FORGE. Hotspot3D

new Hotspot3D(viewer, config)

FORGE.Hotspot3D Abstract base class for projeted views. Should be subclassed for every supported projection / view type.
Parameters:
Name Type Description
viewer FORGE.Viewer viewer reference
config HotspotConfig hostspot configuration
Source:

Extends

Members

(readonly) alive :boolean

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

(readonly) animation :FORGE.HotspotAnimation

Hotspot animation accessor
Type:
Source:

(readonly) className :string

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

(readonly) config :HotspotConfig

Hotspot config accessor
Type:
  • HotspotConfig
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) events :Object

Get the events of this object
Type:
  • Object
Inherited From:
Source:

(readonly) fx :string

Get the FX applied to this object
Type:
  • string
Inherited From:
Source:

(readonly) geometry :FORGE.HotspotGeometry

Hotspot geometry accessor
Type:
Source:

hovered :boolean

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

interactive :boolean

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

(readonly) material :FORGE.HotspotMaterial

Hotspot material accessor
Type:
Source:

(readonly) mesh :THREE.Mesh

3D object mesh
Type:
  • THREE.Mesh
Inherited From:
Source:

name :string

Hotspot name accessor
Type:
  • string
Source:

(readonly) onClick :FORGE.EventDispatcher

Get the onClick FORGE.EventDispatcher.
Type:
Inherited From:
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) onOut :FORGE.EventDispatcher

Get the onOut FORGE.EventDispatcher.
Type:
Inherited From:
Source:

(readonly) onOver :FORGE.EventDispatcher

Get the onOver FORGE.EventDispatcher.
Type:
Inherited From:
Source:

(readonly) onReady :FORGE.EventDispatcher

Get the onReady FORGE.EventDispatcher.
Type:
Inherited From:
Source:

(readonly) ready :boolean

Hotspot3D ready flag
Type:
  • boolean
Overrides:
Source:

(readonly) sound :FORGE.HotspotSound

Hotspot sound accessor
Type:
Source:

(readonly) states :FORGE.HotspotStates

Hotspot states accessor
Type:
Source:

(readonly) states :FORGE.HotspotStates

Hotspot states accessor
Type:
Source:

(readonly) tags :Array

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

(readonly) transform :FORGE.HotspotTransform

Hotspot transform accessor
Type:
Source:

(readonly) uid :string

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

visible :boolean

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

warning :boolean

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

Methods

click()

Triggers actions for the click event
Inherited From:
Source:

destroy()

Destroy routine
Overrides:
Source:

dump() → {HotspotConfig}

Dump the hotspot actual configuration
Source:
Returns:
Return the hotspot actual configuration object
Type
HotspotConfig

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:

out()

Override of the out method to trigger the state change
Overrides:
Source:

over()

Override of the over method to trigger the state change
Overrides:
Source:

update()

Update hotspot content
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. Hotspot3D

Members
Methods