Viewport Setting For The Nitrous Graphics Viewport. More...

#include <IViewportViewSetting.h>

Inheritance diagram for IViewportViewSetting:

Public Member Functions
virtual void	SetProgressiveRenderingEnabled (bool enabled)=0
	Enable/Disable progressive rendering. More...

virtual bool	GetProgressiveRenderingEnabled () const =0
	Get the enable state of progressive rendering. More...

virtual void	SetShowEdgedFaces (bool bShowEdgeFaces)=0
	Enable/Disable show edged faces. More...

virtual bool	GetShowEdgedFaces () const =0
	Get the state of showing edged faces. More...

virtual void	SetUseTexture (bool bUseTexture)=0
	Enable/Disable use texture. More...

virtual bool	GetUseTexture () const =0
	Get the state of 'use texture'. More...

virtual void	SetSelectedEdgedFaces (bool bSelEdgedFaces)=0
	Enable/Disable display selected with edged faces. More...

virtual bool	GetSelectedEdgedFaces () const =0
	Get the state of 'display selected with edged faces'. More...

virtual void	SetShowSelectionBrackets (bool bShowSelectionBrackets)=0
	Enable/Disable use selection brackets. More...

virtual bool	GetShowSelectionBrackets () const =0
	Get the state of show selection brackets. More...

virtual void	SetShadeSelectedFaces (bool bShadeSelFaces)=0
	Enable/Disable shade selected faces. More...

virtual bool	GetShadeSelectedFaces () const =0
	Get the state of shade selected edged faces. More...

virtual void	SetViewportDisable (bool bViewportDisable)=0
	Set true to disable viewport or false otherwise. More...

virtual bool	GetViewportDisable () const =0
	Get the state of viewport disable. More...

virtual void	SetViewportClipping (bool bVptClipping)=0
	Enable/Disable viewport clipping. More...

virtual bool	GetViewportClipping () const =0
	Get the state of viewport clipping. More...

virtual void	SetUseEnvironmentBackgroundColor (bool bUseEnvColor)=0
	Enable/Disable use environment background color. More...

virtual bool	GetUseEnvironmentBackgroundColor () const =0
	Get the state of use environment background color. More...

virtual void	SetUseViewportBackground (bool bValue)=0
	Enable/Disable use viewport background. More...

virtual bool	GetUseViewportBackground () const =0
	Get the state of use viewport background. More...

virtual void	SetShowHighLight (bool bShowHighLight)=0
	Enable/Disable show highlight. More...

virtual bool	GetShowHighlight () const =0
	Get the state of show highlight. More...

virtual void	SetViewportVisualStyle (VisualStyle visualStyle)=0
	Set the current view style. More...

virtual VisualStyle	GetViewportVisualStyle () const =0
	Get the viewport visual style of current viewport. More...

virtual void	SetShadeSelectedObjects (bool bShadeSelObj)=0
	Enable/Disable shade selected objects. More...

virtual bool	GetShadeSelectedObjects () const =0
	Get the state of shade selected objects. More...

virtual void	SetAutoDisplaySelectedLight (bool bAutoDisSelLight)=0
	Enable/Disable auto display selected light. More...

virtual bool	GetAutoDisplaySelectedLight () const =0
	Get the state of auto display selected light. More...

virtual void	SetAmbientOcclusionEnabled (bool bAmbientOcclusionEnabled)=0
	Enable/Disable ambient occlusion. More...

virtual bool	GetAmbientOcclusionEnabled () const =0
	Get the enabled state of ambient occlusion. More...

virtual void	SetShadowsEnabled (bool bShadowsEnabled)=0
	Enable/Disable shadow. More...

virtual bool	GetShadowsEnabled () const =0
	Get the state of display shadow. More...

virtual void	SetAdaptiveDegradeAlwaysDegradeLights (bool bDegradeLights)=0
	Enable/Disable degrade to default lights. More...

virtual bool	GetAdaptiveDegradeAlwaysDegradeLights () const =0
	Get the state of degrade to default lights. More...

virtual void	SetAdaptiveDegradeDrawBackfaces (bool bDrawBackfaces)=0
	Enable/Disable draw back faces for wireframe mesh in adaptive degradation. More...

virtual bool	GetAdaptiveDegradeDrawBackfaces () const =0
	Get the state of draw backfaces. More...

virtual void	SetAdaptiveDegradeNeverDegradeGeometry (bool bNeverDegradeGeometry)=0
	Set true to never degrade geometry or false otherwise. More...

virtual bool	GetAdaptiveDegradeNeverDegradeGeometry () const =0
	Get the state of never degrade geometry. More...

Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()

virtual LifetimeType	LifetimeControl ()

virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

