1) Define the interface class that will be used to represent the next and current frames. The UNDEFINED_ macros are convenience macros that will define methods that throw exceptions (until they are implemented)

Inheritance diagram for makVrf::DtWaterSurfaceStateComponent:

[legend]

Public Member Functions
	DtWaterSurfaceStateComponent (DtStateData *storage)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, waterCurrentSpeed, WaterCurrentSpeed)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, waterCurrentDirection, WaterCurrentDirection)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, tidalOffset, TidalOffset)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (int, swellState, SwellState)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, swellStateDirection, SwellStateDirection)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (int, seaState, SeaState)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, seaStateDirection, SeaStateDirection)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, surfaceTransparency, SurfaceTransparency)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (bool, windDrivenSeaStateEnabled, WindDrivenSeaStateEnabled)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, choppiness, Choppiness)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, surgeDepth, SurgeDepth)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, depthOffset, DepthOffset)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, windFetch, WindFetch)

	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (int, priority, Priority)

void	setIsRemoteComponent (bool b)

Public Member Functions inherited from makVrf::DtFrameStateInterface
	DtFrameStateInterface (DtStateData *)

virtual	~DtFrameStateInterface ()

void	setIsWritable (bool b)

bool	isWritable () const

UInt64	stateId () const

UInt64	legionGlobalId () const

void	setLegionGlobalId (UInt64 d)

virtual bool	isModified () const

virtual void	clearModified ()

virtual void	markModified ()

virtual DtStateComponent::StateComponentType	type () const

virtual DtStateComponent::StateComponentType	componentType () const =0

virtual const char *	stringType () const =0

void	setId (UInt64 id)

virtual UInt64	id () const

virtual void	updateStateData (DtStateData *sd)

virtual Legion::ReadStateInstance	readStateInstance () const

virtual Legion::WriteStateInstance	writeStateInstance ()

void	emitComponentUpdated ()

bool	cleared () const

bool	advancedFrame () const

virtual void	frameAdvanced ()

virtual void	convertToRemote ()

virtual void	convertToLocal ()

virtual void	aboutToBeDeleted ()

Protected Attributes
bool	myIsRemoteComponent = false

Protected Attributes inherited from makVrf::DtFrameStateInterface
bool	myIsModified

UInt64	myId

UInt64	myStateId

UInt64	myLegionId

bool	myIsWritable

bool	myCleared

bool	myAdvancedFrame

DtStateData *	myStateData

Additional Inherited Members
Public Attributes inherited from makVrf::DtFrameStateInterface
boost::signals2::signal< void(DtFrameStateInterface *)>	signal_stateComponentAboutToBeDeleted

boost::signals2::signal< void(const DtFrameStateInterface *)>	signal_componentModified

Protected Member Functions inherited from makVrf::DtFrameStateInterface
virtual void	makeWritable ()

virtual void	makeReadOnly ()

Constructor & Destructor Documentation

makVrf::DtWaterSurfaceStateComponent::DtWaterSurfaceStateComponent ( DtStateData * storage )

inline

Member Function Documentation

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		waterCurrentSpeed	,
		WaterCurrentSpeed
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		waterCurrentDirection	,
		WaterCurrentDirection
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		tidalOffset	,
		TidalOffset
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	int	,
		swellState	,
		SwellState
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		swellStateDirection	,
		SwellStateDirection
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	int	,
		seaState	,
		SeaState
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		seaStateDirection	,
		SeaStateDirection
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		surfaceTransparency	,
		SurfaceTransparency
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	bool	,
		windDrivenSeaStateEnabled	,
		WindDrivenSeaStateEnabled
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		choppiness	,
		Choppiness
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		surgeDepth	,
		SurgeDepth
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		depthOffset	,
		DepthOffset
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		windFetch	,
		WindFetch
	)

makVrf::DtWaterSurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	int	,
		priority	,
		Priority
	)

void makVrf::DtWaterSurfaceStateComponent::setIsRemoteComponent ( bool b )

inline

Member Data Documentation

bool makVrf::DtWaterSurfaceStateComponent::myIsRemoteComponent = false

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfStateData/waterSurfaceStateComponent.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation