Preview

Preview

Extends: Deletable

Previews are 3D viewports, that can either be used as a viewport for the user, or as an offscreen view to record media.

new Preview( options )

Creates a new Preview

Arguments:

• options: PreviewOptions
  • id: string
  • antialias: boolean (Optional)

Property	Type	Description
id	string
canvas	HTMLCanvasElement
height	number
width	number
node	HTMLElement
isOrtho	boolean	True if the preview is in orthographic camera mode
angle	null or number	Angle, when in a specific side view
camera	THREE.PerspectiveCamera or THREE.OrthographicCamera
camPers	THREE.PerspectiveCamera
camOrtho	THREE.OrthographicCamera
controls	any
annotations	any
renderer	THREE.WebGLRenderer
background	See types
raycaster	Raycaster
mouse	Vector2

delete()

raycast( event )

Arguments:

• event: MouseEvent

Returns: false or RaycastResult

render()

setProjectionMode( orthographic )

Arguments:

• orthographic: boolean

Returns: Preview

setFOV( fov )

Arguments:

• fov: number

setLockedAngle( angle )

Arguments:

• angle: number

Returns: Preview

loadAnglePreset( angle_preset )

Arguments:

• angle_preset: AnglePreset
  • position: ArrayVector3
  • target: ArrayVector3 (Optional)
  • rotation: ArrayVector3 (Optional)
  • projection: "unset" or "orthographic" or "perspective"
  • zoom: number (Optional)
  • focal_length: number (Optional)
  • lockedAngle: number (Optional)

Returns: Preview

newAnglePreset()

Opens a dialog to create and save a new angle preset

Returns: Preview

getFacingDirection()

Returns: "east" or "west" or "south" or "north"

getFacingHeight()

Returns: "up" or "down" or "middle"

occupyTransformer()

Returns: Preview

showContextMenu( event )

Arguments:

• event: HTMLElement or Event

Returns: Preview

loadBackground()

all

Static Property

Type: Array of Preview

List of all previews

selected

Static Property

Type: Preview

The last used preview

animate()

Global Function