FORGE. RenderPipeline

new RenderPipeline(viewer)

FXComposer class.
Parameters:
Name Type Description
viewer FORGE.Viewer viewer reference
Source:
To Do:
  • think about how to render multiple scene at the same time, with blending / overlap / viewport layouting... maybe add a layer object encapsulating background / foreground renderings to ease the process

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:

enabled :boolean

FX pipeline status.
Type:
  • boolean
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

addBackground(texture, fxSet, opacityopt)

Add background to the rendering pipeline.
Parameters:
Name Type Attributes Description
texture THREE.Texture texture object used as background.
fxSet Array.<FX> image fx set to apply to background only.
opacity number <optional>
 texture pass opacity
Source:

addGlobalFx(fxSet)

Add fx at the end of the whole rendering pipeline
Parameters:
Name Type Description
fxSet Array.<FX> set of effects
Source:

addRenderScenes(renderScenes)

Add render scenes to the rendering pipeline
Parameters:
Name Type Description
renderScenes Array.<FORGE.RenderScene> array of render scenes
Source:

clear()

Clear composer components
Source:

destroy()

Destroy sequence
Overrides:
Source:

enablePicking(status, materialopt, renderTargetopt)

Enable/Disable picking.
Parameters:
Name Type Attributes Description
status boolean new picking state
material THREE.Material <optional>
 picking material
renderTarget THREE.WebGLRenderTarget <optional>
 picking render target
Source:

getShaderPassByUID(uid) → {THREE.Pass}

Get a shader pass with an UID
Parameters:
Name Type Description
uid string the uid of the ShaderPass
Source:
Returns:
shader pass
Type
THREE.Pass

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:

render(camera)

Render routine
Parameters:
Name Type Description
camera THREE.PerspectiveCamera The camera to use for render.
Source:

setSize(size)

Set size of each composers
Parameters:
Name Type Description
size FORGE.Size new composer size
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:

FORGE. RenderPipeline

Members
Methods