makVrv::DtRenderSettingsInterface 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::DtRenderSettingsInterface:

Public Member Functions
virtual	~DtRenderSettingsInterface ()
	DTOR.
virtual void	setRegenerateCubeMapThreshold (double threshold)=0
	Set the threshold distance for cube map regeneration.
virtual void	setRegenerateHeightMapPercThreshold (double threshold)=0
	Set the threshold distance for height map regeneration as a percentage of the height map dimensions.
virtual void	setOmitCloudInCubeMap (bool state)=0
	Set the state to enable/disble cloud rendering in cube maps.
virtual void	setOceanHeightMapTextureSize (int val)=0
	Set the size of the texture used for creating an ocean height map.
Initializer/Setters for the widgets.
virtual void	setWireframeEnabled (bool enabled)=0
	Set the wire-frame enabled state.
virtual void	setPerformanceOverlayShown (bool shown)=0
	Set the performance overlay widget.
virtual void	setProfilerOverlayShown (bool shown)=0
	Set the function profiler overlay widget.
virtual void	setChannelProjectionResizePolicy (DtChannelConfiguration::ProjectionResizePolicy policy)=0
	Set the channelProjectionResizePolicy.
virtual void	setSymbolTransparency (int scale)=0
	Set value for transparency of occluded icons.
virtual void	setTerrainScalingEnabled (bool enabled)=0
	Set the current state of terrain scaling.
virtual void	setTerrainScaleFactor (double scaleFactor)=0
	Set the terrain scale factor.
virtual void	setTerrainScalingAllowed (bool allowed)=0
	Indicate whether terrain scaling is currently allowed.
virtual void	setClearTrackHistoriesOnTerrainScaleChanged (bool clear)=0
	Set the clear track histories option checkbox.
virtual void	setUseAutofocus (bool useAutofocus)=0
	Set whether to use autofocus for depth of field.
virtual void	setFocalDepth (double focalDepth)=0
	Set the focal depth for depth of field.
virtual void	setFocalRange (double focalRange)=0
	Set the focal range for depth of field.
virtual void	setAmbientFactor (double ambientFactor)=0
	Set the ambient factor.
virtual void	setUseMaterialAmbient (bool useMaterialAmbient)=0
	Set the use material ambient.
virtual void	setDiffuseScaleFactor (double diffuseScaleFactor)=0
	Set the diffuse scale factor.
virtual void	setUseMaterialDiffuse (bool useMaterialDiffuse)=0
	Set the use material ambient.
virtual void	setPerPixelLightingEnabled (bool state)=0
	Set the per-pixel lighting state.
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	setOceanPlanarReflectionsSpecifyFarClip (bool enabled)=0
	Set whether the planar reflections uses the current far clipping plane or sets it own.
virtual void	setOceanPlanarReflectionsFarClip (double farClip)=0
	Specify the far clipping when OceanPlanarReflectionsSpecifyFarClip is true.
virtual void	setLensFlareEnabled (bool state)=0
	Set the lens flare state.
virtual void	setCrepuscularRaysEnabled (bool state)=0
	Set the crepuscular rays (sun rays) state.
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	setComponentVisualizationMode (int state)=0
	Set the wire-frame enabled state.
virtual void	setPagedLodMagnificationScaleFactor (float factor)=0
	Set the wire-frame enabled state.

Public Attributes
Signals emitted when settings are changed by user.
boost::signal< void(void)>	signal_reloadShader
boost::signal< void(bool)>	signal_wireframeSet
boost::signal< void(bool)>	signal_showPerformanceOverlaySet
boost::signal< void(bool)>	signal_showProfilerOverlaySet
boost::signal< void(DtChannelConfiguration::ProjectionResizePolicy)>	signal_channelProjectionResizePolicySet
boost::signal< void(int)>	signal_symbolTransparencyChanged
boost::signal< void(const std::string &)>	signal_activeStatsChanged
boost::signal< void(bool)>	signal_terrainScalingEnabledChanged
boost::signal< void(double)>	signal_terrainScaleFactorChanged
boost::signal< void(bool)>	signal_clearTrackHistoriesOnTerrainScaleChanged
boost::signal< void(bool)>	signal_useAutofocusChanged
boost::signal< void(double)>	signal_focalDepthChanged
boost::signal< void(double)>	signal_focalRangeChanged
boost::signal< void(double)>	signal_ambientFactorChanged
boost::signal< void(bool)>	signal_useMaterialAmbientChanged
boost::signal< void(double)>	signal_diffuseScaleFactorChanged
boost::signal< void(bool)>	signal_useMaterialDiffuseChanged
boost::signal< void(bool)>	signal_perPixelLightingEnabledChanged
boost::signal< void(bool)>	signal_oceanPlanarReflectionsEnabledChanged
boost::signal< void(float)>	signal_oceanPlanarReflectionsLODScaleChanged
boost::signal< void(bool)>	signal_oceanPlanarReflectionsSpecifyFarClipChanged
boost::signal< void(double)>	signal_oceanPlanarReflectionsFarClipChanged
boost::signal< void(bool)>	signal_lensFlareEnabledChanged
boost::signal< void(bool)>	signal_crepuscularRaysEnabledChanged
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(int)>	signal_componentVisualizationComboChanged
boost::signal< void(float)>	signal_pagedLodMagnificationScaleFactorChanged
boost::signal< void(double)>	signal_regenerateCubeMapThresholdChanged
boost::signal< void(double)>	signal_regenerateHeightMapPercThresholdChanged
boost::signal< void(bool)>	signal_omitCloudInCubeMapChanged
boost::signal< void(int)>	signal_oceanHeightMapTextureSizeChanged

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::DtRenderSettingsInterface::~DtRenderSettingsInterface ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtRenderSettingsInterface::setWireframeEnabled ( bool  enabled )

pure virtual

Set the wire-frame enabled state.

Parameters

[in]

enabled

is the enabled/disabled state for wire-frame.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setPerformanceOverlayShown ( bool  shown )

pure virtual

Set the performance overlay widget.

Parameters

[in]

shown

is the show/hide state for displaying the overlay.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setProfilerOverlayShown ( bool  shown )

pure virtual

Set the function profiler overlay widget.

Parameters

[in]

shown

is the show/hide state for displaying the overlay.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setChannelProjectionResizePolicy ( DtChannelConfiguration::ProjectionResizePolicy  policy )

pure virtual

Set the channelProjectionResizePolicy.

Parameters

[in]

policy

describes how to resize channel projections.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setSymbolTransparency ( int  scale )

pure virtual

Set value for transparency of occluded icons.

Parameters

[in]

scale

is the transparency value (0 - 32).

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setTerrainScalingEnabled ( bool  enabled )

pure virtual

Set the current state of terrain scaling.

Parameters

[in]

enabled

is the enabled/disabled state for terrain scaling.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setTerrainScaleFactor ( double  scaleFactor )

pure virtual

Set the terrain scale factor.

Parameters

[in]

scaleFactor

is the multiplier for scaling terrain.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setTerrainScalingAllowed ( bool  allowed )

pure virtual

Indicate whether terrain scaling is currently allowed.

If not, the terrain scaling enabled and terrain scale factor widgets will be grayed out.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setClearTrackHistoriesOnTerrainScaleChanged ( bool  clear )

pure virtual

Set the clear track histories option checkbox.

Parameters

[in]

clear

is the enabled/disabled state for clearing histories.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setUseAutofocus ( bool  useAutofocus )

pure virtual

Set whether to use autofocus for depth of field.

Parameters

[in]

useAutofocus

is the bool for whether to have the camera focus on the object in the center of the screen for depth of field.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setFocalDepth ( double  focalDepth )

pure virtual

Set the focal depth for depth of field.

Parameters

[in]

focalDepth

is the focal distance for depth of field

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setFocalRange ( double  focalRange )

pure virtual

Set the focal range for depth of field.

Parameters

[in]

focalRange

is the distance before and after the focalDepth which is in focus

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setAmbientFactor ( double  ambientFactor )

pure virtual

Set the ambient factor.

Parameters

[in]

ambientFactor

is the multiplier for the ambient material value of all per pixel lighting material.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setUseMaterialAmbient ( bool  useMaterialAmbient )

pure virtual

Set the use material ambient.

Parameters

[in]

useMaterialAmbient

boolean value to enable/disable the usage of the material ambient

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setDiffuseScaleFactor ( double  diffuseScaleFactor )

pure virtual

Set the diffuse scale factor.

Parameters

[in]

diffuseScaleFactor

is the multiplier for the ambient material value of all per pixel lighting material.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setUseMaterialDiffuse ( bool  useMaterialDiffuse )

pure virtual

Set the use material ambient.

Parameters

[in]

useMaterialDiffuse

boolean value to enable/disable the usage of the material ambient

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setPerPixelLightingEnabled ( bool  state )

pure virtual

Set the per-pixel lighting state.

Parameters

[in]

state

is the enabled/disabled state for terrain scaling.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setOceanPlanarReflectionsEnabled ( bool  state )

pure virtual

Set the planar reflections state.

Parameters

[in]

state

is the enabled/disabled state for planar reflections.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setOceanPlanarReflectionsLODScale ( float  scale )

pure virtual

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

Parameters

[in]

scale

is the LOD scale applied when culling in the reflections camera

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setOceanPlanarReflectionsSpecifyFarClip ( bool  enabled )

pure virtual

Set whether the planar reflections uses the current far clipping plane or sets it own.

Parameters

[in]

enabled

specifies the clipping plane usage

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setOceanPlanarReflectionsFarClip ( double  farClip )

pure virtual

Specify the far clipping when OceanPlanarReflectionsSpecifyFarClip is true.

Parameters

[in]

farClip

is the far clipping plane used for reflections

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setLensFlareEnabled ( bool  state )

pure virtual

Set the lens flare state.

Parameters

[in]

state

is the enabled/disabled state for lens flares.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setCrepuscularRaysEnabled ( bool  state )

pure virtual

Set the crepuscular rays (sun rays) state.

Parameters

[in]

state

is the enabled/disabled state for crepuscular rays.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setWaveSprayEffectEnabled ( bool  state )

pure virtual

Set the sea spray particle effect state.

Parameters

[in]

state

is the enabled/disabled state for sea spray effect.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setRotorWashDecalEnabled ( bool  state )

pure virtual

Set the rotor wash detailed texture decal state.

Parameters

[in]

state

is the enabled/disabled state for rotor wash decal.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setTidalStreamWakesEnabled ( bool  state )

pure virtual

Set the tidal stream wakes state.

Parameters

[in]

state

is the enabled/disabled state for tidal stream wakes.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setOceanHeightMapResolution ( double  res )

pure virtual

Set the resolution of the ocean height map.

Parameters

[in]

res

is the map resolution in meters per pixel.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setComponentVisualizationMode ( int  state )

pure virtual

Set the wire-frame enabled state.

Parameters

[in]

enabled

is the enabled/disabled state for wire-frame.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setPagedLodMagnificationScaleFactor ( float  factor )

pure virtual

Set the wire-frame enabled state.

Parameters

[in]

enabled

is the enabled/disabled state for wire-frame.

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setRegenerateCubeMapThreshold ( double  threshold )

pure virtual

Set the threshold distance for cube map regeneration.

Parameters

[in]

threshold

is the threshold distance for cube map regeneration

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setRegenerateHeightMapPercThreshold ( double  threshold )

pure virtual

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

Parameters

[in]

threshold

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

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setOmitCloudInCubeMap ( bool  state )

pure virtual

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

Parameters

[in]

state

is the enabled/disabled state for clouds rendering in cube maps

Implemented in makVrv::DtRenderSettingsWidget.

virtual void makVrv::DtRenderSettingsInterface::setOceanHeightMapTextureSize ( int  val )

pure virtual

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

Parameters

[in]

Value

will be clamped between 256 and 16384. Note that specific graphics cards may reduce the value

Implemented in makVrv::DtRenderSettingsWidget.

Member Data Documentation

boost::signal<void (void)> makVrv::DtRenderSettingsInterface::signal_reloadShader

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_wireframeSet

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_showPerformanceOverlaySet

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_showProfilerOverlaySet

boost::signal<void (DtChannelConfiguration::ProjectionResizePolicy)> makVrv::DtRenderSettingsInterface::signal_channelProjectionResizePolicySet

boost::signal<void (int)> makVrv::DtRenderSettingsInterface::signal_symbolTransparencyChanged

boost::signal<void (const std::string&)> makVrv::DtRenderSettingsInterface::signal_activeStatsChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_terrainScalingEnabledChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_terrainScaleFactorChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_clearTrackHistoriesOnTerrainScaleChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_useAutofocusChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_focalDepthChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_focalRangeChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_ambientFactorChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_useMaterialAmbientChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_diffuseScaleFactorChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_useMaterialDiffuseChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_perPixelLightingEnabledChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_oceanPlanarReflectionsEnabledChanged

boost::signal<void (float)> makVrv::DtRenderSettingsInterface::signal_oceanPlanarReflectionsLODScaleChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_oceanPlanarReflectionsSpecifyFarClipChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_oceanPlanarReflectionsFarClipChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_lensFlareEnabledChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_crepuscularRaysEnabledChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_waveSprayEffectChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_rotorWashDecalChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_tidalStreamWakesChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_oceanHeightMapResolutionChanged

boost::signal<void (int)> makVrv::DtRenderSettingsInterface::signal_componentVisualizationComboChanged

boost::signal<void (float)> makVrv::DtRenderSettingsInterface::signal_pagedLodMagnificationScaleFactorChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_regenerateCubeMapThresholdChanged

boost::signal<void (double)> makVrv::DtRenderSettingsInterface::signal_regenerateHeightMapPercThresholdChanged

boost::signal<void (bool)> makVrv::DtRenderSettingsInterface::signal_omitCloudInCubeMapChanged

boost::signal<void (int)> makVrv::DtRenderSettingsInterface::signal_oceanHeightMapTextureSizeChanged

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCoreQt/DtRenderSettingsInterface.h