Class: AbstractEffect

• [new AbstractEffect(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.animation-1.effects.abstracteffect.abstracteffect.md#new abstracteffect(options))

• new AbstractEffect(options?)

Defines abstract animation effect

• get _active(): boolean

Deprecated

since 5.0. Use getActive() instead

boolean

• set _active(active): void

Deprecated

since 5.0. Use setActive() instead

void

• Protected get _attr(): string

Deprecated

since 5.0. Use getAttributeName() instead

string

• Protected set _attr(attr): void

Deprecated

since 5.0. Use setAttributeName() instead

void

• get _begin(): string | number

Deprecated

since 5.0. Use getBegin() instead

string | number

• set _begin(begin): void

Deprecated

since 5.0. Use setBegin() instead

void

• Protected get _processor(): AbstractProcessor<any&gt;

Deprecated

since 5.0. Use getProcessor() instead

AbstractProcessor<any&gt;

• Protected set _processor(processor): void

Deprecated

since 5.0. Use setProcessor() instead

void

• get _repeatCount(): number

Deprecated

since 5.0. Use getRepeatCount() instead

number

• set _repeatCount(repeatCount): void

Deprecated

since 5.0. Use setRepeatCount() instead

void

• get _state(): Object

Deprecated

since 5.0. Use getState() instead

Object

• set _state(state): void

Deprecated

since 5.0. Use setState() instead

void

• get _style(): AnimationStyle

Deprecated

since 5.0. Use getStyle() instead

AnimationStyle

• set _style(style): void

Deprecated

since 5.0. Use setStyle() instead

void

• get _timeOffset(): number

Deprecated

since 5.0. Use getTimeOffset() instead

number

• set _timeOffset(timeOffset): void

Deprecated

since 5.0. Use setTimeOffset() instead

void

• get _to(): any

Deprecated

since 5.0. Use getTo() instead

any

• set _to(to): void

Deprecated

since 5.0. Use setTo() instead

void

• Protected get _type(): string

Deprecated

since 5.0. Use getTo() instead

string

• Protected set _type(type): void

Deprecated

since 5.0. Use setTo() instead

void

• Protected get _unit(): string

Deprecated

since 5.0. Use getTo() instead

string

• Protected set _unit(unit): void

Deprecated

since 5.0. Use setTo() instead

void

• get _values(): any[]

Deprecated

since 5.0. Use getTo() instead

any[]

• set _values(values): void

Deprecated

since 5.0. Use setTo() instead

void

▸ apply(node): void

Applies effect to node and invalidate it To add animation support to target class create new Animation Effect by inherit from this class, and override method 'apply' to apply intermediate value to target class (for example with setters)

void

▸ Protected ended(): void

Called immediately after the effect ends.

void

▸ getActive(): boolean

Returns active state

boolean

active state

▸ getAnimatedValue(node): any

Extracts value which can animated from node

any

▸ getAttributeName(): string

Returns attribute name

string

attribute name

▸ getBegin(): string | number

Returns begin value

string | number

begin value

▸ getClassName(): string

string

▸ getCurrentValue(): any

Returns current value, which should be applied

any

▸ Protected getProcessor(): AbstractProcessor<any&gt;

Get processor, which will be used for calculate intermediate values

AbstractProcessor<any&gt;

▸ getRepeatCount(): number

Returns repeat count

number

▸ getState(): Object

Return state

Object

▸ getStyle(): AnimationStyle

Return style owner

AnimationStyle

style owner

▸ getTimeOffset(): number

Return time offset

number

time offset

▸ getTimeSegmentIndex(time): number

Gets the number of the time segment.

number

result time segment

▸ getTo(): any

Return to value

any

to value

▸ Protected getTransformation(node): Transformation

Returns transformation, that will be applied to the node

Transformation

transformation

▸ Protected getType(): string

Returns effect type

string

effect type

▸ Protected getUnit(): string

Return effect unit

string

effect unit

▸ getValues(): any[]

return values

any[]

▸ isApplicable(effect, node): boolean

Returns true if this class can accept passed effect as a parameter

boolean

▸ run(owner): AbstractEffect

Runs effect after creation

AbstractEffect

this

▸ setActive(active): AbstractEffect

Set active state

AbstractEffect

this

▸ setAttributeName(attribute): AbstractEffect

Set attribute name

AbstractEffect

this

▸ setBegin(begin): AbstractEffect

Set begin balue

AbstractEffect

this

▸ Protected setProcessor(processor): AbstractEffect

Set processor, which will be used for calculate intermediate values

AbstractEffect

▸ setState(state): AbstractEffect

Set State

AbstractEffect

this

▸ setStyle(style): AbstractEffect

Set style owner

AbstractEffect

this

▸ setTimeOffset(timeOffset): AbstractEffect

Set time offset

AbstractEffect

this

▸ setTo(to): AbstractEffect

Set to value

AbstractEffect

this

▸ Protected setType(type): AbstractEffect

Set effect type

AbstractEffect

this

▸ Protected setUnit(unit): AbstractEffect

Set effect unit

AbstractEffect

this

▸ setValues(values): void

Sets a collection of values to the internal value list. After the values have been added, key times will be recalculated.

void

▸ Protected started(): void

Called immediately after the effect begins.

void

▸ stop(node): void

Stop effect

void

▸ Static fromObject(object?): AbstractEffect

Create or get effect from object

AbstractEffect

effect

▸ Static getClassName(): string

string