 | TerrainRoadPathKey Class |
Inheritance HierarchyDigitalRune.Mathematics.InterpolationCurveKeySingle, Vector3F
DigitalRune.Mathematics.InterpolationPathKey3F
DigitalRune.GraphicsTerrainRoadPathKey
Namespace: DigitalRune.Graphics
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)
SyntaxThe TerrainRoadPathKey type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TerrainRoadPathKey |
Initializes a new instance of the TerrainRoadPathKey class.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetParameter |
Gets the parameter.
(Inherited from PathKey3F.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetParameter |
Sets the parameter.
(Inherited from PathKey3F.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | Interpolation |
Gets or sets the type of interpolation (the spline type) used for the current curve segment
between this key and the next key.
(Inherited from CurveKeyTParam, TPoint.) |
| Parameter |
Gets or sets a value that defines where this curve key is positioned on the curve.
(Inherited from CurveKeyTParam, TPoint.) |
| Point |
Gets or sets the curve point for this curve key.
(Inherited from CurveKeyTParam, TPoint.) |
| SideFalloff |
Gets or sets the side falloff.
|
| TangentIn |
Gets or sets the incoming tangent or the control point before this curve key.
(Inherited from CurveKeyTParam, TPoint.) |
| TangentOut |
Gets or sets the outgoing tangent or the control point after this curve key.
(Inherited from CurveKeyTParam, TPoint.) |
| Width |
Gets or sets the width of the road.
|
RemarksRoads (see TerrainRoadLayer) are usually defined by 3D paths. A 3D path is a curve which goes through several path keys. Each path key defines a point on the curve and the spline interpolation between the point and the next point. When dealing with roads, you can use the TerrainRoadPathKey class for the path keys to provide additional information.
Width defines the absolute with of the road at the path key. SideFalloff defines an additional border of the road where the road influences the terrain height. This property is used when the road is "carved" into a terrain (see ClampTerrainToRoad(HeightField, Path3F, Single, Single, Int32, Single). For example, if a road with a width of 5 and a side falloff of 4 is carved into a terrain, the center 5 units contain the actual road and the terrain height is adjusted to match the road. The terrain height next to the road is interpolated between the original height and the road. The total width of the terrain influenced by the road is SideFalloff (left) + Width + SideFalloff (right) = 13 units.
See Also