PcpExpressionVariables Class Reference

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

#include <expressionVariables.h>

Public Member Functions
	PcpExpressionVariables ()=default
	Create a new object with no expression variables and the source set to the root layer stack.
	PcpExpressionVariables (const PcpExpressionVariablesSource &source, const VtDictionary &expressionVariables)
	Creates a new object for source with the given expressionVariables.
	PcpExpressionVariables (PcpExpressionVariablesSource &&source, VtDictionary &&expressionVariables)
	Creates a new object for source with the given expressionVariables.
const PcpExpressionVariablesSource &	GetSource () const
	Return the source of the composed expression variables.
const VtDictionary &	GetVariables () const
	Returns the composed expression variables dictionary.
void	SetVariables (const VtDictionary &variables)
	Set the composed expression variables to variables.
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)
	Compute the composed expression variables for sourceLayerStackId, recursively computing and composing the overrides specified by its expressionVariableOverridesSource.

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() [1/3]

PcpExpressionVariables ( )

default

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

PcpExpressionVariables() [2/3]

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() [3/3]

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

Compute()

static PCP_API 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.

GetSource()

const PcpExpressionVariablesSource & GetSource ( ) const

inline

Return the source of the composed expression variables.

Definition at line 97 of file expressionVariables.h.

GetVariables()

const VtDictionary & GetVariables ( ) const

inline

Returns the composed expression variables dictionary.

Definition at line 101 of file expressionVariables.h.

operator!=()

bool operator!= ( const PcpExpressionVariables &  rhs ) const

inline

Definition at line 90 of file expressionVariables.h.

operator==()

bool operator== ( const PcpExpressionVariables &  rhs ) const

inline

Definition at line 83 of file expressionVariables.h.

SetVariables()

void 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:

• pxr/usd/pcp/expressionVariables.h