phoenix Namespace Reference

The phoenix namespace. More...

Classes
class	PhBackground
	Simple background implementation. More...
class	PhColor
	Color. More...
class	PhDrawSceneNode
	Draw scene node. More...
class	PhEventHandler
	Event handler. More...
class	PhExtendedBackground
	Extended Background. More...
class	PhPolygon
	Polygon class. More...
class	PhPolygonCollisionHandler
	The polygon collision handler. More...
struct	PhStaticGeometry
	Static geomery. More...
class	PhCollisionObject
	Collision object. More...
struct	PhCollisionData
	Collision data. More...
class	PhRect
	Rectangle class. More...
class	PhRenderSystem
	The render system. More...
class	PhSceneNode
	Scenenode Prototype. More...
class	PhSceneManager
	Scene Manger Class. More...
class	PhSolidBackground
	Solid background node. More...
class	PhSpriteAnimation
	Sprite Animation. More...
class	PhTexture
	Texture class. More...
class	PhTextureManager
	Texture manager. More...
class	PhTileMap
	Tile map. More...
class	PhTimer
	Timer class. More...
class	PhVector2d
	2D Vector class More...
class	PhView
	View class. More...
Namespaces
namespace	aux
	The aux library.
Typedefs
typedef function< void(PhCollisionData data)>	PhObjectCallback
	Callback typedef.
Functions
template<class a_type>
a_type	porportion (a_type a, a_type b, a_type c, a_type d, int find)
	Porportion.
float	RadiansToDegrees (float rad)
	Radians to degrees.
float	DegreesToRadians (float deg)
	Degrees to radians.

---

Detailed Description

The phoenix namespace.

Copyright (c) 2007, Jonathan Wayne Parrott.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

Typedef Documentation

typedef function<void (PhCollisionData data)> phoenix::PhObjectCallback

Callback typedef.

Defines the type of collision callbacks. When the collision manager detects a collision it calls the callbacks of the involved objects and passes it a phoenix::PhCollisionData object representing details from the collision. For non-class members you can simply cast a function pointer to this type (ie PhObjectCallback(function)). However, for member functions (which is usually the case) you can use boost which provides an elegant way to do so (ie PhObjectCallback(boost::bind(&Class::function, this, _1)) ).

See also:

phoenix::PhCollisionObject, phoenix::PhPolygonCollisionHandler

---

Function Documentation

float phoenix::DegreesToRadians

(

float

deg

)

[inline]

Degrees to radians.

Converts degrees to radians, as simple as that.

Parameters:

deg

Angle in degrees.

Returns:

Angle in radians.

See also:

phoenix::RadiansToDegrees()

template<class a_type>

a_type phoenix::porportion	(	a_type	a,
		a_type	b,
		a_type	c,
		a_type	d,
		int	find
	)			[inline]

Porportion.

Porportion, it returns a porportional value based on this:
a/b = c/d
Note that if you're looking for something, one of these four will be unknown, it doesn't matter what value you pass to it.

Parameters:

	a	Numerator of first fraction.
	b	Denominator of first fraction.
	c	Numerator of second fraction.
	d	Denominator of second fraction.
	find	The parameter you wanna find, a being 0 and d being 3.

Returns:

The value you seek.

float phoenix::RadiansToDegrees

(

float

rad

)

[inline]

Radians to degrees.

Converts radians to degrees, as simple as that.

Parameters:

rad

Angle in radians.

Returns:

Angle in degrees.

See also:

phoenix::DegreesToRadians()

---