Rebel Fork Framework
Urho3D::Terrain Class Reference

Heightmap terrain component. More...

#include <Urho3D/Graphics/Terrain.h>

Inheritance diagram for Urho3D::Terrain:
Urho3D::Component Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Terrain (Context *context)
 ~Terrain () override
void ApplyAttributes () override
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
void OnSetEnabled () override
 Handle enabled/disabled state change.
void DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
 Visualize the component as debug geometry.
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 SetEnableDebug (bool enable)
 Enable drawing debug information. Set this before applying heightmap. Increases memory usage.
void ApplyHeightMap ()
 Apply changes from the heightmap image.
int GetPatchSize () const
const Vector3GetSpacing () const
const IntVector2GetNumVertices () const
const IntVector2GetNumPatches () const
unsigned GetMaxLodLevels () const
unsigned GetOcclusionLodLevel () const
bool GetSmoothing () const
ImageGetHeightMap () const
MaterialGetMaterial () const
TerrainPatchGetPatch (unsigned index) const
TerrainPatchGetPatch (int x, int z) const
 Return patch by patch coordinates.
TerrainPatchGetNeighborPatch (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.
Vector2 HeightMapToUV (const IntVector2 &pixelPosition) const
 Convert heightmap pixel position to UV.
TerrainGetNorthNeighbor () const
TerrainGetSouthNeighbor () const
TerrainGetWestNeighbor () const
TerrainGetEastNeighbor () const
ea::shared_array< 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.
BoundingBox CalculateWorldBoundingBox () const
 Return world bounding box of the terrain. Calculations are not cached.
void SetBakeLightmap (bool bakeLightmap)
 Set whether the lightmap is baked for this object.
bool GetBakeLightmap () const
 Return whether the lightmap is baked for this object.
bool GetBakeLightmapEffective () const
 Return whether the lightmap is baked for this object. Return false for objects with zero scale in lightmap.
void SetScaleInLightmap (float scale)
 Set scale in lightmap.
float GetScaleInLightmap () const
 Return scale in lightmap.
void SetLightmapIndex (unsigned idx)
 Set lightmap index.
unsigned GetLightmapIndex () const
 Return lightmap index.
void SetLightmapScaleOffset (const Vector4 &scaleOffset)
 Set lightmap scale and offset.
const Vector4GetLightmapScaleOffset () const
 Return lightmap scale and offset.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 ~Component () override
AttributeScopeHint GetEffectiveScopeHint () const
bool Save (Serializer &dest) const override
 Save as binary data. Return true if successful.
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
virtual void GetDependencyNodes (ea::vector< Node * > &dest)
 Return the depended on nodes to order network updates.
void SetEnabled (bool enable)
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
Node * GetNode () const
SceneGetScene () const
 Return the scene the node belongs to.
bool IsEnabled () const
bool IsEnabledEffective () const
ea::string GetFullNameDebug () const
 Return full component name for debugging. Unique for each component in the scene. Slow!
ComponentGetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
unsigned GetIndexInParent () const
 Return index of this component in the node.
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 ~Serializable () override
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.
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 ObjectReflectionGetReflection () const
 Return reflection used for serialization.
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
void SerializeInBlock (Archive &archive, bool serializeTemporary)
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
bool SetAttribute (unsigned index, const Variant &value)
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
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)
Variant GetAttribute (unsigned index) const
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
Variant GetAttributeDefault (unsigned index) const
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
unsigned GetNumAttributes () const
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
bool IsTemporary () const
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
virtual const ea::string & GetTypeName () const =0
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.
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 SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
VariantMapGetEventDataMap () 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, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
const VariantMapGetGlobalVars () const
void SetGlobalVar (StringHash key, const Variant &value)
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 ea::string & GetCategory () const
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
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.
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
int AddRef ()
int ReleaseRef ()
int Refs () const
int WeakRefs () const
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
bool IsScriptStrongRef () const
 Return true if script reference is strong.

Static Public Member Functions

static void RegisterObject (Context *context)
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 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.
void UpdatePatchesLightmaps ()
 Update lightmap settings in patches.

Private Attributes

SharedPtr< IndexBufferindexBuffer_
 Shared index buffer.
SharedPtr< ImageheightMap_
 Heightmap image.
ea::shared_array< float > heightData_
 Height data.
ea::shared_array< float > sourceHeightData_
 Source height data for smoothing.
SharedPtr< Materialmaterial_
bool bakeLightmap_ {}
 Whether the lightmap is enabled.
float scaleInLightmap_ { 1.0f }
 Texel density scale in lightmap.
unsigned lightmapIndex_ {}
 Lightmap index.
Vector4 lightmapScaleOffset_ { 1.0f, 1.0f, 0.0f, 0.0f }
 Lightmap scale and offset.
ea::vector< WeakPtr< TerrainPatch > > patches_
 Terrain patches.
ea::vector< ea::pair< unsigned, unsigned > > drawRanges_
 Draw ranges for different LODs and stitching combinations.
WeakPtr< Terrainnorth_
 North neighbor terrain.
WeakPtr< Terrainsouth_
 South neighbor terrain.
WeakPtr< Terrainwest_
 West neighbor terrain.
WeakPtr< Terraineast_
 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.
bool debugGeometry_
 Enables vertex buffer shadowing.

Additional Inherited Members

- Protected Member Functions inherited from Urho3D::Component
virtual void OnNodeSet (Node *previousNode, Node *currentNode)
 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)
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
ComponentGetFixedUpdateSource ()
 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 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::Serializable
ea::unique_ptr< VariantMapinstanceDefaultValues_
 Attribute default value at each instance level.
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
bool temporary_
 Temporary flag.
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Detailed Description

Heightmap terrain component.

Member Function Documentation

◆ GetCastShadows()

bool Urho3D::Terrain::GetCastShadows ( ) const

Return shadowcaster flag.

◆ GetDrawDistance()

float Urho3D::Terrain::GetDrawDistance ( ) const

Return draw distance.

◆ GetEastNeighbor()

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

Return east neighbor terrain.

◆ GetHeight()

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

Return height at world coordinates.

◆ GetHeightMap()

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

Return heightmap image.

◆ GetLightMask()

unsigned Urho3D::Terrain::GetLightMask ( ) const

Return light mask.

◆ GetLodBias()

float Urho3D::Terrain::GetLodBias ( ) const

Return LOD bias.

◆ GetMaterial()

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

Return material.

◆ GetMaxLights()

unsigned Urho3D::Terrain::GetMaxLights ( ) const

Return maximum number of per-pixel lights.

◆ GetMaxLodLevels()

unsigned Urho3D::Terrain::GetMaxLodLevels ( ) const

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

◆ GetNorthNeighbor()

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

Return north neighbor terrain.

◆ GetNumPatches()

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

Return heightmap size in patches.

◆ GetNumVertices()

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

Return heightmap size in vertices.

◆ GetOcclusionLodLevel()

unsigned Urho3D::Terrain::GetOcclusionLodLevel ( ) const

Return LOD level used for occlusion.

◆ GetPatch()

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

Return patch by index.

◆ GetPatchSize()

int Urho3D::Terrain::GetPatchSize ( ) const

Return patch quads per side.

◆ GetShadowDistance()

float Urho3D::Terrain::GetShadowDistance ( ) const

Return shadow draw distance.

◆ GetShadowMask()

unsigned Urho3D::Terrain::GetShadowMask ( ) const

Return shadow mask.

◆ GetSmoothing()

bool Urho3D::Terrain::GetSmoothing ( ) const

Return whether smoothing is in use.

◆ GetSouthNeighbor()

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

Return south neighbor terrain.

◆ GetSpacing()

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

Return vertex and height spacing.

◆ GetViewMask()

unsigned Urho3D::Terrain::GetViewMask ( ) const

Return view mask.

◆ GetWestNeighbor()

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

Return west neighbor terrain.

◆ GetZoneMask()

unsigned Urho3D::Terrain::GetZoneMask ( ) const

Return zone mask.

◆ IsOccludee()

bool Urho3D::Terrain::IsOccludee ( ) const

Return occludee flag.

◆ IsOccluder()

bool Urho3D::Terrain::IsOccluder ( ) const

Return occluder flag.

◆ RegisterObject()

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

Register object factory.

◆ SetCastShadows()

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

Set shadowcaster flag for patches.

◆ SetDrawDistance()

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

Set draw distance for patches.

◆ SetEastNeighbor()

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

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

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

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

◆ SetLodBias()

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

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

◆ SetMaterial()

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

Set material.

◆ SetMaxLights()

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

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

◆ SetMaxLodLevels()

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

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

◆ SetNorthNeighbor()

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

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

◆ SetOccludee()

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

Set occludee flag for patches.

◆ SetOccluder()

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

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

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

◆ SetPatchSize()

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

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

◆ SetShadowDistance()

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

Set shadow draw distance for patches.

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

◆ SetSmoothing()

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

Set smoothing of heightmap.

◆ SetSouthNeighbor()

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

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

◆ SetSpacing()

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

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

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

◆ SetWestNeighbor()

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

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

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

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