{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Namespace: PlaneMaterial","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/readme"},"children":["API"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d"},"children":["geotoolkit3d"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3"},"children":["scene"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane"},"children":["plane"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial"},"children":["PlaneMaterial"]}," / PlaneMaterial"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"namespace-planematerial","__idx":0},"children":["Namespace: PlaneMaterial"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane"},"children":["plane"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial"},"children":["PlaneMaterial"]},".PlaneMaterial"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":1},"children":["Table of contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Type Aliases"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#deprecatedoptions"},"children":["DeprecatedOptions"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#options"},"children":["Options"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#optionsbase"},"children":["OptionsBase"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#overlayoptions"},"children":["OverlayOptions"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"contents","__idx":2},"children":["Contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Type Aliases"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"deprecatedoptions","__idx":3},"children":["DeprecatedOptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DeprecatedOptions"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Deprecated"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["to remove once every deprecated field have been removed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"type-declaration","__idx":4},"children":["Type declaration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["color?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Color"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Deprecated"]}]}," since 5.0, please use options.overlayoptions.backgroundfillstyle instead to control the Plane base color."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["opacity?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Deprecated"]}]}," since 5.0, please use options.overlayoptions.backgroundfillstyle instead to control the Plane base opacity."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"options","__idx":5},"children":["Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Options"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Omit"]},"<",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"color\""]}," | ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"opacity\""]},"> & ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#deprecatedoptions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeprecatedOptions"]}]}," & { ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["overlayoptions?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#overlayoptions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OverlayOptions"]}]}," ; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usemipmaps?"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]},"  }"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"optionsbase","__idx":6},"children":["OptionsBase"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OptionsBase"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Omit"]},"<",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#optionsbase"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OptionsBase"]}]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"color\""]}," | ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"opacity\""]},"> & ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#deprecatedoptions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeprecatedOptions"]}]}," & { ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["overlayoptions?"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#overlayoptions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OverlayOptions"]}]},"  }"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"overlayoptions","__idx":7},"children":["OverlayOptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ƭ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OverlayOptions"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"type-declaration-1","__idx":8},"children":["Type declaration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["backgroundfillstyle?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit.attributes.fillstyle.fillstyle#type"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Define the overlay background fillstyle.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Accept CSS color as well as FillStyles.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Can be set to 'null' to prevent drawing the background.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Default color is 50% opacity grey."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["height?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["the height of the overlay, in pixels. Default is 2048."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pixelscale?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["the rendering scale of the overlay. Overlay resolution is (pixelscale * width) * (pixelscale * height)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shapegroup?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit.scene.group.group"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Group"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["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."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["width?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["the width of the overlay, in pixels. Default is 2048."]}]}]}]}]}]}]},"headings":[{"value":"Namespace: PlaneMaterial","id":"namespace-planematerial","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Contents","id":"contents","depth":2},{"value":"DeprecatedOptions","id":"deprecatedoptions","depth":4},{"value":"Type declaration","id":"type-declaration","depth":4},{"value":"Options","id":"options","depth":4},{"value":"OptionsBase","id":"optionsbase","depth":4},{"value":"OverlayOptions","id":"overlayoptions","depth":4},{"value":"Type declaration","id":"type-declaration-1","depth":4}],"frontmatter":{"seo":{"title":"Namespace: PlaneMaterial"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}