Click or drag to resize

Terrain Class

A heightmap based terrain.
Inheritance Hierarchy
SystemObject
  NeoAxisComponent
    NeoAxisTerrain

Namespace: NeoAxis
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2026.1.1.0 (2026.1.1.0)
Syntax
C#
public class Terrain : Component

The Terrain type exposes the following members.

Constructors
 NameDescription
Public methodTerrainInitializes a new instance of the Terrain class
Top
Properties
 NameDescription
Public propertyAllowFullUpdateGeometryCollisionCurrentLayers 
Public propertyAnyData The user data of the component.
(Inherited from Component)
Public propertyBaseType Gets the base type of the object.
(Inherited from Component)
Public propertyCastShadows Whether to cast shadows on the other surfaces.
Public propertyCloneSupport Whether the object supports cloning.
(Inherited from Component)
Public propertyCollision Whether to have a collision body.
Public propertyCollisionFriction The amount of friction applied on the rigid body.
Public propertyCollisionMaterial The physical material used by the rigid body.
Public propertyCollisionRestitution The ratio of the final relative velocity to initial relative velocity of the rigid body after collision.
Public propertyComponents Gets the collection of the child components.
(Inherited from Component)
Public propertyCreatedByBaseType Whether the object is created using a base type.
(Inherited from Component)
Public propertyDebugDrawSurfaceObjectsBounds Whether to visualize the bounds of groups for objects created by surfaces.
Public propertyDisplayInEditor Whether to show the object in the editor.
(Inherited from Component)
Public propertyDisposed Whether the object is disposed.
(Inherited from Component)
Public propertyEditorDocumentConfiguration Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component)
Public propertyEditorReadOnly Whether the object is read only in the editor.
(Inherited from Component)
Public propertyEditorReadOnlyInHierarchy Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component)
Public propertyEnabled Whether the component is enabled. Any functionality of component is not works when it disabled.
(Inherited from Component)
Public propertyEnabledInHierarchy Determines whether the object is attached to a hierarchy of the components and enabled. The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component)
Public propertyEnabledInHierarchyAndIsInstance Determines when the object is attached to a hierarchy of the components, is enabled and the object if not part of a resource (it is usual object instance). The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
(Inherited from Component)
Public propertyHeightmapBuffer 
Public propertyHeightmapSize The resolution of the height map.
Public propertyHeightmapSize_UndoDependentData 
Public propertyHierarchyController Gets the object hierarchy control controller.
(Inherited from Component)
Public propertyHoles The list of objects that are shapes for cutting holes.
Public propertyHolesEnabled Whether to enable holes.
Public propertyHorizontalSize The size along the axes X and Y.
Public propertyIsResource
(Inherited from Component)
Public propertyLODCount 
Public propertyLODDistance The distance from the previous to the next level of detail.
Public propertyLODEnabled Whether to enable level of detail.
Public propertyMaterial Base material of a terrain.
Public propertyMaterialColor The base color multiplier for base material.
Public propertyMaterialUV0 The number of UV tiles per unit for texture coordinates 0.
Public propertyMaterialUV1 The number of UV tiles per unit for texture coordinates 1.
Public propertyMaterialUVCurvatureFrequency The frequency of the curvature in the calculation of texture coordinates. The randomness is intended to reduce the tiling effect.
Public propertyMaterialUVCurvatureIntensity The intensity of the curvature in the calculation of texture coordinates. The curvature is intended to reduce the tiling effect.
Public propertyMotionBlurFactor The multiplier of the motion blur effect.
Public propertyName The name of the component.
(Inherited from Component)
Public propertyNetworkID
(Inherited from Component)
Public propertyNetworkIsClient
(Inherited from Component)
Public propertyNetworkIsServer Whether to work in network server mode. It is false until the scene is not loaded.
(Inherited from Component)
Public propertyNetworkIsSingle
(Inherited from Component)
Public propertyNetworkIsSingleOrClient
(Inherited from Component)
Public propertyNetworkMode Whether to enable synchronization of the component between server and clients.
(Inherited from Component)
Public propertyNetworkModeUsers
(Inherited from Component)
Public propertyOccluder Whether to object should be used as an occluder for occlusion culling.
Public propertyPaintMaskSize Resolution of the paint masks of the layers.
Public propertyParent Gets the parent object.
(Inherited from Component)
Public propertyParentRoot Gets the parent root object.
(Inherited from Component)
Public propertyPosition The position of the object in the scene.
Public propertyPrecalculateObjects Whether to precalculate data of objects from layers in the simulation. When the property is disabled, the objects will calculate when it needed and destroyed after 10 seconds when are not visible by the camera.
Public propertyReceiveDecals Whether it is possible to apply decals on the surface.
Public propertyRemoveFromParentQueued Whether the object is placed in the detach queue from the parent.
(Inherited from Component)
Public propertySaveSupport Whether the object supports saving to a file.
(Inherited from Component)
Public propertyScreenLabel The displaying mode of an on-screen label of the component in the scene editor.
(Inherited from Component)
Public propertySurface Base surface of the terrain.
Public propertySurfaceObjects Whether to create objects of the base surface.
Public propertySurfaceObjectsCastShadows Whether to cast shadows on the other surfaces for objects of base surface.
Public propertySurfaceObjectsCollision Whether to enable a collision detection. A collision definition of the mesh is used.
Public propertySurfaceObjectsColor The base color multiplier for objects of base surface.
Public propertySurfaceObjectsDistribution The scale the distribution of base surface objects.
Public propertySurfaceObjectsScale The scale of base surface objects size.
Public propertySurfaceObjectsVisibilityDistanceFactor The factor of maximum visibility distance for objects of base surface. The maximum distance is calculated based on the size of the object on the screen.
Public propertyTileSize The size of internal tile cells. These cells divide the entire geometry of the landscape into pieces.
Public propertyTypeSettingsPrivateObjects Object settings when used as a type.
(Inherited from Component)
Public propertyVisible Whether the object is visible in the scene.
Top
Methods
 NameDescription
