track.h

Go to the documentation of this file.

/***************************************************************************

    file                 : track.h
    created              : Sun Jan 30 23:00:06 CET 2000
    copyright            : (C) 2000-2024 by Eric Espie, Bernhard Wymann
    email                : berniw@bluewin.ch

 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef _TRACKV1_H_
#define _TRACKV1_H_

#include <tgf.h>
#include <tmath/linalg_t.h>

#define TRK_IDENT   0   /* from 0x01 to 0xFF */

/* Parameters strings for track files */

#define TRK_SECT_HDR    "Header"

#define TRK_ATT_WIDTH   "width"
#define TRK_ATT_SURF    "surface"
#define TRK_ATT_NAME    "name"
#define TRK_ATT_VERSION "version"
#define TRK_ATT_AUTHOR  "author"
#define TRK_ATT_DESCR   "description"
#define TRK_ATT_CAT     "category"

#define TRK_SECT_GRAPH  "Graphic"

#define TRK_ATT_3DDESC  "3d description"
#define TRK_ATT_BKGRND  "background image"
#define TRK_ATT_BKGRND2 "background image2"
#define TRK_ATT_BGTYPE  "background type"
#define TRK_ATT_BGCLR_R "background color R"
#define TRK_ATT_BGCLR_G "background color G"
#define TRK_ATT_BGCLR_B "background color B"
#define TRK_LST_ENV "Environment Mapping"
#define TRK_ATT_ENVNAME "env map image"
#define TRK_ATT_SPEC_R  "specular color R"
#define TRK_ATT_SPEC_G  "specular color G"
#define TRK_ATT_SPEC_B  "specular color B"
#define TRK_ATT_AMBIENT_R   "ambient color R"
#define TRK_ATT_AMBIENT_G   "ambient color G"
#define TRK_ATT_AMBIENT_B   "ambient color B"
#define TRK_ATT_DIFFUSE_R   "diffuse color R"
#define TRK_ATT_DIFFUSE_G   "diffuse color G"
#define TRK_ATT_DIFFUSE_B   "diffuse color B"
#define TRK_ATT_SHIN    "shininess"
#define TRK_ATT_LIPOS_X "light position x"
#define TRK_ATT_LIPOS_Y "light position y"
#define TRK_ATT_LIPOS_Z "light position z"
#define TRK_ATT_FOVFACT "fov factor"

#define TRK_SECT_TURNMARKS "Graphic/Turn Marks"
#define TRK_ATT_HSPACE  "horizontal space"
#define TRK_ATT_VSPACE  "vertical space"

#define TRK_SECT_TERRAIN  "Graphic/Terrain Generation"

#define TRK_ATT_TSTEP   "track step"
#define TRK_ATT_BMARGIN "border margin"
#define TRK_ATT_BSTEP   "border step"
#define TRK_ATT_ORIENT  "orientation"
#define TRK_VAL_CLOCK   "clockwise"
#define TRK_VAL_CCLOCK  "counter-clockwise"
#define TRK_ATT_SURFRAND    "texture randomness"
#define TRK_ATT_RELIEF  "relief file"
#define TRK_ATT_ELEVATION   "elevation map"
#define TRK_ATT_ALT_MAX "maximum altitude"
#define TRK_ATT_ALT_MIN "minimum altitude"
#define TRK_ATT_GRPSZ   "group size"
#define TRK_ATT_OBJMAP  "object map"
#define TRK_ATT_COLOR   "color"
#define TRK_ATT_OBJECT  "object"
#define TRK_ATT_SEED    "random seed"
#define TRK_ATT_ORIENTATION_TYPE "orientation type"
#define TRK_ATT_ORIENTATION "orientation"
#define TRK_ATT_DH  "delta height"
#define TRK_ATT_DV  "delta vert"
#define TRK_SECT_OBJMAP "Object Maps"
#define TRK_SECT_SURFACES "Surfaces"
#define TRK_SECT_OBJECTS  "Objects"

