| Last change
                  on this file since 5009 was
                  4836,
                  checked in by bensch, 20 years ago | 
        
          | 
orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.Thanks a lot to the kDevelop team. this took since the last commit
  
 | 
        | File size:
            1.4 KB | 
      
      
        
  | Rev | Line |  | 
|---|
| [4597] | 1 | /*! | 
|---|
| [4485] | 2 | \file state.h | 
|---|
| [4836] | 3 | *  Definition of the States-singleton Class | 
|---|
| [3655] | 4 | */ | 
|---|
|  | 5 |  | 
|---|
| [4293] | 6 | #ifndef _STATE_H | 
|---|
|  | 7 | #define _STATE_H | 
|---|
| [3655] | 8 |  | 
|---|
|  | 9 | #include "base_object.h" | 
|---|
|  | 10 |  | 
|---|
| [4178] | 11 | // FORWARD DEFINITION | 
|---|
| [4293] | 12 | class PNode; | 
|---|
| [4827] | 13 | class WorldEntity; | 
|---|
|  | 14 | template<class T> class tList; | 
|---|
| [3655] | 15 |  | 
|---|
| [4293] | 16 | //! A Singleton class, that handles some states about orxonox's objects | 
|---|
|  | 17 | class State : public BaseObject { | 
|---|
| [3655] | 18 |  | 
|---|
|  | 19 | public: | 
|---|
| [4827] | 20 | // CAMERA // | 
|---|
|  | 21 | /** @param camera the PNode to the Camera, @param cameraTarget the PNode to the Camera's target */ | 
|---|
|  | 22 | static void setCamera(const PNode* camera, const PNode* cameraTarget); | 
|---|
|  | 23 | /** @returns a Pointer to the PNode of the Camera */ | 
|---|
|  | 24 | static inline const PNode* getCamera() { return State::camera; }; | 
|---|
|  | 25 | /** @returns a Pointer to the CameraTarget */ | 
|---|
|  | 26 | static inline const PNode* getCameraTarget() { return State::cameraTarget; }; | 
|---|
| [4485] | 27 |  | 
|---|
| [4827] | 28 | // WORLD_ENTITY_LIST // | 
|---|
|  | 29 | /** @param worldEntityList The World's List of WorldEntities */ | 
|---|
|  | 30 | static inline void setWorldEntityList(tList<WorldEntity>* worldEntityList) { State::worldEntityList = worldEntityList; }; | 
|---|
|  | 31 | /** @returns the List of WorldEntities */ | 
|---|
|  | 32 | static inline tList<WorldEntity>* getWorldEntityList() { return State::worldEntityList; }; | 
|---|
| [3655] | 33 |  | 
|---|
|  | 34 | private: | 
|---|
| [4746] | 35 | State(); | 
|---|
| [4293] | 36 |  | 
|---|
| [4827] | 37 | static const PNode*           camera;             //!< A reference to the camera | 
|---|
|  | 38 | static const PNode*           cameraTarget;       //!< a reference to the cameraTarget | 
|---|
|  | 39 |  | 
|---|
|  | 40 | static tList<WorldEntity>*    worldEntityList;    //!< The List of the worldEntities | 
|---|
| [3655] | 41 | }; | 
|---|
|  | 42 |  | 
|---|
| [4293] | 43 | #endif /* _STATE_H */ | 
|---|
       
      
      Note: See 
TracBrowser
        for help on using the repository browser.