Interface TurtleCommandContext

Mutable command context passed to custom turtle extensions.

interface TurtleCommandContext {
    index: number;
    symbol: ModuleSymbol;
    getFrame(): Frame3;
    getPosition(): Vec3;
    getWidth(): number;
    setFrame(frame: Frame3): void;
    setPosition(position: Vec3): void;
    setWidth(width: number): void;
}

Index

Properties

Methods

getFrame getPosition getWidth setFrame setPosition setWidth

Properties

`Readonly`index

index: number

`Readonly`symbol

symbol: ModuleSymbol

Methods

getFrame

getFrame(): Frame3
Returns the current orthonormal turtle frame.

Returns Frame3
- Defined in turtle/interpreter.ts:81

getPosition

getPosition(): Vec3
Returns the current renderer-neutral turtle position.

Returns Vec3
- Defined in turtle/interpreter.ts:77

getWidth

getWidth(): number
Returns the current branch width.

Returns number
- Defined in turtle/interpreter.ts:85

setFrame

setFrame(frame: Frame3): void
Replaces and re-orthonormalizes the turtle frame.
Parameters
- frame: Frame3
Returns void
- Defined in turtle/interpreter.ts:83

setPosition

setPosition(position: Vec3): void
Replaces the current turtle position.
Parameters
- position: Vec3
Returns void
- Defined in turtle/interpreter.ts:79

setWidth

setWidth(width: number): void
Replaces the current nonnegative branch width.
Parameters
- width: number
Returns void
- Defined in turtle/interpreter.ts:87