HdMeshSchema Class Reference

#include <meshSchema.h>

Inheritance diagram for HdMeshSchema:

Classes
class	Builder

Public Member Functions
	HdMeshSchema (HdContainerDataSourceHandle container)
HD_API HdMeshTopologySchema	GetTopology ()
HD_API HdTokenDataSourceHandle	GetSubdivisionScheme ()
HD_API HdSubdivisionTagsSchema	GetSubdivisionTags ()
HD_API HdGeomSubsetsSchema	GetGeomSubsets ()
HD_API HdBoolDataSourceHandle	GetDoubleSided ()
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 HdContainerDataSourceHandle &topology, const HdTokenDataSourceHandle &subdivisionScheme, const HdContainerDataSourceHandle &subdivisionTags, const HdContainerDataSourceHandle &geomSubsets, const HdBoolDataSourceHandle &doubleSided)
static HD_API HdMeshSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
static HD_API const HdDataSourceLocator &	GetTopologyLocator ()
	Prim-level relative data source locator to locate topology. More...
static HD_API const HdDataSourceLocator &	GetSubdivisionSchemeLocator ()
	Prim-level relative data source locator to locate subdivisionScheme. More...
static HD_API const HdDataSourceLocator &	GetSubdivisionTagsLocator ()
	Prim-level relative data source locator to locate subdivisionTags. More...
static HD_API const HdDataSourceLocator &	GetGeomSubsetsLocator ()
	Prim-level relative data source locator to locate geomSubsets. More...
static HD_API const HdDataSourceLocator &	GetDoubleSidedLocator ()
	Prim-level relative data source locator to locate doubleSided. More...

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)
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 65 of file meshSchema.h.

Constructor & Destructor Documentation

HdMeshSchema::HdMeshSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 68 of file meshSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdMeshSchema::BuildRetained ( const HdContainerDataSourceHandle &  topology, const HdTokenDataSourceHandle &  subdivisionScheme, const HdContainerDataSourceHandle &  subdivisionTags, const HdContainerDataSourceHandle &  geomSubsets, const HdBoolDataSourceHandle &  doubleSided  )

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& HdMeshSchema::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 HdMeshSchema::GetDoubleSided

(

)

static HD_API const HdDataSourceLocator& HdMeshSchema::GetDoubleSidedLocator ( )

static

Prim-level relative data source locator to locate doubleSided.

static HD_API HdMeshSchema HdMeshSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "mesh" from the parent container and constructs a HdMeshSchema 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 HdGeomSubsetsSchema HdMeshSchema::GetGeomSubsets

(

)

static HD_API const HdDataSourceLocator& HdMeshSchema::GetGeomSubsetsLocator ( )

static

Prim-level relative data source locator to locate geomSubsets.

static HD_API const TfToken& HdMeshSchema::GetSchemaToken ( )

static

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

HD_API HdTokenDataSourceHandle HdMeshSchema::GetSubdivisionScheme

(

)

static HD_API const HdDataSourceLocator& HdMeshSchema::GetSubdivisionSchemeLocator ( )

static

Prim-level relative data source locator to locate subdivisionScheme.

HD_API HdSubdivisionTagsSchema HdMeshSchema::GetSubdivisionTags

(

)

static HD_API const HdDataSourceLocator& HdMeshSchema::GetSubdivisionTagsLocator ( )

static

Prim-level relative data source locator to locate subdivisionTags.

HD_API HdMeshTopologySchema HdMeshSchema::GetTopology

(

)

static HD_API const HdDataSourceLocator& HdMeshSchema::GetTopologyLocator ( )

static

Prim-level relative data source locator to locate topology.

---

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

• pxr/imaging/hd/meshSchema.h