actor.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef GRIM_ACTOR_H
#define GRIM_ACTOR_H

#include "engines/grim/pool.h"
#include "engines/grim/object.h"
#include "engines/grim/color.h"

#include "math/vector3d.h"
#include "math/angle.h"
#include "math/quat.h"

namespace Grim {

class TextObject;
class Sector;
class Costume;
class LipSync;
class Font;
class Set;
class Material;
struct SetShadow;
struct Joint;
class EMIModel;

struct Plane {
    Common::String setName;
    Sector *sector;
};

typedef Common::List<Plane> SectorListType;

#define MAX_SHADOWS 8

struct Shadow {
    Shadow();

    Common::String name;
    Math::Vector3d pos;
    SectorListType planeList;
    bool active;
    bool dontNegate;
    Color color;
    void *userData;
};

class Actor : public PoolObject<Actor> {
public:
    enum CollisionMode {
        CollisionOff = 0,
        CollisionBox = 1,
        CollisionSphere = 2
    };

    enum AlphaMode {
        AlphaOff = -1,
        AlphaReplace = 2,
        AlphaModulate = 3 // Seems to be unused
    };

    enum LightMode {
        LightStatic = 0,
        LightFastDyn = 1,
        LightNormDyn = 2,
        LightNone = 3
    };

    Actor();
    ~Actor();

    static int32 getStaticTag() { return MKTAG('A', 'C', 'T', 'R'); }

    void saveState(SaveGame *savedState) const;
    bool restoreState(SaveGame *savedState);

    const Common::String &getName() const { return _name; }

    void setName(const Common::String &name) { _name = name; }

    void setTalkColor(const Color &color) { _talkColor = color; }
    Color getTalkColor() const { return _talkColor; }

    void setPos(const Math::Vector3d &position);
    Math::Vector3d getPos() const { return _pos; }
    inline Math::Vector3d getDestPos() const { return _destPos; }

    void walkTo(const Math::Vector3d &position);
    void stopWalking() { _walking = false; }
    bool isWalking() const;

    void turnTo(const Math::Angle &pitch, const Math::Angle &yaw, const Math::Angle &roll, bool snap = false);
    void turnTo(const Math::Vector3d &pos, bool snap = false);
    bool singleTurnTo(const Math::Vector3d &pos);
    bool isTurning() const;
    void stopTurning();
    void setRot(const Math::Angle &pitch, const Math::Angle &yaw, const Math::Angle &roll);
    void setRot(const Math::Vector3d &pos);
    void turn(int dir);
    Math::Angle getPitch() const { return _pitch; }
    Math::Angle getYaw() const { return _yaw; }
    Math::Angle getRoll() const { return _roll; }

    Math::Angle  getYawTo(const Actor *actor) const;
    Math::Angle  getYawTo(const Math::Vector3d &p) const;

    void setVisibility(bool val) { _visible = val; }
    bool isVisible() const { return _visible; }

    void setScale(float scale) { _scale = scale; }
    float getScale() const { return _scale; }

    void setTimeScale(float scale) { _timeScale = scale; }
    float getTimeScale() const { return _timeScale; }

    void putInSet(const Common::String &setName);
    bool isDrawableInSet(const Common::String &setName) const;
    bool isInSet(const Common::String &setName) const;

    void setTurnRate(float rate) { _turnRate = rate; }
    float getTurnRate() const { return _turnRate; }
    void setWalkRate(float rate) { _walkRate = rate; }
    float getWalkRate() const { return _walkRate; }

    void setLooking(bool lookingMode) { _lookingMode = lookingMode; }

    void walkForward();
    void moveTo(const Math::Vector3d &pos);
    void setRunning(bool running) { _running = running; }
    void setReflection(float angle) { _reflectionAngle = angle; }
    Math::Vector3d getPuckVector() const;

    void setPuckOrient(bool orient);

    void sayLine(const char *msgId, bool background, float x, float y);
    // When we clean all text objects we don't want the actors to clean their
    // objects again since they're already freed
    void lineCleanup();
    void shutUp();
    bool isTalking();

    void setRestChore(int choreNumber, Costume *cost);
    int getRestChore() const;
    void setWalkChore(int choreNumber, Costume *cost);
    void setTurnChores(int left_chore, int right_chore, Costume *cost);
    void setTalkChore(int index, int choreNumber, Costume *cost);
    int getTalkChore(int index) const;
    Costume *getTalkCostume(int index) const;
    void setMumbleChore(int choreNumber, Costume *cost);
    void stopAllChores(bool ignoreLoopingChores = false);
    void setColormap(const char *map);
    void pushCostume(const char *name);
    void setCostume(const char *name);
    void popCostume();
    void clearCostumes();
    Costume *getCurrentCostume() const;
    void setLocalAlphaMode(unsigned int vertex, AlphaMode alphamode);
    void setLocalAlpha(unsigned int vertex, float alpha);
    bool hasLocalAlpha() const;
    float getLocalAlpha(unsigned int vertex) const;
    Costume *findCostume(const Common::String &name);
    int getCostumeStackDepth() const {
        return _costumeStack.size();
    }
    const Common::List<Costume *> &getCostumes() const { return _costumeStack; }

    void setActiveShadow(int shadowId);
    void setShadowPoint(const Math::Vector3d &pos);
    void setShadowColor(const Color &color);
    void setShadowPlane(const char *name);
    void addShadowPlane(const char *name);
    void clearShadowPlanes();
    void clearShadowPlane(int i);
    void setShadowValid(int);
    void setActivateShadow(int, bool);

    void setFollowBoxes(bool follow);
    bool hasFollowBoxes() const { return _followBoxes; }
    bool hasFollowedBoxes() const { return _hasFollowedBoxes; }
    void update(uint frameTime);
    bool updateTalk(uint frameTime);
    void draw();

    bool isLookAtVectorZero() {
        return _lookAtVector.isZero();
    }
    void setLookAtVectorZero() {
        _lookAtVector.set(0.f, 0.f, 0.f);
        _lookAtActor = 0;
    }
    void setLookAtVector(const Math::Vector3d &vector) {
        _lookAtVector = vector;
        _lookAtActor = 0;
    }
    Math::Vector3d getLookAtVector() {
        return _lookAtVector;
    }
    void setLookAtActor(Actor *other) { _lookAtActor = other->getId(); }
    void setLookAtRate(float rate);
    float getLookAtRate() const;
    void setHead(int joint1, int joint2, int joint3, float maxRoll, float maxPitch, float maxYaw);
    void setHead(const char *joint, const Math::Vector3d &offset);
    void setHeadLimits(float yawRange, float maxPitch, float minPitch);

    void setCollisionMode(CollisionMode mode);
    void setCollisionScale(float scale);

    bool handleCollisionWith(Actor *actor, CollisionMode mode, Math::Vector3d *vec) const;

    static void saveStaticState(SaveGame *state);
    static void restoreStaticState(SaveGame *state);

    bool isAttached() const { return _attachedActor != 0; }
    Math::Vector3d getWorldPos() const;
    Grim::Joint *getAttachedJoint(Actor *parent) const;
    void attachToActor(Actor *other, const char *joint);
    void detach();
    Math::Quaternion getRotationQuat() const;
    const Math::Matrix4 getFinalMatrix() const;
    Math::Vector3d getHeadPos() const;

    void setInOverworld(bool inOverworld) { _inOverworld = inOverworld; }
    bool isInOverworld() const { return _inOverworld; }

    float getGlobalAlpha() const { return _globalAlpha; }
    AlphaMode getAlphaMode() const { return _alphaMode; }
    float getEffectiveAlpha() const { return _alphaMode != AlphaOff ? _globalAlpha : 1.f; }
    void setGlobalAlpha(float alpha, const Common::String &mesh);
    void setAlphaMode(AlphaMode mode, const Common::String &mesh);

    int getSortOrder() const;
    void setSortOrder(const int order);
    int getEffectiveSortOrder() const;

    void activateShadow(bool active, const char *shadowName);
    void activateShadow(bool active, SetShadow *shadow);

    void drawToCleanBuffer();

    bool isTalkingForeground() const;

    LightMode getLightMode() const { return _lightMode; }
    void setLightMode(LightMode lightMode) { _lightMode = lightMode; }

    ObjectPtr<Material> loadMaterial(const Common::String &name, bool clamp);
    ObjectPtr<Material> findMaterial(const Common::String &name);

    void getBBoxInfo(Math::Vector3d &bboxPos, Math::Vector3d &bboxSize) const;

private:
    void costumeMarkerCallback(int marker);
    void collisionHandlerCallback(Actor *other) const;
    void updateWalk();
    void addShadowPlane(const char *n, Set *scene, int shadowId);
    bool shouldDrawShadow(int shadowId);
    void stopTalking();
    bool stopMumbleChore();
    void drawCostume(Costume *costume);
    Math::Vector3d handleCollisionTo(const Math::Vector3d &from, const Math::Vector3d &pos) const;
    Math::Vector3d getTangentPos(const Math::Vector3d &pos, const Math::Vector3d &dest) const;

