Class ToolRetraction

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Tool retraction parameters

public class ToolRetraction : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged

Inheritance

object

ModelObject

ToolRetraction

Implements

INotifyPropertyChanging

IStaticModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Inherited Members

ModelObject.SetPropertyValue<T>(ref T, T, string)

ModelObject.PropertyChanging

ModelObject.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ToolRetraction()

public ToolRetraction()

Properties

ExtraRestart

Amount of additional filament to extrude when undoing a retraction (in mm)

public float ExtraRestart { get; set; }

Property Value

float

Length

Retraction length (in mm)

public float Length { get; set; }

Property Value

float

Speed

Retraction speed (in mm/s)

public float Speed { get; set; }

Property Value

float

UnretractSpeed

Unretract speed (in mm/s)

public float UnretractSpeed { get; set; }

Property Value

float

ZHop

Amount of Z lift after doing a retraction (in mm)

public float ZHop { get; set; }

Property Value

float

Methods

Assign(IStaticModelObject)

Assign the properties from another instance. This is required to update model properties which do not have a setter

public void Assign(IStaticModelObject from)

Parameters

from IStaticModelObject

Other instance

Clone()

Clone this instance

public object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

UpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data