HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
UsdPrimDefinition::Relationship Class Reference

#include <primDefinition.h>

+ Inheritance diagram for UsdPrimDefinition::Relationship:

Public Member Functions

 Relationship ()=default
 Default constructor returns an invalid relationship. More...
 
USD_API Relationship (const Property &property)
 Copy constructor from a Property to allow implicit conversion. More...
 
USD_API Relationship (Property &&property)
 Move constructor from a Property to allow implicit conversion. More...
 
 operator bool () const
 
- Public Member Functions inherited from UsdPrimDefinition::Property
 Property ()=default
 Default constructor returns an invalid property. More...
 
USD_API const TfToken & GetName () const
 
 operator bool () const
 
USD_API bool IsAttribute () const
 
USD_API bool IsRelationship () const
 
USD_API SdfSpecType GetSpecType () const
 Returns the spec type of this property in the prim definition. More...
 
USD_API TfTokenVector ListMetadataFields () const
 
template<class T >
bool GetMetadata (const TfToken &key, T *value) const
 
template<class T >
bool GetMetadataByDictKey (const TfToken &key, const TfToken &keyPath, T *value) const
 
USD_API SdfVariability GetVariability () const
 Returns the variability of this property in the prim definition. More...
 
USD_API std::string GetDocumentation () const
 

Additional Inherited Members

- Protected Member Functions inherited from UsdPrimDefinition::Property
 Property (const TfToken &name, const _LayerAndPath *layerAndPath)
 
 Property (const _LayerAndPath *layerAndPath)
 
- Protected Attributes inherited from UsdPrimDefinition::Property
TfToken _name
 
const _LayerAndPath * _layerAndPath = nullptr
 

Detailed Description

Accessor to a relationship's definition in the prim definition.

These are returned by calls to UsdPrimDefinition::GetRelationshipDefinition and can be freely converted to from a Property accessor. These can be used to check that a property exists and is a relationship (via conversion to bool) and to get relationship relevant field values that are defined for a property in the prim definition.

This class is just a thin wrapper around the property representation in the UsdPrimDefinition that creates it and cannot be stored or accessed beyond the lifetime of the prim definition itself.

Definition at line 249 of file primDefinition.h.

Constructor & Destructor Documentation

UsdPrimDefinition::Relationship::Relationship ( )
default

Default constructor returns an invalid relationship.

USD_API UsdPrimDefinition::Relationship::Relationship ( const Property &  property)

Copy constructor from a Property to allow implicit conversion.

USD_API UsdPrimDefinition::Relationship::Relationship ( Property &&  property)

Move constructor from a Property to allow implicit conversion.

Member Function Documentation

UsdPrimDefinition::Relationship::operator bool ( ) const
inlineexplicit

Conversion to bool returns true if this represents a valid property in the prim definition that is a relationship, and false otherwise.

Definition at line 264 of file primDefinition.h.

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