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

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.
virtual void setPlanarReflectionTextureWidth (int val)=0
 Set the height of the texture used for creating planar reflections.
virtual void setPlanarReflectionTextureHeight (int val)=0
 Set the height of the texture used for creating planar reflections.
virtual void setOceanQuality (unsigned int quality)=0
 Set the ocean quality.
Initializer/Setters for the widgets.
virtual void setOceanPlanarReflectionsEnabled (bool state)=0
 Set the planar reflections state.
virtual void setOceanPlanarReflectionsLODScale (float scale)=0
 Set the scale factor for objects processed by the reflections camera.
virtual void setWaveSprayEffectEnabled (bool state)=0
 Set the sea spray particle effect state.
virtual void setRotorWashDecalEnabled (bool state)=0
 Set the rotor wash detailed texture decal state.
virtual void setTidalStreamWakesEnabled (bool state)=0
 Set the tidal stream wakes state.
virtual void setOceanHeightMapResolution (double res)=0
 Set the resolution of the ocean height map.
virtual void setRegenerateHeightMapPercThreshold (double threshold)=0
 Set the threshold distance for height map regeneration as a percentage of the height map dimensions.
virtual void setOceanHeightMapTextureSize (int val)=0
 Set the size of the texture used for creating an ocean height map.
virtual void setRegenerateCubeMapThreshold (double threshold)=0
 Set the threshold distance for cube map regeneration.
virtual void setOmitCloudInCubeMap (bool state)=0
 Set the state to enable/disble cloud rendering in cube maps.

Public Attributes

Signals emitted when settings are changed by user.
boost::signal< void(bool)> signal_oceanPlanarReflectionsEnabledChanged
boost::signal< void(float)> signal_oceanPlanarReflectionsLODScaleChanged
boost::signal< void(double)> signal_oceanPlanarReflectionsFarClipChanged
boost::signal< void(bool)> signal_waveSprayEffectChanged
boost::signal< void(bool)> signal_rotorWashDecalChanged
boost::signal< void(bool)> signal_tidalStreamWakesChanged
boost::signal< void(double)> signal_oceanHeightMapResolutionChanged
boost::signal< void(double)> signal_regenerateHeightMapPercThresholdChanged
boost::signal< void(int)> signal_oceanHeightMapTextureSizeChanged
boost::signal< void(double)> signal_regenerateCubeMapThresholdChanged
boost::signal< void(bool)> signal_omitCloudInCubeMapChanged
boost::signal< void(int)> signal_planarReflectionTextureWidthChanged
boost::signal< void(int)> signal_planarReflectionTextureHeightChanged
boost::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::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::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::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::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::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::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::setOceanQuality ( unsigned int  quality)
pure virtual

Set the ocean quality.

Parameters
[in]qualityis the ocean display quality

Implemented in makVrv::DtOceanRenderSettingsWidget.

Member Data Documentation

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

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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)