orx-axidraw/org.openrndr.extra.axidraw/Axidraw

Axidraw

class Axidraw(val program: Program, paperSize: PaperSize, orientation: PaperOrientation = PaperOrientation.PORTRAIT)(source)

Class to talk to the axicli command line program

Constructors

Axidraw

constructor(program: Program, paperSize: PaperSize, orientation: PaperOrientation = PaperOrientation.PORTRAIT)

Properties

acceleration

var acceleration: Int

actualPaperSize

val actualPaperSize: Vector2

apiURL

var apiURL: String

API URL to call once plotting is complete. If the string contains [filename] it will be replaced by the name of the file being plotted. This URL should be URL encoded (for instance use %20 instead of a space).

bounds

val bounds: Rectangle

Returns the bounds of the drawable area so user code can draw things whithout leaving the paper.

camera

val camera: Camera2D

constSpeed

var constSpeed: Boolean

margin

var margin: Int

model

var model: AxidrawModel

occlusion

var occlusion: Boolean

optimization

var optimization: AxidrawOptimizationTypes

penDelayDown

var penDelayDown: Int

var penDelayUp: Int

var penPosDown: Int

var penPosUp: Int

var penRateLower: Int

penRateRaise

var penRateRaise: Int

preview

var preview: Boolean

program

val program: Program

randomStart

var randomStart: Boolean

servo

var servo: AxidrawServo

speedPenDown

var speedPenDown: Int

speedPenUp

var speedPenUp: Int

svg

var svg: String

Read-only String variable to inspect the current design in SVG format for debugging purposes.

webhook

var webhook: Boolean

Functions

clear

fun clear(): Unit?

Clears the current design wiping any shapes the user might have added.

display

fun display(drawer: Drawer)

Display the composition using drawer.

draw

fun draw(f: CompositionDrawer.() -> Unit)

The core method that allows the user to append content to the design. Use any methods and properties like contour(), segment(), fill, stroke, etc.

goHome

fun goHome()

After hitting pause, use this to move the pen home

groupStrokeColors

fun groupStrokeColors()

Rebuilds the design putting shapes under groups based on stroke colors and inserts a pause after each group.

onLoad

fun onLoad()

onPlot

fun onPlot()

Plot design using the current settings

onSave

fun onSave()

Save current design as SVG

resizeWindow

fun resizeWindow(ppi: Double = 96.0)

Resizes the program window to match the paper size according to the ppi (Pixels Per Inch) value.

resume

fun resume()

After hitting pause, use this to continue plotting

setupAxidrawCli

fun setupAxidrawCli()

sysInfo

fun sysInfo()

Display Axidraw system info

toggleUpDown

fun toggleUpDown()

Toggle the pen up/down state by powering the pen plotter servo. Useful for calibrating the pen height. Cover the paper with a plastic sheet before running this command to avoid accidentally leaving ink on the paper.

version

fun version()

Display Axidraw software version