Plasma Engine  2.0
Loading...
Searching...
No Matches
plWindWorldModuleInterface Class Referenceabstract
Inheritance diagram for plWindWorldModuleInterface:

Public Member Functions

virtual plVec3 GetWindAt (const plVec3 &vPosition) const =0
 
virtual plSimdVec4f GetWindAtSimd (const plSimdVec4f &vPosition) const
 
plVec3 ComputeWindFlutter (const plVec3 &vWind, const plVec3 &vObjectDir, float fFlutterSpeed, plUInt32 uiFlutterRandomOffset) const
 Computes a 'fluttering' wind motion orthogonal to an object direction.
 
- Public Member Functions inherited from plWorldModule
plWorldGetWorld ()
 Returns the corresponding world to this module.
 
const plWorldGetWorld () const
 Returns the corresponding world to this module.
 
plUInt32 GetWorldIndex () const
 Same as GetWorld()->GetIndex(). Needed to break circular include dependencies.
 
- Public Member Functions inherited from plReflectedClass
virtual const plRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const plRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
PL_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Protected Member Functions

 plWindWorldModuleInterface (plWorld *pWorld)
 
- Protected Member Functions inherited from plWorldModule
 plWorldModule (plWorld *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.
 
plAllocatorGetAllocator ()
 Returns the allocator used by the world.
 
plInternal::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 plWorld::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 plNoBase
static const plRTTIGetStaticRTTI ()
 
- Protected Types inherited from plWorldModule
using UpdateFunction = plDelegate<void(const UpdateContext&)>
 Update function delegate.
 
- Protected Attributes inherited from plWorldModule
plWorldm_pWorld
 

Member Function Documentation

◆ ComputeWindFlutter()

plVec3 plWindWorldModuleInterface::ComputeWindFlutter ( const plVec3 & vWind,
const plVec3 & vObjectDir,
float fFlutterSpeed,
plUInt32 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: