new RenderDisplay(viewer)
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) onDisplayChange :FORGE.EventDispatcher
Get the onDisplayChange FORGE.EventDispatcher.
Type:
- Source:
(readonly) presentingVR :boolean
Presenting in VR or not.
Type:
- boolean
- 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:
(readonly) vrDisplay :VRDisplay
Get the VR display.
Type:
- VRDisplay
- Source:
(readonly) vrFrameData :VRFrameData
Get the VR display.
Type:
- VRFrameData
- Source:
warning :boolean
Get and set the warning flag.
Type:
- boolean
- Inherited From:
- Source:
Methods
destroy()
Destroy sequence
- Overrides:
- Source:
disableVR()
Start or stop VR display
- Source:
enableVR()
Enable VR display
- Source:
getRenderParams() → {Array.<FORGE.RenderParams>}
Get render parameters
- Source:
Returns:
Returns an array of render parameters.
- Type
- Array.<FORGE.RenderParams>
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:
setSize(size)
Set size of rendering objects
Parameters:
Name | Type | Description |
---|---|---|
size |
FORGE.Size | new renderer size |
- Source:
submitFrame()
Submit current frame to VR display interface
- 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: