VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtOceanRenderSettingsInterface Class Referenceabstract

This is the interface which the render settings widget will inherit from and the logic will use to talk to the widget. More...

Inheritance diagram for makVrv::DtOceanRenderSettingsInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtOceanRenderSettingsInterface ()
 DTOR. More...
 
virtual void setPlanarReflectionTextureWidth (int val)=0
 Set the height of the texture used for creating planar reflections. More...
 
virtual void setPlanarReflectionTextureWidthRange (int max, int min, int step)=0
 Set the range for ocean planar reflections texture width slider. More...
 
virtual void setPlanarReflectionTextureHeight (int val)=0
 Set the height of the texture used for creating planar reflections. More...
 
virtual void setPlanarReflectionTextureHeightRange (int max, int min, int step)=0
 Set the range for ocean planar reflections texture height slider. More...
 
virtual void setOceanQuality (unsigned int quality)=0
 Set the ocean quality. More...
 
virtual void setPlanarReflectionsShowSpeedTrees (bool val)=0
 Set the flag that controls if speedtrees should be drawn in the planar reflection. More...
 
Initializer/Setters for the widgets.
virtual void setOceanPlanarReflectionsEnabled (bool state)=0
 Set the planar reflections state. More...
 
virtual void setOceanPlanarReflectionsLODScale (float scale)=0
 Set the scale factor for objects processed by the reflections camera. More...
 
virtual void setOceanPlanarReflectionsLODScaleRange (float max, float min, float step)=0
 Set the range for ocean planar reflections lod scale slider. More...
 
virtual void setWaveSprayEffectEnabled (bool state)=0
 Set the sea spray particle effect state. More...
 
virtual void setRotorWashDecalEnabled (bool state)=0
 Set the rotor wash detailed texture decal state. More...
 
virtual void setTidalStreamWakesEnabled (bool state)=0
 Set the tidal stream wakes state. More...
 
virtual void setOceanHeightMapResolution (double res)=0
 Set the resolution of the ocean height map. More...
 
virtual void setOceanHeightMapResolutionRange (float max, float min, float step)=0
 Set the range for ocean height map resolution slider. More...
 
virtual void setRegenerateHeightMapPercThreshold (double threshold)=0
 Set the threshold distance for height map regeneration as a percentage of the height map dimensions. More...
 
virtual void setRegenerateHeightMapPercThresholdRange (float max, float min, float step)=0
 Set the range for ocean height map precent threshold slider. More...
 
virtual void setOceanHeightMapTextureSize (int val)=0
 Set the size of the texture used for creating an ocean height map. More...
 
virtual void setOceanHeightMapTextureSizeRange (int max, int min, int step)=0
 Set the range for ocean height map texture size slider. More...
 
virtual void setRegenerateCubeMapThreshold (double threshold)=0
 Set the threshold distance for cube map regeneration. More...
 
virtual void setRegenerateCubeMapThresholdRange (float max, float min, float step)=0
 Set the range for regenerate cube map threshold slider. More...
 
virtual void setOmitCloudInCubeMap (bool state)=0
 Set the state to enable/disble cloud rendering in cube maps. More...
 

Public Attributes

Signals emitted when settings are changed by user.
boost::signalslib::signal
< void(bool)> 
signal_oceanPlanarReflectionsEnabledChanged
 
boost::signalslib::signal
< void(float)> 
signal_oceanPlanarReflectionsLODScaleChanged
 
boost::signalslib::signal
< void(double)> 
signal_oceanPlanarReflectionsFarClipChanged
 
boost::signalslib::signal
< void(bool)> 
signal_waveSprayEffectChanged
 
boost::signalslib::signal
< void(bool)> 
signal_rotorWashDecalChanged
 
boost::signalslib::signal
< void(bool)> 
signal_tidalStreamWakesChanged
 
boost::signalslib::signal
< void(double)> 
signal_oceanHeightMapResolutionChanged
 
boost::signalslib::signal
< void(double)> 
signal_regenerateHeightMapPercThresholdChanged
 
boost::signalslib::signal
< void(int)> 
signal_oceanHeightMapTextureSizeChanged
 
boost::signalslib::signal
< void(double)> 
signal_regenerateCubeMapThresholdChanged
 
boost::signalslib::signal
< void(bool)> 
signal_omitCloudInCubeMapChanged
 
boost::signalslib::signal
< void(int)> 
signal_planarReflectionTextureWidthChanged
 
boost::signalslib::signal
< void(int)> 
signal_planarReflectionTextureHeightChanged
 
boost::signalslib::signal
< void(bool)> 
signal_planarReflectionsShowSpeedTreesChanged
 
boost::signalslib::signal
< void(unsigned int)> 
signal_changeOceanQuality
 

Detailed Description

This is the interface which the render settings widget will inherit from and the logic will use to talk to the widget.

Constructor & Destructor Documentation

virtual makVrv::DtOceanRenderSettingsInterface::~DtOceanRenderSettingsInterface ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtOceanRenderSettingsInterface::setOceanPlanarReflectionsEnabled ( bool  state)
pure virtual

Set the planar reflections state.

Parameters
[in]stateis the enabled/disabled state for planar reflections.

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setOceanPlanarReflectionsLODScale ( float  scale)
pure virtual

Set the scale factor for objects processed by the reflections camera.

Parameters
[in]scaleis the LOD scale applied when culling in the reflections camera

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setOceanPlanarReflectionsLODScaleRange ( float  max,
float  min,
float  step 
)
pure virtual

Set the range for ocean planar reflections lod scale slider.

Parameters
[in]maxis the maximum value for the slider
[in]minis the minimum value for the slider
[in]stepis the step the slider will use

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setWaveSprayEffectEnabled ( bool  state)
pure virtual

Set the sea spray particle effect state.

Parameters
[in]stateis the enabled/disabled state for sea spray effect.

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setRotorWashDecalEnabled ( bool  state)
pure virtual

Set the rotor wash detailed texture decal state.

Parameters
[in]stateis the enabled/disabled state for rotor wash decal.

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setTidalStreamWakesEnabled ( bool  state)
pure virtual

Set the tidal stream wakes state.

Parameters
[in]stateis the enabled/disabled state for tidal stream wakes.

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setOceanHeightMapResolution ( double  res)
pure virtual

Set the resolution of the ocean height map.

Parameters
[in]resis the map resolution in meters per pixel.

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setOceanHeightMapResolutionRange ( float  max,
float  min,
float  step 
)
pure virtual

Set the range for ocean height map resolution slider.

Parameters
[in]maxis the maximum value for the slider
[in]minis the minimum value for the slider
[in]stepis the step the slider will use

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setRegenerateHeightMapPercThreshold ( double  threshold)
pure virtual

Set the threshold distance for height map regeneration as a percentage of the height map dimensions.

Parameters
[in]thresholdis the threshold distance for height map regeneration as a percentage of the height map dimensions

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setRegenerateHeightMapPercThresholdRange ( float  max,
float  min,
float  step 
)
pure virtual

Set the range for ocean height map precent threshold slider.

Parameters
[in]maxis the maximum value for the slider
[in]minis the minimum value for the slider
[in]stepis the step the slider will use

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setOceanHeightMapTextureSize ( int  val)
pure virtual

Set the size of the texture used for creating an ocean height map.

Parameters
[in]Valuewill be clamped between 256 and 16384. Note that specific graphics cards may reduce the value

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setOceanHeightMapTextureSizeRange ( int  max,
int  min,
int  step 
)
pure virtual

Set the range for ocean height map texture size slider.

Parameters
[in]maxis the maximum value for the slider
[in]minis the minimum value for the slider
[in]stepis the step the slider will use

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setRegenerateCubeMapThreshold ( double  threshold)
pure virtual

Set the threshold distance for cube map regeneration.

Parameters
[in]thresholdis the threshold distance for cube map regeneration

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setRegenerateCubeMapThresholdRange ( float  max,
float  min,
float  step 
)
pure virtual

Set the range for regenerate cube map threshold slider.

Parameters
[in]maxis the maximum value for the slider
[in]minis the minimum value for the slider
[in]stepis the step the slider will use

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setOmitCloudInCubeMap ( bool  state)
pure virtual

Set the state to enable/disble cloud rendering in cube maps.

Parameters
[in]stateis the enabled/disabled state for clouds rendering in cube maps

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setPlanarReflectionTextureWidth ( int  val)
pure virtual

Set the height of the texture used for creating planar reflections.

Parameters
[in]Valuewill be clamped between 256 and 4096. Note that specific graphics cards may reduce the value

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setPlanarReflectionTextureWidthRange ( int  max,
int  min,
int  step 
)
pure virtual

Set the range for ocean planar reflections texture width slider.

Parameters
[in]maxis the maximum value for the slider
[in]minis the minimum value for the slider
[in]stepis the step the slider will use

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setPlanarReflectionTextureHeight ( int  val)
pure virtual

Set the height of the texture used for creating planar reflections.

Parameters
[in]Valuewill be clamped between 256 and 4096. Note that specific graphics cards may reduce the value

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setPlanarReflectionTextureHeightRange ( int  max,
int  min,
int  step 
)
pure virtual

Set the range for ocean planar reflections texture height slider.

Parameters
[in]maxis the maximum value for the slider
[in]minis the minimum value for the slider
[in]stepis the step the slider will use

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setOceanQuality ( unsigned int  quality)
pure virtual

Set the ocean quality.

Parameters
[in]qualityis the ocean display quality

Implemented in makVrv::DtOceanRenderSettingsWidget.

virtual void makVrv::DtOceanRenderSettingsInterface::setPlanarReflectionsShowSpeedTrees ( bool  val)
pure virtual

Set the flag that controls if speedtrees should be drawn in the planar reflection.

Parameters
[in]Valueto set the flag to

Implemented in makVrv::DtOceanRenderSettingsWidget.

Member Data Documentation

boost::signalslib::signal<void (bool)> makVrv::DtOceanRenderSettingsInterface::signal_oceanPlanarReflectionsEnabledChanged
boost::signalslib::signal<void (float)> makVrv::DtOceanRenderSettingsInterface::signal_oceanPlanarReflectionsLODScaleChanged
boost::signalslib::signal<void (double)> makVrv::DtOceanRenderSettingsInterface::signal_oceanPlanarReflectionsFarClipChanged
boost::signalslib::signal<void (bool)> makVrv::DtOceanRenderSettingsInterface::signal_waveSprayEffectChanged
boost::signalslib::signal<void (bool)> makVrv::DtOceanRenderSettingsInterface::signal_rotorWashDecalChanged
boost::signalslib::signal<void (bool)> makVrv::DtOceanRenderSettingsInterface::signal_tidalStreamWakesChanged
boost::signalslib::signal<void (double)> makVrv::DtOceanRenderSettingsInterface::signal_oceanHeightMapResolutionChanged
boost::signalslib::signal<void (double)> makVrv::DtOceanRenderSettingsInterface::signal_regenerateHeightMapPercThresholdChanged
boost::signalslib::signal<void (int)> makVrv::DtOceanRenderSettingsInterface::signal_oceanHeightMapTextureSizeChanged
boost::signalslib::signal<void (double)> makVrv::DtOceanRenderSettingsInterface::signal_regenerateCubeMapThresholdChanged
boost::signalslib::signal<void (bool)> makVrv::DtOceanRenderSettingsInterface::signal_omitCloudInCubeMapChanged
boost::signalslib::signal<void (int)> makVrv::DtOceanRenderSettingsInterface::signal_planarReflectionTextureWidthChanged
boost::signalslib::signal<void (int)> makVrv::DtOceanRenderSettingsInterface::signal_planarReflectionTextureHeightChanged
boost::signalslib::signal<void (bool)> makVrv::DtOceanRenderSettingsInterface::signal_planarReflectionsShowSpeedTreesChanged
boost::signalslib::signal<void (unsigned int)> makVrv::DtOceanRenderSettingsInterface::signal_changeOceanQuality

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)