PcpPropertyIndex Class Reference

#include <propertyIndex.h>

Public Member Functions
PCP_API	PcpPropertyIndex ()
	Construct an empty property index. More...
PCP_API	PcpPropertyIndex (const PcpPropertyIndex &rhs)
	Copy-construct a property index. More...
PCP_API void	Swap (PcpPropertyIndex &index)
	Swap the contents of this property index with index. More...
PCP_API bool	IsEmpty () const
PCP_API PcpPropertyRange	GetPropertyRange (bool localOnly=false) const
PcpErrorVector	GetLocalErrors () const
	Return the list of errors local to this property. More...
PCP_API size_t	GetNumLocalSpecs () const
	Returns the number of local properties in this prim index. More...

Friends
class	PcpPropertyIterator
class	Pcp_PropertyIndexer

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

PCP_API PcpPropertyIndex::PcpPropertyIndex

(

)

Construct an empty property index.

PCP_API PcpPropertyIndex::PcpPropertyIndex

(

const PcpPropertyIndex &

rhs

)

Copy-construct a property index.

Member Function Documentation

PcpErrorVector PcpPropertyIndex::GetLocalErrors ( ) const

inline

Return the list of errors local to this property.

Definition at line 95 of file propertyIndex.h.

PCP_API size_t PcpPropertyIndex::GetNumLocalSpecs

(

)

const

Returns the number of local properties in this prim index.

PCP_API PcpPropertyRange PcpPropertyIndex::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.

PCP_API bool PcpPropertyIndex::IsEmpty

(

)

const

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

PCP_API void PcpPropertyIndex::Swap

(

PcpPropertyIndex &

index

)

Swap the contents of this property index with index.

Friends And Related Function Documentation

friend class Pcp_PropertyIndexer

friend

Definition at line 105 of file propertyIndex.h.

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