#define TRK_ATT_FRICTION "friction"
#define TRK_ATT_ROLLRES  "rolling resistance"
#define TRK_ATT_ROUGHT   "roughness"
#define TRK_ATT_ROUGHTWL "roughness wavelength"
#define TRK_ATT_DAMMAGE  "dammage"
#define TRK_ATT_REBOUND  "rebound"
#define TRK_ATT_TEXTURE  "texture name"
#define TRK_ATT_BUMPNAME "bump name"
#define TRK_ATT_RACELINENAME "raceline name"
#define TRK_ATT_TEXTYPE  "texture type"
#define TRK_ATT_TEXLINK  "texture link with previous"
#define TRK_ATT_TEXSIZE  "texture size"
#define TRK_ATT_BUMPSIZE "bump size"
#define TRK_ATT_TEXSTARTBOUNDARY "texture start on boundary"
#define TRK_ATT_TEXMIPMAP "texture mipmap"
#define TRK_ATT_R1   "color R1"
#define TRK_ATT_G1   "color G1"
#define TRK_ATT_B1   "color B1"
#define TRK_ATT_R2   "color R2"
#define TRK_ATT_G2   "color G2"
#define TRK_ATT_B2   "color B2"

#define TRK_ATT_STEPLEN "steps length"

#define TRK_VAL_YES "yes"
#define TRK_VAL_NO  "no"

#define TRK_SECT_MAIN   "Main Track"
#define TRK_LST_SEGMENTS    "Track Segments"
#define TRK_ATT_TYPE        "type"
#define TRK_ATT_RLEXT   "raceline ext"
#define TRK_ATT_RLINT   "raceline int"
#define TRK_ATT_RLWIDTHSCALE "raceline widthscale"

#define TRK_VAL_STR     "str"
#define TRK_VAL_LFT     "lft"
#define TRK_VAL_RGT     "rgt"

#define TRK_ATT_LG      "lg"
#define TRK_ATT_RADIUS      "radius"
#define TRK_ATT_RADIUSEND   "end radius"
#define TRK_ATT_ARC     "arc"
#define TRK_ATT_ZS      "z start"
#define TRK_ATT_ZE      "z end"
#define TRK_ATT_ZSL     "z start left"
#define TRK_ATT_ZSR     "z start right"
#define TRK_ATT_ZEL     "z end left"
#define TRK_ATT_ZER     "z end right"
#define TRK_ATT_GRADE       "grade"
#define TRK_ATT_BKS     "banking start"
#define TRK_ATT_BKE     "banking end"
#define TRK_ATT_ID      "id"
#define TRK_ATT_PROFIL      "profil"
#define TRK_ATT_PROFSTEPS   "profil steps"
#define TRK_ATT_PROFSTEPSLEN    "profil steps length"
#define TRK_ATT_PROFTGTS    "profil start tangent"
#define TRK_ATT_PROFTGTE    "profil end tangent"
#define TRK_ATT_PROFTGTSL   "profil start tangent left"
#define TRK_ATT_PROFTGTEL   "profil end tangent left"
#define TRK_ATT_PROFTGTSR   "profil start tangent right"
#define TRK_ATT_PROFTGTER   "profil end tangent right"
#define TRK_ATT_MARKS       "marks"
#define TRK_ATT_ENVMAP      "env map"
#define TRK_ATT_DOVFACTOR   "DoV factor"

#define TRK_SECT_PITS       "Pits"

#define TRK_ATT_ENTRY       "entry"
#define TRK_ATT_EXIT        "exit"
#define TRK_ATT_START       "start"
#define TRK_ATT_END     "end"
#define TRK_ATT_SIDE        "side"
#define TRK_ATT_LEN     "length"
#define TRK_ATT_SPD_LIM     "speed limit"

