new ControllerBase(viewer, classNameopt)
FORGE.ControllerBase
CameraBaseController class.
Base controller class
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
viewer |
FORGE.Viewer | viewer reference. | |
className |
string |
<optional> |
subclass className |
- Source:
Extends
Members
(readonly) active :boolean
Get the "active" flag of the camera controller. A controller is active when it is currently in use.
Type:
- boolean
- Source:
(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:
enabled :boolean
Get or set the enabled flag.
Type:
- boolean
- Source:
(readonly) onControlEnd :FORGE.EventDispatcher
Get the "onControlEnd" FORGE.EventDispatcher of the camera controller.
Type:
- Source:
(readonly) onControlStart :FORGE.EventDispatcher
Get the "onControlStart" FORGE.EventDispatcher of the camera controller.
Type:
- 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) type :string
Get type of the controller.
Type:
- string
- 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
disable()
Disable control.
- Source:
enable()
Enable control.
- 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: