linmove.h

Go to the documentation of this file.

/*
  Crystal Space Entity Layer
  Copyright (C) 2001 PlaneShift Team ([email protected],
  Copyright (C) 2001-2003 by Jorrit Tyberghein

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

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public
  License along with this library; if not, write to the Free
  Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

/*
 * This code is heavily based on pslinmove from the PlaneShift project.
 * Thanks a lot for making this!
 */

#ifndef __CEL_PF_LINEAR_MOVE_FACT__
#define __CEL_PF_LINEAR_MOVE_FACT__

//CS Includes
#include "cstypes.h"
#include "iutil/comp.h"
#include "iutil/eventh.h"
#include "csutil/scf.h"
#include "csutil/stringarray.h"
#include "cstool/collider.h"
#include "ivaria/collider.h"
#include "csutil/sysfunc.h"
#include "colldet.h"

#define PS_LINMOVE_FOLLOW_ONLY_PORTALS true

#define PS_MOVE_FAIL 0
#define PS_MOVE_SUCCEED 1
#define PS_MOVE_PARTIAL 2
#define PS_MOVE_DONTMOVE 3

struct iObjectRegistry;
struct iVirtualClock;
struct iCollider;
struct iCollideSystem;
struct iSector;
class csReversibleTransform;
class csObject;
class csColliderWrapper;
struct iPath;
class psCollisionDetection;

/* Max deviation before we need to send
   a new DR packet */
#define PSLINEARMOVEMENT_DRDELTA 0.2


class psLinearMovement
{
public:
    psLinearMovement(iObjectRegistry* object_reg);
    virtual ~psLinearMovement();

    virtual void SetAngularVelocity(const csVector3 &angle);
    virtual void SetAngularVelocity(const csVector3 &angle, const csVector3 &angle_to_reach);

    virtual void SetVelocity(const csVector3 &vel);

    virtual void AddVelocity(const csVector3 &vel);

    virtual void ClearWorldVelocity();

    virtual void GetVelocity(csVector3 &v) const;

    virtual const csVector3 GetVelocity() const;


    virtual bool RotateV(float delta);

    virtual const csVector3 GetAngularVelocity() const;
    virtual void GetAngularVelocity(csVector3 &v) const;

    virtual bool InitCD(const csVector3 &body, const csVector3 &legs, const csVector3 &shift, iMeshWrapper* mesh);
    virtual void GetCDDimensions(csVector3 &body, csVector3 &legs, csVector3 &shift);

    virtual float GetYRotation() const;
    virtual void SetYRotation(float yrot);
    const csVector3 GetPosition() const;
    const csVector3 GetFullPosition() const;

    void SetScale(float set_scale)
    {
        scale = set_scale;
    }

    virtual void GetLastPosition(csVector3 &pos, float &yrot, iSector* &sector) const;
    virtual void GetLastFullPosition(csVector3 &pos, float &yrot, iSector* &sector);
    virtual void SetPosition(const csVector3 &pos, float yrot, const iSector* sector);
    virtual void SetFullPosition(const csVector3 &pos, float yrot, const iSector* sector);
    virtual void SetPosition(const char* center_name, float yrot, iSector* sector);
    virtual void SetFullPosition(const char* center_name, float yrot, iSector* sector);
    virtual void GetLastClientPosition(csVector3 &pos, float &yrot, iSector* &sector);

    virtual bool IsOnGround() const;

    virtual void SetOnGround(bool onground);


    virtual void SetHugGround(bool hugGround);

    virtual void SetGravity(float grav);

    virtual float GetGravity();

    virtual void ResetGravity();

    virtual bool IsPath() const;


    virtual csTicks TimeDiff(void);

    virtual csTicks ClientTimeDiff()
    {
        return csGetTicks() - lastClientDRUpdate;
    }

    virtual void GetDRData(bool &on_ground, csVector3 &pos,
                           float &yrot, iSector* &sector, csVector3 &vel, csVector3 &worldVel,
                           float &ang_vel);

    virtual void SetDRData(bool on_ground, csVector3 &pos,
                           float yrot, iSector* sector, csVector3 &vel, csVector3 &worldVel,
                           float ang_vel);

    virtual void SetSoftDRData(bool on_ground, csVector3 &pos,
                               float yrot, iSector* sector, csVector3 &vel, csVector3 &worldVel,
                               float ang_vel);

    virtual void TickEveryFrame();

    virtual iSector* GetSector() const;

    virtual int ExtrapolatePosition(float delta);

    virtual void UpdateDRDelta(csTicks ticksdelta);
    virtual void UpdateDR(csTicks delta);
    virtual void UpdateDR();

    virtual void SetPath(iPath* newpath);

    virtual void SetPathTime(float timeval);

    virtual void SetPathSpeed(float speed);

    virtual void SetPathAction(int which, const char* action);

    virtual void SetPathSector(const char* sectorname);

    virtual void SetDeltaLimit(float deltaLimit);

    virtual csVector3 GetPortalDisplacement();

    virtual void ClearPortalDisplacement();


    void UseCD(bool cd);

    void StackTrace(const char* error);

protected:

    // Move local entity
    // both MoveV and MoveSprite return CEL_MOVE_* constants defined above
    int MoveV(float delta);
    int MoveSprite(float delta);
    void OffsetSprite(float delta);

    void HugGround(const csVector3 &pos, iSector* sector);


    // Returns a list of sectors near a position.
    int FindSectors(const csVector3 &pos, float size, iSector** sectors);


    static csCollisionPair our_cd_contact[1000];
    static int num_our_cd;

    iObjectRegistry* object_reg;

    csRef<iMeshWrapper> mesh;
    psCollisionDetection* colldet;

    csRef<iEngine> engine;
    csRef<iVirtualClock> vc;
    csRef<iCollideSystem> cdsys;

    // Linear vars
    float angDelta;
    bool stationary;
    float gravity;

    csVector3 angularVelocity;
    csVector3 angleToReach;
    bool angleToReachFlag;
    csVector3 velBody;

    csVector3 velWorld;

    bool hugGround;

    float xRot;
    float zRot;

    float scale;

    // Path vars
    csRef<iPath> path;
    float path_time, path_speed;
    csStringArray path_actions;
    bool path_sent;
    csString path_sector;

    //Collision vars
    csVector3 shift;
    csVector3 topSize;

    csVector3 bottomSize;

    csBox3 boundingBox;

    csVector3 portalDisplaced;

    csVector3 intervalSize;

    csTicks lastDRUpdate;
    csTicks lastClientDRUpdate;
    csVector3 lastClientPosition;
    float lastClientYrot;
    iSector* lastClientSector;
    float deltaLimit;

    // Variables for 'Soft Update' of position
    csVector3 offset_err;    
    csVector3 offset_rate;   
};

#endif