Public methodAddComponent Adds a component as a child.
(Inherited from Component)
Public methodBeginNetworkMessage(ServerNetworkService_ComponentsClientItem, String)
(Inherited from Component)
Public methodBeginNetworkMessage(IListServerNetworkService_ComponentsClientItem, String)
(Inherited from Component)
Public methodBeginNetworkMessage(IListServerNetworkService_UsersUserInfo, String)
(Inherited from Component)
Public methodBeginNetworkMessage(ServerNetworkService_UsersUserInfo, String)
(Inherited from Component)
Public methodBeginNetworkMessageToEveryone
(Inherited from Component)
Public methodBeginNetworkMessageToServer
(Inherited from Component)
Public methodCalculateBounds 
Public methodClampCellIndex 
Public methodClampMaskIndex 
Public methodClone Creates a copy of the object.
(Inherited from Component)
Public methodCreateComponent(Type, Int32, Boolean, Boolean, NetworkModeEnum) Creates a child component.
(Inherited from Component)
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean, NetworkModeEnum) Creates a child component.
(Inherited from Component)
Public methodCreateComponentT(Int32, Boolean, Boolean, NetworkModeEnum) Creates a child component.
(Inherited from Component)
Public methodDispose Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFindParent(Type) Finds the parent of the specified type.
(Inherited from Component)
Public methodFindParent(MetadataTypeInfo) Finds the parent of the specified type.
(Inherited from Component)
Public methodFindParentT Finds the parent of the specified type.
(Inherited from Component)
Public methodFindThisOrParent(Type) Finds the parent or self of the specified type.
(Inherited from Component)
Public methodFindThisOrParent(MetadataTypeInfo) Finds the parent or self of the specified type.
(Inherited from Component)
Public methodFindThisOrParentT Finds the parent or self of the specified type.
(Inherited from Component)
Public methodGetAllParents Gets all parents of the component.
(Inherited from Component)
Public methodGetBounds2 
Public methodGetBoundsFromTiles 
Public methodGetCellIndexByPosition(Vector2) 
Public methodGetCellIndexByPosition(Vector2) 
Public methodGetCellSize 
Public methodGetComponent(String, Boolean) Finds a child component by name.
(Inherited from Component)
Public methodGetComponent(Type, Boolean, Boolean) Finds a child component of the specified type.
(Inherited from Component)
Public methodGetComponent(MetadataTypeInfo, Boolean, Boolean) Finds a child component of the specified type.
(Inherited from Component)
Public methodGetComponentT(Boolean, Boolean) Finds a child component of the specified type.
(Inherited from Component)
Public methodGetComponentByNameWithIndex Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component)
Public methodGetComponentByPath Finds a child component by path.
(Inherited from Component)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean) Finds child components.
(Inherited from Component)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent) Finds child components.
(Inherited from Component)
Public methodGetComponents(Type, Boolean, Boolean, Boolean, Boolean) Finds child components of the specified type.
(Inherited from Component)
Public methodGetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean) Finds child components of the specified type.
(Inherited from Component)
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT) Finds child components of the specified type.
(Inherited from Component)
Public methodGetGeometryFromTiles 
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetHeight(Vector2I) 
Public methodGetHeight(Vector2, Boolean) 
Public methodGetHeightmapSizeAsInteger 
Public methodGetHeightmapSizeInteger 
Public methodGetHeightMinMax 
Public methodGetHeightMinMaxWithoutPosition 
Public methodGetHeightWithoutPosition 
Public methodGetHoleObjects 
Public methodGetLayerInfoByPosition 
Public methodGetLayersInfoByPosition(Vector2) 
Public methodGetLayersInfoByPosition(Vector2, ListTerrainLayersInfoByPositionItem) 
Public methodGetMaskIndexByPosition(Vector2) 
Public methodGetMaskIndexByPosition(Vector2) 
Public methodGetNormal(Vector2) 
Public methodGetNormal(Vector2I) 
Public methodGetPaintMaskSizeInteger 
Public methodGetPathFromParent Returns the path to the object from the parent.
(Inherited from Component)
Public methodGetPathFromRoot Returns the object's access path from the root object.
(Inherited from Component)
Public methodGetPositionByRay 
Public methodGetPositionXY 
Public methodGetPositionXYByMaskIndex 
Public methodGetProvidedType Returns a type when the object is used as a type.
(Inherited from Component)
Public methodGetScreenLabelInfo
(Inherited from Component)
Public methodStatic memberGetTerrainByMeshInSpace 
Public methodStatic memberGetTerrainByRay 
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsMethodInvoking Checks if a method is running over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component)
Public methodStatic memberLoadHeightmapBuffer 
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodMetadataGetMemberBySignature Returns the object metadata member by name.
(Inherited from Component)
Public methodMetadataGetMembers Returns the object metadata members.
(Inherited from Component)
Public methodMethodInvoke Calls a method by name.
(Inherited from Component)
Public methodMethodInvokeCancel Cancels the execution of selected method that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component)
Public methodMethodInvokeCancelAll Cancels the execution of all methods that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
(Inherited from Component)
Public methodNetworkDisablePropertySynchronization
(Inherited from Component)
Public methodNetworkIsDisabledPropertySynchronization
(Inherited from Component)
Public methodNetworkModeAddUser
(Inherited from Component)
Public methodNetworkModeIsEnabledForUser
(Inherited from Component)
Public methodNetworkModeRemoveUser
(Inherited from Component)
Public methodNetworkRestoreDisabledPropertySynchronization
(Inherited from Component)
Public methodNewObjectSetDefaultConfiguration Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component)
Public methodNewObjectSetDefaultConfigurationUpdate Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component)
Protected methodOnAddedToParent Called when a component is added to the parent.
(Inherited from Component)
Protected methodOnClientConnectedAfterRootComponentEnabled
(Inherited from Component)
Protected methodOnClientConnectedBeforeRootComponentEnabled
(Overrides ComponentOnClientConnectedBeforeRootComponentEnabled(ServerNetworkService_ComponentsClientItem))
Protected methodOnClientDisconnected
(Inherited from Component)
Protected methodOnClone
(Overrides ComponentOnClone(MetadataCloneContext, Component))
Protected methodOnComponentAdded Called when a child component is added.
(Inherited from Component)
Protected methodOnComponentRemoved Called when a child component is removed.
(Inherited from Component)
Protected methodOnDisabled Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component)
Protected methodOnDisabledInSimulation Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component)
Protected methodOnDispose Called when the object is disposed.
(Inherited from Component)
Protected methodOnEditorGetTextInfoCenterBottomCorner
(Inherited from Component)
Protected methodOnEnabled Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component)
Protected methodOnEnabledChanged Called when value of Enabled property is changed.
(Inherited from Component)
Protected methodOnEnabledInHierarchyChanged
(Overrides ComponentOnEnabledInHierarchyChanged)
Protected methodOnEnabledInSimulation Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component)
Protected methodOnLoad
(Overrides ComponentOnLoad(MetadataLoadContext, TextBlock, String))
Protected methodOnMetadataGetMemberBySignature Called when the object metadata member is received by name.
(Inherited from Component)
Protected methodOnMetadataGetMembers Called upon receipt of the object's metadata members.
(Inherited from Component)
Protected methodOnMetadataGetMembersFilter
(Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean))
Protected methodOnPreloadResources Called when preloading the resources used by the object.
(Inherited from Component)
Protected methodOnReceiveNetworkMessageFromClient
(Inherited from Component)
Protected methodOnReceiveNetworkMessageFromServer
(Overrides ComponentOnReceiveNetworkMessageFromServer(String, ArrayDataReader))
Protected methodOnRemovedFromParent Called when a component is removed from the parent.
(Inherited from Component)
Protected methodOnSave
(Overrides ComponentOnSave(MetadataSaveContext, TextBlock, Boolean, String))
Protected methodOnSimulationStep Called during the simulation step.
(Inherited from Component)
Protected methodOnSimulationStepClient Called during the simulation step.
(Inherited from Component)
Protected methodOnUpdate
(Overrides ComponentOnUpdate(Single))
Public methodPreloadResources Preload resources used by the object.
(Inherited from Component)
Public methodPropertyGet(String, Object, Boolean) Gets the value of a property by name.
(Inherited from Component)
Public methodPropertySet Sets the value of a property by name.
(Inherited from Component)
Public methodRemoveAllComponents Removes all child components.
(Inherited from Component)
Public methodRemoveComponent Removes a child component.
(Inherited from Component)
Public methodRemoveFromParent Detaches the object from its parent.
(Inherited from Component)
Public methodSaveHeightmapBuffer 
Public methodSetHeightWithoutPosition 
Public methodSetNeedUpdateAllTiles 
Public methodSetNeedUpdateTilesByCellIndices 
Public methodSetNeedUpdateTilesByMaskIndices 
Public methodToString Returns the name and type of the object as a string.
(Inherited from Component)
Public methodTypeSettingsIsPublic Checks whether the object provided as a type is public.
(Inherited from Component)
Public methodTypeSettingsIsPublicMember Checks whether the member is set up as public.
(Inherited from Component)
Public methodUpdateRenderingAndCollisionData 
Public methodUpdateTiles 
Top
Events
 NameDescription
