API / geotoolkit3d / util / intersection / IOverlayableObject / IOverlayableObject
intersection.IOverlayableObject.IOverlayableObject
Define an interface for 3D object with overlay capabilities.<br> Overlayable objects should have a rectangular coplanar shape, that can be deduced by using the .getCorner() method.<br> This interface is intended for internal usage only.
Interface
Constructors
- [new IOverlayableObject()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.util-5.intersection.ioverlayableobject.ioverlayableobject.md#new ioverlayableobject())
Methods
Methods
▸ getClassName(): string
string
▸ Abstract getCorner(index, target?): Vector3
Return the world position of a specific corner of this overlayable (rectangular) object.<br>
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.<br>
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 getMesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
Return the Three.js Mesh of this overlayable object.<br> Used in intersections to compute the object boundaries, to generate transformations for the overlay.
Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
▸ 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).
▸ Abstract setOverlay(group): void
Set the current 2D Shape group used to render the overlay.
void
▸ Static getClassName(): string
string