All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdDisplayStyle Struct Reference

#include <sceneDelegate.h>

Public Member Functions

 HdDisplayStyle ()
 HdDisplayStyle (int refineLevel_, bool flatShading=false, bool displacement=true, bool occludedSelectionShowsThrough_=false, bool pointsShadingEnabled_=false, bool materialIsFinal_=false)
 HdDisplayStyle (HdDisplayStyle const &rhs)=default
 ~HdDisplayStyle ()=default
bool operator== (HdDisplayStyle const &rhs) const
bool operator!= (HdDisplayStyle const &rhs) const

Public Attributes

int refineLevel
 The prim refine level, in the range [0, 8]. More...
bool flatShadingEnabled
 Is the prim flat shaded. More...
bool displacementEnabled
 Is the prim displacement shaded. More...
bool occludedSelectionShowsThrough
bool pointsShadingEnabled
bool materialIsFinal

Detailed Description

Describes how the geometry of a prim should be displayed.

Definition at line 81 of file sceneDelegate.h.

Constructor & Destructor Documentation

HdDisplayStyle::HdDisplayStyle ( )

Creates a default DisplayStyle.

  • refineLevel is 0.
  • flatShading is disabled.
  • displacement is enabled.
  • occludedSelectionShowsThrough is disabled.
  • pointsShading is disabled.

Definition at line 109 of file sceneDelegate.h.

HdDisplayStyle::HdDisplayStyle ( int  refineLevel_,
bool  flatShading = false,
bool  displacement = true,
bool  occludedSelectionShowsThrough_ = false,
bool  pointsShadingEnabled_ = false,
bool  materialIsFinal_ = false 

Creates a DisplayStyle.

refineLevel_the refine level to display. Valid range is [0, 8].
flatShadingenables flat shading, defaults to false.
displacementenables displacement shading, defaults to false.
occludedSelectionShowsThroughcontrols whether the prim lets occluded selection show through it, defaults to false.
pointsShadingEnabledcontrols whether the prim's points are shaded as surfaces or constant-shaded, defaults to false.
materialisFinalcontrols whether the prim's material should be exempt from override or disabling, such as when a renderer wants to ignore all scene materials.

Definition at line 130 of file sceneDelegate.h.

HdDisplayStyle::HdDisplayStyle ( HdDisplayStyle const rhs)
HdDisplayStyle::~HdDisplayStyle ( )

Member Function Documentation

bool HdDisplayStyle::operator!= ( HdDisplayStyle const rhs) const

Definition at line 162 of file sceneDelegate.h.

bool HdDisplayStyle::operator== ( HdDisplayStyle const rhs) const

Definition at line 153 of file sceneDelegate.h.

Member Data Documentation

bool HdDisplayStyle::displacementEnabled

Is the prim displacement shaded.

Definition at line 89 of file sceneDelegate.h.

bool HdDisplayStyle::flatShadingEnabled

Is the prim flat shaded.

Definition at line 86 of file sceneDelegate.h.

bool HdDisplayStyle::materialIsFinal

Is this prim exempt from having its material disabled or overridden, for example, when a renderer chooses to ignore all scene materials?

Definition at line 101 of file sceneDelegate.h.

bool HdDisplayStyle::occludedSelectionShowsThrough

Does the prim act "transparent" to allow occluded selection to show through?

Definition at line 93 of file sceneDelegate.h.

bool HdDisplayStyle::pointsShadingEnabled

Should the prim's points get shaded like surfaces, as opposed to constant shaded?

Definition at line 97 of file sceneDelegate.h.

int HdDisplayStyle::refineLevel

The prim refine level, in the range [0, 8].

Definition at line 83 of file sceneDelegate.h.

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