cluttermm: Clutter::PathConstraint Class Reference
PathConstraint is a simple constraint that modifies the allocation of the Actor to which it has been applied using a ClutterPath. More...
Inheritance diagram for Clutter::PathConstraint:
Collaboration diagram for Clutter::PathConstraint:
Public Member Functions | |
| virtual | ~PathConstraint () |
| ClutterPathConstraint* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const ClutterPathConstraint* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| ClutterPathConstraint* | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
| void | set_path (const Glib::RefPtr< Path >& path) |
| Sets the path to be followed by the Clutter::PathConstraint. More... | |
| Glib::RefPtr< Path > | get_path () |
| Retrieves a pointer to the Clutter::Path used by constraint. More... | |
| Glib::RefPtr< const Path > | get_path () const |
| Retrieves a pointer to the Clutter::Path used by constraint. More... | |
| void | set_offset (float offset) |
| Sets the offset along the Clutter::Path used by constraint. More... | |
| float | get_offset () const |
| Retrieves the offset along the Clutter::Path used by constraint. More... | |
| Glib::PropertyProxy< float > | property_offset () |
| The offset along the path, between -1.0 and 2.0. More... | |
| Glib::PropertyProxy_ReadOnly < float > | property_offset () const |
| The offset along the path, between -1.0 and 2.0. More... | |
| Glib::PropertyProxy < Glib::RefPtr< Path > > | property_path () |
| The path used to constrain an actor. More... | |
| Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Path > > | property_path () const |
| The path used to constrain an actor. More... | |
| Glib::SignalProxy2< void, const Glib::RefPtr< Actor > , guint > | signal_node_reached () |
 Public Member Functions inherited from Clutter::Constraint | |
| virtual | ~Constraint () |
| ClutterConstraint* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const ClutterConstraint* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| ClutterConstraint* | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
| Public Member Functions inherited from Clutter::ActorMeta | |
| virtual | ~ActorMeta () |
| ClutterActorMeta* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const ClutterActorMeta* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| ClutterActorMeta* | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
| void | set_name (const Glib::ustring& name) |
| Sets the name of meta. More... | |
| Glib::ustring | get_name () const |
| Retrieves the name set using set_name() More... | |
| void | set_enabled (bool is_enabled=true) |
| Sets whether meta should be enabled or not. More... | |
| bool | get_enabled () const |
| Retrieves whether meta is enabled. More... | |
| Glib::RefPtr< Actor > | get_actor () |
| Retrieves a pointer to the Clutter::Actor that owns meta. More... | |
| Glib::RefPtr< const Actor > | get_actor () const |
| Retrieves a pointer to the Clutter::Actor that owns meta. More... | |
Static Public Member Functions | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
| static Glib::RefPtr < PathConstraint > | create (const Glib::RefPtr< Path >& path, float offset) |
| Static Public Member Functions inherited from Clutter::Constraint | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
| Static Public Member Functions inherited from Clutter::ActorMeta | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
| PathConstraint (const Glib::RefPtr< Path >& path, float offset) | |
| Protected Member Functions inherited from Clutter::Constraint | |
| Constraint () | |
| Protected Member Functions inherited from Clutter::ActorMeta | |
| ActorMeta () | |
| virtual void | set_actor_vfunc (const Glib::RefPtr< const Actor >& actor) |
| Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > > | property_actor () const |
| The actor attached to the meta. More... | |
| Glib::PropertyProxy< bool > | property_enabled () |
| Whether the meta is enabled. More... | |
| Glib::PropertyProxy_ReadOnly < bool > | property_enabled () const |
| Whether the meta is enabled. More... | |
| Glib::PropertyProxy < Glib::ustring > | property_name () |
| The name of the meta. More... | |
| Glib::PropertyProxy_ReadOnly < Glib::ustring > | property_name () const |
| The name of the meta. More... | |
Related Functions | |
(Note that these are not member functions.) | |
| Glib::RefPtr < Clutter::PathConstraint > | wrap (ClutterPathConstraint* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
| Related Functions inherited from Clutter::Constraint | |
| Glib::RefPtr< Clutter::Constraint > | wrap (ClutterConstraint* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
| Related Functions inherited from Clutter::ActorMeta | |
| Glib::RefPtr< Clutter::ActorMeta > | wrap (ClutterActorMeta* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Detailed Description
PathConstraint is a simple constraint that modifies the allocation of the Actor to which it has been applied using a ClutterPath.
By setting the “offset” property it is possible to control how far along the path the Actor should be.
Constructor & Destructor Documentation
|
virtual |
|
explicitprotected |
Member Function Documentation
|
static |
| float Clutter::PathConstraint::get_offset | ( | ) | const |
Retrieves the offset along the Clutter::Path used by constraint.
- Returns
- The offset.
| Glib::RefPtr<Path> Clutter::PathConstraint::get_path | ( | ) |
Retrieves a pointer to the Clutter::Path used by constraint.
- Returns
- The Clutter::Path used by the Clutter::PathConstraint, or
0. The returned Clutter::Path is owned by the constraint and it should not be unreferenced.
| Glib::RefPtr<const Path> Clutter::PathConstraint::get_path | ( | ) | const |
Retrieves a pointer to the Clutter::Path used by constraint.
- Returns
- The Clutter::Path used by the Clutter::PathConstraint, or
0. The returned Clutter::Path is owned by the constraint and it should not be unreferenced.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
| ClutterPathConstraint* Clutter::PathConstraint::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
| Glib::PropertyProxy< float > Clutter::PathConstraint::property_offset | ( | ) |
The offset along the path, between -1.0 and 2.0.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
| Glib::PropertyProxy_ReadOnly< float > Clutter::PathConstraint::property_offset | ( | ) | const |
The offset along the path, between -1.0 and 2.0.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
| Glib::PropertyProxy< Glib::RefPtr<Path> > Clutter::PathConstraint::property_path | ( | ) |
The path used to constrain an actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Path> > Clutter::PathConstraint::property_path | ( | ) | const |
The path used to constrain an actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
| void Clutter::PathConstraint::set_offset | ( | float | offset) |
Sets the offset along the Clutter::Path used by constraint.
- Parameters
-
offset The offset along the path.
| void Clutter::PathConstraint::set_path | ( | const Glib::RefPtr< Path >& | path) |
Sets the path to be followed by the Clutter::PathConstraint.
The constraint will take ownership of the Clutter::Path passed to this function.
- Parameters
-
path A Clutter::Path.
| Glib::SignalProxy2< void,const Glib::RefPtr<Actor>,guint > Clutter::PathConstraint::signal_node_reached | ( | ) |
- Slot Prototype:
void on_my_node_reached(const Glib::RefPtr<Actor> actor, guint index)
The signal_node_reached() signal is emitted each time a Clutter::PathConstraint::property_offset() value results in the actor passing a Clutter::PathNode
- Parameters
-
actor The Clutter::Actor using the constraint. index The index of the node that has been reached.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns
- A C++ instance that wraps this C instance.
The documentation for this class was generated from the following file:
- cluttermm/path-constraint.h