qaf Namespace Reference

---

Detailed Description

Everything defined by the Qaf library is placed in the qaf namespace.

Classes
class	BGLayer
	Represents a background layer in the loaded room. More...
class	CollisionStruct
	Represents a geometric boundary for use in collision tests. More...
class	ObjIterator
	Used to iterate over the Environment's list of active game objects. More...
class	DebugVector
	This class is used to generate a visualization of vectors for debug purposes. More...
class	Environment
	The Environment manages the game's state -- both static (window, loaded room, background layers), and dynamic (GameObjs). More...
class	GameObj
	GameObjs represent the "active" components of the game. More...
class	GameObjFactory
	The object factory will be queried by the Environment to create the Room's game objects. More...
class	Joystick
	This class represents an instance of an active joystick device. More...
class	JoystickSystem
	For internal use only. This class manages the system's available joysticks. More...
class	AnimParticleObj
	This is an object that renders itself as an animation, with optional linear/angular speeds. More...
class	LaserCursorObj
	Demonstrates moving-point collision. More...
class	PlatformerObj
	This is a ready-made game object which controls like a platformer. More...
class	SpriteParticleObj
	This is an object that renders itself as a sprite, with optional linear/angular speeds. More...
class	TubeCursorObj
	Demonstrates moving-segment collision. More...
class	Room
	Represents the game's static environment -- obstacles and backgrounds. More...
class	BigTexture
	Stores an arbitrary-sized image. More...
class	Container
	A generic container to store data in a linear arrangement, similar to Java's Vector. More...
class	Geom
	Provides static methods for useful geometric operations. More...
class	HgeInputStream
	Encapsulates reading from a file stored in an HGE resource pack. More...
class	IntegerInputStream
	Encapsulates decoding of an integer stream. More...
class	Matrix
	General-purpose storage class to arrange data as rows and columns. More...
class	Vector2D
	Vector in the R2 space, with (x, y) components. More...
class	Vector3D
	Vector in the R3 space, with (x, y, z) components. More...
Typedefs
typedef std::map< std::string, std::string >	AttributeTable
	A shortcut so we don't have to write the whole type declaration all the time.
