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

#include <primvarSchema.h>

+ Inheritance diagram for HdPrimvarSchema:

Classes

class  Builder
 

Public Member Functions

HD_API HdSampledDataSourceHandle GetPrimvarValue () const
 
HD_API HdSampledDataSourceHandle GetIndexedPrimvarValue () const
 
HD_API bool IsIndexed () const
 
HD_API HdSampledDataSourceHandle GetFlattenedPrimvarValue () const
 
Schema retrieval
 HdPrimvarSchema (HdContainerDataSourceHandle container)
 
Member accessor
HD_API HdIntArrayDataSourceHandle GetIndices () const
 
HD_API HdTokenDataSourceHandle GetInterpolation () const
 
HD_API HdTokenDataSourceHandle GetRole () const
 
HD_API HdIntDataSourceHandle GetElementSize () 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 construction
static HD_API
HdContainerDataSourceHandle 		BuildRetained (const HdSampledDataSourceHandle &primvarValue, const HdSampledDataSourceHandle &indexedPrimvarValue, const HdIntArrayDataSourceHandle &indices, const HdTokenDataSourceHandle &interpolation, const HdTokenDataSourceHandle &role, const HdIntDataSourceHandle &elementSize)
 
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) const
 
- Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle _container
 

Detailed Description

Definition at line 64 of file primvarSchema.h.

Constructor & Destructor Documentation

HdPrimvarSchema::HdPrimvarSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 70 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.

The following values will be stored statically and reused for future calls:

  • HdPrimvarSchemaTokens->constant
  • HdPrimvarSchemaTokens->uniform
  • HdPrimvarSchemaTokens->varying
  • HdPrimvarSchemaTokens->vertex
  • HdPrimvarSchemaTokens->faceVarying
  • HdPrimvarSchemaTokens->instance
static HD_API HdContainerDataSourceHandle HdPrimvarSchema::BuildRetained ( const HdSampledDataSourceHandle &  primvarValue,
const HdSampledDataSourceHandle &  indexedPrimvarValue,
const HdIntArrayDataSourceHandle &  indices,
const HdTokenDataSourceHandle &  interpolation,
const HdTokenDataSourceHandle &  role,
const HdIntDataSourceHandle &  elementSize 
)
static
Deprecated:
Use Builder instead.

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.

The following values will be stored statically and reused for future calls:

  • HdPrimvarSchemaTokens->point
  • HdPrimvarSchemaTokens->normal
  • HdPrimvarSchemaTokens->vector
  • HdPrimvarSchemaTokens->color
  • HdPrimvarSchemaTokens->pointIndex
  • HdPrimvarSchemaTokens->edgeIndex
  • HdPrimvarSchemaTokens->faceIndex
  • HdPrimvarSchemaTokens->textureCoordinate
HD_API HdIntDataSourceHandle HdPrimvarSchema::GetElementSize ( ) const

The number of values in the value array that must be aggregated for each element on the the primitive (same as UsdGeomPrimvar).

HD_API HdSampledDataSourceHandle HdPrimvarSchema::GetFlattenedPrimvarValue ( ) const
HD_API HdSampledDataSourceHandle HdPrimvarSchema::GetIndexedPrimvarValue ( ) const
HD_API HdIntArrayDataSourceHandle HdPrimvarSchema::GetIndices ( ) const

The number of values in the value array that must be aggregated for each element on the the primitive (same as UsdGeomPrimvar).

HD_API HdTokenDataSourceHandle HdPrimvarSchema::GetInterpolation ( ) const

The number of values in the value array that must be aggregated for each element on the the primitive (same as UsdGeomPrimvar).

HD_API HdSampledDataSourceHandle HdPrimvarSchema::GetPrimvarValue ( ) const
HD_API HdTokenDataSourceHandle HdPrimvarSchema::GetRole ( ) const

The number of values in the value array that must be aggregated for each element on the the primitive (same as UsdGeomPrimvar).

HD_API bool HdPrimvarSchema::IsIndexed ( ) const
The documentation for this class was generated from the following file: