PcpInstanceKey Class Reference

#include <instanceKey.h>

Classes
struct	Hash

Public Member Functions
PCP_API	PcpInstanceKey ()
PCP_API	PcpInstanceKey (const PcpPrimIndex &primIndex)
	Create an instance key for the given prim index. More...
PCP_API bool	operator== (const PcpInstanceKey &rhs) const
	Comparison operators. More...
PCP_API bool	operator!= (const PcpInstanceKey &rhs) const
PCP_API std::string	GetString () const

Friends
template<typename HashState >
void	TfHashAppend (HashState &h, const PcpInstanceKey &key)
	Appends hash value for this instance key. More...
size_t	hash_value (const PcpInstanceKey &key)
	Returns hash value for this instance key. More...

Detailed Description

A PcpInstanceKey identifies instanceable prim indexes that share the same set of opinions. Instanceable prim indexes with equal instance keys are guaranteed to have the same opinions for name children and properties beneath those name children. They are NOT guaranteed to have the same opinions for direct properties of the prim indexes themselves.

Definition at line 53 of file instanceKey.h.

Constructor & Destructor Documentation

PCP_API PcpInstanceKey::PcpInstanceKey

(

)

PCP_API PcpInstanceKey::PcpInstanceKey ( const PcpPrimIndex &  primIndex )

explicit

Create an instance key for the given prim index.

Member Function Documentation

PCP_API std::string PcpInstanceKey::GetString

(

)

const

Returns string representation of this instance key for debugging purposes.

PCP_API bool PcpInstanceKey::operator!=

(

const PcpInstanceKey &

rhs

)

const

PCP_API bool PcpInstanceKey::operator==

(

const PcpInstanceKey &

rhs

)

const

Comparison operators.

Friends And Related Function Documentation

size_t hash_value ( const PcpInstanceKey &  key )

friend

Returns hash value for this instance key.

Definition at line 76 of file instanceKey.h.

template<typename HashState >

void TfHashAppend ( HashState &  h, const PcpInstanceKey &  key  )

friend

Appends hash value for this instance key.

Definition at line 71 of file instanceKey.h.

---

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

• pxr/usd/pcp/instanceKey.h