Class ColorCache

Use ColorCache to reuse a color specified by name and save allocation as well as setup time.

Implemented as a singleton. Do not modify colors after getting them from the ColorCache.

Hierarchy

ColorCache

Index

Constructors

Accessors

Methods

Constructors

constructor

new ColorCache(): ColorCache
Returns ColorCache

Accessors

size

get size(): number
Returns the number of elements in the cache.

Returns number
- Defined in @xyzmaps/harp-mapview/lib/ColorCache.ts:51

`Static` instance

get instance(): ColorCache
Return instance of ColorCache.

Returns ColorCache
- Defined in @xyzmaps/harp-mapview/lib/ColorCache.ts:20

Methods

clear

clear(): void
Clears the cache. Only references to the THREE.Color are removed from the cache. Consequently, clearing the cache does not cause any negative visual impact.

Returns void
- Defined in @xyzmaps/harp-mapview/lib/ColorCache.ts:59

getColor

getColor(colorCode): Color
Returns the color for the given colorCode. This function may reuse a previously generated color, so you cannot modify the contents of the color.
Parameters
- colorCode: string | number
  
  ThreeJS color code or name. You must provide a valid color code or name, as this function does not do any validation.
Returns Color
- Defined in @xyzmaps/harp-mapview/lib/ColorCache.ts:34

Generated using TypeDoc