cluttermm: Clutter::ActorBox Class Reference

Public Member Functions
	ActorBox (const ClutterActorBox* gobject)

ClutterActorBox*	gobj ()
	Provides access to the underlying C instance. More...

const ClutterActorBox*	gobj () const
	Provides access to the underlying C instance. More...

	ActorBox (float x1=0, float y1=0, float x2=0, float y2=0)

float	get_x () const
	Retrieves the X coordinate of the origin of box. More...

float	get_y () const
	Retrieves the Y coordinate of the origin of box. More...

float	get_width () const
	Retrieves the width of the box. More...

float	get_height () const
	Retrieves the height of the box. More...

void	set_origin (float x, float y)
	Changes the origin of box, maintaining the size of the Clutter::ActorBox. More...

void	get_origin (float& x, float& y) const
	Retrieves the origin of box. More...

void	set_size (float width, float height)
	Sets the size of box, maintaining the origin of the Clutter::ActorBox. More...

void	get_size (float& width, float& height) const
	Retrieves the size of box. More...

float	get_area () const
	Retrieves the area of box. More...

bool	contains (float x, float y) const
	Checks whether a point with x, y coordinates is contained withing box. More...

void	clamp_to_pixel ()
	Clamps the components of box to the nearest integer. More...

void	interpolate (const ActorBox& final_, double progress, ActorBox& result)
	Interpolates between initial and final Clutter::ActorBoxes using progress. More...

void	unite (const ActorBox& b, ActorBox& result)
	Unions the two boxes a and b and stores the result in result. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Attributes
ClutterActorBox	gobject_

Related Functions
(Note that these are not member functions.)
bool	operator== (const ActorBox& lhs, const ActorBox& rhs)

bool	operator!= (const ActorBox& lhs, const ActorBox& rhs)

Clutter::ActorBox&	wrap (ClutterActorBox* object)

const Clutter::ActorBox&	wrap (const ClutterActorBox* object)

Constructor & Destructor Documentation

Clutter::ActorBox::ActorBox ( const ClutterActorBox * gobject)

explicit

Clutter::ActorBox::ActorBox	(	float	x1 = `0`,
		float	y1 = `0`,
		float	x2 = `0`,
		float	y2 = `0`
	)

explicit

Member Function Documentation

void Clutter::ActorBox::clamp_to_pixel ( )

Clamps the components of box to the nearest integer.

Since cluttermm 1.2:

bool Clutter::ActorBox::contains	(	float	x,
		float	y
	)		const

Checks whether a point with x, y coordinates is contained withing box.

Since cluttermm 1.0:

Parameters

x	X coordinate of the point.
y	Y coordinate of the point.

Returns: true if the point is contained by the Clutter::ActorBox.

float Clutter::ActorBox::get_area ( ) const

Retrieves the area of box.

Since cluttermm 1.0:

Returns: The area of a Clutter::ActorBox, in pixels.

float Clutter::ActorBox::get_height ( ) const

Retrieves the height of the box.

Since cluttermm 1.0:

Returns: The height of the box.

void Clutter::ActorBox::get_origin	(	float &	x,
		float &	y
	)		const

Retrieves the origin of box.

Since cluttermm 1.0:

Parameters

x	Return location for the X coordinate, or `0`.
y	Return location for the Y coordinate, or `0`.

void Clutter::ActorBox::get_size	(	float &	width,
		float &	height
	)		const

Retrieves the size of box.

Since cluttermm 1.0:

Parameters

width	Return location for the width, or `0`.
height	Return location for the height, or `0`.

static GType Clutter::ActorBox::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

float Clutter::ActorBox::get_width ( ) const

Retrieves the width of the box.

Since cluttermm 1.0:

Returns: The width of the box.

float Clutter::ActorBox::get_x ( ) const

Retrieves the X coordinate of the origin of box.

Since cluttermm 1.0:

Returns: The X coordinate of the origin.

float Clutter::ActorBox::get_y ( ) const

Retrieves the Y coordinate of the origin of box.

Since cluttermm 1.0:

Returns: The Y coordinate of the origin.

ClutterActorBox* Clutter::ActorBox::gobj ( )

inline

Provides access to the underlying C instance.

const ClutterActorBox* Clutter::ActorBox::gobj ( ) const

inline

Provides access to the underlying C instance.

void Clutter::ActorBox::interpolate	(	const ActorBox&	final_,
		double	progress,
		ActorBox&	result
	)

Interpolates between initial and final Clutter::ActorBoxes using progress.

Since cluttermm 1.2:

Parameters

final	The final Clutter::ActorBox.
progress	The interpolation progress.
result	Return location for the interpolation.

void Clutter::ActorBox::set_origin	(	float	x,
		float	y
	)

Changes the origin of box, maintaining the size of the Clutter::ActorBox.

Since cluttermm 1.6:

Parameters

x	The X coordinate of the new origin.
y	The Y coordinate of the new origin.

void Clutter::ActorBox::set_size	(	float	width,
		float	height
	)

Sets the size of box, maintaining the origin of the Clutter::ActorBox.

Since cluttermm 1.6:

Parameters

width	The new width.
height	The new height.

void Clutter::ActorBox::unite	(	const ActorBox&	b,
		ActorBox&	result
	)

Unions the two boxes a and b and stores the result in result.

Since cluttermm 1.4:

Parameters

b	The second Clutter::ActorBox.
result	The Clutter::ActorBox representing a union of a and b.

Friends And Related Function Documentation

bool operator!=	(	const ActorBox&	lhs,
		const ActorBox&	rhs
	)

Parameters

lhs	The left-hand side
rhs	The right-hand side

Returns: The result

bool operator==	(	const ActorBox&	lhs,
		const ActorBox&	rhs
	)

Parameters

lhs	The left-hand side
rhs	The right-hand side

Returns: The result

Clutter::ActorBox& wrap ( ClutterActorBox * object)

Parameters

object The C instance

Returns: A C++ instance that wraps this C instance.

const Clutter::ActorBox& wrap ( const ClutterActorBox * object)

Parameters

object The C instance

Returns: A C++ instance that wraps this C instance.

Member Data Documentation

ClutterActorBox Clutter::ActorBox::gobject_

protected

The documentation for this class was generated from the following file:

cluttermm/actor-box.h

cluttermm: Clutter::ActorBox Class Reference

Public Member Functions

Static Public Member Functions

Protected Attributes

Related Functions

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation