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_JADE_PLACEABLE_H
#define ENGINES_JADE_PLACEABLE_H

#include "src/common/scopedptr.h"

#include "src/aurora/types.h"

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

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

namespace Engines {

namespace Jade {

class Placeable : public Object {
public:
    Placeable(const Aurora::GFF3Struct &placeable);
    ~Placeable();

    // Basic visuals

    void show(); 
    void hide(); 

    // Basic properties

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

    // Object/Cursor interactions

    void enter(); 
    void leave(); 

    virtual void highlight(bool enabled);

protected:
    Common::UString _modelName; 
    Common::UString _soundCue;  
    Common::UString _resRef;    

    uint32 _appearanceType;     

    Object *_lastOpenedBy; 
    Object *_lastClosedBy; 

    Common::ScopedPtr<Graphics::Aurora::Model> _model; 

    int32 _state; 
    Common::ScopedPtr<Aurora::GFF3File> _fsm; 

private:
    void load(const Aurora::GFF3Struct &placeable);
    void loadBlueprint(const Aurora::GFF3Struct &gff);
    void loadInstance(const Aurora::GFF3Struct &gff);
    void loadProperties();
    void loadAppearance();
    int32 nextState(const Common::UString &input);
};

} // End of namespace Jade

} // End of namespace Engines

#endif // ENGINES_JADE_PLACEABLE_H