Skip to content

Latest commit

 

History

History
261 lines (164 loc) · 5.51 KB

PLUGINS.md

File metadata and controls

261 lines (164 loc) · 5.51 KB

Documentation for addons provided by the project and in the examples folder.

Plugin documentation has been moved to the plugins directory.

Controls

EnvironmentControls

.enabled

enabled = true : boolean

Whether the controls are enabled and active.

.enableDamping

enableDamping = false : boolean

Flag indicating whether residual inertial animation is played after interaction finishes.

.constructor

constructor(
	scene = null : Scene,
	camera = null : Camera,
	domElement = null : DomElement,
)

Takes the scene to raycast against for click events, the camera being animated, and the dom element to listen for clicks on.

.attach

attach( domElement : DomElement ) : void

The dom element to attach to for events.

.detach

detach() : void

Detaches from the current dom element.

.setCamera

setCamera( camera : Camera | null ) : void

Sets the camera the controls are using.

.setScene

setScene( scene : Object3D | null ) : void

The scene to raycast against for control interactions.

.update

update( deltaTime = null ) : void

Updates the controls. Takes a delta time value in seconds to normalize inertia and damping speeds. Defaults to the time between call to the function.

.dispose

dispose() : void

Detaches all events and makes the controls unusable.

.getPivotPoint

getPivotPoint( target : Vector3 ) : target

Gets the last used interaction point.

.adjustCamera

updateCameraClipPlanes( camera : Camera ) : void

Updates the clip planes and position of the given camera so the globe is encapsulated correctly and is positioned appropriately above the terrain. Used when working with the transition manager to make sure both cameras being transitioned are positioned properly.

GlobeControls

extends EnvironmentControls

.nearMargin

nearMargin = 0.25 : number

The margin around the globe to include when positioning the camera near plane as a percentage of the max radius of the tileset ellipsoid. Useful for ensuring visualizations and other models are visible around the globe.

Default is 25%.

.farMargin

farMargin = 0 : number

The margin around the globe to include when positioning the camera far plane as a percentage of the max radius of the tileset ellipsoid. Useful for ensuring visualizations and other models are visible around the globe.

Default is 0%.

.constructor

constructor(
	scene = null : Scene,
	camera = null : Camera,
	domElement = null : DomElement,
)

Takes the same items as EnvironmentControls in addition to the Google globe tiles renderer.

.setEllipsoid

setEllipsoid( ellipsoid: Ellipsoid | null, ellipsoidGroup: Object3D | null ): void

Specifies the ellipsoid and a group representing the frame of the ellipsoid. Handles to both objects are retained so transformations can be respected.

CameraTransitionManager

Helper class for performing a transition animation between a perspective and orthographic camera.

const transition = new CameraTransitionManager( perspCamera, orthoCamera );
toggleButton.addEventListener( 'click', () => transition.toggle() );

// ...

renderer.setAnimationLoop( () => {

    // set transition.fixedPoint to point that should remain stable

    transition.update();
    renderer.render( transition.camera, scene );

} );

.fixedPoint

fixedPoint = ( 0, 0, 0 ) : Vector3

The point that will represents the plan that will remain fixed during the animation. This point should be in front of the cameras.

.animating

readonly animation : boolean

A flag indicating whether the transition is currently animating or not.

.mode

mode : 'perspective' | 'orthographic

The current mode of the camera that is active or being transitioned to. Setting this field will immediately change the camera.

.duration

durtion = 200 : Number

The length of time it takes to transition the camera in milliseconds.

.camera

readonly camera : Camera

The current camera to render with. Switches between the perspective camera, orthographic camera, and animated transition camera.

.orthographicPositionalZoom

orthographicPositionalZoom = true : boolean

Whether the orthographic camera position should be updated so be synchronized with the necessary perspective camera position so the orthographic near clip planes do not get into into unexpected configurations.

.autoSync

autoSync = true : boolean

Whether to automatically call the "syncCameras" function when so cameras are implicitly positioned correctly for transitioning. Disable this if syncing will happen manually and small adjustments can be made.

.easeFunction

easeFunction = x => x : ( alpha: number ) => number

Function for defining the transition curve between cameras.

.constructor

constructor( perspectiveCamera : PerspectiveCamera, orthographicCamera : OrthographicCamera )

Constructor takes the two cameras to animate between.

.update

update( deltaTime = null : number ) : void

Performs the transition animation if active. Takes a delta time value in seconds to normalize inertia and damping speeds. Defaults to the time between call to the function.

.syncCameras

syncCameras() : void

Synchronizes the two camera positions and views based on the focus point.

.toggle

toggle() : void

Starts the transition animation.