---

path.h

Go to the documentation of this file.

#ifndef __PATH_H
#define __PATH_H

// path flags
#define  PATH_LEVEL            (1<<0) // path is relative to (0,0) of level
#define  PATH_LOOPING          (1<<1) // looping (last pt = 1st pt)

// path endpoint flags
#define  PATHEND_RAND_SELECT   (1<<0) // select random connection
#define  PATHEND_BOUNCE        (1<<1) // bounce back in other direction

// path endpoint identification
#define  AT_NONE   0
#define  AT_BEG    1
#define  AT_END    2

// convenient bundle for path interactions
struct TraverseDetails;
class Object;

struct PathTableRow
{
  float d;       // distance along path
  float x, y;
};

typedef float PathDist;

struct PathMark
{
  int   pt;    // pt index that the mark annotates.
  int   id;    // bus mark signal #, or -1 if speed recommendation
  float speed; // recommended speed at path point (if id is -1)
};

class Path // path information
{
private:
  string name;          
  int id;               
  int flags;            
  int num_pts;
  int num_dists;
  int num_marks;
  Path **pts;
  Path **dists;
  PathMark *marks;      
  int end_flags;        
  int beg_flags;        
  int num_ptsdists;
  int path_flags;
  int table_size;
  PathTableRow* table;
  // Recommended paths:
  // If PATHEND_RAND_SELECT isn't on, then recommendations
  // are suggested to the path traverser when it reaches the
  // endpoint. The traverser can accept the recommendation,
  // or it can ignore it, and choose another path.
  // calculated
  float path_length; 
  int num_end_cxs;      
  int num_beg_cxs;      
  Path **end_cxs;       
  Path **beg_cxs;       
  Path *end_rec;        
  Path *beg_rec;        
public:
  Path( ifstream *f, int _id );         
  ~Path(void);
  // converts d to (x,y) coordinates
  // * d assumed to be in range [0,maxlength)
  //
  //      d  ---.______,--> x
  //            /     |---> y
  //      i  --'      `---> i
  void DtoXY( TraverseDetails* );
  // corrects a distance value "d"
  // into range [0,maxlength)
  void CorrectD( float* d );
  // Calculate a new "d" for a traverser,
  // stopping for end points.
  //
  //      d  ---.______,--> d
  //            /     |---> reminder
  //      dd --'      `---> end
  //
  // Returns true if attempting to go off an end.
  bool Traverse( TraverseDetails* );
  // Flip a traverser on a looping path's end.
  // Remainder -> dd.
  //
  //       end ---.______,--> end         (flipped)
  //              /     |---> d           (0 or path_length)
  //  reminder -'      `---> dd          (loaded w/ reminder)
  //                     `--> reminder   (zero'ed)
  void PerformLoop( TraverseDetails* );
  // Bounce a traverser, if bouncing flag present.
  // Remainder -> dd.
  //
  //       end ---.______,--> dd          (loaded w/ reminder)
  //  reminder --'      `--> reminder   (zero'ed)
  void PerformBounce( TraverseDetails* );
  // Snap a traverser to an end.
  // Remainder -> dd.
  //
  //      x ---._____,---> end         (AT_BEG or AT_END)
  //      y ---'     |---> i           (0 or table_size-1)
  //                 |---> d           (0 or path_length)
  //                 `---> dd          (loaded w/ reminder)
  //                  `--> reminder   (zero'ed)
  void SnapToEnd( TraverseDetails* );
  //TODO find implementation of that method
  void MoveTraverser(Object *obj, float speed);
  int GetNumEndCXS();
  int GetNumBegCXS();
  void SetEndCXS( int indx, Path *end_cxs_val );
  Path *GetEndCXS( int indx );
  void SetBegCXS( int indx, Path *beg_cxs_val );
  Path *GetBegCXS( int indx );
  void SetEndREC( Path *_end_rec );
  Path *GetEndREC();
  void SetBegREC( Path *_end_rec );
  Path *GetBegREC();
};

class TraverseDetails
{
private: 
  Path* path;           
  int table_index;
  int i;                
  double d;             
  float reminder;       
  float x, y;           
  int end;              
  float dd;             
public:  
  TraverseDetails( Path* _path );
  int GetI();
  void SetI( int _i );
  double GetD();
  void SetD( double _d );
  float GetReminder();
  void SetReminder( float _der );
  float GetX();
  void SetX( float _x );
  float GetY();
  void SetY( float _y );
  float GetDD();
  void SetDD( float _dd );
  int GetEnd();
  void SetEnd( int _end );
};

#endif // __PATH_H

---