HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | List of all members
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...
 
enum  DOFBokeh { DOF_NO_BOKEH, DOF_CIRCLE_BOKEH, DOF_TEXTURE_BOKEH }
 
enum  DefaultMaterialType { DEFAULT_MATERIAL_SIMPLE = 0, DEFAULT_MATERIAL_MATCAP }
 

Public Member Functions

 GUI_DisplayOption (bool for_lops_view)
 
 ~GUI_DisplayOption ()
 
GUI_DisplayOption & operator= (const GUI_DisplayOption &opt)
 
GR_DisplayOption & getDisplaySet (GUI_DisplaySetType type)
 Direct cccess to the display set, without any mapping. More...
 
void setDisplaySetRemap (GUI_DisplaySetType follower, GUI_DisplaySetType reference)
 Remap the display option set to another set. More...
 
GUI_DisplaySetType getDisplaySetRemap (GUI_DisplaySetType t) const
 
void setRenderType (GR_RenderVersion t)
 
GR_RenderVersion getRenderType () 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 drawBadges () 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 drawBadges (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 setUVMapFile (const UT_StringRef &uvmap)
 
const UT_StringRef & getUVMapFile () const
 
void setUVMapScale (fpreal scale)
 
fpreal getUVMapScale () const
 
void removeUserOption (int option_id)
 
void refreshUserOptionVersions ()
 
UI_Value & getObjectLevelNotify ()
 
void updateOptionsForHardware (RE_RenderContext 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 setHeadlightHighQuality (bool hq)
 
bool getHeadlightHighQuality () const
 
void setHQLightLimit (int nlights)
 
int getHQLightLimit () const
 
bool hasHQLightLimit () const
 
void setShadowMapMemMB (int mem)
 
int getShadowMapMemMB () const
 
void setShadowMapGenTime (fpreal t)
 
fpreal getShadowMapGenTime () const
 
void setLightSamplingLimit (int limit)
 
int getLightSamplingLimit () const
 
bool hasLightSamplingLimit () const
 
void setFastInteractiveHQLight (bool e)
 
bool getFastInteractiveHQLight () const
 
void setDOFEnable (bool dof)
 
bool isDOFEnabled () const
 
void setDOFBokeh (DOFBokeh b)
 
DOFBokeh getDOFBokeh () const
 
void setDOFTexture (const UT_StringRef &tex)
 
const UT_StringRef & getDOFTexture () const
 
fpreal getDOFBokehAspect () const
 
void setDOFBokehAspect (fpreal a)
 
fpreal getDOFBokehBoost () const
 
void setDOFBokehBoost (fpreal b)
 
void setUniformFogEnable (bool fog)
 
bool isUniformFogEnabled () const
 
void setUniformFogDensity (fpreal d)
 
fpreal getUniformFogDensity () const
 
void setUniformFogOpacity (fpreal d)
 
fpreal getUniformFogOpacity () const
 
void setUniformFogColor (const UT_Vector3F &c)
 
UT_Vector3F getUniformFogColor () const
 
void setUniformFogStart (fpreal s)
 
fpreal getUniformFogStart () const
 
void setUniformFogEnd (fpreal e)
 
fpreal getUniformFogEnd () const
 
int getUniformFogHeightMode () const
 
void setUniformFogHeightMode (int m)
 
fpreal getUniformFogHeight () const
 
void setUniformFogHeight (fpreal h)
 
fpreal getUniformFogFalloff () const
 
void setUniformFogFalloff (fpreal f)
 
void setUniformFogIntensity (fpreal f)
 
fpreal getUniformFogIntensity () const
 
void setUniformFogSunBloom (fpreal f)
 
fpreal getUniformFogSunBloom () const
 
void setUniformFogUseSun (bool d)
 
bool getUniformFogUseSun () const
 
void setUniformFogClipDistance (fpreal d)
 
fpreal getUniformFogClipDistance () const
 
void setVolumeFogEnable (bool fog)
 
bool isVolumeFogEnabled () const
 
void setVolumeFogDensity (fpreal d)
 
fpreal getVolumeFogDensity () const
 
void setVolumeFogOpacity (fpreal d)
 
fpreal getVolumeFogOpacity () const
 
void setVolumeFogColor (const UT_Vector3F &c)
 
UT_Vector3F getVolumeFogColor () const
 
void setVolumeFogStart (fpreal s)
 
fpreal getVolumeFogStart () const
 
void setVolumeFogEnd (fpreal e)
 
fpreal getVolumeFogEnd () const
 
int getVolumeFogHeightMode () const
 
void setVolumeFogHeightMode (int m)
 
fpreal getVolumeFogHeight () const
 
void setVolumeFogHeight (fpreal h)
 
fpreal getVolumeFogFalloff () const
 
void setVolumeFogFalloff (fpreal f)
 
void setVolumeFogIntensity (fpreal f)
 
fpreal getVolumeFogIntensity () const
 
int getVolumeFogQuality () const
 
void setVolumeFogQuality (int q)
 
void setVolumeFogLightScatter (fpreal para, fpreal perp)
 
void getVolumeFogLightScatter (fpreal &para, fpreal &perp) const
 
void setBloomEnable (bool e)
 
bool isBloomEnabled () const
 
void setBloomScale (fpreal sc)
 
fpreal getBloomScale () const
 
void setBloomIntensity (fpreal i)
 
fpreal getBloomIntensity () const
 
void setBloomThreshold (fpreal th)
 
fpreal getBloomThreshold () const
 
void setFogNode (const char *node)
 
const UT_StringRef & getFogNode () const
 
void setDefaultMaterialType (DefaultMaterialType type)
 
void setDefaultMatCapFile (const UT_StringRef &tex_filepath)
 
void setDefaultMatCapIntensity (fpreal intensity)
 
void setDefaultMaterialDiffuse (UT_Color col)
 
void setDefaultMaterialSpecular (UT_Color col)
 
void setDefaultMaterialAmbient (UT_Color col)
 
void setDefaultMaterialEmission (UT_Color col)
 
void setDefaultMaterialRoughness (fpreal rough)
 
void setDefaultMaterialSpecRoughness (fpreal srough)
 
DefaultMaterialType getDefaultMaterialType () const
 
const UT_StringRef & getDefaultMatCapFile () const
 
fpreal getDefaultMatCapIntensity () const
 
UT_Color getDefaultMaterialDiffuse () const
 
UT_Color getDefaultMaterialSpecular () const
 
UT_Color getDefaultMaterialAmbient () const
 
UT_Color getDefaultMaterialEmission () const
 
fpreal getDefaultMaterialRoughness () const
 
fpreal getDefaultMaterialSpecRoughness () const
 
bool isDefaultMaterialDirty () const
 
void clearDefaultMaterialDirty ()
 
bool isDefaultMatCapDirty () const
 
bool clearDefaultMatCapDirty ()
 
void forceMSSUpdate (bool)
 
exint getMSSUpdateSerial () const
 
void getRecommendedTextureLimit (RE_Render *r, int &max2d, int &max3d) const
 
GR_DisplayOption & operator[] (GUI_DisplaySetType type)
 
const GR_DisplayOption & operator[] (GUI_DisplaySetType type) const
 
const GR_CommonDispOption & common () const
 
GR_CommonDispOption & common ()
 
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)
 
enum  FGDepthStyle {
  DEPTH_LINEAR, DEPTH_NDC, DEPTH_OPENGL, DEPTH_CAM_POS,
  DEPTH_WORLD_POS
}
 
enum  ImageFitMode {
  ImageFitMode::HORIZONTAL = 0, ImageFitMode::VERTICAL, ImageFitMode::FILL, ImageFitMode::SCALE,
  ImageFitMode::NUM_FIT_MODES
}
 
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 setRotoCop2Parms (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_Value & getRotoCop2CookNotify (GUI_RotoView type)
 
UI_Value & getRotoCop2NameChangeNotify (GUI_RotoView type)
 
void setForegroundImageEnable (bool enable)
 
bool getForegroundImageEnable () const
 
void setForegroundImage (const UT_StringRef &file_node_path)
 
const UT_StringRef & getForegroundImage () const
 
void setForegroundImageDepth (bool enable)
 
bool getForegroundImageDepth () const
 
void setForegroundDepthPlane (const UT_StringRef &plane)
 
const UT_StringRef & getForegroundDepthPlane () const
 
void setForegroundDepthStyle (FGDepthStyle style)
 
FGDepthStyle getForegroundDepthStyle () const
 
void foregroundOpacity (fpreal opacity)
 
fpreal foregroundOpacity () const
 
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 getOpacity (GUI_RotoView view) const
 
void setOpacity (GUI_RotoView view, float opacity)
 
ImageFitMode getImageFitMode (GUI_RotoView view) const
 
void setImageFitMode (GUI_RotoView view, ImageFitMode fit_mode)
 
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
 
void envMapImage (GUI_RotoView view, bool onoff)
 
bool envMapImage (GUI_RotoView view) const
 
int isRotoFileVideo (GUI_RotoView view) const
 
int getRotoVideoClipStartFrame (GUI_RotoView view) const
 
void setRotoVideoClipStartFrame (GUI_RotoView view, int start_frame)
 
int getRotoVideoClipEndFrame (GUI_RotoView view) const
 
void setRotoVideoClipEndFrame (GUI_RotoView view, int end_frame)
 
fpreal getRotoVideoPlaybackStartFrame (GUI_RotoView view) const
 
void setRotoVideoPlaybackStartFrame (GUI_RotoView view, fpreal start_frame)
 
fpreal getRotoVideoPlaybackSpeed (GUI_RotoView view) const
 
void setRotoVideoPlaybackSpeed (GUI_RotoView view, fpreal speed)
 
const char * getRotoVideoColorSpace (GUI_RotoView view) const
 
void setRotoVideoColorSpace (GUI_RotoView view, const char *color_space)
 
bool getRotoVideoFrameRateEnabled (GUI_RotoView view) const
 
void setRotoVideoFrameRateEnabled (GUI_RotoView view, bool enabled)
 
fpreal getRotoVideoFrameRate (GUI_RotoView view) const
 
void setRotoVideoFrameRate (GUI_RotoView view, fpreal frame_rate)
 
int getRotoVideoRotation (GUI_RotoView view) const
 
bool getRotoVideoIsRotated (GUI_RotoView view) const
 
bool getRotoVideoIsTopFirst (GUI_RotoView view) const
 
int getRotoVideoSourceFrameCount (GUI_RotoView view) const
 
fpreal getRotoVideoSourceFrameRate (GUI_RotoView view) const
 
void setUseFixedImageRes (bool use_fixed)
 
bool getUseFixedImageRes () const
 
void setUseViewportRes (bool use_vp)
 
bool getUseViewportRes () const
 
void setFixedImageRes (int w, int h)
 
UT_Vector2i getFixedImageRes () const
 
void setCurrentImageRes (int w, int h)
 
UT_Vector2i getCurrentImageRes () const
 
void setImageResFraction (fpreal fraction)
 
fpreal getImageResFraction () const
 
bool getCameraCropMask () const
 
void setCameraCropMask (bool crop)
 
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 65 of file GUI_DisplayOption.h.

Member Enumeration Documentation

enum GUI_DisplayOption::DefaultMaterialType
Enumerator
DEFAULT_MATERIAL_SIMPLE 
DEFAULT_MATERIAL_MATCAP 

Definition at line 712 of file GUI_DisplayOption.h.

enum GUI_DisplayOption::DOFBokeh
Enumerator
DOF_NO_BOKEH 
DOF_CIRCLE_BOKEH 
DOF_TEXTURE_BOKEH 

Definition at line 604 of file GUI_DisplayOption.h.

enum GUI_DisplayOption::FGDepthStyle

Rotoscoping background image set/query methods

Enumerator
DEPTH_LINEAR 
DEPTH_NDC 
DEPTH_OPENGL 
DEPTH_CAM_POS 
DEPTH_WORLD_POS 

Definition at line 312 of file GUI_DisplayOption.h.

enum GUI_DisplayOption::gui_MatAssignMode
Enumerator
MAT_ALWAYS 
MAT_NO_PLAYBACK 
MAT_MANUAL 

Definition at line 171 of file GUI_DisplayOption.h.

enum GUI_DisplayOption::gui_StereoPass

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 536 of file GUI_DisplayOption.h.

enum GUI_DisplayOption::ImageFitMode
strong

Rotoscoping background image set/query methods

Enumerator
HORIZONTAL 

Fit the image so that the horizontal dimension fits within the viewport

_________
_________
_________
VERTICAL 

Fit the image so that the vertical dimension fits within the viewport

_______________
FILL 

Stretch the image to fit within the viewport

_________
SCALE 

Scale the image to so that the longest dimension fits within the viewport

_________
_________
_________
NUM_FIT_MODES 

Definition at line 377 of file GUI_DisplayOption.h.

Constructor & Destructor Documentation

GUI_DisplayOption::GUI_DisplayOption ( bool  for_lops_view)
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 158 of file GUI_DisplayOption.h.

void GUI_DisplayOption::applySelectMask ( bool  onoff)
inline

Definition at line 223 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::autoDetectAttribType2D ( ) const
inline

Definition at line 152 of file GUI_DisplayOption.h.

void GUI_DisplayOption::autoDetectAttribType2D ( bool  onoff)
inline

Definition at line 217 of file GUI_DisplayOption.h.

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

Rotoscoping background image set/query methods

Definition at line 429 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::autoPlaceImage ( GUI_RotoView  view) const
inline

Rotoscoping background image set/query methods

Definition at line 431 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::clearDefaultMatCapDirty ( )
inline

Definition at line 745 of file GUI_DisplayOption.h.

void GUI_DisplayOption::clearDefaultMaterialDirty ( )
inline

Definition at line 742 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 88 of file GUI_DisplayOption.h.

GR_CommonDispOption& GUI_DisplayOption::common ( )
inline

Low-level drawing display options common to all geometry contexts

Definition at line 89 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 139 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawBackgrounds ( bool  onoff)
inline

Definition at line 205 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawBadges ( ) const
inline

Definition at line 148 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawBadges ( bool  onoff)
inline

Definition at line 214 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawEnvironmentMaps ( ) const
inline

Definition at line 140 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawEnvironmentMaps ( bool  onoff)
inline

Definition at line 206 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawFieldGuide ( ) const
inline

Definition at line 137 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawFieldGuide ( bool  onoff)
inline

Definition at line 203 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawFilteredBackgrounds ( ) const
inline

Definition at line 142 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawFilteredBackgrounds ( bool  onoff)
inline

Definition at line 208 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawMultiTexture ( ) const
inline

Definition at line 156 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawMultiTexture ( bool  onoff)
inline

Definition at line 221 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawObjectOrigins ( ) const
inline

Definition at line 162 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawObjectOrigins ( bool  org)
inline

Definition at line 228 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawOrigin ( ) const
inline

Definition at line 130 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawOrigin ( bool  onoff)
inline

Definition at line 196 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawSafeArea ( ) const
inline

Definition at line 138 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawSafeArea ( bool  onoff)
inline

Definition at line 204 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawSpecular ( ) const
inline

Definition at line 155 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawSpecular ( bool  onoff)
inline

Definition at line 219 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawStickyOrigin ( ) const
inline

Definition at line 131 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawStickyOrigin ( bool  onoff)
inline

Definition at line 197 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawVertexAttrib2D ( ) const
inline

Definition at line 150 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawVertexAttrib2D ( bool  onoff)
inline

Definition at line 215 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawViewPivot ( ) const
inline

Definition at line 132 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawViewPivot ( bool  onoff)
inline

Definition at line 198 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawWalls ( ) const
inline

Definition at line 133 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawWalls ( bool  onoff)
inline

Definition at line 199 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawXRay ( ) const
inline

Definition at line 160 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawXRay ( bool  xray)
inline

Definition at line 225 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawXYPlane ( ) const
inline

Definition at line 134 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawXYPlane ( bool  onoff)
inline

Definition at line 200 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawXZPlane ( ) const
inline

Definition at line 135 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawXZPlane ( bool  onoff)
inline

Definition at line 201 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::drawYZPlane ( ) const
inline

Definition at line 136 of file GUI_DisplayOption.h.

void GUI_DisplayOption::drawYZPlane ( bool  onoff)
inline

Definition at line 202 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::envMapImage ( GUI_RotoView  view,
bool  onoff 
)
inline

Rotoscoping background image set/query methods

Definition at line 434 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::envMapImage ( GUI_RotoView  view) const
inline

Rotoscoping background image set/query methods

Definition at line 436 of file GUI_DisplayOption.h.

void GUI_DisplayOption::forceMSSUpdate ( bool  )
inline

Definition at line 747 of file GUI_DisplayOption.h.

void GUI_DisplayOption::foregroundOpacity ( fpreal  opacity)
inline

Rotoscoping background image set/query methods

Definition at line 325 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::foregroundOpacity ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 327 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getBloomIntensity ( ) const
inline

Definition at line 705 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getBloomScale ( ) const
inline

Definition at line 703 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getBloomThreshold ( ) const
inline

Definition at line 707 of file GUI_DisplayOption.h.

float GUI_DisplayOption::getBrightness ( GUI_RotoView  view) const
inline

Rotoscoping background image set/query methods

Definition at line 424 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getCameraCropMask ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 494 of file GUI_DisplayOption.h.

UT_Vector2i GUI_DisplayOption::getCurrentImageRes ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 487 of file GUI_DisplayOption.h.

const UT_StringRef& GUI_DisplayOption::getDefaultMatCapFile ( ) const
inline

Definition at line 729 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getDefaultMatCapIntensity ( ) const
inline

Definition at line 731 of file GUI_DisplayOption.h.

UT_Color GUI_DisplayOption::getDefaultMaterialAmbient ( ) const
inline

Definition at line 735 of file GUI_DisplayOption.h.

UT_Color GUI_DisplayOption::getDefaultMaterialDiffuse ( ) const
inline

Definition at line 733 of file GUI_DisplayOption.h.

UT_Color GUI_DisplayOption::getDefaultMaterialEmission ( ) const
inline

Definition at line 736 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getDefaultMaterialRoughness ( ) const
inline

Definition at line 737 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getDefaultMaterialSpecRoughness ( ) const
inline

Definition at line 738 of file GUI_DisplayOption.h.

UT_Color GUI_DisplayOption::getDefaultMaterialSpecular ( ) const
inline

Definition at line 734 of file GUI_DisplayOption.h.

DefaultMaterialType GUI_DisplayOption::getDefaultMaterialType ( ) const
inline

Definition at line 727 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 83 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 105 of file GUI_DisplayOption.h.

DOFBokeh GUI_DisplayOption::getDOFBokeh ( ) const
inline

Definition at line 611 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getDOFBokehAspect ( ) const
inline

Definition at line 614 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getDOFBokehBoost ( ) const
inline

Definition at line 616 of file GUI_DisplayOption.h.

const UT_StringRef& GUI_DisplayOption::getDOFTexture ( ) const
inline

Definition at line 613 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getDrawCameraMask ( ) const
inline

Definition at line 146 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getFastInteractiveHQLight ( ) const
inline

Definition at line 599 of file GUI_DisplayOption.h.

UT_Vector2i GUI_DisplayOption::getFixedImageRes ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 483 of file GUI_DisplayOption.h.

const UT_StringRef& GUI_DisplayOption::getFogNode ( ) const
inline

Definition at line 710 of file GUI_DisplayOption.h.

const UT_StringRef& GUI_DisplayOption::getForegroundDepthPlane ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 310 of file GUI_DisplayOption.h.

FGDepthStyle GUI_DisplayOption::getForegroundDepthStyle ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 322 of file GUI_DisplayOption.h.

const UT_StringRef& GUI_DisplayOption::getForegroundImage ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 303 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getForegroundImageDepth ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 306 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getForegroundImageEnable ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 299 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 502 of file GUI_DisplayOption.h.

UT_Vector3D GUI_DisplayOption::getHeadlightDirection ( ) const
inline

Definition at line 578 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getHeadlightHighQuality ( ) const
inline

Definition at line 584 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getHeadlightIntensity ( ) const
inline

Definition at line 575 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getHeadlightSpecular ( ) const
inline

Definition at line 581 of file GUI_DisplayOption.h.

int GUI_DisplayOption::getHQLightLimit ( ) const
inline

Definition at line 587 of file GUI_DisplayOption.h.

ImageFitMode GUI_DisplayOption::getImageFitMode ( GUI_RotoView  view) const
inline

Rotoscoping background image set/query methods

Definition at line 419 of file GUI_DisplayOption.h.

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

Rotoscoping background image set/query methods

Definition at line 340 of file GUI_DisplayOption.h.

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

Rotoscoping background image set/query methods

Definition at line 330 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 351 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getImageResFraction ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 491 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 361 of file GUI_DisplayOption.h.

int GUI_DisplayOption::getLightSamplingLimit ( ) const
inline

Definition at line 595 of file GUI_DisplayOption.h.

exint GUI_DisplayOption::getMSSUpdateSerial ( ) const
inline

Definition at line 748 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 533 of file GUI_DisplayOption.h.

float GUI_DisplayOption::getOpacity ( GUI_RotoView  view) const
inline

Rotoscoping background image set/query methods

Definition at line 372 of file GUI_DisplayOption.h.

void GUI_DisplayOption::getRecommendedTextureLimit ( RE_Render *  r,
int &  max2d,
int &  max3d 
) const
GR_RenderVersion GUI_DisplayOption::getRenderType ( ) const
inline

Definition at line 116 of file GUI_DisplayOption.h.

UI_Value& GUI_DisplayOption::getRotoCop2CookNotify ( GUI_RotoView  type)

Rotoscoping background image set/query methods

UI_Value& GUI_DisplayOption::getRotoCop2NameChangeNotify ( 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

int GUI_DisplayOption::getRotoVideoClipEndFrame ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

int GUI_DisplayOption::getRotoVideoClipStartFrame ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

const char* GUI_DisplayOption::getRotoVideoColorSpace ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

fpreal GUI_DisplayOption::getRotoVideoFrameRate ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

bool GUI_DisplayOption::getRotoVideoFrameRateEnabled ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

bool GUI_DisplayOption::getRotoVideoIsRotated ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

bool GUI_DisplayOption::getRotoVideoIsTopFirst ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

fpreal GUI_DisplayOption::getRotoVideoPlaybackSpeed ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

fpreal GUI_DisplayOption::getRotoVideoPlaybackStartFrame ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

int GUI_DisplayOption::getRotoVideoRotation ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

int GUI_DisplayOption::getRotoVideoSourceFrameCount ( GUI_RotoView  view) const

Rotoscoping background image set/query methods

fpreal GUI_DisplayOption::getRotoVideoSourceFrameRate ( GUI_RotoView  view) 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 527 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getShadowMapGenTime ( ) const
inline

Definition at line 593 of file GUI_DisplayOption.h.

int GUI_DisplayOption::getShadowMapMemMB ( ) const
inline

Definition at line 590 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogClipDistance ( ) const
inline

Definition at line 654 of file GUI_DisplayOption.h.

UT_Vector3F GUI_DisplayOption::getUniformFogColor ( ) const
inline

Definition at line 628 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogDensity ( ) const
inline

Definition at line 623 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogEnd ( ) const
inline

Definition at line 632 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogFalloff ( ) const
inline

Definition at line 639 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogHeight ( ) const
inline

Definition at line 637 of file GUI_DisplayOption.h.

int GUI_DisplayOption::getUniformFogHeightMode ( ) const
inline

Definition at line 633 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogIntensity ( ) const
inline

Definition at line 645 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogOpacity ( ) const
inline

Definition at line 625 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogStart ( ) const
inline

Definition at line 630 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUniformFogSunBloom ( ) const
inline

Definition at line 649 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getUniformFogUseSun ( ) const
inline

Definition at line 651 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getUseFixedImageRes ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 472 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::getUseViewportRes ( ) const
inline

Rotoscoping background image set/query methods

Definition at line 476 of file GUI_DisplayOption.h.

const UT_StringRef& GUI_DisplayOption::getUVMapFile ( ) const
inline

Definition at line 251 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getUVMapScale ( ) const
inline

Definition at line 254 of file GUI_DisplayOption.h.

UT_Vector3F GUI_DisplayOption::getVolumeFogColor ( ) const
inline

Definition at line 667 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getVolumeFogDensity ( ) const
inline

Definition at line 662 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getVolumeFogEnd ( ) const
inline

Definition at line 671 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getVolumeFogFalloff ( ) const
inline

Definition at line 678 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getVolumeFogHeight ( ) const
inline

Definition at line 676 of file GUI_DisplayOption.h.

int GUI_DisplayOption::getVolumeFogHeightMode ( ) const
inline

Definition at line 672 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getVolumeFogIntensity ( ) const
inline

Definition at line 684 of file GUI_DisplayOption.h.

void GUI_DisplayOption::getVolumeFogLightScatter ( fpreal &  para,
fpreal &  perp 
) const
inline

Definition at line 694 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getVolumeFogOpacity ( ) const
inline

Definition at line 664 of file GUI_DisplayOption.h.

int GUI_DisplayOption::getVolumeFogQuality ( ) const
inline

Definition at line 686 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::getVolumeFogStart ( ) const
inline

Definition at line 669 of file GUI_DisplayOption.h.

void GUI_DisplayOption::handleHighlightSize ( int  hl)
inline

Definition at line 237 of file GUI_DisplayOption.h.

int GUI_DisplayOption::handleHighlightSize ( ) const
inline

Definition at line 239 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::hasHQLightLimit ( ) const
inline

Definition at line 588 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::hasLightSamplingLimit ( ) const
inline

Definition at line 596 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isBloomEnabled ( ) const
inline

Definition at line 701 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isDefaultMatCapDirty ( ) const
inline

Definition at line 744 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isDefaultMaterialDirty ( ) const
inline

Definition at line 741 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isDOFEnabled ( ) const
inline

Definition at line 603 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 518 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isRotoFile ( GUI_RotoView  type) const

Rotoscoping background image set/query methods

int GUI_DisplayOption::isRotoFileVideo ( GUI_RotoView  view) 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 547 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isStereoRightRender ( ) const
inline

Allow rendering of a single stereo camera eye.

Definition at line 550 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isUniformFogEnabled ( ) const
inline

Definition at line 621 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::isVolumeFogEnabled ( ) const
inline

Definition at line 660 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 177 of file GUI_DisplayOption.h.

void GUI_DisplayOption::materialAssignMode ( gui_MatAssignMode  mode)
inline

Definition at line 178 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::materialUpdate ( ) const
inline

Definition at line 180 of file GUI_DisplayOption.h.

void GUI_DisplayOption::materialUpdate ( bool  update)
inline

Definition at line 181 of file GUI_DisplayOption.h.

void GUI_DisplayOption::moveModeOn ( bool  onoff)
inline

set/query enable/disable of shading mode change

Definition at line 246 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::moveModeOn ( ) const
inline

set/query enable/disable of shading mode change

Definition at line 247 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::mssEnable ( ) const
inline

Definition at line 165 of file GUI_DisplayOption.h.

void GUI_DisplayOption::mssEnable ( bool  mss)
inline

Definition at line 231 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::mssPacked ( ) const
inline

Definition at line 167 of file GUI_DisplayOption.h.

void GUI_DisplayOption::mssPacked ( bool  mp)
inline

Definition at line 233 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::mssPerPrim ( ) const
inline

Definition at line 166 of file GUI_DisplayOption.h.

void GUI_DisplayOption::mssPerPrim ( bool  mpp)
inline

Definition at line 232 of file GUI_DisplayOption.h.

int GUI_DisplayOption::objectMaterialLimit ( ) const
inline

Definition at line 168 of file GUI_DisplayOption.h.

void GUI_DisplayOption::objectMaterialLimit ( int  m)
inline

Definition at line 234 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 76 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 78 of file GUI_DisplayOption.h.

void GUI_DisplayOption::originGnomonSize ( fpreal  size)
inline

Definition at line 240 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::originGnomonSize ( ) const
inline

Definition at line 242 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::setBloomEnable ( bool  e)
inline

Definition at line 700 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setBloomIntensity ( fpreal  i)
inline

Definition at line 704 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setBloomScale ( fpreal  sc)
inline

Definition at line 702 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setBloomThreshold ( fpreal  th)
inline

Definition at line 706 of file GUI_DisplayOption.h.

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

Rotoscoping background image set/query methods

Definition at line 426 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setCameraCropMask ( bool  crop)
inline

Rotoscoping background image set/query methods

Definition at line 495 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setCurrentImageRes ( int  w,
int  h 
)
inline

Rotoscoping background image set/query methods

Definition at line 485 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDefaultMatCapFile ( const UT_StringRef &  tex_filepath)
void GUI_DisplayOption::setDefaultMatCapIntensity ( fpreal  intensity)
void GUI_DisplayOption::setDefaultMaterialAmbient ( UT_Color  col)
void GUI_DisplayOption::setDefaultMaterialDiffuse ( UT_Color  col)
void GUI_DisplayOption::setDefaultMaterialEmission ( UT_Color  col)
void GUI_DisplayOption::setDefaultMaterialRoughness ( fpreal  rough)
void GUI_DisplayOption::setDefaultMaterialSpecRoughness ( fpreal  srough)
void GUI_DisplayOption::setDefaultMaterialSpecular ( UT_Color  col)
void GUI_DisplayOption::setDefaultMaterialType ( DefaultMaterialType  type)
void GUI_DisplayOption::setDisplaySetRemap ( GUI_DisplaySetType  follower,
GUI_DisplaySetType  reference 
)
inline

Remap the display option set to another set.

Definition at line 99 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDOFBokeh ( DOFBokeh  b)
inline

Definition at line 610 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDOFBokehAspect ( fpreal  a)
inline

Definition at line 615 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDOFBokehBoost ( fpreal  b)
inline

Definition at line 617 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDOFEnable ( bool  dof)
inline

Definition at line 602 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDOFTexture ( const UT_StringRef &  tex)
inline

Definition at line 612 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setDrawCameraMask ( bool  onoff)
inline

Definition at line 212 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setFastInteractiveHQLight ( bool  e)
inline

Definition at line 597 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setFixedImageRes ( int  w,
int  h 
)
inline

Rotoscoping background image set/query methods

Definition at line 478 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setFogNode ( const char *  node)
inline

Definition at line 709 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setForegroundDepthPlane ( const UT_StringRef &  plane)
inline

Rotoscoping background image set/query methods

Definition at line 308 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setForegroundDepthStyle ( FGDepthStyle  style)
inline

Rotoscoping background image set/query methods

Definition at line 320 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setForegroundImage ( const UT_StringRef &  file_node_path)
inline

Rotoscoping background image set/query methods

Definition at line 301 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setForegroundImageDepth ( bool  enable)
inline

Rotoscoping background image set/query methods

Definition at line 304 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setForegroundImageEnable ( bool  enable)
inline

Rotoscoping background image set/query methods

Definition at line 297 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 503 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setHeadlightDirection ( UT_Vector3D  dir)
void GUI_DisplayOption::setHeadlightHighQuality ( bool  hq)
inline

Definition at line 583 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setHeadlightIntensity ( fpreal  i)
void GUI_DisplayOption::setHeadlightSpecular ( bool  use_spec)
void GUI_DisplayOption::setHQLightLimit ( int  nlights)
inline

Definition at line 586 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setImageFitMode ( GUI_RotoView  view,
ImageFitMode  fit_mode 
)
inline

Rotoscoping background image set/query methods

Definition at line 421 of file GUI_DisplayOption.h.

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

Rotoscoping background image set/query methods

Definition at line 345 of file GUI_DisplayOption.h.

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

Rotoscoping background image set/query methods

Definition at line 335 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 356 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setImageResFraction ( fpreal  fraction)
inline

Rotoscoping background image set/query methods

Definition at line 489 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 366 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setLightSamplingLimit ( int  limit)
inline

Definition at line 594 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.

void GUI_DisplayOption::setOpacity ( GUI_RotoView  view,
float  opacity 
)
inline

Rotoscoping background image set/query methods

Definition at line 374 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setRenderType ( GR_RenderVersion  t)
inline

Definition at line 114 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::setRotoCop2Parms ( 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::setRotoVideoClipEndFrame ( GUI_RotoView  view,
int  end_frame 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoVideoClipStartFrame ( GUI_RotoView  view,
int  start_frame 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoVideoColorSpace ( GUI_RotoView  view,
const char *  color_space 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoVideoFrameRate ( GUI_RotoView  view,
fpreal  frame_rate 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoVideoFrameRateEnabled ( GUI_RotoView  view,
bool  enabled 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoVideoPlaybackSpeed ( GUI_RotoView  view,
fpreal  speed 
)

Rotoscoping background image set/query methods

void GUI_DisplayOption::setRotoVideoPlaybackStartFrame ( GUI_RotoView  view,
fpreal  start_frame 
)

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 528 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setSeparateStereoRender ( gui_StereoPass  pass)
inline

Allow rendering of a single stereo camera eye.

Definition at line 545 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setShadowMapGenTime ( fpreal  t)
inline

Definition at line 591 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setShadowMapMemMB ( int  mem)
inline

Definition at line 589 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogClipDistance ( fpreal  d)
inline

Definition at line 652 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogColor ( const UT_Vector3F &  c)
inline

Definition at line 626 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogDensity ( fpreal  d)
inline

Definition at line 622 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogEnable ( bool  fog)
inline

Definition at line 620 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogEnd ( fpreal  e)
inline

Definition at line 631 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogFalloff ( fpreal  f)
inline

Definition at line 641 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogHeight ( fpreal  h)
inline

Definition at line 638 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogHeightMode ( int  m)
inline

Definition at line 635 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogIntensity ( fpreal  f)
inline

Definition at line 643 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogOpacity ( fpreal  d)
inline

Definition at line 624 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogStart ( fpreal  s)
inline

Definition at line 629 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogSunBloom ( fpreal  f)
inline

Definition at line 648 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUniformFogUseSun ( bool  d)
inline

Definition at line 650 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUseFixedImageRes ( bool  use_fixed)
inline

Rotoscoping background image set/query methods

Definition at line 470 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUseViewportRes ( bool  use_vp)
inline

Rotoscoping background image set/query methods

Definition at line 474 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setUVMapFile ( const UT_StringRef &  uvmap)
void GUI_DisplayOption::setUVMapScale ( fpreal  scale)
void GUI_DisplayOption::setVolumeFogColor ( const UT_Vector3F &  c)
inline

Definition at line 665 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogDensity ( fpreal  d)
inline

Definition at line 661 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogEnable ( bool  fog)
inline

Definition at line 659 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogEnd ( fpreal  e)
inline

Definition at line 670 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogFalloff ( fpreal  f)
inline

Definition at line 680 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogHeight ( fpreal  h)
inline

Definition at line 677 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogHeightMode ( int  m)
inline

Definition at line 674 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogIntensity ( fpreal  f)
inline

Definition at line 682 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogLightScatter ( fpreal  para,
fpreal  perp 
)
inline

Definition at line 689 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogOpacity ( fpreal  d)
inline

Definition at line 663 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogQuality ( int  q)
inline

Definition at line 687 of file GUI_DisplayOption.h.

void GUI_DisplayOption::setVolumeFogStart ( fpreal  s)
inline

Definition at line 668 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showCurrentOutput ( ) const
inline

Definition at line 125 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showCurrentOutput ( bool  onoff)
inline

Definition at line 190 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showDisplay ( ) const
inline

Definition at line 126 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showDisplay ( bool  onoff)
inline

Definition at line 192 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showFootprints ( ) const
inline

Definition at line 124 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showFootprints ( bool  onoff)
inline

Definition at line 189 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showFullNames ( ) const
inline

Definition at line 129 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showFullNames ( bool  onoff)
inline

Definition at line 195 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showGuides ( ) const
inline

Definition at line 127 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showGuides ( bool  onoff)
inline

Definition at line 193 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showIKCriticalZones ( ) const
inline

Definition at line 144 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showIKCriticalZones ( bool  onoff)
inline

Definition at line 210 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showMaterials ( ) const
inline

Definition at line 163 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showMaterials ( bool  show)
inline

Definition at line 229 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showNonSelected ( ) const
inline

Definition at line 122 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showNonSelected ( bool  onoff)
inline

Definition at line 187 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showObjectNames ( ) const
inline

Definition at line 128 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showObjectNames ( bool  onoff)
inline

Definition at line 194 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showSelected ( ) const
inline

Definition at line 121 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showSelected ( bool  onoff)
inline

Definition at line 186 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::showTemplates ( ) const
inline

Definition at line 123 of file GUI_DisplayOption.h.

void GUI_DisplayOption::showTemplates ( bool  onoff)
inline

Definition at line 188 of file GUI_DisplayOption.h.

void GUI_DisplayOption::updateOptionsForHardware ( RE_RenderContext  r)

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

bool GUI_DisplayOption::useMaterialOverrides ( ) const
inline

Definition at line 164 of file GUI_DisplayOption.h.

void GUI_DisplayOption::useMaterialOverrides ( bool  ovr)
inline

Definition at line 230 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::xrayQuality ( ) const
inline

Definition at line 161 of file GUI_DisplayOption.h.

void GUI_DisplayOption::xrayQuality ( bool  q)
inline

Definition at line 226 of file GUI_DisplayOption.h.

fpreal GUI_DisplayOption::xrayWireStrength ( ) const
inline

Definition at line 169 of file GUI_DisplayOption.h.

void GUI_DisplayOption::xrayWireStrength ( fpreal  w)
inline

Definition at line 227 of file GUI_DisplayOption.h.

Member Data Documentation

unsigned GUI_DisplayOption::applySelectMask

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::autoDetectAttribType2D

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::bloom

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::dofEnable

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawBackgrounds

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawBadges

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawCameraMask

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawEnvironmentMaps

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawFieldGuide

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawFilteredBackgrounds

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawObjOrigins

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawOrigin

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawSafeArea

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawSpecular

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawStickyOrigin

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawVertexAttrib2D

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawViewPivot

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawWalls

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawXRay

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawXYPlane

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawXZPlane

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::drawYZPlane

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::isObjectLevel

Definition at line 857 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::mssEnable

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::mssPacked

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::mssPerPrim

Definition at line 810 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::myAutoPlaceImage = false

Definition at line 795 of file GUI_DisplayOption.h.

float GUI_DisplayOption::myBrightness = 1.0f

Definition at line 794 of file GUI_DisplayOption.h.

bool GUI_DisplayOption::myEnvMapImage = false

Definition at line 797 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::myFastHQIntLight

Definition at line 810 of file GUI_DisplayOption.h.

ImageFitMode GUI_DisplayOption::myImageFitMode = ImageFitMode::SCALE

Definition at line 796 of file GUI_DisplayOption.h.

float GUI_DisplayOption::myImageOffset[2] = {0.0f, 0.0f}

Definition at line 791 of file GUI_DisplayOption.h.

float GUI_DisplayOption::myImageScale[2] = {1.0f, 1.0f}

Definition at line 792 of file GUI_DisplayOption.h.

float GUI_DisplayOption::myOpacity = 1.0f

Definition at line 793 of file GUI_DisplayOption.h.

UT_UniquePtr<OPUI_RotoscopeData> GUI_DisplayOption::myRotoscopeData

Definition at line 790 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showCurrentOutput

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showDisplay

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showFootprints

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showForegroundImage

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showFullNames

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showGuides

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showIKCriticalZones

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showNonSelected

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showObjectNames

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showSelected

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::showTemplates

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::uniformFogEnable

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::useForegroundDepth

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::useOverrides

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::volumeFogEnable

Definition at line 810 of file GUI_DisplayOption.h.

unsigned GUI_DisplayOption::xrayQuality

Definition at line 810 of file GUI_DisplayOption.h.

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