FORGE. BackgroundShaderRenderer

new BackgroundShaderRenderer(viewer, target, options)

FORGE.BackgroundShaderRenderer BackgroundShaderRenderer class.
Parameters:
Name Type Description
viewer FORGE.Viewer viewer reference
target THREE.WebGLRenderTarget render target
options SceneMediaOptionsConfig the options for the cubemap
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:

displayObject :string

Get/Set background renderer displayObject.
Type:
  • string
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:

renderTarget :THREE.WebGLRenderTarget

Get background render target.
Type:
  • THREE.WebGLRenderTarget
Inherited From:
Source:

scene :THREE.Scene

Get background scene.
Type:
  • THREE.Scene
Inherited From:
Source:

(readonly) tags :Array

Get the tags associated to this object.
Type:
  • Array
Inherited From:
Source:

texture :string

Get background renderer texture.
Type:
  • string
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:

render(cameranullable)

Do preliminary job of specific background renderer, then summon superclass method
Parameters:
Name Type Attributes Description
camera THREE.PerspectiveCamera <nullable>
perspective camera
Overrides:
Source:

setSize(size)

Update size (resolution)
Parameters:
Name Type Description
size FORGE.Size size [px]
Inherited From:
Source:

update()

Update routine.
Inherited From:
Source:

updateAfterViewChange()

Update after view change
Overrides:
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. BackgroundShaderRenderer

Members
Methods