Changeset 2096 in orxonox.OLD for orxonox/branches/chris/src/camera.h

Timestamp:

Jul 9, 2004, 11:14:42 AM (20 years ago)

Author:

chris

Message:

orxonox/branches/chris: Messed with the Player class, added stuff here and there, debug world now creates a player and bind IO to it. Added some doxygen tags.

File:

• orxonox/branches/chris/src/camera.h (modified) (1 diff)

orxonox/branches/chris/src/camera.h

@@ +1 @@
+/*! 
+    \file camera.h
+    \brief Viewpoint controlling class definitions
+*/ 
 
 #ifndef CAMERA_H
 #define CAMERA_H
 
+//! Camera
+/**
+        This class controls the viewpoint from which the World is rendered. To use the Camera it has
+        to be bound to a WorldEntity which serves as the reference focus point. The Camera itself calls
+        the WorldEntity::get_lookat() and World::calc_camera_pos() functions to calculate the position it
+        currently should be in.
+*/
 class Camera {
  private:
-        WorldEntity* bound;
-        Placement actual_place;
-        Placement desired_place;
+        WorldEntity* bound;             //!< the WorldEntity the Camera is bound to
+        Placement actual_place; //!< the Camera's current position
+        Placement desired_place; //!< where the Camera should be according to calculations
 
         void update_desired_place ();