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

[legend]

Public Member Functions
ezVec2	GetHalfExtents () const

void	SetHalfExtents (ezVec2 value)

float	GetHeight () const

void	SetHeight (float value)

ezVec2	GetTexCoordOffset () const

void	SetTexCoordOffset (ezVec2 value)

ezVec2	GetTexCoordScale () const

void	SetTexCoordScale (ezVec2 value)

void	SetMaterial (const ezMaterialResourceHandle &hMaterial)

ezMaterialResourceHandle	GetMaterial () const

void	SetHeightfield (const ezImageDataResourceHandle &hResource)

const ezImageDataResourceHandle &	GetHeightfield () const

ezVec2U32	GetTesselation () const

void	SetTesselation (ezVec2U32 value)

void	SetGenerateCollision (bool b)

bool	GetGenerateCollision () const

ezVec2U32	GetColMeshTesselation () const

void	SetColMeshTesselation (ezVec2U32 value)

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

EZ_ALWAYS_INLINE ezUInt32	GetUniqueIdForRendering (ezUInt32 uiInnerIndex=0, ezUInt32 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 ezComponent
void	SetActiveFlag (bool bEnabled)
	Sets the active flag of the component, which affects its active state. More...

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'. More...

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

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

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

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

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

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

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

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

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

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

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

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

EZ_ALWAYS_INLINE bool	SendMessage (ezMessage &ref_msg)
	Sends a message to this component.

EZ_ALWAYS_INLINE bool	SendMessage (ezMessage &ref_msg) const

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

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

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

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

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

Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
EZ_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 ezResult	GetLocalBounds (ezBoundingBoxSphere &bounds, bool &bAlwaysVisible, ezMsgUpdateLocalBounds &msg) override
	Called by ezRenderComponent::OnUpdateLocalBounds(). More...

void	OnMsgExtractRenderData (ezMsgExtractRenderData &msg) const

void	OnBuildStaticMesh (ezMsgBuildStaticMesh &msg) const

void	OnMsgExtractGeometry (ezMsgExtractGeometry &msg) const

void	InvalidateMesh ()

void	BuildGeometry (ezGeometry &geom) const

ezResult	BuildMeshDescriptor (ezMeshResourceDescriptor &desc) const

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

Protected Member Functions inherited from ezRenderComponent
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. More...

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

void	OnUpdateLocalBounds (ezMsgUpdateLocalBounds &msg)

void	InvalidateCachedRenderData ()

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

virtual ezComponentMode::Enum	GetMode () const =0

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

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. More...

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

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

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

bool	IsInitialized () const

bool	IsInitializing () const

bool	IsSimulationStarted () const

Protected Attributes
ezUInt32	m_uiHeightfieldChangeCounter = 0

ezImageDataResourceHandle	m_hHeightfield

ezMaterialResourceHandle	m_hMaterial

ezVec2	m_vHalfExtents = ezVec2(100.0f)

float	m_fHeight = 50.0f

ezVec2	m_vTexCoordOffset = ezVec2::MakeZero()

ezVec2	m_vTexCoordScale = ezVec2(1)

ezVec2U32	m_vTesselation = ezVec2U32(128)

ezVec2U32	m_vColMeshTesselation = ezVec2U32(64)

bool	m_bGenerateCollision = true

ezMeshResourceHandle	m_hMesh

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

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

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

Additional Inherited Members
Static Public Member Functions inherited from ezRenderComponent
static ezUInt32	GetUniqueIdForRendering (const ezComponent &component, ezUInt32 uiInnerIndex=0, ezUInt32 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 ezNoBase
static const ezRTTI *	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 ezHeightfieldComponent::DeserializeComponent ( ezWorldReader & 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 ezComponent.

◆ GetLocalBounds()

ezResult ezHeightfieldComponent::GetLocalBounds	(	ezBoundingBoxSphere &	out_bounds,
		bool &	out_bAlwaysVisible,
		ezMsgUpdateLocalBounds &	ref_msg
	)

overrideprotectedvirtual

Called by ezRenderComponent::OnUpdateLocalBounds().

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

Implements ezRenderComponent.

◆ OnActivated()

void ezHeightfieldComponent::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 ezRenderComponent.

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

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