Visualizer for kelvin wakes. More...

Inheritance diagram for makVrv::DtEntityWakeVisualizer:

Public Member Functions
	DtEntityWakeVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR. More...

virtual	~DtEntityWakeVisualizer ()
	DTOR. More...

virtual void	setWakeEnabled (bool enabled)
	Enable or disable wake This call stores the enabled state for processing whether all wake effects should be enabled on this entity. More...

virtual void	setSprayEnabled (bool enabled)
	Enable or disable spray at the bow and hull of the ship. More...

virtual void	setSternWaveEnabled (bool enabled)
	Enable or disable a stern wave. More...

virtual void	setWakeOffset (double offset)
	Set the distance from the center of the ship to the origin point of the circles use to generate the wake. More...

virtual void	setBowSprayOffset (double offset)
	Set the distance from the wake origin to where the spray appears, if enabled. More...

virtual void	setBowWaveOffset (double offset)
	Set the offset to the bow wake. More...

virtual void	setSternWaveOffset (double offset)
	Set the offset to the stern wakes. More...

virtual void	setShipLength (double length)
	Set the length of the ship. More...

virtual void	setBeamWidth (double width)
	Set the beamwidth (widest point) of the ship. More...

virtual void	setPropWashEnabled (bool b)
	Set whether prop wash effects are enabled. More...

virtual void	setPropWashOffset (double offset)
	Set the distance from the wake origin to where the prop wash appears, if enabled. More...

virtual void	setPropWashFadeTime (double fadeTime)
	Set the amount of time, in seconds, over which the prop wash will dissipate. More...

virtual void	setDraft (double draft)
	Set the draft, or the distance the hull extends underwater. More...

virtual void	setLODDistance (double distance)
	Set the distance at which the prop wash segments and waves are halved. More...

virtual void	setSprayVelocityScale (double scale)
	Set the velocity scaling for bow spray effects. More...

virtual void	setBowWaveScale (double scale)
	Set the scaling for bow wave effects. More...

virtual void	setMaxBowWaveAmplitude (double amplitude)
	Set the max amplitude for bow waves. More...

virtual void	setBowSize (double size)
	Set the size of the bow (0 for a pointy one.) More...

virtual void	setSpraySizeScale (double scale)
	Set the particle size scaling for bow spray effects. More...

virtual void	setNumHullSprays (int numSprays)
	Set the number of spray particle systems emitted along the hull of the ship. More...

virtual void	setHullSpraySizeScale (double scale)
	Set the initial size of hull spray particles. More...

virtual void	setHullSprayStart (double offset)
	Set the start offset of hull spray effects. More...

virtual void	setHullSprayEnd (double offset)
	Set the end offset of hull spray effects. More...

virtual void	setHullSprayVelocityScale (double scale)
	Set the initial velocity of hull spray particles as a percent of the ship velocity. More...

virtual void	setHullSprayVerticalOffset (double offset)
	Set the initial vertical position of hull spray particles. More...

virtual void	setDamageState (int state)

virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info. More...

virtual void	setParent (DtStateVisualizer *parent)
	Override of DtStateVisualizer base method. More...

virtual void	setIsFrozen (bool frozen)
	Set if the entity this wake is part of is in the frozen state. More...

Public Member Functions inherited from makVrv::DtEntityStateVisualizer
	DtEntityStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR. More...

virtual	~DtEntityStateVisualizer ()
	DTOR. More...

virtual void	setState (int stateNumber, int stateValue)
	Override to set the attribute state of agents. More...

DtEntityStateListener &	entityStateListener ()

Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR. More...

virtual	~DtStateVisualizer ()
	DTOR. More...

void	setModelDefinition (const std::string &definition)
	Sets the model definition and creates agent(s) based on that definition. More...

const std::string &	modelDefinition () const
	Gets the current model definition. More...

virtual void	implementVisibility (bool visible)
	Wrap some of the show/hide functionality so that it can be overloaded (ex. More...

virtual bool	setVisible (bool visible, int context)
	Returns true if this context wants to show or hide the item. More...

virtual void	initialize ()
	Initialize the visualizer. More...

virtual bool	isVisible () const
	Returns true if visible. More...

virtual void	setSelected (bool)
	Sets selected state. More...

virtual bool	selected () const

void	setName (const std::string &)
	Internal name of state visualizer. More...

const std::string &	name () const

virtual void	setPickable (bool)
	Sets pickable state. More...

virtual bool	pickable () const

virtual void	setUniqueID (DtUniqueID id)

DtUniqueID	uniqueID () const

int	visualizerType () const

void	setShowHideContext (const std::vector< int > &s)
	Set show/hide context without changing visibility of item. More...

DtStateListener &	listener ()

DtBaseConnection &	simulation ()
	Get the connection for this visualizer. More...

void	setDistribute (bool b)
	Whether or not to distribute over the network. More...

bool	distribute () const

Static Public Member Functions
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()
	This class's type info. More...

Protected Member Functions
virtual void	slot_oceanWakesEnabledChanged (bool enabled)
	Receives notification of global settings changes for ocean wakes. More...

virtual void	slot_hullSprayEffectsChanged (bool enabled)
	Receives notification of global settings changes for hull-spray. More...

virtual bool	active () const

virtual void	createModelAgents ()
	Create the wake and wake updater agents. More...

virtual void	destroyModelAgents ()
	Destroy the wake and wake updater agents. More...

virtual void	setModelDefinitionForAgents ()
	No-op. Required for all DtState visualizers, but not used here. More...

virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Set the visualizer definition, which contains any user=specified attributes. More...

virtual void	setEmbarkedOn (const std::string &)
	Called by signal when the entity's embarked state changes. More...

virtual bool	visible () const
	Used locally, checks all the conditions to determine if a wake should be generated for this entity. More...

virtual void	updateWakeEffects ()
	Used locally, enables/disables the wake, spray and prop-wash by creating or destroying all model-agents. More...

virtual bool	areWakeEffectsEnabled () const
	Used locally, returns if wake effects are enabled, both locally and globally. More...

virtual void	updateSprayEffects ()
	Used locally, enables/disables the spray (bow-spray, hull-spray, etc). More...

virtual bool	areSprayEffectsEnabled () const
	Used locally, returns if the spray effects is enabled globally. More...

virtual void	slot_wakeDefaultLODDistanceChanged (double distance)
	Receives notification of global settings changes for wake lod default distance. More...

Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void	slot_mouseDown (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
	Called when the mouse is clicked in this visualizer. More...

virtual void	slot_mouseUp (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)

virtual void	slot_mouseDblClick (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)

virtual bool	hide (int context)
	Will call destroyModelAgents(), if, when the context is added, it is the first context in the list. More...

virtual bool	show (int context)
	Will call createModelAgents(), if, when context is removed from myShowHideContexts, the list size is zero. More...

virtual bool	supportsShowHideContext (int) const
	Default returns true. More...

template<typename T , typename C >
void	connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
	Connect a signal and update the entity. More...

Protected Attributes
DtWakeModelAgent *	myWakeModel

DtWakeUpdaterAgent *	myWakeUpdater

bool	myDestroyed

bool	myEmbarked

bool	myEffectEnabled

bool	mySprayEnabled

bool	mySternWaveEnabled

double	myWakeOffset

bool	myWakeOffsetSet

double	myBowSprayOffset

bool	myBowSprayOffsetSet

double	myBowWaveOffset

bool	myBowWaveOffsetSet

double	mySternWaveOffset

bool	mySternWaveOffsetSet

double	myShipLength

double	myBeamWidth

bool	myPropWashEnabled

double	myPropWashOffset

bool	myPropWashOffsetSet

double	myPropWashFadeTime

bool	myPropWashFadeTimeSet

double	myDraft

double	myLODDistance

double	mySprayVelocityScale

double	myBowWaveScale

double	myMaxBowWaveAmplitude

bool	myMaxBowWaveAmplitudeSet

double	myBowSize

double	mySpraySizeScale

int	myNumHullSprays

double	myHullSprayStart

bool	myHullSprayStartSet

double	myHullSprayEnd

bool	myHullSprayEndSet

double	myHullSprayVerticalOffset

bool	myHullSprayVerticalOffsetSet

double	myHullSprayVelocityScale

double	myHullSpraySizeScale

bool	myOceanWakesEnabledGlobalFlag

bool	mySprayEffectsEnabledGlobalFlag

bool	myIsAmphibious

boost::signalslib::connection	myWakeLODDistanceChangedConnection

Protected Attributes inherited from makVrv::DtEntityStateVisualizer
DtEntityStateListener *	myEntityListener
	Same as myListener, but casted for convenience. More...

Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection &	mySimulation

DtStateListener &	myListener

bool	myDistributeFlag

DtUniqueID	myUniqueID

std::string	myName

std::string	myModelDefinition

DtSignalConnectionManager	myConnections

int	myModelSet

int	myVisualizerType

std::vector< int >	myShowHideContexts

bool	mySelected

bool	myPickable

bool	myVisible

DtStateVisualizer *	myParent

DtSceneObjectAgent *	mySceneObjectAgent

Additional Inherited Members
Public Types inherited from makVrv::DtStateVisualizer
enum	Type { AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType, AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000 }
	Visualizer class types that are supportable via visualizers. More...

Public Attributes inherited from makVrv::DtStateVisualizer
boost::signal< void(DtStateVisualizer , DtStateVisualizer , DtStateVisualizer *)>	signal_reparented
	Signaled when the parent of this item changes, called before destroying any model agents. More...

boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDown
	Emitted when the entity's indicator is clicked. More...

boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseUp

boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDblClick

Detailed Description

Visualizer for kelvin wakes.

Constructor & Destructor Documentation

makVrv::DtEntityWakeVisualizer::DtEntityWakeVisualizer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		int	modelSet
	)

CTOR.

virtual makVrv::DtEntityWakeVisualizer::~DtEntityWakeVisualizer ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEntityWakeVisualizer::setWakeEnabled ( bool enabled )

virtual

Enable or disable wake This call stores the enabled state for processing whether all wake effects should be enabled on this entity.

virtual void makVrv::DtEntityWakeVisualizer::setSprayEnabled ( bool enabled )

virtual

Enable or disable spray at the bow and hull of the ship.

virtual void makVrv::DtEntityWakeVisualizer::setSternWaveEnabled ( bool enabled )

virtual

Enable or disable a stern wave.

virtual void makVrv::DtEntityWakeVisualizer::setWakeOffset ( double offset )

virtual

Set the distance from the center of the ship to the origin point of the circles use to generate the wake.

virtual void makVrv::DtEntityWakeVisualizer::setBowSprayOffset ( double offset )

virtual

Set the distance from the wake origin to where the spray appears, if enabled.

virtual void makVrv::DtEntityWakeVisualizer::setBowWaveOffset ( double offset )

virtual

Set the offset to the bow wake.

virtual void makVrv::DtEntityWakeVisualizer::setSternWaveOffset ( double offset )

virtual

Set the offset to the stern wakes.

virtual void makVrv::DtEntityWakeVisualizer::setShipLength ( double length )

virtual

Set the length of the ship.

virtual void makVrv::DtEntityWakeVisualizer::setBeamWidth ( double width )

virtual

Set the beamwidth (widest point) of the ship.

virtual void makVrv::DtEntityWakeVisualizer::setPropWashEnabled ( bool b )

virtual

Set whether prop wash effects are enabled.

virtual void makVrv::DtEntityWakeVisualizer::setPropWashOffset ( double offset )

virtual

Set the distance from the wake origin to where the prop wash appears, if enabled.

virtual void makVrv::DtEntityWakeVisualizer::setPropWashFadeTime ( double fadeTime )

virtual

Set the amount of time, in seconds, over which the prop wash will dissipate.

virtual void makVrv::DtEntityWakeVisualizer::setDraft ( double draft )

virtual

Set the draft, or the distance the hull extends underwater.

Used to influence the bow wake.

virtual void makVrv::DtEntityWakeVisualizer::setLODDistance ( double distance )

virtual

Set the distance at which the prop wash segments and waves are halved.

virtual void makVrv::DtEntityWakeVisualizer::setSprayVelocityScale ( double scale )

virtual

Set the velocity scaling for bow spray effects.

virtual void makVrv::DtEntityWakeVisualizer::setBowWaveScale ( double scale )

virtual

Set the scaling for bow wave effects.

virtual void makVrv::DtEntityWakeVisualizer::setMaxBowWaveAmplitude ( double amplitude )

virtual

Set the max amplitude for bow waves.

virtual void makVrv::DtEntityWakeVisualizer::setBowSize ( double size )

virtual

Set the size of the bow (0 for a pointy one.)

virtual void makVrv::DtEntityWakeVisualizer::setSpraySizeScale ( double scale )

virtual

Set the particle size scaling for bow spray effects.

virtual void makVrv::DtEntityWakeVisualizer::setNumHullSprays ( int numSprays )

virtual

Set the number of spray particle systems emitted along the hull of the ship.

virtual void makVrv::DtEntityWakeVisualizer::setHullSpraySizeScale ( double scale )

virtual

Set the initial size of hull spray particles.

virtual void makVrv::DtEntityWakeVisualizer::setHullSprayStart ( double offset )

virtual

Set the start offset of hull spray effects.

virtual void makVrv::DtEntityWakeVisualizer::setHullSprayEnd ( double offset )

virtual

Set the end offset of hull spray effects.

virtual void makVrv::DtEntityWakeVisualizer::setHullSprayVelocityScale ( double scale )

virtual

Set the initial velocity of hull spray particles as a percent of the ship velocity.

virtual void makVrv::DtEntityWakeVisualizer::setHullSprayVerticalOffset ( double offset )

virtual

Set the initial vertical position of hull spray particles.

virtual void makVrv::DtEntityWakeVisualizer::setDamageState ( int state )

virtual

virtual const DtStateVisualizer::TypeInfo& makVrv::DtEntityWakeVisualizer::typeInfo ( ) const

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityWakeVisualizer::setParent ( DtStateVisualizer * parent )

virtual

Override of DtStateVisualizer base method.

This gives us access to our parent visualizer, DtEntityKinStateVisualizer. We need to get the value of the isAmphibious flag from it

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityWakeVisualizer::setIsFrozen ( bool frozen )

virtual

Set if the entity this wake is part of is in the frozen state.

static const DtStateVisualizer::TypeInfo& makVrv::DtEntityWakeVisualizer::theTypeInfo ( )

static

This class's type info.

virtual void makVrv::DtEntityWakeVisualizer::slot_oceanWakesEnabledChanged ( bool enabled )

protectedvirtual

Receives notification of global settings changes for ocean wakes.

This call stores the global enabled state for processing whether all wake effects should be enabled on all entities.

Parameters

enabled is the new global state.

virtual void makVrv::DtEntityWakeVisualizer::slot_hullSprayEffectsChanged ( bool enabled )

protectedvirtual

Receives notification of global settings changes for hull-spray.

Parameters

enabled is the new global state.

virtual bool makVrv::DtEntityWakeVisualizer::active ( ) const

protectedvirtual

virtual void makVrv::DtEntityWakeVisualizer::createModelAgents ( )

protectedvirtual

Create the wake and wake updater agents.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityWakeVisualizer::destroyModelAgents ( )

protectedvirtual

Destroy the wake and wake updater agents.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityWakeVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

No-op. Required for all DtState visualizers, but not used here.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityWakeVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition & visDef )

protectedvirtual

Set the visualizer definition, which contains any user=specified attributes.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityWakeVisualizer::setEmbarkedOn ( const std::string & )

protectedvirtual

Called by signal when the entity's embarked state changes.

virtual bool makVrv::DtEntityWakeVisualizer::visible ( ) const

protectedvirtual

Used locally, checks all the conditions to determine if a wake should be generated for this entity.

virtual void makVrv::DtEntityWakeVisualizer::updateWakeEffects ( )

protectedvirtual

Used locally, enables/disables the wake, spray and prop-wash by creating or destroying all model-agents.

This call performs the work of enabling/disabling the effects, but does not save the enabled state of the effects.

See Also: setWakeEnabled(bool); slot_oceanWakesEnabledChanged(bool)

virtual bool makVrv::DtEntityWakeVisualizer::areWakeEffectsEnabled ( ) const

protectedvirtual

Used locally, returns if wake effects are enabled, both locally and globally.

Return values

true	if wake effects are locally and globally enabled.
false	otherwise

virtual void makVrv::DtEntityWakeVisualizer::updateSprayEffects ( )

protectedvirtual

Used locally, enables/disables the spray (bow-spray, hull-spray, etc).

This call performs the work of enabling/disabling the effects, but does not save the enabled state of the effects.

