API / geotoolkit3d / util / intersection / IIntersectablePolyhedron / IIntersectablePolyhedron
intersection.IIntersectablePolyhedron.IIntersectablePolyhedron
Define an interface to provide a way to retrieve intersection related data from a object formed by one or more polyhedrons like ReservoirGrid.
3D Objects implementing this interface will now be eligible for 3D intersection, via the Intersection3DUtil utility.
Interface
Constructors
Methods
Methods
▸ getClassName(): string
string
▸ Abstract getColorProvider(): RgbaColor | ColorProvider
Return the color provider of the intersectable.
▸ Abstract getMesh(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
Return the mesh representing the polyhderons to be intersected.
Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
▸ Abstract getPolyhedron(polyhedronIndex, target): void
Return the polyhedron data at given index.
Vertices coordinates must be in the local coordinate space of the mesh returned by getMesh method.
| Name | Type | Description |
|---|---|---|
polyhedronIndex | number | the index of the polyhedron |
target | PolyhedronCellData | result |
void
▸ Abstract getPolyhedronCount(): number
Return the total number of Polyhedrons contained by this object.
number
▸ Abstract getPolyhedronsBoundingBox(target): void
Return the bounding box of the polyhedrons.
The bounding box should be calculated directly from the polyhedrons' geometry vertex positions, representing the bounding box in the polyhedrons' local space.
The box coordinates must be in the local coordinate space of the mesh returned by getMesh method.
| Name | Type | Description |
|---|---|---|
target | Box3 | result |
void
▸ Abstract isPolyhedronIndexFilteredOut(polyhedronIndex): boolean
Return if the polyhedron at given index is filtered out.
Polyhedron objects like ReservoirGrid can contain multiple polyhedrons, which can be filtered out by user settings.
This method allow to express whether this specific polyhedron is filtered out (and should be excluded from intersection).
| Name | Type |
|---|---|
polyhedronIndex | number |
boolean
true if filtered out, otherwise false
▸ Static getClassName(): string
string