Deprecate init/delete methods so we can start removing them

ultraq · Feb 13, 2024 · 9fac0ce · 9fac0ce
1 parent f33a530
commit 9fac0ce
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 71 deletions.
diff --git a/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/audio/AudioElement.groovy b/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/audio/AudioElement.groovy
@@ -1,12 +1,12 @@
-/* 
+/*
  * Copyright 2007, Emanuel Rabina (http://www.ultraq.net.nz/)
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *     http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,14 +28,18 @@ interface AudioElement {
 	 *
 	 * @param renderer Audio renderer for the underlying audio subsystem.
 	 */
-	void delete(AudioRenderer renderer)
+	@Deprecated
+	default void delete(AudioRenderer renderer) {
+	}
 
 	/**
 	 * Perform any setup for this element.
 	 *
 	 * @param renderer Audio renderer for the underlying audio subsystem.
 	 */
-	void init(AudioRenderer renderer)
+	@Deprecated
+	default void init(AudioRenderer renderer) {
+	}
 
 	/**
 	 * Update the element within a render loop.

diff --git a/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/audio/Listener.groovy b/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/audio/Listener.groovy
@@ -31,13 +31,6 @@ class Listener extends Node<Listener> implements AudioElement {
 	final Vector3f velocity = new Vector3f(0, 0, 0)
 	final Orientation orientation = new Orientation()
 
-	/**
-	 * Does nothing.
-	 */
-	@Override
-	void delete(AudioRenderer renderer) {
-	}
-
 	/**
 	 * Sets up initial listener properties, like volume.
 	 */

diff --git a/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/graphics/GraphicsElement.groovy b/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/graphics/GraphicsElement.groovy
@@ -1,12 +1,12 @@
-/* 
+/*
  * Copyright 2019, Emanuel Rabina (http://www.ultraq.net.nz/)
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *     http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -18,28 +18,32 @@ package nz.net.ultraq.redhorizon.engine.graphics
 
 /**
  * Interface for graphical elements rendered to the graphics hardware.
- * 
+ *
  * @author Emanuel Rabina
  */
 interface GraphicsElement {
 
 	/**
 	 * Perform any cleanup for this element.
-	 * 
+	 *
 	 * @param renderer
 	 */
-	void delete(GraphicsRenderer renderer)
+	@Deprecated
+	default void delete(GraphicsRenderer renderer) {
+	}
 
 	/**
 	 * Perform any setup for this element.
-	 * 
+	 *
 	 * @param renderer
 	 */
-	void init(GraphicsRenderer renderer)
+	@Deprecated
+	default void init(GraphicsRenderer renderer) {
+	}
 
 	/**
 	 * Render the element for display.
-	 * 
+	 *
 	 * @param renderer
 	 */
 	void render(GraphicsRenderer renderer)

diff --git a/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Animation.groovy b/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Animation.groovy
@@ -79,14 +79,6 @@ class Animation extends Node<Animation> implements GraphicsElement, Playable, Te
 		this.streamingDecoder = streamingDecoder
 	}
 
-	@Override
-	void delete(GraphicsRenderer renderer) {
-	}
-
-	@Override
-	void init(GraphicsRenderer renderer) {
-	}
-
 	@Override
 	void onSceneAdded(Scene scene) {
 

diff --git a/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Outline.groovy b/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Outline.groovy
@@ -42,14 +42,6 @@ class Outline extends Node<Outline> implements GraphicsElement {
 	private Mesh mesh
 	private Shader shader
 
-	@Override
-	void delete(GraphicsRenderer renderer) {
-	}
-
-	@Override
-	void init(GraphicsRenderer renderer) {
-	}
-
 	@Override
 	void onSceneAdded(Scene scene) {
 

diff --git a/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Sound.groovy b/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Sound.groovy
@@ -64,14 +64,6 @@ class Sound extends Node<Sound> implements AudioElement, Playable, Temporal {
 		this.streamingDecoder = streamingDecoder
 	}
 
-	@Override
-	void delete(AudioRenderer renderer) {
-	}
-
-	@Override
-	void init(AudioRenderer renderer) {
-	}
-
 	@Override
 	void onSceneAdded(Scene scene) {
 

diff --git a/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Sprite.groovy b/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Sprite.groovy
@@ -55,14 +55,6 @@ class Sprite extends Node<Sprite> implements GraphicsElement {
 		this.imageFile = imageFile
 	}
 
-	@Override
-	void delete(GraphicsRenderer renderer) {
-	}
-
-	@Override
-	void init(GraphicsRenderer renderer) {
-	}
-
 	@Override
 	void onSceneAdded(Scene scene) {
 

diff --git a/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Video.groovy b/redhorizon-engine/source/nz/net/ultraq/redhorizon/engine/scenegraph/nodes/Video.groovy
@@ -58,22 +58,6 @@ class Video extends Node<Video> implements AudioElement, GraphicsElement, Playab
 		this.videoFile = videoFile
 	}
 
-	@Override
-	void delete(AudioRenderer renderer) {
-	}
-
-	@Override
-	void delete(GraphicsRenderer renderer) {
-	}
-
-	@Override
-	void init(AudioRenderer renderer) {
-	}
-
-	@Override
-	void init(GraphicsRenderer renderer) {
-	}
-
 	@Override
 	void onSceneAdded(Scene scene) {