Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

coords.h

Go to the documentation of this file.
00001 /*********************************************************************
00002 * lescegra                                                           *
00003 *                                                                    *
00004 * http://geeky.kicks-ass.org/projects/lescegra.html                  *
00005 *                                                                    *
00006 * Copyright 2003 by Enno Cramer <uebergeek@web.de>                   *
00007 *                                                                    *
00008 * This library is free software; you can redistribute it and/or      *
00009 * modify it under the terms of the GNU Library General Public        *
00010 * License as published by the Free Software Foundation; either       *
00011 * version 2 of the License, or (at your option) any later version.   *
00012 *                                                                    *
00013 * This library is distributed in the hope that it will be useful,    *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of     *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  *
00016 * Library General Public License for more details.                   *
00017 *                                                                    *
00018 * You should have received a copy of the GNU Library General Public  *
00019 * License along with this library; if not, write to the Free         *
00020 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
00021 *********************************************************************/
00022 
00023 #ifndef LSG_COORDS_H
00024 #define LSG_COORDS_H 1
00025 
00026 /**
00027  * \file  coords.h
00028  * \brief Colored coordinate system
00029  */
00030 
00031 #include <lescegra/sg/node.h>
00032 
00033 /**
00034  * \brief Colored coordinate system
00035  *
00036  * Display a red, green, blue colored coordinate system.
00037  */
00038 typedef struct {
00039     LsgNode super;
00040     float size;
00041 } LsgCoords;
00042 
00043 /**
00044  * \relates LsgCoords
00045  * Allocate and initialize a new LsgCoords.
00046  * @param size      The axes length
00047  * @return A new LsgCoords instance
00048  */
00049 LsgCoords* LsgCoords_create(float size);
00050 
00051 /**
00052  * \relates LsgCoords
00053  * Constructor method for LsgCoords.
00054  * @param self      The instance variable
00055  * @param size      The axes length
00056  */
00057 void LsgCoords_init(LsgCoords* self, float size);
00058 
00059 /**
00060  * \relates LsgCoords
00061  * Display a coordinate system.
00062  * @param self      The instance variable
00063  * @param frust     The view frustum transformed to local coordinates
00064  */
00065 void LsgCoords_display(LsgCoords* self, LsgFrustum* frust);
00066 
00067 /**
00068  * Clean the node. Reuse parent implementation.
00069  */
00070 #define LsgCoords_clean(self)       LsgNode_clean(&(self)->super)
00071 
00072 /**
00073  * Update the node. Reuse parent implementation.
00074  */
00075 #define LsgCoords_update(self, now) LsgNode_update(&(self)->super, now)
00076 
00077 /**
00078  * Destructor method for LsgCoords. Reuse parent implementation.
00079  */
00080 #define LsgCoords_destroy(self)     LsgNode_destroy(&(self)->super)
00081 
00082 #endif

(c) 2003, by Enno Cramer
generated on 13 Jul 2003
lescegra - doxygen