new HotspotAnimation(viewer, hotspotTransform)
A FORGE.HotspotAnimation is used to animate a hotspot.
Parameters:
| Name | Type | Description |
|---|---|---|
viewer |
FORGE.Viewer | FORGE.Viewer reference |
hotspotTransform |
FORGE.HotspotTransform | FORGE.HotspotTransform reference |
- Source:
Extends
Members
(readonly) alive :boolean
Get the alive flag value of the object.
Type:
- boolean
- Inherited From:
- Source:
(readonly) autoPlay :boolean
Does the animation auto play.
Type:
- boolean
- 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) enabled :boolean
Enabled flag.
Type:
- boolean
- Source:
(readonly) onComplete :FORGE.EventDispatcher
Get the "onComplete" FORGE.EventDispatcher of the target.
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) onProgress :FORGE.EventDispatcher
Get the "onProgress" FORGE.EventDispatcher of the target.
Type:
- Source:
(readonly) running :boolean
Accessors to timeline
Type:
- boolean
- 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:
warning :boolean
Get and set the warning flag.
Type:
- boolean
- Inherited From:
- Source:
Methods
destroy()
Destroy sequence.
- Overrides:
- Source:
load(config)
Load an animation configuration.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
HotspotTrackConfig | The animation config 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:
play(trackopt)
Play a set of tracks if specified, else the current one, from the start.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
track |
string | number |
<optional> |
A track |
- Source:
resume()
Resume the animations.
- Inherited From:
- Source:
stop()
Stop the animations.
- Inherited From:
- 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: