makVrv::DtEntityWakeVisualizer Class Reference

Visualizer for kelvin wakes. More...

Inheritance diagram for makVrv::DtEntityWakeVisualizer:

Public Member Functions
	DtEntityWakeVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtEntityWakeVisualizer ()
	DTOR.
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.
virtual void	setSprayEnabled (bool enabled)
	Enable or disable spray at the bow and hull of the ship.
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.
virtual void	setBowSprayOffset (double offset)
	Set the distance from the wake origin to where the spray appears, if enabled.
virtual void	setBowWaveOffset (double offset)
	Set the offset to the bow wake.
virtual void	setSternWaveOffset (double offset)
	Set the offset to the stern wakes.
virtual void	setShipLength (double length)
	Set the length of the ship.
virtual void	setBeamWidth (double width)
	Set the beamwidth (widest point) of the ship.
virtual void	setPropWashEnabled (bool b)
	Set whether prop wash effects are enabled.
virtual void	setPropWashOffset (double offset)
	Set the distance from the wake origin to where the prop wash appears, if enabled.
virtual void	setDraft (double draft)
	Set the draft, or the distance the hull extends underwater.
virtual void	setLODDistance (double distance)
	Set the distance at which the prop wash segments and waves are halved.
virtual void	setSprayVelocityScale (double scale)
	Set the velocity scaling for bow spray effects.
virtual void	setBowWaveScale (double scale)
	Set the scaling for bow wave effects.
virtual void	setMaxBowWaveAmplitude (double amplitude)
	Set the max amplitude for bow waves.
virtual void	setBowSize (double size)
	Set the size of the bow (0 for a pointy one.)
virtual void	setSpraySizeScale (double scale)
	Set the particle size scaling for bow spray effects.
virtual void	setNumHullSprays (int numSprays)
	Set the number of spray particle systems emitted along the hull of the ship.
virtual void	setHullSpraySizeScale (double scale)
	Set the initial size of hull spray particles.
virtual void	setHullSprayStart (double offset)
	Set the start offset of hull spray effects.
virtual void	setHullSprayEnd (double offset)
	Set the end offset of hull spray effects.
virtual void	setHullSprayVelocityScale (double scale)
	Set the initial velocity of hull spray particles as a percent of the ship velocity.
virtual void	setHullSprayVerticalOffset (double offset)
	Set the initial vertical position of hull spray particles.
virtual void	setDamageState (int state)
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
Public Member Functions inherited from makVrv::DtEntityStateVisualizer
	DtEntityStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtEntityStateVisualizer ()
	DTOR.
virtual void	setState (int stateNumber, int stateValue)
	Override to set the attribute state of agents.
DtEntityStateListener &	entityStateListener ()
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtStateVisualizer ()
	DTOR.
virtual void	setParent (DtStateVisualizer *)
	Override to set the parent of this visualizer.
void	setModelDefinition (const std::string &definition)
	Sets the model definition and creates agent(s) based on that definition.
const std::string &	modelDefinition () const
	Gets the current model definition.
virtual bool	setVisible (bool visible, int context)
	Returns true if this context wants to show or hide the item.
virtual void	initialize ()
	Initialize the visualizer.
virtual bool	isVisible () const
	Returns true if visible.
virtual void	setSelected (bool)
	Sets selected state.
virtual bool	selected () const
void	setName (const std::string &)
	Internal name of state visualizer.
const std::string &	name () const
virtual void	setPickable (bool)
	Sets pickable state.
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.
DtStateListener &	listener ()
DtBaseConnection &	simulation ()
	Get the connection for this visualizer.
void	setDistribute (bool b)
	Whether or not to distribute over the network.
bool	distribute () const

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

Protected Member Functions
virtual void	slot_oceanWakesEnabledChanged (bool enabled)
	Receives notification of global settings changes for ocean wakes.
virtual void	slot_hullSprayEffectsChanged (bool enabled)
	Receives notification of global settings changes for hull-spray.
virtual bool	active () const
virtual void	createModelAgents ()
	Create the wake and wake updater agents.
virtual void	destroyModelAgents ()
	Destroy the wake and wake updater agents.
virtual void	setModelDefinitionForAgents ()
	No-op. Required for all DtState visualizers, but not used here.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Set the visualizer definition, which contains any user=specified attributes.
virtual void	setVelocity (const DtVector &)
	Called by signal when the entity's velocity changes.
virtual void	setEmbarkedOn (const std::string &)
	Called by signal when the entity's embarked state changes.
virtual bool	visible () const
	Used locally, checks all the conditions to determine if a wake should be generated for this entity.
virtual void	updateWakeEffects ()
	Used locally, enables/disables the wake, spray and prop-wash by creating or destroying all model-agents.
virtual bool	areWakeEffectsEnabled () const
	Used locally, returns if wake effects are enabled, both locally and globally.
virtual void	updateSprayEffects ()
	Used locally, enables/disables the spray (bow-spray, hull-spray, etc).
virtual bool	areSprayEffectsEnabled () const
	Used locally, returns if the spray effects is enabled globally.

Protected Attributes
DtWakeModelAgent *	myWakeModel
DtWakeUpdaterAgent *	myWakeUpdater
bool	myMoving
bool	myDestroyed
bool	myEmbarked
bool	myEffectEnabled
bool	mySprayEnabled
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	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
Protected Attributes inherited from makVrv::DtEntityStateVisualizer
DtEntityStateListener *	myEntityListener
	Same as myListener, but casted for convenience.
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.
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.
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::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::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.

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::setVelocity ( const DtVector &  )

protectedvirtual

Called by signal when the entity's velocity changes.

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

Member Data Documentation

DtWakeModelAgent* makVrv::DtEntityWakeVisualizer::myWakeModel

protected

DtWakeUpdaterAgent* makVrv::DtEntityWakeVisualizer::myWakeUpdater

protected

bool makVrv::DtEntityWakeVisualizer::myMoving

protected

bool makVrv::DtEntityWakeVisualizer::myDestroyed

protected

bool makVrv::DtEntityWakeVisualizer::myEmbarked

protected

bool makVrv::DtEntityWakeVisualizer::myEffectEnabled

protected

bool makVrv::DtEntityWakeVisualizer::mySprayEnabled

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCore/DtEntityWakeVisualizer.h