FORGE. ObjectRenderer

new ObjectRenderer(viewer)

Parameters:
Name Type Description
viewer FORGE.Viewer FORGE.Viewer reference.
Source:

Extends

Members

(readonly) alive :boolean

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

all :Array.<FORGE.Object3D>

Get all the objects
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) onDestroy :FORGE.EventDispatcher

Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
Inherited From:
Source:

renderScenes :Array.<FORGE.RenderScene>

Get background renderer render items array.
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:

warning :boolean

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

Methods

clear()

Clear all render scenes
Source:

createRenderScenes()

Source:

destroy()

Destroy sequence
Overrides:
Source:

getByMesh() → (nullable) {FORGE.Object3D}

Get a 3d object from it's mesh
Source:
Returns:
Type
FORGE.Object3D

getRaycastable() → {Array.<FORGE.Object3D>}

Get 3d objects that are eligible to raycast (interactive)
Source:
Returns:
Type
Array.<FORGE.Object3D>

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:

register(object)

Register an object to the object renderer
Parameters:
Name Type Description
object FORGE.Object3D The object to register
Source:

unregister(object)

Unregister an object from the object renderer.
Parameters:
Name Type Description
object FORGE.Object3D The object to unregister from the object renderer.
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. ObjectRenderer

Members
Methods