public
class
AnimationStyleBuilder
extends Object| java.lang.Object | |
| ↳ | com.carto.styles.AnimationStyleBuilder |
Class Overview
A builder for AnimationStyle instances.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
AnimationStyleBuilder()
Constructs an AnimationStyleBuilder object with all parameters set to defaults.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AnimationStyle |
buildStyle()
Builds a new instance of the AnimationStyle object using previously set parameters.
| ||||||||||
| synchronized void | delete() | ||||||||||
| AnimationType |
getFadeAnimationType()
Returns the fade animation type.
| ||||||||||
| float |
getPhaseInDuration()
Returns the phase-in duration of the animation.
| ||||||||||
| float |
getPhaseOutDuration()
Returns the phase-out duration of the animation.
| ||||||||||
| float |
getRelativeSpeed()
Returns the relative speed of the animation.
| ||||||||||
| AnimationType |
getSizeAnimationType()
Returns the size-related animation type.
| ||||||||||
| void |
setFadeAnimationType(AnimationType animType)
Sets the fade animation type.
| ||||||||||
| void |
setPhaseInDuration(float duration)
Sets the phase-in duration of the animation.
| ||||||||||
| void |
setPhaseOutDuration(float duration)
Sets the phase-out duration of the animation.
| ||||||||||
| void |
setRelativeSpeed(float relativeSpeed)
Sets the relative speed of the animation.
| ||||||||||
| void |
setSizeAnimationType(AnimationType animType)
Sets the size-related animation type.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public AnimationStyleBuilder ()
Constructs an AnimationStyleBuilder object with all parameters set to defaults.
Public Methods
public AnimationStyle buildStyle ()
Builds a new instance of the AnimationStyle object using previously set parameters.
Returns
- A new AnimationStyle object.
public synchronized void delete ()
public AnimationType getFadeAnimationType ()
Returns the fade animation type.
Returns
- The type of the fade animation.
public float getPhaseInDuration ()
Returns the phase-in duration of the animation.
Returns
- The phase-in duration of the animation in seconds. By default this is 0.5.
public float getPhaseOutDuration ()
Returns the phase-out duration of the animation.
Returns
- The phase-out duration of the animation in seconds. By default this is 0.0, which means instant effect.
public float getRelativeSpeed ()
Returns the relative speed of the animation.
Returns
- The relative speed of the animation (1.0 corresponds to the default speed).
public AnimationType getSizeAnimationType ()
Returns the size-related animation type.
Returns
- The type of the size-related animation.
public void setFadeAnimationType (AnimationType animType)
Sets the fade animation type.
Parameters
| animType | The new type of the fade animation. |
|---|
public void setPhaseInDuration (float duration)
Sets the phase-in duration of the animation.
Parameters
| duration | The new phase-in duration of the animation in seconds. |
|---|
public void setPhaseOutDuration (float duration)
Sets the phase-out duration of the animation.
Parameters
| duration | The new phase-out duration of the animation in seconds. |
|---|
public void setRelativeSpeed (float relativeSpeed)
Sets the relative speed of the animation. The relative speed affects all phases of the animation.
Parameters
| relativeSpeed | The new relative speed of the animation. |
|---|
public void setSizeAnimationType (AnimationType animType)
Sets the size-related animation type.
Parameters
| animType | The new type of the size-related animation. |
|---|