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

#include <meshTopologySchema.h>

+ Inheritance diagram for HdMeshTopologySchema:

Classes

class  Builder
 

Public Member Functions

 HdMeshTopologySchema (HdContainerDataSourceHandle container)
 
HD_API HdIntArrayDataSourceHandle GetFaceVertexCounts ()
 
HD_API HdIntArrayDataSourceHandle GetFaceVertexIndices ()
 
HD_API HdIntArrayDataSourceHandle GetHoleIndices ()
 
HD_API HdTokenDataSourceHandle GetOrientation ()
 
- 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 HdIntArrayDataSourceHandle &faceVertexCounts, const HdIntArrayDataSourceHandle &faceVertexIndices, const HdIntArrayDataSourceHandle &holeIndices, const HdTokenDataSourceHandle &orientation)
 
static HD_API HdMeshTopologySchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static HD_API const TfTokenGetSchemaToken ()
 
static HD_API const
HdDataSourceLocator
GetDefaultLocator ()
 
static HD_API
HdTokenDataSourceHandle 
BuildOrientationDataSource (const TfToken &orientation)
 

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 57 of file meshTopologySchema.h.

Constructor & Destructor Documentation

HdMeshTopologySchema::HdMeshTopologySchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 60 of file meshTopologySchema.h.

Member Function Documentation

static HD_API HdTokenDataSourceHandle HdMeshTopologySchema::BuildOrientationDataSource ( const TfToken orientation)
static

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

  • HdMeshTopologySchemaTokens->leftHanded
  • HdMeshTopologySchemaTokens->rightHanded ...will be stored statically and reused for future calls.
static HD_API HdContainerDataSourceHandle HdMeshTopologySchema::BuildRetained ( const HdIntArrayDataSourceHandle faceVertexCounts,
const HdIntArrayDataSourceHandle faceVertexIndices,
const HdIntArrayDataSourceHandle holeIndices,
const HdTokenDataSourceHandle orientation 
)
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 const HdDataSourceLocator& HdMeshTopologySchema::GetDefaultLocator ( )
static

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

HD_API HdIntArrayDataSourceHandle HdMeshTopologySchema::GetFaceVertexCounts ( )
HD_API HdIntArrayDataSourceHandle HdMeshTopologySchema::GetFaceVertexIndices ( )
static HD_API HdMeshTopologySchema HdMeshTopologySchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

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

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: