Prim abstraction for scene adapter implementations. More...

#include <prim.h>

Inheritance diagram for EsfPrimInterface:

Public Member Functions
ESF_API const TfTokenVector &	GetAppliedSchemas (EsfJournal *journal) const

ESF_API EsfAttribute	GetAttribute (const TfToken &attributeName, EsfJournal *journal) const

ESF_API EsfRelationship	GetRelationship (const TfToken &relationshipName, EsfJournal *journal) const

ESF_API EsfPrim	GetParent (EsfJournal *journal) const

ESF_API TfType	GetType (EsfJournal *journal) const

virtual bool	IsPseudoRoot () const =0

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
	EsfPrimInterface (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

Prim abstraction for scene adapter implementations.

The prim abstraction closely resembles the read-only interface of UsdPrim.

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 36 of file prim.h.

Constructor & Destructor Documentation

◆ EsfPrimInterface()

EsfPrimInterface ( const SdfPath & path )

inlineprotected

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

Definition at line 65 of file prim.h.

Member Function Documentation

◆ GetAppliedSchemas()

ESF_API const TfTokenVector & GetAppliedSchemas ( EsfJournal * journal ) const

See also: UsdPrim::GetAppliedSchemas

◆ GetAttribute()

ESF_API EsfAttribute GetAttribute	(	const TfToken &	attributeName,
		EsfJournal *	journal
	)		const

See also: UsdPrim::GetAttribute

◆ GetParent()

ESF_API EsfPrim GetParent ( EsfJournal * journal ) const

See also: UsdPrim::GetParent

◆ GetRelationship()

ESF_API EsfRelationship GetRelationship	(	const TfToken &	relationshipName,
		EsfJournal *	journal
	)		const

See also: UsdPrim::GetRelationship

◆ GetType()

ESF_API TfType GetType ( EsfJournal * journal ) const

See also: UsdPrim::GetPrimTypeInfo and; UsdPrimTypeInfo::GetSchemaType

◆ IsPseudoRoot()

virtual bool IsPseudoRoot ( ) const

pure virtual

See also: UsdPrim::IsPseudoRoot

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

pxr/exec/esf/prim.h

Public Member Functions

Protected Member Functions

Additional Inherited Members