#include <meshSchema.h>

Inheritance diagram for HdMeshSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdMeshTopologySchema	GetTopology () const

HD_API HdTokenDataSourceHandle	GetSubdivisionScheme () const

HD_API HdSubdivisionTagsSchema	GetSubdivisionTags () 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 ()

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 &	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 &	GetDoubleSidedLocator ()
	Prim-level relative data source locator to locate doubleSided. More...

Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdContainerDataSourceHandle &topology, const HdTokenDataSourceHandle &subdivisionScheme, const HdContainerDataSourceHandle &subdivisionTags, const HdBoolDataSourceHandle &doubleSided)

Schema retrieval
	HdMeshSchema (HdContainerDataSourceHandle container)

static HD_API HdMeshSchema	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 50 of file meshSchema.h.

Constructor & Destructor Documentation

HdMeshSchema::HdMeshSchema ( HdContainerDataSourceHandle container )

inline

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.

Definition at line 56 of file meshSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdMeshSchema::BuildRetained	(	const HdContainerDataSourceHandle &	topology,
		const HdTokenDataSourceHandle &	subdivisionScheme,
		const HdContainerDataSourceHandle &	subdivisionTags,
		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& 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 ( ) const

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.

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 ( ) const

static HD_API const HdDataSourceLocator& HdMeshSchema::GetSubdivisionSchemeLocator ( )

static

Prim-level relative data source locator to locate subdivisionScheme.

HD_API HdSubdivisionTagsSchema HdMeshSchema::GetSubdivisionTags ( ) const

static HD_API const HdDataSourceLocator& HdMeshSchema::GetSubdivisionTagsLocator ( )

static

Prim-level relative data source locator to locate subdivisionTags.

HD_API HdMeshTopologySchema HdMeshSchema::GetTopology ( ) const

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

Classes

Public Member Functions

Static Public Member Functions

Schema retrieval

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation