esp::assets::AbstractAttributes class

Base class for all implemented attributes.

Base classes

class esp::core::Configuration

Derived classes

class AbstractPhysicsAttributes
base attributes object holding attributes shared by all PhysicsObjectAttributes and PhysicsSceneAttributes objects; Should be treated as if is abstract - should never be instanced directly
class AbstractPrimitiveAttributes
class PhysicsManagerAttributes
attributes for a single physics manager

Constructors, destructors, conversion operators

AbstractAttributes(const std::string& attributesClassKey, const std::string& handle)
~AbstractAttributes() defaulted virtual

Public functions

auto getClassKey() const -> std::string
Get this attributes' class. Should only be set from constructor. Used as key in constructor function pointer maps in AttributesManagers.
void setHandle(const std::string& handle) virtual
Set this attributes name/origin. Some attributes derive their own names based on their state, such as AbstractPrimitiveAttributes; in such cases this should be overridden with NOP.
auto getHandle() const -> std::string
void setFileDirectory(const std::string& fileDirectory) virtual
directory where files used to construct attributes can be found.
auto getFileDirectory() const -> std::string
void setID(int ID)
auto getID() const -> int
auto getConfigGroup() const -> const Corrade::Utility::ConfigurationGroup&
Returns configuration to be used with PrimitiveImporter to instantiate Primitives. Names in getter/setters chosen to match parameter name expectations in PrimitiveImporter.

Protected functions

void setAttributesClassKey(const std::string& attributesClassKey)
Set this attributes' class. Should only be set from constructor. Used as key in constructor function pointer maps in AttributesManagers.

Function documentation

void esp::assets::AbstractAttributes::setHandle(const std::string& handle) virtual

Set this attributes name/origin. Some attributes derive their own names based on their state, such as AbstractPrimitiveAttributes; in such cases this should be overridden with NOP.

Parameters
handle the handle to set.

const Corrade::Utility::ConfigurationGroup& esp::assets::AbstractAttributes::getConfigGroup() const

Returns configuration to be used with PrimitiveImporter to instantiate Primitives. Names in getter/setters chosen to match parameter name expectations in PrimitiveImporter.

Returns a reference to the underlying configuration group for this attributes object

void esp::assets::AbstractAttributes::setAttributesClassKey(const std::string& attributesClassKey) protected

Set this attributes' class. Should only be set from constructor. Used as key in constructor function pointer maps in AttributesManagers.

Parameters
attributesClassKey the string handle corresponding to the constructors used to make copies of this object in copy constructor map.