HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdLegacyDisplayStyleSchema Class Reference

#include <legacyDisplayStyleSchema.h>

+ Inheritance diagram for HdLegacyDisplayStyleSchema:

Classes

class  Builder
 

Public Member Functions

 HdLegacyDisplayStyleSchema (HdContainerDataSourceHandle container)
 
HD_API HdIntDataSourceHandle GetRefineLevel ()
 
HD_API HdBoolDataSourceHandle GetFlatShadingEnabled ()
 
HD_API HdBoolDataSourceHandle GetDisplacementEnabled ()
 
HD_API HdBoolDataSourceHandle GetOccludedSelectionShowsThrough ()
 
HD_API HdBoolDataSourceHandle GetPointsShadingEnabled ()
 
HD_API HdBoolDataSourceHandle GetMaterialIsFinal ()
 
HD_API HdTokenDataSourceHandle GetShadingStyle ()
 
HD_API HdTokenArrayDataSourceHandle GetReprSelector ()
 
HD_API HdTokenDataSourceHandle GetCullStyle ()
 
- 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 HdIntDataSourceHandle &refineLevel, const HdBoolDataSourceHandle &flatShadingEnabled, const HdBoolDataSourceHandle &displacementEnabled, const HdBoolDataSourceHandle &occludedSelectionShowsThrough, const HdBoolDataSourceHandle &pointsShadingEnabled, const HdBoolDataSourceHandle &materialIsFinal, const HdTokenDataSourceHandle &shadingStyle, const HdTokenArrayDataSourceHandle &reprSelector, const HdTokenDataSourceHandle &cullStyle)
 
static HD_API
HdLegacyDisplayStyleSchema 
GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static HD_API const TfTokenGetSchemaToken ()
 
static HD_API const
HdDataSourceLocator
GetDefaultLocator ()
 
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...
 

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 66 of file legacyDisplayStyleSchema.h.

Constructor & Destructor Documentation

HdLegacyDisplayStyleSchema::HdLegacyDisplayStyleSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 69 of file legacyDisplayStyleSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdLegacyDisplayStyleSchema::BuildRetained ( const HdIntDataSourceHandle refineLevel,
const HdBoolDataSourceHandle flatShadingEnabled,
const HdBoolDataSourceHandle displacementEnabled,
const HdBoolDataSourceHandle occludedSelectionShowsThrough,
const HdBoolDataSourceHandle pointsShadingEnabled,
const HdBoolDataSourceHandle materialIsFinal,
const HdTokenDataSourceHandle shadingStyle,
const HdTokenArrayDataSourceHandle reprSelector,
const HdTokenDataSourceHandle cullStyle 
)
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.

HD_API HdTokenDataSourceHandle HdLegacyDisplayStyleSchema::GetCullStyle ( )
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 ( )
HD_API HdBoolDataSourceHandle HdLegacyDisplayStyleSchema::GetFlatShadingEnabled ( )
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 ( )
HD_API HdBoolDataSourceHandle HdLegacyDisplayStyleSchema::GetOccludedSelectionShowsThrough ( )
HD_API HdBoolDataSourceHandle HdLegacyDisplayStyleSchema::GetPointsShadingEnabled ( )
HD_API HdIntDataSourceHandle HdLegacyDisplayStyleSchema::GetRefineLevel ( )
HD_API HdTokenArrayDataSourceHandle HdLegacyDisplayStyleSchema::GetReprSelector ( )
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 ( )

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