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

#include <expressionVariablesSource.h>

Public Member Functions

PCP_API PcpExpressionVariablesSource ()
 
PCP_API PcpExpressionVariablesSource (const PcpLayerStackIdentifier &layerStackIdentifier, const PcpLayerStackIdentifier &rootLayerStackIdentifier)
 
PCP_API ~PcpExpressionVariablesSource ()
 
PCP_API size_t GetHash () const
 Return hash value for this object. More...
 
bool IsRootLayerStack () const
 
const PcpLayerStackIdentifierGetLayerStackIdentifier () const
 
PCP_API const
PcpLayerStackIdentifier
ResolveLayerStackIdentifier (const PcpLayerStackIdentifier &rootLayerStackIdentifier) const
 
PCP_API const
PcpLayerStackIdentifier
ResolveLayerStackIdentifier (const PcpCache &cache) const
 
const PcpLayerStackIdentifierResolveLayerStackIdentifier (PcpLayerStackIdentifier &&) const =delete
 
const PcpLayerStackIdentifierResolveLayerStackIdentifier (PcpCache &&) const =delete
 
Comparison Operators
PCP_API bool operator== (const PcpExpressionVariablesSource &rhs) const
 
PCP_API bool operator!= (const PcpExpressionVariablesSource &rhs) const
 
PCP_API bool operator< (const PcpExpressionVariablesSource &rhs) const
 

Detailed Description

Represents the layer stack associated with a set of expression variables. This is typically a simple PcpLayerStackIdentifier.

Definition at line 41 of file expressionVariablesSource.h.

Constructor & Destructor Documentation

PCP_API PcpExpressionVariablesSource::PcpExpressionVariablesSource ( )

Create a PcpExpressionVariableSource representing the root layer stack of a prim index.

PCP_API PcpExpressionVariablesSource::PcpExpressionVariablesSource ( const PcpLayerStackIdentifier layerStackIdentifier,
const PcpLayerStackIdentifier rootLayerStackIdentifier 
)

Create a PcpExpressionVariableSource representing the layer stack identified by layerStackIdentifier. If layerStackIdentifier is equal to rootLayerStackIdentifier, this is the same as the default constructor.

PCP_API PcpExpressionVariablesSource::~PcpExpressionVariablesSource ( )

Member Function Documentation

PCP_API size_t PcpExpressionVariablesSource::GetHash ( ) const

Return hash value for this object.

const PcpLayerStackIdentifier* PcpExpressionVariablesSource::GetLayerStackIdentifier ( ) const
inline

Return the identifier of the layer stack represented by this object if it is not the root layer stack. Return nullptr if this object represents the root layer stack (i.e., IsRootLayerStack returns true).

Definition at line 89 of file expressionVariablesSource.h.

bool PcpExpressionVariablesSource::IsRootLayerStack ( ) const
inline

Return true if this object represents a prim index's root layer stack, false otherwise. If this function returns true, GetLayerStackIdentifier will return nullptr.

Definition at line 80 of file expressionVariablesSource.h.

PCP_API bool PcpExpressionVariablesSource::operator< ( const PcpExpressionVariablesSource rhs) const
PCP_API bool PcpExpressionVariablesSource::operator== ( const PcpExpressionVariablesSource rhs) const
PCP_API const PcpLayerStackIdentifier& PcpExpressionVariablesSource::ResolveLayerStackIdentifier ( const PcpLayerStackIdentifier rootLayerStackIdentifier) const

Convenience function to return the identifier of the layer stack represented by this object. If this object represents the root layer stack, return rootLayerStackIdentifier, otherwise return *GetLayerStackIdentifier().

PCP_API const PcpLayerStackIdentifier& PcpExpressionVariablesSource::ResolveLayerStackIdentifier ( const PcpCache cache) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Equivalent to ResolveLayerStackIdentifier(cache.GetLayerStackIdentifier())

const PcpLayerStackIdentifier& PcpExpressionVariablesSource::ResolveLayerStackIdentifier ( PcpLayerStackIdentifier &&  ) const
delete
const PcpLayerStackIdentifier& PcpExpressionVariablesSource::ResolveLayerStackIdentifier ( PcpCache &&  ) const
delete

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