#include <stage.h>
Public Member Functions | |
virtual | ~Stage () |
ClutterStage * | gobj () |
Provides access to the underlying C GObject. | |
const ClutterStage * | gobj () const |
Provides access to the underlying C GObject. | |
ClutterStage * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | set_color (const Color &color) |
Set the stage color. | |
Color | get_color () const |
Retrieves the stage color. | |
void | set_perspectivex (ClutterPerspective *perspective) |
Set the stage perspective. | |
void | get_perspectivex (ClutterPerspective *perspective) const |
Retrieves the stage perspective. | |
void | set_perspective (float fovy, float aspect, float z_near, float z_far) |
Set the stage perspective. | |
void | get_perspective (float &fovy, float &aspect, float &z_near, float &z_far) |
Retrieves the stage perspective. | |
void | fullscreen () |
Asks to place the stage window in the fullscreen state. | |
void | unfullscreen () |
Asks to toggle off the fullscreen state for the stage window. | |
void | show_cursor () |
Shows the cursor on the stage window. | |
void | hide_cursor () |
Makes the cursor invisible on the stage window. | |
Glib::ustring | get_title () const |
Gets the stage title. | |
void | set_title (const Glib::ustring &title) |
Sets the stage title. | |
void | set_user_resizable (bool value) |
Sets if the stage is able to be resized by user interaction (i.e via window manager controls). | |
bool | get_user_resizable () const |
Retrieves the value set with set_user_resizable(). | |
Glib::RefPtr< Actor > | get_actor_at_pos (int x, int y) |
Checks the scene at the coordinates x and y and returns a pointer to the Clutter::Actor at those coordinates. | |
Glib::RefPtr< const Actor > | get_actor_at_pos (int x, int y) const |
Checks the scene at the coordinates x and y and returns a pointer to the Clutter::Actor at those coordinates. | |
Glib::RefPtr< Actor > | get_key_focus () |
Retrieves the actor that is currently under key focus. | |
Glib::RefPtr< const Actor > | get_key_focus () const |
Retrieves the actor that is currently under key focus. | |
void | set_key_focus (const Glib::RefPtr< Actor > &actor) |
Sets the key focus on actor. | |
Glib::RefPtr< Gdk::Pixbuf > | snapshot (int x, int y, int width, int height) const |
Gets a pixel based representation of the current rendered stage. | |
bool | get_use_fog () const |
Gets whether the depth cueing effect is enabled on stage. | |
void | set_use_fog (bool fog=true) |
Sets whether the depth cueing effect on the stage should be enabled or not. | |
void | set_fog (double density, double z_near, double z_far) |
Sets the GL fog settings used to create the depth cueing effect on the stage. | |
void | get_fog (double &density, double &z_near, double &z_far) const |
Retrieves the settings used by the GL fog to create the depth cueing effect on the stage. | |
void | set_fogx (const Fog &fog) |
Sets the depth cueing settings for the stage. | |
void | get_fogx (Fog &fog) const |
Retrieves the current depth cueing settings from the stage. | |
double | get_resolution () const |
Retrieves the resolution (in DPI) of the stage from the default backend. | |
Fixed | get_resolutionx () const |
Fixed point version of get_resolution(). | |
void | stage_event (Event *event) |
This function is used to emit an event on the main stage. | |
Glib::SignalProxy0< void > | signal_fullscreen () |
Glib::SignalProxy0< void > | signal_unfullscreen () |
Glib::SignalProxy0< void > | signal_activate () |
Glib::SignalProxy0< void > | signal_deactivate () |
Static Public Member Functions | |
static Glib::RefPtr< Stage > | get_default () |
Return value: the main Clutter::Stage. | |
Protected Member Functions | |
Stage () | |
virtual void | set_fullscreen_vfunc (bool fullscreen) |
virtual void | set_cursor_visible_vfunc (bool visible) |
virtual Glib::RefPtr< Gdk::Pixbuf > | draw_to_pixbuf_vfunc (int x, int y, int width, int height) |
virtual void | set_title_vfunc (const Glib::ustring &title) |
virtual void | set_user_resize_vfunc (bool value) |
virtual void | on_fullscreen () |
virtual void | on_unfullscreen () |
virtual void | on_activate () |
virtual void | on_deactivate () |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Clutter::Stage > | wrap (ClutterStage *object, bool take_copy=false) |
A Glib::wrap() method for this object. |
virtual Clutter::Stage::~Stage | ( | ) | [virtual] |
Clutter::Stage::Stage | ( | ) | [protected] |
virtual Glib::RefPtr<Gdk::Pixbuf> Clutter::Stage::draw_to_pixbuf_vfunc | ( | int | x, | |
int | y, | |||
int | width, | |||
int | height | |||
) | [protected, virtual] |
void Clutter::Stage::fullscreen | ( | ) |
Asks to place the stage window in the fullscreen state.
Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows.
Glib::RefPtr<const Actor> Clutter::Stage::get_actor_at_pos | ( | int | x, | |
int | y | |||
) | const |
Checks the scene at the coordinates x and y and returns a pointer to the Clutter::Actor at those coordinates.
x | X coordinate to check. | |
y | Y coordinate to check. |
Glib::RefPtr<Actor> Clutter::Stage::get_actor_at_pos | ( | int | x, | |
int | y | |||
) |
Checks the scene at the coordinates x and y and returns a pointer to the Clutter::Actor at those coordinates.
x | X coordinate to check. | |
y | Y coordinate to check. |
Color Clutter::Stage::get_color | ( | ) | const |
static Glib::RefPtr<Stage> Clutter::Stage::get_default | ( | ) | [static] |
Return value: the main Clutter::Stage.
You should never
void Clutter::Stage::get_fog | ( | double & | density, | |
double & | z_near, | |||
double & | z_far | |||
) | const |
Retrieves the settings used by the GL fog to create the depth cueing effect on the stage.
Since: 0.6
density | Return location for the intensity dampening. | |
z_near | Return location for the starting point of the depth cueing. | |
z_far | Return location for the ending point of the depth cueing. |
void Clutter::Stage::get_fogx | ( | Fog & | fog | ) | const |
Retrieves the current depth cueing settings from the stage.
This is the fixed point version of get_fog().
Since: 0.6
fog | Return location for a Clutter::Fog structure. |
Glib::RefPtr<const Actor> Clutter::Stage::get_key_focus | ( | ) | const |
Retrieves the actor that is currently under key focus.
Glib::RefPtr<Actor> Clutter::Stage::get_key_focus | ( | ) |
Retrieves the actor that is currently under key focus.
void Clutter::Stage::get_perspective | ( | float & | fovy, | |
float & | aspect, | |||
float & | z_near, | |||
float & | z_far | |||
) |
Retrieves the stage perspective.
Since: 0.4
fovy | Return location for the field of view, in degrees, or 0 . | |
aspect | Return location for the aspect ratio, or 0 . | |
z_near | Return location for the distance of the viewer from the near clipping plane, or 0 . | |
z_far | Return location for the distance of the viewer from the far clipping plane, or 0 . |
void Clutter::Stage::get_perspectivex | ( | ClutterPerspective * | perspective | ) | const |
Retrieves the stage perspective.
perspective | Return location for a Clutter::Perspective. |
double Clutter::Stage::get_resolution | ( | ) | const |
Retrieves the resolution (in DPI) of the stage from the default backend.
Fixed Clutter::Stage::get_resolutionx | ( | ) | const |
Glib::ustring Clutter::Stage::get_title | ( | ) | const |
Gets the stage title.
bool Clutter::Stage::get_use_fog | ( | ) | const |
Gets whether the depth cueing effect is enabled on stage.
true
if the the depth cueing effect is enabledbool Clutter::Stage::get_user_resizable | ( | ) | const |
Retrieves the value set with set_user_resizable().
true
is the stage is resizable by the user.const ClutterStage* Clutter::Stage::gobj | ( | ) | const [inline] |
ClutterStage* Clutter::Stage::gobj | ( | ) | [inline] |
ClutterStage* Clutter::Stage::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Reimplemented from Clutter::Group.
void Clutter::Stage::hide_cursor | ( | ) |
Makes the cursor invisible on the stage window.
Since: 0.4
virtual void Clutter::Stage::on_activate | ( | ) | [protected, virtual] |
virtual void Clutter::Stage::on_deactivate | ( | ) | [protected, virtual] |
virtual void Clutter::Stage::on_fullscreen | ( | ) | [protected, virtual] |
virtual void Clutter::Stage::on_unfullscreen | ( | ) | [protected, virtual] |
void Clutter::Stage::set_color | ( | const Color & | color | ) |
virtual void Clutter::Stage::set_cursor_visible_vfunc | ( | bool | visible | ) | [protected, virtual] |
void Clutter::Stage::set_fog | ( | double | density, | |
double | z_near, | |||
double | z_far | |||
) |
Sets the GL fog settings used to create the depth cueing effect on the stage.
If the actors are all near the view point you will need a higher density and a smaller interval between z_near and z_far. On the other hand, if actors are placed far away from the view point you will need a lower density but a bigger interval between z_near and z_far.
Since: 0.6
density | Density of the intensity dampening. | |
z_near | Starting point of the depth cueing. | |
z_far | Ending point of the depth cueing. |
void Clutter::Stage::set_fogx | ( | const Fog & | fog | ) |
Sets the depth cueing settings for the stage.
This is the fixed point version of set_fog().
Since: 0.6
fog | A Clutter::Fog structure. |
virtual void Clutter::Stage::set_fullscreen_vfunc | ( | bool | fullscreen | ) | [protected, virtual] |
void Clutter::Stage::set_key_focus | ( | const Glib::RefPtr< Actor > & | actor | ) |
Sets the key focus on actor.
An actor with key focus will receive all the key events. If actor is 0
, the stage will receive focus.
Since: 0.6
actor | The actor to set key focus to, or 0 . |
void Clutter::Stage::set_perspective | ( | float | fovy, | |
float | aspect, | |||
float | z_near, | |||
float | z_far | |||
) |
Set the stage perspective.
Since: 0.4
fovy | The field of view angle, in degrees, in the y direction. | |
aspect | The aspect ratio that determines the field of view in the x direction. The aspect ratio is the ratio of x (width) to y (height). | |
z_near | The distance from the viewer to the near clipping plane (always positive). | |
z_far | The distance from the viewer to the far clipping plane (always positive). |
void Clutter::Stage::set_perspectivex | ( | ClutterPerspective * | perspective | ) |
Set the stage perspective.
perspective | A Clutter::Perspective. |
void Clutter::Stage::set_title | ( | const Glib::ustring & | title | ) |
Sets the stage title.
Since 0.4
title | A utf8 string for the stage windows title. |
virtual void Clutter::Stage::set_title_vfunc | ( | const Glib::ustring & | title | ) | [protected, virtual] |
void Clutter::Stage::set_use_fog | ( | bool | fog = true |
) |
Sets whether the depth cueing effect on the stage should be enabled or not.
Depth cueing is a 3D effect that makes actors farther away from the viewing point less opaque, by fading them with the stage color.
The parameters of the GL fog used can be changed using the set_fog() function.
Since: 0.6
fog | true for enabling the depth cueing effect. |
void Clutter::Stage::set_user_resizable | ( | bool | value | ) |
Sets if the stage is able to be resized by user interaction (i.e via window manager controls).
Since: 0.4
resizable | Whether if the stage should be user resizable. |
virtual void Clutter::Stage::set_user_resize_vfunc | ( | bool | value | ) | [protected, virtual] |
void Clutter::Stage::show_cursor | ( | ) |
Shows the cursor on the stage window.
Glib::SignalProxy0< void > Clutter::Stage::signal_activate | ( | ) |
void on_my_activate()
Glib::SignalProxy0< void > Clutter::Stage::signal_deactivate | ( | ) |
void on_my_deactivate()
Glib::SignalProxy0< void > Clutter::Stage::signal_fullscreen | ( | ) |
void on_my_fullscreen()
Glib::SignalProxy0< void > Clutter::Stage::signal_unfullscreen | ( | ) |
void on_my_unfullscreen()
Glib::RefPtr<Gdk::Pixbuf> Clutter::Stage::snapshot | ( | int | x, | |
int | y, | |||
int | width, | |||
int | height | |||
) | const |
Gets a pixel based representation of the current rendered stage.
x | X coordinate of the first pixel that is read from stage. | |
y | Y coordinate of the first pixel that is read from stage. | |
width | Width dimention of pixels to be read, or -1 for the entire stage width. | |
height | Height dimention of pixels to be read, or -1 for the entire stage height. |
void Clutter::Stage::stage_event | ( | Event * | event | ) |
This function is used to emit an event on the main stage.
You should rarely need to use this function, except for synthetising events.
event | A Clutter::Event. |
void Clutter::Stage::unfullscreen | ( | ) |
Asks to toggle off the fullscreen state for the stage window.
Note that you shouldn't assume the window is definitely not full screen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows.
Glib::RefPtr< Clutter::Stage > wrap | ( | ClutterStage * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
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. |