PbrShaderAttributesManager class
Base classes
-
template<class T, ManagedObjectAccess Access>class AbstractAttributesManager<attributes::PbrShaderAttributes, ManagedObjectAccess::Copy>
- Class template defining responsibilities and functionality for managing esp::
metadata:: attributes:: AbstractAttributes constructs.
Constructors, destructors, conversion operators
Public functions
-
auto createObject(const std::
string& pbrConfigFilename = ESP_DEFAULT_PBRSHADER_CONFIG_REL_PATH, bool registerTemplate = true) -> attributes::PbrShaderAttributes::ptr override - Creates an instance of a PBR shader configuration file used to govern which calculations are performed by the PBR shader (such as Image-based Lighting and/or specific PBR layer calculations), as well as to provide some user-configurable shader-wide control values.
- void setValsFromJSONDoc(attributes::PbrShaderAttributes::ptr attribs, const io::JsonGenericValue& jsonConfig) override
- Method to take an existing attributes and set its values from passed json config file.
- void setAllIBLEnabled(bool isIblEnabled)
- This will set all the metadata::
attributes:: PbrShaderAttributes to have IBL either on or off. - void setAllDirectLightsEnabled(bool isDirLightEnabled)
- This will set all the metadata::
attributes:: PbrShaderAttributes to have Direct Ligthing either on or off. - void finalizeAttrPathsBeforeRegister(const attributes::PbrShaderAttributes::ptr& pbrShaderAttribs) 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::PbrShaderAttributes::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::ManagedContainerBase.
-
auto preRegisterObjectFinalize(attributes::PbrShaderAttributes::ptr pbrShaderAttribs,
const std::
string& objectHandle, 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 physics-attributes-specific resetting that needs to happen on reset.
Function documentation
attributes::PbrShaderAttributes::ptr esp::
Creates an instance of a PBR shader configuration file used to govern which calculations are performed by the PBR shader (such as Image-based Lighting and/or specific PBR layer calculations), as well as to provide some user-configurable shader-wide control values.
| Parameters | |
|---|---|
| pbrConfigFilename | The location of the PBR shader 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::
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::
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 | |
|---|---|
| pbrShaderAttribs | The attributes to be filtered. |
TODO : If/When we begin treating IBL filepaths like we do other paths, this will need to be implemented.
attributes::PbrShaderAttributes::ptr esp::
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 PbrShaderAttributes 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 PbrShaderAttributes pointer, with only default values set. |
void esp::
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::ManagedContainerBase.
| Parameters | |
|---|---|
| templateID | the ID of the template to remove |
| templateHandle | the string key of the attributes desired. |
core::
This method will perform any essential updating to the managed object before registration is performed. If this updating fails, registration will also fail.
| Parameters | |
|---|---|
| pbrShaderAttribs | 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. |
void esp::
Not required for this manager.
| Parameters | |
|---|---|
| objectID | the ID of the successfully registered managed object |
| objectHandle | The name of the managed object |
This method will perform any final manager-related handling after successfully registering an object.
See esp::attributes::managers::ObjectAttributesManager for an example.