class
SceneAttributes
Contents
Base classes
- class AbstractAttributes
- Base class for all implemented attributes. Inherits from esp::core::AbstractFileBasedManagedObject so the attributes can be managed by a esp::core::ManagedContainer.
Constructors, destructors, conversion operators
-
SceneAttributes(const std::
string& handle) explicit - SceneAttributes(const SceneAttributes& otr)
- SceneAttributes(SceneAttributes&& otr) noexcept
Public functions
- auto operator=(const SceneAttributes& otr) -> SceneAttributes&
- auto operator=(SceneAttributes&& otr) -> SceneAttributes& noexcept
-
void setTranslationOrigin(const std::
string& translation_origin) - Set a value representing the mechanism used to create this scene instance - should map to an enum value in @InstanceTranslationOriginMap. This acts as an instance-specific override to the scene-instance-wide setting.
- auto getTranslationOrigin() const -> SceneInstanceTranslationOrigin
- Get the value representing the mechanism used to create this scene instance - should map to an enum value in @InstanceTranslationOriginMap. This acts as an instance-specific override to the scene-instance-wide setting.
-
void setLightingHandle(const std::
string& lightingHandle) - Set the name of the template that describes the scene's default lighting.
-
auto getLightingHandle() const -> std::
string - Get the name of the template that describes the scene's default lighting.
-
void setNavmeshHandle(const std::
string& navmeshHandle) - Set the name of the navmesh for the scene.
-
auto getNavmeshHandle() const -> std::
string - Get the name of the navmesh for the scene.
-
void setSemanticSceneHandle(const std::
string& semanticSceneDesc) - Set the name of the semantic scene descriptor.
-
auto getSemanticSceneHandle() const -> std::
string - Get the name of the semantic scene descriptor.
- void setStageInstance(SceneObjectInstanceAttributes::ptr _stageInstance)
- Set the description of the stage placement for this scene instance. Scene instance will always have only 1 stage instance reference.
- auto getStageInstance() const -> SceneObjectInstanceAttributes::cptr
- Get a shared_pointer to the SceneObjectInstanceAttributes descibing the stage placement for this scene instance.
- void addObjectInstance(SceneObjectInstanceAttributes::ptr _objInstance)
- Add a description of an object instance to this scene instance.
-
auto getObjectInstances() const -> std::
vector<SceneObjectInstanceAttributes::cptr> - Get the object instance descriptions for this scene.
- auto getNumObjInstances() const -> int
- Return the number of defined SceneObjectInstanceAttributes subconfigs in this scene instance.
- void addArticulatedObjectInstance(SceneAOInstanceAttributes::ptr _artObjInstance)
- Add a description of an object instance to this scene instance.
-
auto getArticulatedObjectInstances() const -> std::
vector<SceneAOInstanceAttributes::cptr> - Get the object instance descriptions for this scene.
- auto getNumAOInstances() const -> int
- Return the number of defined SceneAOInstanceAttributes subconfigs in this scene instance.
Protected functions
-
auto getObjectInfoHeaderInternal() const -> std::
string override - Retrieve a comma-separated string holding the header values for the info returned for this managed object, type-specific.
-
auto getObjectInfoInternal() const -> std::
string override - Retrieve a comma-separated informational string about the contents of this managed object.
Protected variables
-
std::
shared_ptr<Configuration> objInstConfig_ - Smartpointer to created object instance configuration. The configuration is created on SceneAttributes construction.
-
std::
deque<int> availableObjInstIDs_ - Deque holding all released IDs to consume for object instances when one is deleted, before using size of objectInstances_ container.
-
std::
shared_ptr<Configuration> artObjInstConfig_ - Smartpointer to created articulated object instance configuration. The configuratio is created on SceneAttributes construction.
-
std::
deque<int> availableArtObjInstIDs_ - Deque holding all released IDs to consume for articulated object instances when one is deleted, before using size of articulatedObjectInstances_ container.