Heightmap terrain component. More...

#include </var/dev/u3d/stable/Source/Urho3D/Graphics/Terrain.h>

Inheritance diagram for Urho3D::Terrain:

Collaboration diagram for Urho3D::Terrain:

Public Member Functions
	Terrain (Context *context)
	Construct.

	~Terrain () override
	Destruct.

void	ApplyAttributes () override
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update. More...

void	OnSetEnabled () override
	Handle enabled/disabled state change. More...

void	SetPatchSize (int size)

void	SetSpacing (const Vector3 &spacing)

void	SetMaxLodLevels (unsigned levels)

void	SetOcclusionLodLevel (unsigned level)

void	SetSmoothing (bool enable)

bool	SetHeightMap (Image *image)

void	SetMaterial (Material *material)

void	SetNorthNeighbor (Terrain *north)

void	SetSouthNeighbor (Terrain *south)

void	SetWestNeighbor (Terrain *west)

void	SetEastNeighbor (Terrain *east)

void	SetNeighbors (Terrain north, Terrain south, Terrain west, Terrain east)
	Set all neighbor terrains at once.

void	SetDrawDistance (float distance)

void	SetShadowDistance (float distance)

void	SetLodBias (float bias)

void	SetViewMask (unsigned mask)

void	SetLightMask (unsigned mask)

void	SetShadowMask (unsigned mask)

void	SetZoneMask (unsigned mask)

void	SetMaxLights (unsigned num)

void	SetCastShadows (bool enable)

void	SetOccluder (bool enable)

void	SetOccludee (bool enable)

void	ApplyHeightMap ()
	Apply changes from the heightmap image.

int	GetPatchSize () const

const Vector3 &	GetSpacing () const

const IntVector2 &	GetNumVertices () const

const IntVector2 &	GetNumPatches () const

unsigned	GetMaxLodLevels () const

unsigned	GetOcclusionLodLevel () const

bool	GetSmoothing () const

Image *	GetHeightMap () const

Material *	GetMaterial () const

TerrainPatch *	GetPatch (unsigned index) const

TerrainPatch *	GetPatch (int x, int z) const
	Return patch by patch coordinates.

TerrainPatch *	GetNeighborPatch (int x, int z) const
	Return patch by patch coordinates including neighbor terrains.

float	GetHeight (const Vector3 &worldPosition) const
	Return height at world coordinates. More...

Vector3	GetNormal (const Vector3 &worldPosition) const
	Return normal at world coordinates.

IntVector2	WorldToHeightMap (const Vector3 &worldPosition) const
	Convert world position to heightmap pixel position. Note that the internal height data representation is reversed vertically, but in the heightmap image north is at the top.

Vector3	HeightMapToWorld (const IntVector2 &pixelPosition) const
	Convert heightmap pixel position to world position.

Terrain *	GetNorthNeighbor () const

Terrain *	GetSouthNeighbor () const

Terrain *	GetWestNeighbor () const

Terrain *	GetEastNeighbor () const

SharedArrayPtr< float >	GetHeightData () const
	Return raw height data.

float	GetDrawDistance () const

float	GetShadowDistance () const

float	GetLodBias () const

unsigned	GetViewMask () const

unsigned	GetLightMask () const

unsigned	GetShadowMask () const

unsigned	GetZoneMask () const

unsigned	GetMaxLights () const

bool	IsVisible () const
	Return visible flag.

bool	GetCastShadows () const

bool	IsOccluder () const

bool	IsOccludee () const

void	CreatePatchGeometry (TerrainPatch *patch)
	Regenerate patch geometry.

void	UpdatePatchLod (TerrainPatch *patch)
	Update patch based on LOD and neighbor LOD.

void	SetHeightMapAttr (const ResourceRef &value)
	Set heightmap attribute.

void	SetMaterialAttr (const ResourceRef &value)
	Set material attribute.

void	SetPatchSizeAttr (int value)
	Set patch size attribute.

void	SetMaxLodLevelsAttr (unsigned value)
	Set max LOD levels attribute.

