ClutterAlignConstraint

ClutterAlignConstraint — A constraint aligning the position of an actor

Synopsis

                    ClutterAlignConstraint;
enum                ClutterAlignAxis;
ClutterConstraint * clutter_align_constraint_new        (ClutterActor *source,
                                                         ClutterAlignAxis axis,
                                                         gfloat factor);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActorMeta
               +----ClutterConstraint
                     +----ClutterAlignConstraint

Properties

  "align-axis"               ClutterAlignAxis      : Read / Write / Construct
  "factor"                   gfloat                : Read / Write / Construct
  "source"                   ClutterActor*         : Read / Write / Construct

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

Details

ClutterAlignConstraint

typedef struct _ClutterAlignConstraint ClutterAlignConstraint;

ClutterAlignConstraint is an opaque structure whose members cannot be directly accesses

Since 1.4


enum ClutterAlignAxis

typedef enum { /*< prefix=CLUTTER_ALIGN >*/
  CLUTTER_ALIGN_X_AXIS,
  CLUTTER_ALIGN_Y_AXIS,
} ClutterAlignAxis;

Specifies the axis on which ClutterAlignConstraint should maintain the alignment

CLUTTER_ALIGN_X_AXIS

Maintain the alignment on the X axis

CLUTTER_ALIGN_Y_AXIS

Maintain the alignment on the Y axis

Since 1.4


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

source :

the ClutterActor to use as the source of the alignment

axis :

the axis to be used to compute the alignment

factor :

the alignment factor, between 0.0 and 1.0

Returns :

the newly created ClutterAlignConstraint

Since 1.4

Property Details

The "align-axis" property

  "align-axis"               ClutterAlignAxis      : Read / Write / Construct

The axis to be used to compute the alignment

Default value: CLUTTER_ALIGN_X_AXIS

Since 1.4


The "factor" property

  "factor"                   gfloat                : Read / Write / Construct

The alignment factor, as a normalized value between 0.0 and 1.0

The "factor" depends on the "align-axis" value: with CLUTTER_ALIGN_X_AXIS, 0.0 means left and 1.0 means right; with CLUTTER_ALIGN_Y_AXIS, 0.0 means top and 1.0 means bottom

Allowed values: [0,1]

Default value: 0

Since 1.4


The "source" property

  "source"                   ClutterActor*         : Read / Write / Construct

The ClutterActor used as the source for the alignment

Since 1.4