Enumerations
enum	JoystickObject {   QAF_JOY_NONE = 0,   QAF_JOY_X_AXIS,   QAF_JOY_Y_AXIS,   QAF_JOY_Z_AXIS,   QAF_JOY_X_AXIS_ROTATION,   QAF_JOY_Y_AXIS_ROTATION,   QAF_JOY_Z_AXIS_ROTATION,   QAF_JOY_SLIDER_0,   QAF_JOY_SLIDER_1,   QAF_JOY_POV_0,   QAF_JOY_POV_1,   QAF_JOY_POV_2,   QAF_JOY_POV_3,   QAF_JOY_BUTTON_0,   QAF_JOY_BUTTON_1,   QAF_JOY_BUTTON_2,   QAF_JOY_BUTTON_3,   QAF_JOY_BUTTON_4,   QAF_JOY_BUTTON_5,   QAF_JOY_BUTTON_6,   QAF_JOY_BUTTON_7,   QAF_JOY_BUTTON_8,   QAF_JOY_BUTTON_9,   QAF_JOY_BUTTON_10,   QAF_JOY_BUTTON_11,   QAF_JOY_BUTTON_12,   QAF_JOY_BUTTON_13,   QAF_JOY_BUTTON_14,   QAF_JOY_BUTTON_15,   QAF_JOY_BUTTON_16,   QAF_JOY_BUTTON_17,   QAF_JOY_BUTTON_18,   QAF_JOY_BUTTON_19,   QAF_JOY_BUTTON_20,   QAF_JOY_BUTTON_21,   QAF_JOY_BUTTON_22,   QAF_JOY_BUTTON_23,   QAF_JOY_BUTTON_24,   QAF_JOY_BUTTON_25,   QAF_JOY_BUTTON_26,   QAF_JOY_BUTTON_27,   QAF_JOY_BUTTON_28,   QAF_JOY_BUTTON_29,   QAF_JOY_BUTTON_30,   QAF_JOY_BUTTON_31,   QAF_JOY_BUTTON_32,   QAF_JOY_BUTTON_33,   QAF_JOY_BUTTON_34,   QAF_JOY_BUTTON_35,   QAF_JOY_BUTTON_36,   QAF_JOY_BUTTON_37,   QAF_JOY_BUTTON_38,   QAF_JOY_BUTTON_39,   QAF_JOY_BUTTON_40,   QAF_JOY_BUTTON_41,   QAF_JOY_BUTTON_42,   QAF_JOY_BUTTON_43,   QAF_JOY_BUTTON_44,   QAF_JOY_BUTTON_45,   QAF_JOY_BUTTON_46,   QAF_JOY_BUTTON_47,   QAF_JOY_BUTTON_48,   QAF_JOY_BUTTON_49,   QAF_JOY_BUTTON_50,   QAF_JOY_BUTTON_51,   QAF_JOY_BUTTON_52,   QAF_JOY_BUTTON_53,   QAF_JOY_BUTTON_54,   QAF_JOY_BUTTON_55,   QAF_JOY_BUTTON_56,   QAF_JOY_BUTTON_57,   QAF_JOY_BUTTON_58,   QAF_JOY_BUTTON_59,   QAF_JOY_BUTTON_60,   QAF_JOY_BUTTON_61,   QAF_JOY_BUTTON_62,   QAF_JOY_BUTTON_63,   QAF_JOY_BUTTON_64,   QAF_JOY_BUTTON_65,   QAF_JOY_BUTTON_66,   QAF_JOY_BUTTON_67,   QAF_JOY_BUTTON_68,   QAF_JOY_BUTTON_69,   QAF_JOY_BUTTON_70,   QAF_JOY_BUTTON_71,   QAF_JOY_BUTTON_72,   QAF_JOY_BUTTON_73,   QAF_JOY_BUTTON_74,   QAF_JOY_BUTTON_75,   QAF_JOY_BUTTON_76,   QAF_JOY_BUTTON_77,   QAF_JOY_BUTTON_78,   QAF_JOY_BUTTON_79,   QAF_JOY_BUTTON_80,   QAF_JOY_BUTTON_81,   QAF_JOY_BUTTON_82,   QAF_JOY_BUTTON_83,   QAF_JOY_BUTTON_84,   QAF_JOY_BUTTON_85,   QAF_JOY_BUTTON_86,   QAF_JOY_BUTTON_87,   QAF_JOY_BUTTON_88,   QAF_JOY_BUTTON_89,   QAF_JOY_BUTTON_90,   QAF_JOY_BUTTON_91,   QAF_JOY_BUTTON_92,   QAF_JOY_BUTTON_93,   QAF_JOY_BUTTON_94,   QAF_JOY_BUTTON_95,   QAF_JOY_BUTTON_96,   QAF_JOY_BUTTON_97,   QAF_JOY_BUTTON_98,   QAF_JOY_BUTTON_99,   QAF_JOY_BUTTON_100,   QAF_JOY_BUTTON_101,   QAF_JOY_BUTTON_102,   QAF_JOY_BUTTON_103,   QAF_JOY_BUTTON_104,   QAF_JOY_BUTTON_105,   QAF_JOY_BUTTON_106,   QAF_JOY_BUTTON_107,   QAF_JOY_BUTTON_108,   QAF_JOY_BUTTON_109,   QAF_JOY_BUTTON_110,   QAF_JOY_BUTTON_111,   QAF_JOY_BUTTON_112,   QAF_JOY_BUTTON_113,   QAF_JOY_BUTTON_114,   QAF_JOY_BUTTON_115,   QAF_JOY_BUTTON_116,   QAF_JOY_BUTTON_117,   QAF_JOY_BUTTON_118,   QAF_JOY_BUTTON_119,   QAF_JOY_BUTTON_120,   QAF_JOY_BUTTON_121,   QAF_JOY_BUTTON_122,   QAF_JOY_BUTTON_123,   QAF_JOY_BUTTON_124,   QAF_JOY_BUTTON_125,   QAF_JOY_BUTTON_126,   QAF_JOY_BUTTON_127 }
	Types of objects present in a joystick. More...
enum	ObstacleBlock {   QAFBLK_EMPTY = -1,   QAFBLK_SE_BLOCK = 0,   QAFBLK_W_E_BOTTOM = 1,   QAFBLK_SW_BLOCK = 2,   QAFBLK_NW_MISSING = 3,   QAFBLK_NE_MISSING = 4,   QAFBLK_SW_NE_BOTTOM = 5,   QAFBLK_NW_SE_BOTTOM = 6,   QAFBLK_SW_E_BOTTOM = 7,   QAFBLK_W_NE_BOTTOM = 8,   QAFBLK_NW_E_BOTTOM = 9,   QAFBLK_W_SE_BOTTOM = 10,   QAFBLK_N_S_RIGHT = 11,   QAFBLK_FULL = 12,   QAFBLK_N_S_LEFT = 13,   QAFBLK_SW_MISSING = 14,   QAFBLK_SE_MISSING = 15,   QAFBLK_NW_SE_TOP = 16,   QAFBLK_SW_NE_TOP = 17,   QAFBLK_NW_E_TOP = 18,   QAFBLK_W_SE_TOP = 19,   QAFBLK_SW_E_TOP = 20,   QAFBLK_W_NE_TOP = 21,   QAFBLK_NE_BLOCK = 22,   QAFBLK_W_E_TOP = 23,   QAFBLK_NW_BLOCK = 24,   QAFBLK_S_E_BOTTOM = 25,   QAFBLK_W_N_BOTTOM = 26,   QAFBLK_N_E_BOTTOM = 27,   QAFBLK_W_S_BOTTOM = 28,   QAFBLK_N_E_TOP = 29,   QAFBLK_W_S_TOP = 30,   QAFBLK_S_E_TOP = 31,   QAFBLK_W_N_TOP = 32,   QAFBLK_THINFLOOR_HI = 33,   QAFBLK_THINFLOOR_MID = 34,   QAFBLK_THINFLOOR_LO = 35 }
	A Room's "obstacle layer" is stored as a matrix of integers, which represent the different block types that compose the room's layout. More...
Functions
Vector2D	operator * (float s, const Vector2D &v)
Vector3D	operator * (float s, const Vector3D &t)

---

Enumeration Type Documentation

enum qaf::JoystickObject

Types of objects present in a joystick.

The names are derived from DirectInput's nomenclature. See the header file qafJoystickSystem.h for a list of useful macros that can be applied to these values.

Enumerator:

QAF_JOY_NONE	Represents an invalid code.
QAF_JOY_X_AXIS	Axis that might provide analog input.
QAF_JOY_Y_AXIS	Axis that might provide analog input.
QAF_JOY_Z_AXIS	Axis that might provide analog input.
QAF_JOY_X_AXIS_ROTATION	Axis that might provide analog input.
QAF_JOY_Y_AXIS_ROTATION	Axis that might provide analog input.
QAF_JOY_Z_AXIS_ROTATION	Axis that might provide analog input.
QAF_JOY_SLIDER_0	Axis that might provide analog input.
QAF_JOY_SLIDER_1	Axis that might provide analog input.
QAF_JOY_POV_0	Point-of-view hat, representing directional input.
QAF_JOY_POV_1	Point-of-view hat, representing directional input.
QAF_JOY_POV_2	Point-of-view hat, representing directional input.
QAF_JOY_POV_3	Point-of-view hat, representing directional input.
QAF_JOY_BUTTON_0	Button that can only receive digital input.
QAF_JOY_BUTTON_1	Button that can only receive digital input.
QAF_JOY_BUTTON_2	Button that can only receive digital input.
QAF_JOY_BUTTON_3	Button that can only receive digital input.
QAF_JOY_BUTTON_4	Button that can only receive digital input.
QAF_JOY_BUTTON_5	Button that can only receive digital input.
QAF_JOY_BUTTON_6	Button that can only receive digital input.
QAF_JOY_BUTTON_7	Button that can only receive digital input.
QAF_JOY_BUTTON_8	Button that can only receive digital input.
QAF_JOY_BUTTON_9	Button that can only receive digital input.
QAF_JOY_BUTTON_10	Button that can only receive digital input.
QAF_JOY_BUTTON_11	Button that can only receive digital input.
QAF_JOY_BUTTON_12	Button that can only receive digital input.
QAF_JOY_BUTTON_13	Button that can only receive digital input.
QAF_JOY_BUTTON_14	Button that can only receive digital input.
QAF_JOY_BUTTON_15	Button that can only receive digital input.
QAF_JOY_BUTTON_16	Button that can only receive digital input.
QAF_JOY_BUTTON_17	Button that can only receive digital input.
QAF_JOY_BUTTON_18	Button that can only receive digital input.
QAF_JOY_BUTTON_19	Button that can only receive digital input.
QAF_JOY_BUTTON_20	Button that can only receive digital input.
QAF_JOY_BUTTON_21	Button that can only receive digital input.
QAF_JOY_BUTTON_22	Button that can only receive digital input.
QAF_JOY_BUTTON_23	Button that can only receive digital input.
QAF_JOY_BUTTON_24	Button that can only receive digital input.
QAF_JOY_BUTTON_25	Button that can only receive digital input.
QAF_JOY_BUTTON_26	Button that can only receive digital input.
QAF_JOY_BUTTON_27	Button that can only receive digital input.
QAF_JOY_BUTTON_28	Button that can only receive digital input.
QAF_JOY_BUTTON_29	Button that can only receive digital input.
QAF_JOY_BUTTON_30	Button that can only receive digital input.
QAF_JOY_BUTTON_31	Button that can only receive digital input.
QAF_JOY_BUTTON_32	Button that can only receive digital input.
QAF_JOY_BUTTON_33	Button that can only receive digital input.
QAF_JOY_BUTTON_34	Button that can only receive digital input.
QAF_JOY_BUTTON_35	Button that can only receive digital input.
QAF_JOY_BUTTON_36	Button that can only receive digital input.
QAF_JOY_BUTTON_37	Button that can only receive digital input.
QAF_JOY_BUTTON_38	Button that can only receive digital input.
QAF_JOY_BUTTON_39	Button that can only receive digital input.
QAF_JOY_BUTTON_40	Button that can only receive digital input.
QAF_JOY_BUTTON_41	Button that can only receive digital input.
QAF_JOY_BUTTON_42	Button that can only receive digital input.
QAF_JOY_BUTTON_43	Button that can only receive digital input.
QAF_JOY_BUTTON_44	Button that can only receive digital input.
QAF_JOY_BUTTON_45	Button that can only receive digital input.
QAF_JOY_BUTTON_46	Button that can only receive digital input.
QAF_JOY_BUTTON_47	Button that can only receive digital input.
QAF_JOY_BUTTON_48	Button that can only receive digital input.
QAF_JOY_BUTTON_49	Button that can only receive digital input.
QAF_JOY_BUTTON_50	Button that can only receive digital input.
QAF_JOY_BUTTON_51	Button that can only receive digital input.
QAF_JOY_BUTTON_52	Button that can only receive digital input.
QAF_JOY_BUTTON_53	Button that can only receive digital input.
QAF_JOY_BUTTON_54	Button that can only receive digital input.
QAF_JOY_BUTTON_55	Button that can only receive digital input.
QAF_JOY_BUTTON_56	Button that can only receive digital input.
QAF_JOY_BUTTON_57	Button that can only receive digital input.
QAF_JOY_BUTTON_58	Button that can only receive digital input.
QAF_JOY_BUTTON_59	Button that can only receive digital input.
QAF_JOY_BUTTON_60	Button that can only receive digital input.
QAF_JOY_BUTTON_61	Button that can only receive digital input.
QAF_JOY_BUTTON_62	Button that can only receive digital input.
QAF_JOY_BUTTON_63	Button that can only receive digital input.
QAF_JOY_BUTTON_64	Button that can only receive digital input.
QAF_JOY_BUTTON_65	Button that can only receive digital input.
QAF_JOY_BUTTON_66	Button that can only receive digital input.
QAF_JOY_BUTTON_67	Button that can only receive digital input.
QAF_JOY_BUTTON_68	Button that can only receive digital input.
QAF_JOY_BUTTON_69	Button that can only receive digital input.
QAF_JOY_BUTTON_70	Button that can only receive digital input.
QAF_JOY_BUTTON_71	Button that can only receive digital input.
QAF_JOY_BUTTON_72	Button that can only receive digital input.
QAF_JOY_BUTTON_73	Button that can only receive digital input.
QAF_JOY_BUTTON_74	Button that can only receive digital input.
QAF_JOY_BUTTON_75	Button that can only receive digital input.
QAF_JOY_BUTTON_76	Button that can only receive digital input.
QAF_JOY_BUTTON_77	Button that can only receive digital input.
QAF_JOY_BUTTON_78	Button that can only receive digital input.
QAF_JOY_BUTTON_79	Button that can only receive digital input.
QAF_JOY_BUTTON_80	Button that can only receive digital input.
QAF_JOY_BUTTON_81	Button that can only receive digital input.
QAF_JOY_BUTTON_82	Button that can only receive digital input.
QAF_JOY_BUTTON_83	Button that can only receive digital input.
QAF_JOY_BUTTON_84	Button that can only receive digital input.
QAF_JOY_BUTTON_85	Button that can only receive digital input.
QAF_JOY_BUTTON_86	Button that can only receive digital input.
QAF_JOY_BUTTON_87	Button that can only receive digital input.
QAF_JOY_BUTTON_88	Button that can only receive digital input.
QAF_JOY_BUTTON_89	Button that can only receive digital input.
QAF_JOY_BUTTON_90	Button that can only receive digital input.
QAF_JOY_BUTTON_91	Button that can only receive digital input.
QAF_JOY_BUTTON_92	Button that can only receive digital input.
QAF_JOY_BUTTON_93	Button that can only receive digital input.
QAF_JOY_BUTTON_94	Button that can only receive digital input.
QAF_JOY_BUTTON_95	Button that can only receive digital input.
QAF_JOY_BUTTON_96	Button that can only receive digital input.
QAF_JOY_BUTTON_97	Button that can only receive digital input.
QAF_JOY_BUTTON_98	Button that can only receive digital input.
QAF_JOY_BUTTON_99	Button that can only receive digital input.
QAF_JOY_BUTTON_100	Button that can only receive digital input.
QAF_JOY_BUTTON_101	Button that can only receive digital input.
QAF_JOY_BUTTON_102	Button that can only receive digital input.
QAF_JOY_BUTTON_103	Button that can only receive digital input.
QAF_JOY_BUTTON_104	Button that can only receive digital input.
QAF_JOY_BUTTON_105	Button that can only receive digital input.
QAF_JOY_BUTTON_106	Button that can only receive digital input.
QAF_JOY_BUTTON_107	Button that can only receive digital input.
QAF_JOY_BUTTON_108	Button that can only receive digital input.
QAF_JOY_BUTTON_109	Button that can only receive digital input.
QAF_JOY_BUTTON_110	Button that can only receive digital input.
QAF_JOY_BUTTON_111	Button that can only receive digital input.
QAF_JOY_BUTTON_112	Button that can only receive digital input.
QAF_JOY_BUTTON_113	Button that can only receive digital input.
QAF_JOY_BUTTON_114	Button that can only receive digital input.
QAF_JOY_BUTTON_115	Button that can only receive digital input.
QAF_JOY_BUTTON_116	Button that can only receive digital input.
QAF_JOY_BUTTON_117	Button that can only receive digital input.
QAF_JOY_BUTTON_118	Button that can only receive digital input.
QAF_JOY_BUTTON_119	Button that can only receive digital input.
QAF_JOY_BUTTON_120	Button that can only receive digital input.
QAF_JOY_BUTTON_121	Button that can only receive digital input.
QAF_JOY_BUTTON_122	Button that can only receive digital input.
QAF_JOY_BUTTON_123	Button that can only receive digital input.
QAF_JOY_BUTTON_124	Button that can only receive digital input.
QAF_JOY_BUTTON_125	Button that can only receive digital input.
QAF_JOY_BUTTON_126	Button that can only receive digital input.
QAF_JOY_BUTTON_127	Button that can only receive digital input.

