3.0

foocad-build/uk.co.nickthecoder.foocad.build/ModelWithSetup

ModelWithSetup

interface ModelWithSetup : Model

Multi-piece models may wish to implement the setup method, which is called before any piece is built. Some initialisation isn't possible within the init block. For example, anything that using Custom fields (because these fields are set AFTER the class is created, but before setup and build are called.

Functions

abstract fun build(): Shape3d

Creates the default shape to be built/printed. A Model may be composed of many pieces, in which case, build should create the "main" piece, or possibly all pieces to be printed on a single plate.

fun Model.buildPiece(pieceName: String?): Shape3d

Builds a piece by looking for a method called pieceName with a Piece annotation.

findPicturePieceName

fun Model.findPicturePieceName(): String?

pieceAnnotation

fun Model.pieceAnnotation(pieceName: String? = null): Piece?

fun Model.pieceNames(): List<String>

Returns piece names by looking Piece annotations on methods.

pieceNamesIncludingDefault

fun Model.pieceNamesIncludingDefault(): List<String?>

The same as pieceNames, but includes the "default" pieceName of null as the first item in the list.

fun Model.printPieceName(pieceName: String?): String?

abstract fun setup()

slicerOverrides

fun Model.slicerOverrides(): SlicerValues?

Returns SlicerValues by looking for Slice annotations on the build method.

fun Model.slicerOverrides(pieceName: String?): SlicerValues?

Returns SlicerValues by looking for Slice annotations on the method named pieceName or the build method if pieceName is null.