Class: Plane

• new Plane(options)

• new Plane(options?)

AbstractPanel.constructor

▸ add(object): Plane

Adds object as child of this object.

Plane

this

AbstractPanel.add

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

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

Plane

AbstractPanel.afterRender

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

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

Plane

AbstractPanel.beforeRender

▸ dispose(): void

Dispose object

void

AbstractPanel.dispose

▸ getBoundingBox(): Box3

Returns the bounding box in the plane local coordinates.
This bounding box differs from the one obtained via getMeshBoundingBox.
It is defined in the Plane's local space, whereas the other is computed directly from the mesh geometry in the mesh's local space.

Box3

bbox

▸ getClassName(): string

string

IOverlayableObject.getClassName

AbstractPanel.getClassName

▸ getCorner(index, target?): Vector3

Return the world position of a specific corner of this plane quad.
If this plane (or a parent object) has been moved/rotated since the last render, please call Plane.updateWorldMatrix(true, true) first for correct results.

Example

The indices represent the 4 corners of the quad like so:
0---1
|   |
2---3

Vector3

IOverlayableObject.getCorner

AbstractPanel.getCorner

▸ getHighlightedObjects(): Plane | Plane[]

Get selected plane or planes that will generate a highlight

Plane | Plane[]

ICustomHighlight.getHighlightedObjects

▸ getImageTexture(): Texture

Returns the texture of the plane base image, if any.

Texture

texture

▸ getImageTextureDimension(vec2?): Vector2

Returns the dimension of the plane base image texture, if any.

Vector2

dimension in Vector2

▸ getLocalCorner(index, target?): Vector3

Return the local position of a specific corner of this plane quad. This method is mainly used for intersection purposes.
For coordinates calculation accuracy purpose, local plane coordinates might not match the provided coordinates at construction time.
For this reason, it is recommended to users to instead use getCorner, which apply all parent's matrix transformations.

Example

The indices represent the 4 corners of the quad like so:
0---1
|   |
2---3

Vector3

IOverlayableObject.getLocalCorner

AbstractPanel.getLocalCorner

▸ getMesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Return the plane mesh.

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

IOverlayableObject.getMesh

AbstractPanel.getMesh

▸ getOptions(): Required<Options>

Get options

Required<Options>

options object

AbstractPanel.getOptions

▸ getOverlay(): Group<Node>

Returns the overlay of this plane, if any.

Group<Node>

IOverlayableObject.getOverlay

AbstractPanel.getOverlay

▸ getOverlayTexture(): CanvasTexture

Returns the texture of the plane overlay, if any.

CanvasTexture

texture

▸ getOverlayTextureBounds(): Rect

Returns the overlay texture boundaries of this plane, in pixels.

Rect

IOverlayableObject.getOverlayTextureBounds

AbstractPanel.getOverlayTextureBounds

▸ getOverlayTextureDimension(vec2?): Vector2

Returns the dimension of the plane overlay texture, if any.

Vector2

dimension in Vector2

▸ getVisible(): boolean

Get visible

boolean

true, if object is visible

AbstractPanel.getVisible

▸ invalidateObject<T>(event?): Plane

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.

Plane

AbstractPanel.invalidateObject

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractPanel.isDisposed

▸ isSelectable(): boolean

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

boolean

AbstractPanel.isSelectable

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

Notify listeners

Plane

this

AbstractPanel.notify

▸ off(type?, callback?): Plane

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.

Plane

this

AbstractPanel.off

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

Plane

AbstractPanel.off

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

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.

Plane

this

AbstractPanel.on

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

Plane

AbstractPanel.on

▸ onStatsUpdated(metrics): Plane

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.

Plane

AbstractPanel.onStatsUpdated

▸ Protected onVisibilityChanged(): void

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

void

AbstractPanel.onVisibilityChanged

▸ remove(object): Plane

Removes object as child of this object.

Plane

this

AbstractPanel.remove

▸ setOptions(options?): Plane

Set this Plane options

Plane

AbstractPanel.setOptions

▸ setOverlay(overlayGroup): void

Used for intersection API

void

IOverlayableObject.setOverlay

AbstractPanel.setOverlay

▸ setPosition(position): Plane

Set Object's local position.

Plane

this

AbstractPanel.setPosition

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

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

Plane

this

AbstractPanel.setRotation

▸ setSelectable(selectable): void

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

void

AbstractPanel.setSelectable

▸ setVisible(visible, silent?): Plane

Set visible

Plane

this

AbstractPanel.setVisible

▸ updateObject(scene, camera): Plane

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

Plane

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

AbstractPanel.useOwnHighlight

▸ Static getClassName(): string

string

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

AbstractPanel.register