See Also: setSprayEnabled(bool); slot_hullSprayEffectsChanged(bool)

virtual bool makVrv::DtEntityWakeVisualizer::areSprayEffectsEnabled ( ) const

protectedvirtual

Used locally, returns if the spray effects is enabled globally.

Return values

true	if spray effect is globally enabled.
false	otherwise

virtual void makVrv::DtEntityWakeVisualizer::slot_wakeDefaultLODDistanceChanged ( double distance )

protectedvirtual

Receives notification of global settings changes for wake lod default distance.

Parameters

distance is the new global state.

Member Data Documentation

DtWakeModelAgent* makVrv::DtEntityWakeVisualizer::myWakeModel

protected

DtWakeUpdaterAgent* makVrv::DtEntityWakeVisualizer::myWakeUpdater

protected

bool makVrv::DtEntityWakeVisualizer::myDestroyed

protected

bool makVrv::DtEntityWakeVisualizer::myEmbarked

protected

bool makVrv::DtEntityWakeVisualizer::myEffectEnabled

protected

bool makVrv::DtEntityWakeVisualizer::mySprayEnabled

protected

bool makVrv::DtEntityWakeVisualizer::mySternWaveEnabled

protected

double makVrv::DtEntityWakeVisualizer::myWakeOffset

protected