void	SetOcclusionLodLevelAttr (unsigned value)
	Set occlusion LOD level attribute.

ResourceRef	GetHeightMapAttr () const
	Return heightmap attribute.

ResourceRef	GetMaterialAttr () const
	Return material attribute.

Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.

	~Component () override
	Destruct.

virtual void	OnSetEnabled ()
	Handle enabled/disabled state change. More...

bool	Save (Serializer &dest) const override
	Save as binary data. Return true if successful. More...

bool	SaveXML (XMLElement &dest) const override
	Save as XML data. Return true if successful. More...

bool	SaveJSON (JSONValue &dest) const override
	Save as JSON data. Return true if successful. More...

void	MarkNetworkUpdate () override
	Mark for attribute check on the next network update. More...

virtual void	GetDependencyNodes (PODVector< Node * > &dest)
	Return the depended on nodes to order network updates. More...

virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Visualize the component as debug geometry. More...

void	SetEnabled (bool enable)

void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.

unsigned	GetID () const

bool	IsReplicated () const

Node *	GetNode () const

Scene *	GetScene () const
	Return the scene the node belongs to.

bool	IsEnabled () const

bool	IsEnabledEffective () const

Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.

void	GetComponents (PODVector< Component * > &dest, StringHash type) const
	Return components in the same scene node by type.

template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.

template<class T >
void	GetComponents (PODVector< T * > &dest) const
	Template version of returning components in the same scene node by type.

void	AddReplicationState (ComponentReplicationState *state)
	Add a replication state that is tracking this component.

void	PrepareNetworkUpdate ()
	Prepare network update by comparing attributes and marking replication states dirty as necessary.

void	CleanupConnection (Connection *connection)

Public Member Functions inherited from Urho3D::Animatable
	Animatable (Context *context)
	Construct.

	~Animatable () override
	Destruct.

bool	LoadXML (const XMLElement &source) override
	Load from XML data. Return true if successful. More...

bool	SaveXML (XMLElement &dest) const override
	Save as XML data. Return true if successful. More...

bool	LoadJSON (const JSONValue &source) override
	Load from JSON data. Return true if successful. More...

bool	SaveJSON (JSONValue &dest) const override
	Save as JSON data. Return true if successful. More...

void	SetAnimationEnabled (bool enable)

void	SetAnimationTime (float time)
	Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.

void	SetObjectAnimation (ObjectAnimation *objectAnimation)

void	SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
	Set attribute animation.

void	SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
	Set attribute animation wrap mode.

void	SetAttributeAnimationSpeed (const String &name, float speed)
	Set attribute animation speed.

void	SetAttributeAnimationTime (const String &name, float time)
	Set attribute animation time position manually. Automatic update should be disabled in this case.

void	RemoveObjectAnimation ()
	Remove object animation. Same as calling SetObjectAnimation with a null pointer.

void	RemoveAttributeAnimation (const String &name)
	Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.

bool	GetAnimationEnabled () const

ObjectAnimation *	GetObjectAnimation () const

ValueAnimation *	GetAttributeAnimation (const String &name) const
	Return attribute animation.

WrapMode	GetAttributeAnimationWrapMode (const String &name) const
	Return attribute animation wrap mode.

float	GetAttributeAnimationSpeed (const String &name) const
	Return attribute animation speed.

float	GetAttributeAnimationTime (const String &name) const
	Return attribute animation time position.

void	SetObjectAnimationAttr (const ResourceRef &value)
	Set object animation attribute.

ResourceRef	GetObjectAnimationAttr () const
	Return object animation attribute.

Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.

	~Serializable () override
	Destruct.

virtual void	OnSetAttribute (const AttributeInfo &attr, const Variant &src)
	Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor. More...

virtual void	OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
	Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor. More...

virtual const Vector< AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined. More...

virtual const Vector< AttributeInfo > *	GetNetworkAttributes () const
	Return network replication attribute descriptions, or null if none defined.

