SphereControls
Class: SphereControls
Drag / wheel / keyboard orbit controller for looking around an equirectangular sphere, with inertia; its animations run on the viewer's shared tween group.
Extends
EventDispatcher<Events>
Constructors
Constructor
new SphereControls(
element,camera,sphere,config?):SphereControls
Parameters
element
HTMLElement
camera
PerspectiveCamera
sphere
Object3D
config?
SphereControlsConfig = {}
Returns
SphereControls
Overrides
EventDispatcher<Events>.constructor
Properties
_autoRotate
_autoRotate:
boolean=false
_lat
_lat:
number=0
_lon
_lon:
number=0
autoRotateSpeed
autoRotateSpeed:
number=0.05
autoRotateTimestamp
autoRotateTimestamp:
number=0
camera
camera:
PerspectiveCamera
config
config:
SphereControlsConfig
defaultFov
defaultFov:
number=65
isUserInteracting
isUserInteracting:
boolean=false
maxFov
maxFov:
number=100
minFov
minFov:
number=20
onMouseDownLat
onMouseDownLat:
number=0
onMouseDownLon
onMouseDownLon:
number=0
onMouseDownMouseX
onMouseDownMouseX:
number=0
onMouseDownMouseY
onMouseDownMouseY:
number=0
sensibility
sensibility:
number=0.1
sphere
sphere:
Object3D
Accessors
autoRotate
Get Signature
get autoRotate():
boolean
Returns
boolean
Set Signature
set autoRotate(
autoRotate):void
Parameters
autoRotate
boolean
Returns
void
lat
Get Signature
get lat():
number
Returns
number
Set Signature
set lat(
lat):void
Parameters
lat
number
Returns
void
lon
Get Signature
get lon():
number
Returns
number
Set Signature
set lon(
lon):void
Parameters
lon
number
Returns
void
Methods
addEventListener()
Call Signature
addEventListener<
T>(type,listener):void
Adds a listener to an event type.
Type Parameters
T
T extends keyof Events
Parameters
type
T
The type of event to listen to.
listener
EventListener<Events[T], T, SphereControls>
The function that gets called when the event is fired.
Returns
void
Inherited from
EventDispatcher.addEventListener
Call Signature
addEventListener<
T>(type,listener):void
Adds a listener to an event type.
Type Parameters
T
T extends string
Parameters
type
T
The type of event to listen to.
listener
EventListener<{ }, T, SphereControls>
The function that gets called when the event is fired.
Returns
void
Inherited from
EventDispatcher.addEventListener
dispatchEvent()
dispatchEvent<
T>(event):void
Fire an event type.
Type Parameters
T
T extends keyof Events
Parameters
event
BaseEvent<T> & Events[T]
The event that gets fired.
Returns
void
Inherited from
EventDispatcher.dispatchEvent
dispose()
dispose():
void
Detach every listener. Call from the viewer's destroy().
Returns
void
hasEventListener()
Call Signature
hasEventListener<
T>(type,listener):boolean
Checks if listener is added to an event type.
Type Parameters
T
T extends keyof Events
Parameters
type
T
The type of event to listen to.
listener
EventListener<Events[T], T, SphereControls>
The function that gets called when the event is fired.
Returns
boolean
Inherited from
EventDispatcher.hasEventListener
Call Signature
hasEventListener<
T>(type,listener):boolean
Checks if listener is added to an event type.
Type Parameters
T
T extends string
Parameters
type
T
The type of event to listen to.
listener
EventListener<{ }, T, SphereControls>
The function that gets called when the event is fired.
Returns
boolean
Inherited from
EventDispatcher.hasEventListener
onDocumentMouseWheel()
onDocumentMouseWheel(
event):void
Parameters
event
WheelEvent
Returns
void
onPointerMove()
onPointerMove(
event):void
Parameters
event
MouseEvent | TouchEvent
Returns
void
onPointerStart()
onPointerStart(
event):void
Parameters
event
MouseEvent | TouchEvent
Returns
void
onPointerUp()
onPointerUp(
event):void
Parameters
event
MouseEvent | TouchEvent
Returns
void
removeEventListener()
Call Signature
removeEventListener<
T>(type,listener):void
Removes a listener from an event type.
Type Parameters
T
T extends keyof Events
Parameters
type
T
The type of the listener that gets removed.
listener
EventListener<Events[T], T, SphereControls>
The listener function that gets removed.
Returns
void
Inherited from
EventDispatcher.removeEventListener
Call Signature
removeEventListener<
T>(type,listener):void
Removes a listener from an event type.
Type Parameters
T
T extends string
Parameters
type
T
The type of the listener that gets removed.
listener
EventListener<{ }, T, SphereControls>
The listener function that gets removed.
Returns
void
Inherited from
EventDispatcher.removeEventListener
retrieveLatLonFromCamera()
retrieveLatLonFromCamera():
void
Returns
void
update()
update():
void
Returns
void
updateFov()
updateFov(
fov):void
Parameters
fov
number
Returns
void