StageAttributes class
Specific Attributes instance describing a rigid stage, constructed with a default set of stage-specific required attributes.
Base classes
- class AbstractObjectAttributes
- base attributes object holding attributes shared by all esp::
metadata:: attributes:: ObjectAttributes and esp:: metadata:: attributes:: StageAttributes objects; Should be treated as abstract - should never be instanced directly
Constructors, destructors, conversion operators
-
StageAttributes(const std::
string& handle = "") explicit
Public functions
-
void setOrigin(const Magnum::
Vector3& origin) -
auto getOrigin() const -> Magnum::
Vector3 -
void setGravity(const Magnum::
Vector3& gravity) -
auto getGravity() const -> Magnum::
Vector3 -
void setSemanticOrientUp(const Magnum::
Vector3& semanticOrientUp) - Set default up orientation for semantic mesh. This is to support stage aligning semantic meshes that have different orientations than the stage render mesh.
-
auto getSemanticOrientUp() const -> Magnum::
Vector3 - get default up orientation for semantic mesh. This is to support stage aligning semantic meshes that have different orientations than the stage render mesh. Returns render asset up if no value for semantic asset was specifically set.
-
void setSemanticOrientFront(const Magnum::
Vector3& semanticOrientFront) - Set default forward orientation for semantic mesh. This is to support stage aligning semantic meshes that have different orientations than the stage render mesh.
-
auto getSemanticOrientFront() const -> Magnum::
Vector3 - get default forward orientation for semantic mesh. This is to support stage aligning semantic meshes that have different orientations than the stage render mesh. Returns render asset front if no value for semantic asset was specifically set.
-
void setSemanticDescriptorFilename(const std::
string& semantic_descriptor_filename) - Text file that describes the hierharchy of semantic information embedded in the Semantic Asset mesh. May be overridden by value specified in Scene Instance Attributes.
-
auto getSemanticDescriptorFilename() const -> std::
string - Text file that describes the hierharchy of semantic information embedded in the Semantic Asset mesh. May be overridden by value specified in Scene Instance Attributes.
-
void setSemanticAssetHandle(const std::
string& semanticAssetHandle) -
auto getSemanticAssetHandle() const -> std::
string - void setSemanticAssetType(int semanticAssetType)
- auto getSemanticAssetType() const -> int
- void setHasSemanticTextures(bool hasSemanticTextures)
- Set whether or not the semantic asset for this stage supports texture semantics.
- auto getHasSemanticTextures() const -> bool
- auto useSemanticTextures() const -> bool
- Only set internally if we should use semantic textures for semantic asset loading/rendering. Should only be true if "has_semantic_textures" is true and user has specified to use semantic textures via SimulatorConfiguration.
- void setUseSemanticTextures(bool useSemanticTextures)
- Only should be called when simulator::reconfigure is called, based on setting.
- void setLoadSemanticMesh(bool loadSemanticMesh)
- auto getLoadSemanticMesh() -> bool
-
void setNavmeshAssetHandle(const std::
string& nav_asset) -
auto getNavmeshAssetHandle() const -> std::
string -
void setLightSetupKey(const std::
string& light_setup_key) - Set lighting setup for stage. Default value comes from esp::
sim:: SimulatorConfiguration, is overridden by any value set in json, if exists. -
auto getLightSetupKey() const -> std::
string - void setFrustumCulling(bool frustumCulling)
- Set frustum culling for stage. Default value comes from esp::
sim:: SimulatorConfiguration, is overridden by any value set in json, if exists. Currently only set from SimulatorConfiguration. - auto getFrustumCulling() const -> bool
Protected functions
- void writeValuesToJsonInternal(io::JsonGenericValue& jsonObj, io::JsonAllocator& allocator) const override
- Write stage-specific values to json object.
-
auto getAbstractObjectInfoHeaderInternal() const -> std::
string override - get AbstractObject specific info header
-
auto getAbstractObjectInfoInternal() const -> std::
string override - get AbstractObject specific info for csv string