src/bzflag/World.cxx

/* bzflag
 * Copyright (c) 1993-2021 Tim Riker
 *
 * This package is free software;  you can redistribute it and/or
 * modify it under the terms of the license found in the file
 * named COPYING that should have accompanied this file.
 *
 * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */

/* interface header */
#include "World.h"

/* system implementation headers */
#include <fstream>
#include <time.h>
#include <assert.h>

/* common implementation headers */
#include "BZDBCache.h"
#include "TextureManager.h"
#include "FileManager.h"
#include "CollisionManager.h"
#include "DynamicColor.h"
#include "TextureMatrix.h"
#include "PhysicsDriver.h"
#include "FlagSceneNode.h"
#include "ObstacleMgr.h"
#include "MeshDrawInfo.h"
#include "MeshDrawMgr.h"
#include "DirectoryNames.h"
#include "GameTime.h"
#include "WallObstacle.h"
#include "MeshObstacle.h"

//
// World
//

World*          World::playingField = NULL;
BundleMgr*      World::bundleMgr;
std::string     World::locale("");
int         World::flagTexture(-1);


World::World() :
    gameType(TeamFFA),
    gameOptions(0),
    linearAcceleration(0.0f),
    angularAcceleration(0.0f),
    maxPlayers(0),
    curMaxPlayers(0),
    maxShots(1),
    maxFlags(0),
    shakeTimeout(),
    shakeWins(),
    players(NULL),
    flags(NULL),
    flagNodes(NULL),
    flagWarpNodes(NULL),
    wind(),
    oldFogEffect(),
    oldUseDrawInfo()
{
    worldWeapons = new WorldPlayer();
    waterLevel = -1.0f;
    waterMaterial = NULL;
    linkMaterial = NULL;
    drawInfoCount = 0;
    drawInfoArray = NULL;
}


World::~World()
{
    int i;
    freeFlags();
    freeInsideNodes();
    freeMeshDrawMgrs();
    for (i = 0; i < curMaxPlayers; i++)
        delete players[i];
    delete[] players;
    delete worldWeapons;
    for (i = 0; i < NumTeams; i++)
        bases[i].clear();

    // clear the managers
    links.clear();
    DYNCOLORMGR.clear();
    TEXMATRIXMGR.clear();
    MATERIALMGR.clear();
    PHYDRVMGR.clear();
    TRANSFORMMGR.clear();
    OBSTACLEMGR.clear();
    COLLISIONMGR.clear();

    return;
}


void            World::init()
{
    TextureManager &tm = TextureManager::instance();
    flagTexture = tm.getTextureID( "flag" );
}

void            World::done()
{
    flagTexture = 0;
}

void            World::loadCollisionManager()
{
    COLLISIONMGR.load();
    return;
}

void            World::checkCollisionManager()
{
    if (COLLISIONMGR.needReload())
    {
        // reload the collision grid
        COLLISIONMGR.load();
    }
    return;
}

void            World::setFlagTexture(FlagSceneNode* flag)
{
    flag->setTexture(flagTexture);
}

void            World::setWorld(World* _playingField)
{
    playingField = _playingField;
}


int World::getTeleportTarget(int source) const
{
    return links.getTeleportTarget(source);
}


int World::getTeleportTarget(int source, unsigned int seed) const
{
    return links.getTeleportTarget(source, seed);
}


int World::getTeleporter(const Teleporter* teleporter, int face) const
{
    // search for teleporter
    const ObstacleList& teleporters = OBSTACLEMGR.getTeles();
    const int count = teleporters.size();
    for (int i = 0; i < count; i++)
    {
        if (teleporter == (const Teleporter*)teleporters[i])
            return ((2 * i) + face);
    }
    printf ("World::getTeleporter() error\n");
    fflush(stdout);
    exit(1);
}


const Teleporter* World::getTeleporter(int source, int& face) const
{
    const ObstacleList& teleporters = OBSTACLEMGR.getTeles();
    if (source >= 0 && source < (int)(2 * teleporters.size()))
    {
        face = (source & 1);
        return ((const Teleporter*) teleporters[source / 2]);
    }
    return NULL;
}


TeamColor       World::whoseBase(const float* pos) const
{
    if (gameType != ClassicCTF)
        return NoTeam;

    for (int i = 1; i < NumTeams; i++)
    {
        for (TeamBases::const_iterator it = bases[i].begin(); it != bases[i].end(); ++it)
        {
            float nx = pos[0] - it->p[0];
            float ny = pos[1] - it->p[1];
            float rx = (float) (cosf(atanf(ny / nx) - it->p[3]) * sqrt((ny * ny) + (nx * nx)));
            float ry = (float) (sinf(atanf(ny / nx) - it->p[3]) * sqrt((ny * ny) + (nx * nx)));
            if (fabsf(rx) < it->p[4] &&
                    fabsf(ry) < it->p[5])
            {
                float nz = it->p[2] + it->p[6];
                float rz = pos[2] - nz;
                if (fabsf(rz) < 0.1)   // epsilon kludge
                    return TeamColor(i);
            }
        }
    }

    return NoTeam;
}

const Obstacle*     World::inBuilding(const float* pos,
                                      float radius, float height) const
{
    // check everything but walls
    const ObsList* olist = COLLISIONMGR.cylinderTest (pos, radius, height);
    for (int i = 0; i < olist->count; i++)
    {
        const Obstacle* obs = olist->list[i];
        if (obs->inCylinder(pos, radius, height))
            return obs;
    }

    return NULL;
}

const Obstacle*     World::inBuilding(const float* pos, float angle,
                                      float dx, float dy, float dz) const
{
    // check everything but the walls
    const ObsList* olist = COLLISIONMGR.boxTest (pos, angle, dx, dy, dz);

    for (int i = 0; i < olist->count; i++)
    {
        const Obstacle* obs = olist->list[i];
        if (obs->inBox(pos, angle, dx, dy, dz))
            return obs;
    }

    return NULL;
}


const Obstacle*     World::hitBuilding(const float* pos, float angle,
                                       float dx, float dy, float dz) const
{
    // check walls
    const ObstacleList& walls = OBSTACLEMGR.getWalls();
    for (unsigned int w = 0; w < walls.size(); w++)
    {
        const WallObstacle* wall = (const WallObstacle*) walls[w];
        if (wall->inBox(pos, angle, dx, dy, dz))
            return wall;
    }

    // check everything else
    const ObsList* olist = COLLISIONMGR.boxTest (pos, angle, dx, dy, dz);

    for (int i = 0; i < olist->count; i++)
    {
        const Obstacle* obs = olist->list[i];
        if (!obs->isDriveThrough() && obs->inBox(pos, angle, dx, dy, dz))
            return obs;
    }

    return NULL;
}


static inline int compareHeights(const Obstacle*& obsA, const Obstacle* obsB)
{
    const Extents& eA = obsA->getExtents();
    const Extents& eB = obsB->getExtents();
    if (eA.maxs[2] > eB.maxs[2])
        return -1;
    else
        return +1;
}

static int compareObstacles(const void* a, const void* b)
{
    // - normal object come first (from lowest to highest)
    // - then come the mesh face (highest to lowest)
    // - and finally, the mesh objects (checkpoints really)
    const Obstacle* obsA = *((const Obstacle* const *)a);
    const Obstacle* obsB = *((const Obstacle* const *)b);
    const char* typeA = obsA->getType();
    const char* typeB = obsB->getType();

    bool isMeshA = (typeA == MeshObstacle::getClassName());
    bool isMeshB = (typeB == MeshObstacle::getClassName());

    if (isMeshA)
    {
        if (!isMeshB)
            return +1;
        else
            return compareHeights(obsA, obsB);
    }

    if (isMeshB)
    {
        if (!isMeshA)
            return -1;
        else
            return compareHeights(obsA, obsB);
    }

    bool isFaceA = (typeA == MeshFace::getClassName());
    bool isFaceB = (typeB == MeshFace::getClassName());

    if (isFaceA)
    {
        if (!isFaceB)
            return +1;
        else
            return compareHeights(obsA, obsB);
    }

    if (isFaceB)
    {
        if (!isFaceA)
            return -1;
        else
            return compareHeights(obsA, obsB);
    }

    return compareHeights(obsB, obsA); // reversed
}

static int compareHitNormal (const void* a, const void* b)
{
    const MeshFace* faceA = *((const MeshFace* const *) a);
    const MeshFace* faceB = *((const MeshFace* const *) b);

    // Up Planes come first
    if (faceA->isUpPlane() && !faceB->isUpPlane())
        return -1;
    if (faceB->isUpPlane() && !faceA->isUpPlane())
        return +1;

    // highest Up Plane comes first
    if (faceA->isUpPlane() && faceB->isUpPlane())
    {
        if (faceA->getPosition()[2] > faceB->getPosition()[2])
            return -1;
        else
            return +1;
    }

    // compare the dot products
    if (faceA->scratchPad < faceB->scratchPad)
        return -1;
    else
        return +1;
}

const Obstacle* World::hitBuilding(const float* oldPos, float oldAngle,
                                   const float* pos, float angle,
                                   float dx, float dy, float dz,
                                   bool directional) const
{
    // check walls
    const ObstacleList& walls = OBSTACLEMGR.getWalls();
    for (unsigned int w = 0; w < walls.size(); w++)
    {
        const WallObstacle* wall = (const WallObstacle*) walls[w];
        if (wall->inMovingBox(oldPos, oldAngle, pos, angle, dx, dy, dz))
            return wall;
    }

    // get the list of potential hits from the collision manager
    const ObsList* olist =
        COLLISIONMGR.movingBoxTest (oldPos, oldAngle, pos, angle, dx, dy, dz);

    // sort the list by type and height
    qsort (olist->list, olist->count, sizeof(Obstacle*), compareObstacles);


    int i;

    // check non-mesh obstacles
    for (i = 0; i < olist->count; i++)
    {
        const Obstacle* obs = olist->list[i];
        const char* type = obs->getType();
        if ((type == MeshFace::getClassName()) ||
                (type == MeshObstacle::getClassName()))
            break;
        if (!obs->isDriveThrough() &&
                obs->inMovingBox(oldPos, oldAngle, pos, angle, dx, dy, dz))
            return obs;
    }
    if (i == olist->count)
    {
        return NULL; // no more obstacles, we are done
    }

    // do some prep work for mesh faces
    int hitCount = 0;
    float vel[3];
    vel[0] = pos[0] - oldPos[0];
    vel[1] = pos[1] - oldPos[1];
    vel[2] = pos[2] - oldPos[2];
    bool goingDown = (vel[2] <= 0.0f);

    // check mesh faces
    for (/* do nothing */; i < olist->count; i++)
    {
        Obstacle* obs = olist->list[i];
        const char* type = obs->getType();
        if (type == MeshObstacle::getClassName())
            break;
        if (!obs->isDriveThrough() &&
                obs->inMovingBox(oldPos, oldAngle, pos, angle, dx, dy, dz))
        {
            const MeshFace* face = (const MeshFace*) obs;
            const float facePos2 = face->getPosition()[2];
            if (face->isUpPlane() &&
                    (!goingDown || (oldPos[2] < (facePos2 - 1.0e-3f))))
                continue;
            else if (face->isDownPlane() && ((oldPos[2] >= facePos2) || goingDown))
                continue;
            else
            {
                // add the face to the hitlist
                olist->list[hitCount] = obs;
                hitCount++;
                // compute its dot product and stick it in the scratchPad
                const float* p = face->getPlane();
                const float dot = (vel[0] * p[0]) + (vel[1] * p[1]) + (vel[2] * p[2]);
                face->scratchPad = dot;
            }
        }
    }
    // sort the list by dot product (this sort will be replaced with a running tab
    qsort (olist->list, hitCount, sizeof(Obstacle*), compareHitNormal);

    // see if there as a valid meshface hit
    if (hitCount > 0)
    {
        const MeshFace* face = (const MeshFace*) olist->list[0];
        if (face->isUpPlane() || (face->scratchPad < 0.0f) || !directional)
            return face;
    }
    if (i == olist->count)
    {
        return NULL; // no more obstacles, we are done
    }

    // check mesh obstacles
    for (/* do nothing */; i < olist->count; i++)
    {
        const Obstacle* obs = olist->list[i];
        if (!obs->isDriveThrough() &&
                obs->inMovingBox(oldPos, oldAngle, pos, angle, dx, dy, dz))
            return obs;
    }

    return NULL; // no more obstacles, we are done
}


