HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Static Public Member Functions | List of all members
HdPrimvarSchema Class Reference

#include <primvarSchema.h>

+ Inheritance diagram for HdPrimvarSchema:

Classes

class  Builder
 

Public Member Functions

 HdPrimvarSchema (HdContainerDataSourceHandle container)
 
HD_API HdSampledDataSourceHandle GetPrimvarValue ()
 
HD_API HdSampledDataSourceHandle GetIndexedPrimvarValue ()
 
HD_API bool IsIndexed ()
 
HD_API HdSampledDataSourceHandle GetFlattenedPrimvarValue ()
 
HD_API HdIntArrayDataSourceHandle GetIndices ()
 
HD_API HdTokenDataSourceHandle GetInterpolation ()
 
HD_API HdTokenDataSourceHandle GetRole ()
 
- 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
HdContainerDataSourceHandle 		BuildRetained (const HdSampledDataSourceHandle &primvarValue, const HdSampledDataSourceHandle &indexedPrimvarValue, const HdIntArrayDataSourceHandle &indices, const HdTokenDataSourceHandle &interpolation, const HdTokenDataSourceHandle &role)
 
static HD_API
HdTokenDataSourceHandle 		BuildInterpolationDataSource (const TfToken &interpolation)
 
static HD_API
HdTokenDataSourceHandle 		BuildRoleDataSource (const TfToken &role)
 

Additional Inherited Members

- Public Types inherited from HdSchema
using UnderlyingDataSource = HdContainerDataSource
 
- 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 82 of file primvarSchema.h.

Constructor & Destructor Documentation

HdPrimvarSchema::HdPrimvarSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 85 of file primvarSchema.h.

Member Function Documentation

static HD_API HdTokenDataSourceHandle HdPrimvarSchema::BuildInterpolationDataSource ( const TfToken &  interpolation)
static

Returns token data source for use as interpolation value. Values of...

  • HdPrimvarSchemaTokens->constant
  • HdPrimvarSchemaTokens->uniform
  • HdPrimvarSchemaTokens->varying
  • HdPrimvarSchemaTokens->vertex
  • HdPrimvarSchemaTokens->faceVarying
  • HdPrimvarSchemaTokens->instance ...will be stored statically and reused for future calls.
static HD_API HdContainerDataSourceHandle HdPrimvarSchema::BuildRetained ( const HdSampledDataSourceHandle &  primvarValue,
const HdSampledDataSourceHandle &  indexedPrimvarValue,
const HdIntArrayDataSourceHandle &  indices,
const HdTokenDataSourceHandle &  interpolation,
const HdTokenDataSourceHandle &  role 
)
static

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

static HD_API HdTokenDataSourceHandle HdPrimvarSchema::BuildRoleDataSource ( const TfToken &  role)
static

Returns token data source for use as role value. Values of...

  • HdPrimvarSchemaTokens->point
  • HdPrimvarSchemaTokens->normal
  • HdPrimvarSchemaTokens->vector
  • HdPrimvarSchemaTokens->color
  • HdPrimvarSchemaTokens->pointIndex
  • HdPrimvarSchemaTokens->edgeIndex
  • HdPrimvarSchemaTokens->faceIndex
  • HdPrimvarSchemaTokens->textureCoordinate ...will be stored statically and reused for future calls.
HD_API HdSampledDataSourceHandle HdPrimvarSchema::GetFlattenedPrimvarValue ( )
HD_API HdSampledDataSourceHandle HdPrimvarSchema::GetIndexedPrimvarValue ( )
HD_API HdIntArrayDataSourceHandle HdPrimvarSchema::GetIndices ( )
HD_API HdTokenDataSourceHandle HdPrimvarSchema::GetInterpolation ( )
HD_API HdSampledDataSourceHandle HdPrimvarSchema::GetPrimvarValue ( )
HD_API HdTokenDataSourceHandle HdPrimvarSchema::GetRole ( )
HD_API bool HdPrimvarSchema::IsIndexed ( )
The documentation for this class was generated from the following file: