Umasoft
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Protected Attributes | List of all members
vtHeightConstrain Class Reference

#include <NavEngines.h>

Inheritance diagram for vtHeightConstrain:
vtEngine vtEnabledBase

Public Member Functions

 vtHeightConstrain (float fMinHeight)
 
void SetHeightField (vtHeightField3d *pHF)
 Set the heightfield on which to do the terrain following.
 
void SetMinGroundOffset (float fMeters)
 Set the height above the terrain to allow.
 
float GetMinGroundOffset ()
 Get the height above the terrain to allow.
 
void SetUseCulture (bool set)
 Set whether to use the height of culture for terrain following. Default is false.
 
bool GetUseCulture ()
 Get whether to use the height of culture for terrain following.
 
void SetMaintain (bool bMaintain)
 If true, the current height above the terrain is maintained. Default is false.
 
bool GetMaintain ()
 
void SetMaintainHeight (float fHeight)
 Set the height which should be maintained.
 
bool IsVerticallyMobile ()
 
void Eval ()
 
- Public Member Functions inherited from vtEngine
osg::Referenced * GetTarget (uint which=0)
 
void AddTarget (osg::Referenced *ptr)
 
void SetTarget (osg::Referenced *ptr)
 
void RemoveTarget (osg::Referenced *ptr)
 
uint NumTargets ()
 Return the number of targets for this engine.
 
void setName (const char *str)
 
const char * getName ()
 
virtual void OnMouse (vtMouseEvent &event)
 Virtual handler, to catch mouse events, can be overridden by your engine class.
 
virtual void OnKey (int key, int flags)
 Virtual handler, to catch keyboard events, can be overridden by your engine class.
 
virtual void OnWindowSize (int width, int height)
 Virtual handler, to catch resize events, can be overridden by your engine class.
 
void SetWindow (vtWindow *pWin)
 
vtWindowGetWindow ()
 
void AddChild (vtEngine *pEngine)
 
void RemoveChild (vtEngine *pEngine)
 
vtEngineGetChild (uint i)
 
uint NumChildren ()
 
void AddChildrenToList (vtArray< vtEngine * > &list, bool bEnabledOnly)
 
- Public Member Functions inherited from vtEnabledBase
virtual void SetEnabled (bool bOn)
 
bool GetEnabled ()
 

Protected Attributes

bool m_bMaintain
 
float m_fMaintainHeight
 
vtHeightField3dm_pHF
 
float m_fMinGroundOffset
 
bool m_bUseCulture
 
bool m_bOnGround
 
- Protected Attributes inherited from vtEngine
vtArray< osg::Referenced * > m_Targets
 
std::vector< vtEnginePtr > m_Children
 
vtString m_strName
 
vtWindowm_pWindow
 
- Protected Attributes inherited from vtEnabledBase
bool m_bEnabled
 

Detailed Description

Constrain the height of a target over a heightfield.

Member Function Documentation

void vtHeightConstrain::Eval ( )
virtual

Virtual handler, will be called every frame to do the work of the engine. You must override this if you want your engine to be useful.

Reimplemented from vtEngine.


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