[3246] | 1 | /*! |
---|
| 2 | \file p_node.h |
---|
| 3 | \brief Definition of a parenting node |
---|
| 4 | |
---|
| 5 | parenting is how coordinates are handled in orxonox, meaning, that all coordinates |
---|
| 6 | are representet relative to another parent node. this nodes build a parenting |
---|
| 7 | tree of one-sided references (from up to down referenced). |
---|
| 8 | Every node manages itself a list of childrens (of whos it is parent - easy...) |
---|
| 9 | |
---|
| 10 | absCoordinate, absDirection have to be recalculated as soon as there was a change in |
---|
| 11 | place or ortientation. this is only the case if |
---|
| 12 | o bDirChanged is true (so changed) AND timeStamp != now |
---|
| 13 | o bCoorChanged is true (so moved) AND timeStamp != now |
---|
| 14 | this conditions make it cheaper to recalculate the tree (reduces redundant work). |
---|
| 15 | |
---|
[3365] | 16 | remember: if you have to change the coordinates or the directions, use the functions |
---|
| 17 | that are defined to execute this operation - otherwhise there will be big problems... |
---|
[3246] | 18 | */ |
---|
| 19 | |
---|
| 20 | |
---|
| 21 | #ifndef _P_NODE_H |
---|
| 22 | #define _P_NODE_H |
---|
| 23 | |
---|
[3543] | 24 | #include "base_object.h" |
---|
[3804] | 25 | #include "vector.h" |
---|
[3246] | 26 | |
---|
[3543] | 27 | // FORWARD DEFINITION \\ |
---|
[3365] | 28 | class PNode; /* forward decleration, so that parentEntry has access to PNode */ |
---|
[3804] | 29 | //class Quaternion; |
---|
| 30 | //class Vector; |
---|
[3607] | 31 | template<class T> class tList; |
---|
[3246] | 32 | |
---|
[3450] | 33 | //! enumeration for the different translation-binding-types |
---|
[3565] | 34 | //typedef enum parentingMode {PNODE_LOCAL_ROTATE, PNODE_ROTATE_MOVEMENT, PNODE_ALL, PNODE_MOVEMENT, PNODE_ROTATE_AND_MOVE}; |
---|
| 35 | // linkage modes |
---|
| 36 | #define PNODE_LOCAL_ROTATE 1 //!< Rotates all the children around their centers. |
---|
| 37 | #define PNODE_ROTATE_MOVEMENT 2 //!< Moves all the children around the center of their parent, without the rotation around their own centers. |
---|
| 38 | #define PNODE_MOVEMENT 4 //!< Moves all children along with the parent. |
---|
| 39 | // special linkage modes |
---|
| 40 | #define PNODE_ALL 3 //!< Moves all children around the center of their parent, and also rotates their centers |
---|
| 41 | #define PNODE_ROTATE_AND_MOVE 5 //!< Rotates all children around their axis, and moves them as the Parent Moves, but does not rotate around the center of their parent. |
---|
| 42 | |
---|
[3450] | 43 | //! The default mode of the translation-binding. |
---|
[3565] | 44 | #define DEFAULT_MODE PNODE_ALL |
---|
[3246] | 45 | |
---|
[3450] | 46 | //! Patent Node is a Engine to calculate the position of an Object in respect to the position of its parent. |
---|
[3365] | 47 | class PNode : public BaseObject { |
---|
| 48 | |
---|
[3246] | 49 | public: |
---|
| 50 | PNode (); |
---|
[3809] | 51 | PNode (const Vector& absCoordinate, PNode* pNode); |
---|
[3365] | 52 | virtual ~PNode (); |
---|
[3246] | 53 | |
---|
[3450] | 54 | PNode* parent; //!< a pointer to the parent node |
---|
| 55 | tList<PNode>* children; //!< list of the children |
---|
[3365] | 56 | |
---|
| 57 | |
---|
[3537] | 58 | |
---|
[3966] | 59 | inline const Vector& getRelCoor () const { return this->relCoordinate; } |
---|
[3810] | 60 | void setRelCoor (const Vector& relCoord); |
---|
[3966] | 61 | inline const Vector& getAbsCoor () const { return this->absCoordinate; } |
---|
[3809] | 62 | void setAbsCoor (const Vector& absCoord); |
---|
| 63 | void shiftCoor (const Vector& shift); |
---|
[3246] | 64 | |
---|
[3966] | 65 | inline const Quaternion& getRelDir () const { return this->relDirection; } |
---|
[3810] | 66 | void setRelDir (const Quaternion& relDir); |
---|
[3966] | 67 | inline const Quaternion& getAbsDir () const { return this->absDirection; } |
---|
[3810] | 68 | void setAbsDir (const Quaternion& absDir); |
---|
[3802] | 69 | void shiftDir (const Quaternion& shift); |
---|
[3246] | 70 | |
---|
[3802] | 71 | float getSpeed() const; |
---|
[3966] | 72 | Vector getVelocity() const; |
---|
[3644] | 73 | |
---|
[3802] | 74 | void addChild (PNode* pNode, int parentingMode = DEFAULT_MODE); |
---|
[3246] | 75 | void removeChild (PNode* pNode); |
---|
[3537] | 76 | void remove(); |
---|
| 77 | |
---|
| 78 | |
---|
[3535] | 79 | void setParent (PNode* parent); |
---|
[3813] | 80 | inline void parentCoorChanged () { this->bRelCoorChanged = true; } |
---|
| 81 | inline void parentDirChanged () { this->bRelDirChanged = true; } |
---|
[3565] | 82 | void setMode (int parentingMode); |
---|
[3811] | 83 | int getMode() const; |
---|
[3246] | 84 | |
---|
[3644] | 85 | virtual void update (float dt); |
---|
[3365] | 86 | void processTick (float dt); |
---|
[3246] | 87 | |
---|
[3966] | 88 | void setName (const char* newName); |
---|
| 89 | const char* getName (); |
---|
[3365] | 90 | |
---|
| 91 | |
---|
| 92 | void debug (); |
---|
| 93 | |
---|
[3521] | 94 | protected: |
---|
[3450] | 95 | float timeStamp; //!< this the timeStamp of when the abs{Coordinat, Direction} has been calculated |
---|
| 96 | char* objectName; //!< The name of the Object |
---|
| 97 | bool bAbsCoorChanged; //!< If Absolute Coordinate has changed since last time we checked |
---|
| 98 | bool bRelCoorChanged; //!< If Relative Coordinate has changed since last time we checked |
---|
| 99 | bool bAbsDirChanged; //!< If Absolute Direction has changed since last time we checked |
---|
| 100 | bool bRelDirChanged; //!< If Relative Direction has changed since last time we checked |
---|
[3365] | 101 | |
---|
[3966] | 102 | Vector relCoordinate; //!< coordinates relative to the parent |
---|
| 103 | Vector absCoordinate; //!< absolute coordinates in the world ( from (0,0,0) ) |
---|
| 104 | Quaternion relDirection; //!< direction relative to the parent |
---|
| 105 | Quaternion absDirection; //!< absolute direvtion in the world ( from (0,0,1) ) |
---|
[3246] | 106 | |
---|
[3565] | 107 | int mode; //!< the mode of the binding |
---|
[3537] | 108 | |
---|
[3644] | 109 | private: |
---|
| 110 | void init(PNode* parent); |
---|
| 111 | |
---|
[3966] | 112 | Vector lastAbsCoordinate; //!< this is used for speedcalculation, it stores the last coordinate |
---|
| 113 | Vector diffCoordinate; //!< this is stored here for performance reasons, difference to the last vector |
---|
[3644] | 114 | float time; //!< time since last update |
---|
[3246] | 115 | }; |
---|
| 116 | |
---|
| 117 | #endif /* _P_NODE_H */ |
---|
[3529] | 118 | |
---|