Class ArcballControls

Param

Virtual camera used in the scene

Param

Renderer's dom element

Param

The scene to be rendered

Hierarchy

EventDispatcher
- ArcballControls

Index

Constructors

constructor

Methods

activateGizmos applyTransformMatrix calculateAngularSpeed calculatePointersDistance calculateRotationAxis calculateTbRadius compareMouseAction copyState dispose disposeGrid drawGrid easeOutCubic focus getAngle getCursorNDC getCursorPosition getOpFromAction getOpStateFromAction getRaycaster initializeMouseActions makeGizmos onContextMenu onDoublePanEnd onDoublePanMove onDoublePanStart onDoubleTap onFocusAnim onPinchEnd onPinchMove onPinchStart onPointerCancel onPointerDown onPointerMove onPointerUp onRotateEnd onRotateMove onRotateStart onRotationAnim onSinglePanEnd onSinglePanMove onSinglePanStart onTriplePanEnd onTriplePanMove onTriplePanStart onWheel onWindowResize pan pasteState reset rotate saveState scale setCamera setCenter setFov setGizmosVisible setMouseAction setStateFromJSON setTbRadius setTransformationMatrices unprojectOnObj unprojectOnTbPlane unprojectOnTbSurface unsetMouseAction update updateMatrixState updateTbState updateTouchEvent zRotate

Constructors

constructor

new ArcballControls(camera: any, domElement: any, scene?: any): ArcballControls
Parameters
- camera: any
- domElement: any
- scene: any = null
Returns ArcballControls
Overrides EventDispatcher.constructor
- Defined in src/3d/controls/ArcballControl.class.ts:75

Methods

activateGizmos

activateGizmos(isActive: any): void
Make rotation gizmos more or less visible
Parameters
- isActive: any
  
  If true, make gizmos more visible
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1795

applyTransformMatrix

applyTransformMatrix(transformation: any): void
Apply a transformation matrix, to the camera and gizmos
Parameters
- transformation: any
  
  Object containing matrices to apply to camera and gizmos
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1538

calculateAngularSpeed

calculateAngularSpeed(p0: any, p1: any, t0: any, t1: any): number
Calculate the angular speed
Parameters
- p0: any
  
  Position at t0
- p1: any
  
  Position at t1
- t0: any
  
  Initial time in milliseconds
- t1: any
  
  Ending time in milliseconds
Returns number
- Defined in src/3d/controls/ArcballControl.class.ts:1621

calculatePointersDistance

calculatePointersDistance(p0: any, p1: any): number
Calculate the distance between two pointers

Returns
The distance between the two pointers
Parameters
- p0: any
  
  The first pointer
- p1: any
  
  The second pointer
Returns number
- Defined in src/3d/controls/ArcballControl.class.ts:1637

calculateRotationAxis

calculateRotationAxis(vec1: any, vec2: any): any
Calculate the rotation axis as the vector perpendicular between two vectors

Returns
The normalized rotation axis
Parameters
- vec1: any
  
  The first vector
- vec2: any
  
  The second vector
Returns any
- Defined in src/3d/controls/ArcballControl.class.ts:1647

calculateTbRadius

calculateTbRadius(camera: any): number
Calculate the trackball radius so that gizmo's diamater will be 2/3 of the minimum side of the camera frustum

Returns
The trackball radius
Parameters
- camera: any
Returns number
- Defined in src/3d/controls/ArcballControl.class.ts:1660

compareMouseAction

compareMouseAction(action1: any, action2: any): boolean
Compare two mouse actions

Returns
True if action1 and action 2 are the same mouse action, false otherwise
Parameters
- action1: any
- action2: any
Returns boolean
- Defined in src/3d/controls/ArcballControl.class.ts:1361

copyState

copyState(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2177

dispose

dispose(): void
Remove all listeners, stop animations and clean scene

Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1753

disposeGrid

disposeGrid(): void
remove the grid from the scene

Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1775

drawGrid

drawGrid(): void
Draw a grid and add it to the scene

Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1711

easeOutCubic

easeOutCubic(t: any): number
Compute the easing out cubic function for ease out effect in animation

Returns
Result of easing out cubic at time t
Parameters
- t: any
  
  The absolute progress of the animation in the bound of 0 (beginning of the) and 1 (ending of animation)
Returns number
- Defined in src/3d/controls/ArcballControl.class.ts:1787

focus

focus(point: any, size: any, amount?: number): void
Focus operation consist of positioning the point of interest in front of the camera and a slightly zoom in
Parameters
- point: any
  
  The point of interest
- size: any
  
  Scale factor
- amount: number = 1
  
  Amount of operation to be completed (used for focus animations, default is complete full operation)
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1678

getAngle

getAngle(p1: any, p2: any): number
Calculate the angle between two pointers

Returns
The angle between two pointers in degrees
Parameters
- p1: any
- p2: any
Returns number
- Defined in src/3d/controls/ArcballControl.class.ts:1517

getCursorNDC

getCursorNDC(cursorX: any, cursorY: any, canvas: any): any
Calculate the cursor position in NDC

Returns
Cursor normalized position inside the canvas
Parameters
- cursorX: any
- cursorY: any
- canvas: any
  
  The canvas where the renderer draws its output
Returns any
- Defined in src/3d/controls/ArcballControl.class.ts:1818

getCursorPosition

getCursorPosition(cursorX: any, cursorY: any, canvas: any): any
Calculate the cursor position inside the canvas x/y coordinates with the origin being in the center of the canvas

Returns
Cursor position inside the canvas
Parameters
- cursorX: any
- cursorY: any
- canvas: any
  
  The canvas where the renderer draws its output
Returns any
- Defined in src/3d/controls/ArcballControl.class.ts:1832

getOpFromAction

getOpFromAction(mouse: any, key: any): any
Return the operation associated to a mouse/keyboard combination

Returns
The operation if it has been found, null otherwise
Parameters
- mouse: any
  
  A mouse button (0, 1, 2) or 'WHEEL' for wheel notches
- key: any
  
  The keyboard modifier ('CTRL', 'SHIFT') or null if key is not needed
Returns any
- Defined in src/3d/controls/ArcballControl.class.ts:1461

getOpStateFromAction

getOpStateFromAction(mouse: any, key: any): any
Get the operation associated to mouse and key combination and returns the corresponding FSA state

Returns
The FSA state obtained from the operation associated to mouse/keyboard combination
Parameters
- mouse: any
  
  Mouse button
- key: any
  
  Keyboard modifier
Returns any
- Defined in src/3d/controls/ArcballControl.class.ts:1489

getRaycaster

getRaycaster(): Raycaster
Returns Raycaster
- Defined in src/3d/controls/ArcballControl.class.ts:2391

initializeMouseActions

initializeMouseActions(): void
Set default mouse actions

Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1342

makeGizmos

makeGizmos(tbCenter: any, tbRadius: any): void
Creates the rotation gizmos matching trackball center and radius
Parameters
- tbCenter: any
  
  The trackball center
- tbRadius: any
  
  The trackball radius
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1911

onContextMenu

onContextMenu(event: any): void
Parameters
- event: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:246

onDoublePanEnd

onDoublePanEnd(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1097

onDoublePanMove

onDoublePanMove(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1075

onDoublePanStart

onDoublePanStart(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1056

onDoubleTap

onDoubleTap(event: any): void
Parameters
- event: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1024

onFocusAnim

onFocusAnim(time: any, point: any, cameraMatrix: any, gizmoMatrix: any): void
Perform animation for focus operation
Parameters
- time: any
  
  Instant in which this function is called as performance.now()
- point: any
  
  Point of interest for focus operation
- cameraMatrix: any
  
  Camera matrix
- gizmoMatrix: any
  
  Gizmos matrix
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1982

onPinchEnd

onPinchEnd(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1220

onPinchMove

onPinchMove(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1179

onPinchStart

onPinchStart(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1164

onPointerCancel

onPointerCancel(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:260

onPointerDown

onPointerDown(event: any): void
Parameters
- event: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:266

onPointerMove

onPointerMove(event: any): void
Parameters
- event: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:329

onPointerUp

onPointerUp(event: any): void
Parameters
- event: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:398

onRotateEnd

onRotateEnd(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1158

onRotateMove

onRotateMove(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1123

onRotateStart

onRotateStart(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1102

onRotationAnim

onRotationAnim(time: any, rotationAxis: any, w0: any): void
Perform animation for rotation operation
Parameters
- time: any
  
  Instant in which this function is called as performance.now()
- rotationAxis: any
  
  Rotation axis
- w0: any
  
  Initial angular velocity
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2041

onSinglePanEnd

onSinglePanEnd(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:977

onSinglePanMove

onSinglePanMove(event: any, opState: any): void
Parameters
- event: any
- opState: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:754

onSinglePanStart

onSinglePanStart(event: any, operation: any): void
Parameters
- event: any
- operation: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:643

onTriplePanEnd

onTriplePanEnd(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1323

onTriplePanMove

onTriplePanMove(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1250

onTriplePanStart

onTriplePanStart(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1225

onWheel

onWheel(event: any): void
Parameters
- event: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:494

onWindowResize

onWindowResize(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:230

pan

pan(p0: any, p1: any, adjust?: boolean): {
camera: Matrix4;
gizmos: Matrix4;
}
Perform pan operation moving camera between two points
Parameters
- p0: any
  
  Initial point
- p1: any
  
  Ending point
- adjust: boolean = false
  
  If movement should be adjusted considering camera distance (Perspective only)
Returns {
camera: Matrix4;
gizmos: Matrix4;
}
- camera: Matrix4
- gizmos: Matrix4
- Defined in src/3d/controls/ArcballControl.class.ts:2092

pasteState

pasteState(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2207

reset

reset(): void
Reset trackball

Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2118

rotate

rotate(axis: any, angle: any): {
camera: Matrix4;
gizmos: Matrix4;
}
Rotate the camera around an axis passing by trackball's center

Returns
Object with 'camera' field containing transformation matrix resulting from the operation to be applied to the camera
Parameters
- axis: any
  
  Rotation axis
- angle: any
  
  Angle in radians
Returns {
camera: Matrix4;
gizmos: Matrix4;
}
- camera: Matrix4
- gizmos: Matrix4
- Defined in src/3d/controls/ArcballControl.class.ts:2162

saveState

saveState(): void
Save the current state of the control. This can later be recover with .reset

Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2217

scale

scale(size: any, point: any, scaleGizmos?: boolean): {
camera: Matrix4;
gizmos: Matrix4;
}
Perform uniform scale operation around a given point

Returns
Object with 'camera' and 'gizmo' fields containing transformation matrices resulting from the operation to be applied to the camera and gizmos
Parameters
- size: any
  
  Scale factor
- point: any
  
  Point around which scale
- scaleGizmos: boolean = true
  
  If gizmos should be scaled (Perspective only)
Returns {
camera: Matrix4;
gizmos: Matrix4;
}
- camera: Matrix4
- gizmos: Matrix4
- Defined in src/3d/controls/ArcballControl.class.ts:2237

setCamera

setCamera(camera: any): void
Set the camera to be controlled
Parameters
- camera: any
  
  The virtual camera to be controlled
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1843

setCenter

setCenter(clientX: any, clientY: any): void
Set _center's x/y coordinates
Parameters
- clientX: any
- clientY: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1334

setFov

setFov(value: any): void
Set camera fov
Parameters
- value: any
  
  fov to be setted
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2333

setGizmosVisible

setGizmosVisible(value: any): void
Set gizmos visibility
Parameters
- value: any
  
  Value of gizmos visibility
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1882

setMouseAction

setMouseAction(operation: any, mouse: any, key?: any): boolean
Set a new mouse action by specifying the operation to be performed and a mouse/key combination. In case of conflict, replaces the existing one

Returns
True if the mouse action has been successfully added, false otherwise
Parameters
- operation: any
  
  The operation to be performed ('PAN', 'ROTATE', 'ZOOM', 'FOV)
- mouse: any
  
  A mouse button (0, 1, 2) or 'WHEEL' for wheel notches
- key: any = null
  
  The keyboard modifier ('CTRL', 'SHIFT') or null if key is not needed
Returns boolean
- Defined in src/3d/controls/ArcballControl.class.ts:1380

setStateFromJSON

setStateFromJSON(json: any): void
Parameters
- json: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2688

setTbRadius

setTbRadius(value: any): void
Set gizmos radius factor and redraws gizmos
Parameters
- value: any
  
  Value of radius factor
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1891

setTransformationMatrices

setTransformationMatrices(camera?: any, gizmos?: any): void
Set values in transformation object
Parameters
- camera: any = null
  
  Transformation to be applied to the camera
- gizmos: any = null
  
  Transformation to be applied to gizmos
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2345

unprojectOnObj

unprojectOnObj(cursor: any, camera: any): Vector3
Unproject the cursor on the 3D object surface

Returns
The point of intersection with the model, if exist, null otherwise
Parameters
- cursor: any
  
  Cursor coordinates in NDC
- camera: any
  
  Virtual camera
Returns Vector3
- Defined in src/3d/controls/ArcballControl.class.ts:2401

unprojectOnTbPlane

unprojectOnTbPlane(camera: any, cursorX: any, cursorY: any, canvas: any, initialDistance?: boolean): any
Unproject the cursor on the plane passing through the center of the trackball orthogonal to the camera

Returns
The unprojected point on the trackball plane
Parameters
- camera: any
  
  The virtual camera
- cursorX: any
  
  Cursor horizontal coordinate on screen
- cursorY: any
  
  Cursor vertical coordinate on screen
- canvas: any
  
  The canvas where the renderer draws its output
- initialDistance: boolean = false
  
  If initial distance between camera and gizmos should be used for calculations instead of current (Perspective only)
Returns any
- Defined in src/3d/controls/ArcballControl.class.ts:2544

unprojectOnTbSurface

unprojectOnTbSurface(camera: any, cursorX: any, cursorY: any, canvas: any, tbRadius: any): any
Unproject the cursor on the trackball surface

Returns
The unprojected point on the trackball surface
Parameters
- camera: any
  
  The virtual camera
- cursorX: any
  
  Cursor horizontal coordinate on screen
- cursorY: any
  
  Cursor vertical coordinate on screen
- canvas: any
  
  The canvas where the renderer draws its output
- tbRadius: any
  
  The trackball radius
Returns any
- Defined in src/3d/controls/ArcballControl.class.ts:2427

unsetMouseAction

unsetMouseAction(mouse: any, key?: any): boolean
Remove a mouse action by specifying its mouse/key combination

Returns
True if the operation has been succesfully removed, false otherwise
Parameters
- mouse: any
  
  A mouse button (0, 1, 2) or 'WHEEL' for wheel notches
- key: any = null
  
  The keyboard modifier ('CTRL', 'SHIFT') or null if key is not needed
Returns boolean
- Defined in src/3d/controls/ArcballControl.class.ts:1444

update

update(): void
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2634

updateMatrixState

updateMatrixState(): void
Update camera and gizmos state

Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2608

updateTbState

updateTbState(newState: any, updateMatrices: any): void
Update the trackball FSA
Parameters
- newState: any
  
  New state of the FSA
- updateMatrices: any
  
  If matriices state should be updated
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:2627

updateTouchEvent

updateTouchEvent(event: any): void
Update a PointerEvent inside current pointerevents array
Parameters
- event: any
Returns void
- Defined in src/3d/controls/ArcballControl.class.ts:1525

zRotate

zRotate(point: any, angle: any): {
camera: Matrix4;
gizmos: Matrix4;
}
Rotate camera around its direction axis passing by a given point by a given angle

Returns
The computed transormation matix
Parameters
- point: any
  
  The point where the rotation axis is passing trough
- angle: any
  
  Angle in radians
Returns {
camera: Matrix4;
gizmos: Matrix4;
}
- camera: Matrix4
- gizmos: Matrix4
- Defined in src/3d/controls/ArcballControl.class.ts:2373

Class ArcballControls

Param

Param

Param

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

camera: any

domElement: any

scene: any = null

Returns ArcballControls

Methods

activateGizmos

Parameters

isActive: any

Returns void

applyTransformMatrix

Parameters

transformation: any

Returns void

calculateAngularSpeed

Parameters

p0: any

p1: any

t0: any

t1: any

Returns number

calculatePointersDistance

Returns

Parameters

p0: any

p1: any

Returns number

calculateRotationAxis

Returns

Parameters

vec1: any

vec2: any

Returns any

calculateTbRadius

Returns

Parameters

camera: any

Returns number

compareMouseAction

Returns

Parameters

action1: any

action2: any

Returns boolean

copyState

Returns void

dispose

Returns void

disposeGrid

Returns void

drawGrid

Returns void

easeOutCubic

Returns

Parameters

t: any

Returns number

focus

Parameters

point: any

size: any

amount: number = 1

Returns void

getAngle

Returns

Parameters

p1: any

p2: any

Returns number

getCursorNDC