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

#include <layerStackIdentifier.h>

Classes

struct  Hash
 

Public Types

typedef PcpLayerStackIdentifier This
 

Public Member Functions

PCP_API PcpLayerStackIdentifier ()
 Construct with all empty pointers. More...
 
PCP_API PcpLayerStackIdentifier (const SdfLayerHandle &rootLayer, const SdfLayerHandle &sessionLayer=TfNullPtr, const ArResolverContext &pathResolverContext=ArResolverContext(), const PcpExpressionVariablesSource &expressionVariablesOverrideSource=PcpExpressionVariablesSource())
 
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. More...
 
const SdfLayerHandle sessionLayer
 The session layer (optional). More...
 
const ArResolverContext pathResolverContext
 The path resolver context used for resolving asset paths. (optional) More...
 
const PcpExpressionVariablesSource expressionVariablesOverrideSource
 

Detailed Description

Arguments used to identify a layer stack.

Objects of this type are immutable.

Definition at line 31 of file layerStackIdentifier.h.

Member Typedef Documentation

Constructor & Destructor Documentation

PCP_API PcpLayerStackIdentifier::PcpLayerStackIdentifier ( )

Construct with all empty pointers.

PCP_API PcpLayerStackIdentifier::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

size_t PcpLayerStackIdentifier::GetHash ( ) const
inline

Definition at line 88 of file layerStackIdentifier.h.

PCP_API PcpLayerStackIdentifier::operator bool ( ) const
explicit
bool PcpLayerStackIdentifier::operator!= ( const This rhs) const
inline

Definition at line 61 of file layerStackIdentifier.h.

PCP_API bool PcpLayerStackIdentifier::operator< ( const This rhs) const
bool PcpLayerStackIdentifier::operator<= ( const This rhs) const
inline

Definition at line 68 of file layerStackIdentifier.h.

PCP_API PcpLayerStackIdentifier& PcpLayerStackIdentifier::operator= ( const PcpLayerStackIdentifier )
PCP_API bool PcpLayerStackIdentifier::operator== ( const This rhs) const
bool PcpLayerStackIdentifier::operator> ( const This rhs) const
inline

Definition at line 72 of file layerStackIdentifier.h.

bool PcpLayerStackIdentifier::operator>= ( const This rhs) const
inline

Definition at line 76 of file layerStackIdentifier.h.

Member Data Documentation

const PcpExpressionVariablesSource PcpLayerStackIdentifier::expressionVariablesOverrideSource

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

Definition at line 105 of file layerStackIdentifier.h.

const ArResolverContext PcpLayerStackIdentifier::pathResolverContext

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

Definition at line 101 of file layerStackIdentifier.h.

const SdfLayerHandle PcpLayerStackIdentifier::rootLayer

The root layer.

Definition at line 95 of file layerStackIdentifier.h.

const SdfLayerHandle PcpLayerStackIdentifier::sessionLayer

The session layer (optional).

Definition at line 98 of file layerStackIdentifier.h.


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