FORGE. RenderManager

new RenderManager(viewer)

RenderManager 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

(static) DEPTH_FAR :number

Render manager constant far depth
Type:
  • number
Source:

(static) DEPTH_NEAR :number

Render manager constant near depth
Type:
  • number
Source:

(readonly) alive :boolean

Get the alive flag value of the object.
Type:
  • boolean
Inherited From:
Source:

(readonly) backgroundReady :boolean

Get the backgroundReady flag
Type:
  • boolean
Source:

(readonly) backgroundRenderer :FORGE.BackgroundMeshRenderer|FORGE.BackgroundShaderRenderer

Get background renderer.
Type:
Source:

(readonly) camera :FORGE.Camera

Get camera.
Type:
Source:

(readonly) canvasResolution :FORGE.Size

Get canvas resolution in pixels.
Type:
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) display :FORGE.RenderDisplay

Get the render display.
Type:
Source:

(readonly) displayResolution :FORGE.Size

Get display resolution in pixels.
Type:
Source:

(readonly) mediaSound :FORGE.Sound|Object

Get sound linked to the media.
Type:
Source:

(readonly) objects :FORGE.ObjectRenderer

Get the FORGE.ObjectRenderer instance
Type:
Source:

(readonly) onAfterRender :FORGE.EventDispatcher

Get the onAfterRender FORGE.EventDispatcher.
Type:
Source:

(readonly) onBackgroundReady :FORGE.EventDispatcher

Get the onBackgroundReady FORGE.EventDispatcher.
Type:
Source:

(readonly) onBeforeRender :FORGE.EventDispatcher

Get the onBeforeRender FORGE.EventDispatcher.
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:

pickingManager :FORGE.PickingManager

Get picking manager.
Type:
Source:

(readonly) presentingVR :boolean

VR presenting status.
Type:
  • boolean
Source:

(readonly) renderPipeline :FORGE.RenderPipeline

Get FX Composer.
Type:
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:

view :FORGE.ViewManager

Get the view manager.
Type:
Source:

(readonly) viewer :FORGE.Viewer

Get viewer.
Type:
Source:

warning :boolean

Get and set the warning flag.
Type:
  • boolean
Inherited From:
Source:

(readonly) WebGLRenderer :THREE.WebGLRenderer

Get WebGL renderer.
Type:
  • THREE.WebGLRenderer
Source:

Methods

destroy()

Renderer destroy sequence
Overrides:
Source:

disableVR()

Disable VR display
Source:

enableVR()

Enable VR display
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:

render()

Render routine
Source:

toggleVR()

Toggle VR display
Source:

update()

Update routine
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. RenderManager

Members
Methods