    Math::Vector3d getSimplePuckVector() const;
    void calculateOrientation(const Math::Vector3d &pos, Math::Angle *pitch, Math::Angle *yaw, Math::Angle *roll);

    bool getSphereInfo(bool adjustZ, float &size, Math::Vector3d &pos) const;
    EMIModel *findModelWithMesh(const Common::String &mesh);

    Common::String _name;
    Common::String _setName;    // The actual current set

    Color _talkColor;
    Math::Vector3d _pos;
    Math::Angle _pitch, _yaw, _roll;
    float _walkRate, _turnRate;

    bool _followBoxes;  // Constrain to walkboxes
    bool _hasFollowedBoxes;
    float _reflectionAngle; // Maximum angle to turn by at walls
    bool _visible;
    float _scale;
    float _timeScale;
    bool _lookingMode;
    Common::String _talkSoundName;
    bool _talking;
    bool _backgroundTalk;
    ObjectPtr<LipSync> _lipSync;
    Common::List<Costume *> _costumeStack;

    // Variables for gradual turning
    bool _turning;
    bool _singleTurning;
    // NOTE: The movement direction is separate from the direction
    // the actor's model is facing. The model's direction is gradually
    // updated to match the movement direction. This produces a smooth
    // turning animation while still allowing the actor to move in a
    // new direction immediately after reflecting off a wall.
    Math::Angle _moveYaw;
    Math::Angle _movePitch;
    Math::Angle _moveRoll;
    // This is used to increase momentarily the turn rate when needed
    float _turnRateMultiplier;

    // Variables for walking to a point
    bool _walking;
    Math::Vector3d _destPos;

    //chores
    class ActionChore {
    public:
        ActionChore();
        ActionChore(Costume *cost, int chore);

        void play(bool fade = false, unsigned int time = fadeTime);
        void playLooping(bool fade = false, unsigned int time = fadeTime);
        void stop(bool fade = false, unsigned int time = fadeTime);
        void setLastFrame();

        inline bool isValid() const { return _chore > -1 && _costume != nullptr; }
        bool isPlaying() const;
        inline bool equals(const Costume *cost, int chore) const {
            return (_costume == cost && _chore == chore);
        }

        void saveState(SaveGame *state) const;
        void restoreState(SaveGame *state, Actor *actor);

        Costume *_costume;
        int _chore;

        static const unsigned int fadeTime;
        static const unsigned int talkFadeTime;
    };
    ActionChore _restChore;

    ActionChore _walkChore;
    bool _walkedLast, _walkedCur;
    bool _running;

    ActionChore _leftTurnChore, _rightTurnChore;
    int _lastTurnDir, _currTurnDir;

    ActionChore _talkChore[10];
    int _talkAnim;

    ActionChore _mumbleChore;

    Shadow *_shadowArray;
    int _activeShadowSlot;

    static ObjectPtr<Font> _sayLineFont;
    int _sayLineText;
    bool _mustPlaceText;

    ActionChore *getTurnChore(int dir) {
        return (dir > 0 ? &_leftTurnChore : &_rightTurnChore);
    }

    void freeCostume(Costume *costume);
    void freeCostumeChore(const Costume *toFree, ActionChore *chore);

    // lookAt
    Math::Vector3d _lookAtVector;

    // struct used for path finding
    struct PathNode {
        Sector *sect;
        PathNode *parent;
        Math::Vector3d pos;
        float dist;
        float cost;
    };
    Common::List<Math::Vector3d> _path;

    CollisionMode _collisionMode;
    float _collisionScale;

    bool _puckOrient;

    static bool _isTalkingBackground;
    int _talkDelay;
    int _attachedActor;
    int _lookAtActor;
    Common::String _attachedJoint;
    AlphaMode _alphaMode;
    float _globalAlpha;

    bool _inOverworld;

    int _sortOrder;
    int _sectorSortOrder;
    bool _useParentSortOrder;

    bool _fakeUnbound;
    bool _drawnToClean;

    LightMode _lightMode;

    Common::List<ObjectPtr<Material> > _materials;

    // Highest vertex used in EMI
    const static unsigned int MAX_LOCAL_ALPHA_VERTICES = 48;
    Common::Array<float> _localAlpha;
    Common::Array<int> _localAlphaMode;
};

} // end of namespace Grim

#endif