object.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_OBJECT_H
#define ENGINES_NWN_OBJECT_H

#include <list>

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

#include "src/aurora/nwscript/object.h"

#include "src/sound/types.h"

#include "src/engines/nwn/types.h"
#include "src/engines/nwn/location.h"

#include "src/engines/nwn/gui/widgets/tooltip.h"

#include "src/engines/nwn/script/container.h"

namespace Aurora {
    class SSFFile;

    namespace NWScript {
        class Object;
    }
}

namespace Engines {

namespace NWN {

class Area;

class Object : public Aurora::NWScript::Object, public NWN::ScriptContainer {
public:
    Object(ObjectType type = kObjectTypeInvalid);
    virtual ~Object();

    ObjectType getType() const;

    // Basic visuals

    virtual void loadModel();   
    virtual void unloadModel(); 

    virtual void show(); 
    virtual void hide(); 

    const std::list<uint32> &getIDs() const;

    // Basic properties

    const Common::UString &getName() const;
    const Common::UString &getDescription() const;
    const Common::UString &getPortrait() const;

    const Common::UString &getConversation() const;

    const Aurora::SSFFile *getSSF();

    // Interactive properties

    bool isStatic() const; 
    bool isUsable() const; 

    bool isClickable() const; 

    // Object/Object interactions

    Aurora::NWScript::Object *getPCSpeaker() const;
    void setPCSpeaker(Aurora::NWScript::Object *pc);

    Area *getArea() const;
    virtual void setArea(Area *);

    // Positioning

    virtual void getPosition(float &x, float &y, float &z) const;
    virtual void getOrientation(float &x, float &y, float &z, float &angle) const;

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

    Location getLocation() const;

    // Object/Cursor interactions

    virtual void enter(); 
    virtual void leave(); 

    virtual void highlight(bool enabled);

    virtual bool click(Object *triggerer = 0);

    // Object (text) talking

    virtual void speakString(const Common::UString &string, uint32 volume);

    void speakOneLiner(Common::UString conv, Object *tokenTarget = 0);

    // Sound

    void stopSound();
    void playSound(const Common::UString &sound, bool pitchVariance = false);

    // Animation

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

protected:
    ObjectType _type; 

    Common::UString _name;        
    Common::UString _description; 

    Common::UString _portrait; 

    Common::UString _conversation; 

    uint32 _soundSet; 
    Common::ScopedPtr<Aurora::SSFFile> _ssf; 

    bool _static; 
    bool _usable; 

    std::list<uint32> _ids; 

    Aurora::NWScript::Object *_pcSpeaker; 

    Area *_area; 

    float _position[3];    
    float _orientation[4]; 

    Sound::ChannelHandle _sound; 

    Common::ScopedPtr<Tooltip> _tooltip; 


    void loadSSF();
    bool beginConversation(Object *triggerer);

    virtual bool createTooltip(Tooltip::Type type);

    bool createFeedbackTooltip();
    bool createSpeechTooltip(const Common::UString &line);

    void destroyTooltip();

    bool showFeedbackTooltip();
    bool showSpeechTooltip(const Common::UString &line);
    void hideTooltip();
};

} // End of namespace NWN

} // End of namespace Engines

#endif // ENGINES_NWN_OBJECT_H