Loading...
Searching...
No Matches
EsfAttributeInterface Class Referenceabstract

Attribute abstraction for scene adapter implementations. More...

#include <attribute.h>

+ Inheritance diagram for EsfAttributeInterface:

Public Member Functions

ESF_API SdfValueTypeName GetValueTypeName (EsfJournal *journal) const
 
ESF_API EsfAttributeQuery GetQuery () const
 Returns an object for caching and querying value resolution information.
 
ESF_API SdfPathVector GetConnections (EsfJournal *journal) const
 
- Public Member Functions inherited from EsfPropertyInterface
ESF_API TfToken GetBaseName (EsfJournal *journal) const
 
ESF_API TfToken GetNamespace (EsfJournal *journal) const
 
- Public Member Functions inherited from EsfObjectInterface
ESF_API bool IsValid (EsfJournal *journal) const
 
ESF_API SdfPath GetPath (EsfJournal *journal) const
 
ESF_API TfToken GetName (EsfJournal *journal) const
 
ESF_API EsfPrim GetPrim (EsfJournal *journal) const
 
EsfStage GetStage () const
 
ESF_API EsfSchemaConfigKey GetSchemaConfigKey (EsfJournal *journal) const
 Returns an opaque value that is guaranteed to be unique and stable.
 
virtual bool IsPrim () const =0
 
virtual bool IsAttribute () const =0
 
virtual bool IsRelationship () const =0
 
virtual EsfObject AsObject () const =0
 
virtual EsfAttribute AsAttribute () const =0
 
virtual EsfRelationship AsRelationship () const =0
 
virtual EsfPrim AsPrim () const =0
 
ESF_API VtValue GetMetadata (const TfToken &key) const
 Returns the value of the metadata field indicated by key.
 
ESF_API bool IsValidMetadataKey (const TfToken &key) const
 Returns true if the field indicated by key is a valid metadata field for this object.
 
ESF_API TfType GetMetadataValueType (const TfToken &key) const
 Returns the value type for the indicated key.
 

Protected Member Functions

 EsfAttributeInterface (const SdfPath &path)
 This constructor may only be called by the scene adapter implementation.
 
- Protected Member Functions inherited from EsfPropertyInterface
 EsfPropertyInterface (const SdfPath &path)
 This constructor may only be called by the scene adapter implementation.
 
- Protected Member Functions inherited from EsfObjectInterface
 EsfObjectInterface (const SdfPath &path)
 This constructor may only be called by the scene adapter implementation.
 
const SdfPath_GetPath () const
 Gets the path to this object used for journaling.
 
virtual EsfStage _GetStage () const =0
 

Additional Inherited Members

- Static Protected Member Functions inherited from EsfObjectInterface
static EsfSchemaConfigKey CreateSchemaConfigKey (const void *const id)
 

Detailed Description

Attribute abstraction for scene adapter implementations.

The attribute abstraction closely resembles the read-only interface of UsdAttribute.

The public methods of this class are called by the exec network compiler. Each method takes an argument of type EsfJournal* which captures the conditions for recompilation.

Definition at line 35 of file attribute.h.

Constructor & Destructor Documentation

◆ EsfAttributeInterface()

EsfAttributeInterface ( const SdfPath path)
inlineprotected

This constructor may only be called by the scene adapter implementation.

Definition at line 53 of file attribute.h.

Member Function Documentation

◆ GetConnections()

ESF_API SdfPathVector GetConnections ( EsfJournal journal) const

◆ GetQuery()

ESF_API EsfAttributeQuery GetQuery ( ) const

Returns an object for caching and querying value resolution information.

See also
UsdAttributeQuery

◆ GetValueTypeName()

ESF_API SdfValueTypeName GetValueTypeName ( EsfJournal journal) const
See also
UsdAttribute::GetValueTypeName

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