GCodeAPI.GCodeSpecial Class Reference
Inheritance diagram for GCodeAPI.GCodeSpecial:
GCodeAPI.IGCode

Public Types

enum  Axis { X, Y, Z, E }
 Enum of axis. More...
 

Public Member Functions

override string ToString ()
 Returns the g-code string. More...
 
IGCode Duplicate ()
 Return a deep copy of the object. More...
 

Static Public Member Functions

static GCodeSpecial setInchValues ()
 Sets units to inches. More...
 
static GCodeSpecial setMetricValues ()
 Sets units to millimeters. More...
 
static GCodeSpecial setAbsolutePositionMode ()
 Sets to absolute positioning. More...
 
static GCodeSpecial setRelavitvePositionMode ()
 Sets to relative positioning. More...
 
static GCodeSpecial setExtruderAbsoluteMode ()
 Sets extruder to absolute mode. More...
 
static GCodeSpecial setExtruderRelativeMode ()
 Sets extruder to relative mode. More...
 
static GCodeSpecial FanOff ()
 Sets fan off. More...
 
static IGCode ResetToZ (double value)
 Sets absolute zero position on the Z axis. More...
 
static IGCode ResetToExtrude (double value)
 Sets absolute zero position of extruder. More...
 
static IGCode HeaterAndWait (double temperature)
 Sets extruder temperature and wait. More...
 
static GCodeSpecial HeaterOff ()
 Turns off heater. More...
 
static GCodeSpecial StepperOff ()
 Turns off motors. More...
 
static double ExtrudeCircle (double radius)
 Returns the necessary extruding length. More...
 
static double ExtrudeLine (double length)
 Returns the necessary extruding length. More...
 
static double ExtrudeLine (double x1, double y1, double x2, double y2)
 Returns the necessary extruding length. More...
 
static double ExtrudeLine (Point p1, Point p2)
 Returns the necessary extruding length. More...
 
static IGCode FanOn (double speed)
 Sets speed of the fan. More...
 
static IGCode GoToHome (bool x=false, bool y=false, bool z=false)
 Goes to home specified axis. More...
 

Static Public Attributes

static double ExtrudeRatio = 0.009d
 Default extruding ratio. More...
 

Properties

string Name [get]
 Returns the name of IGCode. More...
 
- Properties inherited from GCodeAPI.IGCode
string Name [get]
 Returns the name of IGCode More...
 

Member Enumeration Documentation

◆ Axis

Enum of axis.

Member Function Documentation

◆ Duplicate()

IGCode GCodeAPI.GCodeSpecial.Duplicate ( )

Return a deep copy of the object.

Returns

Implements GCodeAPI.IGCode.

◆ ExtrudeCircle()

static double GCodeAPI.GCodeSpecial.ExtrudeCircle ( double  radius)
static

Returns the necessary extruding length.

Parameters
radiusradius of circle
Returns

◆ ExtrudeLine() [1/3]

static double GCodeAPI.GCodeSpecial.ExtrudeLine ( double  length)
static

Returns the necessary extruding length.

Parameters
lengthlength of line
Returns

◆ ExtrudeLine() [2/3]

static double GCodeAPI.GCodeSpecial.ExtrudeLine ( double  x1,
double  y1,
double  x2,
double  y2 
)
static

Returns the necessary extruding length.

Parameters
x1X position of Start point
y1Y position of Start point
x2X position of End point
y2Y position of End point
Returns

◆ ExtrudeLine() [3/3]

static double GCodeAPI.GCodeSpecial.ExtrudeLine ( Point  p1,
Point  p2 
)
static

Returns the necessary extruding length.

Parameters
p1Start point
p2End Point
Returns

◆ FanOff()

static GCodeSpecial GCodeAPI.GCodeSpecial.FanOff ( )
static

Sets fan off.

Returns

◆ FanOn()

static IGCode GCodeAPI.GCodeSpecial.FanOn ( double  speed)
static

Sets speed of the fan.

Parameters
speed0-255 value
Returns

◆ GoToHome()

static IGCode GCodeAPI.GCodeSpecial.GoToHome ( bool  x = false,
bool  y = false,
bool  z = false 
)
static

Goes to home specified axis.

Parameters
xGoes to home on X axis
yGoes to home on Y axis
zGoes to home on Z axis
Returns

◆ HeaterAndWait()

static IGCode GCodeAPI.GCodeSpecial.HeaterAndWait ( double  temperature)
static

Sets extruder temperature and wait.

Parameters
temperaturetemperature in Celsius
Returns

◆ HeaterOff()

static GCodeSpecial GCodeAPI.GCodeSpecial.HeaterOff ( )
static

Turns off heater.

Returns

◆ ResetToExtrude()

static IGCode GCodeAPI.GCodeSpecial.ResetToExtrude ( double  value)
static

Sets absolute zero position of extruder.

Parameters
value
Returns

◆ ResetToZ()

static IGCode GCodeAPI.GCodeSpecial.ResetToZ ( double  value)
static

Sets absolute zero position on the Z axis.

Parameters
value
Returns

◆ setAbsolutePositionMode()

static GCodeSpecial GCodeAPI.GCodeSpecial.setAbsolutePositionMode ( )
static

Sets to absolute positioning.

Returns

◆ setExtruderAbsoluteMode()

static GCodeSpecial GCodeAPI.GCodeSpecial.setExtruderAbsoluteMode ( )
static

Sets extruder to absolute mode.

Returns

◆ setExtruderRelativeMode()

static GCodeSpecial GCodeAPI.GCodeSpecial.setExtruderRelativeMode ( )
static

Sets extruder to relative mode.

Returns

◆ setInchValues()

static GCodeSpecial GCodeAPI.GCodeSpecial.setInchValues ( )
static

Sets units to inches.

Returns

◆ setMetricValues()

static GCodeSpecial GCodeAPI.GCodeSpecial.setMetricValues ( )
static

Sets units to millimeters.

Returns

◆ setRelavitvePositionMode()

static GCodeSpecial GCodeAPI.GCodeSpecial.setRelavitvePositionMode ( )
static

Sets to relative positioning.

Returns

◆ StepperOff()

static GCodeSpecial GCodeAPI.GCodeSpecial.StepperOff ( )
static

Turns off motors.

Returns

◆ ToString()

override string GCodeAPI.GCodeSpecial.ToString ( )

Returns the g-code string.

Returns

Member Data Documentation

◆ ExtrudeRatio

double GCodeAPI.GCodeSpecial.ExtrudeRatio = 0.009d
static

Default extruding ratio.

Property Documentation

◆ Name

string GCodeAPI.GCodeSpecial.Name
get

Returns the name of IGCode.


The documentation for this class was generated from the following file: