This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
PcpInstanceKey Class Reference

A PcpInstanceKey identifies instanceable prim indexes that share the same set of opinions. More...

#include <instanceKey.h>

Classes

struct  Hash
 Hash functor. More...
 

Public Member Functions

PCP_API PcpInstanceKey (const PcpPrimIndex &primIndex)
 Create an instance key for the given prim index.
 
PCP_API bool operator== (const PcpInstanceKey &rhs) const
 Comparison operators.
 
PCP_API bool operator!= (const PcpInstanceKey &rhs) const
 
PCP_API std::string GetString () const
 Returns string representation of this instance key for debugging purposes.
 

Friends

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

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 36 of file instanceKey.h.

Constructor & Destructor Documentation

◆ PcpInstanceKey()

PCP_API PcpInstanceKey ( const PcpPrimIndex primIndex)
explicit

Create an instance key for the given prim index.

Member Function Documentation

◆ GetString()

PCP_API std::string GetString ( ) const

Returns string representation of this instance key for debugging purposes.

◆ operator==()

PCP_API bool operator== ( const PcpInstanceKey rhs) const

Comparison operators.

Friends And Related Function Documentation

◆ hash_value

size_t hash_value ( const PcpInstanceKey key)
friend

Returns hash value for this instance key.

Definition at line 59 of file instanceKey.h.

◆ TfHashAppend

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

Appends hash value for this instance key.

Definition at line 54 of file instanceKey.h.


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