animation_line_alpha interface¶
This page explains the animation_line_alpha
method interface.
What interface is this?¶
The animation_line_alpha
method interface creates an ap.AnimationLineAlpha
instance. You can animate line alpha (opacity) with it.
This interface exists on a GraphicsBase
subclass, such as the Rectangle
or Circle
class.
Basic usage¶
The following example sets the line alpha animation (from 1.0 to 0.0) with the animation_line_alpha
method:
import apysc as ap
DURATION: int = 1000
def on_animation_complete_1(e: ap.AnimationEvent[ap.Rectangle], options: dict) -> None:
"""
The handler that the animation calls when its end.
Parameters
----------
e : AnimationEvent
Event instance.
options : dict
Optional arguments dictionary.
"""
rectangle: ap.Rectangle = e.this.target
rectangle.animation_line_alpha(
alpha=1.0,
duration=DURATION,
).animation_complete(on_animation_complete_2).start()
def on_animation_complete_2(e: ap.AnimationEvent[ap.Rectangle], options: dict) -> None:
"""
The handler that the animation calls when its end.
Parameters
----------
e : AnimationEvent
Event instance.
options : dict
Optional arguments dictionary.
"""
rectangle: ap.Rectangle = e.this.target
rectangle.animation_line_alpha(
alpha=0.0,
duration=DURATION,
).animation_complete(on_animation_complete_1).start()
ap.Stage(
stage_width=150,
stage_height=150,
background_color=ap.Color("#333"),
stage_elem_id="stage",
)
sprite: ap.Sprite = ap.Sprite()
sprite.graphics.line_style(color=ap.Color("#eee"), thickness=5, alpha=1.0)
rectangle: ap.Rectangle = sprite.graphics.draw_rect(x=50, y=50, width=50, height=50)
rectangle.animation_line_alpha(
alpha=0.0,
duration=DURATION,
).animation_complete(on_animation_complete_1).start()
ap.save_overall_html(dest_dir_path="./animation_line_alpha_basic_usage/")
animation_line_alpha API¶
Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.
[Interface signature] animation_line_alpha(self, *, alpha: Union[float, apysc._type.number.Number], duration: Union[int, apysc._type.int.Int] = 3000, delay: Union[int, apysc._type.int.Int] = 0, easing: apysc._animation.easing.Easing = <Easing.LINEAR: 'function(x) {return x;}'>) -> apysc._animation.animation_line_alpha.AnimationLineAlpha
[Interface summary]
Set the line alpha animation setting.
[Parameters]
alpha
: Number or floatThe final line alpha of the animation.
duration
: Int or int, default 3000Milliseconds before an animation ends.
delay
: Int or int, default 0Milliseconds before an animation starts.
easing
: Easing, default Easing.LINEAREasing setting.
[Returns]
animation_line_alpha
: AnimationLineAlphaCreated animation setting instance.
[Notes]
To start this animation, you need to call the start
method of the returned instance.
[Examples]
>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> sprite: ap.Sprite = ap.Sprite()
>>> sprite.graphics.begin_fill(color=ap.Color("#0af"))
>>> sprite.graphics.line_style(color=ap.Color("#fff"), thickness=5, alpha=1.0)
>>> rectangle: ap.Rectangle = sprite.graphics.draw_rect(
... x=50, y=50, width=50, height=50
... )
>>> _ = rectangle.animation_line_alpha(
... alpha=0.0,
... duration=1500,
... easing=ap.Easing.EASE_OUT_QUINT,
... ).start()
[References]