API / geotoolkit3d / scene / plane / PlaneMaterial / PlaneMaterial
plane.PlaneMaterial.PlaneMaterial
Plane material. Is responsible for handling the plane image and overlay parameters and rendering.
↳
PlaneMaterial
Constructors
- [new PlaneMaterial(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial.md#new planematerial(options))
Methods
Constructors
• new PlaneMaterial(options?)
| Name | Type |
|---|---|
Optional options | Options |
MeshColorMapLambertMaterial.constructor
Methods
▸ dispose(): void
void
MeshColorMapLambertMaterial.dispose
▸ getClassName(): string
string
MeshColorMapLambertMaterial.getClassName
▸ getColormapSize(): number
Retrieve the color map size
number
current colormap size
MeshColorMapLambertMaterial.getColormapSize
▸ getImageTextureDimension(vec2?): Vector2
Returns the dimension of the plane base image texture, if any.
| Name | Type | Description |
|---|---|---|
Optional vec2 | Vector2 | (optional) the Vector2 to hold the dimension, to avoid creating new object. |
Vector2
▸ getOptions(): OptionsBaseOut
Get the MeshColorMapLambertMaterial options.
MeshColorMapLambertMaterial.getOptions
▸ getOptionsMultiColorMap(): Required<Options>
Required<Options>
MeshColorMapLambertMaterial.getOptionsMultiColorMap
▸ getOverlay(): Group<Node>
Return the overlay Group holding the 2D shapes
▸ getOverlayTexture(): CanvasTexture
Returns the texture of the overlay, if any.
CanvasTexture
▸ getOverlayTextureDimension(vec2?): Vector2
Returns the dimension of the plane overlay texture, if any.
| Name | Type | Description |
|---|---|---|
Optional vec2 | Vector2 | (optional) the Vector2 to hold the dimension, to avoid creating new object. |
Vector2
▸ onBeforeCompile(parameters, renderer): void
| Name | Type |
|---|---|
parameters | WebGLProgramParametersWithUniforms |
renderer | WebGLRenderer |
void
MeshColorMapLambertMaterial.onBeforeCompile
▸ setOptions(options?): PlaneMaterial
Set this material options.
| Name | Type |
|---|---|
Optional options | OptionsBase |
MeshColorMapLambertMaterial.setOptions
▸ setOptionsMultiColorMap(options): PlaneMaterial
| Name | Type |
|---|---|
options | Options |
MeshColorMapLambertMaterial.setOptionsMultiColorMap
▸ Static getClassName(): string
string