Cubios::Scene

Constructors

Scene

Summary

Constructs GFX Engine scene object

Synopsis

1Scene()
2 

Public Methods

CreateObject

Summary

Creates an instance of GFX scene object in the list of objects added to the scene

Arguments

• obj - pointer to an instance of SceneObject

Output

Returns unique identifier of an object

Synopsis

1uint32_t CreateObject(SceneObject* obj)
2 

CreateObjectWithID

Summary

Creates an instance of GFX scene object with given identifier in the list of objects added to the scene

Arguments

• id - identifier of the object
• obj - pointer to an instance of SceneObject

Output

Returns true if object has been added to the list successfully, otherwise false

Synopsis

1bool CreateObjectWithID(uint32_t id, SceneObject* obj)
2 

CreateSound

Summary

Creates an instance of sound object in the list of objects added to the scene

Arguments

• obj - pointer to an instance of sound object

Output

Returns unique identifier of an object

Synopsis

1uint32_t CreateSound(Sound* obj)
2 

CreateSoundWithID

Summary

Creates an instance of sound object with given identifier in the list of objects added to the scene

Arguments

• id - identifier of the object
• obj - pointer to an instance of sound object

Output

Returns true if object has been added to the list successfully, otherwise false

Synopsis

1bool CreateSoundWithID(uint32_t id, Sound* obj)
2 

DisposeObjectWithID

Summary

Removes object from the list of objects that are added to the scene and disposes the object

Arguments

• id - identifier of the object

Output

Returns true if object has been removed to the list successfully, otherwise false

Synopsis

1bool DisposeObjectWithID(uint32_t id)
2 

DisposeSoundWithID

Summary

Removes sound object from the list of objects that are added to the scene and disposes the object

Arguments

• id - identifier of the object

Output

Returns true if object has been removed to the list successfully, otherwise false

Synopsis

1bool DisposeSoundWithID(uint32_t id)
2 

DisposeAllObjects

Summary

Removes and disposes all objects from the scene

Synopsis

1void DisposeAllObjects()
2 

Play

Summary

Plays sound object

Arguments

• id - identifier of the sound object
• volume - audio playback volume

Synopsis

1void Play(uint32_t id, uint8_t volume)
2 

Public Operators

operator [ ]

Summary

Operator is used for accessing scene object via their identifiers

Output

Returns a pointer to requested scene object

Synopsis

1SceneObject* operator[](uint32_t)
2