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

#include <GUI_DisplayOption.h>

Public Types

enum  gui_MatAssignMode { MAT_ALWAYS = 0, MAT_NO_PLAYBACK = 1, MAT_MANUAL = 2 }
 
enum  gui_StereoPass { GUI_DISP_STEREO_BOTH, GUI_DISP_STEREO_LEFT, GUI_DISP_STEREO_RIGHT }
 For the OpenGL ROP only: Allows a single stereo camera to be rendered. More...
 

Public Member Functions

 GUI_DisplayOption ()
 
 ~GUI_DisplayOption ()
 
GUI_DisplayOptionoperator= (const GUI_DisplayOption &opt)
 
GR_DisplayOptiongetDisplaySet (GUI_DisplaySetType type)
 Direct cccess to the display set, without any mapping. More...
 
void setDisplaySetRemap (GUI_DisplaySetType slave, GUI_DisplaySetType master)
 Remap the display option set to another set. More...
 
GUI_DisplaySetType getDisplaySetRemap (GUI_DisplaySetType t) const
 
bool showSelected () const
 
bool showNonSelected () const
 
bool showTemplates () const
 
bool showFootprints () const
 
bool showCurrentOutput () const
 
bool showDisplay () const
 
bool showGuides () const
 
bool showObjectNames () const
 
bool showFullNames () const
 
bool drawOrigin () const
 
bool drawStickyOrigin () const
 
bool drawViewPivot () const
 
bool drawWalls () const
 
bool drawXYPlane () const
 
bool drawXZPlane () const
 
bool drawYZPlane () const
 
bool drawFieldGuide () const
 
bool drawSafeArea () const
 
bool drawBackgrounds () const
 
bool drawEnvironmentMaps () const
 
bool drawFilteredBackgrounds () const
 
bool showIKCriticalZones () const
 
bool getDrawCameraMask () const
 
bool drawVertexAttrib2D () const
 
bool autoDetectAttribType2D () const
 
bool drawSpecular () const
 
bool drawMultiTexture () const
 
bool applySelectMask () const
 
bool drawXRay () const
 
bool xrayQuality () const
 
bool drawObjectOrigins () const
 
bool showMaterials () const
 
bool useMaterialOverrides () const
 
bool mssEnable () const
 
bool mssPerPrim () const
 
bool mssPacked () const
 
int objectMaterialLimit () const
 
fpreal xrayWireStrength () const
 
gui_MatAssignMode materialAssignMode () const
 
void materialAssignMode (gui_MatAssignMode mode)
 
bool materialUpdate () const
 
void materialUpdate (bool update)
 
void showSelected (bool onoff)
 
void showNonSelected (bool onoff)
 
void showTemplates (bool onoff)
 
void showFootprints (bool onoff)
 
void showCurrentOutput (bool onoff)
 
void showDisplay (bool onoff)
 
void showGuides (bool onoff)
 
void showObjectNames (bool onoff)
 
void showFullNames (bool onoff)
 
void drawOrigin (bool onoff)
 
void drawStickyOrigin (bool onoff)
 
void drawViewPivot (bool onoff)
 
void drawWalls (bool onoff)
 
void drawXYPlane (bool onoff)
 
void drawXZPlane (bool onoff)
 
void drawYZPlane (bool onoff)
 
void drawFieldGuide (bool onoff)
 
void drawSafeArea (bool onoff)
 
void drawBackgrounds (bool onoff)
 
void drawEnvironmentMaps (bool onoff)
 
void drawFilteredBackgrounds (bool onoff)
 
void showIKCriticalZones (bool onoff)
 
void setDrawCameraMask (bool onoff)
 
void drawVertexAttrib2D (bool onoff)
 
void autoDetectAttribType2D (bool onoff)
 
void drawSpecular (bool onoff)
 
void drawMultiTexture (bool onoff)
 
void applySelectMask (bool onoff)
 
void drawXRay (bool xray)
 
void xrayQuality (bool q)
 
void xrayWireStrength (fpreal w)
 
void drawObjectOrigins (bool org)
 
void showMaterials (bool show)
 
void useMaterialOverrides (bool ovr)
 
void mssEnable (bool mss)
 
void mssPerPrim (bool mpp)
 
void mssPacked (bool mp)
 
void objectMaterialLimit (int m)
 
void handleHighlightSize (int hl)
 
