Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/coord/p_node.h @ 9116

Last change on this file since 9116 was 8711, checked in by bensch, 18 years ago

merged the script_engine back here

File size: 12.3 KB
RevLine 
[4570]1/*!
[5391]2 * @file p_node.h
[6042]3 * @brief Definition of THE Parenting Node
[5391]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
[6042]12 *  o bRelCoorChanged is true (so moved)
13 *  o bRelDirChanged is true (so changed)
[5391]14 *  this conditions make it cheaper to recalculate the tree (reduces redundant work).
15 */
[3246]16
17
18#ifndef _P_NODE_H
19#define _P_NODE_H
20
[3543]21#include "base_object.h"
[6341]22#include "stdincl.h"
[6498]23#include "synchronizeable.h"
[6042]24
[3804]25#include "vector.h"
[6616]26#include "quaternion.h"
[5770]27#include <list>
[3246]28
[5405]29// FORWARD DECLARATION
[4436]30class TiXmlElement;
[3246]31
[5006]32#define PNODE_ITERATION_DELTA    .001
[6054]33
[4765]34//! Parental linkage modes
35typedef enum
36{
[5769]37  // PARENTAL FOLLOWING
[6042]38  PNODE_LOCAL_ROTATE                   = 0x0001,    //!< Rotates all the children around their centers.
39  PNODE_ROTATE_MOVEMENT                = 0x0002,    //!< Moves all the children around the center of their parent, without the rotation around their own centers.
[4765]40
[6042]41  PNODE_MOVEMENT                       = 0x0004,    //!< Moves all children along with the parent.
42  // special linkage modes
43  PNODE_ALL                            = 0x0003,    //!< Moves all children around the center of their parent, and also rotates their centers
44  PNODE_ROTATE_AND_MOVE                = 0x0005,    //!< Rotates all children around their axis, and moves them as the Parent Moves, but does not rotate around the center of their parent.
[3565]45
[5769]46
47  // REPARENTING
[6078]48  PNODE_REPARENT_TO_NULL               = 0x0010,    //!< Reparents to the Null, if the Parent is Removed. Meaning the Node wont have a parent anymore.
[6048]49  PNODE_REPARENT_TO_PARENTS_PARENT     = 0x0020,    //!< Reparents the Node to the parents (old) parent it the parent gets removed.
[6078]50  /////////////////////////////////////////////     //  ELSE: Reparents to the NullParent.
[6042]51  PNODE_REPARENT_DELETE_CHILDREN       = 0x0040,    //!< Deletes the Children of the node when This Node is Removed. (Use with care).
[6054]52  /// FIXME
53   PNODE_REPARENT_KEEP_POSITION         = 0x0080,    //!< Tries to keep the Position if the Node is reparented.
[5769]54
55
56  // DELETION
[6042]57  PNODE_PROHIBIT_CHILD_DELETE          = 0x0100,    //!< Prohibits the Children from being deleted if this Node gets deleted.
58  PNODE_PROHIBIT_DELETE_WITH_PARENT    = 0x0200,    //!< Prohibits the Node to be deleted if the Parent is. Child will be reparented according to the Repaenting-Rules
[6054]59  PNODE_REPARENT_CHILDREN_ON_REMOVE    = 0x0400,    //!< Reparents the Children of the Node if the Node gets Removed.
[6078]60  PNODE_REPARENT_ON_PARENTS_REMOVE     = 0x0800,    //!< The Node gets Reparented if its Parent gets removed. Child will be reparented according to the Reparenting-Rules.
[5769]61
[6042]62  // VISIBILITY/ACTIVITY
63  PNODE_HIDE_CHILDREN_IF_HIDDEN        = 0x1000,    //!< Prohibits the Children from being drawn if this node isn't visible. (used for Draw))
64  PNODE_HIDE_IF_PARENT_HIDDEN          = 0x2000,    //!< Prohibits the node from being drawn if the Parent is invisible.
65  PNODE_UPDATE_CHILDREN_IF_INACTIVE    = 0x4000,    //!< Updates the Children of this Node even if the Parent is Inactive (note if this's parent is inactive children won't be updated.)
66  PNODE_STATIC_NODE                    = 0x8000,    //!< Used for nodes that do not have any moving children, and that do not move.
67
[4765]68} PARENT_MODE;
69
[3450]70//! The default mode of the translation-binding.
[6042]71#define PNODE_PARENT_MODE_DEFAULT PNODE_ALL | \
72                                  PNODE_REPARENT_KEEP_POSITION
[3246]73
[4440]74
[3450]75//! Patent Node is a Engine to calculate the position of an Object in respect to the position of its parent.
[6498]76class PNode : virtual public BaseObject, virtual public Synchronizeable {
[3246]77 public:
[6078]78  PNode (PNode* parent = PNode::getNullParent(), long nodeFlags = PNODE_PARENT_MODE_DEFAULT);
[3365]79  virtual ~PNode ();
[3246]80
[6512]81  virtual void loadParams(const TiXmlElement* root);
[4436]82
[6424]83  void init();
84
[6078]85  // ACTIVATION //
[6142]86  inline void activateNode() { this->bActive = this->bRelCoorChanged = this->bRelDirChanged = true; };
[6054]87  inline void deactivateNode() { this->bActive = false; };
88  inline bool getNodeActiveState() { return this->bActive; };
89
[6078]90  // POSITION //
[3810]91  void setRelCoor (const Vector& relCoord);
[4610]92  void setRelCoor (float x, float y, float z);
[4992]93  void setRelCoorSoft(const Vector& relCoordSoft, float bias = 1.0);
94  void setRelCoorSoft(float x, float y, float z, float bias = 1.0);
[4836]95  /** @returns the relative position */
[5050]96  inline const Vector& getRelCoor () const { return this->prevRelCoordinate; };
[5113]97  /** @returns the Relative Coordinate Destination */
[5915]98  inline const Vector& getRelCoorSoft2D() const { return (this->toCoordinate)? *this->toCoordinate : this->relCoordinate; };
[3809]99  void setAbsCoor (const Vector& absCoord);
[4610]100  void setAbsCoor (float x, float y, float z);
[5406]101  void setAbsCoorSoft(const Vector& absCoordSoft, float bias = 1.0);
102  void setAbsCoorSoft(float x, float y, float z, float bias = 1.0);
[4836]103  /** @returns the absolute position */
[4372]104  inline const Vector& getAbsCoor () const { return this->absCoordinate; };
[8711]105  /** @returns the absolute X coordinate. */
106  inline float getAbsCoorX() { return this->absCoordinate.x; };
107  /** @returns the absolute Y Coordinate */
108  inline float getAbsCoorY() { return this->absCoordinate.y; };
109  /** @returns the absolute Z Coordinate */
110  inline float getAbsCoorZ() { return this->absCoordinate.z; };
111
[8490]112  /** @returns the absolute position */
113  inline const Vector& getLastAbsCoor () const { return this->lastAbsCoordinate; };
[8711]114 
[3809]115  void shiftCoor (const Vector& shift);
[5750]116  void shiftCoor (float x, float y, float z) { this->shiftCoor(Vector(x, y, z)); };
[3246]117
[6078]118  // SPEED //
119  /** @returns the Speed of the Node */
120  inline float getSpeed() const { return this->velocity.len(); };
121  /** @returns the Velocity of the Node */
122  inline const Vector& getVelocity() const { return this->velocity; };
123
124
125  // ROTATION //
[3810]126  void setRelDir (const Quaternion& relDir);
[6873]127  void setRelDir (float angle, float x, float y, float z);
[4992]128  void setRelDirSoft(const Quaternion& relDirSoft, float bias = 1.0);
[6873]129  void setRelDirSoft(float angle, float x, float y, float z, float bias = 1.0);
[4836]130  /** @returns the relative Direction */
[5050]131  inline const Quaternion& getRelDir () const { return this->prevRelDirection; };
[5113]132  /** @returns the Relative Directional Destination */
[5915]133  inline const Quaternion& getRelDirSoft2D() const { return (this->toDirection)? *this->toDirection : this->relDirection; };
[4836]134  /** @returns a Vector pointing into the relative Direction */
[5050]135  inline Vector getRelDirV() const { return this->prevRelDirection.apply(Vector(0,1,0)); };
[3810]136  void setAbsDir (const Quaternion& absDir);
[6873]137  void setAbsDir (float angle, float x, float y, float z);
[5414]138  void setAbsDirSoft(const Quaternion& absDirSoft, float bias = 1.0);
[6873]139  void setAbsDirSoft(float angle, float x, float y, float z, float bias = 1.0);
[5915]140  void shiftDir (const Quaternion& shift);
[4836]141  /** @returns the absolute Direction */
[4372]142  inline const Quaternion& getAbsDir () const { return this->absDirection; };
[4836]143  /** @returns a Vector pointing into the absolute Direction */
[4372]144  inline Vector getAbsDirV() const { return this->absDirection.apply(Vector(0,1,0)); };
[5915]145  /** @returns A Vector pointing into the forward direction (X) of the Node */
146  inline Vector getAbsDirX() const { return this->absDirection.apply(Vector(1,0,0)); };
147  /** @returns A Vector pointing into the upward direction (Y) of the Node */
148  inline Vector getAbsDirY() const { return this->absDirection.apply(Vector(0,1,0)); };
149  /** @returns A Vector pointing into the right direction (Z) of the Node */
150  inline Vector getAbsDirZ() const { return this->absDirection.apply(Vector(0,0,1)); };
[3246]151
[3644]152
[6078]153  // PARENTING //
[5382]154  void addChild (PNode* child);
[7221]155  void addChild (const std::string& childName);
[4993]156  void removeChild (PNode* child);
[5769]157  void removeNode();
[3537]158
[6695]159  PNode* seekNextAssignedPNode(PNode* node) const;
160
[6054]161  /** @param parent the new parent of this node */
[6048]162  inline void setParent (PNode* parent) { parent->addChild(this); };
[7221]163  void setParent (const std::string& parentName);
[4966]164  /** @returns the parent of this PNode */
[5387]165  inline PNode* getParent () const { return this->parent; };
166  /** @returns the List of Children of this PNode */
[6071]167  const std::list<PNode*>& getNodesChildren() const { return this->children; };
[4761]168
[5382]169  void setParentSoft(PNode* parentNode, float bias = 1.0);
[7221]170  void setParentSoft(const std::string& parentName, float bias = 1.0);
[4987]171
[6078]172  // PARENTING_MODE AND OTHER FLAGS //
[6054]173  void setParentMode (PARENT_MODE parentMode);
[7221]174  void setParentMode (const std::string& parentingMode);
[4836]175  /** @returns the Parenting mode of this node */
[6054]176  int getParentMode() const { return 0x000f & this->parentMode; };
[3246]177
[6078]178  void addNodeFlags(unsigned short nodeFlags);
179  void removeNodeFlags(unsigned short nodeFlags);
[6054]180
[6078]181  // NULL_PARENT //
[6074]182  /** @returns the NullParent, the (main) ROOT of the PNode Tree. If it does not yet exist, it will be created. */
[6078]183  static PNode* getNullParent()  { return (PNode::nullParent != NULL)? PNode::nullParent : PNode::createNullParent(); };
[6054]184
[6078]185  // UPDATING //
[5769]186  void updateNode (float dt);
[3246]187
[6078]188  // DEBUG //
[5769]189  void countChildNodes(int& nodes) const;
190  void debugNode (unsigned int depth = 1, unsigned int level = 0) const;
[5383]191  void debugDraw(unsigned int depth = 1, float size = 1.0, const Vector& color = Vector(1, 0, 0), unsigned int level = 0) const;
[3365]192
[6078]193  // HELPER_FUNCTIONS //
[7221]194  static const char* parentingModeToString(int parentingMode);
195  static PARENT_MODE stringToParentingMode(const std::string& parentingMode);
[7076]196  float distance(const PNode* node) const { return (this->getAbsCoor() - node->getAbsCoor()).len(); };
[5750]197
[4440]198 private:
[4987]199  /** tells the child that the parent's Coordinate has changed */
[4440]200  inline void parentCoorChanged () { this->bRelCoorChanged = true; }
[4987]201  /** tells the child that the parent's Direction has changed */
[4440]202  inline void parentDirChanged () { this->bRelDirChanged = true; }
[8186]203 public:
[4836]204  /** @returns the last calculated coordinate */
[4993]205  inline Vector getLastAbsCoor() { return this->lastAbsCoordinate; }
[8186]206 private:
[6078]207  static PNode* createNullParent();
[6048]208  void reparent();
[6075]209  bool checkIntegrity(const PNode* checkParent) const;
[6078]210  void eraseChild(PNode* child);
[3537]211
[3644]212 private:
[5770]213  bool               bRelCoorChanged;    //!< If Relative Coordinate has changed since last time we checked
214  bool               bRelDirChanged;     //!< If Relative Direction has changed since last time we checked
[3644]215
[5770]216  Vector             relCoordinate;      //!< coordinates relative to the parent
217  Vector             absCoordinate;      //!< absolute coordinates in the world ( from (0,0,0) )
218  Quaternion         relDirection;       //!< direction relative to the parent
219  Quaternion         absDirection;       //!< absolute direvtion in the world ( from (0,0,1) )
[4440]220
[5770]221  Vector             prevRelCoordinate;  //!< The last Relative Coordinate from the last update-Cycle.
222  Vector             lastAbsCoordinate;  //!< this is used for speedcalculation, it stores the last coordinate
223  Quaternion         prevRelDirection;   //!< The last Relative Direciton from the last update-Cycle.
224//  Quaternion         lastAbsDirection;
[4440]225
[5770]226  Vector             velocity;           //!< Saves the velocity.
[4987]227
[5770]228  Vector*            toCoordinate;       //!< a position to which to iterate. (This is used in conjunction with setParentSoft.and set*CoorSoft)
229  Quaternion*        toDirection;        //!< a direction to which to iterate. (This is used in conjunction with setParentSoft and set*DirSoft)
230  float              bias;               //!< how fast to iterate to the given position (default is 1)
[4987]231
[6042]232  PNode*             parent;             //!< a pointer to the parent node.
233  std::list<PNode*>  children;           //!< list of the children of this PNode.
[4440]234
[6042]235  bool               bActive;            //!< If the Node is Active (for cutting off the rest of the tree in update).
236  unsigned short     parentMode;         //!< the mode of the binding
[6074]237
238
239  static PNode*      nullParent;         //!< The ROOT of the main PNode Tree.
[6634]240
241  private:
242    float coorx;
243    float coory;
244    float coorz;
245
246    float rotw;
247    float rotx;
248    float roty;
249    float rotz;
[8490]250
[7954]251  private:
252    int relCoordinate_handle;
253    int relDirection_handle;
254    Vector relCoordinate_write;
255    Quaternion relDirection_write;
[8490]256
[7954]257  public:
258    virtual void varChangeHandler( std::list<int> & id );
[3246]259};
260
261#endif /* _P_NODE_H */
Note: See TracBrowser for help on using the repository browser.