VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtWindSwitchTickable Class Reference

The DtWindSwitchTickable class is responsible for switching nodes based on the current wind speed. More...

Inheritance diagram for makVrv::DtWindSwitchTickable:
Inheritance graph
[legend]

Public Member Functions

 DtWindSwitchTickable (DtDe &de, DtElementID elementId, DtUniqueID sceneObjectId, DtUniqueID uniqueId, bool useInstancing, unsigned int nodeTypeIndex)
 CTOR. More...
 
virtual ~DtWindSwitchTickable ()
 DTOR. More...
 
virtual void update (DtTime tNow)
 Update the switch node based on the wind speed. More...
 
virtual bool needsUpdate (DtTime tNow)
 The check function called by DtTickableManager to verify if an update is required. More...
 
virtual void configure (osg::Node *n, DtOsgArticulatedModel *osgArticulatedModel, const rapidjson::Value &windJsonData)
 Configure the meta file tickable object. More...
 
unsigned int getSwitchIndexForSpeed (double windSpeed)
 Get the switch index based on the wind speed (km/h) More...
 
- Public Member Functions inherited from makVrv::DtDynamicFeatureTickable
virtual ~DtDynamicFeatureTickable ()
 DTOR. More...
 
- Public Member Functions inherited from makVrv::DtTickable
virtual bool updateIfNeeded (DtTime tNow)
 Calls needsUpdate(), and then calls update() if needsUpdate() is true. More...
 
virtual ~DtTickable ()
 Virtual DTOR. More...
 
virtual void setIsThreadSafe (bool safe)
 Get/set whether this tickable can be updated in parallel with other tickables. More...
 
virtual bool isThreadSafe () const
 
virtual void setTickableListState (TickableListState safeList)
 Track which tickable list (if any) this tickable is on Since the tickable constructor puts ALL tickables on the main (unThreadSafe) to start we need a way to check which list a tickable is on (and this way we can request removals from the correct list instead of having to call DtTickableManager::removeTickableObject(), which tries both lists). More...
 
virtual TickableListState tickableListState () const
 
virtual void setUpdatePeriod (unsigned int period)
 Specify how often (in # of frames) this tickable should call update. More...
 
virtual unsigned int updatePeriod () const
 
virtual bool lodSystemEnabled () const
 is the update LOD system enabled, overridden by subclasses More...
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor. More...
 
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor. More...
 

Static Public Attributes

static const chartheWindSwitchFeatureName
 Strings to get the different parts of the meta file Use these instead of hardcoded strings. More...
 
static const chartheTagWindSpeeds
 
static const chartheTagSwitchIndices
 

Protected Attributes

float myLastWindSpeed
 Last update wind speed. More...
 
DtDisplayUnitsConvertermyConverter
 To convert the wind speed to display units (km/h) More...
 
osgSim::MultiSwitch * myWindSwitchNode
 The actual node that contains switch states. More...
 
std::vector< doublemyWindSpeeds
 Windspeeds. More...
 
std::vector< intmySwitchIndices
 
- Protected Attributes inherited from makVrv::DtDynamicFeatureTickable
DtDemyDe
 The display engine. More...
 
DtElementID myElementId
 Object element id. More...
 
DtUniqueID mySceneObjectId
 To retrieve the scene object if needed. More...
 
DtInstanceManagermyInstanceManager
 The instance manager in case we have instancing on. More...
 
bool myUseInstancing
 Is instancing enabled? More...
 
unsigned int myNodeTypeIndex
 For the node type used in the tickable, the index in the instancing array for that node type (so we update the right one) More...
 
DtUniqueID myUniqueId
 For retrieving the instance state from the instance manager. More...
 
std::string myFeatureName
 The name of the feature in the .meta file. More...
 
- Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterfacemyManager
 Pointer to manager for removal during destruction. More...
 
DtSignalConnectionManager myConnections
 
unsigned int myFrameCounter
 
unsigned int myFrameToUpdate
 
unsigned int myUpdatePeriod
 
DtTime myLastUpdateTime
 
bool myIsThreadSafe
 
TickableListState myTickableListState
 

Additional Inherited Members

- Public Types inherited from makVrv::DtTickable
enum  TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }
 Enumeration used to indicate which DtTickableManager's tickable list the tickable is on, if any. More...
 
- Protected Member Functions inherited from makVrv::DtDynamicFeatureTickable
 DtDynamicFeatureTickable (DtDe &de, DtElementID elementId, DtUniqueID sceneObjectId, DtUniqueID uniqueId, bool useInstancing, unsigned int nodeTypeIndex)
 CTOR. More...
 
- Protected Member Functions inherited from makVrv::DtTickable
 DtTickable (DtTickableManagerInterface *manager)
 CTOR. More...
 
 DtTickable ()
 Unimplemented default CTOR. More...
 
virtual void slot_managerAboutToBeDeleted ()
 

Detailed Description

The DtWindSwitchTickable class is responsible for switching nodes based on the current wind speed.

Constructor & Destructor Documentation

makVrv::DtWindSwitchTickable::DtWindSwitchTickable ( DtDe de,
DtElementID  elementId,
DtUniqueID  sceneObjectId,
DtUniqueID  uniqueId,
bool  useInstancing,
unsigned int  nodeTypeIndex 
)

CTOR.

virtual makVrv::DtWindSwitchTickable::~DtWindSwitchTickable ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWindSwitchTickable::update ( DtTime  tNow)
virtual

Update the switch node based on the wind speed.

Implements makVrv::DtTickable.

virtual bool makVrv::DtWindSwitchTickable::needsUpdate ( DtTime  tNow)
virtual

The check function called by DtTickableManager to verify if an update is required.

If this function returns true, the DtTickableManager will then call update().

Parameters
[in]tNowis the current time-stamp.
Return values
trueif this object needs to be ticked.
falseotherwise.

Reimplemented from makVrv::DtTickable.

virtual void makVrv::DtWindSwitchTickable::configure ( osg::Node *  n,
DtOsgArticulatedModel osgArticulatedModel,
const rapidjson::Value &  windJsonData 
)
virtual

Configure the meta file tickable object.

unsigned int makVrv::DtWindSwitchTickable::getSwitchIndexForSpeed ( double  windSpeed)

Get the switch index based on the wind speed (km/h)

Member Data Documentation

const char* makVrv::DtWindSwitchTickable::theWindSwitchFeatureName
static

Strings to get the different parts of the meta file Use these instead of hardcoded strings.

const char* makVrv::DtWindSwitchTickable::theTagWindSpeeds
static
const char* makVrv::DtWindSwitchTickable::theTagSwitchIndices
static
float makVrv::DtWindSwitchTickable::myLastWindSpeed
protected

Last update wind speed.

DtDisplayUnitsConverter& makVrv::DtWindSwitchTickable::myConverter
protected

To convert the wind speed to display units (km/h)

osgSim::MultiSwitch* makVrv::DtWindSwitchTickable::myWindSwitchNode
protected

The actual node that contains switch states.

std::vector<double> makVrv::DtWindSwitchTickable::myWindSpeeds
protected

Windspeeds.

std::vector<int> makVrv::DtWindSwitchTickable::mySwitchIndices
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)