Package com.google.android.filament

Class Scene

java.lang.Object

com.google.android.filament.Scene

public class Scene
extends java.lang.Object

A Scene is a flat container of RenderableManager and LightManager components.

A Scene doesn't provide a hierarchy of objects, i.e.: it's not a scene-graph. However, it manages the list of objects to render and the list of lights. These can be added or removed from a Scene at any time. Moreover clients can use TransformManager to create a graph of transforms.

A RenderableManager component must be added to a Scene in order to be rendered, and the Scene must be provided to a View.

Creation and Destruction

A Scene is created using Engine.createScene() and destroyed using Engine.destroyScene(Scene).

See Also:

View, LightManager, RenderableManager, TransformManager

Method Summary

Modifier and Type	Method	Description
void	addEntities(int[] entities)	Adds a list of entities to the Scene.
void	addEntity(int entity)	Adds an Entity to the Scene.
IndirectLight	getIndirectLight()
int	getLightCount()	Returns the number of LightManager components in the Scene.
long	getNativeObject()
int	getRenderableCount()	Returns the number of RenderableManager components in the Scene.
Skybox	getSkybox()
void	remove(int entity)	Deprecated. See removeEntity(int)
void	removeEntities(int[] entities)	Removes a list of entities from the Scene.
void	removeEntity(int entity)	Removes an Entity from the Scene.
void	setIndirectLight(IndirectLight ibl)	Sets the IndirectLight to use when rendering the Scene.
void	setSkybox(Skybox skybox)	Sets the Skybox.

Methods inherited from class java.lang.Object

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

Method Detail

getSkybox

@Nullable
public Skybox getSkybox()

Returns:

the Skybox or null if none is set

See Also:

setSkybox(Skybox)

setSkybox

public void setSkybox(@Nullable
                      Skybox skybox)

Sets the Skybox. The Skybox is drawn last and covers all pixels not touched by geometry.

Parameters:

skybox - the Skybox to use to fill untouched pixels, or null to unset the Skybox.

getIndirectLight

@Nullable
public IndirectLight getIndirectLight()

Returns:

the IndirectLight or null if none is set

See Also:

setIndirectLight(IndirectLight)

setIndirectLight

public void setIndirectLight(@Nullable
                             IndirectLight ibl)

Sets the IndirectLight to use when rendering the Scene. Currently, a Scene may only have a single IndirectLight. This call replaces the current IndirectLight.

Parameters:

ibl - the IndirectLight to use when rendering the Scene or null to unset.

addEntity

public void addEntity(int entity)

Adds an Entity to the Scene.

Parameters:

entity - the entity is ignored if it doesn't have a RenderableManager component or LightManager component.
A given Entity object can only be added once to a Scene.

addEntities

public void addEntities(int[] entities)

Adds a list of entities to the Scene.

Parameters:

entities - array containing entities to add to the Scene.

removeEntity

public void removeEntity(int entity)

Removes an Entity from the Scene.

Parameters:

entity - the Entity to remove from the Scene. If the specified entity doesn't exist, this call is ignored.

remove

@Deprecated
public void remove(int entity)

Deprecated.

See removeEntity(int)

removeEntities

public void removeEntities(int[] entities)

Removes a list of entities from the Scene. This is equivalent to calling remove in a loop. If any of the specified entities do not exist in the scene, they are skipped.

Parameters:

entities - array containing entities to remove from the Scene.

getRenderableCount

public int getRenderableCount()

Returns the number of RenderableManager components in the Scene.

Returns:

number of RenderableManager components in the Scene..

getLightCount

public int getLightCount()

Returns the number of LightManager components in the Scene.

Returns:

number of LightManager components in the Scene..

getNativeObject

public long getNativeObject()