Public Member Functions | List of all members
sdf::v10::Pbr Class Reference

This class provides access to Physically-Based-Rendering (PBR) material workflows. More...

#include <Pbr.hh>

Public Member Functions

 Pbr ()
 Default constructor. More...
 
 Pbr (const Pbr &_pbr)
 Copy constructor. More...
 
 Pbr (Pbr &&_pbr) noexcept
 Move constructor. More...
 
 ~Pbr ()
 Destructor. More...
 
Errors Load (ElementPtr _sdf)
 Load the pbr based on an element pointer. More...
 
Pbroperator= (const Pbr &_pbr)
 Assignment operator. More...
 
Pbroperator= (Pbr &&_pbr)
 Move assignment operator. More...
 
void SetWorkflow (PbrWorkflowType _type, const PbrWorkflow &_workflow)
 Set a PBR workflow by type. More...
 
PbrWorkflowWorkflow (PbrWorkflowType _type) const
 Get a PBR workflow by type. More...
 

Detailed Description

This class provides access to Physically-Based-Rendering (PBR) material workflows.

Constructor & Destructor Documentation

◆ Pbr() [1/3]

sdf::v10::Pbr::Pbr ( )

Default constructor.

◆ Pbr() [2/3]

sdf::v10::Pbr::Pbr ( const Pbr _pbr)

Copy constructor.

Parameters
[in]_pbrPbr to copy.

◆ Pbr() [3/3]

sdf::v10::Pbr::Pbr ( Pbr &&  _pbr)
noexcept

Move constructor.

Parameters
[in]_pbrPbr to move.

◆ ~Pbr()

sdf::v10::Pbr::~Pbr ( )

Destructor.

Member Function Documentation

◆ Load()

Errors sdf::v10::Pbr::Load ( ElementPtr  _sdf)

Load the pbr based on an element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters
[in]_sdfThe SDF Element pointer
Returns
Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

◆ operator=() [1/2]

Pbr& sdf::v10::Pbr::operator= ( const Pbr _pbr)

Assignment operator.

Parameters
[in]_pbrThe pbr to set values from.
Returns
*this

◆ operator=() [2/2]

Pbr& sdf::v10::Pbr::operator= ( Pbr &&  _pbr)

Move assignment operator.

Parameters
[in]_pbrThe pbr to move values from.
Returns
*this

◆ SetWorkflow()

void sdf::v10::Pbr::SetWorkflow ( PbrWorkflowType  _type,
const PbrWorkflow _workflow 
)

Set a PBR workflow by type.

Parameters
[in]_typeType of PBR workflow
[in]_workflowWorkflow of the specified type.
See also
PbrWorkflowType

◆ Workflow()

PbrWorkflow* sdf::v10::Pbr::Workflow ( PbrWorkflowType  _type) const

Get a PBR workflow by type.

Parameters
[in]_typeType of PBR workflow
Returns
Workflow of the specified type.
See also
PbrWorkflowType

The documentation for this class was generated from the following file: