Loading...
Searching...
No Matches
PcpLayerStackIdentifier Class Reference

Arguments used to identify a layer stack. More...

#include <layerStackIdentifier.h>

Public Types

typedef PcpLayerStackIdentifier This
 

Public Member Functions

PCP_API PcpLayerStackIdentifier ()
 Construct with all empty pointers.
 
PCP_API PcpLayerStackIdentifier (const SdfLayerHandle &rootLayer, const SdfLayerHandle &sessionLayer=TfNullPtr, const ArResolverContext &pathResolverContext=ArResolverContext(), const PcpExpressionVariablesSource &expressionVariablesOverrideSource=PcpExpressionVariablesSource())
 Construct with given pointers.
 
PCP_API PcpLayerStackIdentifieroperator= (const PcpLayerStackIdentifier &)
 
PCP_API operator bool () const
 
PCP_API bool operator== (const This &rhs) const
 
bool operator!= (const This &rhs) const
 
PCP_API bool operator< (const This &rhs) const
 
bool operator<= (const This &rhs) const
 
bool operator> (const This &rhs) const
 
bool operator>= (const This &rhs) const
 
size_t GetHash () const
 

Public Attributes

const SdfLayerHandle rootLayer
 The root layer.
 
const SdfLayerHandle sessionLayer
 The session layer (optional).
 
const ArResolverContext pathResolverContext
 The path resolver context used for resolving asset paths. (optional)
 
const PcpExpressionVariablesSource expressionVariablesOverrideSource
 The source for expression variables that compose over the expression variables in this layer stack.
 

Detailed Description

Arguments used to identify a layer stack.

Objects of this type are immutable.

Definition at line 48 of file layerStackIdentifier.h.

Member Typedef Documentation

◆ This

Definition at line 50 of file layerStackIdentifier.h.

Constructor & Destructor Documentation

◆ PcpLayerStackIdentifier() [1/2]

Construct with all empty pointers.

◆ PcpLayerStackIdentifier() [2/2]

PCP_API PcpLayerStackIdentifier ( const SdfLayerHandle &  rootLayer,
const SdfLayerHandle &  sessionLayer = TfNullPtr,
const ArResolverContext pathResolverContext = ArResolverContext(),
const PcpExpressionVariablesSource expressionVariablesOverrideSource = PcpExpressionVariablesSource() 
)

Construct with given pointers.

If all arguments are TfNullPtr then the result is identical to the default constructed object.

Member Function Documentation

◆ GetHash()

size_t GetHash ( ) const
inline

Definition at line 105 of file layerStackIdentifier.h.

◆ operator!=()

bool operator!= ( const This rhs) const
inline

Definition at line 78 of file layerStackIdentifier.h.

◆ operator<=()

bool operator<= ( const This rhs) const
inline

Definition at line 85 of file layerStackIdentifier.h.

◆ operator>()

bool operator> ( const This rhs) const
inline

Definition at line 89 of file layerStackIdentifier.h.

◆ operator>=()

bool operator>= ( const This rhs) const
inline

Definition at line 93 of file layerStackIdentifier.h.

Member Data Documentation

◆ expressionVariablesOverrideSource

const PcpExpressionVariablesSource expressionVariablesOverrideSource

The source for expression variables that compose over the expression variables in this layer stack.

(optional)

Definition at line 122 of file layerStackIdentifier.h.

◆ pathResolverContext

const ArResolverContext pathResolverContext

The path resolver context used for resolving asset paths. (optional)

Definition at line 118 of file layerStackIdentifier.h.

◆ rootLayer

const SdfLayerHandle rootLayer

The root layer.

Definition at line 112 of file layerStackIdentifier.h.

◆ sessionLayer

const SdfLayerHandle sessionLayer

The session layer (optional).

Definition at line 115 of file layerStackIdentifier.h.


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