Class: ColorMap2D

Defined in: src/ColorMap2D.ts:42

2D Colormap class for mapping two scalar fields to colors

Constructors

Constructor

new ColorMap2D(
   textureData, 
   textureSize, 
   options?): ColorMap2D;

Defined in: src/ColorMap2D.ts:53

Parameters

textureData

Float32Array

textureSize

number

options?

ColorMap2DOptions = {}

Returns

ColorMap2D

Methods

getColor()

getColor(valueX, valueY): RGBA;

Defined in: src/ColorMap2D.ts:70

Get color for a pair of values

Parameters

valueX

number

valueY

number

Returns

RGBA

---

getTexture()

getTexture(): DataTexture;

Defined in: src/ColorMap2D.ts:108

Get Three.js texture for GPU rendering

Returns

DataTexture

---

getTextureData()

getTextureData(): Float32Array;

Defined in: src/ColorMap2D.ts:129

Get the raw texture data

Returns

Float32Array

---

getTextureSize()

getTextureSize(): number;

Defined in: src/ColorMap2D.ts:136

Get texture size (width = height)

Returns

number

---

setRangeX()

setRangeX(range): void;

Defined in: src/ColorMap2D.ts:141

Parameters

range

[number, number]

Returns

void

---

setRangeY()

setRangeY(range): void;

Defined in: src/ColorMap2D.ts:145

Parameters

range

[number, number]

Returns

void

---

setThresholdX()

setThresholdX(threshold): void;

Defined in: src/ColorMap2D.ts:149

Parameters

threshold

[number, number]

Returns

void

---

setThresholdY()

setThresholdY(threshold): void;

Defined in: src/ColorMap2D.ts:153

Parameters

threshold

[number, number]

Returns

void

---

setAlpha()

setAlpha(alpha): void;

Defined in: src/ColorMap2D.ts:157

Parameters

alpha

number

Returns

void

---

getRangeX()

getRangeX(): [number, number];

Defined in: src/ColorMap2D.ts:162

Returns

[number, number]

---

getRangeY()

getRangeY(): [number, number];

Defined in: src/ColorMap2D.ts:163

Returns

[number, number]

---

getThresholdX()

getThresholdX(): [number, number];

Defined in: src/ColorMap2D.ts:164

Returns

[number, number]

---

getThresholdY()

getThresholdY(): [number, number];

Defined in: src/ColorMap2D.ts:165

Returns

[number, number]

---

getAlpha()

getAlpha(): number;

Defined in: src/ColorMap2D.ts:166

Returns

number

---

dispose()

dispose(): void;

Defined in: src/ColorMap2D.ts:168

Returns

void

---

fromPreset()

static fromPreset(
   preset, 
   size?, 
   options?): ColorMap2D;

Defined in: src/ColorMap2D.ts:178

Create a 2D colormap from a preset name

Parameters

preset

ColorMap2DPreset

size?

number = 256

options?

ColorMap2DOptions = {}

Returns

ColorMap2D

---

fromGenerator()

static fromGenerator(
   generator, 
   size?, 
   options?): ColorMap2D;

Defined in: src/ColorMap2D.ts:190

Create a 2D colormap from a custom generator function

Parameters

generator

(x, y) => RGBA

size?

number = 256

options?

ColorMap2DOptions = {}

Returns

ColorMap2D

---

getPresetNames()

static getPresetNames(): ColorMap2DPreset[];

Defined in: src/ColorMap2D.ts:419

Get list of available preset names

Returns

ColorMap2DPreset[]