Class GizmoRectangle

Rectangle Gizmo used for rectangle selection.

Hierarchy

GizmoRectangle

Index

Constructors

Accessors

Methods

dispose getBoundingBox getClosestHit setCorners

Constructors

constructor

new GizmoRectangle(viewer: Viewer): GizmoRectangle
Parameters
- viewer: Viewer
Returns GizmoRectangle
- Defined in src/vim-webgl-viewer/gizmos/gizmoRectangle.ts:16

Accessors

visible

get visible(): boolean
Indicates whether the gizmo is visible.

Returns boolean
- Defined in src/vim-webgl-viewer/gizmos/gizmoRectangle.ts:64
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoRectangle.ts:68

Methods

dispose

dispose(): void
Removes the object from rendering and dispose resources from memory

Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoRectangle.ts:55

getBoundingBox

getBoundingBox(target?: Box3): Box3
Returns the bounding box of the selection. The bounding box is the projection of the selection rectangle onto the plane coplanar to the closest hit of 5 raycasts: one in each corner and one in the center. X-----X | X | X-----X

Returns
The bounding box of the selection.
Parameters
- target: Box3 = ...
Returns Box3
- Defined in src/vim-webgl-viewer/gizmos/gizmoRectangle.ts:145

getClosestHit

getClosestHit(): Vector3
Performs a raycast from the camera through the five interest points and returns the closest hit position.

Returns
The position of the closest hit.

Returns Vector3
- Defined in src/vim-webgl-viewer/gizmos/gizmoRectangle.ts:156

setCorners

setCorners(posA: Vector2, posB: Vector2): void
Sets the two corner points defining the rectangle.
Parameters
- posA: Vector2
  
  The position of the first corner.
- posB: Vector2
  
  The position of the second corner.
Returns void
- Defined in src/vim-webgl-viewer/gizmos/gizmoRectangle.ts:78

Generated using TypeDoc