GI.Clutter.Objects.Animator

The Animator structure contains only private data and should be accessed using the provided API

Since: 1.2

Exported types

newtype Animator

Memory-managed wrapper type.

Constructors

Animator (ManagedPtr Animator)

Instances

Eq Animator

Defined in GI.Clutter.Objects.Animator

Methods

(==) :: Animator -> Animator -> Bool

(/=) :: Animator -> Animator -> Bool

GObject Animator

Defined in GI.Clutter.Objects.Animator

ManagedPtrNewtype Animator

Defined in GI.Clutter.Objects.Animator

Methods

toManagedPtr :: Animator -> ManagedPtr Animator

TypedObject Animator

Defined in GI.Clutter.Objects.Animator

Methods

glibType :: IO GType

HasParentTypes Animator

Defined in GI.Clutter.Objects.Animator

IsGValue (Maybe Animator)

Convert Animator to and from GValue. See toGValue and fromGValue.

Defined in GI.Clutter.Objects.Animator

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Animator -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Animator)

type ParentTypes Animator

Defined in GI.Clutter.Objects.Animator

type ParentTypes Animator = '[Object, Scriptable]

class (GObject o, IsDescendantOf Animator o) => IsAnimator o

Type class for types which can be safely cast to Animator, for instance with toAnimator.

Instances

(GObject o, IsDescendantOf Animator o) => IsAnimator o

Defined in GI.Clutter.Objects.Animator

toAnimator :: (MonadIO m, IsAnimator o) => o -> m Animator

Cast to Animator, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, computeValue, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, parseCustomNode, propertyGetEaseIn, propertyGetInterpolation, propertySetEaseIn, propertySetInterpolation, ref, refSink, removeKey, runDispose, start, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getDuration, getId, getKeys, getProperty, getQdata, getTimeline.

Setters

setCustomProperty, setData, setDataFull, setDuration, setId, setKey, setProperty, setTimeline.

computeValue

animatorComputeValue

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsObject b)

=> a

animator: a Animator

-> b

object: a Object

-> Text

propertyName: the name of the property on object to check

-> Double

progress: a value between 0.0 and 1.0

-> GValue

value: an initialized value to store the computed result

-> m Bool

Returns: True if the computation yields has a value, otherwise (when an error occurs or the progress is before any of the keys) False is returned and the Value is left untouched

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Compute the value for a managed property at a given progress.

If the property is an ease-in property, the current value of the property on the object will be used as the starting point for computation.

Since: 1.2

getDuration

animatorGetDuration

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a)

=> a

animator: a Animator

-> m Word32

Returns: the duration of the animation, in milliseconds

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the current duration of an animator

Since: 1.2

getKeys

animatorGetKeys

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsObject b)

=> a

animator: a Animator instance

-> Maybe b

object: a Object to search for, or Nothing for all objects

-> Maybe Text

propertyName: a specific property name to query for, or Nothing for all properties

-> Double

progress: a specific progress to search for, or a negative value for all progresses

-> m [AnimatorKey]

Returns: a list of AnimatorKeys; the contents of the list are owned by the Animator, but you should free the returned list when done, using g_list_free()

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Returns a list of pointers to opaque structures with accessor functions that describe the keys added to an animator.

Since: 1.2

getTimeline

animatorGetTimeline

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a)

=> a

animator: a Animator

-> m Timeline

Returns: the Timeline that drives the animator

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Get the timeline hooked up for driving the Animator

Since: 1.2

new

animatorNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Animator

Returns: a new Animator.

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Creates a new Animator instance

Since: 1.2

propertyGetEaseIn

animatorPropertyGetEaseIn

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsObject b)

=> a

animator: a AnimatorKey

-> b

object: a Object

-> Text

propertyName: the name of a property on object

-> m Bool

Returns: True if the property is eased in

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Checks if a property value is to be eased into the animation.

Since: 1.2

propertyGetInterpolation

animatorPropertyGetInterpolation

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsObject b)

=> a

animator: a AnimatorKey

-> b

object: a Object

-> Text

propertyName: the name of a property on object

-> m Interpolation

Returns: a ClutterInterpolation value.

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Get the interpolation used by animator for a property on a particular object.

Since: 1.2

propertySetEaseIn

animatorPropertySetEaseIn

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsObject b)

=> a

animator: a AnimatorKey

-> b

object: a Object

-> Text

propertyName: the name of a property on object

-> Bool

easeIn: we are going to be easing in this property

-> m ()

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Sets whether a property value is to be eased into the animation.

Since: 1.2

propertySetInterpolation

animatorPropertySetInterpolation

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsObject b)

=> a

animator: a AnimatorKey

-> b

object: a Object

-> Text

propertyName: the name of a property on object

-> Interpolation

interpolation: the Interpolation to use

-> m ()

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Set the interpolation method to use, InterpolationLinear causes the values to linearly change between the values, and InterpolationCubic causes the values to smoothly change between the values.

Since: 1.2

removeKey

animatorRemoveKey

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsObject b)

=> a

animator: a Animator

-> Maybe b

object: a Object to search for, or Nothing for all

-> Maybe Text

propertyName: a specific property name to query for, or Nothing for all

-> Double

progress: a specific progress to search for or a negative value for all

-> m ()

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Removes all keys matching the conditions specificed in the arguments.

Since: 1.2

setDuration

animatorSetDuration

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a)

=> a

animator: a Animator

-> Word32

duration: milliseconds a run of the animator should last.

-> m ()

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Runs the timeline of the Animator with a duration in msecs as specified.

Since: 1.2

setKey

animatorSetKey

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsObject b)

=> a

animator: a Animator

-> b

object: a Object

-> Text

propertyName: the property to specify a key for

-> Word32

mode: the id of the alpha function to use

-> Double

progress: the normalized range at which stage of the animation this value applies

-> GValue

value: the value property_name should have at progress.

-> m Animator

Returns: The animator instance

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Sets a single key in the Animator for the propertyName of object at progress.

See also: clutter_animator_set()

Since: 1.2

setTimeline

animatorSetTimeline

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a, IsTimeline b)

=> a

animator: a Animator

-> b

timeline: a Timeline

-> m ()

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Sets an external timeline that will be used for driving the animation

Since: 1.2

start

animatorStart

Arguments

:: (HasCallStack, MonadIO m, IsAnimator a)

=> a

animator: a Animator

-> m Timeline

Returns: the Timeline that drives the animator. The returned timeline is owned by the Animator and it should not be unreferenced

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Start the ClutterAnimator, this is a thin wrapper that rewinds and starts the animators current timeline.

Since: 1.2

Properties

duration

The duration of the Timeline used by the Animator to drive the animation

Since: 1.2

constructAnimatorDuration :: (IsAnimator o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “duration” property. This is rarely needed directly, but it is used by new.

getAnimatorDuration :: (MonadIO m, IsAnimator o) => o -> m Word32

Get the value of the “duration” property. When overloading is enabled, this is equivalent to

get animator #duration

setAnimatorDuration :: (MonadIO m, IsAnimator o) => o -> Word32 -> m ()

Set the value of the “duration” property. When overloading is enabled, this is equivalent to

set animator [ #duration := value ]

timeline

The Timeline used by the Animator to drive the animation

Since: 1.2

constructAnimatorTimeline :: (IsAnimator o, MonadIO m, IsTimeline a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “timeline” property. This is rarely needed directly, but it is used by new.

getAnimatorTimeline :: (MonadIO m, IsAnimator o) => o -> m Timeline

Get the value of the “timeline” property. When overloading is enabled, this is equivalent to

get animator #timeline

setAnimatorTimeline :: (MonadIO m, IsAnimator o, IsTimeline a) => o -> a -> m ()

Set the value of the “timeline” property. When overloading is enabled, this is equivalent to

set animator [ #timeline := value ]