HdTetMeshTopologySchema Class Reference

#include <tetMeshTopologySchema.h>

Inheritance diagram for HdTetMeshTopologySchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdVec4iArrayDataSourceHandle	GetTetVertexIndices () const
HD_API HdVec3iArrayDataSourceHandle	GetSurfaceFaceVertexIndices () 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 ()
Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static HD_API const HdDataSourceLocator &	GetTetVertexIndicesLocator ()
	Prim-level relative data source locator to locate tetVertexIndices. More...
static HD_API const HdDataSourceLocator &	GetSurfaceFaceVertexIndicesLocator ()
	Prim-level relative data source locator to locate surfaceFaceVertexIndices. More...
Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdVec4iArrayDataSourceHandle &tetVertexIndices, const HdVec3iArrayDataSourceHandle &surfaceFaceVertexIndices, const HdTokenDataSourceHandle &orientation)
static HD_API HdTokenDataSourceHandle	BuildOrientationDataSource (const TfToken &orientation)

Schema retrieval
	HdTetMeshTopologySchema (HdContainerDataSourceHandle container)
static HD_API HdTetMeshTopologySchema	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 49 of file tetMeshTopologySchema.h.

Constructor & Destructor Documentation

HdTetMeshTopologySchema::HdTetMeshTopologySchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "topology" from the parent container and constructs a HdTetMeshTopologySchema 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 55 of file tetMeshTopologySchema.h.

Member Function Documentation

static HD_API HdTokenDataSourceHandle HdTetMeshTopologySchema::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:

• HdTetMeshTopologySchemaTokens->leftHanded
• HdTetMeshTopologySchemaTokens->rightHanded

static HD_API HdContainerDataSourceHandle HdTetMeshTopologySchema::BuildRetained ( const HdVec4iArrayDataSourceHandle &  tetVertexIndices, const HdVec3iArrayDataSourceHandle &  surfaceFaceVertexIndices, 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& HdTetMeshTopologySchema::GetDefaultLocator ( )

static

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

static HD_API HdTetMeshTopologySchema HdTetMeshTopologySchema::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 HdTetMeshTopologySchema 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 HdTetMeshTopologySchema::GetOrientation

(

)

const

static HD_API const TfToken& HdTetMeshTopologySchema::GetSchemaToken ( )

static

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

HD_API HdVec3iArrayDataSourceHandle HdTetMeshTopologySchema::GetSurfaceFaceVertexIndices

(

)

const

static HD_API const HdDataSourceLocator& HdTetMeshTopologySchema::GetSurfaceFaceVertexIndicesLocator ( )

static

Prim-level relative data source locator to locate surfaceFaceVertexIndices.

HD_API HdVec4iArrayDataSourceHandle HdTetMeshTopologySchema::GetTetVertexIndices

(

)

const

static HD_API const HdDataSourceLocator& HdTetMeshTopologySchema::GetTetVertexIndicesLocator ( )

static

Prim-level relative data source locator to locate tetVertexIndices.

---

The documentation for this class was generated from the following file:

• pxr/imaging/hd/tetMeshTopologySchema.h