Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
HdModelDrawMode Struct Reference

Describes optional alternative imaging behavior for prims. More...

#include <sceneDelegate.h>

Public Member Functions

 HdModelDrawMode (TfToken const &drawMode_, bool applyDrawMode_=false, GfVec3f drawModeColor_=GfVec3f(0.18), TfToken const &cardGeometry_=HdModelDrawModeTokens->cross, SdfAssetPath cardTextureXPos_=SdfAssetPath(), SdfAssetPath cardTextureYPos_=SdfAssetPath(), SdfAssetPath cardTextureZPos_=SdfAssetPath(), SdfAssetPath cardTextureXNeg_=SdfAssetPath(), SdfAssetPath cardTextureYNeg_=SdfAssetPath(), SdfAssetPath cardTextureZNeg_=SdfAssetPath())
 DrawModeColor is specified in the rendering color space.
 
bool operator== (HdModelDrawMode const &rhs) const
 
bool operator!= (HdModelDrawMode const &rhs) const
 

Public Attributes

TfToken drawMode
 
bool applyDrawMode
 
GfVec3f drawModeColor
 
TfToken cardGeometry
 
SdfAssetPath cardTextureXPos
 
SdfAssetPath cardTextureYPos
 
SdfAssetPath cardTextureZPos
 
SdfAssetPath cardTextureXNeg
 
SdfAssetPath cardTextureYNeg
 
SdfAssetPath cardTextureZNeg
 

Detailed Description

Describes optional alternative imaging behavior for prims.

Some scene delegates, like the UsdImagingDelegate, will pre-flatten this data, but other scene delegates may wish to use this to pipe the data through to a draw mode resolving scene index (see UsdImagingDrawModeSceneIndex as an example of such a scene index).

There is currently no plan to add emulation support for this information, such as via HdLegacyPrimSceneIndex or HdSceneIndexAdapterSceneDelegate.

Definition at line 218 of file sceneDelegate.h.

Constructor & Destructor Documentation

◆ HdModelDrawMode() [1/2]

HdModelDrawMode ( )
inline

Definition at line 237 of file sceneDelegate.h.

◆ HdModelDrawMode() [2/2]

HdModelDrawMode ( TfToken const & drawMode_,
bool applyDrawMode_ = false,
GfVec3f drawModeColor_ = GfVec3f(0.18),
TfToken const & cardGeometry_ = HdModelDrawModeTokens->cross,
SdfAssetPath cardTextureXPos_ = SdfAssetPath(),
SdfAssetPath cardTextureYPos_ = SdfAssetPath(),
SdfAssetPath cardTextureZPos_ = SdfAssetPath(),
SdfAssetPath cardTextureXNeg_ = SdfAssetPath(),
SdfAssetPath cardTextureYNeg_ = SdfAssetPath(),
SdfAssetPath cardTextureZNeg_ = SdfAssetPath() )
inline

DrawModeColor is specified in the rendering color space.

Definition at line 245 of file sceneDelegate.h.

Member Function Documentation

◆ operator!=()

bool operator!= ( HdModelDrawMode const & rhs) const
inline

Definition at line 275 of file sceneDelegate.h.

◆ operator==()

bool operator== ( HdModelDrawMode const & rhs) const
inline

Definition at line 263 of file sceneDelegate.h.

Member Data Documentation

◆ applyDrawMode

bool applyDrawMode

Definition at line 223 of file sceneDelegate.h.

◆ cardGeometry

TfToken cardGeometry

Definition at line 228 of file sceneDelegate.h.

◆ cardTextureXNeg

SdfAssetPath cardTextureXNeg

Definition at line 233 of file sceneDelegate.h.

◆ cardTextureXPos

SdfAssetPath cardTextureXPos

Definition at line 230 of file sceneDelegate.h.

◆ cardTextureYNeg

SdfAssetPath cardTextureYNeg

Definition at line 234 of file sceneDelegate.h.

◆ cardTextureYPos

SdfAssetPath cardTextureYPos

Definition at line 231 of file sceneDelegate.h.

◆ cardTextureZNeg

SdfAssetPath cardTextureZNeg

Definition at line 235 of file sceneDelegate.h.

◆ cardTextureZPos

SdfAssetPath cardTextureZPos

Definition at line 232 of file sceneDelegate.h.

◆ drawMode

TfToken drawMode

Definition at line 221 of file sceneDelegate.h.

◆ drawModeColor

GfVec3f drawModeColor

Definition at line 225 of file sceneDelegate.h.

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