All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
reference.h File Reference
+ Include dependency graph for reference.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  SdfReference
 Represents a reference and all its meta data. More...
 
struct  SdfReference::IdentityEqual
 Struct that defines equality of SdfReferences based on their identity (the asset path and prim path). More...
 
struct  SdfReference::IdentityLessThan
 Struct that defines a strict weak ordering of SdfReferences based on their identity (the asset path and prim path). More...
 

Typedefs

typedef std::vector< SdfReferenceSdfReferenceVector
 

Functions

SDF_API int SdfFindReferenceByIdentity (const SdfReferenceVector &references, const SdfReference &referenceId)
 Convenience function to find the index of the reference in references that has the same identity as the given reference referenceId.
 
SDF_API std::ostream & operator<< (std::ostream &out, const SdfReference &reference)
 Writes the string representation of SdfReference to out.
 

Typedef Documentation

◆ SdfReferenceVector

typedef std::vector<SdfReference> SdfReferenceVector

Definition at line 29 of file reference.h.

Function Documentation

◆ operator<<()

SDF_API std::ostream & operator<< ( std::ostream &  out,
const SdfReference reference 
)

Writes the string representation of SdfReference to out.

◆ SdfFindReferenceByIdentity()

SDF_API int SdfFindReferenceByIdentity ( const SdfReferenceVector &  references,
const SdfReference referenceId 
)

Convenience function to find the index of the reference in references that has the same identity as the given reference referenceId.

A reference's identity is given by its asset path and prim path alone (i.e. the layer offset and custom data is ignored).

If no reference with the same identity exists in reference, -1 is returned. If more than one reference with the same identity exist in references the index of the first one is returned.