 | |
Height | |
HeightMapContoursNode class is used to render the contour lines that is defined by the HeightMapSurfaceNode.
Inheritance HierarchySystemObject
Ab4d.SharpEngine.CoreComponentBase
Ab4d.SharpEngine.CoreInitializedSceneComponent
Ab4d.SharpEngine.SceneNodesSceneNode
Ab4d.SharpEngine.SceneNodesGroupNode
Ab4d.SharpEngine.SceneNodesHeightMapContoursNode
Ab4d.SharpEngine.CoreComponentBase
Ab4d.SharpEngine.CoreInitializedSceneComponent
Ab4d.SharpEngine.SceneNodesSceneNode
Ab4d.SharpEngine.SceneNodesGroupNode
Ab4d.SharpEngine.SceneNodesHeightMapContoursNode
Namespace: Ab4d.SharpEngine.SceneNodes
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 4.0.9584+ba1aaa26d4181dd3fa8ed7b6398391d1affa36c8
SyntaxC#
public class HeightMapContoursNode : GroupNode
The HeightMapContoursNode type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HeightMapContoursNode(String) | Creates a new HeightMapContoursNode |
| HeightMapContoursNode(HeightMapSurfaceNode, String) | Creates a new HeightMapContoursNode that will use the CenterPosition, Size and HeightData values from the parent HeightMapSurfaceNode. |
| HeightMapContoursNode(HeightMapSurfaceNode, Int32, Int32, Single, Boolean, String) | Creates a new HeightMapContoursNode that will use the CenterPosition, Size and HeightData values from the parent HeightMapSurfaceNode. |
| HeightMapContoursNode(HeightMapSurfaceNode, Single, Int32, Single, Boolean, String) | Creates a new HeightMapContoursNode that will use the CenterPosition, Size and HeightData values from the parent HeightMapSurfaceNode. |
| HeightMapContoursNode(Vector3, Vector3, Single, Int32, Int32, Single, Boolean, String) | Creates a new HeightMapContoursNode |
| HeightMapContoursNode(Vector3, Vector3, Single, Single, Int32, Single, Boolean, String) | Creates a new HeightMapContoursNode |
Properties| Name | Description | |
|---|---|---|
 | CenterPosition | Center position of the height map surface Default value is (0, 0, 0). |
| CombineContourLines | Combine contour lines into a single MultiLineNode. If enabled, one MultiLineNode is created for all minor lines and one for all major lines (if available). If disabled, each contour line is created as its own MultiLineNode. |
| ContourHeights | Array of heights for which contour lines should be generated. When null (the default), NumContourLines contour lines are be generated in the height range spanned by the height map data, with N being controlled by the NumContourLines property. |
| GetCustomLineColorCallback | Gets or sets the callback function used to determine the custom line color based on contour line height value. This is called only when CombineContourLinesis set to false (by default)./> |
| GetCustomLineThicknessCallback | Gets or sets the callback function used to determine the custom line thickness based on contour line height value. This is called only when CombineContourLinesis set to false (by default)./> |
| HeightData | 2D array defining the height data. The dimensions of array also determine the size of the mesh (scaled by the X and Z components of the Size property). If no height data is provided, a rectangle is generated. Default value is null (no height data available). |
| MajorLineColor | Color of major contour lines. Default color is black. |
| MajorLinesFrequency | The frequency of major contour lines, in terms of minor contour lines (i.e., how many minor lines until next major one). When set to 0 or less, the major contour lines are not drawn and all contour lines are minor lines. Default value is 0. |
| MajorLineThickness | Thickness of major contour lines. Default value is 2.0 (set by public static DefaultMajorLineThickness). |
| MinorLineColor | Color of minor contour lines. Default color is black. |
| MinorLineThickness | Thickness of minor contour lines. Default value is 1.0 (set by public static DefaultMinorLineThickness). |
| NumContourLines | Number of contour lines to generate from the height data when contour line heights (the ContourHeights property) are not specified. Default value is 10. |
| ParentSurfaceNode | |
| Size | Size of the surface. X and Z components scale the 2D shape's width and height, while Y component scales the height values. Default value is (1, 1, 1) |
| VerticalOffset | Offset applied to the contour lines in the vertical (Y) direction, to avoid strict overlap with surface generated from the same height data. Default value is 0.001. |
Methods| Name | Description | |
|---|---|---|
| ConvertDataToMeshHeightValue | |
| ConvertMeshToDataHeightValue | |
| CreateContourLine(Single, Single, Boolean) | Returns a list of positions that represents the contour line segments at the specified height for the height map specified by the ParentSurfaceNode or HeightData. |
 | CreateContourLine(StandardMesh, Single, Single) | Returns a list of positions that represents the contour line segments at the specified height for the specified mesh. |
| CreateContourLine(PositionNormalTextureVertex, Int32, Single, Single) | Returns a list of positions that represents the contour line segments at the specified height for the mesh specified by the vertices and triangleIndices. |
| CreateContourLine(Vector3, Int32, Single, Single) | Returns a list of positions that represents the contour line segments at the specified height for the mesh specified by the positions and triangleIndices. |
| CreateContourLines(Single, Single, Boolean) | Generates contour line segments on multiple contour heights for the height map specified by the ParentSurfaceNode or HeightData. |
| CreateContourLines(StandardMesh, Single, Single) | Generates contour line segments for the specified mesh on multiple contour heights. |
| CreateContourLines(PositionNormalTextureVertex, Int32, Single, Single) | Generates contour line segments for a mesh based on multiple contour heights. |
| CreateContourLines(Vector3, Int32, Single, Single) | Generates contour line segments for a mesh based on specified contour heights and an optional vertical offset. |
 | Dispose | (Overrides GroupNodeDispose(Boolean)) |
| FlattenContours | Sets the Y-coordinate of all contour line positions to a specified fixed height. To disable flatting, set fixedHeightValue to float.NaN. |
| GetAvailableLineHeights | Retrieve a list of available contour line heights that can be used with GetLineNode. Returns null if CombineContourLines is enabled. |
| GetLineNode | Retrieve the MultiLineNode corresponding to the contour line with the specified height. The height must be one of the values returned by GetAvailableLineHeights(). Returns null if contour line with the specified height does not exist. Returns null if CombineContourLines is enabled; in that case, nodes for combined lines can be retrieved via GetMajorLinesNode and GetMinorLinesNode. |
| GetMajorLinesNode | Retrieve the MultiLineNode corresponding to combined major contour lines. Returns null if CombineContourLines is disabled, or if no major lines are available. |
| GetMinorLinesNode | Retrieve the MultiLineNode corresponding to combined minor contour lines. Returns null if CombineContourLines is disabled, or if no major lines are available. |
| OnUpdate | (Overrides SceneNodeOnUpdate) |
| UpdateLocalBoundingBox | (Overrides GroupNodeUpdateLocalBoundingBox) |
Fields| Name | Description | |
|---|---|---|
 | DefaultMajorLineThickness | |
| DefaultMinorLineThickness |
Extension Methods| Name | Description | |
|---|---|---|
 | DumpHierarchy |
Writes the hierarchy of the GroupNode and its children into the Visual Studio Output window.
(Defined by Extensions) |
See Also