xiiSimpleWindWorldModule Class Reference

Inheritance diagram for xiiSimpleWindWorldModule:

Public Member Functions
	xiiSimpleWindWorldModule (xiiWorld *pWorld)
virtual xiiVec3	GetWindAt (const xiiVec3 &vPosition) const override
void	SetFallbackWind (const xiiVec3 &vWind)
Public Member Functions inherited from xiiWindWorldModuleInterface
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
xiiWorld *	GetWorld ()
	Returns the corresponding world to this module.
const xiiWorld *	GetWorld () 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 xiiRTTI *	GetDynamicRTTI () 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.

Additional Inherited Members
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()
Protected Types inherited from xiiWorldModule
using	UpdateFunction = xiiDelegate<void(const UpdateContext&)>
	Update function delegate.
Protected Member Functions inherited from xiiWindWorldModuleInterface
	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.
xiiAllocatorBase *	GetAllocator ()
	Returns the allocator used by the world.
xiiInternal::WorldLargeBlockAllocator *	GetBlockAllocator ()
	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).
Protected Attributes inherited from xiiWorldModule
xiiWorld *	m_pWorld

Member Function Documentation

GetWindAt()

xiiVec3 xiiSimpleWindWorldModule::GetWindAt ( const xiiVec3 & vPosition ) const

overridevirtual

Implements xiiWindWorldModuleInterface.

---

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

• /home/runner/work/XII/XII/Source/Engine/GameEngine/Effects/Wind/SimpleWindWorldModule.h
• /home/runner/work/XII/XII/Source/Engine/GameEngine/Effects/Wind/Implementation/SimpleWindWorldModule.cpp