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 plHeightfieldComponent:

[legend]

Public Member Functions
plVec2	GetHalfExtents () const

void	SetHalfExtents (plVec2 value)

float	GetHeight () const

void	SetHeight (float value)

plVec2	GetTexCoordOffset () const

void	SetTexCoordOffset (plVec2 value)

plVec2	GetTexCoordScale () const

void	SetTexCoordScale (plVec2 value)

void	SetMaterialFile (const char *szFile)

const char *	GetMaterialFile () const

void	SetMaterial (const plMaterialResourceHandle &hMaterial)

plMaterialResourceHandle	GetMaterial () const

void	SetHeightfieldFile (const char *szFile)

const char *	GetHeightfieldFile () const

void	SetHeightfield (const plImageDataResourceHandle &hResource)

plImageDataResourceHandle	GetHeightfield () const

plVec2U32	GetTesselation () const

void	SetTesselation (plVec2U32 value)

void	SetGenerateCollision (bool b)

bool	GetGenerateCollision () const

plVec2U32	GetColMeshTesselation () const

void	SetColMeshTesselation (plVec2U32 value)

void	SetIncludeInNavmesh (bool b)

bool	GetIncludeInNavmesh () const

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

PL_ALWAYS_INLINE plUInt32	GetUniqueIdForRendering (plUInt32 uiInnerIndex=0, plUInt32 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 plComponent
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.

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

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

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

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

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

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

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

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

void	SetUniqueID (plUInt32 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.

PL_ALWAYS_INLINE bool	SendMessage (plMessage &ref_msg)
	Sends a message to this component.

PL_ALWAYS_INLINE bool	SendMessage (plMessage &ref_msg) const

void	PostMessage (const plMessage &msg, plTime delay=plTime::MakeZero(), plObjectMsgQueueType::Enum queueType=plObjectMsgQueueType::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 plMessage &msg) const
	Returns whether the given Message is handled by this component.

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

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

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

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

Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () 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
virtual plResult	GetLocalBounds (plBoundingBoxSphere &bounds, bool &bAlwaysVisible, plMsgUpdateLocalBounds &msg) override
	Called by plRenderComponent::OnUpdateLocalBounds(). If PL_SUCCESS is returned, bounds and bAlwaysVisible will be integrated into the plMsgUpdateLocalBounds result, otherwise the out values are simply ignored.

void	OnMsgExtractRenderData (plMsgExtractRenderData &msg) const

void	OnBuildStaticMesh (plMsgBuildStaticMesh &msg) const

void	OnMsgExtractGeometry (plMsgExtractGeometry &msg) const

void	InvalidateMesh ()

void	BuildGeometry (plGeometry &geom) const

plResult	BuildMeshDescriptor (plMeshResourceDescriptor &desc) const

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

Protected Member Functions inherited from plRenderComponent
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 (plMsgUpdateLocalBounds &msg)

void	InvalidateCachedRenderData ()

Protected Member Functions inherited from plComponent
	plComponent ()
	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 plWorldModuleTypeId	GetTypeId () const =0

virtual plComponentMode::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 (plMessage &msg, bool bWasPostedMsg)
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

virtual bool	OnUnhandledMessage (plMessage &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
plUInt32	m_uiHeightfieldChangeCounter = 0

plImageDataResourceHandle	m_hHeightfield

plMaterialResourceHandle	m_hMaterial

plVec2	m_vHalfExtents = plVec2(100.0f)

float	m_fHeight = 50.0f

plVec2	m_vTexCoordOffset = plVec2::MakeZero()

plVec2	m_vTexCoordScale = plVec2(1)

plVec2U32	m_vTesselation = plVec2U32(128)

plVec2U32	m_vColMeshTesselation = plVec2U32(64)

bool	m_bGenerateCollision = true

bool	m_bIncludeInNavmesh = true

plMeshResourceHandle	m_hMesh

Protected Attributes inherited from plComponent
const plRTTI *	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 (plWorldWriter &stream) const override
	Override this to save the current state of the component to the given stream.

virtual void	DeserializeComponent (plWorldReader &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 plRenderComponent
static plUInt32	GetUniqueIdForRendering (const plComponent &component, plUInt32 uiInnerIndex=0, plUInt32 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 plNoBase
static const plRTTI *	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 plHeightfieldComponent::DeserializeComponent ( plWorldReader & inout_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 plComponent.

◆ GetLocalBounds()

plResult plHeightfieldComponent::GetLocalBounds	(	plBoundingBoxSphere &	ref_bounds,
		bool &	ref_bAlwaysVisible,
		plMsgUpdateLocalBounds &	ref_msg )

overrideprotectedvirtual

Called by plRenderComponent::OnUpdateLocalBounds(). If PL_SUCCESS is returned, bounds and bAlwaysVisible will be integrated into the plMsgUpdateLocalBounds result, otherwise the out values are simply ignored.

Implements plRenderComponent.

◆ OnActivated()

void plHeightfieldComponent::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 plRenderComponent.

◆ SerializeComponent()

void plHeightfieldComponent::SerializeComponent ( plWorldWriter & inout_stream ) const

overrideprivatevirtual

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

Reimplemented from plComponent.

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

Code/EnginePlugins/GameComponentsPlugin/Terrain/HeightfieldComponent.h
Code/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()