CoreExport	~FPMixinInterface ()

virtual BaseInterface *	GetInterface (Interface_ID id)

virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)

virtual Interface_ID	GetID ()

Public Member Functions inherited from FPInterface
virtual FPInterfaceDesc *	GetDesc ()=0

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

virtual ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Protected Member Functions
virtual	~IViewportViewSetting ()

Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)

FPMixinInterface &	operator= (const FPMixinInterface &rhs)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Detailed 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).

Constructor & Destructor Documentation

◆ ~IViewportViewSetting()

virtual ~IViewportViewSetting ( )

inlineprotectedvirtual

178 {}

Member Function Documentation

◆ SetProgressiveRenderingEnabled()

virtual void SetProgressiveRenderingEnabled ( bool enabled )

pure virtual

Enable/Disable progressive rendering.

◆ GetProgressiveRenderingEnabled()

virtual bool GetProgressiveRenderingEnabled ( ) const

pure virtual

Get the enable state of progressive rendering.

Returns: true if enabled or false otherwise

◆ SetShowEdgedFaces()

virtual void SetShowEdgedFaces ( bool bShowEdgeFaces )

pure virtual

Enable/Disable show edged faces.

◆ GetShowEdgedFaces()

virtual bool GetShowEdgedFaces ( ) const

pure virtual

Get the state of showing edged faces.

Returns: true if edged faces is on or false otherwise

◆ SetUseTexture()

virtual void SetUseTexture ( bool bUseTexture )

pure virtual

Enable/Disable use texture.

◆ GetUseTexture()

virtual bool GetUseTexture ( ) const

pure virtual

Get the state of 'use texture'.

Returns: true if use texture or false otherwise

◆ SetSelectedEdgedFaces()

virtual void SetSelectedEdgedFaces ( bool bSelEdgedFaces )

pure virtual

Enable/Disable display selected with edged faces.

◆ GetSelectedEdgedFaces()

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

◆ SetShowSelectionBrackets()

virtual void SetShowSelectionBrackets ( bool bShowSelectionBrackets )

pure virtual

Enable/Disable use selection brackets.

◆ GetShowSelectionBrackets()

virtual bool GetShowSelectionBrackets ( ) const

pure virtual

Get the state of show selection brackets.

Returns: true if this option is on or false otherwise

◆ SetShadeSelectedFaces()

virtual void SetShadeSelectedFaces ( bool bShadeSelFaces )

pure virtual

Enable/Disable shade selected faces.

◆ GetShadeSelectedFaces()

virtual bool GetShadeSelectedFaces ( ) const

pure virtual

Get the state of shade selected edged faces.

Returns: true if this option is on or false otherwise

◆ SetViewportDisable()

virtual void SetViewportDisable ( bool bViewportDisable )

pure virtual

Set true to disable viewport or false otherwise.

◆ GetViewportDisable()

virtual bool GetViewportDisable ( ) const

pure virtual

Get the state of viewport disable.

Returns: true if viewport is currently disabled or false otherwise

◆ SetViewportClipping()

virtual void SetViewportClipping ( bool bVptClipping )

pure virtual

Enable/Disable viewport clipping.

◆ GetViewportClipping()

virtual bool GetViewportClipping ( ) const

pure virtual

Get the state of viewport clipping.

Returns: true if this option is on or false otherwise

◆ SetUseEnvironmentBackgroundColor()

virtual void SetUseEnvironmentBackgroundColor ( bool bUseEnvColor )

pure virtual

Enable/Disable use environment background color.

◆ GetUseEnvironmentBackgroundColor()

virtual bool GetUseEnvironmentBackgroundColor ( ) const

pure virtual

Get the state of use environment background color.

Returns: true if this option is on or false otherwise

◆ SetUseViewportBackground()

virtual void SetUseViewportBackground ( bool bValue )

pure virtual

Enable/Disable use viewport background.

◆ GetUseViewportBackground()

virtual bool GetUseViewportBackground ( ) const

pure virtual

Get the state of use viewport background.

Returns: true if this option is on or false otherwise

◆ SetShowHighLight()

virtual void SetShowHighLight ( bool bShowHighLight )

pure virtual

Enable/Disable show highlight.

◆ GetShowHighlight()

virtual bool GetShowHighlight ( ) const

pure virtual

Get the state of show highlight.

Returns: true if this option is on or false otherwise

◆ SetViewportVisualStyle()

virtual void SetViewportVisualStyle ( VisualStyle visualStyle )

pure virtual

Set the current view style.

◆ GetViewportVisualStyle()

virtual VisualStyle GetViewportVisualStyle ( ) const

pure virtual

Get the viewport visual style of current viewport.

Returns: the visual style

◆ SetShadeSelectedObjects()

virtual void SetShadeSelectedObjects ( bool bShadeSelObj )

pure virtual

Enable/Disable shade selected objects.

◆ GetShadeSelectedObjects()

virtual bool GetShadeSelectedObjects ( ) const

pure virtual

Get the state of shade selected objects.

Returns: true if this option is on or false otherwise

◆ SetAutoDisplaySelectedLight()

virtual void SetAutoDisplaySelectedLight ( bool bAutoDisSelLight )

pure virtual

Enable/Disable auto display selected light.

◆ GetAutoDisplaySelectedLight()

virtual bool GetAutoDisplaySelectedLight ( ) const

pure virtual

Get the state of auto display selected light.

Returns: true if this option is on or false otherwise

◆ SetAmbientOcclusionEnabled()

virtual void SetAmbientOcclusionEnabled ( bool bAmbientOcclusionEnabled )

pure virtual

Enable/Disable ambient occlusion.

◆ GetAmbientOcclusionEnabled()

virtual bool GetAmbientOcclusionEnabled ( ) const

pure virtual

Get the enabled state of ambient occlusion.

Returns: true if ambient occlusion is enabled or false otherwise

◆ SetShadowsEnabled()

virtual void SetShadowsEnabled ( bool bShadowsEnabled )

pure virtual

Enable/Disable shadow.

◆ GetShadowsEnabled()

virtual bool GetShadowsEnabled ( ) const

pure virtual

Get the state of display shadow.

Returns: true if shadow is on or false otherwise

◆ SetAdaptiveDegradeAlwaysDegradeLights()

virtual void SetAdaptiveDegradeAlwaysDegradeLights ( bool bDegradeLights )

pure virtual

Enable/Disable degrade to default lights.

◆ GetAdaptiveDegradeAlwaysDegradeLights()

virtual bool GetAdaptiveDegradeAlwaysDegradeLights ( ) const

pure virtual

Get the state of degrade to default lights.

Returns: true if this option is on or false otherwise

◆ SetAdaptiveDegradeDrawBackfaces()

virtual void SetAdaptiveDegradeDrawBackfaces ( bool bDrawBackfaces )

pure virtual

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

◆ GetAdaptiveDegradeDrawBackfaces()

virtual bool GetAdaptiveDegradeDrawBackfaces ( ) const

pure virtual

Get the state of draw backfaces.

Returns: true if this option is on or false otherwise

◆ SetAdaptiveDegradeNeverDegradeGeometry()

virtual void SetAdaptiveDegradeNeverDegradeGeometry ( bool bNeverDegradeGeometry )

pure virtual

Set true to never degrade geometry or false otherwise.

◆ GetAdaptiveDegradeNeverDegradeGeometry()

virtual bool GetAdaptiveDegradeNeverDegradeGeometry ( ) const

pure virtual

Get the state of never degrade geometry.

Returns: true if this option is on or false otherwise

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~IViewportViewSetting()

Member Function Documentation

◆ SetProgressiveRenderingEnabled()

◆ GetProgressiveRenderingEnabled()

◆ SetShowEdgedFaces()

◆ GetShowEdgedFaces()

◆ SetUseTexture()

◆ GetUseTexture()

◆ SetSelectedEdgedFaces()

◆ GetSelectedEdgedFaces()

◆ SetShowSelectionBrackets()

◆ GetShowSelectionBrackets()

◆ SetShadeSelectedFaces()

◆ GetShadeSelectedFaces()

◆ SetViewportDisable()

◆ GetViewportDisable()

◆ SetViewportClipping()

◆ GetViewportClipping()

◆ SetUseEnvironmentBackgroundColor()

◆ GetUseEnvironmentBackgroundColor()

◆ SetUseViewportBackground()

◆ GetUseViewportBackground()

◆ SetShowHighLight()

◆ GetShowHighlight()

◆ SetViewportVisualStyle()

◆ GetViewportVisualStyle()

◆ SetShadeSelectedObjects()

◆ GetShadeSelectedObjects()

◆ SetAutoDisplaySelectedLight()

◆ GetAutoDisplaySelectedLight()

◆ SetAmbientOcclusionEnabled()

◆ GetAmbientOcclusionEnabled()

◆ SetShadowsEnabled()

◆ GetShadowsEnabled()

◆ SetAdaptiveDegradeAlwaysDegradeLights()

◆ GetAdaptiveDegradeAlwaysDegradeLights()

◆ SetAdaptiveDegradeDrawBackfaces()

◆ GetAdaptiveDegradeDrawBackfaces()

◆ SetAdaptiveDegradeNeverDegradeGeometry()

◆ GetAdaptiveDegradeNeverDegradeGeometry()