[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit3d](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d) / [scene](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3) / [plane](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#plane) / [Plane](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#plane) / Plane

# Class: Plane

[plane](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#plane).[Plane](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#plane).Plane

Plane is a 3D "quad" rectangle which can be used to draw and display 2D toolkit shapes.<br>
The rendering options of the shapes are fully customizable (background fillstyle, size, scale).

The Plane shape/geometry can be defined by various ways:<ul>
<li>by defining 3 points of the rectangle.</li>
<li>by passing down a THREE.js PlaneGeometry.</li>
<li>by defining the rectangle width/height then rotating/translating the object.</li></ul>

Additionally, a Texture can be used as a background to the plane render.<br>
The main advantage is that this texture resolution can be different from the overlay resolution, to avoid stretching and full control over the quality and scale.

## Hierarchy

- [`AbstractPanel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel)
↳ **`Plane`**


## Implements

- [`ICustomHighlight`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.icustomhighlight.icustomhighlight)
- [`IOverlayableObject`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject)


## Table of contents

Constructors
- [new Plane(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.plane.plane.plane.md#new plane(options))


Methods
| [add](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#add) | [afterRender](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#afterrender) | [beforeRender](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#beforerender) |
|  --- | --- | --- |
| [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#dispose) | [getBoundingBox](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getboundingbox) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getclassname) |
| [getCorner](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getcorner) | [getHighlightedObjects](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#gethighlightedobjects) | [getImageTexture](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getimagetexture) |
| [getImageTextureDimension](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getimagetexturedimension) | [getLocalCorner](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getlocalcorner) | [getMesh](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getmesh) |
| [getOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getoptions) | [getOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getoverlay) | [getOverlayTexture](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getoverlaytexture) |
| [getOverlayTextureBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getoverlaytexturebounds) | [getOverlayTextureDimension](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getoverlaytexturedimension) | [getVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getvisible) |
| [invalidateObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#invalidateobject) | [isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#isdisposed) | [isSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#isselectable) |
| [notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#notify) | [off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#off) | [on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#on) |
| [onStatsUpdated](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#onstatsupdated) | [onVisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#onvisibilitychanged) | [remove](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#remove) |
| [setOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#setoptions) | [setOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#setoverlay) | [setPosition](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#setposition) |
| [setRotation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#setrotation) | [setSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#setselectable) | [setVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#setvisible) |
| [updateObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#updateobject) | [useOwnHighlight](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#useownhighlight) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#getclassname-1) |
| [register](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane#register) |


## Contents

Constructors
#### new Plane(options)

• **new Plane**(`options?`)

#### Parameters

| Name  | Type  |
|  --- | --- |
| `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#plane#options) |


#### Overrides

AbstractPanel.constructor

Methods
#### add

▸ **add**(`object`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

Adds object as child of this object.

#### Parameters

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


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

this

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[add](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#add)

#### afterRender

▸ **afterRender**(`scene`, `camera`, `plot`, `renderer`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

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](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.plot.plot) for more details on the render steps

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `scene` | `Scene` | The scene |
| `camera` | `Camera` | The camera used for this render phase. |
| `plot` | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.plot.plot) | The 3D plot |
| `renderer` | `WebGLRenderer` | The renderer |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[afterRender](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#afterrender)

#### beforeRender

▸ **beforeRender**(`scene`, `camera`, `plot`, `renderer`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

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 beforeRender 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](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.plot.plot) for more details on the render steps

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `scene` | `Scene` | The scene |
| `camera` | `Camera` | The camera used for this render phase. |
| `plot` | [`Plot`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.plot.plot) | The 3D plot |
| `renderer` | `WebGLRenderer` | The renderer |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[beforeRender](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#beforerender)

#### dispose

▸ **dispose**(): `void`

Dispose object

#### Returns

`void`

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#dispose)

#### getBoundingBox

▸ **getBoundingBox**(): `Box3`

Returns the bounding box in the plane local coordinates.<br>
This bounding box differs from the one obtained via getMeshBoundingBox.<br>
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.

#### Returns

`Box3`

bbox

#### getClassName

▸ **getClassName**(): `string`

#### Returns

`string`

#### Implementation of

[IOverlayableObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject#getclassname)

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getclassname)

#### getCorner

▸ **getCorner**(`index`, `target?`): `Vector3`

Return the world position of a specific corner of this plane quad.<br>
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`**

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

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `index` | `number` | Index of the plane quad, from 0 to 3. |
| `Optional` `target` | `Vector3` | Optional point Vector3, will be updated and returned if provided. |


#### Returns

`Vector3`

#### Implementation of

[IOverlayableObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject).[getCorner](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject#getcorner)

#### Overrides

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getCorner](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getcorner)

#### getHighlightedObjects

▸ **getHighlightedObjects**(): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane) | [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)[]

Get selected plane or planes that will generate a highlight

#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane) | [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)[]

#### Implementation of

[ICustomHighlight](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.icustomhighlight.icustomhighlight).[getHighlightedObjects](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.icustomhighlight.icustomhighlight#gethighlightedobjects)

#### getImageTexture

▸ **getImageTexture**(): `Texture`

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

#### Returns

`Texture`

texture

#### getImageTextureDimension

▸ **getImageTextureDimension**(`vec2?`): `Vector2`

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

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `vec2` | `Vector2` | (optional) the Vector2 to hold the dimension, to avoid creating new object. |


#### Returns

`Vector2`

dimension in Vector2

#### getLocalCorner

▸ **getLocalCorner**(`index`, `target?`): `Vector3`

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

**`Example`**

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

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `index` | `number` | Index of the plane quad, from 0 to 3. |
| `Optional` `target` | `Vector3` | Optional point Vector3, will be updated and returned if provided. |


#### Returns

`Vector3`

#### Implementation of

[IOverlayableObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject).[getLocalCorner](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject#getlocalcorner)

#### Overrides

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getLocalCorner](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getlocalcorner)

#### getMesh

▸ **getMesh**(): `Mesh`<`BufferGeometry`<`NormalBufferAttributes`&gt;, `Material` | `Material`[], `Object3DEventMap`&gt;

Return the plane mesh.

#### Returns

`Mesh`<`BufferGeometry`<`NormalBufferAttributes`&gt;, `Material` | `Material`[], `Object3DEventMap`&gt;

#### Implementation of

[IOverlayableObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject).[getMesh](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject#getmesh)

#### Overrides

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getMesh](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getmesh)

#### getOptions

▸ **getOptions**(): `Required`<[`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#object3d#options)&gt;

Get options

#### Returns

`Required`<[`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#object3d#options)&gt;

options object

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getoptions)

#### getOverlay

▸ **getOverlay**(): [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

Returns the overlay of this plane, if any.

#### Returns

[`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt;

#### Implementation of

[IOverlayableObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject).[getOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject#getoverlay)

#### Overrides

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getoverlay)

#### getOverlayTexture

▸ **getOverlayTexture**(): `CanvasTexture`

Returns the texture of the plane overlay, if any.

#### Returns

`CanvasTexture`

texture

#### getOverlayTextureBounds

▸ **getOverlayTextureBounds**(): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect)

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

#### Returns

[`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect)

#### Implementation of

[IOverlayableObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject).[getOverlayTextureBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject#getoverlaytexturebounds)

#### Overrides

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getOverlayTextureBounds](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getoverlaytexturebounds)

#### getOverlayTextureDimension

▸ **getOverlayTextureDimension**(`vec2?`): `Vector2`

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

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `vec2` | `Vector2` | (optional) the Vector2 to hold the dimension, to avoid creating new object. |


#### Returns

`Vector2`

dimension in Vector2

#### getVisible

▸ **getVisible**(): `boolean`

Get visible

#### Returns

`boolean`

true, if object is visible

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getvisible)

#### invalidateObject

▸ **invalidateObject**<`T`&gt;(`event?`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

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` `event` | [`Event`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.event.event)<`T`&gt; | The event to fire |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[invalidateObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#invalidateobject)

#### isDisposed

▸ **isDisposed**(): `boolean`

Returns whether this object has been disposed

#### Returns

`boolean`

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#isdisposed)

#### isSelectable

▸ **isSelectable**(): `boolean`

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

#### Returns

`boolean`

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[isSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#isselectable)

#### notify

▸ **notify**(`type`, `source`, `args?`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

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


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `type` | `string` | event types |
| `source` | `any` | of the event |
| `Optional` `args` | `any` | arguments of the event |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

this

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#notify)

#### off

▸ **off**(`type?`, `callback?`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.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.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `type` | `string` | type of the event |
| `Optional` `callback` | [`EventListener`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#eventdispatcher#eventlistener) | function to be called |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

this

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#off)

▸ **off**<`E`&gt;(`type`, `callback`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Type parameters

| Name | Type |
|  --- | --- |
| `E` | extends `string` |


#### Parameters

| Name  | Type  |
|  --- | --- |
| `type` | `E` |
| `callback` | (`eventType`: `E`, `sender`: [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#object3d#eventmap)[`E`]) => `void` |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#off)

#### on

▸ **on**(`type`, `callback`, `options?`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

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  |
|  --- | --- | --- |
| `type` | `string` | type of event or property |
| `callback` | [`EventListener`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#eventdispatcher#eventlistener) | to be called |
| `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#eventdispatcher#options) | options of subscription |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

this

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#on)

▸ **on**<`E`&gt;(`type`, `callback`, `options?`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Type parameters

| Name | Type |
|  --- | --- |
| `E` | extends `string` |


#### Parameters

| Name  | Type  |
|  --- | --- |
| `type` | `E` |
| `callback` | (`eventType`: `E`, `sender`: [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#object3d#eventmap)[`E`]) => `void` |
| `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#eventdispatcher#options) |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#on)

#### onStatsUpdated

▸ **onStatsUpdated**(`metrics`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

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  |
|  --- | --- | --- |
| `metrics` | [`PerformanceMetrics`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.plot.plot#performancemetrics) | The performance metrics. |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[onStatsUpdated](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#onstatsupdated)

#### onVisibilityChanged

▸ `Protected` **onVisibilityChanged**(): `void`

This method is called if visibility is changed.  Send event [Events.VisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#object3d#events#visibilitychanged)

#### Returns

`void`

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[onVisibilityChanged](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#onvisibilitychanged)

#### remove

▸ **remove**(`object`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

Removes object as child of this object.

#### Parameters

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


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

this

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[remove](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#remove)

#### setOptions

▸ **setOptions**(`options?`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

Set this Plane options

#### Parameters

| Name  | Type  |
|  --- | --- |
| `Optional` `options` | [`OptionsBase`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit3d.scene-3#plane#optionsbase) |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Overrides

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[setOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#setoptions)

#### setOverlay

▸ **setOverlay**(`overlayGroup`): `void`

Used for intersection API

#### Parameters

| Name  | Type  |
|  --- | --- |
| `overlayGroup` | [`Group`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.group.group)<[`Node`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.node.node)&gt; |


#### Returns

`void`

#### Implementation of

[IOverlayableObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject).[setOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject#setoverlay)

#### Overrides

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[setOverlay](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#setoverlay)

#### setPosition

▸ **setPosition**(`position`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

Set Object's local position.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `position` | `Object` | local position |
| `Optional` `position.x` | `number` | - 
 |
| `Optional` `position.y` | `number` | - 
 |
| `Optional` `position.z` | `number` | - 
 |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

this

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[setPosition](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#setposition)

#### setRotation

▸ **setRotation**(`x`, `y`, `z`, `order?`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

Set Object's local rotation ([Euler angles](https://en.wikipedia.org/wiki/Euler_angles)), in radians.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `x` | `number` | x angle |
| `y` | `number` | y angle |
| `z` | `number` | z angle |
| `Optional` `order` | `EulerOrder` | euler order |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

this

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[setRotation](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#setrotation)

#### setSelectable

▸ **setSelectable**(`selectable`): `void`

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

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `selectable` | `boolean` | if can be selected |


#### Returns

`void`

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[setSelectable](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#setselectable)

#### setVisible

▸ **setVisible**(`visible`, `silent?`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

Set visible

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `visible` | `boolean` | true, if object is visible |
| `Optional` `silent` | `boolean` | true, if object shouldn't be invalidated |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

this

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[setVisible](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#setvisible)

#### updateObject

▸ **updateObject**(`scene`, `camera`): [`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

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](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.plot.plot) for more details on the render steps

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `scene` | `Scene` | The scene |
| `camera` | `Camera` | The camera |


#### Returns

[`Plane`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.plane.plane.plane)

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[updateObject](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#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

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[useOwnHighlight](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#useownhighlight)

#### getClassName

▸ `Static` **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#getclassname-1)

#### register

▸ `Static` **register**(): `void`

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

**`Example`**

```ts
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

[AbstractPanel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel).[register](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit3d.scene-3.panel.abstractpanel.abstractpanel#register)