IViewportViewSetting Class Reference
 
 
 
IViewportViewSetting Class Reference

#include <IViewportViewSetting.h>

Inheritance diagram for IViewportViewSetting:
FPMixinInterface FPInterface BaseInterface InterfaceServer MaxHeapOperators

Class Description

Viewport Setting For The Nitrous Graphics Viewport.

Note:
To access this interface from a ViewExp object, please call ViewExp::GetInterface(IVIEWPORT_SETTINGS_INTERFACE_ID).

Public Member Functions

virtual void  SetProgressiveRenderingEnabled (bool enabled)=0
  Enable/Disable progressive rendering.
virtual bool  GetProgressiveRenderingEnabled () const =0
  Get the enable state of progressive rendering.
virtual void  SetShowEdgedFaces (bool bShowEdgeFaces)=0
  Enable/Disable show edged faces.
virtual bool  GetShowEdgedFaces () const =0
  Get the state of showing edged faces.
virtual void  SetUseTexture (bool bUseTexture)=0
  Enable/Disable use texture.
virtual bool  GetUseTexture () const =0
  Get the state of 'use texture'.
virtual void  SetSelectedEdgedFaces (bool bSelEdgedFaces)=0
  Enable/Disable display selected with edged faces.
virtual bool  GetSelectedEdgedFaces () const =0
  Get the state of 'display selected with edged faces'.
virtual void  SetShowSelectionBrackets (bool bShowSelectionBrackets)=0
  Enable/Disable use selection brackets.
virtual bool  GetShowSelectionBrackets () const =0
  Get the state of show selection brackets.
virtual void  SetShadeSelectedFaces (bool bShadeSelFaces)=0
  Enable/Disable shade selected faces.
virtual bool  GetShadeSelectedFaces () const =0
  Get the state of shade selected edged faces.
virtual void  SetViewportDisable (bool bViewportDisable)=0
  Set true to disable viewport or false otherwise.
virtual bool  GetViewportDisable () const =0
  Get the state of viewport disable.
virtual void  SetViewportClipping (bool bVptClipping)=0
  Enable/Disable viewport clipping.
virtual bool  GetViewportClipping () const =0
  Get the state of viewport clipping.
virtual void  SetUseEnvironmentBackgroundColor (bool bUseEnvColor)=0
  Enable/Disable use environment background color.
virtual bool  GetUseEnvironmentBackgroundColor () const =0
  Get the state of use environment background color.
virtual void  SetUseViewportBackground (bool bValue)=0
  Enable/Disable use viewport background.
virtual bool  GetUseViewportBackground () const =0
  Get the state of use viewport background.
virtual void  SetShowHighLight (bool bShowHighLight)=0
  Enable/Disable show highlight.
virtual bool  GetShowHighlight () const =0
  Get the state of show highlight.
virtual void  SetViewportVisualStyle (VisualStyle visualStyle)=0
  Set the current view style.
virtual VisualStyle  GetViewportVisualStyle () const =0
  Get the viewport visual style of current viewport.
virtual void  SetShadeSelectedObjects (bool bShadeSelObj)=0
  Enable/Disable shade selected objects.
virtual bool  GetShadeSelectedObjects () const =0
  Get the state of shade selected objects.
virtual void  SetAutoDisplaySelectedLight (bool bAutoDisSelLight)=0
  Enable/Disable auto display selected light.
virtual bool  GetAutoDisplaySelectedLight () const =0
  Get the state of auto display selected light.
virtual void  SetAmbientOcclusionEnabled (bool bAmbientOcclusionEnabled)=0
  Enable/Disable ambient occlusion.
virtual bool  GetAmbientOcclusionEnabled () const =0
  Get the enabled state of ambient occlusion.
virtual void  SetShadowsEnabled (bool bShadowsEnabled)=0
  Enable/Disable shadow.
virtual bool  GetShadowsEnabled () const =0
  Get the state of display shadow.
virtual void  SetAdaptiveDegradeAlwaysDegradeLights (bool bDegradeLights)=0
  Enable/Disable degrade to default lights.
virtual bool  GetAdaptiveDegradeAlwaysDegradeLights () const =0
  Get the state of degrade to default lights.
virtual void  SetAdaptiveDegradeDrawBackfaces (bool bDrawBackfaces)=0
  Enable/Disable draw back faces for wireframe mesh in adaptive degradation.
virtual bool  GetAdaptiveDegradeDrawBackfaces () const =0
  Get the state of draw backfaces.
virtual void  SetAdaptiveDegradeNeverDegradeGeometry (bool bNeverDegradeGeometry)=0
  Set true to never degrade geometry or false otherwise.
virtual bool  GetAdaptiveDegradeNeverDegradeGeometry () const =0
  Get the state of never degrade geometry.

Protected Member Functions

virtual  ~IViewportViewSetting ()

Constructor & Destructor Documentation

virtual ~IViewportViewSetting ( ) [inline, protected, virtual]
{}

Member Function Documentation

virtual void SetProgressiveRenderingEnabled ( bool  enabled ) [pure virtual]

Enable/Disable progressive rendering.

virtual bool GetProgressiveRenderingEnabled ( ) const [pure virtual]

Get the enable state of progressive rendering.

Returns:
true if enabled or false otherwise
virtual void SetShowEdgedFaces ( bool  bShowEdgeFaces ) [pure virtual]

