API / geotoolkit3d / scene / panel / AbstractPanel / AbstractPanel
panel.AbstractPanel.AbstractPanel
Abstract Panel is a 3D "quad" rectangle which can be used to draw and display 2D toolkit shapes.
The rendering options of the shapes are fully customizable (background fillstyle, size, scale).
↳
AbstractPanel↳↳
Plane↳↳
FencePanel↳↳
Slice
Constructors
Methods
Constructors
• Protected new AbstractPanel(options?)
| Name | Type |
|---|---|
Optional options | Options |
Object3D.constructor
Methods
▸ add(object): AbstractPanel
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ afterRender(scene, camera, plot, renderer): AbstractPanel
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): AbstractPanel
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 |
▸ dispose(): void
Dispose object
void
▸ getClassName(): string
string
IOverlayableObject.getClassName
▸ Abstract getCorner(index, target?): Vector3
Return the world position of a specific corner of this overlayable (rectangular) object.
Example
The indices represent the 4 corners of the overlayable object like so:
0---1
| |
2---3| Name | Type | Description |
|---|---|---|
index | number | Index of the corner, from 0 to 3. |
Optional target | Vector3 | Optional point Vector3 to avoid unnecessary object creation. Will be updated and returned if provided. |
Vector3
▸ Abstract getLocalCorner(index, target?): Vector3
Return the local position of a specific corner of this overlayable (rectangular) object.
Example
The indices represent the 4 corners of the overlayable object like so:
0---1
| |
2---3| Name | Type | Description |
|---|---|---|
index | number | Index of the corner, from 0 to 3. |
Optional target | Vector3 | Optional point Vector3 to avoid unnecessary object creation. Will be updated and returned if provided. |
Vector3
IOverlayableObject.getLocalCorner
▸ Abstract getMesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
Return the Three.js Mesh of this overlayable object.
Used in intersections to compute the object boundaries, to generate transformations for the overlay.
Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
▸ getOptions(): Required<Options>
Get options
Required<Options>
options object
▸ Abstract getOverlay(): Group<Node>
Return the current 2D Shape group used to render the overlay.
▸ Abstract getOverlayTextureBounds(): Rect
Return the overlay texture bounds, (unit is in pixel).
IOverlayableObject.getOverlayTextureBounds
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
▸ invalidateObject<T>(event?): AbstractPanel
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?): AbstractPanel
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?): AbstractPanel
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): AbstractPanel
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AbstractPanel, args: EventMap[E]) => void |
▸ on(type, callback, options?): AbstractPanel
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?): AbstractPanel
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AbstractPanel, args: EventMap[E]) => void |
Optional options | Options |
▸ onStatsUpdated(metrics): AbstractPanel
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): AbstractPanel
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ setOptions(options?): AbstractPanel
Set options
| Name | Type | Description |
|---|---|---|
Optional options | Options | options object |
this
▸ Abstract setOverlay(group): void
Set the current 2D Shape group used to render the overlay.
void
▸ setPosition(position): AbstractPanel
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?): AbstractPanel
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?): AbstractPanel
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): AbstractPanel
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