int handleHighlightSize () const
 
void originGnomonSize (fpreal size)
 
fpreal originGnomonSize () const
 
void removeUserOption (int option_id)
 
void refreshUserOptionVersions ()
 
UI_ValuegetObjectLevelNotify ()
 
void updateOptionsForHardware (RE_Render *r)
 
bool compatibleWith (const GUI_DisplayOption &opt) const
 
void setHeadlightIntensity (fpreal i)
 
fpreal getHeadlightIntensity () const
 
void setHeadlightDirection (UT_Vector3D dir)
 
UT_Vector3D getHeadlightDirection () const
 
void setHeadlightSpecular (bool use_spec)
 
bool getHeadlightSpecular () const
 
void setDefaultMaterialDiffuse (UT_Color col)
 
void setDefaultMaterialSpecular (UT_Color col)
 
void setDefaultMaterialAmbient (UT_Color col)
 
void setDefaultMaterialEmission (UT_Color col)
 
UT_Color getDefaultMaterialDiffuse () const
 
UT_Color getDefaultMaterialSpecular () const
 
UT_Color getDefaultMaterialAmbient () const
 
UT_Color getDefaultMaterialEmission () const
 
bool isDefaultMaterialDirty () const
 
void clearDefaultMaterialDirty ()
 
void forceMSSUpdate (bool)
 
exint getMSSUpdateSerial () const
 
bool isClipOutPass () const
 
void setClipOutPass (bool out_pass)
 
void getRecommendedTextureLimit (RE_Render *r, int &max2d, int &max3d) const
 
GR_DisplayOptionoperator[] (GUI_DisplaySetType type)
 
const GR_DisplayOptionoperator[] (GUI_DisplaySetType type) const
 
const GR_CommonDispOptioncommon () const
 
GR_CommonDispOptioncommon ()
 
bool save (std::ostream &) const
 
bool load (UT_IStream &)
 
void enableSceneOption (const char *name, bool enable)
 
bool isSceneOptionEnabled (const char *name) const
 
void moveModeOn (bool onoff)
 
bool moveModeOn () const
 
bool isObjectLevel () const
 
void setObjectLevel (bool onoff)
 
unsigned getSelectMask () const
 
void setSelectMask (unsigned mask)
 
void setSeparateStereoRender (gui_StereoPass pass)
 
bool isStereoLeftRender () const
 
bool isStereoRightRender () const
 
 ANY_FLAG_ACTIVE_IN_SETS (drawPointCoincident)
 
 ANY_FLAG_ACTIVE_IN_SETS (drawPointMarkers)
 
 ANY_FLAG_ACTIVE_IN_SETS (uvFillOverlap)
 

Static Public Member Functions

static float getHandleScale ()
 
static void setHandleScale (float v)
 
RE_TextureHolder getRotoTexture (RE_Render *r, GUI_RotoView type, float &quality, float &aspect_ratio, UT_DimRect *udim_area=nullptr) const
 
void getRotoResolution (GUI_RotoView type, UT_Vector2i &res)
 
bool setRotoFileParms (GUI_RotoView type, const char *file, float quality)
 
bool setRotoCopParms (GUI_RotoView type, const char *path, float quality)
 
void setRotoSource (GUI_RotoView type, bool file)
 
void setRotoTime (fpreal t)
 
bool isRotoTimeDependent (GUI_RotoView type) const
 
fpreal getRotoQuality () const
 
void setRotoQuality (fpreal q)
 
void setRotoPath (GUI_RotoView type, bool file_path, const char *path)
 
bool isRotoFile (GUI_RotoView type) const
 
const char * getRotoCopPath (GUI_RotoView type) const
 
const char * getRotoFilePath (GUI_RotoView type) const
 
UI_ValuegetRotoCopCookNotify (GUI_RotoView type)
 
UI_ValuegetRotoCopNameChangeNotify (GUI_RotoView type)
 
void getImageMinUV (float arr[2]) const
 
void setImageMinUV (float arr[2])
 
void getImageMaxUV (float arr[2]) const
 
void setImageMaxUV (float arr[2])
 
void getImageOffset (GUI_RotoView view, float arr[2]) const
 
void setImageOffset (GUI_RotoView view, float arr[2])
 
void getImageScale (GUI_RotoView view, float arr[2]) const
 
void setImageScale (GUI_RotoView view, float arr[2])
 
