Skip to content
Last updated

API / geotoolkit / scene / RegularCache / RegularCache

Class: RegularCache

scene.RegularCache.RegularCache

Defines a cache strategy to prerender composite node's children into a single shared image and cut it into a set of tiles.

Hierarchy

Table of contents

Constructors
  • [new RegularCache(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.scene.regularcache.regularcache.md#new regularcache(options))
Methods

Contents

Constructors

new RegularCache(options)

• new RegularCache(options?)

Creates cache

Parameters

Name Type Description
Optional optionsOptionsoptions

Overrides

Cache.constructor

Methods

clone

▸ clone(): Cache

Returns a cloned cache object. All inheritors should implement copy constructor or provide custom implementation for this method.

Returns

Cache

Inherited from

Cache.clone


getClassName

▸ getClassName(): string

Returns

string

Inherited from

Cache.getClassName


getLimits

▸ getLimits(): Rect | LimitsCallback

Returns total cache limits (if used)

Returns

Rect | LimitsCallback


getOwner

▸ getOwner(): Node

Returns cache owner.

Returns

Node

owner

Inherited from

Cache.getOwner


getResourceManager

▸ getResourceManager(): TileResourceManager

Returns resource manager.

Returns

TileResourceManager

Overrides

Cache.getResourceManager


getTileHeight

▸ getTileHeight(): number

Returns tile height.

Returns

number

height


getTileWidth

▸ getTileWidth(): number

Returns tile width.

Returns

number

width


invalidate

▸ invalidate(bounds?): RegularCache

Invalidates cache. Marks cache to be rendered.

Parameters

Name Type Description
Optional boundsRectrectangular area to be invalidated

Returns

RegularCache

this

Inherited from

Cache.invalidate


rebuild

▸ rebuild(force?): RegularCache

Flags the RegularCache as needing a clear / rebuild. Called after zooming or when we've hit the cap for number of images

Parameters

Name Type Description
Optional forcebooleanforce flag

Returns

RegularCache

this

Overrides

Cache.rebuild


render

▸ render(context): void

Render cache.

Parameters

Name Type Description
contextRenderingContextrendering context

Returns

void

Overrides

Cache.render


setLimits

▸ setLimits(limits): RegularCache

Sets total cache limits

Parameters

Name Type Description
limitsRect | LimitsCallbacktotal cache limits to use instead of the owner model limits (if needed)

Returns

RegularCache

this


setOwner

▸ setOwner(owner): RegularCache

Sets cache owner.

Parameters

Name Type Description
ownerCompositeNode<Node&gt;node which should be cached

Returns

RegularCache

this

Overrides

Cache.setOwner


setRenderContent

▸ setRenderContent(renderContentDelegate): RegularCache

Sets render content delegate.

Parameters

Name Type Description
renderContentDelegate(context: RenderingContext) => voidparameter which can render content for this node

Returns

RegularCache

Overrides

Cache.setRenderContent


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

Cache.getClassName