Package com.xebisco.yield

Class Scene

java.lang.Object

com.xebisco.yield.AbstractBehavior

com.xebisco.yield.Entity2DContainer

com.xebisco.yield.Scene

All Implemented Interfaces:

Behavior, Renderable, Closeable, AutoCloseable

Direct Known Subclasses:

BlankScene

public abstract class Scene
extends Entity2DContainer

The Scene class represents a scene in a 2D environment. It can contain various systems and properties for managing an application state.

Constructor Summary

Constructors

Constructor	Description
Scene(Application application)	Constructs a new Scene with the given application.

Method Summary

Modifier and Type	Method	Description
Color	backGroundColor()	Returns the background color of the scene.
Transform2D	camera()	Retrieves the camera transform of the scene.
void	onUpdate(ContextTime time)	This method is called when the behavior needs to be updated with the current time.
Scene	setBackGroundColor(Color backGroundColor)	Sets the background color of the scene.
Scene	setSystems(Set<SystemBehavior> systems)	Sets the SystemBehavior objects in the scene.
<T extends SystemBehavior> T	system(Class<T> systemType)	Returns the first found SystemBehavior object from the scene.
<T extends SystemBehavior> T	system(Class<T> systemType, int index)	Returns a specific SystemBehavior object from the scene.
Set<SystemBehavior>	systems()

Methods inherited from class com.xebisco.yield.Entity2DContainer

application, close, entities, instantiate, instantiate, onStart, remove, render, setEntities, toAddEntities, toRemoveEntities

Methods inherited from class com.xebisco.yield.AbstractBehavior

frames, tick

Methods inherited from class java.lang.Object

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

Constructor Details

Scene

public Scene(Application application)

Constructs a new Scene with the given application.

Parameters:

application - The application that the scene belongs to.

Method Details

onUpdate

public void onUpdate(ContextTime time)

Description copied from interface: Behavior

This method is called when the behavior needs to be updated with the current time. It is typically used to perform any necessary calculations or updates based on the current time.

Specified by:

onUpdate in interface Behavior

Overrides:

onUpdate in class Entity2DContainer

Parameters:

time - The current time context.

system

public <T extends SystemBehavior> T system(Class<T> systemType,
 int index)

Returns a specific SystemBehavior object from the scene.

Type Parameters:

T - The type of the SystemBehavior object.

Parameters:

systemType - The class of the SystemBehavior object to retrieve.

index - The index of the SystemBehavior object to retrieve.

Returns:

The specified SystemBehavior object, or null if not found.

system

public <T extends SystemBehavior> T system(Class<T> systemType)

Returns the first found SystemBehavior object from the scene.

Type Parameters:

T - The type of the SystemBehavior object.

Parameters:

systemType - The class of the SystemBehavior object to retrieve.

Returns:

The specified SystemBehavior object, or null if not found.

backGroundColor

public Color backGroundColor()

Returns the background color of the scene.

Returns:

The background color of the scene.

setBackGroundColor

public Scene setBackGroundColor(Color backGroundColor)

Sets the background color of the scene.

Parameters:

backGroundColor - The new background color for the scene.

Returns:

This Scene instance for method chaining.

systems

public Set<SystemBehavior> systems()

setSystems

public Scene setSystems(Set<SystemBehavior> systems)

Sets the SystemBehavior objects in the scene.

Parameters:

systems - The new set of SystemBehavior objects for the scene.

Returns:

This Scene instance for method chaining.

camera

public Transform2D camera()

Retrieves the camera transform of the scene.

Returns:

The camera transform of the scene.