virtual bool	Load (Deserializer &source)
	Load from binary data. Return true if successful. More...

virtual bool	Save (Serializer &dest) const
	Save as binary data. Return true if successful. More...

virtual bool	LoadXML (const XMLElement &source)
	Load from XML data. Return true if successful. More...

virtual bool	SaveXML (XMLElement &dest) const
	Save as XML data. Return true if successful. More...

virtual bool	LoadJSON (const JSONValue &source)
	Load from JSON data. Return true if successful. More...

virtual bool	SaveJSON (JSONValue &dest) const
	Save as JSON data. Return true if successful. More...

virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update. More...

virtual bool	SaveDefaultAttributes () const
	Return whether should save default-valued attributes into XML. Default false. More...

virtual void	MarkNetworkUpdate ()
	Mark for attribute check on the next network update. More...

bool	SetAttribute (unsigned index, const Variant &value)

bool	SetAttribute (const String &name, const Variant &value)
	Set attribute by name. Return true if successfully set.

void	SetInstanceDefault (bool enable)
	Set instance-level default flag.

void	ResetToDefault ()
	Reset all editable attributes to their default values.

void	RemoveInstanceDefault ()
	Remove instance's default values if they are set previously.

void	SetTemporary (bool enable)

void	SetInterceptNetworkUpdate (const String &attributeName, bool enable)
	Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.

void	AllocateNetworkState ()
	Allocate network attribute state.

void	WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
	Write initial delta network update.

void	WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
	Write a delta network update according to dirty attribute bits.

void	WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
	Write a latest data network update.

bool	ReadDeltaUpdate (Deserializer &source)
	Read and apply a network delta update. Return true if attributes were changed.

bool	ReadLatestDataUpdate (Deserializer &source)
	Read and apply a network latest data update. Return true if attributes were changed.

Variant	GetAttribute (unsigned index) const

Variant	GetAttribute (const String &name) const
	Return attribute value by name. Return empty if not found.

Variant	GetAttributeDefault (unsigned index) const

Variant	GetAttributeDefault (const String &name) const
	Return attribute default value by name. Return empty if not found.

unsigned	GetNumAttributes () const

unsigned	GetNumNetworkAttributes () const
	Return number of network replication attributes.

bool	IsTemporary () const

bool	GetInterceptNetworkUpdate (const String &attributeName) const
	Return whether an attribute's network updates are being intercepted.

NetworkState *	GetNetworkState () const
	Return the network attribute state, if allocated.

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const String &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.

bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEvent (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

void	SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEvent (Object sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void userData=nullptr)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, Args... args)
	Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const String &	GetCategory () const

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

void	AddRef ()

void	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Urho3D::Animatable
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (Terrain, Component)

void	CreateGeometry ()
	Regenerate terrain geometry.

void	CreateIndexData ()
	Create index data shared by all patches.

float	GetRawHeight (int x, int z) const
	Return an uninterpolated terrain height value, clamping to edges.

float	GetSourceHeight (int x, int z) const
	Return a source terrain height value, clamping to edges. The source data is used for smoothing.

float	GetLodHeight (int x, int z, unsigned lodLevel) const
	Return interpolated height for a specific LOD level.

Vector3	GetRawNormal (int x, int z) const
	Get slope-based terrain normal at position.

void	CalculateLodErrors (TerrainPatch *patch)
	Calculate LOD errors for a patch.

void	SetPatchNeighbors (TerrainPatch *patch)
	Set neighbors for a patch.

bool	SetHeightMapInternal (Image *image, bool recreateNow)
	Set heightmap image and optionally recreate the geometry immediately. Return true if successful.

void	HandleHeightMapReloadFinished (StringHash eventType, VariantMap &eventData)
	Handle heightmap image reload finished.

void	HandleNeighborTerrainCreated (StringHash eventType, VariantMap &eventData)
	Handle neighbor terrain geometry being created. Update the edge patch neighbors as necessary.

void	UpdateEdgePatchNeighbors ()
	Update edge patch neighbors when neighbor terrain(s) change or are recreated.

