makVrf::DtSubsurfaceStateComponent Class Reference

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

Public Member Functions
	DtSubsurfaceStateComponent (DtStateData *storage)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, underwaterVisibility, UnderwaterVisibility)
	UNDEFINED_RETURNREF_ACCESSOR_MUTATOR (DtVrfSubsurfaceLayerSet, subsurfaceLayers, SubsurfaceLayers)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer1Depth, ThermoclineLayer1Depth)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer1Permeability, ThermoclineLayer1Permeability)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer2Depth, ThermoclineLayer2Depth)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer2Permeability, ThermoclineLayer2Permeability)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer3Depth, ThermoclineLayer3Depth)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer3Permeability, ThermoclineLayer3Permeability)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer4Depth, ThermoclineLayer4Depth)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer4Permeability, ThermoclineLayer4Permeability)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer5Depth, ThermoclineLayer5Depth)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, thermoclineLayer5Permeability, ThermoclineLayer5Permeability)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (double, ambientWaterTemperature, AmbientWaterTemperature)
	UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR (int, priority, Priority)
virtual void	addSubsurfaceLayer (const DtVrfSubsurfaceLayer &layerToAdd)
virtual void	removeSubsurfaceLayer (const DtVrfSubsurfaceLayer &layerToRemove)
void	setIsRemoteComponent (bool b)
Public Member Functions inherited from makVrf::DtFrameStateInterface
	DtFrameStateInterface (const DtStateData *)
virtual	~DtFrameStateInterface ()
void	setIsWritable (bool b)
bool	isWritable () const
UInt64	stateId () const
UInt64	legionGlobalId () const
void	setLegionGlobalId (UInt64 d)
bool	isModified () const
void	clearModified ()
void	markModified ()
virtual DtStateComponent::StateComponentType	type () const
virtual DtStateComponent::StateComponentType	componentType () 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

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::DtSubsurfaceStateComponent::DtSubsurfaceStateComponent ( DtStateData *  storage )

inline

Member Function Documentation

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		underwaterVisibility	,
		UnderwaterVisibility
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNREF_ACCESSOR_MUTATOR	(	DtVrfSubsurfaceLayerSet	,
		subsurfaceLayers	,
		SubsurfaceLayers
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer1Depth	,
		ThermoclineLayer1Depth
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer1Permeability	,
		ThermoclineLayer1Permeability
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer2Depth	,
		ThermoclineLayer2Depth
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer2Permeability	,
		ThermoclineLayer2Permeability
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer3Depth	,
		ThermoclineLayer3Depth
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer3Permeability	,
		ThermoclineLayer3Permeability
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer4Depth	,
		ThermoclineLayer4Depth
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer4Permeability	,
		ThermoclineLayer4Permeability
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer5Depth	,
		ThermoclineLayer5Depth
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		thermoclineLayer5Permeability	,
		ThermoclineLayer5Permeability
	)

makVrf::DtSubsurfaceStateComponent::UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR	(	double	,
		ambientWaterTemperature	,
		AmbientWaterTemperature
	)

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

virtual void makVrf::DtSubsurfaceStateComponent::addSubsurfaceLayer ( const DtVrfSubsurfaceLayer &  layerToAdd )

inlinevirtual

virtual void makVrf::DtSubsurfaceStateComponent::removeSubsurfaceLayer ( const DtVrfSubsurfaceLayer &  layerToRemove )

inlinevirtual

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

inline

Member Data Documentation

bool makVrf::DtSubsurfaceStateComponent::myIsRemoteComponent = false

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfStateData/subsurfaceStateComponent.h