#define TRK_SECT_LSIDE      "Left Side"
#define TRK_SECT_RSIDE      "Right Side"
#define TRK_SECT_LBORDER    "Left Border"
#define TRK_SECT_RBORDER    "Right Border"
#define TRK_SECT_LBARRIER   "Left Barrier"
#define TRK_SECT_RBARRIER   "Right Barrier"

#define TRK_ATT_SWIDTH      "start width"
#define TRK_ATT_EWIDTH      "end width"
#define TRK_ATT_STYLE       "style"
#define TRK_ATT_HEIGHT      "height"
#define TRK_ATT_BANKTYPE    "banking type"

#define TRK_VAL_PLAN        "plan"
#define TRK_VAL_WALL        "wall"
#define TRK_VAL_CURB        "curb"
#define TRK_VAL_FENCE       "fence"


#define TRK_SECT_CAM        "Cameras"

#define TRK_ATT_SEGMENT     "segment"
#define TRK_ATT_TORIGHT     "to right"
#define TRK_ATT_TOSTART     "to start"
#define TRK_ATT_HEIGHT      "height"
#define TRK_ATT_CAM_FOV     "fov start"
#define TRK_ATT_CAM_FOVE    "fov end"

#define TRK_VAL_ASPHALT     "asphalt"
#define TRK_VAL_CONCRETE    "concrete"
#define TRK_VAL_GRASS       "grass"
#define TRK_VAL_SAND        "sand"
#define TRK_VAL_DIRT        "dirt"
#define TRK_VAL_BARRIER     "barrier"

#define TRK_VAL_LINEAR      "linear"
#define TRK_VAL_SPLINE      "spline"

#define TRK_VAL_TANGENT     "tangent"
#define TRK_VAL_LEVEL       "level"

typedef struct RoadCam
{
    char        *name;
    t3Dd        pos;
    struct RoadCam  *next;
} tRoadCam;

typedef struct SegExt
{
    int     nbMarks;    
    int     *marks;     
} tSegExt;


typedef struct trackSurface {
    struct trackSurface *next;  
    const char *material;       
    tdble kFriction;        
    tdble kRebound;     
    tdble kRollRes;     
    tdble kRoughness;       
    tdble kRoughWaveLen;    
    tdble kDammage;     
} tTrackSurface;



typedef struct trackBarrier {
    int         style;  
    tdble       width;  
    tdble       height; 
    tTrackSurface   *surface; 
    vec2f normal;   // Normal on the vertical track inside pointing towards the track middle.
} tTrackBarrier;


typedef struct trackSeg {
    const char *name;           
    int id;         
    int type;           
#define TR_RGT      1       
#define TR_LFT      2       
#define TR_STR      3       
    int type2;          
#define TR_MAIN     1       
#define TR_LSIDE    2       
#define TR_RSIDE    3       
#define TR_LBORDER  4       
#define TR_RBORDER  5       
    int style;          
#define TR_PLAN     0   
#define TR_CURB     1   
#define TR_WALL     2   
#define TR_FENCE    3   
#define TR_PITBUILDING  4   
    tdble length;       
    tdble width;        
    tdble startWidth;       
    tdble endWidth;     
    tdble lgfromstart;      
    tdble radius;       
    tdble radiusr;      
    tdble radiusl;      
    tdble arc;          
    t3Dd center;        
    t3Dd vertex[4];     
#define TR_SL   0       
#define TR_SR   1       
#define TR_EL   2       
#define TR_ER   3       
    tdble angle[7];     
#define TR_ZS   0       
#define TR_ZE   1       
#define TR_YL   2       
#define TR_YR   3       
#define TR_XS   4       
#define TR_XE   5       
#define TR_CS   6       
    /* constants used to find the height of a point */
    tdble Kzl;      /* long constant */
    tdble Kzw;      /* width constant */
    /* constant used to find the width of a segment */
    tdble   Kyl;        /* find y along x */
    t3Dd    rgtSideNormal;  /* normal to the right side in case of straight segment */
    int     envIndex;   /* Environment mapping image index */

    tdble   height;     
    unsigned int raceInfo;  
#define TR_NORMAL   0x00000000 
#define TR_LAST     0x00000001 
#define TR_START    0x00000002 
#define TR_PITLANE  0x00000004 
#define TR_SPEEDLIMIT   0x00000008 
#define TR_PITENTRY 0x00000010 
#define TR_PITEXIT  0x00000020 
#define TR_PIT      0x00000040 
#define TR_PITSTART 0x00000080 
#define TR_PITEND   0x00000100 
    tdble DoVfactor;            /* the factor to use in calculating DoV for this Seg */

    /* pointers */

    /* optionnal extensions */
    tSegExt     *ext;

    tTrackSurface   *surface; 
    tTrackBarrier   *barrier[2]; 
    tRoadCam        *cam;   /* current camera */
    struct trackSeg *next;  
    struct trackSeg *prev;  
    // Union to avoid code duplication for left/right side cases and to
    // keep compatibility of code. The side definition is so ugly to
    // match the one of the barrier[].
#define TR_SIDE_LFT 1
#define TR_SIDE_RGT 0
    union {
        struct { struct trackSeg *rside, *lside; };
        struct trackSeg* side[2];
    };

} tTrackSeg;

/* selection for local position structure */
#define TR_TORIGHT  0
#define TR_TOMIDDLE 1
#define TR_TOLEFT   2

typedef struct
{
    tTrackSeg   *seg;       
    int     type;       
#define TR_LPOS_MAIN    0   
#define TR_LPOS_SEGMENT 1   
#define TR_LPOS_TRACK   2   
    tdble   toStart;    
    tdble   toRight;    
    tdble   toMiddle;   
    tdble   toLeft;     
} tTrkLocPos;

struct CarElt;

typedef struct TrackOwnPit
{
    tTrkLocPos pos; 
    int pitCarIndex;    
#define TR_PIT_STATE_FREE   -1
#define TR_PIT_MAXCARPERPIT 4       // maximum cars per pit
    tdble lmin; 
    tdble lmax; 
    int freeCarIndex;   // Index of next free car entry (look at the next line).
    struct CarElt   *car[TR_PIT_MAXCARPERPIT];  
} tTrackOwnPit;

typedef struct 
{
    int type;       
#define TR_PIT_NONE     0 
#define TR_PIT_ON_TRACK_SIDE    1 
#define TR_PIT_ON_SEPARATE_PATH 2
    int nMaxPits;   
    int nPitSeg;    
    int side;       
    tdble len;                  
    tdble width;                
    tdble speedLimit;           
    tTrackSeg *pitEntry;        
    tTrackSeg *pitStart;        
    tTrackSeg *pitEnd;          
    tTrackSeg *pitExit;         
    tTrackOwnPit *driversPits;  
    int carsPerPit;
    int driversPitsNb;          
} tTrackPitInfo;

typedef struct
{
    tdble   height;
    tdble   width;
    tdble   hSpace;
    tdble   vSpace;
} tTurnMarksInfo;

typedef struct 
{
    const char *background;
    char        *background2;
    int         bgtype;
    float       bgColor[3];
    int         envnb;
    const char      **env;
    tTurnMarksInfo  turnMarksInfo;
} tTrackGraphicInfo;

typedef struct
{
    const char *name;   
    const char *author; 
    char      *filename;    
    void      *params;  
    char      *internalname; 
    const char *category;   
    int       nseg;     
    int       version;  
    tdble     length;   
    tdble     width;    
    tTrackPitInfo pits;     
    tTrackSeg     *seg;     
    tTrackSurface *surfaces;    
    t3Dd        min;
    t3Dd        max;
    tTrackGraphicInfo   graphic;
} tTrack;


typedef tTrack*(*tfTrackBuild)(char* filename);

