XII Release 0.1.0
Loading...
Searching...
No Matches
xiiWindWorldModuleInterface Class Referenceabstract
Inheritance diagram for xiiWindWorldModuleInterface:
[legend]

Public Member Functions

virtual xiiVec3 GetWindAt (const xiiVec3 &vPosition) const =0
 
virtual xiiSimdVec4f GetWindAtSimd (const xiiSimdVec4f &vPosition) const
 
xiiVec3 ComputeWindFlutter (const xiiVec3 &vWind, const xiiVec3 &vObjectDir, float fFlutterSpeed, xiiUInt32 uiFlutterRandomOffset) const
 Computes a 'fluttering' wind motion orthogonal to an object direction.
 
- Public Member Functions inherited from xiiWorldModule
xiiWorldGetWorld ()
 Returns the corresponding world to this module.
 
const xiiWorldGetWorld () const
 Returns the corresponding world to this module.
 
xiiUInt32 GetWorldIndex () const
 Same as GetWorld()->GetIndex(). Needed to break circular include dependencies.
 
- Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const xiiRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T>
XII_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Protected Member Functions

 xiiWindWorldModuleInterface (xiiWorld *pWorld)
 
- Protected Member Functions inherited from xiiWorldModule
 xiiWorldModule (xiiWorld *pWorld)
 
void RegisterUpdateFunction (const UpdateFunctionDesc &desc)
 Registers the given update function at the world.
 
void DeregisterUpdateFunction (const UpdateFunctionDesc &desc)
 De-registers the given update function from the world. Note that only the m_Function and the m_Phase of the description have to be valid for de-registration.
 
xiiAllocatorBaseGetAllocator ()
 Returns the allocator used by the world.
 
xiiInternal::WorldLargeBlockAllocatorGetBlockAllocator ()
 Returns the block allocator used by the world.
 
bool GetWorldSimulationEnabled () const
 Returns whether the world simulation is enabled.
 
virtual void Initialize ()
 This method is called after the constructor. A derived type can override this method to do initialization work. Typically this is the method where updates function are registered.
 
virtual void Deinitialize ()
 This method is called before the destructor. A derived type can override this method to do deinitialization work.
 
virtual void OnSimulationStarted ()
 This method is called at the start of the next world update when the world is simulated. This method will be called after the initialization method.
 
virtual void WorldClear ()
 Called by xiiWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).
 

Additional Inherited Members

- Static Public Member Functions inherited from xiiNoBase
static const xiiRTTIGetStaticRTTI ()
 
- Protected Types inherited from xiiWorldModule
using UpdateFunction = xiiDelegate<void(const UpdateContext&)>
 Update function delegate.
 
- Protected Attributes inherited from xiiWorldModule
xiiWorldm_pWorld
 

Member Function Documentation

◆ ComputeWindFlutter()

xiiVec3 xiiWindWorldModuleInterface::ComputeWindFlutter ( const xiiVec3 & vWind,
const xiiVec3 & vObjectDir,
float fFlutterSpeed,
xiiUInt32 uiFlutterRandomOffset ) const

Computes a 'fluttering' wind motion orthogonal to an object direction.

This is used to apply sideways or upwards wind forces on an object, such that it flutters in the wind, even when the wind is constant.

Parameters
vWindThe sampled (and potentially boosted or clamped) wind value.
vObjectDirThe main direction of the object. For example the (average) direction of a tree branch, or the direction of a rope or cable. The flutter value will be orthogonal to the object direction and the wind direction. So when wind blows sideways onto a branch, the branch would flutter upwards and downwards. For a rope hanging downwards, wind blowing against it would make it flutter sideways.
fFlutterSpeedHow fast the object shall flutter (frequency).
uiFlutterRandomOffsetA random number that adds an offset to the flutter, such that multiple objects next to each other will flutter out of phase.

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