situated.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_SITUATED_H
#define ENGINES_KOTOR_SITUATED_H

#include "glm/vec3.hpp"

#include "src/common/scopedptr.h"

#include "src/aurora/types.h"

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

#include "src/engines/kotor/object.h"
#include "src/engines/kotor/walkmesh.h"

namespace Engines {

namespace KotOR {

class Situated : public Object {
public:
    ~Situated();

    // Basic visuals

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

    // Basic properties

    virtual bool isOpen() const = 0;

    bool isLocked() const;               
    virtual void setLocked(bool locked); 

    Object *getLastOpenedBy() const;
    Object *getLastClosedBy() const;
    Object *getLastUsedBy  () const;

    const Common::UString &getConversation() const;

    // Positioning

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

    // Walkmesh

    virtual bool testCollision(const glm::vec3 &orig, const glm::vec3 &dest) const;
    void setWalkmeshInvisible(bool invisible);

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

protected:
    Common::UString _modelName; 

    uint32 _appearanceID; 
    uint32 _soundAppType; 

    bool _locked; 

    Common::UString _soundOpened;    
    Common::UString _soundClosed;    
    Common::UString _soundDestroyed; 
    Common::UString _soundUsed;      
    Common::UString _soundLocked;    

    Common::UString _conversation; 

    Object *_lastOpenedBy; 
    Object *_lastClosedBy; 
    Object *_lastUsedBy;   

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

    Walkmesh _walkmesh;


    Situated(ObjectType type);

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

    virtual void loadObject(const Aurora::GFF3Struct &gff) = 0;
    virtual void loadAppearance() = 0;


private:
    void loadProperties(const Aurora::GFF3Struct &gff);
    void loadPortrait(const Aurora::GFF3Struct &gff);
    void loadSounds();
};

} // End of namespace KotOR

} // End of namespace Engines

#endif // ENGINES_KOTOR_SITUATED_H