void	MarkNeighborsDirty ()
	Mark neighbors dirty.

void	MarkTerrainDirty ()
	Mark terrain dirty.

Private Attributes
SharedPtr< IndexBuffer >	indexBuffer_
	Shared index buffer.

SharedPtr< Image >	heightMap_
	Heightmap image.

SharedArrayPtr< float >	heightData_
	Height data.

SharedArrayPtr< float >	sourceHeightData_
	Source height data for smoothing.

SharedPtr< Material >	material_
	Material.

Vector< WeakPtr< TerrainPatch > >	patches_
	Terrain patches.

PODVector< Pair< unsigned, unsigned > >	drawRanges_
	Draw ranges for different LODs and stitching combinations.

WeakPtr< Terrain >	north_
	North neighbor terrain.

WeakPtr< Terrain >	south_
	South neighbor terrain.

WeakPtr< Terrain >	west_
	West neighbor terrain.

WeakPtr< Terrain >	east_
	East neighbor terrain.

Vector3	spacing_
	Vertex and height spacing.

Vector3	lastSpacing_
	Vertex and height sacing at the time of last update.

Vector2	patchWorldOrigin_
	Origin of patches on the XZ-plane.

Vector2	patchWorldSize_
	Size of a patch on the XZ-plane.

IntVector2	numVertices_
	Terrain size in vertices.

IntVector2	lastNumVertices_
	Terrain size in vertices at the time of last update.

IntVector2	numPatches_
	Terrain size in patches.

int	patchSize_
	Patch size, quads per side.

int	lastPatchSize_
	Patch size at the time of last update.

unsigned	numLodLevels_
	Number of terrain LOD levels.

unsigned	maxLodLevels_
	Maximum number of LOD levels.

unsigned	occlusionLodLevel_
	LOD level used for occlusion.

bool	smoothing_
	Smoothing enable flag.

bool	visible_
	Visible flag.

bool	castShadows_
	Shadowcaster flag.

bool	occluder_
	Occluder flag.

bool	occludee_
	Occludee flag.

unsigned	viewMask_
	View mask.

unsigned	lightMask_
	Light mask.

unsigned	shadowMask_
	Shadow mask.

unsigned	zoneMask_
	Zone mask.

float	drawDistance_
	Draw distance.

float	shadowDistance_
	Shadow distance.

float	lodBias_
	LOD bias.

unsigned	maxLights_
	Maximum lights.

unsigned	northID_
	Node ID of north neighbor.

unsigned	southID_
	Node ID of south neighbor.

unsigned	westID_
	Node ID of west neighbor.

unsigned	eastID_
	Node ID of east neighbor.

bool	recreateTerrain_
	Terrain needs regeneration flag.

bool	neighborsDirty_
	Terrain neighbor attributes dirty flag.

Additional Inherited Members
Protected Member Functions inherited from Urho3D::Component
void	OnAttributeAnimationAdded () override
	Handle attribute animation added. More...

void	OnAttributeAnimationRemoved () override
	Handle attribute animation removed. More...

virtual void	OnNodeSet (Node *node)
	Handle scene node being assigned at creation. More...

virtual void	OnSceneSet (Scene *scene)
	Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here. More...

virtual void	OnMarkedDirty (Node *node)
	Handle scene node transform dirtied. More...

virtual void	OnNodeSetEnabled (Node *node)
	Handle scene node enabled status changing. More...

void	SetID (unsigned id)

void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.

void	HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
	Handle scene attribute animation update event.

Component *	GetFixedUpdateSource ()
	Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.

void	DoAutoRemove (AutoRemoveMode mode)
	Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.

Protected Member Functions inherited from Urho3D::Animatable
virtual void	OnAttributeAnimationAdded ()=0
	Handle attribute animation added. More...

virtual void	OnAttributeAnimationRemoved ()=0
	Handle attribute animation removed. More...

virtual Animatable *	FindAttributeAnimationTarget (const String &name, String &outName)
	Find target of an attribute animation from object hierarchy by name. More...

void	SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
	Set object attribute animation internal.

void	OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
	Handle object animation added.

void	OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
	Handle object animation removed.

void	UpdateAttributeAnimations (float timeStep)
	Update attribute animations.

bool	IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const
	Is animated network attribute.

AttributeAnimationInfo *	GetAttributeAnimationInfo (const String &name) const
	Return attribute animation info.

void	HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
	Handle attribute animation added.

void	HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
	Handle attribute animation removed.

Protected Attributes inherited from Urho3D::Component
Node *	node_
	Scene node.

unsigned	id_
	Unique ID within the scene.

bool	networkUpdate_
	Network update queued flag.

bool	enabled_
	Enabled flag.

Protected Attributes inherited from Urho3D::Animatable
bool	animationEnabled_
	Animation enabled.

SharedPtr< ObjectAnimation >	objectAnimation_
	Animation.

HashSet< const AttributeInfo * >	animatedNetworkAttributes_
	Animated network attribute set.

HashMap< String, SharedPtr< AttributeAnimationInfo > >	attributeAnimationInfos_
	Attribute animation infos.

Protected Attributes inherited from Urho3D::Serializable
UniquePtr< NetworkState >	networkState_
	Network attribute state.

Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Heightmap terrain component.

Member Function Documentation

◆ ApplyAttributes()

void Urho3D::Terrain::ApplyAttributes ( )

overridevirtual

Apply attribute changes that can not be applied immediately. Called after scene load or a network update.

Reimplemented from Urho3D::Serializable.

Here is the call graph for this function:

◆ GetCastShadows()

bool Urho3D::Terrain::GetCastShadows ( ) const

inline

Return shadowcaster flag.

Here is the caller graph for this function:

◆ GetDrawDistance()

float Urho3D::Terrain::GetDrawDistance ( ) const

inline

Return draw distance.

Here is the caller graph for this function:

◆ GetEastNeighbor()

Terrain * Urho3D::Terrain::GetEastNeighbor ( ) const

inline

Return east neighbor terrain.

◆ GetHeight()

float Urho3D::Terrain::GetHeight ( const Vector3 & worldPosition ) const

Return height at world coordinates.

Todo:: This assumes that the terrain scene node is upright

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHeightMap()

Image * Urho3D::Terrain::GetHeightMap ( ) const

Return heightmap image.

◆ GetLightMask()

unsigned Urho3D::Terrain::GetLightMask ( ) const

inline

Return light mask.

Here is the caller graph for this function:

◆ GetLodBias()

float Urho3D::Terrain::GetLodBias ( ) const

inline

Return LOD bias.

Here is the caller graph for this function:

◆ GetMaterial()

Material * Urho3D::Terrain::GetMaterial ( ) const

Return material.

◆ GetMaxLights()

unsigned Urho3D::Terrain::GetMaxLights ( ) const

inline

Return maximum number of per-pixel lights.

Here is the caller graph for this function:

◆ GetMaxLodLevels()

unsigned Urho3D::Terrain::GetMaxLodLevels ( ) const

inline

Return maximum number of LOD levels for terrain patches. This can be between 1-4.

Here is the caller graph for this function:

◆ GetNorthNeighbor()

Terrain * Urho3D::Terrain::GetNorthNeighbor ( ) const

inline

Return north neighbor terrain.

◆ GetNumPatches()

const IntVector2 & Urho3D::Terrain::GetNumPatches ( ) const

inline

Return heightmap size in patches.

◆ GetNumVertices()

const IntVector2 & Urho3D::Terrain::GetNumVertices ( ) const

inline

Return heightmap size in vertices.

◆ GetOcclusionLodLevel()

unsigned Urho3D::Terrain::GetOcclusionLodLevel ( ) const

inline

Return LOD level used for occlusion.

Here is the caller graph for this function:

◆ GetPatch()

TerrainPatch * Urho3D::Terrain::GetPatch ( unsigned index ) const

Return patch by index.

Here is the caller graph for this function:

◆ GetPatchSize()

int Urho3D::Terrain::GetPatchSize ( ) const

inline

Return patch quads per side.

Here is the caller graph for this function:

◆ GetShadowDistance()

float Urho3D::Terrain::GetShadowDistance ( ) const

inline

Return shadow draw distance.

Here is the caller graph for this function:

◆ GetShadowMask()

unsigned Urho3D::Terrain::GetShadowMask ( ) const

inline

Return shadow mask.

Here is the caller graph for this function:

◆ GetSmoothing()

bool Urho3D::Terrain::GetSmoothing ( ) const

inline

Return whether smoothing is in use.

◆ GetSouthNeighbor()

Terrain * Urho3D::Terrain::GetSouthNeighbor ( ) const

inline

Return south neighbor terrain.

◆ GetSpacing()

const Vector3 & Urho3D::Terrain::GetSpacing ( ) const

inline

Return vertex and height spacing.

◆ GetViewMask()

unsigned Urho3D::Terrain::GetViewMask ( ) const

inline

Return view mask.

Here is the caller graph for this function:

◆ GetWestNeighbor()

Terrain * Urho3D::Terrain::GetWestNeighbor ( ) const

inline

Return west neighbor terrain.

◆ GetZoneMask()

unsigned Urho3D::Terrain::GetZoneMask ( ) const

inline

Return zone mask.

Here is the caller graph for this function:

◆ IsOccludee()

bool Urho3D::Terrain::IsOccludee ( ) const

inline

Return occludee flag.

Here is the caller graph for this function:

◆ IsOccluder()

bool Urho3D::Terrain::IsOccluder ( ) const

inline

Return occluder flag.

Here is the caller graph for this function:

◆ OnSetEnabled()

void Urho3D::Terrain::OnSetEnabled ( )

overridevirtual

Handle enabled/disabled state change.

Reimplemented from Urho3D::Component.

Here is the call graph for this function:

◆ RegisterObject()

void Urho3D::Terrain::RegisterObject ( Context * context )

static

Register object factory.

◆ SetCastShadows()

void Urho3D::Terrain::SetCastShadows ( bool enable )

Set shadowcaster flag for patches.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDrawDistance()

void Urho3D::Terrain::SetDrawDistance ( float distance )

Set draw distance for patches.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetEastNeighbor()

void Urho3D::Terrain::SetEastNeighbor ( Terrain * east )

Set east (positive X) neighbor terrain for seamless LOD changes across terrains.

Here is the call graph for this function:

◆ SetHeightMap()

bool Urho3D::Terrain::SetHeightMap ( Image * image )

Set heightmap image. Dimensions should be a power of two + 1. Uses 8-bit grayscale, or optionally red as MSB and green as LSB for 16-bit accuracy. Return true if successful.

Here is the call graph for this function:

◆ SetLightMask()

void Urho3D::Terrain::SetLightMask ( unsigned mask )

Set light mask for patches. Is and'ed with light's and zone's light mask to see if the object should be lit.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLodBias()

void Urho3D::Terrain::SetLodBias ( float bias )

Set LOD bias for patches. Affects which terrain LOD to display.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMaterial()

void Urho3D::Terrain::SetMaterial ( Material * material )

Set material.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMaxLights()

void Urho3D::Terrain::SetMaxLights ( unsigned num )

Set maximum number of per-pixel lights for patches. Default 0 is unlimited.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMaxLodLevels()

void Urho3D::Terrain::SetMaxLodLevels ( unsigned levels )

Set maximum number of LOD levels for terrain patches. This can be between 1-4.

Here is the call graph for this function:

◆ SetNorthNeighbor()

void Urho3D::Terrain::SetNorthNeighbor ( Terrain * north )

Set north (positive Z) neighbor terrain for seamless LOD changes across terrains.

Here is the call graph for this function:

◆ SetOccludee()

void Urho3D::Terrain::SetOccludee ( bool enable )

Set occludee flag for patches.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetOccluder()

