All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdPrimOriginSchema Class Reference

#include <primOriginSchema.h>

+ Inheritance diagram for HdPrimOriginSchema:


class  OriginPath

Public Types

using OriginPathDataSource = HdTypedSampledDataSource< OriginPath >

Public Member Functions

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

Static Public Member Functions

static HD_API HdPrimOriginSchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfTokenGetSchemaToken ()
static HD_API const
GetDefaultLocator ()
static HD_API const
GetScenePathLocator ()

Additional Inherited Members

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

Detailed Description

Definition at line 51 of file primOriginSchema.h.

Member Typedef Documentation

Constructor & Destructor Documentation

HdPrimOriginSchema::HdPrimOriginSchema ( HdContainerDataSourceHandle  container)

Definition at line 54 of file primOriginSchema.h.

Member Function Documentation

static HD_API const HdDataSourceLocator& HdPrimOriginSchema::GetDefaultLocator ( )

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)

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

Returns an HdDataSourceLocator (relative to the prim-level data source) where the scenepath data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

static HD_API const TfToken& HdPrimOriginSchema::GetSchemaToken ( )

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: