Skip to content
Last updated

API / geotoolkit3d / scene / MeshColorMapBasicMaterial / MeshColorMapBasicMaterial

Class: MeshColorMapBasicMaterial

scene.MeshColorMapBasicMaterial.MeshColorMapBasicMaterial

A material similar to THREE.BasicMaterial and implements colormap logic through a texture.<br> <br> This material requires the associated THREE.BufferGeometry to have a float attribute named upon ShaderUtil.COLORMAPVALUES_ATTRIBUTE_NAME value.<br> This float value (per vertex) will be used to retrieve a color in the given colorprovider (converted to a colormap texture).<br> The resulting color will be multiplied by the optional given static color (defaults to white unless explicitly set).<br> <br> If the given colorprovider is null then only the single color will be used.<br> <br>

Hierarchy

Table of contents

Constructors
  • [new MeshColorMapBasicMaterial(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.meshcolormapbasicmaterial.meshcolormapbasicmaterial.md#new meshcolormapbasicmaterial(options))
Methods

Contents

Constructors

new MeshColorMapBasicMaterial(options)

• new MeshColorMapBasicMaterial(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

ColorMapShaderMaterial.constructor

Methods

dispose

▸ dispose(): void

Returns

void

Inherited from

ColorMapShaderMaterial.dispose


getClassName

▸ getClassName(): string

Returns

string

Inherited from

ColorMapShaderMaterial.getClassName


getColorProvider

▸ getColorProvider(): ColorProvider

Return this material's color provider, or null if not defined.

Returns

ColorProvider


getColormapSize

▸ getColormapSize(): number

Retrieve the color map size

Returns

number

current colormap size

Inherited from

ColorMapShaderMaterial.getColormapSize


getOptions

▸ getOptions(): OptionsBaseOut

Get mesh colormap basic material options

Returns

OptionsBaseOut

Overrides

ColorMapShaderMaterial.getOptions


getOptionsMultiColorMap

▸ getOptionsMultiColorMap(): Required<Options&gt;

Returns

Required<Options&gt;

Inherited from

ColorMapShaderMaterial.getOptionsMultiColorMap


onBeforeCompile

▸ onBeforeCompile(parameters, renderer): void

Parameters

Name Type
parametersWebGLProgramParametersWithUniforms
rendererWebGLRenderer

Returns

void

Inherited from

ColorMapShaderMaterial.onBeforeCompile


setColorProvider

▸ setColorProvider(colorProvider): MeshColorMapBasicMaterial

Set this material colorProvider

Parameters

Name Type Description
colorProviderstring | ColorProvider | Colorthe color provider

Returns

MeshColorMapBasicMaterial


setOptions

▸ setOptions(options): MeshColorMapBasicMaterial

Set options, the given json will be merged with the object's state so that only the given options will be changed.<br> (see constructor of MeshColorMapBasicMaterial for more info)

Parameters

Name Type Description
optionsOptionsBaseThe options

Returns

MeshColorMapBasicMaterial

this

Overrides

ColorMapShaderMaterial.setOptions


setOptionsMultiColorMap

▸ setOptionsMultiColorMap(options): MeshColorMapBasicMaterial

Parameters

Name Type
optionsOptions

Returns

MeshColorMapBasicMaterial

Inherited from

ColorMapShaderMaterial.setOptionsMultiColorMap


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

ColorMapShaderMaterial.getClassName