Package dev.prozilla.pine.core.scene

Class Scene

java.lang.Object

dev.prozilla.pine.core.scene.Scene

All Implemented Interfaces:

Destructible, Initializable, InputHandler, Renderable, Updatable, Printable, ApplicationContext, ApplicationProvider, SceneContext

public class Scene
extends Object
implements Initializable, InputHandler, Updatable, Renderable, Destructible, Printable, SceneContext, ApplicationProvider

Responsible for loading objects into the world.

Field Summary

Fields

Modifier and Type	Field	Description
protected Application	application
protected CameraData	cameraData
protected Prefab	cameraPrefab	Prefab that will be used during scene loading to create a camera entity.
boolean	initialized
boolean	loaded
protected Logger	logger
String	name
protected World	world

Constructor Summary

Constructors

Constructor	Description
Scene()	Creates a new scene with a generated name.
Scene(String name)	Creates a new scene with a given name.

Method Summary

Modifier and Type	Method	Description
protected void	checkStatus()	Checks whether the scene is ready.
void	destroy()	Destroys this scene.
boolean	equals(Scene scene)	Checks if this scene is equal to another scene by comparing both ID's.
static int	generateId()	Generates a new unique scene ID.
Application	getApplication()
CameraData	getCameraData()
int	getId()
World	getWorld()
int	hashCode()
void	init()	Initializes the scene and its children.
void	input(float deltaTime)	Handles input for the scene.
boolean	isActive()	Checks whether this scene is the application's current scene.
protected void	load()	Loads this scene with the default camera prefab.
protected void	load(Prefab cameraPrefab)	Fills this scene with a new world and camera.
void	render(Renderer renderer)	Renders the scene every frame.
void	reset()	Resets the state of this scene.
void	setApplication(Application application)
String	toString()	Returns a string representation of this object.
void	update(float deltaTime)	Updates the scene every frame.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.prozilla.pine.core.ApplicationProvider

getAudioDevice, getConfig, getInput, getLogger, getModManager, getRenderer, getTimer, getTracker, getWindow

Methods inherited from interface dev.prozilla.pine.common.Printable

print, print

Field Details

name

public String name

application

protected Application application

logger

protected Logger logger

world

protected World world

cameraData

protected CameraData cameraData

cameraPrefab

protected Prefab cameraPrefab

Prefab that will be used during scene loading to create a camera entity.

loaded

public boolean loaded

initialized

public boolean initialized

Constructor Details

Scene

public Scene()

Creates a new scene with a generated name. The name consists of Scene # followed by the scene ID.

Scene

public Scene(String name)

Creates a new scene with a given name.

Parameters:

name - Name of the scene

Method Details

setApplication

public void setApplication(Application application)

reset

public void reset()

Resets the state of this scene.

load

protected void load()

Loads this scene with the default camera prefab.

load

protected void load(Prefab cameraPrefab)
             throws IllegalStateException

Fills this scene with a new world and camera.

Parameters:

cameraPrefab - Prefab for the camera entity.

Throws:

IllegalStateException

init

public void init()
          throws IllegalStateException

Initializes the scene and its children.

Specified by:

init in interface Initializable

Throws:

IllegalStateException

input

public void input(float deltaTime)
           throws IllegalStateException

Handles input for the scene.

Specified by:

input in interface InputHandler

Parameters:

deltaTime - Delta time in seconds

Throws:

IllegalStateException

update

public void update(float deltaTime)
            throws IllegalStateException

Updates the scene every frame.

Specified by:

update in interface Updatable

Parameters:

deltaTime - Delta time in seconds

Throws:

IllegalStateException

render

public void render(Renderer renderer)
            throws IllegalStateException

Renders the scene every frame.

Specified by:

render in interface Renderable

Throws:

IllegalStateException

destroy

public void destroy()
             throws IllegalStateException

Destroys this scene.

Specified by:

destroy in interface Destructible

Throws:

IllegalStateException

checkStatus

protected void checkStatus()
                    throws IllegalStateException

Checks whether the scene is ready.

Throws:

IllegalStateException

generateId

public static int generateId()

Generates a new unique scene ID.

Returns:

Scene ID

getId

public int getId()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Scene scene)

Checks if this scene is equal to another scene by comparing both ID's.

Parameters:

scene - Other scene

Returns:

True if both scenes have the same ID.

isActive

public boolean isActive()

Checks whether this scene is the application's current scene.

getApplication

public Application getApplication()

Specified by:

getApplication in interface ApplicationProvider

getWorld

public World getWorld()

Specified by:

getWorld in interface SceneContext

getCameraData

public CameraData getCameraData()

Specified by:

getCameraData in interface SceneContext

toString

public String toString()

Description copied from interface: Printable

Returns a string representation of this object.

Specified by:

toString in interface Printable

Overrides:

toString in class Object

Returns:

String representation of this object.