Click or drag to resize

Component_Terrain Class

Heightmap based terrain.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2021.3.1.0 (2021.3.1.0)
Syntax
C#
public class Component_Terrain : Component, 
	IComponent_Terrain

The Component_Terrain type exposes the following members.

Constructors
  NameDescription
Public methodComponent_Terrain
Initializes a new instance of the Component_Terrain class
Top
Properties
  NameDescription
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 propertyCollisionAnisotropicFriction
The amount of directional friction applied on the rigid body.
Public propertyCollisionFriction
The amount of friction applied on the rigid body.
Public propertyCollisionFrictionMode
The type 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 propertyCollisionRollingFriction
The amount of friction applied when rigid body is rolling.
Public propertyCollisionSpinningFriction
The amount of friction applied when rigid body is spinning.
Public propertyColor
The base color multiplier.
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 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. See also EnabledInHierarchy property.
(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 propertyEnabledInHierarchyAndIsNotResource
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
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 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 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 propertyName
The name of the component.
(Inherited from Component.)
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 propertyReceiveDecals
Whether it is possible to apply decals 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
Sets the display of the on-screen label of the object in the scene editor.
(Inherited from Component.)
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 methodCalculateBounds
Public methodClampCellIndex
Public methodClampMaskIndex
Public methodClone
Creates a copy of the object.
(Inherited from Component.)
Public methodCreateComponent(Type, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponentT(Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodDispose
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows 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 methodGetCellIndexByPosition
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHeight(Vector2I)
Public methodGetHeight(Vector2, Boolean)
Public methodGetHeightmapSizeInteger
Public methodGetHeightMinMax
Public methodGetHeightMinMaxWithoutPosition
Public methodGetHeightWithoutPosition
Public methodGetHoleObjects
Public methodGetMaskIndexByPosition
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 memberGetTerrainByRay
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMethodInvoking (Inherited from Component.)
Protected methodMemberwiseClone
Creates 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 (Inherited from Component.)
Public methodMethodInvokeCancelAll (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 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 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 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 methodSetHeightWithoutPosition
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 methodUpdateCollisionData
Public methodUpdateRenderingAndCollisionData
Public methodUpdateRenderingData
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
(Inherited from Component.)
Public eventCastShadowsChanged
Occurs 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 eventCollisionAnisotropicFrictionChanged
Occurs when the CollisionAnisotropicFriction property value changes.
Public eventCollisionChanged
Occurs when the Collision property value changes.
Public eventCollisionFrictionChanged
Occurs when the CollisionFriction property value changes.
Public eventCollisionFrictionModeChanged
Occurs when the CollisionFrictionMode property value changes.
Public eventCollisionMaterialChanged
Occurs when the CollisionMaterial property value changes.
Public eventCollisionRestitutionChanged
Occurs when the CollisionRestitution property value changes.
Public eventCollisionRollingFrictionChanged
Occurs when the CollisionRollingFriction property value changes.
Public eventCollisionSpinningFrictionChanged
Occurs when the CollisionSpinningFriction property value changes.
Public eventColorChanged
Occurs when the Color 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 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 eventHeightmapSizeChanged
Occurs when the HeightmapSize property value changes.
Public eventHolesChanged
Public eventHolesEnabledChanged
Occurs when the HolesEnabled property value changes.
Public eventHorizontalSizeChanged
Occurs when the HorizontalSize property value changes.
Public eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventLODCountChanged
Occurs when the LODCount property value changes.
Public eventLODDistanceChanged
Occurs when the LODDistance property value changes.
Public eventLODEnabledChanged
Occurs when the LODEnabled property value changes.
Public eventMaterialChanged
Occurs when the Material property value changes.
Public eventMaterialUV0Changed
Occurs when the MaterialUV0 property value changes.
Public eventMaterialUV1Changed
Occurs when the MaterialUV1 property value changes.
Public eventMaterialUVCurvatureFrequencyChanged
Occurs when the MaterialUVCurvatureFrequency property value changes.
Public eventMaterialUVCurvatureIntensityChanged
Occurs 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 eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventPaintMaskSizeChanged
Occurs when the PaintMaskSize property value changes.
Public eventPositionChanged
Occurs when the Position property value changes.
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
(Inherited from Component.)
Public eventReceiveDecalsChanged
Occurs when the ReceiveDecals property value changes.
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 eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
(Inherited from Component.)
Public eventSimulationStep
Occurs during the simulation step.
(Inherited from Component.)
Public eventTileSizeChanged
Occurs when the TileSize property value changes.
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Public eventVisibleChanged
Occurs when the Visible property value changes.
Top
Extension Methods
See Also