HdPrimOriginSchema Class Reference

#include <primOriginSchema.h>

Inheritance diagram for HdPrimOriginSchema:

Classes
class	OriginPath

Public Types
using	OriginPathDataSource = HdTypedSampledDataSource< OriginPath >
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource

Public Member Functions
HD_API SdfPath	GetOriginPath (const TfToken &name) const
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
Schema location
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static HD_API const HdDataSourceLocator &	GetScenePathLocator ()

Schema retrieval
	HdPrimOriginSchema (HdContainerDataSourceHandle container)
static HD_API HdPrimOriginSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 45 of file primOriginSchema.h.

Member Typedef Documentation

using HdPrimOriginSchema::OriginPathDataSource = HdTypedSampledDataSource<OriginPath>

Definition at line 89 of file primOriginSchema.h.

Constructor & Destructor Documentation

HdPrimOriginSchema::HdPrimOriginSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "primOrigin" from the parent container and constructs a HdPrimOriginSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

Definition at line 51 of file primOriginSchema.h.

Member Function Documentation

static HD_API const HdDataSourceLocator& HdPrimOriginSchema::GetDefaultLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static HD_API HdPrimOriginSchema HdPrimOriginSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "primOrigin" from the parent container and constructs a HdPrimOriginSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

HD_API SdfPath HdPrimOriginSchema::GetOriginPath

(

const TfToken &

name

)

const

Extracts SdfPath from container that was added via OriginPathDataSource.

static HD_API const HdDataSourceLocator& HdPrimOriginSchema::GetScenePathLocator ( )

static

Additional prim-level relative data source locator to locate scenePath.

static HD_API const TfToken& HdPrimOriginSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

---

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

• pxr/imaging/hd/primOriginSchema.h