Class: Clutter::SnapConstraint

Inherits:

Constraint

• Object
• GObject::InitiallyUnowned
• ActorMeta
• Constraint
• Clutter::SnapConstraint

Defined in:

(unknown)

Instance Method Summary

• #from_edge ⇒ Clutter::SnapEdge

  The edge of the Clutter::Actor that should be snapped.

• #from_edge=(from_edge) ⇒ Clutter::SnapEdge

  The edge of the Clutter::Actor that should be snapped.

• #get_edges(from_edge, to_edge) ⇒ nil

  Retrieves the edges used by the constraint.

• #initialize(source, from_edge, to_edge, offset) ⇒ Clutter::Constraint constructor

  Creates a new Clutter::SnapConstraint that will snap a #ClutterActor to the edge of source, with the given offset.

• #offset ⇒ Clutter::gfloat

  The offset, in pixels, between Clutter::SnapConstraint:from-edge and Clutter::SnapConstraint:to-edge.

• #offset=(offset) ⇒ Clutter::gfloat

  The offset, in pixels, between Clutter::SnapConstraint:from-edge and Clutter::SnapConstraint:to-edge.

• #set_edges(from_edge, to_edge) ⇒ nil

  Sets the edges to be used by the constraint.

• #source ⇒ Clutter::Actor

  The Clutter::Actor used as the source for the constraint.

• #source=(source) ⇒ Clutter::Actor

  The Clutter::Actor used as the source for the constraint.

• #to_edge ⇒ Clutter::SnapEdge

  The edge of the Clutter::SnapConstraint:source that should be snapped.

• #to_edge=(to_edge) ⇒ Clutter::SnapEdge

  The edge of the Clutter::SnapConstraint:source that should be snapped.

Methods inherited from ActorMeta

#actor, #actor=, #enabled, #enabled=, #enabled?, #name, #name=

Constructor Details

#initialize(source, from_edge, to_edge, offset) ⇒ Clutter::Constraint

Creates a new Clutter::SnapConstraint that will snap a #ClutterActor to the edge of source, with the given offset.

Parameters:

• source (Clutter::Actor) —

  the Clutter::Actor to use as the source of the constraint, or nil

• from_edge (Clutter::SnapEdge) —

  the edge of the actor to use in the constraint

• to_edge (Clutter::SnapEdge) —

  the edge of source to use in the constraint

• offset (Clutter::gfloat) —

  the offset to apply to the constraint, in pixels

Instance Method Details

#from_edge ⇒ Clutter::SnapEdge

The edge of the Clutter::Actor that should be snapped

Returns:

• (Clutter::SnapEdge) —

  from-edge

#from_edge=(from_edge) ⇒ Clutter::SnapEdge

The edge of the Clutter::Actor that should be snapped

Parameters:

• from_edge (Clutter::SnapEdge)

Returns:

• (Clutter::SnapEdge) —

  from-edge

• (Clutter::SnapEdge) —

  from-edge

#get_edges(from_edge, to_edge) ⇒ nil

Retrieves the edges used by the constraint

Parameters:

• from_edge (Clutter::SnapEdge) —

  return location for the actor's edge, or nil

• to_edge (Clutter::SnapEdge) —

  return location for the source's edge, or nil

Returns:

• (nil)

#offset ⇒ Clutter::gfloat

The offset, in pixels, between Clutter::SnapConstraint:from-edge and Clutter::SnapConstraint:to-edge

Returns:

• (Clutter::gfloat) —

  offset

#offset=(offset) ⇒ Clutter::gfloat

The offset, in pixels, between Clutter::SnapConstraint:from-edge and Clutter::SnapConstraint:to-edge

Parameters:

• offset (Clutter::gfloat)

Returns:

• (Clutter::gfloat) —

  offset

• (Clutter::gfloat) —

  offset

#set_edges(from_edge, to_edge) ⇒ nil

Sets the edges to be used by the constraint

The from_edge is the edge on the Clutter::Actor to which constraint has been added. The to_edge is the edge of the Clutter::Actor inside the Clutter::SnapConstraint:source property.

Parameters:

• from_edge (Clutter::SnapEdge) —

  the edge on the actor

• to_edge (Clutter::SnapEdge) —

  the edge on the source

Returns:

• (nil)

#source ⇒ Clutter::Actor

The Clutter::Actor used as the source for the constraint

Returns:

• (Clutter::Actor) —

  source

#source=(source) ⇒ Clutter::Actor

The Clutter::Actor used as the source for the constraint

Parameters:

• source (Clutter::Actor)

Returns:

• (Clutter::Actor) —

  source

• (Clutter::Actor) —

  source

#to_edge ⇒ Clutter::SnapEdge

The edge of the Clutter::SnapConstraint:source that should be snapped

Returns:

• (Clutter::SnapEdge) —

  to-edge

#to_edge=(to_edge) ⇒ Clutter::SnapEdge

The edge of the Clutter::SnapConstraint:source that should be snapped

Parameters:

• to_edge (Clutter::SnapEdge)

Returns:

• (Clutter::SnapEdge) —

  to-edge

• (Clutter::SnapEdge) —

  to-edge