Public eventAddedToParent Occurs when a component is added to the parent.
(Inherited from Component)
Public eventCastShadowsChangedOccurs when the CastShadows property value changes.
Public eventCloneEvent Occurs when object is cloned.
(Inherited from Component)
Public eventCloneSupportChanged Occurs after changing value of CloneSupport property.
(Inherited from Component)
Public eventCollisionChangedOccurs when the Collision property value changes.
Public eventCollisionFrictionChangedOccurs when the CollisionFriction property value changes.
Public eventCollisionMaterialChangedOccurs when the CollisionMaterial property value changes.
Public eventCollisionRestitutionChangedOccurs when the CollisionRestitution property value changes.
Public eventComponentAdded Occurs when a child component is added.
(Inherited from Component)
Public eventComponentRemoved Occurs when a child component is removed.
(Inherited from Component)
Public eventComponentsChanged Occurs when the set of children is changed.
(Inherited from Component)
Public eventDebugDrawSurfaceObjectsBoundsChangedOccurs when the DebugDrawSurfaceObjectsBounds property value changes.
Public eventDisabledEvent Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component)
Public eventDisabledInSimulation Occurs when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component)
Public eventDisplayInEditorChanged Occurs when value of DisplayInEditor property is changed.
(Inherited from Component)
Public eventDisposeEvent Occurs when the object is disposed.
(Inherited from Component)
Public eventEnabledChanged Occurs when the Enabled property value changes.
(Inherited from Component)
Public eventEnabledEvent Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component)
Public eventEnabledInHierarchyChanged Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component)
Public eventEnabledInSimulation Occurs when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
(Inherited from Component)
Public eventGetHeightWithoutPositionOverride 
Public eventHeightmapSizeChangedOccurs when the HeightmapSize property value changes.
Public eventHolesChanged 
Public eventHolesEnabledChangedOccurs when the HolesEnabled property value changes.
Public eventHorizontalSizeChangedOccurs when the HorizontalSize property value changes.
Public eventLoadEvent Occurs during object loading.
(Inherited from Component)
Public eventLODCountChangedOccurs when the LODCount property value changes.
Public eventLODDistanceChangedOccurs when the LODDistance property value changes.
Public eventLODEnabledChangedOccurs when the LODEnabled property value changes.
Public eventMaterialChangedOccurs when the Material property value changes.
Public eventMaterialColorChangedOccurs when the MaterialColor property value changes.
Public eventMaterialUV0ChangedOccurs when the MaterialUV0 property value changes.
Public eventMaterialUV1ChangedOccurs when the MaterialUV1 property value changes.
Public eventMaterialUVCurvatureFrequencyChangedOccurs when the MaterialUVCurvatureFrequency property value changes.
Public eventMaterialUVCurvatureIntensityChangedOccurs when the MaterialUVCurvatureIntensity property value changes.
Public eventMetadataGetMemberBySignatureEvent Occurs when the object metadata member is received by name.
(Inherited from Component)
Public eventMetadataGetMembersEvent Occurs upon receipt of the object's metadata members.
(Inherited from Component)
Public eventMetadataGetMembersFilterEvent Occurs when filtering receive members of the object metadata.
(Inherited from Component)
Public eventMotionBlurFactorChangedOccurs when the MotionBlurFactor property value changes.
Public eventNameChanged Occurs when component name is changed.
(Inherited from Component)
Public eventNetworkModeChangedOccurs when the NetworkMode property value changes.
(Inherited from Component)
Public eventOccluderChangedOccurs when the Occluder property value changes.
Public eventPaintMaskSizeChangedOccurs when the PaintMaskSize property value changes.
Public eventPositionChangedOccurs when the Position property value changes.
Public eventPrecalculateObjectsChangedOccurs when the PrecalculateObjects property value changes.
Public eventPreloadResourcesEvent Occurs when preloading the resources used by the object.
(Inherited from Component)
Public eventReceiveDecalsChangedOccurs when the ReceiveDecals property value changes.
Public eventReceiveNetworkMessageFromClient
(Inherited from Component)
Public eventReceiveNetworkMessageFromServer
(Inherited from Component)
Public eventRemovedFromParent Occurs when a component is removed from the parent.
(Inherited from Component)
Public eventSaveEvent Occurs during object saving.
(Inherited from Component)
Public eventSaveSupportChanged Occurs after changing value of SaveSupport property.
(Inherited from Component)
Public eventScreenLabelChangedOccurs when the ScreenLabel property value changes.
(Inherited from Component)
Public eventSimulationStep Occurs during the simulation step.
(Inherited from Component)
Public eventSimulationStepClient Occurs during the simulation step.
(Inherited from Component)
Public eventSurfaceChangedOccurs when the Surface property value changes.
Public eventSurfaceObjectsCastShadowsChangedOccurs when the SurfaceObjectsCastShadows property value changes.
Public eventSurfaceObjectsChangedOccurs when the SurfaceObjects property value changes.
Public eventSurfaceObjectsCollisionChangedOccurs when the SurfaceObjectsCollision property value changes.
Public eventSurfaceObjectsColorChangedOccurs when the SurfaceObjectsColor property value changes.
Public eventSurfaceObjectsDistributionChangedOccurs when the SurfaceObjectsDistribution property value changes.
Public eventSurfaceObjectsScaleChangedOccurs when the SurfaceObjectsScale property value changes.
Public eventSurfaceObjectsVisibilityDistanceFactorChangedOccurs when the SurfaceObjectsVisibilityDistanceFactor property value changes.
Public eventTileSizeChangedOccurs when the TileSize property value changes.
Public eventUpdateEvent Occurs during the update process of all objects.
(Inherited from Component)
Public eventVisibleChangedOccurs when the Visible property value changes.
Top
Extension Methods
 NameDescription
Public Extension MethodMethodInvoke Calls the object method by name.
(Defined by ObjectEx)
Public Extension MethodPropertyGet Gets the value of the object property by name.
(Defined by ObjectEx)
Public Extension MethodPropertyGetT Gets the value of the object property by name.
(Defined by ObjectEx)
Public Extension MethodPropertySet Sets the value of the object property by name.
(Defined by ObjectEx)
Top
See Also