bool            World::crossingTeleporter(const float* pos,
        float angle, float dx, float dy, float dz,
        float* plane) const
{
    const ObstacleList& teleporters = OBSTACLEMGR.getTeles();
    for (unsigned int i = 0; i < teleporters.size(); i++)
    {
        const Teleporter* teleporter = (const Teleporter*) teleporters[i];
        if (teleporter->isCrossing(pos, angle, dx, dy, dz, plane))
            return true;
    }
    return false;
}

const Teleporter*   World::crossesTeleporter(const float* oldPos,
        const float* newPos,
        int& face) const
{
    // check teleporters
    const ObstacleList& teleporters = OBSTACLEMGR.getTeles();
    for (unsigned int i = 0; i < teleporters.size(); i++)
    {
        const Teleporter* teleporter = (const Teleporter*) teleporters[i];
        if (teleporter->hasCrossed(oldPos, newPos, face))
            return teleporter;
    }

    // didn't cross
    return NULL;
}

const Teleporter*   World::crossesTeleporter(const Ray& r, int& face) const
{
    // check teleporters
    const ObstacleList& teleporters = OBSTACLEMGR.getTeles();
    for (unsigned int i = 0; i < teleporters.size(); i++)
    {
        const Teleporter* teleporter = (const Teleporter*) teleporters[i];
        if (teleporter->isTeleported(r, face) > Epsilon)
            return teleporter;
    }

    // didn't cross
    return NULL;
}

float           World::getProximity(const float* p, float r) const
{
    // get maximum over all teleporters
    float bestProximity = 0.0;
    const ObstacleList& teleporters = OBSTACLEMGR.getTeles();
    for (unsigned int i = 0; i < teleporters.size(); i++)
    {
        const Teleporter* teleporter = (const Teleporter*) teleporters[i];
        const float proximity = teleporter->getProximity(p, r);
        if (proximity > bestProximity)
            bestProximity = proximity;
    }
    return bestProximity;
}

void            World::freeFlags()
{
    int i;
    if (flagNodes)
        for (i = 0; i < maxFlags; i++)
            delete flagNodes[i];
    if (flagWarpNodes)
        for (i = 0; i < maxFlags; i++)
            delete flagWarpNodes[i];
    delete[] flags;
    delete[] flagNodes;
    delete[] flagWarpNodes;
    flags = NULL;
    flagNodes = NULL;
    flagWarpNodes = NULL;
}

void            World::makeMeshDrawMgrs()
{
    // make the display list managers for source meshes
    std::vector<MeshObstacle*> sourceMeshes;
    OBSTACLEMGR.getSourceMeshes(sourceMeshes);
    unsigned int count = sourceMeshes.size();
    drawInfoArray = new MeshDrawInfo*[count];
    drawInfoCount = 0;
    for (unsigned int i = 0; i < count; i++)
    {
        MeshDrawInfo* di = sourceMeshes[i]->getDrawInfo();
        if ((di != NULL) && !di->isCopy())
        {
            MeshDrawMgr* dm = new MeshDrawMgr(di);
            di->setDrawMgr(dm);
            drawInfoArray[drawInfoCount] = di;
            drawInfoCount++;
        }
    }
    return;
}


void            World::freeMeshDrawMgrs()
{
    for (int i = 0; i < drawInfoCount; i++)
    {
        MeshDrawInfo* di = drawInfoArray[i];
        MeshDrawMgr* dm = di->getDrawMgr();
        delete dm;
        di->setDrawMgr(NULL);
    }
    drawInfoCount = 0;
    delete[] drawInfoArray;
    drawInfoArray = NULL;
    return;
}


void            World::updateAnimations(float UNUSED(dt))
{
    const double gameTime = GameTime::getStepTime();
    for (int i = 0; i < drawInfoCount; i++)
    {
        MeshDrawInfo* di = drawInfoArray[i];
        di->updateAnimation(gameTime);
    }
    return;
}


void            World::freeInsideNodes() const
{
    unsigned int i;
    int j;
    const ObstacleList& boxes = OBSTACLEMGR.getBoxes();
    for (i = 0; i < boxes.size(); i++)
    {
        Obstacle* obs = boxes[i];
        for (j = 0; j < obs->getInsideSceneNodeCount(); j++)
            delete obs->getInsideSceneNodeList()[j];
        obs->freeInsideSceneNodeList();
    }
    const ObstacleList& pyramids = OBSTACLEMGR.getPyrs();
    for (i = 0; i < pyramids.size(); i++)
    {
        Obstacle* obs = pyramids[i];
        for (j = 0; j < obs->getInsideSceneNodeCount(); j++)
            delete obs->getInsideSceneNodeList()[j];
        obs->freeInsideSceneNodeList();
    }
    const ObstacleList& basesR = OBSTACLEMGR.getBases();
    for (i = 0; i < basesR.size(); i++)
    {
        Obstacle* obs = basesR[i];
        for (j = 0; j < obs->getInsideSceneNodeCount(); j++)
            delete obs->getInsideSceneNodeList()[j];
        obs->freeInsideSceneNodeList();
    }
    const ObstacleList& meshes = OBSTACLEMGR.getMeshes();
    for (i = 0; i < meshes.size(); i++)
    {
        Obstacle* obs = meshes[i];
        for (j = 0; j < obs->getInsideSceneNodeCount(); j++)
            delete obs->getInsideSceneNodeList()[j];
        obs->freeInsideSceneNodeList();
    }
    return;
}


void        World::makeLinkMaterial()
{
    const std::string name = "LinkMaterial";

    linkMaterial = MATERIALMGR.findMaterial(name);
    if (linkMaterial != NULL)
        return;

    int dyncolId = DYNCOLORMGR.findColor(name);
    if (dyncolId < 0)
    {
        DynamicColor* dyncol = new DynamicColor;
        dyncol->setLimits(0, 0.0f, 0.25f); // red
        dyncol->setLimits(1, 0.0f, 0.25f); // green
        dyncol->setLimits(2, 0.0f, 0.25f); // blue
        dyncol->setLimits(3, 0.75f, 0.75f); // alpha
        // period, offset, weight
        float params[3] = {2.0f, 0.0f, 1.0f};
        params[1] = 0.0f * (params[0] / 3.0f); // red
        dyncol->addSinusoid(0, params);
        params[1] = 1.0f * (params[0] / 3.0f); // green
        dyncol->addSinusoid(1, params);
        params[1] = 2.0f * (params[0] / 3.0f); // blue
        dyncol->addSinusoid(2, params);
        dyncol->setName(name);
        dyncol->finalize();
        dyncolId = DYNCOLORMGR.addColor (dyncol);
    }

    int texmatId = TEXMATRIXMGR.findMatrix(name);
    if (texmatId < 0)
    {
        TextureMatrix* texmat = new TextureMatrix;
        texmat->setDynamicShift(0.0f, -0.05f);
        texmat->setName(name);
        texmat->finalize();
        texmatId = TEXMATRIXMGR.addMatrix (texmat);
    }

    BzMaterial mat;
    const float color[4] = {0.0f, 0.0f, 0.0f, 0.5f};
    mat.setDiffuse(color);
    mat.setDynamicColor(dyncolId);
    mat.setTexture("telelink");
    mat.setTextureMatrix(texmatId);
    mat.setNoLighting(true);
    mat.setName(name);
    linkMaterial = MATERIALMGR.addMaterial(&mat);

    return;
}


void            World::initFlag(int index)
{
    // make sure the server has not sent us a bogus value.
    if (index >= maxFlags || index < 0)
        return;
    // set color of flag (opaque)
    const float* color = flags[index].type->getColor();
    flagNodes[index]->setColor(color[0], color[1], color[2]);

    // if coming or going then position warp
    Flag& flag = flags[index];
    if (flag.status == FlagComing || flag.status == FlagGoing)
    {
        GLfloat pos[3];
        pos[0] = flag.position[0];
        pos[1] = flag.position[1];
        pos[2] = 0.5f * flag.flightEnd * (flag.initialVelocity +
                                          0.25f * BZDBCache::gravity * flag.flightEnd) + flag.position[2];
        flagWarpNodes[index]->move(pos);
        flagWarpNodes[index]->setSizeFraction(0.0f);
    }
}

void            World::updateWind(float UNUSED(dt))
{
    const float minWindSpeed = 0.0f; // FIXME - BZDB
    const float maxWindSpeed = 10.0f; // FIXME - BZDB

    // pretty cheezy, should be fields and such
    const double gt = GameTime::getStepTime();

    const double oneMinuteFactor = (1.0 / (60.0 * (M_PI * 2.0)));
    const float wsf = (float)(0.5 + (0.5 * cos(gt * 15.0f * oneMinuteFactor)));
    const float windSpeed = ((1.0f - wsf) * minWindSpeed) +
                            (wsf * maxWindSpeed);

    const float windAngle = (float)((M_PI * 2.0) *
                                    (cos(gt * 3.0f * oneMinuteFactor) +
                                     cos(gt * 10.0f * oneMinuteFactor)));

    wind[0] = windSpeed * cosf(windAngle);
    wind[1] = windSpeed * sinf(windAngle);
    wind[2] = 0.0f;
}

void            World::updateFlag(int index, float dt)
{
    if (!flagNodes) return;
    const GLfloat* color = flagNodes[index]->getColor();
    GLfloat alpha = color[3];
    Flag& flag = flags[index];

    switch (flag.status)
    {
    default:
        // do nothing (don't move cos either it's not moving or we
        // don't know the position to move it to)
        break;

    case FlagInAir:
        flag.flightTime += dt;
        if (flag.flightTime >= flag.flightEnd)
        {
            // touchdown
            flag.status = FlagOnGround;
            flag.position[0] = flag.landingPosition[0];
            flag.position[1] = flag.landingPosition[1];
            flag.position[2] = flag.landingPosition[2];
        }
        else
        {
            // still flying
            float t = flag.flightTime / flag.flightEnd;
            flag.position[0] = (1.0f - t) * flag.launchPosition[0] +
                               t * flag.landingPosition[0];
            flag.position[1] = (1.0f - t) * flag.launchPosition[1] +
                               t * flag.landingPosition[1];
            flag.position[2] = (1.0f - t) * flag.launchPosition[2] +
                               t * flag.landingPosition[2] +
                               flag.flightTime * (flag.initialVelocity +
                                                  0.5f * BZDBCache::gravity * flag.flightTime);
        }
        break;

    case FlagComing:
        flag.flightTime += dt;
        if (flag.flightTime >= flag.flightEnd)
        {
            // touchdown
            flag.status = FlagOnGround;
            flag.position[2] = 0.0f;
            alpha = 1.0f;
        }
        else if (flag.flightTime >= 0.5f * flag.flightEnd)
        {
            // falling
            flag.position[2] = flag.flightTime * (flag.initialVelocity +
                                                  0.5f * BZDBCache::gravity * flag.flightTime) + flag.landingPosition[2];
            alpha = 1.0f;
        }
        else
        {
            // hovering
            flag.position[2] = 0.5f * flag.flightEnd * (flag.initialVelocity +
                               0.25f * BZDBCache::gravity * flag.flightEnd) + flag.landingPosition[2];

            // flag is fades in during first half of hovering period
            // and is opaque during the second half.  flag warp grows
            // to full size during first half, and shrinks to nothing
            // during second half.
            if (flag.flightTime >= 0.25f * flag.flightEnd)
            {
                // second half
                float t = (flag.flightTime - 0.25f * flag.flightEnd) /
                          (0.25f * flag.flightEnd);
                alpha = 1.0f;
                flagWarpNodes[index]->setSizeFraction(1.0f - t);
            }
            else
            {
                // first half
                float t = flag.flightTime / (0.25f * flag.flightEnd);
                alpha = t;
                flagWarpNodes[index]->setSizeFraction(t);
            }
        }
        break;

    case FlagGoing:
        flag.flightTime += dt;
        if (flag.flightTime >= flag.flightEnd)
        {
            // all gone
            flag.status = FlagNoExist;
        }
        else if (flag.flightTime < 0.5f * flag.flightEnd)
        {
            // rising
            flag.position[2] = flag.flightTime * (flag.initialVelocity +
                                                  0.5f * BZDBCache::gravity * flag.flightTime) + flag.landingPosition[2];
            alpha = 1.0f;
        }
        else
        {
            // hovering
            flag.position[2] = 0.5f * flag.flightEnd * (flag.initialVelocity +
                               0.25f * BZDBCache::gravity * flag.flightEnd) + flag.landingPosition[2];

            // flag is opaque during first half of hovering period
            // and fades out during the second half.  flag warp grows
            // to full size during first half, and shrinks to nothing
            // during second half.
            if (flag.flightTime < 0.75f * flag.flightEnd)
            {
                // first half
                float t = (0.75f * flag.flightEnd - flag.flightTime) /
                          (0.25f * flag.flightEnd);
                alpha = 1.0f;
                flagWarpNodes[index]->setSizeFraction(1.0f - t);
            }
            else
            {
                // second half
                float t = (flag.flightEnd - flag.flightTime) /
                          (0.25f * flag.flightEnd);
                alpha = t;
                flagWarpNodes[index]->setSizeFraction(t);
            }
        }
        break;
    }

    // update alpha if changed
    if (alpha != color[3])
        flagNodes[index]->setColor(color[0], color[1], color[2], alpha);

    // move flag scene node
    flagNodes[index]->move(flags[index].position);

    // setup the flag angle
    if (flag.status != FlagOnTank)
    {
        flagNodes[index]->setWind(wind, dt);
        flagNodes[index]->setBillboard(true);
    }
    else
    {
        const Player* flagPlayer = NULL;
        for (int i = 0; i < curMaxPlayers; i++)
        {
            const Player* p = players[i];
            if (p && p->getId() == flag.owner)
            {
                flagPlayer = p;
                break;
            }
        }
        if (flagPlayer != NULL)
        {
            if (flag.type == Flags::Narrow)
            {
                flagNodes[index]->setAngle(flagPlayer->getAngle());
                flagNodes[index]->setBillboard(false);
            }
            else
            {
                float myWind[3];
                getWind(myWind, flagPlayer->getPosition());
                const float* vel = flagPlayer->getVelocity();
                myWind[0] -= vel[0];
                myWind[1] -= vel[1];
                if (flagPlayer->isFalling())
                    myWind[2] -= vel[2];
                flagNodes[index]->setWind(myWind, dt);
                flagNodes[index]->setBillboard(true);
            }
        }
        else
        {
            flagNodes[index]->setWind(wind, dt); // assumes homogeneous wind
            flagNodes[index]->setBillboard(true);
        }
    }
}

void            World::addFlags(SceneDatabase* scene, bool seerView)
{
    if (!flagNodes) return;
    for (int i = 0; i < maxFlags; i++)
    {
        // if not showing flags, only allow FlagOnTank through
        if (flags[i].status != FlagOnTank && !BZDBCache::displayMainFlags)
            continue;

        if (flags[i].status == FlagNoExist) continue;
        // skip flag on a tank that isn't alive. also skip
        // Cloaking flag on a tank if we don't have a Seer flag.
        if (flags[i].status == FlagOnTank)
        {
            if ((flags[i].type == Flags::Cloaking) && !seerView)
                continue;
            int j;
            for (j = 0; j < curMaxPlayers; j++)
                if (players[j] && players[j]->getId() == flags[i].owner)
                    break;

            if (j < curMaxPlayers && !(players[j]->getStatus() & PlayerState::Alive))
                continue;
        }

        scene->addDynamicNode(flagNodes[i]);

        // add warp if coming/going and hovering
        if ((flags[i].status == FlagComing &&
                flags[i].flightTime < 0.5 * flags[i].flightEnd) ||
                (flags[i].status == FlagGoing &&
                 flags[i].flightTime >= 0.5 * flags[i].flightEnd))
            scene->addDynamicNode(flagWarpNodes[i]);
    }
}


static std::string indent = "";


static void writeDefaultOBJMaterials(std::ostream& out)
{
    typedef struct
    {
        const char* name;
        const char* texture;
        float color[4];
    } MatProps;
    const MatProps defaultMats[] =
    {
        {"std_ground",  "std_ground.png",   {0.5f, 0.5f, 0.5f, 1.0f}},
        {"boxtop",      "roof.png",     {1.0f, 1.0f, 0.9f, 1.0f}},
        {"boxwall",     "boxwall.png",      {1.0f, 0.9f, 0.8f, 1.0f}},
        {"pyrwall",     "pyrwall.png",      {0.8f, 0.8f, 1.0f, 1.0f}},
        {"telefront",   "telelink.png",     {1.0f, 0.0f, 0.0f, 0.5f}},
        {"teleback",    "telelink.png",     {0.0f, 1.0f, 0.0f, 0.5f}},
        {"telerim",     "caution.png",      {1.0f, 1.0f, 0.0f, 0.5f}},
        {"basetop_team1",   "red_basetop.png",  {1.0f, 0.8f, 0.8f, 1.0f}},
        {"basewall_team1",  "red_basewall.png", {1.0f, 0.8f, 0.8f, 1.0f}},
        {"basetop_team2",   "green_basetop.png",    {0.8f, 1.0f, 0.8f, 1.0f}},
        {"basewall_team2",  "green_basewall.png",   {0.8f, 1.0f, 0.8f, 1.0f}},
        {"basetop_team3",   "blue_basetop.png", {0.8f, 0.8f, 1.0f, 1.0f}},
        {"basewall_team3",  "blue_basewall.png",    {0.8f, 0.8f, 1.0f, 1.0f}},
        {"basetop_team4",   "purple_basetop.png",   {1.0f, 0.8f, 1.0f, 1.0f}},
        {"basewall_team4",  "purple_basewall.png",  {1.0f, 0.8f, 1.0f, 1.0f}}
    };
    const int count = sizeof(defaultMats) / sizeof(defaultMats[0]);
    BzMaterial mat;
    for (int i = 0; i < count; i++)
    {
        const MatProps& mp = defaultMats[i];
        mat.setName(mp.name);
        mat.setTexture(mp.texture);
        mat.setDiffuse(mp.color);
        mat.printMTL(out, "");
    }
    return;
}


static void writeOBJGround(std::ostream& out)
{
    const float ws = BZDBCache::worldSize / 2.0f;
    const float ts = BZDBCache::worldSize / 100.0f;
    out << "o bzground" << std::endl;
    out << "v " << -ws << " " << -ws << " 0" << std::endl;
    out << "v " << +ws << " " << -ws << " 0" << std::endl;
    out << "v " << +ws << " " << +ws << " 0" << std::endl;
    out << "v " << -ws << " " << +ws << " 0" << std::endl;
    out << "vt " << -ts << " " << -ts << std::endl;
    out << "vt " << +ts << " " << -ts << std::endl;
    out << "vt " << +ts << " " << +ts << std::endl;
    out << "vt " << -ts << " " << +ts << std::endl;
    out << "vn 0 0 1" << std::endl;
    out << "usemtl std_ground" << std::endl;
    out << "f -4/-4/-1 -3/-3/-1 -2/-2/-1 -1/-1/-1" << std::endl;
    out << std::endl;
    return;
}


static void writeBZDBvar (const std::string& name, void *userData)
{
    std::ofstream& out = *((std::ofstream*)userData);
    if ((BZDB.getPermission(name) == StateDatabase::Server)
            && (BZDB.get(name) != BZDB.getDefault(name))
            && (name != "poll"))
    {
        std::string qmark = "";
        if (BZDB.get(name).find(' ') != std::string::npos)
            qmark = '"';
        out << indent << "  -set " << name << " "
            << qmark << BZDB.get(name) << qmark << std::endl;
    }
    return;
}


bool World::writeWorld(const std::string& filename, std::string& fullname)
{
    const bool saveAsOBJ = BZDB.isTrue("saveAsOBJ");
    if (saveAsOBJ)
        indent = "# ";
    else
        indent = "";

    fullname = getWorldDirName();
    fullname += filename;
    if (saveAsOBJ)
    {
        if (strstr(fullname.c_str(), ".obj") == NULL)
            fullname += ".obj";
    }
    else
    {
        if (strstr(fullname.c_str(), ".bzw") == NULL)
            fullname += ".bzw";
    }

    std::ostream *stream = FILEMGR.createDataOutStream(fullname.c_str());
    if (stream == NULL)
        return false;

    // for notational convenience
    std::ostream& out = *stream;

    time_t nowTime = time (NULL);
    out << "# BZFlag client: saved world on " << ctime(&nowTime) << std::endl;

    // Write the Server Options
    {
        out << indent << "options" << std::endl;

        // FIXME - would be nice to get a few other thing
        //   -fb, -sb, rabbit style, a real -mp, etc... (also, flags?)

        if (allowTeamFlags())
        {
            out << indent << "  -c" << std::endl;
            out << indent << "  -mp 2,";
            for (int t = RedTeam; t <= PurpleTeam; t++)
            {
                if (getBase(t, 0) != NULL)
                    out << "2,";
                else
                    out << "0,";
            }
            out << "2" << std::endl;
        }
        if (allowRabbit())
            out << indent << "  -rabbit" << std::endl;
        if (allowJumping())
            out << indent << "  -j" << std::endl;
        if (allShotsRicochet())
            out << indent << "  +r" << std::endl;
        if (allowHandicap())
            out << indent << "  -handicap" << std::endl;
        if (allowAntidote())
        {
            out << indent << "  -sa" << std::endl;
            out << indent << "  -st " << getFlagShakeTimeout() << std::endl;
            out << indent << "  -sw " << getFlagShakeWins() << std::endl;
        }
        if ((getLinearAcceleration() != 0.0f) ||
                (getAngularAcceleration() != 0.0f))
        {
            out << indent << "  -a " << getLinearAcceleration() << " "
                << getAngularAcceleration() << std::endl;
        }

        out << indent << "  -ms " << getMaxShots() << std::endl;

        // Write BZDB server variables that aren't defaults
        BZDB.iterate (writeBZDBvar, &out);

        out << indent << "end" << std::endl << std::endl;
    }

    // Write World object
    {
        float worldSize = BZDBCache::worldSize;
        float flagHeight = BZDB.eval(StateDatabase::BZDB_FLAGHEIGHT);
        if ((worldSize != atof(BZDB.getDefault(StateDatabase::BZDB_WORLDSIZE).c_str()))
                ||  (flagHeight != atof(BZDB.getDefault(StateDatabase::BZDB_FLAGHEIGHT).c_str())))
        {
            out << indent << "world" << std::endl;
            if (worldSize != atof(BZDB.getDefault(StateDatabase::BZDB_WORLDSIZE).c_str()))
                out << indent << "  size " << worldSize / 2.0f << std::endl;
            if (flagHeight != atof(BZDB.getDefault(StateDatabase::BZDB_FLAGHEIGHT).c_str()))
                out << indent << "  flagHeight " << flagHeight << std::endl;
            out << indent << "end" << std::endl << std::endl;
        }
    }

    // Write dynamic colors
    DYNCOLORMGR.print(out, indent);

    // Write texture matrices
    TEXMATRIXMGR.print(out, indent);

    // Write materials
    if (!saveAsOBJ)
        MATERIALMGR.print(out, indent);
    else
    {
        const std::string mtlname = filename + ".mtl";
        const std::string mtlfile = getWorldDirName() + mtlname;
        std::ostream* mtlStream = FILEMGR.createDataOutStream(mtlfile.c_str());
        if (mtlStream != NULL)
        {
            out << "mtllib " << mtlname << std::endl; // index the mtl file
            out << std::endl;
            *mtlStream << "# BZFlag client: saved world on " << ctime(&nowTime);
            *mtlStream << std::endl;
            writeDefaultOBJMaterials(*mtlStream);
            MATERIALMGR.printMTL(*mtlStream, "");
            delete mtlStream;
        }
    }

    // Write physics drivers
    PHYDRVMGR.print(out, indent);

    // Write obstacle transforms
    TRANSFORMMGR.print(out, indent);

    // Write water level
    {
        if (waterLevel >= 0.0f)
        {
            out << indent << "waterLevel" << std::endl;
            out << indent << "  height " << waterLevel << std::endl;
            out << indent << "  matref ";
            MATERIALMGR.printReference(out, waterMaterial);
            out << std::endl;
            out << indent << "end" << std::endl << std::endl;
        }
    }

    // Write the world obstacles
    {
        if (saveAsOBJ)
            writeOBJGround(out);
        OBSTACLEMGR.print(out, indent);
    }

    // Write links
    {
        links.print(out, indent);
    }

    // Write weapons
    {
        for (std::vector<Weapon>::iterator it = weapons.begin();
                it != weapons.end(); ++it)
        {
            Weapon weapon = *it;
            out << indent << "weapon" << std::endl;
            if (weapon.type != Flags::Null)
                out << indent << "  type " << weapon.type->flagAbbv << std::endl;
            out << indent << "  position " << weapon.pos[0] << " " << weapon.pos[1] << " "
                << weapon.pos[2] << std::endl;
            out << indent << "  rotation " << ((weapon.dir * 180.0) / M_PI) << std::endl;
            out << indent << "  initdelay " << weapon.initDelay << std::endl;
            if (!weapon.delay.empty())
            {
                out << indent << "  delay";
                for (std::vector<float>::iterator dit = weapon.delay.begin();
                        dit != weapon.delay.end(); ++dit)
                    out << " " << (float)*dit;
                out << std::endl;
            }
            out << indent << "end" << std::endl << std::endl;
        }
    }

    // Write entry zones
    {
        for (std::vector<EntryZone>::iterator it = entryZones.begin();
                it != entryZones.end(); ++it)
        {
            EntryZone zone = *it;
            out << indent << "zone" << std::endl;
            out << indent << "  position " << zone.pos[0] << " " << zone.pos[1] << " "
                << zone.pos[2] << std::endl;
            out << indent << "  size " << zone.size[0] << " " << zone.size[1] << " "
                << zone.size[2] << std::endl;
            out << indent << "  rotation " << ((zone.rot * 180.0) / M_PI) << std::endl;
            if (!zone.flags.empty())
            {
                out << indent << "  flag";
                std::vector<FlagType*>::iterator fit;
                for (fit = zone.flags.begin(); fit != zone.flags.end(); ++fit)
                    out << " " << (*fit)->flagAbbv;
                out << std::endl;
            }
            if (!zone.teams.empty())
            {
                out << indent << "  team";
                std::vector<TeamColor>::iterator tit;
                for (tit = zone.teams.begin(); tit != zone.teams.end(); ++tit)
                    out << " " << (*tit);
                out << std::endl;
            }
            if (!zone.safety.empty())
            {
                out << indent << "  safety";
                std::vector<TeamColor>::iterator sit;
                for (sit = zone.safety.begin(); sit != zone.safety.end(); ++sit)
                    out << " " << (*sit);
                out << std::endl;
            }
            out << indent << "end" << std::endl << std::endl;
        }
    }

    delete stream;

    return true;
}

static void drawLines (int count, float (*vertices)[3], int color)
{
    const float colors[][4] =
    {
        { 0.25f, 0.25f, 0.25f, 0.8f }, // gray    (branch node)
        { 0.25f, 0.25f, 0.0f,  0.8f }, // yellow  (regular)
        { 0.0f,  0.25f, 0.25f, 0.8f }, // cyan    (meshed)
        { 0.25f, 0.0f,  0.25f, 0.8f }, // purple  (meshed + regular)
    };
    const int colorCount = sizeof(colors) / sizeof(colors[0]);

    if (color < 0)
        color = 0;
    else if (color >= colorCount)
        color = colorCount - 1;
    glColor4fv (colors[color]);

    glBegin (GL_LINE_STRIP);
    for (int i = 0; i < count; i++)
        glVertex3fv (vertices[i]);
    glEnd ();

    return;
}


static void drawInsideOutsidePoints()
{
    std::vector<const float*> insides;
    std::vector<const float*> outsides;

    const ObstacleList& meshes = OBSTACLEMGR.getMeshes();
    for (unsigned int i = 0; i < meshes.size(); i++)
    {
        const MeshObstacle* mesh = (const MeshObstacle*) meshes[i];
        const int    checkCount  = mesh->getCheckCount();
        const char*  checkTypes  = mesh->getCheckTypes();
        const afvec3* checkPoints = mesh->getCheckPoints();
        for (int c = 0; c < checkCount; c++)
        {
            switch (checkTypes[c])
            {
            case MeshObstacle::CheckInside:
            {
                insides.push_back(checkPoints[c]);
                break;
            }
            case MeshObstacle::CheckOutside:
            {
                outsides.push_back(checkPoints[c]);
                break;
            }
            default:
            {
                break;
            }
            }
        }
    }

    glPushAttrib(GL_DEPTH_BUFFER_BIT | GL_POINT_BIT | GL_LINE_BIT);

    glDisable(GL_DEPTH_TEST);
    glEnable(GL_POINT_SMOOTH);
    glEnable(GL_LINE_SMOOTH);
    glLineWidth(1.49f);
    glPointSize(4.49f);

    glBegin(GL_POINTS);
    {
        glColor4f(0.0f, 1.0f, 0.0f, 0.8f);
        for (size_t i = 0; i < insides.size(); i++)
            glVertex3fv(insides[i]);
        glColor4f(1.0f, 0.0f, 0.0f, 0.8f);
        for (size_t i = 0; i < outsides.size(); i++)
            glVertex3fv(outsides[i]);
    }
    glEnd();

    glBegin(GL_LINES);
    {
        glColor4f(0.0f, 1.0f, 0.0f, 0.2f);
        for (size_t i = 0; i < insides.size(); i++)
        {
            glVertex3f(insides[i][0], insides[i][1], 0.0f);
            glVertex3fv(insides[i]);
        }
        glColor4f(1.0f, 0.0f, 0.0f, 0.2f);
        for (size_t i = 0; i < outsides.size(); i++)
        {
            glVertex3f(outsides[i][0], outsides[i][1], 0.0f);
            glVertex3fv(outsides[i]);
        }
    }
    glEnd();

    glPopAttrib();
}


void World::drawCollisionGrid() const
{
    GLboolean usingTextures;

    glGetBooleanv (GL_TEXTURE_2D, &usingTextures);
    glDisable (GL_TEXTURE_2D);

    COLLISIONMGR.draw (&drawLines);

    drawInsideOutsidePoints();

    if (usingTextures)
        glEnable (GL_TEXTURE_2D);

    return;
}

RemotePlayer* World::getCurrentRabbit() const
{
    if (players == NULL)
        return NULL;
    for (int i = 0; i < curMaxPlayers; i++)
    {
        RemotePlayer* p = players[i];
        if (p && p->isAlive() && (p->getTeam() == RabbitTeam))
            return p;
    }
    return NULL;
}


// Local Variables: ***
// mode: C++ ***
// tab-width: 4 ***
// c-basic-offset: 4 ***
// indent-tabs-mode: nil ***
// End: ***
// ex: shiftwidth=4 tabstop=4