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

#include <nurbsPatchSchema.h>

+ Inheritance diagram for HdNurbsPatchSchema:

Classes

class  Builder
 

Public Member Functions

Member accessor
HD_API HdIntDataSourceHandle GetUVertexCount () const
 
HD_API HdIntDataSourceHandle GetVVertexCount () const
 
HD_API HdIntDataSourceHandle GetUOrder () const
 
HD_API HdIntDataSourceHandle GetVOrder () const
 
HD_API
HdDoubleArrayDataSourceHandle 		GetUKnots () const
 
HD_API
HdDoubleArrayDataSourceHandle 		GetVKnots () const
 
HD_API HdTokenDataSourceHandle GetUForm () const
 
HD_API HdTokenDataSourceHandle GetVForm () const
 
HD_API HdVec2dDataSourceHandle GetURange () const
 
HD_API HdVec2dDataSourceHandle GetVRange () const
 
HD_API HdNurbsPatchTrimCurveSchema GetTrimCurve () const
 
HD_API HdTokenDataSourceHandle GetOrientation () const
 
HD_API HdBoolDataSourceHandle GetDoubleSided () 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 ()
 
Schema construction
static HD_API
HdContainerDataSourceHandle 		BuildRetained (const HdIntDataSourceHandle &uVertexCount, const HdIntDataSourceHandle &vVertexCount, const HdIntDataSourceHandle &uOrder, const HdIntDataSourceHandle &vOrder, const HdDoubleArrayDataSourceHandle &uKnots, const HdDoubleArrayDataSourceHandle &vKnots, const HdTokenDataSourceHandle &uForm, const HdTokenDataSourceHandle &vForm, const HdVec2dDataSourceHandle &uRange, const HdVec2dDataSourceHandle &vRange, const HdContainerDataSourceHandle &trimCurve, const HdTokenDataSourceHandle &orientation, const HdBoolDataSourceHandle &doubleSided)
 
static HD_API
HdTokenDataSourceHandle 		BuildFormDataSource (const TfToken &form)
 
static HD_API
HdTokenDataSourceHandle 		BuildOrientationDataSource (const TfToken &orientation)
 

Schema retrieval

 HdNurbsPatchSchema (HdContainerDataSourceHandle container)
 
static HD_API HdNurbsPatchSchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 

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 63 of file nurbsPatchSchema.h.

Constructor & Destructor Documentation

HdNurbsPatchSchema::HdNurbsPatchSchema ( HdContainerDataSourceHandle  container)
inline

Retrieves a container data source with the schema's default name token "nurbsPatch" from the parent container and constructs a HdNurbsPatchSchema 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 69 of file nurbsPatchSchema.h.

Member Function Documentation

static HD_API HdTokenDataSourceHandle HdNurbsPatchSchema::BuildFormDataSource ( const TfToken &  form)
static

Returns token data source for use as form value.

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

  • HdNurbsPatchSchemaTokens->open
  • HdNurbsPatchSchemaTokens->closed
  • HdNurbsPatchSchemaTokens->periodic
static HD_API HdTokenDataSourceHandle HdNurbsPatchSchema::BuildOrientationDataSource ( const TfToken &  orientation)
static

Returns token data source for use as orientation value.

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

  • HdNurbsPatchSchemaTokens->leftHanded
  • HdNurbsPatchSchemaTokens->rightHanded
static HD_API HdContainerDataSourceHandle HdNurbsPatchSchema::BuildRetained ( const HdIntDataSourceHandle &  uVertexCount,
const HdIntDataSourceHandle &  vVertexCount,
const HdIntDataSourceHandle &  uOrder,
const HdIntDataSourceHandle &  vOrder,
const HdDoubleArrayDataSourceHandle &  uKnots,
const HdDoubleArrayDataSourceHandle &  vKnots,
const HdTokenDataSourceHandle &  uForm,
const HdTokenDataSourceHandle &  vForm,
const HdVec2dDataSourceHandle &  uRange,
const HdVec2dDataSourceHandle &  vRange,
const HdContainerDataSourceHandle &  trimCurve,
const HdTokenDataSourceHandle &  orientation,
const HdBoolDataSourceHandle &  doubleSided 
)
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 const HdDataSourceLocator& HdNurbsPatchSchema::GetDefaultLocator ( )
static

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

HD_API HdBoolDataSourceHandle HdNurbsPatchSchema::GetDoubleSided ( ) const
static HD_API HdNurbsPatchSchema HdNurbsPatchSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "nurbsPatch" from the parent container and constructs a HdNurbsPatchSchema 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 HdTokenDataSourceHandle HdNurbsPatchSchema::GetOrientation ( ) const
static HD_API const TfToken& HdNurbsPatchSchema::GetSchemaToken ( )
static

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

HD_API HdNurbsPatchTrimCurveSchema HdNurbsPatchSchema::GetTrimCurve ( ) const
HD_API HdTokenDataSourceHandle HdNurbsPatchSchema::GetUForm ( ) const
HD_API HdDoubleArrayDataSourceHandle HdNurbsPatchSchema::GetUKnots ( ) const
HD_API HdIntDataSourceHandle HdNurbsPatchSchema::GetUOrder ( ) const
HD_API HdVec2dDataSourceHandle HdNurbsPatchSchema::GetURange ( ) const
HD_API HdIntDataSourceHandle HdNurbsPatchSchema::GetUVertexCount ( ) const
HD_API HdTokenDataSourceHandle HdNurbsPatchSchema::GetVForm ( ) const
HD_API HdDoubleArrayDataSourceHandle HdNurbsPatchSchema::GetVKnots ( ) const
HD_API HdIntDataSourceHandle HdNurbsPatchSchema::GetVOrder ( ) const
HD_API HdVec2dDataSourceHandle HdNurbsPatchSchema::GetVRange ( ) const
HD_API HdIntDataSourceHandle HdNurbsPatchSchema::GetVVertexCount ( ) const
The documentation for this class was generated from the following file: