API / geotoolkit3d / scene / plane / PlaneMaterial / PlaneMaterial
plane.PlaneMaterial.PlaneMaterial
Type Aliases
Ƭ DeprecatedOptions: Object
Deprecated
to remove once every deprecated field have been removed.
| Name | Type | Description |
|---|---|---|
color? | Color | Deprecated since 5.0, please use options.overlayoptions.backgroundfillstyle instead to control the Plane base color. |
opacity? | number | Deprecated since 5.0, please use options.overlayoptions.backgroundfillstyle instead to control the Plane base opacity. |
Ƭ Options: Omit<Options, "color" | "opacity"> & DeprecatedOptions & { overlayoptions?: OverlayOptions ; usemipmaps?: boolean }
Ƭ OptionsBase: Omit<OptionsBase, "color" | "opacity"> & DeprecatedOptions & { overlayoptions?: OverlayOptions }
Ƭ OverlayOptions: Object
| Name | Type | Description |
|---|---|---|
backgroundfillstyle? | Type | Define the overlay background fillstyle. Accept CSS color as well as FillStyles. Can be set to 'null' to prevent drawing the background. Default color is 50% opacity grey. |
height? | number | the height of the overlay, in pixels. Default is 2048. |
pixelscale? | number | the rendering scale of the overlay. Overlay resolution is (pixelscale * width) * (pixelscale * height) |
shapegroup? | Group | A group that will be used to render 2D shapes on top of the plane as 'overlay'. Will be drawn on top of the base image if any. |
width? | number | the width of the overlay, in pixels. Default is 2048. |