Clutter.Alpha¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r |
Alpha value as computed by the alpha |
||
r/w/c |
Progress mode |
||
r/w |
Timeline used by the alpha |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class Clutter.Alpha(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Clutter.Alpha
combines aClutter.Timeline
and a function. The contents of theClutter.Alpha
structure are private and should only be accessed using the provided API.New in version 0.2.
Deprecated since version 1.12: Use
Clutter.Timeline
instead- classmethod new()¶
- Returns:
the newly created empty
Clutter.Alpha
instance.- Return type:
Creates a new
Clutter.Alpha
instance. You must set a function to compute the alpha value usingClutter.Alpha.set_func
() and bind aClutter.Timeline
object to theClutter.Alpha
instance usingClutter.Alpha.set_timeline
().You should use the newly created
Clutter.Alpha
instance inside aClutter.Behaviour
object.New in version 0.2.
Deprecated since version 1.12: Use
Clutter.Timeline
instead
- classmethod new_full(timeline, mode)¶
- Parameters:
timeline (
Clutter.Timeline
) –Clutter.Timeline
timelinemode (
int
) – animation mode
- Returns:
the newly created
Clutter.Alpha
- Return type:
Creates a new
Clutter.Alpha
instance and sets the timeline and animation mode.See also
Clutter.Alpha.set_timeline
() andClutter.Alpha.set_mode
().New in version 1.0.
Deprecated since version 1.12: Use
Clutter.Timeline
instead
- classmethod new_with_func(timeline, func, *data)¶
- Parameters:
timeline (
Clutter.Timeline
) – aClutter.Timeline
func (
Clutter.AlphaFunc
) – aClutter.AlphaFunc
data (
object
orNone
) – data to pass to the function, orNone
- Returns:
the newly created
Clutter.Alpha
- Return type:
Creates a new
Clutter.Alpha
instances and sets the timeline and the alpha function.This function will not register func as a global alpha function.
See also
Clutter.Alpha.set_timeline
() andClutter.Alpha.set_func
().New in version 1.0.
Deprecated since version 1.12: Use
Clutter.Timeline
instead
- classmethod register_func(closure)¶
- Parameters:
closure (
GObject.Closure
) – aGObject.Closure
- Returns:
the logical id of the alpha function
- Return type:
GObject.Closure
variant ofClutter.Alpha.register_func
().Registers a global alpha function and returns its logical id to be used by
Clutter.Alpha.set_mode
() or byClutter.Animation
.The logical id is always greater than
Clutter.AnimationMode.ANIMATION_LAST
.New in version 1.0.
Deprecated since version 1.12: There is no direct replacement for this function. Use
Clutter.Timeline.set_progress_func
() on each specificClutter.Timeline
instance
- get_alpha()¶
- Returns:
The current alpha value for the alpha
- Return type:
Query the current alpha value.
New in version 0.2.
Deprecated since version 1.12: Use
Clutter.Timeline.get_progress
()
- get_mode()¶
- Returns:
the animation mode
- Return type:
Retrieves the
Clutter.AnimationMode
used by self.New in version 1.0.
Deprecated since version 1.12: Use
Clutter.Timeline
instead
- get_timeline()¶
- Returns:
a
Clutter.Timeline
instance- Return type:
Gets the
Clutter.Timeline
bound to self.New in version 0.2.
Deprecated since version 1.12: Use
Clutter.Timeline
directlry
- set_closure(closure)¶
- Parameters:
closure (
GObject.Closure
) – AGObject.Closure
Sets the
GObject.Closure
used to compute the alpha value at each frame of theClutter.Timeline
bound to self.New in version 0.8.
Deprecated since version 1.12: Use
Clutter.Timeline.set_progress_func
()
- set_func(func, *data)¶
- Parameters:
func (
Clutter.AlphaFunc
) – AClutter.AlphaFunc
data (
object
orNone
) – user data to be passed to the alpha function, orNone
Sets the
Clutter.AlphaFunc
function used to compute the alpha value at each frame of theClutter.Timeline
bound to self.This function will not register func as a global alpha function.
New in version 0.2.
Deprecated since version 1.12: Use
Clutter.Timeline.set_progress_func
()
- set_mode(mode)¶
- Parameters:
mode (
int
) – aClutter.AnimationMode
Sets the progress function of self using the symbolic value of mode, as taken by the
Clutter.AnimationMode
enumeration or using the value returned byClutter.Alpha.register_func
().New in version 1.0.
Deprecated since version 1.12: Use
Clutter.Timeline
andClutter.Timeline.set_progress_mode
() instead
- set_timeline(timeline)¶
- Parameters:
timeline (
Clutter.Timeline
) – AClutter.Timeline
Binds self to timeline.
New in version 0.2.
Deprecated since version 1.12: Use
Clutter.Timeline
directly
Property Details¶
- Clutter.Alpha.props.alpha¶
-
The alpha value as computed by the alpha function. The linear interval is 0.0 to 1.0, but the Alpha allows overshooting by one unit in each direction, so the valid interval is -1.0 to 2.0.
New in version 0.2.
Deprecated since version 1.12: Use
Clutter.Timeline
::new-frame
andClutter.Timeline.get_progress
() instead
- Clutter.Alpha.props.mode¶
-
The progress function logical id - either a value from the
Clutter.AnimationMode
enumeration or a value returned byClutter.Alpha.register_func
().If
Clutter.AnimationMode.CUSTOM_MODE
is used then the function set usingClutter.Alpha.set_closure
() orClutter.Alpha.set_func
() will be used.New in version 1.0.
Deprecated since version 1.12: Use
Clutter.Timeline
:progress-mode
- Clutter.Alpha.props.timeline¶
- Name:
timeline
- Type:
- Default Value:
- Flags:
A
Clutter.Timeline
instance used to drive the alpha function.New in version 0.2.
Deprecated since version 1.12.