placeable.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_NWN_PLACEABLE_H
#define ENGINES_NWN_PLACEABLE_H

#include "src/aurora/types.h"

#include "src/engines/nwn/situated.h"

namespace Engines {

namespace NWN {

class Placeable : public Situated {
public:
    enum State {
        kStateDefault     = 0, 
        kStateOpen        = 1, 
        kStateClosed      = 2, 
        kStateDestroyed   = 3, 
        kStateActivated   = 4, 
        kStateDeactivated = 5  
    };

    Placeable(const Aurora::GFF3Struct &placeable);
    ~Placeable();

    // Basic visuals

    void show(); 
    void hide(); 

    // Basic properties

    bool isOpen() const;
    bool isActivated() const;

    bool open(Object *opener);
    bool close(Object *closer);

    bool activate(Object *opener);
    bool deactivate(Object *closer);

    // Object/Cursor interactions

    void enter(); 
    void leave(); 

    void highlight(bool enabled);

    bool click(Object *triggerer = 0);

    // Animation

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

protected:
    void loadObject(const Aurora::GFF3Struct &gff);
    void loadAppearance();

private:
    State _state; 

    bool _hasInventory; 

    void load(const Aurora::GFF3Struct &placeable);

    void setModelState();

    const Common::UString &getAnimationSound(Animation animation);
};

} // End of namespace NWN

} // End of namespace Engines

#endif // ENGINES_NWN_PLACEABLE_H