Gel2D - The free/open source game creation suite

Public Member Functions | Public Attributes
gel::GelArmature Class Reference

2D bone system for character animation. More...

#include <gelArmature.h>

Inheritance diagram for gel::GelArmature:
gel::GelObject gel::GelEventReceiver

List of all members.

Public Member Functions

 GelArmature ()
 Default constructor.
 GelArmature (const char *desc_name)
 Convenience constructor.
 GelArmature (Gel2dVec obj_pos, float obj_rot, Gel2dVec obj_scl)
 Convenience constructor.
void addBone (GelBone *parent=NULL, const char *name="Bone")
 Adds a bone to the armature.
void writeDesc (const char *filename)
 Writes an armature description file to disk.
int readDesc (const char *filename)
 Reads an armature description file from disk.
void render ()
 Renders the armature to the screen.

Public Attributes

GelBone bone [GEL_MAX_BONES]

Detailed Description

2D bone system for character animation.

Attention:
This class is currently under construction. It is not suitable to be used in its present form.

Constructor & Destructor Documentation

gel::GelArmature::GelArmature ( )

Default constructor.

gel::GelArmature::GelArmature ( const char *  desc_name)

Convenience constructor.

Reads an armature description file from disk.

Parameters:
desc_name: The directory / name of a Gel2D Armature description file.
gel::GelArmature::GelArmature ( Gel2dVec  obj_pos,
float  obj_rot,
Gel2dVec  obj_scl 
)

Convenience constructor.

Sets the object's position, rotation, and scale.

Parameters:
obj_pos: The object's x and y coordinates.
obj_rot: The rotation of the object in degrees.
obj_scl: The object's scale.

Member Function Documentation

void gel::GelArmature::addBone ( GelBone parent = NULL,
const char *  name = "Bone" 
)

Adds a bone to the armature.

Parameters:
parent: The parent of the new bone.
name: The name of the new bone.
void gel::GelArmature::writeDesc ( const char *  filename)

Writes an armature description file to disk.

Parameters:
filename: The directory / name of the description file.
int gel::GelArmature::readDesc ( const char *  filename)

Reads an armature description file from disk.

Parameters:
filename: The directory / name of the description file.
Returns:
GEL_TRUE If the file is a valid Gel2D Armature, else GEL_FALSE.
void gel::GelArmature::render ( ) [virtual]

Renders the armature to the screen.

Reimplemented from gel::GelObject.


Member Data Documentation


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