API (v2.0.0) - Giro3D
    Preparing search index...

    Interface CommonCreationOptions

    interface CommonCreationOptions {
        endCondition?: MouseCallback;
        onTemporaryPointMoved?: (shape: Shape, position: Vector3) => void;
        pick?: PickCallback<PickResult<unknown>>;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index

    Properties

    endCondition? onTemporaryPointMoved? pick? signal?

    Properties

    endCondition?: MouseCallback

    The input required to finish drawing the shape. Does not apply to shapes that require a fixed number of points (i.e point, segment, etc).

    right click
    onTemporaryPointMoved?: (shape: Shape, position: Vector3) => void

    An optional callback to be called when a point has been moved.

    Type Declaration

      • (shape: Shape, position: Vector3): void

      • Parameters

        • shape: Shape

          The shape being created.

        • position: Vector3

          The position of the point.

        Returns void

    pick?: PickCallback<PickResult<unknown>>

    The optional custom picking function.

    signal?: AbortSignal

    The optional signal to listen to cancel the creation of a shape.

    Settings

    Member Visibility

    On This Page

    Properties