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

Axidraw

class Axidraw(program: Program, val paperSizeInMm: Vector2, val drawBounds: Rectangle = program.drawer.bounds, fit: Vector2 = Vector2.ZERO)(source)

Class for working with Axidraw pen plotters. It communicates with the axicli command line program, which is installed automatically using Python. Provides an extensive GUI to configure the pen plotter, to save and load designs, preview them, layout designs using a Camera2D, plot, resume and more.

Parameters

fit

A Vector 2 specifying where inside drawBounds to draw the plot simulation. The default is Vector2.ZERO, which means centered. Use values between -1.0 and 1.0 for aligning to the left/top or to the right/bottom of drawBounds.

Constructors

Axidraw

constructor(program: Program, paperSizeInMm: Vector2, drawBounds: Rectangle = program.drawer.bounds, fit: Vector2 = Vector2.ZERO)

Properties

acceleration

var acceleration: Int

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).

autoRotate

var autoRotate: Boolean

bounds

val bounds: Rectangle

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

camera

val camera: Camera2D

An interactive camera you can use to position your design in the paper. Allows panning, scaling and rotating.

constSpeed

var constSpeed: Boolean

drawBounds

val drawBounds: Rectangle

A Rectangle specifying the window area where to draw the plot simulation. The default is drawer.bounds.

margin

var margin: Int

model

var model: AxidrawModel

occlusion

var occlusion: Boolean

oneMm

val oneMm: Double

Returns the length of one millimeter in the drawing assuming the camera has not been zoomed in or out

optimization

var optimization: AxidrawOptimizationTypes

paperSizeInMm

val paperSizeInMm: Vector2

A Vector2 specifying the paper size in mm. For convenient a constant like PaperSize.A5.size can be used.

penDelayDown

var penDelayDown: Int

var penDelayUp: Int

var penPosDown: Int

var penPosUp: Int

var penRateLower: Int

penRateRaise

var penRateRaise: Int

plotPaused

var plotPaused: Boolean

Becomes true when pressing the hardware pause button on the Axidraw, resets to false after a successful plot or by calling goHome or resume.

preview

var preview: Boolean

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

centerOnPaper

fun centerOnPaper()

Pans the camera to center items found in the current design.

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. Call this method from inside your extend {} block.

draw

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

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

goHome

fun goHome(): ExecutionResult

After hitting pause, use this to move the pen home

groupStrokeColors

fun groupStrokeColors(): List<ColorRGBa>

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

onLoad

fun onLoad()

Show a file-selector dialog to load an SVG file, then loads the content of the selected SVG file.

onPlot

fun onPlot(): ExecutionResult

Plot a design using the current settings

onSave

fun onSave()

Save current design as SVG

resume

fun resume(): ExecutionResult

After hitting pause, use this to continue plotting

setupAxidrawCli

fun setupAxidrawCli(reinstall: Boolean = false)

This method is called automatically when instantiating org.openrndr.extra.axidraw.Axidraw to set up the axicli program. Call it with true as an argument to manually reinstall axicli.`

setupVirtualEnv

fun setupVirtualEnv(reinstall: Boolean = false)

This method is called automatically when instantiating org.openrndr.extra.axidraw.Axidraw to set up a Python virtual environment. Call it with true as an argument to manually reinstall the virtual environment.

sysInfo

fun sysInfo(): ExecutionResult

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(): ExecutionResult

Display Axidraw software version