Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

actions?: Clutter.Action

Adds a #ClutterAction to the actor

anchorGravity?: Clutter.Gravity

The anchor point expressed as a #ClutterGravity

It is highly recommended not to use #ClutterActor:anchor-x, #ClutterActor:anchor-y, and #ClutterActor:anchor-gravity in newly written code; the anchor point adds an additional translation that will affect the actor's relative position with regards to its parent, as well as the position of its children. This change needs to always be taken into account when positioning the actor. It is recommended to use the #ClutterActor:pivot-point property instead, as it will affect only the transformations.

anchorX?: number

The X coordinate of an actor's anchor point, relative to the actor coordinate space, in pixels.

It is highly recommended not to use #ClutterActor:anchor-x, #ClutterActor:anchor-y, and #ClutterActor:anchor-gravity in newly written code; the anchor point adds an additional translation that will affect the actor's relative position with regards to its parent, as well as the position of its children. This change needs to always be taken into account when positioning the actor. It is recommended to use the #ClutterActor:pivot-point property instead, as it will affect only the transformations.

anchorY?: number

The Y coordinate of an actor's anchor point, relative to the actor coordinate space, in pixels

It is highly recommended not to use #ClutterActor:anchor-x, #ClutterActor:anchor-y, and #ClutterActor:anchor-gravity in newly written code; the anchor point adds an additional translation that will affect the actor's relative position with regards to its parent, as well as the position of its children. This change needs to always be taken into account when positioning the actor. It is recommended to use the #ClutterActor:pivot-point property instead, as it will affect only the transformations.

backgroundColor?: Clutter.Color

Paints a solid fill of the actor's allocation using the specified color.

The #ClutterActor:background-color property is animatable.

childTransform?: Clutter.Matrix

Applies a transformation matrix on each child of an actor.

Setting this property with a #ClutterMatrix will set the #ClutterActor:child-transform-set property to %TRUE as a side effect; setting this property with %NULL will set the #ClutterActor:child-transform-set property to %FALSE.

The #ClutterActor:child-transform property is animatable.

The visible region of the actor, in actor-relative coordinates

clipRect?: Clutter.Rect

The visible region of the actor, in actor-relative coordinates, expressed as a #ClutterRect.

Setting this property to %NULL will unset the existing clip.

Setting this property will change the #ClutterActor:has-clip property as a side effect.

clipToAllocation?: boolean

Whether the clip region should track the allocated area of the actor.

This property is ignored if a clip area has been explicitly set using clutter_actor_set_clip().

color?: Clutter.Color

The color to be used to paint the background of the #ClutterBox. Setting this property will set the #ClutterBox:color-set property as a side effect

This property sets the #ClutterActor:background-color property internally.

colorSet?: boolean

Whether the #ClutterBox:color property has been set.

This property reads the #ClutterActor:background-color-set property internally.

constraints?: Clutter.Constraint

Adds a #ClutterConstraint to the actor

content?: Clutter.Content

The #ClutterContent implementation that controls the content of the actor.

contentGravity?: ContentGravity

The alignment that should be honoured by the #ClutterContent set with the #ClutterActor:content property.

Changing the value of this property will change the bounding box of the content; you can use the #ClutterActor:content-box property to get the position and size of the content within the actor's allocation.

This property is meaningful only for #ClutterContent implementations that have a preferred size, and if the preferred size is smaller than the actor's allocation.

The #ClutterActor:content-gravity property is animatable.

contentRepeat?: ContentRepeat

The repeat policy for the actor's #ClutterActor:content.

depth?: number

The position of the actor on the Z axis.

The #ClutterActor:depth property is relative to the parent's modelview matrix.

Setting this property will call #ClutterContainerIface.sort_depth_order() which is usually a no-op, and it's most likely not what you want.

The #ClutterActor:depth property is animatable.

effect?: Clutter.Effect

Adds #ClutterEffect to the list of effects be applied on a #ClutterActor

fixedPositionSet?: boolean

This flag controls whether the #ClutterActor:fixed-x and #ClutterActor:fixed-y properties are used

fixedX?: number

The fixed X position of the actor in pixels.

Writing this property sets #ClutterActor:fixed-position-set property as well, as a side effect

fixedY?: number

The fixed Y position of the actor in pixels.

Writing this property sets the #ClutterActor:fixed-position-set property as well, as a side effect

height?: number

Height of the actor (in pixels). If written, forces the minimum and natural size request of the actor to the given height. If read, returns the allocated height if available, otherwise the height request.

The #ClutterActor:height property is animatable.

layoutManager?: Clutter.LayoutManager

A delegate object for controlling the layout of the children of an actor.

magnificationFilter?: Clutter.ScalingFilter
marginBottom?: number

The margin (in pixels) from the bottom of the actor.

This property adds a margin to the actor's preferred size; the margin will be automatically taken into account when allocating the actor.

The #ClutterActor:margin-bottom property is animatable.

marginLeft?: number

The margin (in pixels) from the left of the actor.

This property adds a margin to the actor's preferred size; the margin will be automatically taken into account when allocating the actor.

The #ClutterActor:margin-left property is animatable.

marginRight?: number

The margin (in pixels) from the right of the actor.

This property adds a margin to the actor's preferred size; the margin will be automatically taken into account when allocating the actor.

The #ClutterActor:margin-right property is animatable.

marginTop?: number

The margin (in pixels) from the top of the actor.

This property adds a margin to the actor's preferred size; the margin will be automatically taken into account when allocating the actor.

The #ClutterActor:margin-top property is animatable.

minHeight?: number

A forced minimum height request for the actor, in pixels

Writing this property sets the #ClutterActor:min-height-set property as well, as a side effect. This property overrides the usual height request of the actor.

minHeightSet?: boolean

This flag controls whether the #ClutterActor:min-height property is used

minWidth?: number

A forced minimum width request for the actor, in pixels

Writing this property sets the #ClutterActor:min-width-set property as well, as a side effect.

This property overrides the usual width request of the actor.

minWidthSet?: boolean

This flag controls whether the #ClutterActor:min-width property is used

minificationFilter?: Clutter.ScalingFilter
name?: string

The name of the actor

naturalHeight?: number

A forced natural height request for the actor, in pixels

Writing this property sets the #ClutterActor:natural-height-set property as well, as a side effect. This property overrides the usual height request of the actor

naturalHeightSet?: boolean

This flag controls whether the #ClutterActor:natural-height property is used

naturalWidth?: number

A forced natural width request for the actor, in pixels

Writing this property sets the #ClutterActor:natural-width-set property as well, as a side effect. This property overrides the usual width request of the actor

naturalWidthSet?: boolean

This flag controls whether the #ClutterActor:natural-width property is used

offscreenRedirect?: OffscreenRedirect

Determines the conditions in which the actor will be redirected to an offscreen framebuffer while being painted. For example this can be used to cache an actor in a framebuffer or for improved handling of transparent actors. See clutter_actor_set_offscreen_redirect() for details.

opacity?: number

Opacity of an actor, between 0 (fully transparent) and 255 (fully opaque)

The #ClutterActor:opacity property is animatable.

pivotPoint?: Clutter.Point

The point around which the scaling and rotation transformations occur.

The pivot point is expressed in normalized coordinates space, with (0, 0) being the top left corner of the actor and (1, 1) the bottom right corner of the actor.

The default pivot point is located at (0, 0).

The #ClutterActor:pivot-point property is animatable.

pivotPointZ?: number

The Z component of the #ClutterActor:pivot-point, expressed as a value along the Z axis.

The #ClutterActor:pivot-point-z property is animatable.

position?: Clutter.Point

The position of the origin of the actor.

This property is a shorthand for setting and getting the #ClutterActor:x and #ClutterActor:y properties at the same time.

The #ClutterActor:position property is animatable.

reactive?: boolean

Whether the actor is reactive to events or not

Only reactive actors will emit event-related signals

requestMode?: RequestMode

Request mode for the #ClutterActor. The request mode determines the type of geometry management used by the actor, either height for width (the default) or width for height.

For actors implementing height for width, the parent container should get the preferred width first, and then the preferred height for that width.

For actors implementing width for height, the parent container should get the preferred height first, and then the preferred width for that height.

For instance:

  ClutterRequestMode mode;
gfloat natural_width, min_width;
gfloat natural_height, min_height;

mode = clutter_actor_get_request_mode (child);
if (mode == CLUTTER_REQUEST_HEIGHT_FOR_WIDTH)
{
clutter_actor_get_preferred_width (child, -1,
&min_width,
&natural_width);
clutter_actor_get_preferred_height (child, natural_width,
&min_height,
&natural_height);
}
else if (mode == CLUTTER_REQUEST_WIDTH_FOR_HEIGHT)
{
clutter_actor_get_preferred_height (child, -1,
&min_height,
&natural_height);
clutter_actor_get_preferred_width (child, natural_height,
&min_width,
&natural_width);
}
else if (mode == CLUTTER_REQUEST_CONTENT_SIZE)
{
ClutterContent *content = clutter_actor_get_content (child);

min_width, min_height = 0;
natural_width = natural_height = 0;

if (content != NULL)
clutter_content_get_preferred_size (content, &natural_width, &natural_height);
}