float getBrightness (GUI_RotoView view) const
 
void setBrightness (GUI_RotoView view, float brightness)
 
void autoPlaceImage (GUI_RotoView view, bool onoff)
 
bool autoPlaceImage (GUI_RotoView view) const
 
static const char * getRotoViewName (GUI_RotoView view)
 

Detailed Description

Display options object that contains all high-level viewport display settings, and contains the objects with context-specific display options and common drawing options.

Examples:
DM/DM_SceneBoundsHook.C.

Definition at line 58 of file GUI_DisplayOption.h.

Member Enumeration Documentation

Enumerator
MAT_ALWAYS 
MAT_NO_PLAYBACK 
MAT_MANUAL 

Definition at line 159 of file GUI_DisplayOption.h.

For the OpenGL ROP only: Allows a single stereo camera to be rendered.

Enumerator
GUI_DISP_STEREO_BOTH 
GUI_DISP_STEREO_LEFT 
GUI_DISP_STEREO_RIGHT 

Definition at line 358 of file GUI_DisplayOption.h.

Constructor & Destructor Documentation

GUI_DisplayOption::GUI_DisplayOption ( )
GUI_DisplayOption::~GUI_DisplayOption ( )

Member Function Documentation

GUI_DisplayOption::ANY_FLAG_ACTIVE_IN_SETS ( drawPointCoincident  )

Returns true if any of the geometry contexts have this option set.

GUI_DisplayOption::ANY_FLAG_ACTIVE_IN_SETS ( drawPointMarkers  )

Returns true if any of the geometry contexts have this option set.

GUI_DisplayOption::ANY_FLAG_ACTIVE_IN_SETS ( uvFillOverlap  )

Returns true if any of the geometry contexts have this option set.

bool GUI_DisplayOption::applySelectMask ( ) const
inline

Definition at line 146 of file GUI_DisplayOption.h.

void GUI_DisplayOption::applySelectMask ( bool  onoff)
inline

Definition at line 210 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::autoDetectAttribType2D ( ) const
inline

Definition at line 140 of file GUI_DisplayOption.h.

void GUI_DisplayOption::autoDetectAttribType2D ( bool  onoff)
inline

Definition at line 204 of file GUI_DisplayOption.h.

void GUI_DisplayOption::autoPlaceImage ( GUI_RotoView  view,
bool  onoff 
)
inline

Rotoscoping background image set/query methods

Definition at line 314 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::autoPlaceImage ( GUI_RotoView  view) const
inline

Rotoscoping background image set/query methods

Definition at line 316 of file GUI_DisplayOption.h.

void GUI_DisplayOption::clearDefaultMaterialDirty ( )
inline

Definition at line 416 of file GUI_DisplayOption.h.

const GR_CommonDispOption& GUI_DisplayOption::common ( ) const
inline

Low-level drawing display options common to all geometry contexts

Examples:
DM/DM_InfoHook.C, DM/DM_ObjectPathHook.C, DM/DM_OverdrawHook.C, and DM/DM_SceneBoundsHook.C.

Definition at line 81 of file GUI_DisplayOption.h.

GR_CommonDispOption& GUI_DisplayOption::common ( )
inline

Low-level drawing display options common to all geometry contexts

Definition at line 82 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::compatibleWith ( const GUI_DisplayOption opt) const

Returns true if the passed options are compatible with these options, meaning that update() does not need to be called on GR_Primitives if 'opt' is used after this option. This could happen if 'opt' had a marker on that required an attribute that this options set does not.

bool GUI_DisplayOption::drawBackgrounds ( ) const
inline

Definition at line 128 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawBackgrounds ( bool  onoff)
inline

Definition at line 193 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawEnvironmentMaps ( ) const
inline

Definition at line 129 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawEnvironmentMaps ( bool  onoff)
inline

Definition at line 194 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawFieldGuide ( ) const
inline

Definition at line 126 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawFieldGuide ( bool  onoff)
inline

Definition at line 191 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawFilteredBackgrounds ( ) const
inline

Definition at line 131 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawFilteredBackgrounds ( bool  onoff)
inline

Definition at line 196 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawMultiTexture ( ) const
inline

Definition at line 144 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawMultiTexture ( bool  onoff)
inline

Definition at line 208 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawObjectOrigins ( ) const
inline

Definition at line 150 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawObjectOrigins ( bool  org)
inline

