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_KOTOR2_CREATURE_H
#define ENGINES_KOTOR2_CREATURE_H

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

#include "src/aurora/types.h"

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

#include "src/engines/kotor2/object.h"

namespace Engines {

namespace KotOR2 {

class CharacterGenerationInfo;

class Creature : public Object {
public:
    Creature();
    Creature(const Aurora::GFF3Struct &creature);
    ~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;

    // 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;

    // 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);

private:
    struct PartModels {
        Common::UString type;

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

        Common::UString bodyTexture;
    };

    bool _isPC; 

    uint32 _appearance; 

    Common::ScopedPtr<Graphics::Aurora::Model> _model; 
    Common::UString _conversation;
    Common::UString _modelType;


    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 loadBody(PartModels &parts);
    void loadHead(PartModels &parts);

    void setDefaultAnimations();
};

} // End of namespace KotOR2

} // End of namespace Engines

#endif // ENGINES_KOTOR2_CREATURE_H