@novorender/web_app / OrbitController

Class: OrbitController

A camera controller for orbiting around a point of interest.

Extends

• BaseController

Accessors

axes

get axes(): ControllerAxes

The input axes

See

ControllerInput.axes

Returns

ControllerAxes

Inherited from

BaseController.axes

Defined in

@novorender/web_app/controller/base.ts:55

---

currentFlyTo

get currentFlyTo(): undefined | Orientation

The current fly-to state, if any.

Returns

undefined | Orientation

Inherited from

BaseController.currentFlyTo

Defined in

@novorender/web_app/controller/base.ts:109

---

distance

get distance(): number

The distance from the pivot point, in meters.

set distance(value): void

Parameters

Parameter	Type
value	number

Returns

number

Defined in

@novorender/web_app/controller/orbit.ts:87

---

fov

get fov(): number

The camera vertical field of view angle, in degrees.

set fov(value): void

Parameters

Parameter	Type
value	number

Returns

number

Defined in

@novorender/web_app/controller/orbit.ts:96

---

generation

get generation(): number

Camera controller state generation.

Remarks

If the controller state changes, the generation count will be incremented once every call to renderStateChanges. This can be used to detect changes by comparing to a local generation count. The count is wrapped at 0xffffffff, so make sure you use != comparison and not < comparison.

Returns

number

Inherited from

BaseController.generation

Defined in

@novorender/web_app/controller/base.ts:29

---

hasShift

get hasShift(): boolean

The input shift button state.

See

ControllerInput.hasShift

Returns

boolean

Inherited from

BaseController.hasShift

Defined in

@novorender/web_app/controller/base.ts:104

---

height

get height(): number

The input element height.

See

ControllerInput.height

Returns

number

Inherited from

BaseController.height

Defined in

@novorender/web_app/controller/base.ts:76

---

moving

get moving(): boolean

Whether the camera is currently considered moving or not.

See

View.isIdleFrame

Returns

boolean

Inherited from

BaseController.moving

Defined in

@novorender/web_app/controller/base.ts:62

---

multiplier

get multiplier(): number

The input multiplier.

See

ControllerInput.multiplier

Returns

number

Inherited from

BaseController.multiplier

Defined in

@novorender/web_app/controller/base.ts:83

---

parameters

get parameters(): OrbitControllerParams

The current controller parameters.

Returns

OrbitControllerParams

Defined in

@novorender/web_app/controller/orbit.ts:35

---

pitch

get pitch(): number

The pitch angle around the pivot point, in degrees.

set pitch(value): void

Parameters

Parameter	Type
value	number

Returns

number

Defined in

@novorender/web_app/controller/orbit.ts:60

---

pivot

get pivot(): ReadonlyVec3

The pivot point to orbit around, in world space.

set pivot(value): void

Parameters

Parameter	Type
value	ReadonlyVec3

Returns

ReadonlyVec3

Defined in

@novorender/web_app/controller/orbit.ts:78

---

pointerTable

get pointerTable(): readonly TouchContactPoint[]

The input pointer table.

See

ControllerInput.touchPoints

Returns

readonly TouchContactPoint[]

Inherited from

BaseController.pointerTable

Defined in

@novorender/web_app/controller/base.ts:97

---

position

get position(): vec3

Computed position, in world space.

Remarks

This position is derived from pivot point, distance, rotated around pitch and yaw angles.

Returns

vec3

Defined in

@novorender/web_app/controller/orbit.ts:43

---

rotation

get rotation(): ReadonlyQuat

Computed rotation quaternion, in world space.

Remarks

This rotation is derived from pitch and yaw angles.

Returns

ReadonlyQuat

Defined in

@novorender/web_app/controller/orbit.ts:55

---

width

get width(): number

The input element width.

See

ControllerInput.width

Returns

number

Inherited from

BaseController.width

Defined in

@novorender/web_app/controller/base.ts:69

---

yaw

get yaw(): number

The yaw angle around the pivot point, in degrees.

set yaw(value): void

Parameters

Parameter	Type
value	number

Returns

number

Defined in

@novorender/web_app/controller/orbit.ts:69

---

zoomPos

get zoomPos(): number[]

The input zoom position.

See

ControllerInput.zoomPos

Returns

number[]

Inherited from

BaseController.zoomPos

Defined in

@novorender/web_app/controller/base.ts:90

Constructors

new OrbitController()

new OrbitController(input, params?): OrbitController

Parameters

Parameter	Type	Description
input	ControllerInput	The input source.
params?	Partial<OrbitControllerParams>	Optional initialization parameters.

Returns

OrbitController

Overrides

BaseController.constructor

Defined in

@novorender/web_app/controller/orbit.ts:29

Methods

animate()

animate(elapsedTime): void

Apply time sensitive changes to controller state.

Parameters

Parameter	Type	Description
elapsedTime	number	The # of milliseconds elapsed since the last update.

Returns

void

Remarks

Fly-to animations happens here, as well as motion based on keyboard pressed-state, such as the WASD keys.

Inherited from

BaseController.animate

Defined in

@novorender/web_app/controller/base.ts:136

---

attach()

attach(): void

Attach this controller to the input object

Returns

void

Inherited from

BaseController.attach

Defined in

@novorender/web_app/controller/base.ts:193

---

autoFit()

autoFit(center, radius): void

Attempt to fit controller position such that the specified bounding sphere is brought into view.

Parameters

Parameter	Type	Description
center	ReadonlyVec3	The center of the bounding sphere, in world space.
radius	number	The radius of the bounding sphere, in world space.

Returns

void

Overrides

BaseController.autoFit

Defined in

@novorender/web_app/controller/orbit.ts:156

---

changed()

protected changed(): void

Signal changes to internal state.

Returns

void

Inherited from

BaseController.changed

Defined in

@novorender/web_app/controller/base.ts:34

---

init()

init(params): void

Initialize controller from parameters.

Parameters

Parameter	Type
params	ControllerInitParams

Returns

void

See

serialize

Overrides

BaseController.init

Defined in

@novorender/web_app/controller/orbit.ts:117

---

mouseButtonChanged()

mouseButtonChanged(event): void | Promise<void>

Handler for mouse buttons events.

Parameters

Parameter	Type
event	MouseEvent

Returns

void | Promise<void>

Inherited from

BaseController.mouseButtonChanged

Defined in

@novorender/web_app/controller/base.ts:201

---

moveBegin()

moveBegin(event): void | Promise<void>

Handler for mouse/touch move events.

Parameters

Parameter	Type
event	MouseEvent | TouchEvent

Returns

void | Promise<void>

Inherited from

BaseController.moveBegin

Defined in

@novorender/web_app/controller/base.ts:213

---

moveTo()

moveTo(
   targetPosition, 
   flyTime, 
   rotation?): void

Move controller to specified position/rotation.

Parameters

Parameter	Type	Default value
targetPosition	ReadonlyVec3	undefined
flyTime	number	1000
rotation?	ReadonlyQuat	undefined

Returns

void

Inherited from

BaseController.moveTo

Defined in

@novorender/web_app/controller/base.ts:221

---

renderStateChanges()

renderStateChanges(state, elapsedTime): undefined | RecursivePartial<RenderState>

Retrieve the state changes to be applied to the specified render state.

Parameters

Parameter	Type	Description
state	RenderStateCamera	The baseline render state.
elapsedTime	number	The time elapsed since last call, in milliseconds.

Returns

undefined | RecursivePartial<RenderState>

Inherited from

BaseController.renderStateChanges

Defined in

@novorender/web_app/controller/base.ts:236

---

resetFlyTo()

protected resetFlyTo(): void

Returns

void

Inherited from

BaseController.resetFlyTo

Defined in

@novorender/web_app/controller/base.ts:113

---

serialize()

serialize(includeDerived): ControllerInitParams

Serialize the state of this controller into init parameters.

Parameters

Parameter	Type	Default value	Description
includeDerived	boolean	false	Include derived state which may not be intrinsic to this controller, such as orbit controller position.

Returns

ControllerInitParams

See

init

Overrides

BaseController.serialize

Defined in

@novorender/web_app/controller/orbit.ts:111

---

setFlyTo()

protected setFlyTo(flyTo): void

Initialize a fly-to transition.

Parameters

Parameter	Type	Description
flyTo	FlyToParams	The transition parameters

Returns

void

Inherited from

BaseController.setFlyTo

Defined in

@novorender/web_app/controller/base.ts:120

---

stateChanges()

stateChanges(state?): Partial<RenderStateCamera>

Retrieve changes to render state from derived class, if any.

Parameters

Parameter	Type	Description
state?	RenderStateCamera	The baseline state to apply changes to.

Returns

Partial<RenderStateCamera>

See

View.modifyRenderState

Remarks

If there are no changes, the returned object will be empty, i.e. .

Overrides

BaseController.stateChanges

Defined in

@novorender/web_app/controller/orbit.ts:191

---

touchChanged()

touchChanged(event): void | Promise<void>

Handler for touch events.

Parameters

Parameter	Type
event	TouchEvent

Returns

void | Promise<void>

Inherited from

BaseController.touchChanged

Defined in

@novorender/web_app/controller/base.ts:207

---

update()

update(): void

Update internal controller state

Returns

void

Overrides

BaseController.update

Defined in

@novorender/web_app/controller/orbit.ts:163

---

updateParams()

updateParams(params): void

Update controller parameters.

Parameters

Parameter	Type	Description
params	Partial<OrbitControllerParams>	Set of parameters to change.

Returns

void

Defined in

@novorender/web_app/controller/orbit.ts:107

---

zoomTo()

zoomTo(boundingSphere, flyTime): void

Bring the specified bounding sphere into view.

Parameters

Parameter	Type	Default value
boundingSphere	BoundingSphere	undefined
flyTime	number	1000

Returns

void

Remarks

This function will retain the current camera controller rotation.

Inherited from

BaseController.zoomTo

Defined in

@novorender/web_app/controller/base.ts:230

---

assert()

static assert(controller): asserts controller is OrbitController

OrbitController type assert function.

Parameters

Parameter	Type	Description
controller	BaseController	The controller to type assert.

Returns

asserts controller is OrbitController

Defined in

@novorender/web_app/controller/orbit.ts:222

---

getDistanceFromViewPlane()

protected static getDistanceFromViewPlane(
   point, 
   cameraPosition, 
   cameraRotation): number

Compute the distance to a point from the specified view plane.

Parameters

Parameter	Type	Description
point	ReadonlyVec3	The point to measure distance too
cameraPosition	ReadonlyVec3	The position of the camera/view plane.
cameraRotation	ReadonlyQuat	The rotation of the camera/view plane.

Returns

number

A signed distance from the point to the view plane, i.e. positive for points in front of the plane and negative otherwise.

Inherited from

BaseController.getDistanceFromViewPlane

Defined in

@novorender/web_app/controller/base.ts:262

---

is()

static is(controller): controller is OrbitController

OrbitController type guard function.

Parameters

Parameter	Type	Description
controller	BaseController	The controller to type guard.

Returns

controller is OrbitController

Defined in

@novorender/web_app/controller/orbit.ts:215

Properties

input

readonly input: ControllerInput;

The input source for this controller.

Inherited from

BaseController.input

Defined in

@novorender/web_app/controller/base.ts:48

---

kind

kind: "orbit";

The controller type id.

Overrides

BaseController.kind

Defined in

@novorender/web_app/controller/orbit.ts:12

---

projection

projection: "pinhole";

The camera projection kind.

See

RenderStateCamera.kind.

Overrides

BaseController.projection

Defined in

@novorender/web_app/controller/orbit.ts:13