Click or drag to resize
Ab4d.SharpEngine logo

HeightMapContoursNode Class

HeightMapContoursNode class is used to render the contour lines that is defined by the HeightMapSurfaceNode.
Inheritance Hierarchy

Namespace: Ab4d.SharpEngine.SceneNodes
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
Syntax
C#
Copy
public class HeightMapContoursNode : GroupNode

The HeightMapContoursNode type exposes the following members.

Constructors
 NameDescription
Public methodHeightMapContoursNode(String)Initializes a new instance of the HeightMapContoursNode class
Public methodHeightMapContoursNode(HeightMapSurfaceNode, String) Creates a new HeightMapContoursNode that will use the CenterPosition, Size and HeightData values from the parent HeightMapSurfaceNode.
Public methodHeightMapContoursNode(Vector3, Vector3, Single, String)Initializes a new instance of the HeightMapContoursNode class
Top
Properties
 NameDescription
Public propertyCenterPosition Center position of the height map surface Default value is (0, 0, 0).
Public propertyCombineContourLines 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.
Public propertyContourHeights Array of heights for which contour lines should be generated. If set to null (the default), N contour lines are be generated in the height range spanned by the height map data, with N being controlled by the NumContourLines property.
Public propertyHeightData 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).
Public propertyMajorLineColor Color of major contour lines. Default color is black.
Public propertyMajorLinesFrequency 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.
Public propertyMajorLineThickness Thickness of major contour lines. Default value is 2.0 (set by public static DefaultMajorLineThickness).
Public propertyMinorLineColor Color of minor contour lines. Default color is black.
Public propertyMinorLineThickness Thickness of minor contour lines. Default value is 1.0 (set by public static DefaultMinorLineThickness).
Public propertyNumContourLines Number of contour lines to generate from the height data when contour line heights (the ContourHeights property) are not specified. Default value is 10.
Public propertyParentSurfaceNode 
Public propertySize 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)
Public propertyVerticalOffset 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.
Top
Methods
 NameDescription
Protected methodDispose
(Overrides GroupNodeDispose(Boolean))
Public methodGetAvailableLineHeights Retrieve a list of available contour line heights that can be used with GetLineNode. Returns null if CombineContourLines is enabled.
Public methodGetLineNode 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.
Public methodGetMajorLinesNode Retrieve the MultiLineNode corresponding to combined major contour lines. Returns null if CombineContourLines is disabled, or if no major lines are available.
Public methodGetMinorLinesNode Retrieve the MultiLineNode corresponding to combined minor contour lines. Returns null if CombineContourLines is disabled, or if no major lines are available.
Protected methodOnUpdate
(Overrides SceneNodeOnUpdate)
Top
Fields
Extension Methods
 NameDescription
Public Extension MethodDumpHierarchy Dumps the hierarchy of the GroupNode and its children.
(Defined by Extensions)
Top
See Also