Copyright	(c) 2023 Ruslan Gadeev Francisco Vallarino
License	BSD-3-Clause (see the LICENSE file)
Maintainer	fjvallarino@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Monomer.Widgets.Animation.Transform

Contents

Configuration
Render transformations
Constructors

Description

Transform animation widget. Wraps a child widget whose content will be animated. Acts as a base for most animation widgets.

Messages:

Accepts an AnimationMsg, used to control the state of the animation.

transform t (Rect x y w h) =
  [ animTranslation $ Point tx ty
  , animScale $ Point sx sy
  ]

animTransform transform managed

With configuration options:

transform t (Rect x y w h) =
  [ animTranslation $ Point tx ty
  , animScale $ Point sx sy
  ]

animTransform_ [duration 2000, autoStart] transform managed

For usage examples, see:

Synopsis

data TransformCfg s e = TransformCfg {
- _tfcAutoStart :: Maybe Bool
- _tfcDuration :: Maybe Millisecond
- _tfcOnFinishedReq :: [WidgetRequest s e]
}
data RenderTransform
animTranslation :: Point -> RenderTransform
animScale :: Point -> RenderTransform
animRotation :: Double -> RenderTransform
animGlobalAlpha :: Double -> RenderTransform
animScissor :: Rect -> RenderTransform
animTransform :: WidgetEvent e => Transformer -> WidgetNode s e -> WidgetNode s e
animTransform_ :: WidgetEvent e => [TransformCfg s e] -> Transformer -> WidgetNode s e -> WidgetNode s e

Configuration

data TransformCfg s e Source #

Configuration options for transform:

autoStart: whether the first time the widget is added, animation should run.
duration: how long the animation lasts in ms.
onFinished: event to raise when animation is complete.
onFinishedReq: WidgetRequest to generate when animation is complete.

Constructors

TransformCfg
Fields _tfcAutoStart :: Maybe Bool _tfcDuration :: Maybe Millisecond _tfcOnFinishedReq :: [WidgetRequest s e]

Instances

Instances details

Monoid (TransformCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods mempty :: TransformCfg s e # mappend :: TransformCfg s e -> TransformCfg s e -> TransformCfg s e # mconcat :: [TransformCfg s e] -> TransformCfg s e #
Semigroup (TransformCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods (<>) :: TransformCfg s e -> TransformCfg s e -> TransformCfg s e # sconcat :: NonEmpty (TransformCfg s e) -> TransformCfg s e # stimes :: Integral b => b -> TransformCfg s e -> TransformCfg s e #
Show (TransformCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods showsPrec :: Int -> TransformCfg s e -> ShowS # show :: TransformCfg s e -> String # showList :: [TransformCfg s e] -> ShowS #
Default (TransformCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods def :: TransformCfg s e #
Eq e => Eq (TransformCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods (==) :: TransformCfg s e -> TransformCfg s e -> Bool # (/=) :: TransformCfg s e -> TransformCfg s e -> Bool #
CmbAutoStart (TransformCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods autoStart :: TransformCfg s e Source # autoStart_ :: Bool -> TransformCfg s e Source #
CmbDuration (TransformCfg s e) Millisecond Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods duration :: Millisecond -> TransformCfg s e Source #
WidgetEvent e => CmbOnFinished (TransformCfg s e) e Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods onFinished :: e -> TransformCfg s e Source #
CmbOnFinishedReq (TransformCfg s e) s e Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods onFinishedReq :: WidgetRequest s e -> TransformCfg s e Source #

Render transformations

data RenderTransform Source #

Possible render transformations:

animTranslation: translates by the given offset.
animScale: scales by the given size.
animRotation: rotates by the given angle.
animGlobalAlpha: applies the given alpha.
animScissor: scissors to the given viewport.

Instances

Instances details

Monoid RenderTransform Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods mempty :: RenderTransform # mappend :: RenderTransform -> RenderTransform -> RenderTransform # mconcat :: [RenderTransform] -> RenderTransform #
Semigroup RenderTransform Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods (<>) :: RenderTransform -> RenderTransform -> RenderTransform # sconcat :: NonEmpty RenderTransform -> RenderTransform # stimes :: Integral b => b -> RenderTransform -> RenderTransform #
Default RenderTransform Source #
Instance details Defined in Monomer.Widgets.Animation.Transform Methods def :: RenderTransform #

animTranslation :: Point -> RenderTransform Source #

Translate by the given offset.

animScale :: Point -> RenderTransform Source #

Scale by the given size.

animRotation :: Double -> RenderTransform Source #

Rotate by the given angle.

animGlobalAlpha :: Double -> RenderTransform Source #

Apply the given alpha.

animScissor :: Rect -> RenderTransform Source #

Scissor to the given viewport.

Constructors

animTransform Source #

Arguments

:: WidgetEvent e
=> Transformer	Transformations from time (in ms) and viewport.
-> WidgetNode s e	The child node.
-> WidgetNode s e	The created animation container.

Animates a widget through translation, scaling, rotation, transparency and scissor.

animTransform_ Source #

Arguments

:: WidgetEvent e
=> [TransformCfg s e]	The config options.
-> Transformer	Transformations from time (in ms) and viewport.
-> WidgetNode s e	The child node.
-> WidgetNode s e	The created animation container.

Animates a widget through translation, scaling, rotation, transparency and scissor. Accepts config.