Skip to content
Last updated

API / geotoolkit3d / scene / asset / Asset / Asset

Class: Asset

asset.Asset.Asset

The main property of this asset is to represent a 3D object loader, and optionally with LOD and size scaling capabilities.

Hierarchy

Table of contents

Constructors
  • [new Asset(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.asset.asset.asset.md#new asset(options))
Methods

Contents

Constructors

new Asset(options)

• new Asset(options)

Parameters

Name Type
optionsOptions

Overrides

Object3D.constructor

Methods

add

▸ add(object): Asset

Adds object as child of this object.

Parameters

Name Type Description
objectObject3D<Object3DEventMap&gt; | Object3D<Object3DEventMap&gt;[]object

Returns

Asset

this

Inherited from

Object3D.add


addModel

▸ addModel(model, index): void

Attach the corresponding models to the asset object.

Parameters

Name Type
modelGroup<Object3DEventMap&gt;
indexnumber

Returns

void


afterRender

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

This function is called after rendering and can update this object's content.<br> <br> It should not trigger any invalidateObject though.<br> 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.<br> <br> This will be executed after the transformations simplification.<br> <br>

See

Plot for more details on the render steps

Parameters

Name Type Description
sceneSceneThe scene
cameraCameraThe camera used for this render phase.
plotPlotThe 3D plot
rendererWebGLRendererThe renderer

Returns

Asset

Inherited from

Object3D.afterRender


beforeRender

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

Calculate screen space here before each render, to allow for scaling when camera is far away

Parameters

Name Type
sceneScene
cameraCamera
plotPlot
rendererWebGLRenderer

Returns

Asset

Overrides

Object3D.beforeRender


dispose

▸ dispose(): void

Dispose object

Returns

void

Inherited from

Object3D.dispose


getClassName

▸ getClassName(): string

Returns

string

Inherited from

Object3D.getClassName


getID

▸ getID(): string

Get object id (unique for each equipment instance)

Returns

string


getOptions

▸ getOptions(): Required<Options&gt;

Get options

Returns

Required<Options&gt;

options object

Inherited from

Object3D.getOptions


getVisible

▸ getVisible(): boolean

Get visible

Returns

boolean

true, if object is visible

Inherited from

Object3D.getVisible


invalidateObject

▸ invalidateObject<T&gt;(event?): Asset

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

Type parameters

Name
T

Parameters

Name Type Description
Optional eventEvent<T&gt;The event to fire

Returns

Asset

Inherited from

Object3D.invalidateObject


isDisposed

▸ isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

Object3D.isDisposed


isSelectable

▸ isSelectable(): boolean

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

Returns

boolean

Inherited from

Object3D.isSelectable


notify

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

  • Notify listeners. Parent nodes will also be notified if they are instances of geotoolkit3d.scene.Object3D

Parameters

Name Type Description
typestringevent types
sourceanyof the event
Optional argsanyarguments of the event

Returns

Asset

this

Inherited from

Object3D.notify


off

▸ off(type?, callback?): Asset

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.

Parameters

Name Type Description
Optional typestringtype of the event
Optional callbackEventListenerfunction to be called

Returns

Asset

this

Inherited from

Object3D.off

▸ off<E&gt;(type, callback): Asset

Type parameters

NameType
Eextends string

Parameters

Name Type
typeE
callback(eventType: E, sender: Asset, args: EventMap[E]) => void

Returns

Asset

Inherited from

Object3D.off


on

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

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

Parameters

Name Type Description
typestringtype of event or property
callbackEventListenerto be called
Optional optionsOptionsoptions of subscription

Returns

Asset

this

Inherited from

Object3D.on

▸ on<E&gt;(type, callback, options?): Asset

Type parameters

NameType
Eextends string

Parameters

Name Type
typeE
callback(eventType: E, sender: Asset, args: EventMap[E]) => void
Optional optionsOptions

Returns

Asset

Inherited from

Object3D.on


onStatsUpdated

▸ onStatsUpdated(metrics): Asset

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

Parameters

Name Type Description
metricsPerformanceMetricsThe performance metrics.

Returns

Asset

Inherited from

Object3D.onStatsUpdated


onVisibilityChanged

▸ Protected onVisibilityChanged(): void

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

Returns

void

Inherited from

Object3D.onVisibilityChanged


remove

▸ remove(object): Asset

Removes object as child of this object.

Parameters

Name Type Description
objectObject3D<Object3DEventMap&gt; | Object3D<Object3DEventMap&gt;[]object

Returns

Asset

this

Inherited from

Object3D.remove


setOptions

▸ setOptions(options?): Asset

Set options

Parameters

Name Type Description
Optional optionsOptionsoptions object

Returns

Asset

this

Inherited from

Object3D.setOptions


setPosition

▸ setPosition(position): Asset

Set Object's local position.

Parameters

Name Type Description
positionObjectlocal position
Optional position.xnumber
Optional position.ynumber
Optional position.znumber

Returns

Asset

this

Inherited from

Object3D.setPosition


setRotation

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

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

Parameters

Name Type Description
xnumberx angle
ynumbery angle
znumberz angle
Optional orderEulerOrdereuler order

Returns

Asset

this

Inherited from

Object3D.setRotation


setSelectable

▸ setSelectable(selectable): void

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

Parameters

Name Type Description
selectablebooleanif can be selected

Returns

void

Inherited from

Object3D.setSelectable


setVisible

▸ setVisible(visible, silent?): Asset

Set visible

Parameters

Name Type Description
visiblebooleantrue, if object is visible
Optional silentbooleantrue, if object shouldn't be invalidated

Returns

Asset

this

Inherited from

Object3D.setVisible


updateObject

▸ updateObject(scene, camera): Asset

This function is called prior to rendering and can update this object's content.<br> <br> It should not trigger any invalidateObject though.<br> 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.<br> <br> This will be executed before the transformations simplification.<br> <br>

See

Plot for more details on the render steps

Parameters

Name Type Description
sceneSceneThe scene
cameraCameraThe camera

Returns

Asset

Inherited from

Object3D.updateObject


useOwnHighlight

▸ 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.

Returns

boolean

Inherited from

Object3D.useOwnHighlight


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

Object3D.getClassName


register

▸ Static register(): void

Register object for special processing through a callback function<br>

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.

Returns

void

Inherited from

Object3D.register