FORGE. CameraGaze

new CameraGaze(viewer)

Gaze Cursor base class. Draw a geometry on the camera space for gaze selection.
Parameters:
Name Type Description
viewer FORGE.Viewer viewer reference.
Source:

Extends

Members

(readonly) alive :boolean

Get the alive flag value of the object.
Type:
  • boolean
Inherited From:
Source:

(readonly) className :string

Get the class name of the object.
Type:
  • string
Inherited From:
Source:

data :*

Get and set any custom data you want to associate to this object.
Type:
  • *
Inherited From:
Source:

debug :boolean

Get and set the debug flag.
Type:
  • boolean
Inherited From:
Source:

(readonly) object :THREE.Mesh

3D object
Type:
  • THREE.Mesh
Source:

(readonly) onDestroy :FORGE.EventDispatcher

Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
Inherited From:
Source:

(readonly) tags :Array

Get the tags associated to this object.
Type:
  • Array
Inherited From:
Source:

(readonly) uid :string

Get the uid of the object.
Type:
  • string
Inherited From:
Source:

visible :boolean

Visibility flag.
Type:
  • boolean
Source:

warning :boolean

Get and set the warning flag.
Type:
  • boolean
Inherited From:
Source:

Methods

destroy()

Destroy sequence.
Overrides:
Source:

load(config)

Loads a configuration for gaze cursors.
Parameters:
Name Type Description
config CameraGazeConfig The configuration to load.
Source:

log(value)

Basic log method, log a string in the console if debug is enabled.
Parameters:
Name Type Description
value * The value you want to log in the console.
Inherited From:
Source:

start()

Starts the gaze timer, this is called from the raycaster.
Source:

stop()

Stops the gaze timer, this is called from the raycaster.
Source:

update()

Update loop of the gaze cursor, it updates the graphics according to the progress percentage of the timer.
Source:

warn(valuenullable)

Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
Name Type Attributes Description
value string | Object <nullable>
The value you want to warn in the console.
Inherited From:
Source:

FORGE. CameraGaze

Members
Methods