HdMeshTopologySchema Class Reference

#include <meshTopologySchema.h>

Inheritance diagram for HdMeshTopologySchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdIntArrayDataSourceHandle	GetFaceVertexCounts () const
HD_API HdIntArrayDataSourceHandle	GetFaceVertexIndices () const
HD_API HdIntArrayDataSourceHandle	GetHoleIndices () const
HD_API HdTokenDataSourceHandle	GetOrientation () 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 HdIntArrayDataSourceHandle &faceVertexCounts, const HdIntArrayDataSourceHandle &faceVertexIndices, const HdIntArrayDataSourceHandle &holeIndices, const HdTokenDataSourceHandle &orientation)
static HD_API HdTokenDataSourceHandle	BuildOrientationDataSource (const TfToken &orientation)

Schema retrieval
	HdMeshTopologySchema (HdContainerDataSourceHandle container)
static HD_API HdMeshTopologySchema	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 51 of file meshTopologySchema.h.

Constructor & Destructor Documentation

HdMeshTopologySchema::HdMeshTopologySchema ( HdContainerDataSourceHandle  container )

inline

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.

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

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

• HdMeshTopologySchemaTokens->leftHanded
• HdMeshTopologySchemaTokens->rightHanded

static HD_API HdContainerDataSourceHandle HdMeshTopologySchema::BuildRetained ( const HdIntArrayDataSourceHandle &  faceVertexCounts, const HdIntArrayDataSourceHandle &  faceVertexIndices, const HdIntArrayDataSourceHandle &  holeIndices, const HdTokenDataSourceHandle &  orientation  )

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& 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

(

)

const

HD_API HdIntArrayDataSourceHandle HdMeshTopologySchema::GetFaceVertexIndices

(

)

const

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

(

)

const

HD_API HdTokenDataSourceHandle HdMeshTopologySchema::GetOrientation

(

)

const

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:

• pxr/imaging/hd/meshTopologySchema.h