new HotspotTransform()
HotspotTransform handle the parsing of the position, rotation and scale of a 3d Hotspot.
- 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) onDestroy :FORGE.EventDispatcher
Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
- Inherited From:
- Source:
position :HotspotTransformPosition
Get/set the spherical position of the transform object
Type:
- HotspotTransformPosition
- Source:
rotation :HotspotTransformRotation
Get/set the rotation of the transform object
Type:
- HotspotTransformRotation
- Source:
scale :HotspotTransformScale
Get/set the scale of the transform object
Type:
- HotspotTransformScale
- 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:
dump() → {HotspotTransformConfig}
Dump the transform actual configuration
- Source:
Returns:
Return the hotspot transform configuration
- Type
- HotspotTransformConfig
load(config, notifyopt)
Load a transform configuration.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config |
HotspotTransformConfig | The transform config to load. | ||
notify |
boolean |
<optional> |
true | Do we have to notify the change of the transform after the config loading |
- 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:
notifyChange()
Notify the transform that a value has changed.
- Source:
updateFromObject3D(object)
Update all the transform values from the mesh.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
THREE.Object3D | The 3D object to read data 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: