new RenderScene(viewer, scene, camera, fxConfig)
A render scene is an object responsible of preparing the draw of a scene
with a camera, applying a set of image effect.
It creates an effect composer that will be called by render loop.
It writes the resulting image into a texture used in main render pipeline.
Parameters:
| Name | Type | Description |
|---|---|---|
viewer |
FORGE.Viewer | viewer reference |
scene |
THREE.Scene | scene to render |
camera |
THREE.Camera | camera used to render the scene |
fxConfig |
Array.<FX> | image fx configuration object |
- 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
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:
setSize(width, height)
Set size of each pass of the render scene
Parameters:
| Name | Type | Description |
|---|---|---|
width |
number | composer width |
height |
number | composer height |
- 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: