Class SnapData

The SnapData type contains the result of a scene picking action.

Index

Constructors

Properties

_closestEdge _closestVertex _normal _pickedFace _pickedVertex _position _vertex0 _vertex1 _vertex2

Accessors

closestEdge closestVertex normal pickedFace pickedVertex position vertex0 vertex1 vertex2

Methods

clone isEqual isEqual

Constructors

constructor

new SnapData(
    normal?: Immutable<Vector3>,
    position?: Immutable<Vector3>,
    vertex0?: Immutable<Vector3>,
    vertex1?: Immutable<Vector3>,
    vertex2?: Immutable<Vector3>,
    closestVertex?: Immutable<Vector3>,
    closestEdge?: Immutable<Vector3>,
    pickedVertex?: number,
    pickedFace?: number,
): SnapData
Parameters
- Optionalnormal: Immutable<Vector3>
- Optionalposition: Immutable<Vector3>
- Optionalvertex0: Immutable<Vector3>
- Optionalvertex1: Immutable<Vector3>
- Optionalvertex2: Immutable<Vector3>
- OptionalclosestVertex: Immutable<Vector3>
- OptionalclosestEdge: Immutable<Vector3>
- OptionalpickedVertex: number
- OptionalpickedFace: number
Returns SnapData

Properties

`Protected`_closestEdge

_closestEdge: Vector3

`Protected`_closestVertex

_closestVertex: Vector3

`Protected`_normal

_normal: Vector3

`Protected`_pickedFace

_pickedFace: number

`Protected`_pickedVertex

_pickedVertex: number

`Protected`_position

_position: Vector3

`Protected`_vertex0

_vertex0: Vector3

`Protected`_vertex1

_vertex1: Vector3

`Protected`_vertex2

_vertex2: Vector3

Accessors

closestEdge

get closestEdge(): Vector3

Point on edge closest to the pick position.

Returns Vector3

closestVertex

get closestVertex(): Vector3

Vertex closest to the pick position.

Returns Vector3

normal

get normal(): Vector3

The normal to the object surface at the snapping point.

Returns Vector3

pickedFace

get pickedFace(): number

Index of picked face if enabled.

Returns number

pickedVertex

get pickedVertex(): number

Position of picked vertex in index buffer. For triangles this is usually 3 * faceIndex + [0..2]

Returns number

position

get position(): Vector3

The world position on the surface of the object.

Returns Vector3

vertex0

get vertex0(): Vector3

World coordinates of the first triangle vertex.

Returns Vector3

vertex1

get vertex1(): Vector3

World coordinates of the second triangle vertex.

Returns Vector3

vertex2

get vertex2(): Vector3

World coordinates of the third triangle vertex.

Returns Vector3

Methods

clone

clone(): SnapData

Clones this instance and returns a new SnapData with identical values.

Returns SnapData

isEqual

isEqual(this: Immutable<SnapData>, other: Immutable<SnapData>): boolean
Determines if this SnapData instance is equal to the other instance.
Parameters
- this: Immutable<SnapData>
- other: Immutable<SnapData>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<SnapData>, rhs: Immutable<SnapData>): boolean
Determines if both SnapData instances are equal.
Parameters
- lhs: Immutable<SnapData>
- rhs: Immutable<SnapData>
Returns boolean