PcpPropertyIndex is an index of all sites in scene description that contribute opinions to a specific property, under composition semantics. More...

#include <propertyIndex.h>

Public Member Functions
PCP_API	PcpPropertyIndex ()
	Construct an empty property index.

PCP_API	PcpPropertyIndex (const PcpPropertyIndex &rhs)
	Copy-construct a property index.

PCP_API void	Swap (PcpPropertyIndex &index)
	Swap the contents of this property index with `index`.

PCP_API bool	IsEmpty () const
	Returns true if this property index contains no opinions, false otherwise.

PCP_API PcpPropertyRange	GetPropertyRange (bool localOnly=false) const
	Returns range of iterators that encompasses properties in this index's property stack.

PcpErrorVector	GetLocalErrors () const
	Return the list of errors local to this property.

PCP_API size_t	GetNumLocalSpecs () const
	Returns the number of local properties in this prim index.

Friends
class	PcpPropertyIterator

Detailed Description

PcpPropertyIndex is an index of all sites in scene description that contribute opinions to a specific property, under composition semantics.

Definition at line 65 of file propertyIndex.h.

Constructor & Destructor Documentation

◆ PcpPropertyIndex() [1/2]

PCP_API PcpPropertyIndex ( )

Construct an empty property index.

◆ PcpPropertyIndex() [2/2]

PCP_API PcpPropertyIndex ( const PcpPropertyIndex & rhs )

Copy-construct a property index.

Member Function Documentation

◆ GetLocalErrors()

PcpErrorVector GetLocalErrors ( ) const

inline

Return the list of errors local to this property.

Definition at line 95 of file propertyIndex.h.

◆ GetNumLocalSpecs()

PCP_API size_t GetNumLocalSpecs ( ) const

Returns the number of local properties in this prim index.

◆ GetPropertyRange()

PCP_API PcpPropertyRange GetPropertyRange ( bool localOnly = false ) const

Returns range of iterators that encompasses properties in this index's property stack.

By default, this returns a range encompassing all properties in the index. If localOnly is specified, the range will only include properties from local nodes in its owning prim's graph.

◆ IsEmpty()

PCP_API bool IsEmpty ( ) const

Returns true if this property index contains no opinions, false otherwise.

◆ Swap()

PCP_API void Swap ( PcpPropertyIndex & index )

Swap the contents of this property index with index.

Friends And Related Function Documentation

◆ PcpPropertyIterator

friend class PcpPropertyIterator

friend

Definition at line 104 of file propertyIndex.h.

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

pxr/usd/pcp/propertyIndex.h

Public Member Functions

Friends