esp::metadata::managers::StageAttributesManager class

#include <esp/metadata/managers/StageAttributesManager.h>

Base classes

template<class T, ManagedObjectAccess Access>

class AbstractObjectAttributesManager<attributes::StageAttributes, ManagedObjectAccess::Copy>

Class template defining responsibilities and functionality for managing esp::metadata::attributes::AbstractObjectAttributes constructs.

Constructors, destructors, conversion operators

StageAttributesManager(PhysicsAttributesManager::ptr physicsAttributesManager) explicit

Public functions

void setCurrPhysicsManagerAttributesHandle(const std::string& handle)

This will set the current physics manager attributes that is governing the world that this StageAttributesManager's scenes will be created in. This is used so that upon creation of new esp::metadata::attributes::StageAttributes, PhysicsManagerAttributes defaults can be set in the esp::metadata::attributes::StageAttributes before any scene-specific values are set.

void setCurrCfgVals(const std::string& lightSetup, bool frustumCulling)

copy current esp::sim::SimulatorConfiguration driven values as defaults, to make them available for stage attributes initialization.

auto createPrimBasedAttributesTemplate(const std::string& primAttrTemplateHandle, bool registerTemplate = true) -> attributes::StageAttributes::ptr override

Creates an instance of a stage template described by passed string, which should be a reference to an existing primitive asset template to be used in the construction of the stage (as render and collision mesh). It returns existing instance if there is one, and nullptr if fails.

void setValsFromJSONDoc(attributes::StageAttributes::ptr attribs, const io::JsonGenericValue& jsonConfig) override

Method to take an existing attributes and set its values from passed json config file.

void finalizeAttrPathsBeforeRegister(const attributes::StageAttributes::ptr& attributes) const override

This function will be called to finalize attributes' paths before registration, moving fully qualified paths to the appropriate hidden attribute fields. This can also be called without registration to make sure the paths specified in an attributes are properly configured.

Protected functions

void createDefaultPrimBasedAttributesTemplates() override

Create and save default primitive asset-based object templates, saving their handles as non-deletable default handles.

void setDefaultAssetNameBasedAttributes(attributes::StageAttributes::ptr attributes, bool setFrame, const std::string& meshHandle, const std::function<void(AssetType)>& assetTypeSetter) override

Perform file-name-based attributes initialization. This is to take the place of the AssetInfo::fromPath functionality, and is only intended to provide default values and other help if certain mistakes are made by the user, such as specifying an asset handle in json but not specifying the asset type corresponding to that handle. These settings should not restrict anything, only provide defaults.

auto initNewObjectInternal(const std::string& handleName, bool builtFromConfig) -> attributes::StageAttributes::ptr override

Used Internally. Create and configure newly-created attributes with any default values, before any specific values are set.

void deleteObjectInternalFinalize(int templateID, const std::string& templateHandle) override

This method will perform any necessary updating that is AbstractAttributesManager-specific upon template removal, such as removing a specific template handle from the list of file-based template handles in ObjectAttributesManager. This should only be called internally from esp::core::managedContainers::ManagedContainerBase.

auto preRegisterObjectFinalize(attributes::StageAttributes::ptr StageAttributesTemplate, const std::string& StageAttributesHandle, bool forceRegistration) -> core::managedContainers::ManagedObjectPreregistration override

This method will perform any essential updating to the managed object before registration is performed. If this updating fails, registration will also fail.

void postRegisterObjectHandling(int objectID, const std::string& objectHandle) override

Not required for this manager.

void resetFinalize() override

Any scene-attributes-specific resetting that needs to happen on reset.

Protected variables

PhysicsAttributesManager::ptr physicsAttributesManager_

Reference to PhysicsAttributesManager to give access to default physics manager attributes settings when esp::metadata::attributes::StageAttributes are created.

std::string cfgLightSetup_

Current lighting default value based on current esp::sim::SimulatorConfiguration settings. Potentially overridden by scene-specific json.

bool cfgFrustumCulling_

Current frustum culling setting based on current esp::sim::SimulatorConfiguration settings. Potentially overridden by scene-specific json.

std::string physicsManagerAttributesHandle_

Name of currently used physicsManagerAttributes.

Function documentation