HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PcpExpressionVariables Class Reference

#include <expressionVariables.h>

Public Member Functions

 PcpExpressionVariables ()=default
 
 PcpExpressionVariables (const PcpExpressionVariablesSource &source, const VtDictionary &expressionVariables)
 
 PcpExpressionVariables (PcpExpressionVariablesSource &&source, VtDictionary &&expressionVariables)
 
const
PcpExpressionVariablesSource
GetSource () const
 Return the source of the composed expression variables. More...
 
const VtDictionaryGetVariables () const
 Returns the composed expression variables dictionary. More...
 
void SetVariables (const VtDictionary &variables)
 Set the composed expression variables to variables. More...
 
Comparison Operators
bool operator== (const PcpExpressionVariables &rhs) const
 
bool operator!= (const PcpExpressionVariables &rhs) const
 

Static Public Member Functions

static PCP_API
PcpExpressionVariables 
Compute (const PcpLayerStackIdentifier &sourceLayerStackId, const PcpLayerStackIdentifier &rootLayerStackId, const PcpExpressionVariables *overrideExpressionVars=nullptr)
 

Detailed Description

Object containing composed expression variables associated with a given layer stack, identified by a PcpExpressionVariablesSource.

Definition at line 43 of file expressionVariables.h.

Constructor & Destructor Documentation

PcpExpressionVariables::PcpExpressionVariables ( )
default

Create a new object with no expression variables and the source set to the root layer stack.

PcpExpressionVariables::PcpExpressionVariables ( const PcpExpressionVariablesSource source,
const VtDictionary expressionVariables 
)
inline

Creates a new object for source with the given expressionVariables.

Definition at line 64 of file expressionVariables.h.

PcpExpressionVariables::PcpExpressionVariables ( PcpExpressionVariablesSource &&  source,
VtDictionary &&  expressionVariables 
)
inline

Creates a new object for source with the given expressionVariables.

Definition at line 74 of file expressionVariables.h.

Member Function Documentation

static PCP_API PcpExpressionVariables PcpExpressionVariables::Compute ( const PcpLayerStackIdentifier sourceLayerStackId,
const PcpLayerStackIdentifier rootLayerStackId,
const PcpExpressionVariables overrideExpressionVars = nullptr 
)
static

Compute the composed expression variables for sourceLayerStackId, recursively computing and composing the overrides specified by its expressionVariableOverridesSource. If overrideExpressionVars is provided, it will be used as the overrides instead of performing the recursive computation.

const PcpExpressionVariablesSource& PcpExpressionVariables::GetSource ( ) const
inline

Return the source of the composed expression variables.

Definition at line 97 of file expressionVariables.h.

const VtDictionary& PcpExpressionVariables::GetVariables ( ) const
inline

Returns the composed expression variables dictionary.

Definition at line 101 of file expressionVariables.h.

bool PcpExpressionVariables::operator!= ( const PcpExpressionVariables rhs) const
inline

Definition at line 90 of file expressionVariables.h.

bool PcpExpressionVariables::operator== ( const PcpExpressionVariables rhs) const
inline

Definition at line 83 of file expressionVariables.h.

void PcpExpressionVariables::SetVariables ( const VtDictionary variables)
inline

Set the composed expression variables to variables.

Definition at line 105 of file expressionVariables.h.


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