EsfObjectInterface Class Reference

#include <object.h>

Inheritance diagram for EsfObjectInterface:

Public Member Functions
ESF_API	~EsfObjectInterface () override
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
ESF_API SdfPathVector	GetIncomingConnections (EsfJournal *journal) const
EsfStage	GetStage () const
ESF_API EsfSchemaConfigKey	GetSchemaConfigKey (EsfJournal *journal) const
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
ESF_API bool	IsValidMetadataKey (const TfToken &key) const
ESF_API TfType	GetMetadataValueType (const TfToken &key) const
Public Member Functions inherited from EsfFixedSizePolymorphicBase
virtual ESF_API	~EsfFixedSizePolymorphicBase ()

Protected Member Functions
	EsfObjectInterface (const SdfPath &path)
	This constructor may only be called by the scene adapter implementation. More...
const SdfPath &	_GetPath () const
	Gets the path to this object used for journaling. More...
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

ESF_API EsfObjectInterface::~EsfObjectInterface ( )

override

EsfObjectInterface::EsfObjectInterface ( const SdfPath &  path )

inlineprotected

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

Definition at line 123 of file object.h.

Member Function Documentation

const SdfPath& EsfObjectInterface::_GetPath ( ) const

inlineprotected

Gets the path to this object used for journaling.

Definition at line 126 of file object.h.

virtual EsfStage EsfObjectInterface::_GetStage ( ) const

protectedpure virtual

virtual EsfAttribute EsfObjectInterface::AsAttribute ( ) const

pure virtual

See Also

UsdObject::As

virtual EsfObject EsfObjectInterface::AsObject ( ) const

pure virtual

See Also

UsdObject::As

virtual EsfPrim EsfObjectInterface::AsPrim ( ) const

pure virtual

See Also

UsdObject::As

virtual EsfRelationship EsfObjectInterface::AsRelationship ( ) const

pure virtual

See Also

UsdObject::As

static EsfSchemaConfigKey EsfObjectInterface::CreateSchemaConfigKey ( const void *const  id )

inlinestaticprotected

Definition at line 130 of file object.h.

ESF_API SdfPathVector EsfObjectInterface::GetIncomingConnections

(

EsfJournal *

journal

)

const

Returns the paths of all attributes that have connections that target the object.

ESF_API VtValue EsfObjectInterface::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.

ESF_API TfType EsfObjectInterface::GetMetadataValueType

(

const TfToken &

key

)

const

Returns the value type for the indicated key.

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

ESF_API TfToken EsfObjectInterface::GetName

(

EsfJournal *

journal

)

const

See Also

UsdObject::GetName

ESF_API SdfPath EsfObjectInterface::GetPath

(

EsfJournal *

journal

)

const

See Also

UsdObject::GetPath

ESF_API EsfPrim EsfObjectInterface::GetPrim

(

EsfJournal *

journal

)

const

See Also

UsdObject::GetPrim

ESF_API EsfSchemaConfigKey EsfObjectInterface::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.

EsfStage EsfObjectInterface::GetStage ( ) const

inline

See Also

UsdObject::GetStage

Definition at line 67 of file object.h.

virtual bool EsfObjectInterface::IsAttribute ( ) const

pure virtual

See Also

UsdObject::Is

virtual bool EsfObjectInterface::IsPrim ( ) const

pure virtual

See Also

UsdObject::Is

virtual bool EsfObjectInterface::IsRelationship ( ) const

pure virtual

See Also

UsdObject::Is

ESF_API bool EsfObjectInterface::IsValid

(

EsfJournal *

journal

)

const

See Also

UsdObject::IsValid

ESF_API bool EsfObjectInterface::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