xiiWorldModule Class Reference

Inheritance diagram for xiiWorldModule:

Classes
struct	UpdateContext
struct	UpdateFunctionDesc
	Description of an update function that can be registered at the world. More...

Public Member Functions
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.

Protected Types
using	UpdateFunction = xiiDelegate<void(const UpdateContext&)>
	Update function delegate.

Protected Member Functions
	xiiWorldModule (xiiWorld *pWorld)
void	RegisterUpdateFunction (const UpdateFunctionDesc &desc)
	Registers the given update function at the world.
void	DeregisterUpdateFunction (const UpdateFunctionDesc &desc)
xiiAllocator *	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 ()
virtual void	Deinitialize ()
	This method is called before the destructor. A derived type can override this method to do deinitialization work.
virtual void	OnSimulationStarted ()
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
xiiWorld *const	m_pWorld

Friends
class	xiiWorld
class	xiiInternal::WorldData
class	xiiMemoryUtils

Additional Inherited Members
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Member Function Documentation

Deinitialize()

virtual void xiiWorldModule::Deinitialize ( )

inlineprotectedvirtual

This method is called before the destructor. A derived type can override this method to do deinitialization work.

Reimplemented in xiiCameraComponentManager, and xiiRenderWorldModule.

DeregisterUpdateFunction()

void xiiWorldModule::DeregisterUpdateFunction ( const UpdateFunctionDesc & desc )

protected

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.

GetWorld()

XII_ALWAYS_INLINE xiiWorld * xiiWorldModule::GetWorld

(

)

Returns the corresponding world to this module.

Copyright (c) Theophilus Eriata. All Rights Reserved.

Initialize()

virtual void xiiWorldModule::Initialize ( )

inlineprotectedvirtual

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.

Reimplemented in xiiCameraComponentManager, xiiComponentManagerSimple< ComponentType, UpdateType, StorageType, UpdatePhase >, xiiComponentManagerSimple< class xiiInputComponent, xiiComponentUpdateType::WhenSimulating >, xiiComponentManagerSimple< class xiiSkeletonComponent, xiiComponentUpdateType::WhenSimulating, xiiBlockStorageType::Compact, xiiWorldUpdatePhase::PostTransform >, xiiComponentManagerSimple< class xiiSkeletonPoseComponent, xiiComponentUpdateType::Always, xiiBlockStorageType::Compact, xiiWorldUpdatePhase::PostTransform >, xiiPrefabReferenceComponentManager, xiiRenderWorldModule, xiiScriptWorldModule, xiiStateMachineComponentManager, and xiiVolumetricMediumComponentManager.

OnSimulationStarted()

virtual void xiiWorldModule::OnSimulationStarted ( )

inlineprotectedvirtual

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.

Reimplemented in xiiRenderWorldModule.

WorldClear()

virtual void xiiWorldModule::WorldClear ( )

inlineprotectedvirtual

Called by xiiWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).

Reimplemented in xiiScriptWorldModule.

---

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

• /home/runner/work/XII/XII/Source/Engine/Core/World/WorldModule.h
• /home/runner/work/XII/XII/Source/Engine/Core/World/Implementation/WorldModule.cpp
• /home/runner/work/XII/XII/Source/Engine/Core/World/Implementation/WorldModule_inl.h