#include <legacyDisplayStyleSchema.h>

Inheritance diagram for HdLegacyDisplayStyleSchema:

Classes
class	Builder

Public Member Functions
Member accessor
HD_API HdIntDataSourceHandle	GetRefineLevel () const

HD_API HdBoolDataSourceHandle	GetFlatShadingEnabled () const

HD_API HdBoolDataSourceHandle	GetDisplacementEnabled () const

HD_API HdBoolDataSourceHandle	GetDisplayInOverlay () const

HD_API HdBoolDataSourceHandle	GetOccludedSelectionShowsThrough () const

HD_API HdBoolDataSourceHandle	GetPointsShadingEnabled () const

HD_API HdBoolDataSourceHandle	GetMaterialIsFinal () const

HD_API HdTokenDataSourceHandle	GetShadingStyle () const

HD_API HdTokenArrayDataSourceHandle	GetReprSelector () const

HD_API HdTokenDataSourceHandle	GetCullStyle () 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 &	GetRefineLevelLocator ()
	Prim-level relative data source locator to locate refineLevel. More...

static HD_API const HdDataSourceLocator &	GetFlatShadingEnabledLocator ()
	Prim-level relative data source locator to locate flatShadingEnabled. More...

static HD_API const HdDataSourceLocator &	GetDisplacementEnabledLocator ()
	Prim-level relative data source locator to locate displacementEnabled. More...

static HD_API const HdDataSourceLocator &	GetDisplayInOverlayLocator ()
	Prim-level relative data source locator to locate displayInOverlay. More...

static HD_API const HdDataSourceLocator &	GetOccludedSelectionShowsThroughLocator ()
	Prim-level relative data source locator to locate occludedSelectionShowsThrough. More...

static HD_API const HdDataSourceLocator &	GetPointsShadingEnabledLocator ()
	Prim-level relative data source locator to locate pointsShadingEnabled. More...

static HD_API const HdDataSourceLocator &	GetMaterialIsFinalLocator ()
	Prim-level relative data source locator to locate materialIsFinal. More...

static HD_API const HdDataSourceLocator &	GetShadingStyleLocator ()
	Prim-level relative data source locator to locate shadingStyle. More...

static HD_API const HdDataSourceLocator &	GetReprSelectorLocator ()
	Prim-level relative data source locator to locate reprSelector. More...

static HD_API const HdDataSourceLocator &	GetCullStyleLocator ()
	Prim-level relative data source locator to locate cullStyle. More...

Schema construction
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdIntDataSourceHandle &refineLevel, const HdBoolDataSourceHandle &flatShadingEnabled, const HdBoolDataSourceHandle &displacementEnabled, const HdBoolDataSourceHandle &displayInOverlay, const HdBoolDataSourceHandle &occludedSelectionShowsThrough, const HdBoolDataSourceHandle &pointsShadingEnabled, const HdBoolDataSourceHandle &materialIsFinal, const HdTokenDataSourceHandle &shadingStyle, const HdTokenArrayDataSourceHandle &reprSelector, const HdTokenDataSourceHandle &cullStyle)

Schema retrieval
	HdLegacyDisplayStyleSchema (HdContainerDataSourceHandle container)

static HD_API HdLegacyDisplayStyleSchema	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 54 of file legacyDisplayStyleSchema.h.

Constructor & Destructor Documentation

HdLegacyDisplayStyleSchema::HdLegacyDisplayStyleSchema ( HdContainerDataSourceHandle container )

inline

Retrieves a container data source with the schema's default name token "displayStyle" from the parent container and constructs a HdLegacyDisplayStyleSchema 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 60 of file legacyDisplayStyleSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdLegacyDisplayStyleSchema::BuildRetained	(	const HdIntDataSourceHandle &	refineLevel,
		const HdBoolDataSourceHandle &	flatShadingEnabled,
		const HdBoolDataSourceHandle &	displacementEnabled,
		const HdBoolDataSourceHandle &	displayInOverlay,
		const HdBoolDataSourceHandle &	occludedSelectionShowsThrough,
		const HdBoolDataSourceHandle &	pointsShadingEnabled,
		const HdBoolDataSourceHandle &	materialIsFinal,
		const HdTokenDataSourceHandle &	shadingStyle,
		const HdTokenArrayDataSourceHandle &	reprSelector,
		const HdTokenDataSourceHandle &	cullStyle
	)

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.

HD_API HdTokenDataSourceHandle HdLegacyDisplayStyleSchema::GetCullStyle ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetCullStyleLocator ( )

static

Prim-level relative data source locator to locate cullStyle.

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::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 HdLegacyDisplayStyleSchema::GetDisplacementEnabled ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetDisplacementEnabledLocator ( )

static

Prim-level relative data source locator to locate displacementEnabled.

HD_API HdBoolDataSourceHandle HdLegacyDisplayStyleSchema::GetDisplayInOverlay ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetDisplayInOverlayLocator ( )

static

Prim-level relative data source locator to locate displayInOverlay.

HD_API HdBoolDataSourceHandle HdLegacyDisplayStyleSchema::GetFlatShadingEnabled ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetFlatShadingEnabledLocator ( )

static

Prim-level relative data source locator to locate flatShadingEnabled.

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

static

Retrieves a container data source with the schema's default name token "displayStyle" from the parent container and constructs a HdLegacyDisplayStyleSchema 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 HdBoolDataSourceHandle HdLegacyDisplayStyleSchema::GetMaterialIsFinal ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetMaterialIsFinalLocator ( )

static

Prim-level relative data source locator to locate materialIsFinal.

HD_API HdBoolDataSourceHandle HdLegacyDisplayStyleSchema::GetOccludedSelectionShowsThrough ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetOccludedSelectionShowsThroughLocator ( )

static

Prim-level relative data source locator to locate occludedSelectionShowsThrough.

HD_API HdBoolDataSourceHandle HdLegacyDisplayStyleSchema::GetPointsShadingEnabled ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetPointsShadingEnabledLocator ( )

static

Prim-level relative data source locator to locate pointsShadingEnabled.

HD_API HdIntDataSourceHandle HdLegacyDisplayStyleSchema::GetRefineLevel ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetRefineLevelLocator ( )

static

Prim-level relative data source locator to locate refineLevel.

HD_API HdTokenArrayDataSourceHandle HdLegacyDisplayStyleSchema::GetReprSelector ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetReprSelectorLocator ( )

static

Prim-level relative data source locator to locate reprSelector.

static HD_API const TfToken& HdLegacyDisplayStyleSchema::GetSchemaToken ( )

static

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

HD_API HdTokenDataSourceHandle HdLegacyDisplayStyleSchema::GetShadingStyle ( ) const

static HD_API const HdDataSourceLocator& HdLegacyDisplayStyleSchema::GetShadingStyleLocator ( )

static

Prim-level relative data source locator to locate shadingStyle.

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

pxr/imaging/hd/legacyDisplayStyleSchema.h

Classes

Public Member Functions

Static Public Member Functions

Schema retrieval

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation