On this page

Editor

Provides functionality for editing and manipulating 3D objects in a web-based environment.

Constructor

new Editor(frame3D, assetManager, options)

Parameters:

Name Type Description

frame3D

module:@ud-viz/frame3d~Planar | module:@ud-viz/frame3d~Base

frame 3d

assetManager

AssetManager

asset manager

options

object

options

Properties

Name	Type	Description
`externalScriptVariablesInputs`	Array	input to edit ExternalScriptComponent variables
`gameScriptVariablesInputs`	Array	input to edit GameScriptComponent variables
`userDataInputs`	Array	input to edit .userData
`object3DModels`	Array	models of object3D
`possibleExternalScriptIds`	Array	ids that can be added to a gameobject3d ExternalScriptComponent
`possibleGameScriptIds`	Array	ids that can be added to a gameobject3d GameScriptComponent
`userData`	object	user data

Source: index.js, line 72

Classes

Editor

Members

assetManager :AssetManager

Type:

AssetManager

Source: index.js, line 91

buttonTargetGameObject3D :HTMLElement

Type:

HTMLElement

Source: index.js, line 402

colliderParent :Object3D

Type:

Object3D

Source: index.js, line 472

currentGODomelement :HTMLElement

Type:

HTMLElement

Source: index.js, line 120

currentGameObject3D :GameObject3D|null

Type:

GameObject3D | null

Source: index.js, line 407

currentGameObjectMeshBox3 :Box3

Type:

Box3

Source: index.js, line 410

currentObjectInput :undefined|null

Type:

undefined | null

Source: index.js, line 585

frame3D :module:@ud-viz/frame3d~Planar|module:@ud-viz/frame3d~Base

Type:

module:@ud-viz/frame3d~Planar | module:@ud-viz/frame3d~Base

Source: index.js, line 88

gameObjectInput :GameObject3DInput

Type:

GameObject3DInput

Source: index.js, line 221

leftPan :HTMLElement

Type:

HTMLElement

Source: index.js, line 99

orbitControls :OrbitControls

Type:

OrbitControls

Source: index.js, line 327

process :RequestAnimationFrameProcess

Type:

RequestAnimationFrameProcess

Source: index.js, line 638

shapeContext :object

Type:

object

Source: index.js, line 485

toolsDomElement :HTMLElement

Type:

HTMLElement

Source: index.js, line 125

transformControls :TransformControls

Type:

TransformControls

Source: index.js, line 333

userData :object

Type:

object

Source: index.js, line 94

Methods

focusCurrentGameObject3D()

Move camera to focus current game object 3d

Source: index.js, line 802

selectGameObject3D(go, force)

Parameters:

Name	Type	Default	Description
`go`	GameObject3D		game object 3d to select for edition
`force`	boolean	false	force even if the selected gameobject3d is the same

Source: index.js, line 828

selectPointMesh(mesh)

Parameters:

Name	Type	Description
`mesh`	Mesh	point mesh to select with transform controls

Source: index.js, line 995

selectShape(shapeIndex)

Parameters:

Name	Type	Description
`shapeIndex`	number	index of the shape to select

Source: index.js, line 917

setCurrentGameObject3DJSON(gameObject3DJSON)

Parameters:

Name	Type	Description
`gameObject3DJSON`	object	json of the gameobject to set

Source: index.js, line 706

setOrbitControlsTargetTo(obj)

Parameters:

Name	Type	Description
`obj`	Object3D	object 3d to target

Source: index.js, line 815

updateBox3()

Update box3 wrapping selected game object 3d

Source: index.js, line 1090

updateCollider()

Update collider shapes in the 3D scene

Source: index.js, line 871

updateShapeSelected(rebuildShapeGeometry)

Update shape selected (when a property of the shape has changed)

Parameters:

Name	Type	Default	Description
`rebuildShapeGeometry`	boolean	true	shape selected needs to rebuild its geometry

Source: index.js, line 1005

(static) computeBox3GameObject3D(obj) → {Box3}

Parameters:

Name	Type	Description
`obj`	Object3D	object 3d to compute box3

Source: index.js, line 1130

Returns:

box 3 of the object 3d

Type:: Box3