Class Heightmap

Namespace

DuetAPI.Utility

Assembly

DuetAPI.dll

Class representing a heightmap

public sealed class Heightmap

Inheritance

object

Heightmap

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This class is no longer used in DSF. Also note that the heightmap format is now slightly different

Constructors

Heightmap()

public Heightmap()

Properties

NumX

Number of probe points in X direction

public int NumX { get; set; }

Property Value

int

NumY

Number of probe points in Y direction

public int NumY { get; set; }

Property Value

int

Radius

Probing radius on delta geometries

public float Radius { get; set; }

Property Value

float

XMax

X end coordinate of the heightmap

public float XMax { get; set; }

Property Value

float

XMin

X start coordinate of the heightmap

public float XMin { get; set; }

Property Value

float

XSpacing

Spacing between the probe points in X direction

public float XSpacing { get; set; }

Property Value

float

YMax

Y end coordinate of the heightmap

public float YMax { get; set; }

Property Value

float

YMin

Y start coordinate of the heightmap

public float YMin { get; set; }

Property Value

float

YSpacing

Spacing between the probe points in Y direction

public float YSpacing { get; set; }

Property Value

float

ZCoordinates

Z coordinate of each probe point

public float[] ZCoordinates { get; set; }

Property Value

float[]

Methods

Load(string)

Load a new heightmap from the given CSV file

public void Load(string filename)

Parameters

filename string

Path to the file

Exceptions

IOException

Invalid file

LoadAsync(string)

Load a new heightmap from the given CSV file asynchronously

public Task LoadAsync(string filename)

Parameters

filename string

Path to the file

Returns

Task

Asynchronous task

Exceptions

IOException

Invalid file

Save(string)

Save a heightmap to the given CSV file

public void Save(string filename)

Parameters

filename string

Filename of the heightmap

SaveAsync(string)

Save a heightmap to the given CSV file asynchronously

public Task SaveAsync(string filename)

Parameters

filename string

Filename of the heightmap

Returns

Task

Asynchronous task