Definition at line 215 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawOrigin ( ) const
inline

Definition at line 119 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawOrigin ( bool  onoff)
inline

Definition at line 184 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawSafeArea ( ) const
inline

Definition at line 127 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawSafeArea ( bool  onoff)
inline

Definition at line 192 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawSpecular ( ) const
inline

Definition at line 143 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawSpecular ( bool  onoff)
inline

Definition at line 206 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawStickyOrigin ( ) const
inline

Definition at line 120 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawStickyOrigin ( bool  onoff)
inline

Definition at line 185 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawVertexAttrib2D ( ) const
inline

Definition at line 138 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawVertexAttrib2D ( bool  onoff)
inline

Definition at line 202 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawViewPivot ( ) const
inline

Definition at line 121 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawViewPivot ( bool  onoff)
inline

Definition at line 186 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawWalls ( ) const
inline

Definition at line 122 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawWalls ( bool  onoff)
inline

Definition at line 187 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawXRay ( ) const
inline

Definition at line 148 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawXRay ( bool  xray)
inline

Definition at line 212 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawXYPlane ( ) const
inline

Definition at line 123 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawXYPlane ( bool  onoff)
inline

Definition at line 188 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawXZPlane ( ) const
inline

Definition at line 124 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawXZPlane ( bool  onoff)
inline

Definition at line 189 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawYZPlane ( ) const
inline

Definition at line 125 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawYZPlane ( bool  onoff)
inline

Definition at line 190 of file GUI_DisplayOption.h.

void GUI_DisplayOption::enableSceneOption ( const char *  name,
bool  enable 
)

Scene custom display option support - set and query scene options

void GUI_DisplayOption::forceMSSUpdate ( bool  )
inline

Definition at line 418 of file GUI_DisplayOption.h.

float GUI_DisplayOption::getBrightness ( GUI_RotoView  view) const
inline

Rotoscoping background image set/query methods

Definition at line 309 of file GUI_DisplayOption.h.

UT_Color GUI_DisplayOption::getDefaultMaterialAmbient ( ) const
inline

Definition at line 412 of file GUI_DisplayOption.h.

UT_Color GUI_DisplayOption::getDefaultMaterialDiffuse ( ) const
inline

Definition at line 410 of file GUI_DisplayOption.h.

UT_Color GUI_DisplayOption::getDefaultMaterialEmission ( ) const
inline

Definition at line 413 of file GUI_DisplayOption.h.

UT_Color GUI_DisplayOption::getDefaultMaterialSpecular ( ) const
inline

Definition at line 411 of file GUI_DisplayOption.h.

GR_DisplayOption& GUI_DisplayOption::getDisplaySet ( GUI_DisplaySetType  type)
inline

Direct cccess to the display set, without any mapping.

Definition at line 76 of file GUI_DisplayOption.h.

GUI_DisplaySetType GUI_DisplayOption::getDisplaySetRemap ( GUI_DisplaySetType  t) const
inline

Query which display set this set is following. If none, it will refer to itself.

Definition at line 98 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getDrawCameraMask ( ) const
inline

Definition at line 135 of file GUI_DisplayOption.h.

static float GUI_DisplayOption::getHandleScale ( )
inlinestatic

Methods to query/change the scale at which handles are drawn.

Definition at line 324 of file GUI_DisplayOption.h.

UT_Vector3D GUI_DisplayOption::getHeadlightDirection ( ) const
inline

Definition at line 400 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getHeadlightIntensity ( ) const
inline

Definition at line 397 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getHeadlightSpecular ( ) const
inline

Definition at line 403 of file GUI_DisplayOption.h.

void GUI_DisplayOption::getImageMaxUV ( float  arr[2]) const
inline

Rotoscoping background image set/query methods

Definition at line 277 of file GUI_DisplayOption.h.

void GUI_DisplayOption::getImageMinUV ( float  arr[2]) const
inline

Rotoscoping background image set/query methods

Definition at line 267 of file GUI_DisplayOption.h.

void GUI_DisplayOption::getImageOffset ( GUI_RotoView  view,
float  arr[2] 
) const
inline

Rotoscoping background image set/query methods

Definition at line 288 of file GUI_DisplayOption.h.

void GUI_DisplayOption::getImageScale ( GUI_RotoView  view,
float  arr[2] 
) const
inline

