Heightmap terrain component. More...

#include <Terrain.h>

Inheritance diagram for Urho3D::Terrain:
Collaboration diagram for Urho3D::Terrain:

Public Member Functions

 Terrain (Context *context)
 ~Terrain ()
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access.
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual void OnSetEnabled ()
 Handle enabled/disabled state change.
void SetPatchSize (int size)
 Set patch quads per side. Must be a power of two.
void SetSpacing (const Vector3 &spacing)
 Set vertex (XZ) and height (Y) spacing.
void SetMaxLodLevels (unsigned levels)
 Set maximum number of LOD levels for terrain patches. This can be between 1-4.
void 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.
void SetSmoothing (bool enable)
 Set smoothing of heightmap.
bool 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.
void SetMaterial (Material *material)
 Set material.
void SetDrawDistance (float distance)
 Set draw distance for patches.
void SetShadowDistance (float distance)
 Set shadow draw distance for patches.
void SetLodBias (float bias)
 Set LOD bias for patches. Affects which terrain LOD to display.
void SetViewMask (unsigned mask)
 Set view mask for patches. Is and'ed with camera's view mask to see if the object should be rendered.
void 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.
void 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.
void 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.
void SetMaxLights (unsigned num)
 Set maximum number of per-pixel lights for patches. Default 0 is unlimited.
void SetCastShadows (bool enable)
 Set shadowcaster flag for patches.
void SetOccluder (bool enable)
 Set occlusion flag for patches. Occlusion uses the coarsest LOD by default.
void SetOccludee (bool enable)
 Set occludee flag for patches.
void ApplyHeightMap ()
 Apply changes from the heightmap image.
int GetPatchSize () const
 Return patch quads per side.
const Vector3GetSpacing () const
 Return vertex and height spacing.
const IntVector2GetNumVertices () const
 Return heightmap size in vertices.
const IntVector2GetNumPatches () const
 Return heightmap size in patches.
unsigned GetMaxLodLevels () const
 Return maximum number of LOD levels for terrain patches. This can be between 1-4.
unsigned GetOcclusionLodLevel () const
 Return LOD level used for occlusion.
bool GetSmoothing () const
 Return whether smoothing is in use.
ImageGetHeightMap () const
 Return heightmap image.
MaterialGetMaterial () const
 Return material.
TerrainPatchGetPatch (unsigned index) const
 Return patch by index.
TerrainPatchGetPatch (int x, int z) const
 Return patch by patch coordinates.
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.
SharedArrayPtr< float > GetHeightData () const
 Return raw height data.
float GetDrawDistance () const
 Return draw distance.
float GetShadowDistance () const
 Return shadow draw distance.
float GetLodBias () const
 Return LOD bias.
unsigned GetViewMask () const
 Return view mask.
unsigned GetLightMask () const
 Return light mask.
unsigned GetShadowMask () const
 Return shadow mask.
unsigned GetZoneMask () const
 Return zone mask.
unsigned GetMaxLights () const
 Return maximum number of per-pixel lights.
bool IsVisible () const
 Return visible flag.
bool GetCastShadows () const
 Return shadowcaster flag.
bool IsOccluder () const
 Return occluder flag.
bool IsOccludee () const
 Return occludee flag.
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)
virtual ~Component ()
virtual bool Save (Serializer &dest) const
 Save as binary data. Return true if successful.
virtual bool SaveXML (XMLElement &dest) const
 Save as XML data. Return true if successful.
virtual void MarkNetworkUpdate ()
 Mark for attribute check on the next network update.
virtual void GetDependencyNodes (PODVector< Node * > &dest)
 Return the depended on nodes to order network updates.
virtual void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
void SetEnabled (bool enable)
 Set enabled/disabled state.
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
 Return ID.
NodeGetNode () const
 Return scene node.
SceneGetScene () const
 Return the scene the node belongs to.
bool IsEnabled () const
 Return whether is enabled.
bool IsEnabledEffective () const
 Return whether is effectively enabled (node is also enabled.)
ComponentGetComponent (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)
 Clean up all references to a network connection that is about to be removed.
- Public Member Functions inherited from Urho3D::Animatable
 Animatable (Context *context)
virtual ~Animatable ()
virtual bool LoadXML (const XMLElement &source, bool setInstanceDefault=false)
 Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
void SetAnimationEnabled (bool enable)
 Set automatic update of animation, default true.
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)
 Set object animation.
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
 Return animation enabled.
ObjectAnimationGetObjectAnimation () const
 Return object animation.
ValueAnimationGetAttributeAnimation (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)
virtual ~Serializable ()
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.
virtual const Vector
< AttributeInfo > * 
GetAttributes () const
 Return attribute descriptions, or null if none defined.
virtual const Vector
< AttributeInfo > * 
GetNetworkAttributes () const
 Return network replication attribute descriptions, or null if none defined.
virtual bool Load (Deserializer &source, bool setInstanceDefault=false)
 Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual bool SaveDefaultAttributes () const
 Return whether should save default-valued attributes into XML. Default false.
bool SetAttribute (unsigned index, const Variant &value)
 Set attribute by index. Return true if successfully set.
bool SetAttribute (const String &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
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)
 Set temporary flag. Temporary objects will not be saved.
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
 Return attribute value by index. Return empty if illegal index.
Variant GetAttribute (const String &name) const
 Return attribute value by name. Return empty if not found.
Variant GetAttributeDefault (unsigned index) const
 Return attribute default value by index. Return empty if illegal index.
Variant GetAttributeDefault (const String &name) const
 Return attribute default value by name. Return empty if not found.
unsigned GetNumAttributes () const
 Return number of attributes.
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
bool IsTemporary () const
 Return whether is temporary.
bool GetInterceptNetworkUpdate (const String &attributeName) const
 Return whether an attribute's network updates are being intercepted.
NetworkStateGetNetworkState () const
 Return the network attribute state, if allocated.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual const TypeInfoGetTypeInfo () 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.
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 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. More...
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
- 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.
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int Refs () const
 Return reference count.
int WeakRefs () const
 Return weak reference count.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory.

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 SetNeighbors (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.

Private Attributes

SharedPtr< IndexBufferindexBuffer_
 Shared index buffer.
SharedPtr< ImageheightMap_
 Heightmap image.
SharedArrayPtr< float > heightData_
 Height data.
SharedArrayPtr< float > sourceHeightData_
 Source height data for smoothing.
SharedPtr< Materialmaterial_
Vector< WeakPtr< TerrainPatch > > patches_
 Terrain patches.
PODVector< Pair< unsigned,
unsigned > > 
 Draw ranges for different LODs and stitching combinations.
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.
bool recreateTerrain_
 Terrain needs regeneration flag.

Additional Inherited Members

- Protected Member Functions inherited from Urho3D::Component
virtual void OnAttributeAnimationAdded ()
 Handle attribute animation added.
virtual void OnAttributeAnimationRemoved ()
 Handle attribute animation removed.
virtual void OnNodeSet (Node *node)
 Handle scene node being assigned at creation.
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.
virtual void OnMarkedDirty (Node *node)
 Handle scene node transform dirtied.
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
void SetID (unsigned id)
 Set ID. Called by Scene.
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.
- Protected Attributes inherited from Urho3D::Component
 Scene node.
unsigned id_
 Unique ID within the scene.
bool networkUpdate_
 Network update queued flag.
bool enabled_
 Enabled flag.

Detailed Description

Heightmap terrain component.

Member Function Documentation

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

Return height at world coordinates.

This assumes that the terrain scene node is upright

Here is the call graph for this function:

The documentation for this class was generated from the following files:
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/Terrain.h
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/Terrain.cpp