Enable/Disable show edged faces.

virtual bool GetShowEdgedFaces ( ) const [pure virtual]

Get the state of showing edged faces.

Returns:
true if edged faces is on or false otherwise
virtual void SetUseTexture ( bool  bUseTexture ) [pure virtual]

Enable/Disable use texture.

virtual bool GetUseTexture ( ) const [pure virtual]

Get the state of 'use texture'.

Returns:
true if use texture or false otherwise
virtual void SetSelectedEdgedFaces ( bool  bSelEdgedFaces ) [pure virtual]

Enable/Disable display selected with edged faces.

virtual bool GetSelectedEdgedFaces ( ) const [pure virtual]

Get the state of 'display selected with edged faces'.

Returns:
true if this option is on or false otherwise
virtual void SetShowSelectionBrackets ( bool  bShowSelectionBrackets ) [pure virtual]

Enable/Disable use selection brackets.

virtual bool GetShowSelectionBrackets ( ) const [pure virtual]

Get the state of show selection brackets.

Returns:
true if this option is on or false otherwise
virtual void SetShadeSelectedFaces ( bool  bShadeSelFaces ) [pure virtual]

Enable/Disable shade selected faces.

virtual bool GetShadeSelectedFaces ( ) const [pure virtual]

Get the state of shade selected edged faces.

Returns:
true if this option is on or false otherwise
virtual void SetViewportDisable ( bool  bViewportDisable ) [pure virtual]

Set true to disable viewport or false otherwise.

virtual bool GetViewportDisable ( ) const [pure virtual]

Get the state of viewport disable.

Returns:
true if viewport is currently disabled or false otherwise
virtual void SetViewportClipping ( bool  bVptClipping ) [pure virtual]

Enable/Disable viewport clipping.

virtual bool GetViewportClipping ( ) const [pure virtual]

Get the state of viewport clipping.

Returns:
true if this option is on or false otherwise
virtual void SetUseEnvironmentBackgroundColor ( bool  bUseEnvColor ) [pure virtual]

Enable/Disable use environment background color.

virtual bool GetUseEnvironmentBackgroundColor ( ) const [pure virtual]

Get the state of use environment background color.

Returns:
true if this option is on or false otherwise
virtual void SetUseViewportBackground ( bool  bValue ) [pure virtual]

Enable/Disable use viewport background.

virtual bool GetUseViewportBackground ( ) const [pure virtual]

Get the state of use viewport background.

Returns:
true if this option is on or false otherwise
virtual void SetShowHighLight ( bool  bShowHighLight ) [pure virtual]

Enable/Disable show highlight.

virtual bool GetShowHighlight ( ) const [pure virtual]

Get the state of show highlight.

Returns:
true if this option is on or false otherwise
virtual void SetViewportVisualStyle ( VisualStyle  visualStyle ) [pure virtual]

Set the current view style.

virtual VisualStyle GetViewportVisualStyle ( ) const [pure virtual]

Get the viewport visual style of current viewport.

Returns:
the visual style
virtual void SetShadeSelectedObjects ( bool  bShadeSelObj ) [pure virtual]

Enable/Disable shade selected objects.

virtual bool GetShadeSelectedObjects ( ) const [pure virtual]

Get the state of shade selected objects.

Returns:
true if this option is on or false otherwise
virtual void SetAutoDisplaySelectedLight ( bool  bAutoDisSelLight ) [pure virtual]

Enable/Disable auto display selected light.

virtual bool GetAutoDisplaySelectedLight ( ) const [pure virtual]

Get the state of auto display selected light.

Returns:
true if this option is on or false otherwise
virtual void SetAmbientOcclusionEnabled ( bool  bAmbientOcclusionEnabled ) [pure virtual]

Enable/Disable ambient occlusion.

virtual bool GetAmbientOcclusionEnabled ( ) const [pure virtual]

Get the enabled state of ambient occlusion.

Returns:
true if ambient occlusion is enabled or false otherwise
virtual void SetShadowsEnabled ( bool  bShadowsEnabled ) [pure virtual]

Enable/Disable shadow.

virtual bool GetShadowsEnabled ( ) const [pure virtual]

Get the state of display shadow.

Returns:
true if shadow is on or false otherwise
virtual void SetAdaptiveDegradeAlwaysDegradeLights ( bool  bDegradeLights ) [pure virtual]

Enable/Disable degrade to default lights.

virtual bool GetAdaptiveDegradeAlwaysDegradeLights ( ) const [pure virtual]

Get the state of degrade to default lights.

Returns:
true if this option is on or false otherwise
virtual void SetAdaptiveDegradeDrawBackfaces ( bool  bDrawBackfaces ) [pure virtual]

Enable/Disable draw back faces for wireframe mesh in adaptive degradation.

virtual bool GetAdaptiveDegradeDrawBackfaces ( ) const [pure virtual]

Get the state of draw backfaces.

Returns:
true if this option is on or false otherwise
virtual void SetAdaptiveDegradeNeverDegradeGeometry ( bool  bNeverDegradeGeometry ) [pure virtual]

Set true to never degrade geometry or false otherwise.

virtual bool GetAdaptiveDegradeNeverDegradeGeometry ( ) const [pure virtual]

Get the state of never degrade geometry.

Returns:
true if this option is on or false otherwise