| Clutter 0.6 Reference Manual | ||||
|---|---|---|---|---|
ClutterBehaviourEllipseClutterBehaviourEllipse — A behaviour interpolating position along an ellipse |
ClutterBehaviourEllipse;
ClutterBehaviourEllipseClass;
ClutterBehaviour* clutter_behaviour_ellipse_new (ClutterAlpha *alpha,
gint x,
gint y,
gint width,
gint height,
ClutterRotateDirection direction,
gdouble start,
gdouble end);
ClutterBehaviour* clutter_behaviour_ellipse_newx (ClutterAlpha *alpha,
gint x,
gint y,
gint width,
gint height,
ClutterRotateDirection direction,
ClutterFixed start,
ClutterFixed end);
void clutter_behaviour_ellipse_set_center
(ClutterBehaviourEllipse *self,
gint x,
gint y);
void clutter_behaviour_ellipse_get_center
(ClutterBehaviourEllipse *self,
gint *x,
gint *y);
void clutter_behaviour_ellipse_set_angle_start
(ClutterBehaviourEllipse *self,
gdouble angle_start);
gdouble clutter_behaviour_ellipse_get_angle_start
(ClutterBehaviourEllipse *self);
void clutter_behaviour_ellipse_set_angle_startx
(ClutterBehaviourEllipse *self,
ClutterFixed angle_start);
ClutterFixed clutter_behaviour_ellipse_get_angle_startx
(ClutterBehaviourEllipse *self);
void clutter_behaviour_ellipse_set_angle_end
(ClutterBehaviourEllipse *self,
gdouble angle_end);
gdouble clutter_behaviour_ellipse_get_angle_end
(ClutterBehaviourEllipse *self);
void clutter_behaviour_ellipse_set_angle_endx
(ClutterBehaviourEllipse *self,
ClutterFixed angle_end);
ClutterFixed clutter_behaviour_ellipse_get_angle_endx
(ClutterBehaviourEllipse *self);
void clutter_behaviour_ellipse_set_angle_tilt
(ClutterBehaviourEllipse *self,
ClutterRotateAxis axis,
gdouble angle_tilt);
gdouble clutter_behaviour_ellipse_get_angle_tilt
(ClutterBehaviourEllipse *self,
ClutterRotateAxis axis);
void clutter_behaviour_ellipse_set_angle_tiltx
(ClutterBehaviourEllipse *self,
ClutterRotateAxis axis,
ClutterFixed angle_tilt);
ClutterFixed clutter_behaviour_ellipse_get_angle_tiltx
(ClutterBehaviourEllipse *self,
ClutterRotateAxis axis);
void clutter_behaviour_ellipse_set_height
(ClutterBehaviourEllipse *self,
gint height);
gint clutter_behaviour_ellipse_get_height
(ClutterBehaviourEllipse *self);
void clutter_behaviour_ellipse_set_width (ClutterBehaviourEllipse *self,
gint width);
gint clutter_behaviour_ellipse_get_width (ClutterBehaviourEllipse *self);
void clutter_behaviour_ellipse_set_tilt (ClutterBehaviourEllipse *self,
gdouble angle_tilt_x,
gdouble angle_tilt_y,
gdouble angle_tilt_z);
void clutter_behaviour_ellipse_get_tilt (ClutterBehaviourEllipse *self,
gdouble *angle_tilt_x,
gdouble *angle_tilt_y,
gdouble *angle_tilt_z);
void clutter_behaviour_ellipse_set_tiltx (ClutterBehaviourEllipse *self,
ClutterFixed angle_tilt_x,
ClutterFixed angle_tilt_y,
ClutterFixed angle_tilt_z);
void clutter_behaviour_ellipse_get_tiltx (ClutterBehaviourEllipse *self,
ClutterFixed *angle_tilt_x,
ClutterFixed *angle_tilt_y,
ClutterFixed *angle_tilt_z);
void clutter_behaviour_ellipse_set_direction
(ClutterBehaviourEllipse *self,
ClutterRotateDirection direction);
ClutterRotateDirection clutter_behaviour_ellipse_get_direction
(ClutterBehaviourEllipse *self);
"angle-end" gdouble : Read / Write "angle-start" gdouble : Read / Write "angle-tilt-x" gdouble : Read / Write "angle-tilt-y" gdouble : Read / Write "angle-tilt-z" gdouble : Read / Write "center" ClutterKnot : Read / Write "direction" ClutterRotateDirection : Read / Write "height" gint : Read / Write "width" gint : Read / Write
ClutterBehaviourEllipse interpolates actors along a path defined by an ellipse.
Note, on applying an ellipse behaviour to an actor its position will be set to what is dictated by the ellipses initial position.
typedef struct {
void (*knot_reached) (ClutterBehaviourEllipse *ellipseb,
const ClutterKnot *knot);
} ClutterBehaviourEllipseClass;
Ellipse behaviour class
knot_reached () |
signal class handler for the ClutterBehaviourEllipse::knot_reached signal |
Since 0.4
ClutterBehaviour* clutter_behaviour_ellipse_new (ClutterAlpha *alpha, gint x, gint y, gint width, gint height, ClutterRotateDirection direction, gdouble start, gdouble end);
Creates a behaviour that drives actors along an elliptical path with
given center, width and height; the movement starts at angle_start
degrees (with 0 corresponding to 12 o'clock) and ends at angle_end
degrees. Angles >= 360 degrees get clamped to the canonical interval
<0, 360), if start == end, the behaviour will rotate by exacly 360 degrees.
alpha : |
a ClutterAlpha, or NULL
|
x : |
x coordinace of the center |
y : |
y coordiance of the center |
width : |
width of the ellipse |
height : |
height of the ellipse |
direction : |
ClutterRotateDirection of rotation |
start : |
angle in degrees at which movement starts, between 0 and 360 |
end : |
angle in degrees at which movement ends, between 0 and 360 |
| Returns : | the newly created ClutterBehaviourEllipse |
Since 0.4
ClutterBehaviour* clutter_behaviour_ellipse_newx (ClutterAlpha *alpha, gint x, gint y, gint width, gint height, ClutterRotateDirection direction, ClutterFixed start, ClutterFixed end);
Creates a behaviour that drives actors along an elliptical path. This
is the fixed point variant of clutter_behaviour_ellipse_new().
alpha : |
a ClutterAlpha, or NULL
|
x : |
x coordinace of the center |
y : |
y coordiance of the center |
width : |
width of the ellipse |
height : |
height of the ellipse |
direction : |
ClutterRotateDirection of rotation |
start : |
ClutterFixed angle in degrees at which movement starts |
end : |
ClutterFixed angle in degrees at which movement ends |
| Returns : | the newly created ClutterBehaviourEllipse |
Since 0.4
void clutter_behaviour_ellipse_set_center
(ClutterBehaviourEllipse *self,
gint x,
gint y);
Sets the center of the elliptical path to the point represented by knot.
self : |
a ClutterBehaviourEllipse |
x : |
x coordinace of centre |
y : |
y coordinace of centre |
Since 0.4
void clutter_behaviour_ellipse_get_center
(ClutterBehaviourEllipse *self,
gint *x,
gint *y);
Gets the center of the elliptical path path.
self : |
a ClutterBehaviourEllipse |
x : |
location to store the x coordinace of the center, or NULL |
y : |
location to store the y coordinace of the center, or NULL |
Since 0.4
void clutter_behaviour_ellipse_set_angle_start
(ClutterBehaviourEllipse *self,
gdouble angle_start);
Sets the angle at which movement starts; angles >= 360 degress get clamped to the canonical interval <0, 360).
self : |
a ClutterBehaviourEllipse |
angle_start : |
angle at which movement starts in degrees, between 0 and 360. |
Since 0.6
gdouble clutter_behaviour_ellipse_get_angle_start
(ClutterBehaviourEllipse *self);
Gets the angle at which movements starts.
self : |
a ClutterBehaviourEllipse |
| Returns : | angle in degrees |
Since 0.6
void clutter_behaviour_ellipse_set_angle_startx
(ClutterBehaviourEllipse *self,
ClutterFixed angle_start);
Sets the angle at which movement starts; angles >= 360 degress get clamped to the canonical interval <0, 360).
self : |
a ClutterBehaviourEllipse |
angle_start : |
An angle, as ClutterFixed, at which movement starts, in degrees, between 0 and 360. |
Since 0.6
ClutterFixed clutter_behaviour_ellipse_get_angle_startx (ClutterBehaviourEllipse *self);
Gets the angle at which movements starts.
self : |
a ClutterBehaviourEllipse |
| Returns : | angle, as ClutterFixed, in degrees. |
Since 0.6
void clutter_behaviour_ellipse_set_angle_end
(ClutterBehaviourEllipse *self,
gdouble angle_end);
Sets the angle at which movement ends; angles >= 360 degress get clamped to the canonical interval <0, 360).
self : |
a ClutterBehaviourEllipse |
angle_end : |
angle at which movement ends in degrees, between 0 and 360. |
Since 0.4
gdouble clutter_behaviour_ellipse_get_angle_end
(ClutterBehaviourEllipse *self);
Gets the at which movements ends.
self : |
a ClutterBehaviourEllipse |
| Returns : | angle in degrees |
Since 0.4
void clutter_behaviour_ellipse_set_angle_endx
(ClutterBehaviourEllipse *self,
ClutterFixed angle_end);
Sets the angle at which movement ends; angles >= 360 degress get clamped to the canonical interval <0, 360).
self : |
a ClutterBehaviourEllipse |
angle_end : |
angle, as ClutterFixed, at which movement ends, in degrees, between 0 and 360. |
Since 0.4
ClutterFixed clutter_behaviour_ellipse_get_angle_endx (ClutterBehaviourEllipse *self);
Gets the angle at which movements ends.
self : |
a ClutterBehaviourEllipse |
| Returns : | angle, as ClutterFixed, in degrees |
Since 0.4
void clutter_behaviour_ellipse_set_angle_tilt
(ClutterBehaviourEllipse *self,
ClutterRotateAxis axis,
gdouble angle_tilt);
Sets the angle at which the ellipse should be tilted around it's center.
self : |
a ClutterBehaviourEllipse |
axis : |
a ClutterRotateAxis |
angle_tilt : |
tilt of the elipse around the center in the given axis in degrees. |
Since 0.4
gdouble clutter_behaviour_ellipse_get_angle_tilt
(ClutterBehaviourEllipse *self,
ClutterRotateAxis axis);
Gets the tilt of the ellipse around the center in the given axis.
self : |
a ClutterBehaviourEllipse |
axis : |
a ClutterRotateAxis |
| Returns : | angle in degrees. |
Since 0.4
void clutter_behaviour_ellipse_set_angle_tiltx
(ClutterBehaviourEllipse *self,
ClutterRotateAxis axis,
ClutterFixed angle_tilt);
Sets the angle at which the ellipse should be tilted around it's center.
self : |
a ClutterBehaviourEllipse |
axis : |
a ClutterRoateAxis |
angle_tilt : |
tilt, as ClutterFixed, of the elipse around the center in the given axis in degrees. |
Since 0.4
ClutterFixed clutter_behaviour_ellipse_get_angle_tiltx (ClutterBehaviourEllipse *self, ClutterRotateAxis axis);
Gets the tilt of the ellipse around the center in the given axis.
self : |
a ClutterBehaviourEllipse |
axis : |
a ClutterRotateAxis |
| Returns : | angle, as ClutterFixed, in degrees |
Since 0.4
void clutter_behaviour_ellipse_set_height
(ClutterBehaviourEllipse *self,
gint height);
Sets the height of the elliptical path.
self : |
a ClutterBehaviourEllipse |
height : |
height of the ellipse |
Since 0.4
gint clutter_behaviour_ellipse_get_height
(ClutterBehaviourEllipse *self);
Gets the height of the elliptical path.
self : |
a ClutterBehaviourEllipse |
| Returns : | the height of the path |
Since 0.4
void clutter_behaviour_ellipse_set_width (ClutterBehaviourEllipse *self, gint width);
Sets the width of the elliptical path.
self : |
a ClutterBehaviourEllipse |
width : |
width of the ellipse |
Since 0.4
gint clutter_behaviour_ellipse_get_width (ClutterBehaviourEllipse *self);
Gets the width of the elliptical path.
self : |
a ClutterBehaviourEllipse |
| Returns : | the width of the path |
Since 0.4
void clutter_behaviour_ellipse_set_tilt (ClutterBehaviourEllipse *self, gdouble angle_tilt_x, gdouble angle_tilt_y, gdouble angle_tilt_z);
Sets the angles at which the ellipse should be tilted around it's center.
self : |
a ClutterBehaviourEllipse |
angle_tilt_x : |
tilt of the elipse around the center in X axis in degrees. |
angle_tilt_y : |
tilt of the elipse around the center in Y axis in degrees. |
angle_tilt_z : |
tilt of the elipse around the center in Z axis in degrees. |
Since 0.4
void clutter_behaviour_ellipse_get_tilt (ClutterBehaviourEllipse *self, gdouble *angle_tilt_x, gdouble *angle_tilt_y, gdouble *angle_tilt_z);
Gets the tilt of the ellipse around the center in Y axis.
self : |
a ClutterBehaviourEllipse |
angle_tilt_x : |
return location for tilt angle on the X axis, or NULL.
|
angle_tilt_y : |
return location for tilt angle on the Y axis, or NULL.
|
angle_tilt_z : |
return location for tilt angle on the Z axis, or NULL.
|
Since 0.4
void clutter_behaviour_ellipse_set_tiltx (ClutterBehaviourEllipse *self, ClutterFixed angle_tilt_x, ClutterFixed angle_tilt_y, ClutterFixed angle_tilt_z);
Sets the angle at which the ellipse should be tilted around it's center.
self : |
a ClutterBehaviourEllipse |
angle_tilt_x : |
tilt of the elipse in degrees, as ClutterFixed, around the center in X axis |
angle_tilt_y : |
tilt of the elipse in degrees, as ClutterFixed, around the center in Y axis |
angle_tilt_z : |
tilt of the elipse in degrees, as ClutterFixed, around the center in Z axis |
Since 0.4
void clutter_behaviour_ellipse_get_tiltx (ClutterBehaviourEllipse *self, ClutterFixed *angle_tilt_x, ClutterFixed *angle_tilt_y, ClutterFixed *angle_tilt_z);
Gets the tilt of the ellipse around the center in Y axis.
self : |
a ClutterBehaviourEllipse |
angle_tilt_x : |
location for tilt of the elipse, as ClutterFixed, around the center in X axis in degrees, or NULL. |
angle_tilt_y : |
location for tilt of the elipse, as ClutterFixed, around the center in Y axis in degress, or NULL. |
angle_tilt_z : |
location for tilt of the elipse, as ClutterFixed, around the center in Z axis in degrees, or NULL. |
Since 0.4
void clutter_behaviour_ellipse_set_direction
(ClutterBehaviourEllipse *self,
ClutterRotateDirection direction);
Sets the rotation direction used by the ellipse behaviour.
self : |
a ClutterBehaviourEllipse |
direction : |
the rotation direction |
Since 0.4
ClutterRotateDirection clutter_behaviour_ellipse_get_direction (ClutterBehaviourEllipse *self);
Retrieves the ClutterRotateDirection used by the ellipse behaviour.
self : |
a ClutterBehaviourEllipse |
| Returns : | the rotation direction |
Since 0.4
angle-end" property"angle-end" gdouble : Read / Write
The final angle to where the rotation should end.
Allowed values: [0,360]
Default value: 0
Since 0.4
angle-start" property"angle-start" gdouble : Read / Write
The initial angle from where the rotation should start.
Allowed values: [0,360]
Default value: 0
Since 0.4
angle-tilt-x" property"angle-tilt-x" gdouble : Read / Write
The tilt angle for the rotation around center in x axis
Allowed values: [0,360]
Default value: 360
Since 0.4
angle-tilt-y" property"angle-tilt-y" gdouble : Read / Write
The tilt angle for the rotation around center in y axis
Allowed values: [0,360]
Default value: 360
Since 0.4
angle-tilt-z" property"angle-tilt-z" gdouble : Read / Write
The tilt_z angle for the rotation
Allowed values: [0,360]
Default value: 360
Since 0.4
direction" property"direction" ClutterRotateDirection : Read / Write
The direction of the rotation.
Default value: CLUTTER_ROTATE_CW
Since 0.4
height" property"height" gint : Read / Write
Height of the ellipse.
Allowed values: >= 0
Default value: 50
Since 0.4