Represents the layer stack associated with a set of expression variables. More...

#include <expressionVariablesSource.h>

Public Member Functions
PCP_API	PcpExpressionVariablesSource ()
	Create a PcpExpressionVariableSource representing the root layer stack of a prim index.

PCP_API	PcpExpressionVariablesSource (const PcpLayerStackIdentifier &layerStackIdentifier, const PcpLayerStackIdentifier &rootLayerStackIdentifier)
	Create a PcpExpressionVariableSource representing the layer stack identified by `layerStackIdentifier`.

PCP_API size_t	GetHash () const
	Return hash value for this object.

bool	IsRootLayerStack () const
	Return true if this object represents a prim index's root layer stack, false otherwise.

const PcpLayerStackIdentifier *	GetLayerStackIdentifier () const
	Return the identifier of the layer stack represented by this object if it is not the root layer stack.

PCP_API const PcpLayerStackIdentifier &	ResolveLayerStackIdentifier (const PcpLayerStackIdentifier &rootLayerStackIdentifier) const
	Convenience function to return the identifier of the layer stack represented by this object.

PCP_API const PcpLayerStackIdentifier &	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 &	ResolveLayerStackIdentifier (PcpLayerStackIdentifier &&) const =delete

const PcpLayerStackIdentifier &	ResolveLayerStackIdentifier (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

◆ PcpExpressionVariablesSource() [1/2]

PCP_API PcpExpressionVariablesSource ( )

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

◆ PcpExpressionVariablesSource() [2/2]

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

Member Function Documentation

◆ GetHash()

PCP_API size_t GetHash ( ) const

Return hash value for this object.

◆ GetLayerStackIdentifier()

const PcpLayerStackIdentifier * 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.

◆ IsRootLayerStack()

bool 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.

◆ ResolveLayerStackIdentifier() [1/2]

PCP_API const PcpLayerStackIdentifier & 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())

◆ ResolveLayerStackIdentifier() [2/2]

PCP_API const PcpLayerStackIdentifier & 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().

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

pxr/usd/pcp/expressionVariablesSource.h

Public Member Functions