Class Heightmap
Class representing a heightmap
Inherited Members
Namespace: DuetAPI.Utility
Assembly: DuetAPI.dll
Syntax
public sealed class HeightmapRemarks
This class is no longer used in DSF. Also note that the heightmap format is now slightly different
Properties
NumX
Number of probe points in X direction
Declaration
public int NumX { get; set; }Property Value
| Type | Description |
|---|---|
| int |
NumY
Number of probe points in Y direction
Declaration
public int NumY { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Radius
Probing radius on delta geometries
Declaration
public float Radius { get; set; }Property Value
| Type | Description |
|---|---|
| float |
XMax
X end coordinate of the heightmap
Declaration
public float XMax { get; set; }Property Value
| Type | Description |
|---|---|
| float |
XMin
X start coordinate of the heightmap
Declaration
public float XMin { get; set; }Property Value
| Type | Description |
|---|---|
| float |
XSpacing
Spacing between the probe points in X direction
Declaration
public float XSpacing { get; set; }Property Value
| Type | Description |
|---|---|
| float |
YMax
Y end coordinate of the heightmap
Declaration
public float YMax { get; set; }Property Value
| Type | Description |
|---|---|
| float |
YMin
Y start coordinate of the heightmap
Declaration
public float YMin { get; set; }Property Value
| Type | Description |
|---|---|
| float |
YSpacing
Spacing between the probe points in Y direction
Declaration
public float YSpacing { get; set; }Property Value
| Type | Description |
|---|---|
| float |
ZCoordinates
Z coordinate of each probe point
Declaration
public float[] ZCoordinates { get; set; }Property Value
| Type | Description |
|---|---|
| float[] |
Methods
Load(string)
Load a new heightmap from the given CSV file
Declaration
public Task Load(string filename)Parameters
| Type | Name | Description |
|---|---|---|
| string | filename | Path to the file |
Returns
| Type | Description |
|---|---|
| Task | Asynchronous task |
Exceptions
| Type | Condition |
|---|---|
| IOException | Invalid file |
Save(string)
Save a heightmap to the given CSV file
Declaration
public Task Save(string filename)Parameters
| Type | Name | Description |
|---|---|---|
| string | filename | Filename of the heightmap |
Returns
| Type | Description |
|---|---|
| Task | Asynchronous task |