Last updated

API / geotoolkit / animation / effects / Registry / Registry

Class: Registry

effects.Registry.Registry

Registry which stores animation effect. If you want to add your own effect you should call geotoolkit/animation/effects/Registry.getInstance().registerEffect(class_name) If you want to instantiate class from object you should call geotoolkit/animation/effects/Registry.getInstance().createEffect(effect_object)

Table of contents

Constructors
Methods

Contents

Constructors

new Registry()

new Registry()

Methods

createEffect

createEffect(effect, node?): AbstractEffect

Finds class appropriate passed object and instantiates it

Throws

Error if effect does not found

Parameters

Name Type Description
effectOptionseffect properties
Optional nodeAnimatedNodenode to which effect would be applied

Returns

AbstractEffect

effect


getClassName

getClassName(): string

Returns

string


registerEffect

registerEffect(Effect): Registry

Register effect in registry

Parameters

Name Type Description
Effecttypeof AbstractEffecteffect

Returns

Registry

this


setDefaultEffect

setDefaultEffect(Effect): Registry

Sets default effect class, that will be used in createEffect

Parameters

Name Type Description
Effecttypeof AbstractEffecteffect

Returns

Registry

this


getClassName

Static getClassName(): string

Returns

string


getInstance

Static getInstance(): Registry

Returns instance of the Effects registry

Returns

Registry

Effects registry