new DisplayList(viewer)
Manage Display Objects list and fullscreen events.
Parameters:
| Name | Type | Description |
|---|---|---|
viewer |
FORGE.Viewer | Viewer reference. |
- Source:
Extends
Members
(static) types :Array.<string>
Types of display objects.
Type:
- Array.<string>
- 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:
(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
destroy()
Destroy sequence
- Overrides:
- 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:
register(object, updateopt)
Registers a display object in the display list.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
object |
FORGE.DisplayObject | The display object to register. | |
update |
boolean |
<optional> |
Is this display object needs to be updated updated? |
- Source:
unregister(object)
Unregister a display object from the display list.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
FORGE.DisplayObject | The object to unregister from the display list. |
- 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: