{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Class: 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":"class-planematerial","__idx":0},"children":["Class: 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":"p","attributes":{},"children":["Plane material."," ","Is responsible for handling the plane image and overlay parameters and rendering."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"hierarchy","__idx":1},"children":["Hierarchy"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MeshColorMapLambertMaterial"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["↳ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PlaneMaterial"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":2},"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":["Constructors"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#new-planematerialoptions"},"children":["new PlaneMaterial(options)"]}]}]}]},{"$$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":["Methods"]}]},{"$$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/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#dispose"},"children":["dispose"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#getclassname"},"children":["getClassName"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#getimagetexturedimension"},"children":["getImageTextureDimension"]}]}]}]},{"$$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/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#getoptions"},"children":["getOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#getoptionsmulticolormap"},"children":["getOptionsMultiColorMap"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#getoverlay"},"children":["getOverlay"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#getoverlaytexture"},"children":["getOverlayTexture"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#getoverlaytexturedimension"},"children":["getOverlayTextureDimension"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#onbeforecompile"},"children":["onBeforeCompile"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#setoptions"},"children":["setOptions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#setoptionsmulticolormap"},"children":["setOptionsMultiColorMap"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial#getclassname-1"},"children":["getClassName"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"contents","__idx":3},"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":["Constructors"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"new-planematerialoptions","__idx":4},"children":["new PlaneMaterial(options)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["new PlaneMaterial"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},")"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters","__idx":5},"children":["Parameters"]},{"$$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":{"width":"65%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"35%","data-label":"Type"},"children":["Type "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"overrides","__idx":6},"children":["Overrides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["MeshColorMapLambertMaterial.constructor"]}]},{"$$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":["Methods"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"dispose","__idx":7},"children":["dispose"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dispose"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["void"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns","__idx":8},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["void"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from","__idx":9},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":["MeshColorMapLambertMaterial"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#dispose"},"children":["dispose"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getclassname","__idx":10},"children":["getClassName"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getClassName"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-1","__idx":11},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from-1","__idx":12},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":["MeshColorMapLambertMaterial"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#getclassname"},"children":["getClassName"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getimagetexturedimension","__idx":13},"children":["getImageTextureDimension"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getImageTextureDimension"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vec2?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the dimension of the plane base image texture, if any."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters-1","__idx":14},"children":["Parameters"]},{"$$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":{"width":"30%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"20%","data-label":"Type"},"children":["Type "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%","data-label":"Description"},"children":["Description "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vec2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(optional) the Vector2 to hold the dimension, to avoid creating new object."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-2","__idx":15},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector2"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getoptions","__idx":16},"children":["getOptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getOptions"]},"(): ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#optionsbaseout"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OptionsBaseOut"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the MeshColorMapLambertMaterial options."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-3","__idx":17},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#optionsbaseout"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OptionsBaseOut"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from-2","__idx":18},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":["MeshColorMapLambertMaterial"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#getoptions"},"children":["getOptions"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getoptionsmulticolormap","__idx":19},"children":["getOptionsMultiColorMap"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getOptionsMultiColorMap"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Required"]},"<",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.colormapshadermaterial.colormapshadermaterial.multicolormap#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]},">"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-4","__idx":20},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Required"]},"<",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.colormapshadermaterial.colormapshadermaterial.multicolormap#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]},">"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from-3","__idx":21},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":["MeshColorMapLambertMaterial"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#getoptionsmulticolormap"},"children":["getOptionsMultiColorMap"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getoverlay","__idx":22},"children":["getOverlay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getOverlay"]},"(): ",{"$$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":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit.scene.node.node"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Node"]}]},">"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Return the overlay Group holding the 2D shapes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-5","__idx":23},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"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":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit.scene.node.node"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Node"]}]},">"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getoverlaytexture","__idx":24},"children":["getOverlayTexture"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getOverlayTexture"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CanvasTexture"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the texture of the overlay, if any."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-6","__idx":25},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CanvasTexture"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getoverlaytexturedimension","__idx":26},"children":["getOverlayTextureDimension"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getOverlayTextureDimension"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vec2?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the dimension of the plane overlay texture, if any."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters-2","__idx":27},"children":["Parameters"]},{"$$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":{"width":"30%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"20%","data-label":"Type"},"children":["Type "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%","data-label":"Description"},"children":["Description "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vec2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(optional) the Vector2 to hold the dimension, to avoid creating new object."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-7","__idx":28},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vector2"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"onbeforecompile","__idx":29},"children":["onBeforeCompile"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["onBeforeCompile"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parameters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["renderer"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["void"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters-3","__idx":30},"children":["Parameters"]},{"$$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":{"width":"65%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"35%","data-label":"Type"},"children":["Type "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parameters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WebGLProgramParametersWithUniforms"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["renderer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WebGLRenderer"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-8","__idx":31},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["void"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from-4","__idx":32},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":["MeshColorMapLambertMaterial"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#onbeforecompile"},"children":["onBeforeCompile"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"setoptions","__idx":33},"children":["setOptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["setOptions"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},"): ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PlaneMaterial"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set this material options."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters-4","__idx":34},"children":["Parameters"]},{"$$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":{"width":"65%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"35%","data-label":"Type"},"children":["Type "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.plane.planematerial.planematerial#optionsbase"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OptionsBase"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-9","__idx":35},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PlaneMaterial"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"overrides-1","__idx":36},"children":["Overrides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":["MeshColorMapLambertMaterial"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#setoptions"},"children":["setOptions"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"setoptionsmulticolormap","__idx":37},"children":["setOptionsMultiColorMap"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["setOptionsMultiColorMap"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]},"): ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PlaneMaterial"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"parameters-5","__idx":38},"children":["Parameters"]},{"$$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":{"width":"65%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"35%","data-label":"Type"},"children":["Type "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.scene-3.colormapshadermaterial.colormapshadermaterial.multicolormap#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-10","__idx":39},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PlaneMaterial"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from-5","__idx":40},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":["MeshColorMapLambertMaterial"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#setoptionsmulticolormap"},"children":["setOptionsMultiColorMap"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"getclassname-1","__idx":41},"children":["getClassName"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Static"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getClassName"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"returns-11","__idx":42},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"inherited-from-6","__idx":43},"children":["Inherited from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial"},"children":["MeshColorMapLambertMaterial"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.meshcolormaplambertmaterial.meshcolormaplambertmaterial#getclassname-1"},"children":["getClassName"]}]}]}]},"headings":[{"value":"Class: PlaneMaterial","id":"class-planematerial","depth":1},{"value":"Hierarchy","id":"hierarchy","depth":2},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Contents","id":"contents","depth":2},{"value":"new PlaneMaterial(options)","id":"new-planematerialoptions","depth":4},{"value":"Parameters","id":"parameters","depth":4},{"value":"Overrides","id":"overrides","depth":4},{"value":"dispose","id":"dispose","depth":4},{"value":"Returns","id":"returns","depth":4},{"value":"Inherited from","id":"inherited-from","depth":4},{"value":"getClassName","id":"getclassname","depth":4},{"value":"Returns","id":"returns-1","depth":4},{"value":"Inherited from","id":"inherited-from-1","depth":4},{"value":"getImageTextureDimension","id":"getimagetexturedimension","depth":4},{"value":"Parameters","id":"parameters-1","depth":4},{"value":"Returns","id":"returns-2","depth":4},{"value":"getOptions","id":"getoptions","depth":4},{"value":"Returns","id":"returns-3","depth":4},{"value":"Inherited from","id":"inherited-from-2","depth":4},{"value":"getOptionsMultiColorMap","id":"getoptionsmulticolormap","depth":4},{"value":"Returns","id":"returns-4","depth":4},{"value":"Inherited from","id":"inherited-from-3","depth":4},{"value":"getOverlay","id":"getoverlay","depth":4},{"value":"Returns","id":"returns-5","depth":4},{"value":"getOverlayTexture","id":"getoverlaytexture","depth":4},{"value":"Returns","id":"returns-6","depth":4},{"value":"getOverlayTextureDimension","id":"getoverlaytexturedimension","depth":4},{"value":"Parameters","id":"parameters-2","depth":4},{"value":"Returns","id":"returns-7","depth":4},{"value":"onBeforeCompile","id":"onbeforecompile","depth":4},{"value":"Parameters","id":"parameters-3","depth":4},{"value":"Returns","id":"returns-8","depth":4},{"value":"Inherited from","id":"inherited-from-4","depth":4},{"value":"setOptions","id":"setoptions","depth":4},{"value":"Parameters","id":"parameters-4","depth":4},{"value":"Returns","id":"returns-9","depth":4},{"value":"Overrides","id":"overrides-1","depth":4},{"value":"setOptionsMultiColorMap","id":"setoptionsmulticolormap","depth":4},{"value":"Parameters","id":"parameters-5","depth":4},{"value":"Returns","id":"returns-10","depth":4},{"value":"Inherited from","id":"inherited-from-5","depth":4},{"value":"getClassName","id":"getclassname-1","depth":4},{"value":"Returns","id":"returns-11","depth":4},{"value":"Inherited from","id":"inherited-from-6","depth":4}],"frontmatter":{"seo":{"title":"Class: PlaneMaterial"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/apis/classes/geotoolkit3d.scene-3.plane.planematerial.planematerial","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}