Skip to main content

class.CadMiddlePanController

API > CadMiddlePanController

Class: CadMiddlePanController

Variant of flight controller that uses middle mouse button for panning.

Extends

Constructors

constructor

new CadMiddlePanController( input, pick, params?): CadMiddlePanController

Parameters

ParameterType
inputControllerInput
pickPickContext
params?FlightControllerParams

Returns

CadMiddlePanController

Overrides

FlightController.constructor

Source

@novorender/web_app/controller/flight.ts:406

Properties

input

readonly input: ControllerInput

The input source for this controller.

Inherited from

FlightController.input

Source

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


kind

kind: "cadMiddlePan"

The controller type id.

Overrides

FlightController.kind

Source

@novorender/web_app/controller/flight.ts:404


pick

readonly pick: PickContext

The context used for pick queries.

Inherited from

FlightController.pick

Source

@novorender/web_app/controller/flight.ts:406


projection

projection: "pinhole"

The camera projection kind.

See

RenderStateCamera.kind.

Inherited from

FlightController.projection

Source

@novorender/web_app/controller/flight.ts:20

Accessors

axes

get axes(): ControllerAxes

The input axes

Returns

ControllerAxes

Inherited from

FlightController.axes

Source

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

See

ControllerInput.axes


currentFlyTo

get currentFlyTo(): undefined | Orientation

The current fly-to state, if any.

Returns

undefined | Orientation

Inherited from

FlightController.currentFlyTo

Source

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


fov

get set fov(): number

The camera vertical field of view angle, in degrees.

Returns

number

Inherited from

FlightController.fov

Source

@novorender/web_app/controller/flight.ts:89


generation

get generation(): number

Camera controller state generation.

Returns

number

Inherited from

FlightController.generation

Source

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

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.


hasShift

get hasShift(): boolean

The input shift button state.

Returns

boolean

Inherited from

FlightController.hasShift

Source

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

See

ControllerInput.hasShift


height

get height(): number

The input element height.

Returns

number

Inherited from

FlightController.height

Source

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

See

ControllerInput.height


moving

get moving(): boolean

Whether the camera is currently considered moving or not.

Returns

boolean

Inherited from

FlightController.moving

Source

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

See

View.isIdleFrame


multiplier

get multiplier(): number

The input multiplier.

Returns

number

Inherited from

FlightController.multiplier

Source

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

See

ControllerInput.multiplier


pitch

get set pitch(): number

The camera pitch angle, in degrees.

Returns

number

Inherited from

FlightController.pitch

Source

@novorender/web_app/controller/flight.ts:71


pivot

get pivot(): undefined | Pivot

The optional pivot point to orbit around, in world space.

Returns

undefined | Pivot

Inherited from

FlightController.pivot

Source

@novorender/web_app/controller/flight.ts:98


pointerTable

get pointerTable(): readonly TouchContactPoint[]

The input pointer table.

Returns

readonly TouchContactPoint[]

Inherited from

FlightController.pointerTable

Source

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

See

ControllerInput.touchPoints


position

get set position(): ReadonlyVec3

Camera position, in world space.

Returns

ReadonlyVec3

Inherited from

FlightController.position

Source

@novorender/web_app/controller/flight.ts:54


rotation

get rotation(): ReadonlyQuat

Computed rotation quaternion, in world space.

Returns

ReadonlyQuat

Inherited from

FlightController.rotation

Source

@novorender/web_app/controller/flight.ts:66

Remarks

This rotation is derived from pitch and yaw angles.


width

get width(): number

The input element width.

Returns

number

Inherited from

FlightController.width

Source

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

See

ControllerInput.width


yaw

get set yaw(): number

The camera yaw angle, in degrees.

Returns

number

Inherited from

FlightController.yaw

Source

@novorender/web_app/controller/flight.ts:80


zoomPos

get zoomPos(): number[]

The input zoom position.

Returns

number[]

Inherited from

FlightController.zoomPos

Source

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

See

ControllerInput.zoomPos

Methods

animate

animate(elapsedTime): void

Apply time sensitive changes to controller state.

Parameters

ParameterTypeDescription
elapsedTimenumberThe # of milliseconds elapsed since the last update.

Returns

void

Inherited from

FlightController.animate

Source

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

Remarks

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


attach

attach(): void

Attach this controller to the input object

Returns

void

Inherited from

FlightController.attach

Source

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


autoFit

autoFit(center, radius): void

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

Parameters

ParameterTypeDescription
centerReadonlyVec3The center of the bounding sphere, in world space.
radiusnumberThe radius of the bounding sphere, in world space.

Returns

void

Inherited from

FlightController.autoFit

Source

@novorender/web_app/controller/flight.ts:132


changed

protected changed(): void

Signal changes to internal state.

Returns

void

Inherited from

FlightController.changed

Source

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


getTransformations

getTransformations(): CameraTransformations

Function to get transformations since last updated. This can be overwritten to easily change direction and scale of input while keeping the standard caluculation for flight controller

Returns

CameraTransformations

Overrides

FlightController.getTransformations

Source

@novorender/web_app/controller/flight.ts:412


init

init(params): void

Initialize controller from parameters.

Parameters

ParameterType
paramsControllerInitParams

Returns

void

Inherited from

FlightController.init

Source

@novorender/web_app/controller/flight.ts:115

See

serialize


modifiers

protected modifiers(): object

Function for getting input modifiers based on how far the 3d objects are from the mouse cursor

Returns

mousePanModifier

mousePanModifier: number

mouseWheelModifier

mouseWheelModifier: number

pinchModifier

pinchModifier: number

scale

scale: number = 20

touchMovementModifier

touchMovementModifier: number

Inherited from

FlightController.modifiers

Source

@novorender/web_app/controller/flight.ts:337


mouseButtonChanged

mouseButtonChanged(event): Promise\< void >

Handler for mouse buttons events.

Parameters

ParameterType
eventMouseEvent

Returns

Promise\< void >

Inherited from

FlightController.mouseButtonChanged

Source

@novorender/web_app/controller/flight.ts:251


moveBegin

moveBegin(event): Promise\< void >

Handler for mouse/touch move events.

Parameters

ParameterType
eventMouseEvent | TouchEvent

Returns

Promise\< void >

Inherited from

FlightController.moveBegin

Source

@novorender/web_app/controller/flight.ts:284


moveTo

moveTo( targetPosition, flyTime = 1000, rotation?): void

Move controller to specified position/rotation.

Parameters

ParameterTypeDefault value
targetPositionReadonlyVec3undefined
flyTimenumber1000
rotation?ReadonlyQuatundefined

Returns

void

Inherited from

FlightController.moveTo

Source

@novorender/web_app/controller/flight.ts:141


renderStateChanges

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

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

Parameters

ParameterTypeDescription
stateRenderStateCameraThe baseline render state.
elapsedTimenumberThe time elapsed since last call, in milliseconds.

Returns

undefined | RecursivePartial\< RenderState >

Inherited from

FlightController.renderStateChanges

Source

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


serialize

serialize(): ControllerInitParams

Serialize the state of this controller into init parameters.

Returns

ControllerInitParams

Inherited from

FlightController.serialize

Source

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

See

init


setFlyTo

protected setFlyTo(flyTo): void

Initialize a fly-to transition.

Parameters

ParameterTypeDescription
flyToFlyToParamsThe transition parameters

Returns

void

Inherited from

FlightController.setFlyTo

Source

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


stateChanges

stateChanges(state?): Partial\< RenderStateCamera >

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

Parameters

ParameterTypeDescription
state?RenderStateCameraThe baseline state to apply changes to.

Returns

Partial\< RenderStateCamera >

Inherited from

FlightController.stateChanges

Source

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

See

View.modifyRenderState

Remarks

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


touchChanged

touchChanged(event): Promise\< void >

Handler for touch events.

Parameters

ParameterType
eventTouchEvent

Returns

Promise\< void >

Inherited from

FlightController.touchChanged

Source

@novorender/web_app/controller/flight.ts:268


update

update(): void

Update internal controller state

Returns

void

Inherited from

FlightController.update

Source

@novorender/web_app/controller/flight.ts:187


updateParams

updateParams(params): void

Update controller parameters.

Parameters

ParameterTypeDescription
paramsRecursivePartial\< FlightControllerParams >Set of parameters to change.

Returns

void

Inherited from

FlightController.updateParams

Source

@novorender/web_app/controller/flight.ts:105


zoomTo

zoomTo(boundingSphere, flyTime = 1000): void

Bring the specified bounding sphere into view.

Parameters

ParameterTypeDefault value
boundingSphereBoundingSphereundefined
flyTimenumber1000

Returns

void

Inherited from

FlightController.zoomTo

Source

@novorender/web_app/controller/flight.ts:168

Remarks

This function will retain the current camera controller rotation.


assert

static assert(controller): asserts controller is FlightController

FlightController type assert function.

Parameters

ParameterTypeDescription
controllerBaseControllerThe controller to type assert.

Returns

asserts controller is FlightController

Inherited from

FlightController.assert

Source

@novorender/web_app/controller/flight.ts:390


getDistanceFromViewPlane

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

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

Parameters

ParameterTypeDescription
pointReadonlyVec3The point to measure distance too
cameraPositionReadonlyVec3The position of the camera/view plane.
cameraRotationReadonlyQuatThe 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

FlightController.getDistanceFromViewPlane

Source

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


is

static is(controller): controller is FlightController

FlightController type guard function.

Parameters

ParameterTypeDescription
controllerBaseControllerThe controller to type guard.

Returns

controller is FlightController

Inherited from

FlightController.is

Source

@novorender/web_app/controller/flight.ts:383