API / geotoolkit3d / scene / animation / AnimationManager / AnimationManager
animation.AnimationManager.AnimationManager
This class manage animations in the scene.
It provides an easy way to insert animations and can handle several animations at a time.
Note that this AnimationMechanism is focused on providing smooth animation while keeping the resources usage as low as possible.
Therefore the animation intermediate steps count is not guaranteed.
Once added, an animation will be started and will be executed for each frame until it returns 'true'.
Then it will be discarded.
This manager will optimize the animations to run around 60 fps (if possible), it may pause animation when the plot is not visible.
To use this AnimationManager, insert it into the scene like a regular node.
Then push an animation function in it.
Note that this class is not responsible for actually interpolating values between steps.
Client code should implement the logic to compute intermediate steps.
↳
AnimationManager
Constructors
Methods
Methods
▸ add(object): AnimationManager
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ addAnimation(animation): AnimationManager
Add an animation function that will be called to update the animation state.
It will be called before the rendering occurs.
The provided function is responsible for animating one or several objects.
If the animation has ended, the function should return True to notify the AnimationManager to remove/discard this animation.
Otherwise it will be called indefinitely.
| Name | Type | Description |
|---|---|---|
animation | AbstractAnimation | geotoolkit3d.scene.animation.AbstractAnimation. |
this
▸ afterRender(scene, camera, plot, renderer): AnimationManager
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
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | Camera | The camera used for this render phase. |
plot | Plot | The 3D plot |
renderer | WebGLRenderer | The renderer |
▸ beforeRender(scene, camera, plot, renderer): AnimationManager
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
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | Camera | The camera used for this render phase. |
plot | Plot | The 3D plot |
renderer | WebGLRenderer | The renderer |
▸ checkAnimation(animation): boolean
Check for an animation in the manager
| Name | Type | Description |
|---|---|---|
animation | AbstractAnimation | geotoolkit3d.scene.animation.AbstractAnimation. |
boolean
animation if an animation is already in the manager
▸ dispose(): void
Dispose object
void
▸ getClassName(): string
string
▸ getOptions(): Required<Options>
Get options
Required<Options>
options object
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
▸ invalidateObject<T>(event?): AnimationManager
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.
| Name |
|---|
T |
| Name | Type | Description |
|---|---|---|
Optional event | Event<T> | The event to fire |
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSelectable(): boolean
Return if this object can be picked/selected (see RendererPicking).
boolean
▸ notify(type, source, args?): AnimationManager
Notify listeners
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off(type?, callback?): AnimationManager
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.
| Name | Type | Description |
|---|---|---|
Optional type | string | type of the event |
Optional callback | EventListener | function to be called |
this
▸ off<E>(type, callback): AnimationManager
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AnimationManager, args: EventMap[E]) => void |
▸ on(type, callback, options?): AnimationManager
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.
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
callback | EventListener | to be called |
Optional options | Options | options of subscription |
this
▸ on<E>(type, callback, options?): AnimationManager
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AnimationManager, args: EventMap[E]) => void |
Optional options | Options |
▸ onStatsUpdated(metrics): AnimationManager
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.
| Name | Type | Description |
|---|---|---|
metrics | PerformanceMetrics | The performance metrics. |
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
▸ remove(object): AnimationManager
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ removeAnimation(animation): void
remove an animation from the manager
| Name | Type | Description |
|---|---|---|
animation | AbstractAnimation | geotoolkit3d.scene.animation.AbstractAnimation |
void
▸ setOptions(options?): AnimationManager
Set options
| Name | Type | Description |
|---|---|---|
Optional options | Options | options object |
this
▸ setPosition(position): AnimationManager
Set Object's local position.
| Name | Type | Description |
|---|---|---|
position | Object | local position |
Optional position.x | number | |
Optional position.y | number | |
Optional position.z | number |
this
▸ setRotation(x, y, z, order?): AnimationManager
Set Object's local rotation (Euler angles), in radians.
| Name | Type | Description |
|---|---|---|
x | number | x angle |
y | number | y angle |
z | number | z angle |
Optional order | EulerOrder | euler order |
this
▸ setSelectable(selectable): void
Set if this object can be picked/selected (see RendererPicking).
| Name | Type | Description |
|---|---|---|
selectable | boolean | if can be selected |
void
▸ setVisible(visible, silent?): AnimationManager
Set visible
| Name | Type | Description |
|---|---|---|
visible | boolean | true, if object is visible |
Optional silent | boolean | true, if object shouldn't be invalidated |
this
▸ updateObject(scene, camera): AnimationManager
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
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | Camera | The camera |
▸ 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
▸ Static getClassName(): string
string
▸ 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