HDK
 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)
 
 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
 

Detailed Description

Describes how the geometry of a prim should be displayed.

Definition at line 80 of file sceneDelegate.h.

Constructor & Destructor Documentation

HdDisplayStyle::HdDisplayStyle ( )
inline

Creates a default DisplayStyle.

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

Definition at line 98 of file sceneDelegate.h.

HdDisplayStyle::HdDisplayStyle ( int  refineLevel_,
bool  flatShading = false,
bool  displacement = true,
bool  occludedSelectionShowsThrough_ = false 
)
inline

Creates a DisplayStyle.

Parameters
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.

Definition at line 112 of file sceneDelegate.h.

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

Member Function Documentation

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

Definition at line 138 of file sceneDelegate.h.

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

Definition at line 131 of file sceneDelegate.h.

Member Data Documentation

bool HdDisplayStyle::displacementEnabled

Is the prim displacement shaded.

Definition at line 88 of file sceneDelegate.h.

bool HdDisplayStyle::flatShadingEnabled

Is the prim flat shaded.

Definition at line 85 of file sceneDelegate.h.

bool HdDisplayStyle::occludedSelectionShowsThrough

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

Definition at line 92 of file sceneDelegate.h.

int HdDisplayStyle::refineLevel

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

Definition at line 82 of file sceneDelegate.h.


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