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

observercam.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_OBSERVERCAM_H
00024 #define LSG_OBSERVERCAM_H 1
00025 
00026 /**
00027  * \file  observercam.h
00028  * \brief Perspective camera with location and heading
00029  */
00030 
00031 #include <lescegra/sg/camera.h>
00032 
00033 #include <lescegra/util/vertex.h>
00034 
00035 /**
00036  * \brief Perspective camera with location and heading
00037  *
00038  * A perspective camera that is defined by the three vertices location, heading
00039  * and up, the field-of-view and a minimal and maximal viewing distance.
00040  */
00041 typedef struct {
00042     LsgCamera super;
00043     Vertex location;
00044     Vertex heading;
00045     Vertex up;
00046     float fovy;
00047     float aspect;
00048     float dmin;
00049     float dmax;
00050 } LsgObserverCam;
00051 
00052 
00053 /**
00054  * \relates LsgObserverCam
00055  * Allocate and initialize a LsgObserverCam.
00056  * @return A new LsgObserverCam instance
00057  */
00058 LsgObserverCam* LsgObserverCam_create(void);
00059 
00060 /**
00061  * \relates LsgObserverCam
00062  * Constructor method for LsgObserverCam. Initialize the LsgCamera as looking from
00063  * {0, 0, -1} along the positive z axis with the second (y) axis being up. The
00064  * initial field-of-view is 45 degrees in both directions.
00065  * @param self      The instance variable
00066  */
00067 void LsgObserverCam_init(LsgObserverCam* self);
00068 
00069 /**
00070  * \relates LsgObserverCam
00071  * Display a node as seen using this LsgCamera.
00072  * @param self      The instance variable
00073  * @param frustum   The initial view frustum
00074  * @param node      The node to display
00075  */
00076 void LsgObserverCam_display(LsgObserverCam* self, LsgFrustum* frust, LsgNode* node);
00077 
00078 /**
00079  * Destructor method for LsgObserverCam. Reuse parent implementation.
00080  */
00081 #define LsgObserverCam_destroy(self) LsgCamera_destroy(&(self)->super)
00082 
00083 #endif

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