Class: AbstractWidget

• new AbstractWidget(options)

• new AbstractWidget(options?)

Object3D.constructor

▸ add(object): AbstractWidget

Adds object as child of this object.

AbstractWidget

this

Object3D.add

▸ afterRender(scene, camera, plot, renderer): AbstractWidget

This function is called after rendering and can update this object's content.

It should not trigger any invalidateObject though.
Note that it is not necessary nor recommended to explicitly call afterRender on this object's children as beforeRender will be called on all nodes present in the scene.

This will be executed after the transformations simplification.

See

Plot for more details on the render steps

AbstractWidget

Object3D.afterRender

▸ beforeRender(scene, camera, plot, renderer): AbstractWidget

This function is called prior to rendering and can update this object's content.

It should not trigger any invalidateObject though.
Note that it is not necessary nor recommended to explicitly call beforeRender on this object's children as beforeRender will be called on all nodes present in the scene.

This will be executed after the transformations simplification.

See

Plot for more details on the render steps

AbstractWidget

Object3D.beforeRender

▸ dispose(): void

Dispose object

void

Object3D.dispose

▸ getClassName(): string

string

Object3D.getClassName

▸ getOptions(): Required<Options>

Get options

Required<Options>

options object

Object3D.getOptions

▸ getVisible(): boolean

Get visible

boolean

true, if object is visible

Object3D.getVisible

▸ invalidateObject<T>(event?): AbstractWidget

Notifies this object and its parent that this object has been invalidated.
If this object is in a Plot, it will be marked as dirty and will trigger a rendering cycle.

AbstractWidget

Object3D.invalidateObject

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Object3D.isDisposed

▸ isSelectable(): boolean

Return if this object can be picked/selected (see RendererPicking).

boolean

Object3D.isSelectable

▸ notify(type, source, args?): AbstractWidget

Notify listeners

AbstractWidget

this

Object3D.notify

▸ off(type?, callback?): AbstractWidget

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

AbstractWidget

this

Object3D.off

▸ off<E>(type, callback): AbstractWidget

AbstractWidget

Object3D.off

▸ on(type, callback, options?): AbstractWidget

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

AbstractWidget

this

Object3D.on

▸ on<E>(type, callback, options?): AbstractWidget

AbstractWidget

Object3D.on

▸ onStatsUpdated(metrics): AbstractWidget

This function is called when the plot has updated performance metric.
It will be called every set number of frames.
The number of frame is customizable in the plot options advancedrendering.performancemetrics.updateframeperiod and is 100 by default.

AbstractWidget

Object3D.onStatsUpdated

▸ Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

void

Object3D.onVisibilityChanged

▸ remove(object): AbstractWidget

Removes object as child of this object.

AbstractWidget

this

Object3D.remove

▸ setOptions(options?): AbstractWidget

Set options

AbstractWidget

this

Object3D.setOptions

▸ setPosition(position): AbstractWidget

Set Object's local position.

AbstractWidget

this

Object3D.setPosition

▸ setRotation(x, y, z, order?): AbstractWidget

Set Object's local rotation (Euler angles), in radians.

AbstractWidget

this

Object3D.setRotation

▸ setSelectable(selectable): void

Set if this object can be picked/selected (see RendererPicking).

void

Object3D.setSelectable

▸ setVisible(visible, silent?): AbstractWidget

Set visible

AbstractWidget

this

Object3D.setVisible

▸ updateObject(scene, camera): AbstractWidget

This function is called prior to rendering and can update this object's content.

It should not trigger any invalidateObject though.
Note that it is not necessary nor recommended to explicitly call updateObject on this object's children as updateObject will be called on all nodes present in the scene.

This will be executed before the transformations simplification.

See

Plot for more details on the render steps

AbstractWidget

Object3D.updateObject

▸ useOwnHighlight(): boolean

Returns true if this object make its own highlight effect (like geotoolkit3d.scene.reservoir.hexahedral.ReservoirGrid) This is to prevent unnecessary executions of the costly highlight passes.

boolean

Object3D.useOwnHighlight

▸ Static getClassName(): string

string

Object3D.getClassName

▸ Static register(): void

Register object for special processing through a callback function

Example

geotoolkit3d.util.ObjectProcessor.getDefaultInstance().registerObject(this.getClassName(), callback);

Deprecated

since 5.0, to allow custom object highlighting, please instead make your Object implement the interface geotoolkit3d/scene/ICustomHighlight.

void

Object3D.register