typedef tdble(*tfTrackHeightG)(tTrackSeg* seg, tdble X, tdble Y);

typedef tdble(*tfTrackHeightL)(tTrkLocPos* pos);

typedef void(*tfTrackGlobal2Local)(tTrackSeg* seg, tdble X, tdble Y, tTrkLocPos* pos, int type);

typedef void(*tfTrackLocal2Global)(tTrkLocPos* pos, tdble* X, tdble* Y);

typedef void(*tfTrackSideNormal)(tTrackSeg* seg, tdble X, tdble Y, int side, t3Dd* norm);

typedef void(*tfTrackSurfaceNormal)(tTrkLocPos *pos, t3Dd* norm);

typedef void(*tfTrackShutdown)(void);

typedef struct {
    tfTrackBuild            trkBuild;       
    tfTrackBuild            trkBuildEx;     
    tfTrackHeightG          trkHeightG;
    tfTrackHeightL          trkHeightL;
    tfTrackGlobal2Local     trkGlobal2Local;
    tfTrackLocal2Global     trkLocal2Global;
    tfTrackSideNormal       trkSideNormal;
    tfTrackSurfaceNormal    trkSurfaceNormal;
    tfTrackShutdown         trkShutdown;
} tTrackItf;


/* For Type 3 tracks (now obsolete) */

#define TRK_LST_SURF            "List"
#define TRK_LST_CAM         "list"
#define TRK_ATT_PIT_ENTRY       "pit entry"
#define TRK_ATT_PIT_EXIT        "pit exit"
#define TRK_ATT_PIT_START       "pit start"
#define TRK_ATT_PIT_END         "pit end"
#define TRK_ATT_PIT_TYPE        "pit type"
#define TRK_ATT_PIT_SIDE        "pit side"
#define TRK_ATT_PIT_LEN         "pit length"
#define TRK_ATT_PIT_WIDTH       "pit width"

#define TRK_LST_SEG "segments"
#define TRK_ATT_ENVIND  "env map index"


#define TRK_ATT_LST "lside type"
#define TRK_ATT_LSW "lside width"
#define TRK_ATT_LSWS    "lside start width"
#define TRK_ATT_LSWE    "lside end width"
#define TRK_ATT_LSSURF  "lside surface"
#define TRK_ATT_RST "rside type"
#define TRK_ATT_RSW "rside width"
#define TRK_ATT_RSWS    "rside start width"
#define TRK_ATT_RSWE    "rside end width"
#define TRK_ATT_RSSURF  "rside surface"
#define TRK_ATT_LBS "lborder style"
#define TRK_ATT_LBW "lborder width"
#define TRK_ATT_LBH "lborder height"
#define TRK_ATT_LBSURF  "lborder surface"
#define TRK_ATT_RBS "rborder style"
#define TRK_ATT_RBW "rborder width"
#define TRK_ATT_RBH "rborder height"
#define TRK_ATT_RBSURF  "rborder surface"

#define TRK_ATT_BHEIGHT "border height"

#define TRK_ATT_LBAS    "lbarrier style"
#define TRK_ATT_LBAW    "lbarrier width"
#define TRK_ATT_LBAH    "lbarrier height"
#define TRK_ATT_LBAFRCT "lbarrier friction"
#define TRK_ATT_LBASURF "lbarrier surface"
#define TRK_ATT_RBAS    "rbarrier style"
#define TRK_ATT_RBAW    "rbarrier width"
#define TRK_ATT_RBAH    "rbarrier height"
#define TRK_ATT_LBAFRCT "lbarrier friction"
#define TRK_ATT_RBASURF "rbarrier surface"

#define TRK_VAL_PIT_TYPE_NONE       "no pit"
#define TRK_VAL_PIT_TYPE_SIDE       "track side"
#define TRK_VAL_PIT_TYPE_SEP_PATH   "seperate path"

#define TRK_ATT_FINISH  "finish segment"

#endif /* _TRACKV1_H_ */