Interface CommonCreationOptions

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

Hierarchy (view full)

Properties

endCondition? onTemporaryPointMoved? pick? signal?

Properties

OptionalendCondition

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

Default Value

right click

OptionalonTemporaryPointMoved

onTemporaryPointMoved?: ((shape: entities.Shape<EntityUserData>, position: Vector3) => void)

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

Type declaration

Optionalpick

pick?: PickCallback<PickResult<unknown>>

The optional custom picking function.

Optionalsignal

signal?: AbortSignal

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

Settings

Member Visibility

On This Page

Properties