Clutter.Interval¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Clutter.Scriptable (4)
Structs:: GObject.ObjectClass (5)

class	`new_with_values` (gtype, initial, final)
	`clone` ()
	`compute` (factor)
	`compute_value` (factor)
	`get_final_value` ()
	`get_initial_value` ()
	`get_value_type` ()
	`is_valid` ()
	`peek_final_value` ()
	`peek_initial_value` ()
	`set_final` (value)
	`set_initial` (value)
	`validate` (pspec)

Virtual Methods¶

Inherited:: GObject.Object (7), Clutter.Scriptable (4)

	`do_compute_value` (factor)
	`do_validate` (pspec)

Properties¶

Name	Type	Flags	Short Description
`final`	`GObject.Value`	r/w	Final value of the interval
`initial`	`GObject.Value`	r/w	Initial value of the interval
`value-type`	`GObject.GType`	r/w/co	The type of the values in the interval

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.InitiallyUnowned`	r

Class Details¶

class Clutter.Interval(**kwargs)¶

Bases:: GObject.InitiallyUnowned, Clutter.Scriptable
Abstract:: No
Structure:: Clutter.IntervalClass

The Clutter.Interval structure contains only private data and should be accessed using the provided functions.

New in version 1.0.

classmethod new_with_values(gtype, initial, final)¶

Parameters:

gtype (GObject.GType) – the type of the values in the interval
initial (GObject.Value or None) – a GObject.Value holding the initial value of the interval
final (GObject.Value or None) – a GObject.Value holding the final value of the interval

Returns:

the newly created Clutter.Interval

Return type:

Clutter.Interval

Creates a new Clutter.Interval of type gtype, between initial and final.

This function is useful for language bindings.

New in version 1.0.

clone()¶

Returns:: the newly created Clutter.Interval
Return type:: Clutter.Interval

Creates a copy of self.

New in version 1.0.

compute(factor)¶

Parameters:: factor (float) – the progress factor, between 0 and 1
Returns:: a pointer to the computed value, or None if the computation was not successfull
Return type:: GObject.Value

Computes the value between the self boundaries given the progress factor

Unlike Clutter.Interval.compute_value(), this function will return a const pointer to the computed value

You should use this function if you immediately pass the computed value to another function that makes a copy of it, like GObject.Object.set_property()

New in version 1.4.

compute_value(factor)¶

Parameters:

factor (float) – the progress factor, between 0 and 1

Returns:

True if the operation was successful

value:: return location for an initialized GObject.Value

Return type:

(bool, value: GObject.Value)

Computes the value between the self boundaries given the progress factor and copies it into value.

New in version 1.0.

get_final_value()¶

Returns:: a GObject.Value
Return type:: value: GObject.Value

Retrieves the final value of self and copies it into value.

The passed GObject.Value must be initialized to the value held by the Clutter.Interval.

New in version 1.0.

get_initial_value()¶

Returns:: a GObject.Value
Return type:: value: GObject.Value

Retrieves the initial value of self and copies it into value.

The passed GObject.Value must be initialized to the value held by the Clutter.Interval.

New in version 1.0.

get_value_type()¶

Returns:: the type of the value, or GObject.TYPE_INVALID
Return type:: GObject.GType

Retrieves the GObject.GType of the values inside self.

New in version 1.0.

is_valid()¶

Returns:: True if the Clutter.Interval has an initial and final values, and False otherwise
Return type:: bool

Checks if the self has a valid initial and final values.

New in version 1.12.

peek_final_value()¶

Returns:: the final value of the interval. The value is owned by the Clutter.Interval and it should not be modified or freed
Return type:: GObject.Value

Gets the pointer to the final value of self

New in version 1.0.

peek_initial_value()¶

Returns:: the initial value of the interval. The value is owned by the Clutter.Interval and it should not be modified or freed
Return type:: GObject.Value

Gets the pointer to the initial value of self

New in version 1.0.

set_final(value)¶

Parameters:: value (GObject.Value) – a GObject.Value

Sets the final value of self to value. The value is copied inside the Clutter.Interval.

New in version 1.0.

set_initial(value)¶

Parameters:: value (GObject.Value) – a GObject.Value

Sets the initial value of self to value. The value is copied inside the Clutter.Interval.

New in version 1.0.

validate(pspec)¶

Parameters:: pspec (GObject.ParamSpec) – a GObject.ParamSpec
Returns:: True if the Clutter.Interval is valid, False otherwise
Return type:: bool

Validates the initial and final values of self against a GObject.ParamSpec.

New in version 1.0.

do_compute_value(factor) virtual¶

Parameters:

factor (float) – the progress factor, between 0 and 1

Returns:

True if the operation was successful

value:: return location for an initialized GObject.Value

Return type:

(bool, value: GObject.Value)

Computes the value between the interval boundaries given the progress factor and copies it into value.

New in version 1.0.

do_validate(pspec) virtual¶

Parameters:: pspec (GObject.ParamSpec) – a GObject.ParamSpec
Returns:: True if the Clutter.Interval is valid, False otherwise
Return type:: bool

Validates the initial and final values of interval against a GObject.ParamSpec.

New in version 1.0.

Property Details¶

Clutter.Interval.props.final¶

Name:: final
Type:: GObject.Value
Default Value:: None
Flags:: READABLE, WRITABLE

The final value of the interval.

New in version 1.12.

Clutter.Interval.props.initial¶

Name:: initial
Type:: GObject.Value
Default Value:: None
Flags:: READABLE, WRITABLE

The initial value of the interval.

New in version 1.12.

Clutter.Interval.props.value_type¶

Name:: value-type
Type:: GObject.GType
Default Value:: <GType void>
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The type of the values in the interval.

New in version 1.0.