This component utilizes a greyscale image to generate an elevation mesh, which is typically used for simple terrain. More...

#include <HeightfieldComponent.h>

Inheritance diagram for xiiHeightfieldComponent:

[legend]

Public Member Functions
xiiVec2	GetHalfExtents () const

void	SetHalfExtents (xiiVec2 value)

float	GetHeight () const

void	SetHeight (float value)

xiiVec2	GetTexCoordOffset () const

void	SetTexCoordOffset (xiiVec2 value)

xiiVec2	GetTexCoordScale () const

void	SetTexCoordScale (xiiVec2 value)

void	SetMaterial (const xiiMaterialResourceHandle &hMaterial)

xiiMaterialResourceHandle	GetMaterial () const

void	SetHeightfield (const xiiImageDataResourceHandle &hResource)

const xiiImageDataResourceHandle &	GetHeightfield () const

xiiVec2U32	GetTesselation () const

void	SetTesselation (xiiVec2U32 value)

void	SetGenerateCollision (bool b)

bool	GetGenerateCollision () const

xiiVec2U32	GetColMeshTesselation () const

void	SetColMeshTesselation (xiiVec2U32 value)

Public Member Functions inherited from xiiRenderComponent
void	TriggerLocalBoundsUpdate ()
	Call this when some value was modified that affects the size of the local bounding box and it should be recomputed.

XII_ALWAYS_INLINE xiiUInt32	GetUniqueIdForRendering (xiiUInt32 uiInnerIndex=0, xiiUInt32 uiInnerIndexShift=24) const
	Computes a unique ID for the given component, that is usually given to the renderer to distinguish objects.

Public Member Functions inherited from xiiComponent
void	SetActiveFlag (bool bEnabled)
	Sets the active flag of the component, which affects its active state.

bool	GetActiveFlag () const
	Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'.

bool	IsActive () const
	Checks whether this component is in an active state.

bool	IsActiveAndInitialized () const
	Returns whether this component is active and initialized.

bool	IsActiveAndSimulating () const
	Whether the component is currently active and simulation has been started as well.

xiiComponentManagerBase *	GetOwningManager ()
	Returns the corresponding manager for this component.

const xiiComponentManagerBase *	GetOwningManager () const
	Returns the corresponding manager for this component.

xiiGameObject *	GetOwner ()
	Returns the owner game object if the component is attached to one or nullptr.

const xiiGameObject *	GetOwner () const
	Returns the owner game object if the component is attached to one or nullptr.

xiiWorld *	GetWorld ()
	Returns the corresponding world for this component.

const xiiWorld *	GetWorld () const
	Returns the corresponding world for this component.

xiiComponentHandle	GetHandle () const
	Returns a handle to this component.

xiiUInt32	GetUniqueID () const
	Returns the unique id for this component.

void	SetUniqueID (xiiUInt32 uiUniqueID)
	Sets the unique id for this component.

void	EnsureInitialized ()
	Ensures that the component is initialized. Must only be called from another component's Initialize callback.

void	EnsureSimulationStarted ()
	Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback.

XII_ALWAYS_INLINE bool	SendMessage (xiiMessage &ref_msg)
	Sends a message to this component.

XII_ALWAYS_INLINE bool	SendMessage (xiiMessage &ref_msg) const

void	PostMessage (const xiiMessage &msg, xiiTime delay=xiiTime::MakeZero(), xiiObjectMsgQueueType::Enum queueType=xiiObjectMsgQueueType::NextFrame) const
	Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.

virtual bool	HandlesMessage (const xiiMessage &msg) const
	Returns whether the given Message is handled by this component.

void	SetUserFlag (xiiUInt8 uiFlagIndex, bool bSet)
	Be careful to check which flags may already be in use by base classes.

bool	GetUserFlag (xiiUInt8 uiFlagIndex) const
	Retrieves a custom flag. Index must be between 0 and 7.

void	SetCreatedByPrefab ()
	Adds xiiObjectFlags::CreatedByPrefab to the component. See the flag for details.

bool	WasCreatedByPrefab () const
	Checks whether the xiiObjectFlags::CreatedByPrefab flag is set on this component.

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 Member Functions
virtual xiiResult	GetLocalBounds (xiiBoundingBoxSphere &bounds, bool &bAlwaysVisible, xiiMsgUpdateLocalBounds &msg) override
	Called by xiiRenderComponent::OnUpdateLocalBounds().

void	OnMsgExtractRenderData (xiiMsgExtractRenderData &msg) const

void	OnBuildStaticMesh (xiiMsgBuildStaticMesh &msg) const

void	OnMsgExtractGeometry (xiiMsgExtractGeometry &msg) const

void	InvalidateMesh ()

void	BuildGeometry (xiiGeometry &geom) const

xiiResult	BuildMeshDescriptor (xiiMeshResourceDescriptor &desc) const

template<typename ResourceType>
xiiTypedResourceHandle< ResourceType >	GenerateMesh () const

Protected Member Functions inherited from xiiRenderComponent
virtual void	Deinitialize () override
	This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work.

virtual void	OnDeactivated () override
	This method is called when the component gets deactivated.

void	OnUpdateLocalBounds (xiiMsgUpdateLocalBounds &msg)

void	InvalidateCachedRenderData ()

Protected Member Functions inherited from xiiComponent
	xiiComponent ()
	Keep the constructor private or protected in derived classes, so it cannot be called manually.

bool	IsDynamic () const
	Returns whether this component is dynamic and thus can only be attached to dynamic game objects.

virtual xiiWorldModuleTypeId	GetTypeId () const =0

virtual xiiComponentMode::Enum	GetMode () const =0

virtual void	Initialize ()
	Can be overridden for basic initialization that depends on a valid hierarchy and position.

virtual void	OnSimulationStarted ()
	This method is called once for active components, at the start of the next world update, but only when the world is simulated.

void	EnableUnhandledMessageHandler (bool enable)
	By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.

virtual bool	OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg)
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

virtual bool	OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg) const
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

bool	IsInitialized () const

bool	IsInitializing () const

bool	IsSimulationStarted () const

Protected Attributes
xiiUInt32	m_uiHeightfieldChangeCounter = 0

xiiImageDataResourceHandle	m_hHeightfield

xiiMaterialResourceHandle	m_hMaterial

xiiVec2	m_vHalfExtents = xiiVec2(100.0f)

float	m_fHeight = 50.0f

xiiVec2	m_vTexCoordOffset = xiiVec2::MakeZero()

xiiVec2	m_vTexCoordScale = xiiVec2(1)

xiiVec2U32	m_vTesselation = xiiVec2U32(128)

xiiVec2U32	m_vColMeshTesselation = xiiVec2U32(64)

bool	m_bGenerateCollision = true

xiiMeshResourceHandle	m_hMesh

Protected Attributes inherited from xiiComponent
const xiiRTTI *	m_pMessageDispatchType = nullptr
	Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.

Private Member Functions
virtual void	SerializeComponent (xiiWorldWriter &stream) const override
	Override this to save the current state of the component to the given stream.

virtual void	DeserializeComponent (xiiWorldReader &stream) override
	Override this to load the current state of the component from the given stream.

virtual void	OnActivated () override
	This method is called when the component gets activated.

Additional Inherited Members
Static Public Member Functions inherited from xiiRenderComponent
static xiiUInt32	GetUniqueIdForRendering (const xiiComponent &component, xiiUInt32 uiInnerIndex=0, xiiUInt32 uiInnerIndexShift=24)
	Computes a unique ID for the given component, that is usually given to the renderer to distinguish objects.

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

Detailed Description

This component utilizes a greyscale image to generate an elevation mesh, which is typically used for simple terrain.

The component always creates a mesh for rendering, which uses a single material. For different layers of grass, dirt, etc. the material can combine multiple textures and a mask.

If the "GenerateCollision" property is set, the component also generates a static collision mesh during scene export.

Member Function Documentation

◆ DeserializeComponent()

void xiiHeightfieldComponent::DeserializeComponent ( xiiWorldReader & ref_stream )

overrideprivatevirtual

Override this to load the current state of the component from the given stream.

The active state will be automatically serialized. The 'initialized' state is not serialized, all components will be initialized after creation, even if they were already in an initialized state when they were serialized.

Reimplemented from xiiComponent.

◆ GetLocalBounds()

xiiResult xiiHeightfieldComponent::GetLocalBounds	(	xiiBoundingBoxSphere &	out_bounds,
		bool &	out_bAlwaysVisible,
		xiiMsgUpdateLocalBounds &	ref_msg )

overrideprotectedvirtual

Called by xiiRenderComponent::OnUpdateLocalBounds().

If XII_SUCCESS is returned, out_bounds and out_bAlwaysVisible will be integrated into the xiiMsgUpdateLocalBounds ref_msg, otherwise the out values are simply ignored.

Implements xiiRenderComponent.

◆ OnActivated()

void xiiHeightfieldComponent::OnActivated ( )

overrideprivatevirtual

This method is called when the component gets activated.

By default a component is active, but it can be created in an inactive state. In such a case OnActivated() is only called once a component is activated. If a component gets switched between active and inactive at runtime, OnActivated() and OnDeactivated() are called accordingly. In contrast Initialize() and Deinitialize() are only ever called once.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from xiiRenderComponent.

◆ SerializeComponent()

void xiiHeightfieldComponent::SerializeComponent ( xiiWorldWriter & ref_stream ) const

overrideprivatevirtual

Override this to save the current state of the component to the given stream.

Reimplemented from xiiComponent.

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

/home/runner/work/XII/XII/Source/EnginePlugins/GameComponentsPlugin/Terrain/HeightfieldComponent.h
/home/runner/work/XII/XII/Source/EnginePlugins/GameComponentsPlugin/Terrain/Implementation/HeightfieldComponent.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeserializeComponent()

◆ GetLocalBounds()

◆ OnActivated()

◆ SerializeComponent()