will retrieve the minimum and natural width and height depending on the preferred request mode of the #ClutterActor "child".

The clutter_actor_get_preferred_size() function will implement this check for you.

rotationAngleX?: number

The rotation angle on the X axis.

The #ClutterActor:rotation-angle-x property is animatable.

rotationAngleY?: number

The rotation angle on the Y axis

The #ClutterActor:rotation-angle-y property is animatable.

rotationAngleZ?: number

The rotation angle on the Z axis

The #ClutterActor:rotation-angle-z property is animatable.

rotationCenterX?: Vertex

The rotation center on the X axis.

rotationCenterY?: Vertex

The rotation center on the Y axis.

rotationCenterZ?: Vertex

The rotation center on the Z axis.

rotationCenterZGravity?: Clutter.Gravity

The rotation center on the Z axis expressed as a #ClutterGravity.

scaleCenterX?: number

The horizontal center point for scaling

scaleCenterY?: number

The vertical center point for scaling

scaleGravity?: Clutter.Gravity

The center point for scaling expressed as a #ClutterGravity

scaleX?: number

The horizontal scale of the actor.

The #ClutterActor:scale-x property is animatable.

scaleY?: number

The vertical scale of the actor.

The #ClutterActor:scale-y property is animatable.

scaleZ?: number

The scale factor of the actor along the Z axis.

The #ClutterActor:scale-y property is animatable.

showOnSetParent?: boolean

If %TRUE, the actor is automatically shown when parented.

Calling clutter_actor_hide() on an actor which has not been parented will set this property to %FALSE as a side effect.

size?: Clutter.Size

The size of the actor.

This property is a shorthand for setting and getting the #ClutterActor:width and #ClutterActor:height at the same time.

The #ClutterActor:size property is animatable.

textDirection?: Clutter.TextDirection

The direction of the text inside a #ClutterActor.

transform?: Clutter.Matrix

Overrides the transformations of a #ClutterActor with a custom matrix.

The matrix specified by the #ClutterActor:transform property is applied to the actor and its children relative to the actor's #ClutterActor:allocation and #ClutterActor:pivot-point.

Application code should rarely need to use this function directly.

Setting this property with a #ClutterMatrix will set the #ClutterActor:transform-set property to %TRUE as a side effect; setting this property with %NULL will set the #ClutterActor:transform-set property to %FALSE.

The #ClutterActor:transform property is animatable.

translationX?: number

An additional translation applied along the X axis, relative to the actor's #ClutterActor:pivot-point.

The #ClutterActor:translation-x property is animatable.

translationY?: number

An additional translation applied along the Y axis, relative to the actor's #ClutterActor:pivot-point.

The #ClutterActor:translation-y property is animatable.

translationZ?: number

An additional translation applied along the Z axis, relative to the actor's #ClutterActor:pivot-point.

The #ClutterActor:translation-z property is animatable.

visible?: boolean

Whether the actor is set to be visible or not

See also #ClutterActor:mapped

width?: number

Width of the actor (in pixels). If written, forces the minimum and natural size request of the actor to the given width. If read, returns the allocated width if available, otherwise the width request.

The #ClutterActor:width property is animatable.

x?: number

X coordinate of the actor in pixels. If written, forces a fixed position for the actor. If read, returns the fixed position if any, otherwise the allocation if available, otherwise 0.

The #ClutterActor:x property is animatable.

xAlign?: ActorAlign

The alignment of an actor on the X axis, if the actor has been given extra space for its allocation. See also the #ClutterActor:x-expand property.

xExpand?: boolean

Whether a layout manager should assign more space to the actor on the X axis.

y?: number

Y coordinate of the actor in pixels. If written, forces a fixed position for the actor. If read, returns the fixed position if any, otherwise the allocation if available, otherwise 0.

The #ClutterActor:y property is animatable.

yAlign?: ActorAlign

The alignment of an actor on the Y axis, if the actor has been given extra space for its allocation.

yExpand?: boolean

Whether a layout manager should assign more space to the actor on the Y axis.

zPosition?: number

The actor's position on the Z axis, relative to the parent's transformations.

Positive values will bring the actor's position nearer to the user, whereas negative values will bring the actor's position farther from the user.

The #ClutterActor:z-position does not affect the paint or allocation order.

The #ClutterActor:z-position property is animatable.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method