gcode-preview - v3.0.0-alpha.3
    Preparing search index...

    Class WebGLPreview

    WebGL-based G-code preview renderer

    Index

    Constructors

    constructor

    Properties

    _endLayer? _lastRenderTime _singleLayerMode _startLayer? _wireframe camera canvas controls disableGradient extrusionWidth? inches initialCameraPosition interpreter job lineHeight lineWidth? minLayerThreshold nonTravelmoves parser renderer renderExtrusion renderTravel renderTubes scene defaultExtrusionColor

    Accessors

    ambientLight backgroundColor boundingBoxColor brightness buildVolume countLayers directionalLight endLayer extrusionColor lastSegmentColor singleLayerMode startLayer topLayerColor travelColor

    Methods

    clear clearCamera createBoundingBox dispose loadCamera processGCode readStream render renderAnimated resize saveCamera

    Constructors

    Properties

    Optional_endLayer

    _endLayer?: number

    Last layer to render (1-based index)

    _lastRenderTime

    _lastRenderTime: number = 0

    Last render time in milliseconds

    _singleLayerMode

    _singleLayerMode: boolean = false

    Whether single layer mode is enabled

    Optional_startLayer

    _startLayer?: number

    First layer to render (1-based index)

    _wireframe

    _wireframe: boolean = false

    Whether to render in wireframe mode

    camera: PerspectiveCamera

    Three.js perspective camera

    canvas: HTMLCanvasElement

    Canvas element being rendered to

    controls: OrbitControls

    Orbit controls for camera

    disableGradient: boolean = false

    Disable color gradient between layers

    extrusionWidth?: number

    Width of extruded material

    inches: boolean = false

    Whether to use inches instead of millimeters

    initialCameraPosition: number[] = ...

    Initial camera position [x, y, z]

    interpreter: Interpreter = ...

    G-code interpreter

    job: Job

    Job containing parsed G-code data

    lineHeight: number = 0.2

    Height of extruded lines

    lineWidth?: number

    Width of rendered lines

    minLayerThreshold: number

    Minimum layer height threshold

    nonTravelmoves: string[] = []

    List of G-code commands considered non-travel moves

    parser: Parser = ...

    G-code parser

    renderer: WebGLRenderer & {
        info: {
            memory: { geometries: number; textures: number };
            render: {
                calls: number;
                lines: number;
                points: number;
                triangles: number;
            };
        };
    }

    Three.js WebGL renderer

    renderExtrusion: boolean = true

    Whether to render extrusion paths

    renderTravel: boolean = false

    Whether to render travel moves

    renderTubes: boolean = false

    Whether to render paths as 3D tubes

    scene: Scene

    Three.js scene

    defaultExtrusionColor: Color = ...

    Default extrusion color

    Accessors

    • get backgroundColor(): Color

      Gets the current background color

      Returns Color

      Current background color

    • set backgroundColor(value: string | number | Color): void

      Sets the background color

      Parameters

      • value: string | number | Color

        Color value as number, string, or Color instance

      Returns void

    • get boundingBoxColor(): ColorRepresentation

      Gets the current bounding box color

      Returns ColorRepresentation

      Color representation or undefined if not set

    • set boundingBoxColor(value: ColorRepresentation): void

      Sets the bounding box color

      Parameters

      • value: ColorRepresentation

        Color value or undefined to hide the bounding box

      Returns void

    • get countLayers(): number

      Gets the total number of layers in the job

      Returns number

      Number of layers

    • get endLayer(): number

      Gets the current end layer (1-based index)

      Returns number

      End layer number

    • set endLayer(value: number): void

      Sets the end layer (1-based index)

      Parameters

      • value: number

        Layer number to end rendering at

      Returns void

    • get extrusionColor(): Color | Color[]

      Gets the current extrusion color(s)

      Returns Color | Color[]

      Color or array of colors for extruded paths

    • set extrusionColor(value: string | number | Color | ColorRepresentation[]): void

      Sets the extrusion color(s)

      Parameters

      • value: string | number | Color | ColorRepresentation[]

        Color value(s) as number, string, Color instance, or array of ColorRepresentation

      Returns void

    • get lastSegmentColor(): ColorRepresentation

      Gets the current last segment color

      Returns ColorRepresentation

      Color representation or undefined if not set

    • set lastSegmentColor(value: ColorRepresentation): void

      Sets the last segment color

      Parameters

      • value: ColorRepresentation

        Color value or undefined to clear

      Returns void

    • get singleLayerMode(): boolean

      Gets whether single layer mode is enabled

      Returns boolean

      True if single layer mode is active

    • set singleLayerMode(value: boolean): void

      Sets single layer mode

      Parameters

      • value: boolean

        True to enable single layer mode

      Returns void

    • get startLayer(): number

      Gets the current start layer (1-based index)

      Returns number

      Start layer number

    • set startLayer(value: number): void

      Sets the start layer (1-based index)

      Parameters

      • value: number

        Layer number to start rendering from

      Returns void

    • get topLayerColor(): ColorRepresentation

      Gets the current top layer color

      Returns ColorRepresentation

      Color representation or undefined if not set

    • set topLayerColor(value: ColorRepresentation): void

      Sets the top layer color

      Parameters

      • value: ColorRepresentation

        Color value or undefined to clear

      Returns void

    • get travelColor(): Color

      Gets the current travel move color

      Returns Color

      Current travel move color

    • set travelColor(value: string | number | Color): void

      Sets the travel move color

      Parameters

      • value: string | number | Color

        Color value as number, string, or Color instance

      Returns void

    Methods

    • Processes G-code and updates the visualization

      Parameters

      • gcode: string | string[] | ReadableStream<any>

        G-code string or array of strings to process

      • options: { render: boolean } = ...

        Options for rendering: { render: boolean }

      Returns Promise<void>

      Parses the G-code, executes commands, and renders the paths if render is true.

    • Parameters

      • stream: ReadableStream

      Returns Promise<void>

    • Experimental

      Renders paths incrementally using an animation loop

      Parameters

      • pathCount: number = undefined

        Number of paths to render per frame

      Returns Promise<void>

      Promise that resolves when rendering is complete

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods