esp::metadata::managers::SceneDatasetAttributesManager class

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

Base classes

template<class T, ManagedObjectAccess Access>

class AbstractAttributesManager<attributes::SceneDatasetAttributes, ManagedObjectAccess::Share>

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

Constructors, destructors, conversion operators

SceneDatasetAttributesManager(PhysicsAttributesManager::ptr physicsAttributesMgr, PbrShaderAttributesManager::ptr pbrShaderAttributesMgr) explicit

Public functions

auto createObject(const std::string& attributesTemplateHandle, bool registerTemplate = true) -> attributes::SceneDatasetAttributes::ptr override

Creates an instance of a dataset template described by passed string. For dataset templates, this a file name.

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

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

void setCurrPhysicsManagerAttributesHandle(const std::string& handle)

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

void setDefaultPbrShaderAttributesHandle(const std::string& pbrHandle)

This will set the current default PBR/IBL Shader configuration attributes. This is used so that upon creation of new esp::metadata::attributes::SceneDatasetAttributes, the default esp::metadata::attributes::PbrShaderAttributes can be set in the esp::metadata::attributes::SceneDatasetAttributes before any scene-specific values are set.

void finalizeAttrPathsBeforeRegister(const attributes::SceneDatasetAttributes::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 validateMap(const std::string& dsDir, const std::string& jsonTag, std::map<std::string, std::string>& map)

This will validate a loaded dataset map with file location values from the dataset config, by attempting to either verify those locations are valid files, or else prefix the given location with the dataset root directory.

template<typename U>

void readDatasetJSONCell(const std::string& dsDir, const char* tag, const io::JsonGenericValue& jsonConfig, const U& attrMgr, std::map<std::string, std::string>* strKeyMap = nullptr)

Verify a particular subcell exists within the dataset_config.JSON file, and if so, handle reading the possible JSON sub-cells it might hold, using the passed AbstractAttributesManager for the dataset being processed.

template<typename U>

void readDatasetConfigsJSONCell(const std::string& dsDir, const char* tag, const io::JsonGenericValue& jCell, const U& attrMgr)

This will parse an individual element in a "configs" cell array in the dataset_config.JSON file.

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

Used Internally. Create and configure newly-created dataset 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 esp::core::managedContainers::ManagedContainerBase.

void resetFinalize() override

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

auto preRegisterObjectFinalize(attributes::SceneDatasetAttributes::ptr object, const std::string& objectHandle, bool forceRegistration) -> core::managedContainers::ManagedObjectPreregistration override

Not required for this manager.

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

Not required for this manager.

Protected variables

std::string physicsManagerAttributesHandle_

Name of currently used physicsManagerAttributes.

std::string defaultPbrShaderAttributesHandle_

Name of currently used default PbrShaderAttributes.

PhysicsAttributesManager::ptr physicsAttributesManager_

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

PbrShaderAttributesManager::ptr pbrShaderAttributesManager_

Reference to the PbrShaderAttributesManager to give access to various PBR/IBL Shader configuration parameters and settings.

Function documentation