| Top |
Functions
Properties
| ClutterAlignAxis | align-axis | Read / Write / Construct |
| gfloat | factor | Read / Write / Construct |
| ClutterActor * | source | Read / Write / Construct |
Object Hierarchy
GObject ╰── GInitiallyUnowned ╰── ClutterActorMeta ╰── ClutterConstraint ╰── ClutterAlignConstraint
Description
ClutterAlignConstraint is a ClutterConstraint that aligns the position of the ClutterActor to which it is applied to the size of another ClutterActor using an alignment factor
ClutterAlignConstraint is available since Clutter 1.4
Functions
clutter_align_constraint_new ()
ClutterConstraint * clutter_align_constraint_new (ClutterActor *source,ClutterAlignAxis axis,gfloat factor);
Creates a new constraint, aligning a ClutterActor's position with
regards of the size of the actor to source
, with the given
alignment factor
Parameters
source |
the ClutterActor to use as the source of the
alignment, or |
[allow-none] |
axis |
the axis to be used to compute the alignment |
|
factor |
the alignment factor, between 0.0 and 1.0 |
Since: 1.4
clutter_align_constraint_set_source ()
void clutter_align_constraint_set_source (ClutterAlignConstraint *align,ClutterActor *source);
Sets the source of the alignment constraint
Since: 1.4
clutter_align_constraint_get_source ()
ClutterActor *
clutter_align_constraint_get_source (ClutterAlignConstraint *align);
Retrieves the source of the alignment
Since: 1.4
clutter_align_constraint_set_align_axis ()
void clutter_align_constraint_set_align_axis (ClutterAlignConstraint *align,ClutterAlignAxis axis);
Sets the axis to which the alignment refers to
Since: 1.4
clutter_align_constraint_get_align_axis ()
ClutterAlignAxis
clutter_align_constraint_get_align_axis
(ClutterAlignConstraint *align);
Retrieves the value set using clutter_align_constraint_set_align_axis()
Since: 1.4
clutter_align_constraint_set_factor ()
void clutter_align_constraint_set_factor (ClutterAlignConstraint *align,gfloat factor);
Sets the alignment factor of the constraint
The factor depends on the “align-axis” property
and it is a value between 0.0 (meaning left, when
“align-axis” is set to CLUTTER_ALIGN_X_AXIS; or
meaning top, when “align-axis” is set to
CLUTTER_ALIGN_Y_AXIS) and 1.0 (meaning right, when
“align-axis” is set to CLUTTER_ALIGN_X_AXIS; or
meaning bottom, when “align-axis” is set to
CLUTTER_ALIGN_Y_AXIS). A value of 0.5 aligns in the middle in either
cases
Since: 1.4
clutter_align_constraint_get_factor ()
gfloat
clutter_align_constraint_get_factor (ClutterAlignConstraint *align);
Retrieves the factor set using clutter_align_constraint_set_factor()
Since: 1.4
Types and Values
ClutterAlignConstraint
typedef struct _ClutterAlignConstraint ClutterAlignConstraint;
ClutterAlignConstraint is an opaque structure whose members cannot be directly accesses
Since: 1.4
enum ClutterAlignAxis
Specifies the axis on which ClutterAlignConstraint should maintain the alignment.
Since: 1.4
Property Details
The “align-axis” property
“align-axis” ClutterAlignAxis
The axis to be used to compute the alignment
Flags: Read / Write / Construct
Default value: CLUTTER_ALIGN_X_AXIS
Since: 1.4
The “factor” property
“factor” gfloat
The alignment factor, as a normalized value between 0.0 and 1.0
The factor depends on the “align-axis” property:
with an align-axis value of CLUTTER_ALIGN_X_AXIS, 0.0 means left and
1.0 means right; with a value of CLUTTER_ALIGN_Y_AXIS, 0.0 means top
and 1.0 means bottom.
Flags: Read / Write / Construct
Allowed values: [0,1]
Default value: 0
Since: 1.4
The “source” property
“source” ClutterActor *
The ClutterActor used as the source for the alignment.
The ClutterActor must not be a child or a grandchild of the actor using the constraint.
Flags: Read / Write / Construct
Since: 1.4
