Class: Clutter::BehaviourDepth

Inherits:
Behaviour show all
Defined in:
(unknown)

Overview

The Clutter::BehaviourDepthClass structure contains only private data

Instance Method Summary collapse

Methods inherited from Behaviour

#actors, #actors_foreach, #alpha, #alpha=, #apply, #get_nth_actor, #is_applied, #n_actors, #remove, #remove_all

Constructor Details

#initialize(alpha, depth_start, depth_end) ⇒ Clutter::Behaviour

Creates a new Clutter::BehaviourDepth which can be used to control the ClutterActor:depth property of a set of Clutter::Actors.

If alpha is not nil, the Clutter::Behaviour will take ownership of the Clutter::Alpha instance. In the case when alpha is nil, it can be set later with clutter_behaviour_set_alpha().

Parameters:

  • alpha (Clutter::Alpha) —

    a Clutter::Alpha instance, or nil

  • depth_start (Integer) —

    initial value of the depth

  • depth_end (Integer) —

    final value of the depth

Instance Method Details

#depth_end ⇒ Integer

End depth level to apply to the actors.

Returns:

  • (Integer) —

    depth-end

#depth_end=(depth_end) ⇒ Integer

End depth level to apply to the actors.

Parameters:

  • depth_end (Integer)

Returns:

  • (Integer) —

    depth-end

  • (Integer) —

    depth-end

#depth_start ⇒ Integer

Start depth level to apply to the actors.

Returns:

  • (Integer) —

    depth-start

#depth_start=(depth_start) ⇒ Integer

Start depth level to apply to the actors.

Parameters:

  • depth_start (Integer)

Returns:

  • (Integer) —

    depth-start

  • (Integer) —

    depth-start

#get_bounds(depth_start, depth_end) ⇒ nil

Gets the boundaries of the behaviour

Parameters:

  • depth_start (Integer) —

    return location for the initial depth value, or nil

  • depth_end (Integer) —

    return location for the final depth value, or nil

Returns:

  • (nil)

#set_bounds(depth_start, depth_end) ⇒ nil

Sets the boundaries of the behaviour.

Parameters:

  • depth_start (Integer) —

    initial value of the depth

  • depth_end (Integer) —

    final value of the depth

Returns:

  • (nil)