new Raycaster(viewer)
Raycaster for mouse interaction with 3d objects of the scene
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) 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:
warning :boolean
Get and set the warning flag.
Type:
- boolean
- Inherited From:
- Source:
Methods
_start(mode)
Start raycasting.
Add event on the main canvas for mouse interaction
Parameters:
| Name | Type | Description |
|---|---|---|
mode |
string | picking mode |
- Source:
_stop()
Stop raycasting, removes all event listeners
- Source:
clear()
Clear raycaster.
Release all references related to the scene
- Source:
click()
Triggers the click method of the hovered object if exists.
- Source:
destroy()
Basic destroy method, prevent double destroy, change the alive flag.
- Inherited From:
- 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:
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: