esp::metadata::managers::PhysicsAttributesManager class
#include <esp/metadata/managers/PhysicsAttributesManager.h>

Base classes

template<class T, ManagedObjectAccess Access> class AbstractAttributesManager<attributes::PhysicsManagerAttributes, ManagedObjectAccess::Copy>: Class template defining responsibilities and functionality for managing esp::metadata::attributes::AbstractAttributes constructs.

Constructors, destructors, conversion operators

PhysicsAttributesManager()

Public functions

auto createObject(const std::string& physicsFilename = ESP_DEFAULT_PHYSICS_CONFIG_REL_PATH, bool registerTemplate = true) -> attributes::PhysicsManagerAttributes::ptr override: Creates an instance of a physics world template described by passed string. For physics templates, this a file name. Parses global physics simulation parameters (such as timestep, gravity, simulator implementation) from the specified configuration file.
void setValsFromJSONDoc(attributes::PhysicsManagerAttributes::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::PhysicsManagerAttributes::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

auto initNewObjectInternal(const std::string& handleName, bool builtFromConfig) -> attributes::PhysicsManagerAttributes::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 esp::core::managedContainers::ManagedContainerBase.
auto preRegisterObjectFinalize(attributes::PhysicsManagerAttributes::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.
void resetFinalize() override: Any physics-attributes-specific resetting that needs to happen on reset.

Function documentation

attributes::PhysicsManagerAttributes::ptr esp::metadata::managers::PhysicsAttributesManager::createObject(const std::string& physicsFilename = ESP_DEFAULT_PHYSICS_CONFIG_REL_PATH, bool registerTemplate = true) override

Creates an instance of a physics world template described by passed string. For physics templates, this a file name. Parses global physics simulation parameters (such as timestep, gravity, simulator implementation) from the specified configuration file.

Parameters
physicsFilename	The configuration file to parse. Defaults to the file location `ESP_DEFAULT_PHYSICS_CONFIG_REL_PATH` set by cmake.
registerTemplate	whether to add this template to the library. If the user is going to edit this template, this should be false - any subsequent editing will require re-registration. Defaults to true. If specified as true, then this function returns a copy of the registered template.
Returns	a reference to the physics simulation meta data object parsed from the specified configuration file.

If a template exists with this handle, this existing template will be overwritten with the newly created one if registerTemplate is true.

void esp::metadata::managers::PhysicsAttributesManager::setValsFromJSONDoc(attributes::PhysicsManagerAttributes::ptr attribs, const io::JsonGenericValue& jsonConfig) override

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

Parameters
attribs	(out) an existing attributes to be modified.
jsonConfig	json document to parse

void esp::metadata::managers::PhysicsAttributesManager::finalizeAttrPathsBeforeRegister(const attributes::PhysicsManagerAttributes::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.

Parameters
attributes	The attributes to be filtered.

attributes::PhysicsManagerAttributes::ptr esp::metadata::managers::PhysicsAttributesManager::initNewObjectInternal(const std::string& handleName, bool builtFromConfig) override protected

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

Parameters
handleName	handle name to be assigned to attributes
builtFromConfig	Whether this PhysicsManagerAttributes is being built from a config file (i.e. handleName is the name of a configuration file) or from some other source.
Returns	Newly created but unregistered PhysicsManagerAttributes pointer, with only default values set.

void esp::metadata::managers::PhysicsAttributesManager::deleteObjectInternalFinalize(int templateID, const std::string& templateHandle) override protected

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.

Parameters
templateID	the ID of the template to remove
templateHandle	the string key of the attributes desired.

core::managedContainers::ManagedObjectPreregistration esp::metadata::managers::PhysicsAttributesManager::preRegisterObjectFinalize(attributes::PhysicsManagerAttributes::ptr object, const std::string& objectHandle, bool forceRegistration) override protected

Not required for this manager.

Parameters
object	the managed object to be registered
objectHandle	the name to register the managed object with. Expected to be valid.
forceRegistration	Should register object even if conditional registration checks fail.
Returns	Whether the preregistration has succeeded and what handle to use to register the object if it has.

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

void esp::metadata::managers::PhysicsAttributesManager::postRegisterObjectHandling(int objectID, const std::string& objectHandle) override protected