enum qaf::ObstacleBlock

A Room's "obstacle layer" is stored as a matrix of integers, which represent the different block types that compose the room's layout.

Enumerator:

QAFBLK_EMPTY	// +-------+ // | | // | | // | | // +-------+
QAFBLK_SE_BLOCK	// +-------+ // | | // | .---| // | |///| // +-------+
QAFBLK_W_E_BOTTOM	// +-------+ // | | // |-------| // |///////| // +-------+
QAFBLK_SW_BLOCK	// +-------+ // | | // |---. | // |///| | // +-------+
QAFBLK_NW_MISSING	// +-------+ // | |///| // |---'///| // |///////| // +-------+
QAFBLK_NE_MISSING	// +-------+ // |///| | // |///'---| // |///////| // +-------+
QAFBLK_SW_NE_BOTTOM	// +-------+ // | _-¯| // | _-///| // |_-/////| // +-------+
QAFBLK_NW_SE_BOTTOM	// +-------+ // |¯-_ | // |///-_ | // |/////-_| // +-------+
QAFBLK_SW_E_BOTTOM	// +-------+ // | | // | __--| // |_--////| // +-------+
QAFBLK_W_NE_BOTTOM	// +-------+ // | __--¯| // |--/////| // |///////| // +-------+
QAFBLK_NW_E_BOTTOM	// +-------+ // |¯--__ | // |/////--| // |///////| // +-------+
QAFBLK_W_SE_BOTTOM	// +-------+ // | | // |--__ | // |////--_| // +-------+
QAFBLK_N_S_RIGHT	// +-------+ // | |///| // | |///| // | |///| // +-------+
QAFBLK_FULL	// +-------+ // |///////| // |///////| // |///////| // +-------+
QAFBLK_N_S_LEFT	// +-------+ // |///| | // |///| | // |///| | // +-------+
QAFBLK_SW_MISSING	// +-------+ // |///////| // |---.///| // | |///| // +-------+
QAFBLK_SE_MISSING	// +-------+ // |///////| // |///.---| // |///| | // +-------+
QAFBLK_NW_SE_TOP	// +-------+ // |¯-/////| // | ¯-///| // | ¯-_| // +-------+
QAFBLK_SW_NE_TOP	// +-------+ // |/////-¯| // |///-¯ | // |_-¯ | // +-------+
QAFBLK_NW_E_TOP	// +-------+ // |¯--////| // | ¯¯--| // | | // +-------+
QAFBLK_W_SE_TOP	// +-------+ // |///////| // |--/////| // | ¯¯--_| // +-------+
QAFBLK_SW_E_TOP	// +-------+ // |///////| // |///__--| // |_-- | // +-------+
QAFBLK_W_NE_TOP	// +-------+ // |////--¯| // |--¯¯ | // | | // +-------+
QAFBLK_NE_BLOCK	// +-------+ // | |///| // | '---| // | | // +-------+
QAFBLK_W_E_TOP	// +-------+ // |///////| // |-------| // | | // +-------+
QAFBLK_NW_BLOCK	// +-------+ // |///| | // |---' | // | | // +-------+
QAFBLK_S_E_BOTTOM	// +-------+ // | | // | _-| // | _-//| // +-------+
QAFBLK_W_N_BOTTOM	// +-------+ // | _-¯///| // |-//////| // |///////| // +-------+
QAFBLK_N_E_BOTTOM	// +-------+ // |///¯-_ | // |//////-| // |///////| // +-------+
QAFBLK_W_S_BOTTOM	// +-------+ // | | // |-_ | // |//-_ | // +-------+
QAFBLK_N_E_TOP	// +-------+ // | ¯-//| // | ¯-| // | | // +-------+
QAFBLK_W_S_TOP	// +-------+ // |///////| // |-//////| // | ¯-_///| // +-------+
QAFBLK_S_E_TOP	// +-------+ // |///////| // |//////-| // |///_-¯ | // +-------+
QAFBLK_W_N_TOP	// +-------+ // |//-¯ | // |-¯ | // | | // +-------+
QAFBLK_THINFLOOR_HI	// +-------+ // |¯¯¯¯¯¯¯| // | | // | | // +-------+
QAFBLK_THINFLOOR_MID	// +-------+ // | | // |=======| // | | // +-------+
QAFBLK_THINFLOOR_LO	// +-------+ // | | // | | // |_______| // +-------+

---