void Urho3D::Terrain::SetOccluder ( bool enable )

Set occlusion flag for patches. Occlusion uses the coarsest LOD by default.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetOcclusionLodLevel()

void Urho3D::Terrain::SetOcclusionLodLevel ( unsigned level )

Set LOD level used for terrain patch occlusion. By default (M_MAX_UNSIGNED) the coarsest. Since the LOD level used needs to be fixed, using finer LOD levels may result in false positive occlusion in cases where the actual rendered geometry is coarser, so use with caution.

Here is the call graph for this function:

◆ SetPatchSize()

void Urho3D::Terrain::SetPatchSize ( int size )

Set patch quads per side. Must be a power of two.

Here is the call graph for this function:

◆ SetShadowDistance()

void Urho3D::Terrain::SetShadowDistance ( float distance )

Set shadow draw distance for patches.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetShadowMask()

void Urho3D::Terrain::SetShadowMask ( unsigned mask )

Set shadow mask for patches. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSmoothing()

void Urho3D::Terrain::SetSmoothing ( bool enable )

Set smoothing of heightmap.

Here is the call graph for this function:

◆ SetSouthNeighbor()

void Urho3D::Terrain::SetSouthNeighbor ( Terrain * south )

Set south (negative Z) neighbor terrain for seamless LOD changes across terrains.

Here is the call graph for this function:

◆ SetSpacing()

void Urho3D::Terrain::SetSpacing ( const Vector3 & spacing )

Set vertex (XZ) and height (Y) spacing.

Here is the call graph for this function:

◆ SetViewMask()

void Urho3D::Terrain::SetViewMask ( unsigned mask )

Set view mask for patches. Is and'ed with camera's view mask to see if the object should be rendered.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetWestNeighbor()

void Urho3D::Terrain::SetWestNeighbor ( Terrain * west )

Set west (negative X) neighbor terrain for seamless LOD changes across terrains.

Here is the call graph for this function:

◆ SetZoneMask()

void Urho3D::Terrain::SetZoneMask ( unsigned mask )

Set zone mask for patches. Is and'ed with zone's zone mask to see if the object should belong to the zone.

Here is the call graph for this function:

Here is the caller graph for this function:

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

/var/dev/u3d/stable/Source/Urho3D/Graphics/Terrain.h
/var/dev/u3d/stable/Source/Urho3D/Graphics/Terrain.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ApplyAttributes()

◆ GetCastShadows()

◆ GetDrawDistance()

◆ GetEastNeighbor()

◆ GetHeight()

◆ GetHeightMap()

◆ GetLightMask()

◆ GetLodBias()

◆ GetMaterial()

◆ GetMaxLights()

◆ GetMaxLodLevels()

◆ GetNorthNeighbor()

◆ GetNumPatches()

◆ GetNumVertices()

◆ GetOcclusionLodLevel()

◆ GetPatch()

◆ GetPatchSize()

◆ GetShadowDistance()

◆ GetShadowMask()

◆ GetSmoothing()

◆ GetSouthNeighbor()

◆ GetSpacing()

◆ GetViewMask()

◆ GetWestNeighbor()

◆ GetZoneMask()

◆ IsOccludee()

◆ IsOccluder()

◆ OnSetEnabled()

◆ RegisterObject()

◆ SetCastShadows()

◆ SetDrawDistance()

◆ SetEastNeighbor()

◆ SetHeightMap()

◆ SetLightMask()

◆ SetLodBias()

◆ SetMaterial()

◆ SetMaxLights()

◆ SetMaxLodLevels()

◆ SetNorthNeighbor()

◆ SetOccludee()

◆ SetOccluder()

◆ SetOcclusionLodLevel()

◆ SetPatchSize()

◆ SetShadowDistance()

◆ SetShadowMask()

◆ SetSmoothing()

◆ SetSouthNeighbor()

◆ SetSpacing()

◆ SetViewMask()

◆ SetWestNeighbor()

◆ SetZoneMask()