Package com.banuba.sdk.scene

Interface Scene

All Known Implementing Classes:

Scene.CppProxy

public interface Scene

A class representing a displayable scene. Aggregates in one place the hierarchy of Entities with their Components, AssetManager and RenderList and makes it work all together.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Scene.CppProxy

Method Summary

Modifier and Type	Method	Description
void	addEffectEvent(java.lang.String name, java.util.HashMap<java.lang.String,java.lang.String> params)
void	addFeatureParam(FeatureId feature, java.util.ArrayList<FeatureParameter> params)
void	addLayer(Layer layer)
void	clearRenderList()
Entity	createEntity(java.lang.String name)
void	disableRecognizerFeature(FeatureId feature)
void	enableRecognizerFeature(FeatureId feature)
Parameter	findGlobalMaterialParameter(java.lang.String name)	find global material parameter by name
AssetManager	getAssetManager()	Get the AssetManager of a current scene.
Camera	getCamera()
java.util.ArrayList<Component>	getComponents(ComponentType type)	Get all components present in this scene of specified type
Layer	getLayer(java.lang.String layerName)	Return first found layer with name `layerName` or NULL if such layer doesn't exist.
java.util.ArrayList<Layer>	getLayers()
java.lang.String	getName()	Get a scene name.
long	getNativeContext()
RenderList	getRenderList()
Entity	getRoot()	Get the root of entities hierarchy.
int	getSurfaceHeight()
int	getSurfaceWidth()
TriggerStatusType	getTriggerStatus(TriggerType trigger)
void	removeLayer(Layer layer)
void	setName(java.lang.String name)	Set a new name for a scene.
void	setRenderList(RenderList renderList)

Method Detail

setName

void setName(@NonNull
             java.lang.String name)

Set a new name for a scene. The name could be empty.

getName

@NonNull
java.lang.String getName()

Get a scene name.

getRoot

@Nullable
Entity getRoot()

Get the root of entities hierarchy. It always exists and has a name "Root".

getAssetManager

@Nullable
AssetManager getAssetManager()

Get the AssetManager of a current scene. It always exists.

addLayer

void addLayer(@Nullable
              Layer layer)

getLayers

@NonNull
java.util.ArrayList<Layer> getLayers()

getComponents

@NonNull
java.util.ArrayList<Component> getComponents(@NonNull
                                             ComponentType type)

Get all components present in this scene of specified type

getLayer

@Nullable
Layer getLayer(@NonNull
               java.lang.String layerName)

Return first found layer with name `layerName` or NULL if such layer doesn't exist.

removeLayer

void removeLayer(@Nullable
                 Layer layer)

setRenderList

void setRenderList(@Nullable
                   RenderList renderList)

getRenderList

@Nullable
RenderList getRenderList()

clearRenderList

void clearRenderList()

getCamera

@Nullable
Camera getCamera()

enableRecognizerFeature

void enableRecognizerFeature(@NonNull
                             FeatureId feature)

disableRecognizerFeature

void disableRecognizerFeature(@NonNull
                              FeatureId feature)

addFeatureParam

void addFeatureParam(@NonNull
                     FeatureId feature,
                     @NonNull
                     java.util.ArrayList<FeatureParameter> params)

addEffectEvent

void addEffectEvent(@NonNull
                    java.lang.String name,
                    @NonNull
                    java.util.HashMap<java.lang.String,java.lang.String> params)

getTriggerStatus

@NonNull
TriggerStatusType getTriggerStatus(@NonNull
                                   TriggerType trigger)

createEntity

@Nullable
Entity createEntity(@NonNull
                    java.lang.String name)

getNativeContext

long getNativeContext()

getSurfaceWidth

int getSurfaceWidth()

getSurfaceHeight

int getSurfaceHeight()

findGlobalMaterialParameter

@Nullable
Parameter findGlobalMaterialParameter(@NonNull
                                      java.lang.String name)

find global material parameter by name

Parameters:

name - (string)

Returns:

parameter (parameter) or null