HdPrimvarsSchema Class Reference

#include <primvarsSchema.h>

Inheritance diagram for HdPrimvarsSchema:

Public Member Functions
	HdPrimvarsSchema (HdContainerDataSourceHandle container)
HD_API TfTokenVector	GetPrimvarNames ()
HD_API HdPrimvarSchema	GetPrimvar (TfToken name)
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 HdPrimvarsSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
static HD_API const HdDataSourceLocator &	GetPointsLocator ()
static HD_API const HdDataSourceLocator &	GetNormalsLocator ()
static HD_API const HdDataSourceLocator &	GetWidthsLocator ()

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 54 of file primvarsSchema.h.

Constructor & Destructor Documentation

HdPrimvarsSchema::HdPrimvarsSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 57 of file primvarsSchema.h.

Member Function Documentation

static HD_API const HdDataSourceLocator& HdPrimvarsSchema::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 HdPrimvarsSchema HdPrimvarsSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

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

static HD_API const HdDataSourceLocator& HdPrimvarsSchema::GetNormalsLocator ( )

static

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

static HD_API const HdDataSourceLocator& HdPrimvarsSchema::GetPointsLocator ( )

static

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

HD_API HdPrimvarSchema HdPrimvarsSchema::GetPrimvar

(

TfToken

name

)

HD_API TfTokenVector HdPrimvarsSchema::GetPrimvarNames

(

)

static HD_API const TfToken& HdPrimvarsSchema::GetSchemaToken ( )

static

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

static HD_API const HdDataSourceLocator& HdPrimvarsSchema::GetWidthsLocator ( )

static

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

---

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

• pxr/imaging/hd/primvarsSchema.h