EsfObjectInterface Class Reference

Scene object abstraction for scene adapter implementations. More...

#include <object.h>

Inheritance diagram for EsfObjectInterface:

Public Member Functions
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
Metadata
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
	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

Static Protected Member Functions
static EsfSchemaConfigKey	CreateSchemaConfigKey (const void *const id)

Detailed Description

Scene object abstraction for scene adapter implementations.

The scene object abstraction closely resembles the read-only interface of UsdObject.

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.

This class and all classes derived from it are compatible with EsfFixedSizePolymorphicHolder.

Definition at line 44 of file object.h.

Constructor & Destructor Documentation

EsfObjectInterface()

EsfObjectInterface ( const SdfPath &  path )

inlineprotected

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

Definition at line 118 of file object.h.

Member Function Documentation

_GetPath()

const SdfPath & _GetPath ( ) const

inlineprotected

Gets the path to this object used for journaling.

Definition at line 121 of file object.h.

AsAttribute()

virtual EsfAttribute AsAttribute ( ) const

pure virtual

See also

UsdObject::As

AsObject()

virtual EsfObject AsObject ( ) const

pure virtual

See also

UsdObject::As

AsPrim()

virtual EsfPrim AsPrim ( ) const

pure virtual

See also

UsdObject::As

AsRelationship()

virtual EsfRelationship AsRelationship ( ) const

pure virtual

See also

UsdObject::As

CreateSchemaConfigKey()

static EsfSchemaConfigKey CreateSchemaConfigKey ( const void *const  id )

inlinestaticprotected

Definition at line 125 of file object.h.

GetMetadata()

ESF_API VtValue GetMetadata

(

const TfToken &

key

)

const

Returns the value of the metadata field indicated by key.

Emits an error if key is not a valid metadata key.

GetMetadataValueType()

ESF_API TfType GetMetadataValueType

(

const TfToken &

key

)

const

Returns the value type for the indicated key.

Emits an error if key is not a valid metadata key.

GetName()

ESF_API TfToken GetName

(

EsfJournal *

journal

)

const

See also

UsdObject::GetName

GetPath()

ESF_API SdfPath GetPath

(

EsfJournal *

journal

)

const

See also

UsdObject::GetPath

GetPrim()

ESF_API EsfPrim GetPrim

(

EsfJournal *

journal

)

const

See also

UsdObject::GetPrim

GetSchemaConfigKey()

ESF_API EsfSchemaConfigKey GetSchemaConfigKey

(

EsfJournal *

journal

)

const

Returns an opaque value that is guaranteed to be unique and stable.

Any prims that have the same typed schema and the same list of applied schemas will have the same schema config key.

GetStage()

EsfStage GetStage ( ) const

inline

See also

UsdObject::GetStage

Definition at line 62 of file object.h.

IsAttribute()

virtual bool IsAttribute ( ) const

pure virtual

See also

UsdObject::Is

IsPrim()

virtual bool IsPrim ( ) const

pure virtual

See also

UsdObject::Is

IsRelationship()

virtual bool IsRelationship ( ) const

pure virtual

See also

UsdObject::Is

IsValid()

ESF_API bool IsValid

(

EsfJournal *

journal

)

const

See also

UsdObject::IsValid

IsValidMetadataKey()

ESF_API bool IsValidMetadataKey

(

const TfToken &

key

)

const

Returns true if the field indicated by key is a valid metadata field for this object.

---

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

• pxr/exec/esf/object.h