Interface PickParams

Parameters for picking.

interface PickParams {
    canvasPos?: Vec2;
    pickInvisible?: boolean;
    pickSurfaceNormal?: boolean;
    rayDirection?: Vec3;
    rayMatrix?: Mat4;
    rayOrigin?: Vec3;
    rayPick?: boolean;
    snapRadius?: number;
    snapToEdge?: boolean;
    snapToVertex?: boolean;
}

Properties

canvasPos? pickInvisible? pickSurfaceNormal? rayDirection? rayMatrix? rayOrigin? rayPick? snapRadius? snapToEdge? snapToVertex?

Properties

OptionalcanvasPos

canvasPos?: Vec2

Canvas coordinates, used when PickParams.rayPick is false.

OptionalpickInvisible

pickInvisible?: boolean

Set this false to not pick invisible ViewObjects. Default is true.

OptionalpickSurfaceNormal

pickSurfaceNormal?: boolean

Set this true when ray-picking to pick the normal vector on the surface of the picked object.

OptionalrayDirection

rayDirection?: Vec3

Ray-picking direction, used when PickParams.rayPick is true.

OptionalrayMatrix

rayMatrix?: Mat4

Ray-picking direction matrix, used when PickParams.rayPick is true.

OptionalrayOrigin

rayOrigin?: Vec3

Ray-picking origin, used when PickParams.rayPick is true.

OptionalrayPick

rayPick?: boolean

Set this true to perform a ray-pick; leave false to pick at canvas coordinates.

OptionalsnapRadius

snapRadius?: number

The snap radius around PickParams.canvasPos, in canvas pixels.

OptionalsnapToEdge

snapToEdge?: boolean

Whether to snap to the nearest edge to PickParams.canvasPos.

OptionalsnapToVertex

snapToVertex?: boolean

Whether to snap to the nearest vertex to PickParams.canvasPos.

Settings

Member Visibility

On This Page

Properties