creature.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_KOTOR_CREATURE_H
#define ENGINES_KOTOR_CREATURE_H

#include "src/common/types.h"
#include "src/common/scopedptr.h"
#include "src/common/ustring.h"
#include "src/common/ptrmap.h"

#include "src/aurora/types.h"

#include "src/graphics/aurora/types.h"

#include "src/engines/kotor/object.h"
#include "src/engines/kotor/inventory.h"
#include "src/engines/kotor/action.h"

namespace Engines {

namespace KotOR {

class CharacterGenerationInfo;
class Item;

class Creature : public Object {
public:
    Creature();
    Creature(const Aurora::GFF3Struct &creature);
    Creature(const Common::UString &resRef);
    ~Creature();

    void createFakePC();
    void createPC(const CharacterGenerationInfo &info);

    // Basic visuals

    void show(); 
    void hide(); 
    bool isVisible() const; 

    // Basic properties

    bool isPC() const; 
    bool isPartyMember() const;

    Gender getGender() const; 
    int getLevel(const Class &c) const; 

    Race getRace() const; 
    SubRace getSubRace() const; 

    int getLevelByPosition(int position) const; 
    Class getClassByPosition(int position) const; 

    float getWalkRate() const;
    float getRunRate() const;

    // Positioning

    void setPosition(float x, float y, float z);
    void setOrientation(float x, float y, float z, float angle);

    // Object/Cursor interactions

    void enter(); 
    void leave(); 

    void highlight(bool enabled);

    bool click(Object *triggerer = 0);

    const Common::UString &getConversation() const;

    float getCameraHeight() const;

    // Inventory and equipment

    void equipItem(Common::UString tag, EquipmentSlot slot);

    Inventory &getInventory();
    Item *getEquipedItem(EquipmentSlot slot) const;

    // Animation

    void playDefaultAnimation();
    void playDefaultHeadAnimation();

    void playAnimation(const Common::UString &anim,
                       bool restart = true,
                       float length = 0.0f,
                       float speed = 1.0f);

    void playHeadAnimation(const Common::UString &anim,
                           bool restart = true,
                           float length = 0.0f,
                           float speed = 1.0f);

    // PC Mesh string generation

    static Common::UString getBodyMeshString(Gender gender, Class charClass, char state = 'b');
    static Common::UString getHeadMeshString(Gender gender, Skin skin, uint32 faceId);

    // Action queue

    void clearActionQueue();

    void enqueueAction(const Action &action);

    const Action *peekAction() const;
    const Action *dequeueAction();

private:
    struct PartModels {
        Common::UString type;

        Common::UString body;
        Common::UString head;

        Common::UString bodyTexture;
        Common::UString portrait;
    };

    struct ClassLevel {
        Class characterClass;
        int level;
    };

    bool _isPC; 

    uint32 _appearance; 

    Race _race; 
    SubRace _subRace; 

    Gender _gender;
    std::vector<ClassLevel> _levels; 
    Skin _skin; 
    uint8 _face; 

    Common::UString _modelType;
    Common::ScopedPtr<Graphics::Aurora::Model> _model; 
    Graphics::Aurora::Model *_headModel; 
    bool _visible;

    Common::UString _conversation;

    Inventory _inventory;
    Common::PtrMap<EquipmentSlot, Item> _equipment;

    std::vector<Action> _actionQueue;

    float _walkRate;
    float _runRate;


    void init();

    void load(const Aurora::GFF3Struct &creature);
    void load(const Aurora::GFF3Struct &instance, const Aurora::GFF3Struct *blueprint);

    void loadProperties(const Aurora::GFF3Struct &gff);
    void loadPortrait(const Aurora::GFF3Struct &gff);
    void loadAppearance();

    void getPartModels(PartModels &parts, uint32 state = 'a');
    void getPartModelsPC(PartModels &parts, uint32 state, uint8 textureVariation);
    void loadBody(PartModels &parts);
    void loadHead(PartModels &parts);
    void loadMovementRate(const Common::UString &name);

    void changeBody();
    void changeWeapon(EquipmentSlot slot);

    void setDefaultAnimations();
};

} // End of namespace KotOR

} // End of namespace Engines

#endif // ENGINES_KOTOR_CREATURE_H