bool makVrv::DtEntityWakeVisualizer::myWakeOffsetSet

protected

double makVrv::DtEntityWakeVisualizer::myBowSprayOffset

protected

bool makVrv::DtEntityWakeVisualizer::myBowSprayOffsetSet

protected

double makVrv::DtEntityWakeVisualizer::myBowWaveOffset

protected

bool makVrv::DtEntityWakeVisualizer::myBowWaveOffsetSet

protected

double makVrv::DtEntityWakeVisualizer::mySternWaveOffset

protected

bool makVrv::DtEntityWakeVisualizer::mySternWaveOffsetSet

protected

double makVrv::DtEntityWakeVisualizer::myShipLength

protected

double makVrv::DtEntityWakeVisualizer::myBeamWidth

protected

bool makVrv::DtEntityWakeVisualizer::myPropWashEnabled

protected

double makVrv::DtEntityWakeVisualizer::myPropWashOffset

protected

bool makVrv::DtEntityWakeVisualizer::myPropWashOffsetSet

protected

double makVrv::DtEntityWakeVisualizer::myPropWashFadeTime

protected

bool makVrv::DtEntityWakeVisualizer::myPropWashFadeTimeSet

protected

double makVrv::DtEntityWakeVisualizer::myDraft

protected

double makVrv::DtEntityWakeVisualizer::myLODDistance

protected

double makVrv::DtEntityWakeVisualizer::mySprayVelocityScale

protected

double makVrv::DtEntityWakeVisualizer::myBowWaveScale

protected

double makVrv::DtEntityWakeVisualizer::myMaxBowWaveAmplitude

protected

bool makVrv::DtEntityWakeVisualizer::myMaxBowWaveAmplitudeSet

protected

double makVrv::DtEntityWakeVisualizer::myBowSize

protected

double makVrv::DtEntityWakeVisualizer::mySpraySizeScale

protected

int makVrv::DtEntityWakeVisualizer::myNumHullSprays

protected

double makVrv::DtEntityWakeVisualizer::myHullSprayStart

protected

bool makVrv::DtEntityWakeVisualizer::myHullSprayStartSet

protected

double makVrv::DtEntityWakeVisualizer::myHullSprayEnd

protected

bool makVrv::DtEntityWakeVisualizer::myHullSprayEndSet

protected

double makVrv::DtEntityWakeVisualizer::myHullSprayVerticalOffset

protected

bool makVrv::DtEntityWakeVisualizer::myHullSprayVerticalOffsetSet

protected

double makVrv::DtEntityWakeVisualizer::myHullSprayVelocityScale

protected

double makVrv::DtEntityWakeVisualizer::myHullSpraySizeScale

protected

bool makVrv::DtEntityWakeVisualizer::myOceanWakesEnabledGlobalFlag

protected

bool makVrv::DtEntityWakeVisualizer::mySprayEffectsEnabledGlobalFlag

protected

bool makVrv::DtEntityWakeVisualizer::myIsAmphibious

protected

boost::signalslib::connection makVrv::DtEntityWakeVisualizer::myWakeLODDistanceChangedConnection

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtEntityWakeVisualizer.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation