| TextWaveAnimator Class |
An animator that add wave animation to rich paragraphs.
Inheritance HierarchyNamespace: GeonBit.UI.Animators
Assembly: GeonBit.UI (in GeonBit.UI.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class TextWaveAnimator : IAnimator
The TextWaveAnimator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TextWaveAnimator | Initializes a new instance of the TextWaveAnimator class |
Properties| Name | Description | |
|---|---|---|
 | IsDone |
Did this animator finish?
(Overrides IAnimatorIsDone.) |
| ShouldRemoveWhenDone |
Should remove this animator when done?
(Inherited from IAnimator.) |
| TargetEntity |
Target entity this animator operates on.
(Inherited from IAnimator.) |
Methods| Name | Description | |
|---|---|---|
| CheckEntityCompatibility |
Return if an entity type is compatible with this animator.
(Overrides IAnimatorCheckEntityCompatibility(Entity).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Reset |
Reset animation.
(Overrides IAnimatorReset.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Update |
Do animation.
(Overrides IAnimatorUpdate.) |
Fields| Name | Description | |
|---|---|---|
 | Enabled |
Is this animator currently running?
(Inherited from IAnimator.) |
| Loop |
Should play this animation in a loop?
|
| SpeedFactor |
Wave movement speed.
|
| WaveHeight |
Wave height factor.
|
| WaveLengthFactor |
Wave length / width factor.
|
See Also