API / geotoolkit3d / scene / curtain / PlaneCurtain / PlaneCurtain
curtain.PlaneCurtain.PlaneCurtain
The PlaneCurtain is an implementation of a 3D Curtain object made of Planes. A Curtain is a vertical geometry defined by a series of horizontal points coordinates. These points define a path in the X and Y axes, and the vertical size of the curtain is then defined by the user.<br>
This implementation represent the curtain geometry using multiple geotoolkit3d/scene/plane/Plane This enable powerful features such as intersections between the curtain and 3D objects (such as ReservoirGrids, Surfaces).<br>
Because each Plane will handle its own canvas and texture for drawing intersections, it is highly recommended to leave the decimation option enabled for performance reasons.<br>
This object provide these additional features over handling your own Planes:<ul> <li>Automatic and customizable Curtain path decimation</li> <li>Plane creation and handling</li> <li>Intersection handling (resizing Curtain if needed)</li> <li>Curtain shading</li> </ul>
↳
PlaneCurtain
Constructors
- [new PlaneCurtain(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.curtain.planecurtain.planecurtain.md#new planecurtain(options))
Methods
Methods
▸ add(object): PlaneCurtain
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ afterRender(scene, camera, plot, renderer): PlaneCurtain
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 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): PlaneCurtain
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 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
▸ generateIntersection(object, options?): void
Generate or update an intersection between this curtain and the provided mesh object. Supported objects include ReservoirGrids and Surfaces.
| Name | Type | Description |
|---|---|---|
object | Object3D | the mesh object to intersect. |
Optional options | PlaneMeshIntersectionOptions | the options for the intersection. |
void
▸ getClassName(): string
string
IIntersectableMesh.getClassName
▸ getColorProvider(): RgbaColor | ColorProvider
Return the color provider of the intersectable.
IIntersectableMesh.getColorProvider
▸ getHighlightedObjects(): Plane[]
Get selected planes in the PlaneCurtain that will generate a highlight
Plane[]
ICustomHighlight.getHighlightedObjects
▸ getMesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
Return the mesh to be intersected.
Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
▸ getMeshBoundingBox(target): void
Return the bounding box of the mesh.<br> The bounding box should be calculated directly from the mesh's geometry vertex positions, representing the bounding box. The box coordinates must be in the local coordinate space of the mesh returned by getMesh method.
| Name | Type | Description |
|---|---|---|
target | Box3 | result |
void
IIntersectableMesh.getMeshBoundingBox
▸ getOptions(): Required<CommonOptions>
Get options
Required<CommonOptions>
options object
▸ getPlanes(): Plane[]
Returns an array that contains all the planes
Plane[]
▸ getTriangle(triangleIndex, target): void
Return the triangle data at given index.<br> Vertices coordinates must be in the local coordinate space of the mesh returned by getMesh method.
| Name | Type | Description |
|---|---|---|
triangleIndex | number | the index of the triangle |
target | TriangleData | result |
void
IIntersectableMesh.getTriangle
▸ getTriangleCount(): number
Return the number of triangle.
number
IIntersectableMesh.getTriangleCount
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
▸ invalidateObject<T>(event?): PlaneCurtain
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>
| 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).<br>
boolean
▸ notify(type, source, args?): PlaneCurtain
- Notify listeners. Parent nodes will also be notified if they are instances of geotoolkit3d.scene.Object3D
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off(type?, callback?): PlaneCurtain
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): PlaneCurtain
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: PlaneCurtain, args: EventMap[E]) => void |
▸ on(type, callback, options?): PlaneCurtain
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>
| 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?): PlaneCurtain
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: PlaneCurtain, args: EventMap[E]) => void |
Optional options | Options |
▸ onStatsUpdated(metrics): PlaneCurtain
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.
| 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): PlaneCurtain
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ removeIntersection(object): void
Remove the intersection between this curtain and the given object.
| Name | Type | Description |
|---|---|---|
object | Object3D | the object to remove the intersection of. |
void
▸ setIntersectionProperties(object, options): void
Update an intersection property without recomputing the intersection coordinates.
| Name | Type | Description |
|---|---|---|
object | Object3D | the mesh object to update the intersection of. |
options | PlaneMeshIntersectionOptions | the options for the intersection. |
void
▸ setOptions(options?): PlaneCurtain
Set options
| Name | Type | Description |
|---|---|---|
Optional options | Partial<CommonOptions> | options object |
this
▸ setPosition(position): PlaneCurtain
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?): PlaneCurtain
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).<br>
| Name | Type | Description |
|---|---|---|
selectable | boolean | if can be selected |
void
▸ setVisible(visible, silent?): PlaneCurtain
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): PlaneCurtain
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 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<br>
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