Rotoscoping background image set/query methods

Definition at line 298 of file GUI_DisplayOption.h.

exint GUI_DisplayOption::getMSSUpdateSerial ( ) const
inline

Definition at line 419 of file GUI_DisplayOption.h.

UI_Value& GUI_DisplayOption::getObjectLevelNotify ( )
inline

This value is changed when the scene is switched from obj to sop/dop level.

Definition at line 355 of file GUI_DisplayOption.h.

void GUI_DisplayOption::getRecommendedTextureLimit ( RE_Render r,
int max2d,
int max3d 
) const
UI_Value& GUI_DisplayOption::getRotoCopCookNotify ( GUI_RotoView  type)

Rotoscoping background image set/query methods

UI_Value& GUI_DisplayOption::getRotoCopNameChangeNotify ( GUI_RotoView  type)

Rotoscoping background image set/query methods

const char* GUI_DisplayOption::getRotoCopPath ( GUI_RotoView  type) const

Rotoscoping background image set/query methods

const char* GUI_DisplayOption::getRotoFilePath ( GUI_RotoView  type) const

Rotoscoping background image set/query methods

fpreal GUI_DisplayOption::getRotoQuality ( ) const

Rotoscoping background image set/query methods

void GUI_DisplayOption::getRotoResolution ( GUI_RotoView  type,
UT_Vector2i res 
)

Rotoscoping background image set/query methods

RE_TextureHolder GUI_DisplayOption::getRotoTexture ( RE_Render r,
GUI_RotoView  type,
float &  quality,
float &  aspect_ratio,
UT_DimRect udim_area = nullptr 
) const

Rotoscoping background image set/query methods

static const char* GUI_DisplayOption::getRotoViewName ( GUI_RotoView  view)
static

Rotoscoping background image set/query methods

unsigned GUI_DisplayOption::getSelectMask ( ) const
inline

The select mask is set when the user is in a "select" state to automatically turn on some decorations. The mask is used to temporarily tweak the appropriate display options, and does not, in and of itself, invalidate display lists.

Definition at line 349 of file GUI_DisplayOption.h.

void GUI_DisplayOption::handleHighlightSize ( int  hl)
inline

Definition at line 224 of file GUI_DisplayOption.h.

int GUI_DisplayOption::handleHighlightSize ( ) const
inline

Definition at line 226 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isClipOutPass ( ) const
inline

Definition at line 423 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isDefaultMaterialDirty ( ) const
inline

Definition at line 415 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isObjectLevel ( ) const
inline

State which switches the geometry context display options between the Scene and Model display sets. When at the object level, the scene is used.

Definition at line 340 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isRotoFile ( GUI_RotoView  type) const

Rotoscoping background image set/query methods

bool GUI_DisplayOption::isRotoTimeDependent ( GUI_RotoView  type) const

Rotoscoping background image set/query methods

bool GUI_DisplayOption::isSceneOptionEnabled ( const char *  name) const

Scene custom display option support - set and query scene options

Examples:
DM/DM_BackgroundHook.C, DM/DM_InfoHook.C, DM/DM_LightBloomHook.C, DM/DM_ObjectPathHook.C, DM/DM_OverdrawHook.C, and DM/DM_SceneBoundsHook.C.
bool GUI_DisplayOption::isStereoLeftRender ( ) const
inline

Allow rendering of a single stereo camera eye.

Definition at line 369 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isStereoRightRender ( ) const
inline

Allow rendering of a single stereo camera eye.

Definition at line 372 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::load ( UT_IStream )

Return true if the load/save was successful, and false otherwise.

gui_MatAssignMode GUI_DisplayOption::materialAssignMode ( ) const
inline

Definition at line 165 of file GUI_DisplayOption.h.

void GUI_DisplayOption::materialAssignMode ( gui_MatAssignMode  mode)
inline

Definition at line 166 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::materialUpdate ( ) const
inline

Definition at line 168 of file GUI_DisplayOption.h.

void GUI_DisplayOption::materialUpdate ( bool  update)
inline

Definition at line 169 of file GUI_DisplayOption.h.

void GUI_DisplayOption::moveModeOn ( bool  onoff)
inline

set/query enable/disable of shading mode change

Definition at line 233 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::moveModeOn ( ) const
inline

set/query enable/disable of shading mode change

Definition at line 234 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::mssEnable ( ) const
inline

Definition at line 153 of file GUI_DisplayOption.h.

void GUI_DisplayOption::mssEnable ( bool  mss)
inline

Definition at line 218 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::mssPacked ( ) const
inline

Definition at line 155 of file GUI_DisplayOption.h.

void GUI_DisplayOption::mssPacked ( bool  mp)
inline

Definition at line 220 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::mssPerPrim ( ) const
inline

Definition at line 154 of file GUI_DisplayOption.h.

void GUI_DisplayOption::mssPerPrim ( bool  mpp)
inline

Definition at line 219 of file GUI_DisplayOption.h.

int GUI_DisplayOption::objectMaterialLimit ( ) const
inline

Definition at line 156 of file GUI_DisplayOption.h.

void GUI_DisplayOption::objectMaterialLimit ( int  m)
inline

Definition at line 221 of file GUI_DisplayOption.h.

GUI_DisplayOption& GUI_DisplayOption::operator= ( const GUI_DisplayOption opt)
GR_DisplayOption& GUI_DisplayOption::operator[] ( GUI_DisplaySetType  type)
inline

Context-specific geometry-specific display options. If a display set follows another set, it will be remapped to return that set.

Definition at line 69 of file GUI_DisplayOption.h.

const GR_DisplayOption& GUI_DisplayOption::operator[] ( GUI_DisplaySetType  type) const
inline

Context-specific geometry-specific display options. If a display set follows another set, it will be remapped to return that set.

Definition at line 71 of file GUI_DisplayOption.h.

void GUI_DisplayOption::originGnomonSize ( fpreal  size)
inline

Definition at line 227 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::originGnomonSize ( ) const
inline

Definition at line 229 of file GUI_DisplayOption.h.

void GUI_DisplayOption::refreshUserOptionVersions ( )

Refresh the cached version keys for the enabled user options to reflect the most up-to-date version.

void GUI_DisplayOption::removeUserOption ( int  option_id)
bool GUI_DisplayOption::save ( std::ostream &  ) const

Return true if the load/save was successful, and false otherwise.

void GUI_DisplayOption::setBrightness ( GUI_RotoView  view,
float  brightness 
)
inline

Rotoscoping background image set/query methods

Definition at line 311 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setClipOutPass ( bool  out_pass)
inline

Definition at line 424 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDefaultMaterialAmbient ( UT_Color  col)
void GUI_DisplayOption::setDefaultMaterialDiffuse ( UT_Color  col)
void GUI_DisplayOption::setDefaultMaterialEmission ( UT_Color  col)
void GUI_DisplayOption::setDefaultMaterialSpecular ( UT_Color  col)
void GUI_DisplayOption::setDisplaySetRemap ( GUI_DisplaySetType  slave,
GUI_DisplaySetType  master 
)
inline

Remap the display option set to another set.

Definition at line 92 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDrawCameraMask ( bool  onoff)
inline

Definition at line 200 of file GUI_DisplayOption.h.

static void GUI_DisplayOption::setHandleScale ( float  v)
inlinestatic

Methods to query/change the scale at which handles are drawn.

Definition at line 325 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setHeadlightDirection ( UT_Vector3D  dir)
void GUI_DisplayOption::setHeadlightIntensity ( fpreal  i)
void GUI_DisplayOption::setHeadlightSpecular ( bool  use_spec)
void GUI_DisplayOption::setImageMaxUV ( float  arr[2])
inline

Rotoscoping background image set/query methods

Definition at line 282 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setImageMinUV ( float  arr[2])
inline

Rotoscoping background image set/query methods

Definition at line 272 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setImageOffset ( GUI_RotoView  view,
float  arr[2] 
)
inline

Rotoscoping background image set/query methods

Definition at line 293 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setImageScale ( GUI_RotoView  view,
float  arr[2] 
)
inline

Rotoscoping background image set/query methods

Definition at line 303 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setObjectLevel ( bool  onoff)

State which switches the geometry context display options between the Scene and Model display sets. When at the object level, the scene is used.

bool GUI_DisplayOption::setRotoCopParms ( GUI_RotoView  type,
const char *  path,
float  quality 
)

Rotoscoping background image set/query methods

bool GUI_DisplayOption::setRotoFileParms ( GUI_RotoView  type,
const char *  file,
float  quality 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoPath ( GUI_RotoView  type,
bool  file_path,
const char *  path 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoQuality ( fpreal  q)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoSource ( GUI_RotoView  type,
bool  file 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoTime ( fpreal  t)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setSelectMask ( unsigned  mask)
inline

The select mask is set when the user is in a "select" state to automatically turn on some decorations. The mask is used to temporarily tweak the appropriate display options, and does not, in and of itself, invalidate display lists.

Definition at line 350 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setSeparateStereoRender ( gui_StereoPass  pass)
inline

Allow rendering of a single stereo camera eye.

Definition at line 367 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showCurrentOutput ( ) const
inline

Definition at line 114 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showCurrentOutput ( bool  onoff)
inline

Definition at line 178 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showDisplay ( ) const
inline

Definition at line 115 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showDisplay ( bool  onoff)
inline

Definition at line 180 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showFootprints ( ) const
inline

Definition at line 113 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showFootprints ( bool  onoff)
inline

Definition at line 177 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showFullNames ( ) const
inline

Definition at line 118 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showFullNames ( bool  onoff)
inline

Definition at line 183 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showGuides ( ) const
inline

Definition at line 116 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showGuides ( bool  onoff)
inline

Definition at line 181 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showIKCriticalZones ( ) const
inline

Definition at line 133 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showIKCriticalZones ( bool  onoff)
inline

Definition at line 198 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showMaterials ( ) const
inline

Definition at line 151 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showMaterials ( bool  show)
inline

Definition at line 216 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showNonSelected ( ) const
inline

Definition at line 111 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showNonSelected ( bool  onoff)
inline

Definition at line 175 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showObjectNames ( ) const
inline

Definition at line 117 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showObjectNames ( bool  onoff)
inline

Definition at line 182 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showSelected ( ) const
inline

Definition at line 110 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showSelected ( bool  onoff)
inline

Definition at line 174 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showTemplates ( ) const
inline

Definition at line 112 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showTemplates ( bool  onoff)
inline

Definition at line 176 of file GUI_DisplayOption.h.

void GUI_DisplayOption::updateOptionsForHardware ( RE_Render r)

Auto-select quality/preformance presets based on hardware queries. Only works at startup.

bool GUI_DisplayOption::useMaterialOverrides ( ) const
inline

Definition at line 152 of file GUI_DisplayOption.h.

void GUI_DisplayOption::useMaterialOverrides ( bool  ovr)
inline

Definition at line 217 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::xrayQuality ( ) const
inline

Definition at line 149 of file GUI_DisplayOption.h.

void GUI_DisplayOption::xrayQuality ( bool  q)
inline

Definition at line 213 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::xrayWireStrength ( ) const
inline

Definition at line 157 of file GUI_DisplayOption.h.

void GUI_DisplayOption::xrayWireStrength ( fpreal  w)
inline

Definition at line 214 of file GUI_DisplayOption.h.

Member Data Documentation

unsigned GUI_DisplayOption::applySelectMask

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::autoDetectAttribType2D

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawBackgrounds

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawCameraMask

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawEnvironmentMaps

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawFieldGuide

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawFilteredBackgrounds

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawObjOrigins

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawOrigin

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawSafeArea

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawSpecular

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawStickyOrigin

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawVertexAttrib2D

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawViewPivot

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawWalls

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawXRay

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawXYPlane

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawXZPlane

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawYZPlane

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::isClipOutPass

Definition at line 511 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::isObjectLevel

Definition at line 511 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::mssEnable

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::mssPacked

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::mssPerPrim

Definition at line 471 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::myAutoPlaceImage

Definition at line 462 of file GUI_DisplayOption.h.

float GUI_DisplayOption::myBrightness

Definition at line 461 of file GUI_DisplayOption.h.

float GUI_DisplayOption::myImageOffset[2]

Definition at line 459 of file GUI_DisplayOption.h.

float GUI_DisplayOption::myImageScale[2]

Definition at line 460 of file GUI_DisplayOption.h.

OPUI_RotoscopeData* GUI_DisplayOption::myRotoscopeData

Definition at line 458 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showCurrentOutput

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showDisplay

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showFootprints

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showFullNames

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showGuides

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showIKCriticalZones

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showMaterials

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showNonSelected

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showObjectNames

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showSelected

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showTemplates

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::useOverrides

Definition at line 471 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::xrayQuality

Definition at line 471 of file GUI_DisplayOption.h.


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