Scene.h

Go to the documentation of this file.

//========================================================================
// Copyright (c) 2003-2011 Anael Seghezzi <www.maratis3d.com>
//
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would
//    be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such, and must not
//    be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source
//    distribution.
//
//========================================================================

#ifndef __SCENE_H
#define __SCENE_H

#include <map>

namespace Neo
{

// data modes
enum M_DATA_MODES
{
    M_DATA_STATIC = 0,
    M_DATA_DYNAMIC,
    M_DATA_STREAM
};

class NEO_ENGINE_EXPORT Scene
{
public:

    // Definition of some additional data for rendering
    class AdditionalData {};

    // constructor / destructor
    Scene(void);
    ~Scene(void);

private:

    AdditionalData* m_additionalData;

    // name
    String m_name;

    // data mode
    M_DATA_MODES m_dataMode;

    // script
    String m_scriptFilename;

    // objects pointers
    vector <Object3d *> m_objects;

    // objects
    vector <OCamera *> m_cameras;
    vector <OLight *> m_lights;
    vector <OEntity *> m_entities;
    vector <OSound *> m_sounds;
    vector <OText *> m_texts;

    // current frame
    int m_currentFrame;

    map<int,Object3d*> m_handles;
    unsigned long int m_ids;

    // current camera
    unsigned int m_currentCamera;

    // gravity
    Vector3 m_gravity;

    // Ambient light
    Vector3 m_ambientLight;

public:

    AdditionalData* getAdditionalData() { return m_additionalData; }
    void setAdditionalData(AdditionalData* d) { m_additionalData = d; }

    // name
    void setName(const char * name);

    inline const char * getName(void){ return m_name.getSafeString(); }

    inline Vector3 getAmbientLight() { return m_ambientLight; }
    inline void setAmbientLight(Vector3 light) { m_ambientLight = light; }

    // data mode
    inline void setDataMode(M_DATA_MODES dataMode){ m_dataMode = dataMode; }
    inline M_DATA_MODES getDataMode(void){ return m_dataMode; }

    // script
    void setScriptFilename(const char * scriptFilename);

    inline const char * getScriptFilename(void){ return m_scriptFilename.getData(); }

    // gravity
    inline void setGravity(const Vector3 & gravity){ m_gravity = gravity; }

    inline Vector3 getGravity(void) const { return m_gravity; }

    // sounds
    void playLoopSounds(void);
    void stopAllSounds(void);

    // delete object
    void deleteObject(Object3d * object);

    // add objects
    OCamera * addNewCamera(void);

    OCamera * addNewCamera(const OCamera & camera);

    OLight * addNewLight(void);

    Object3d * addNewGroup(void);
    Object3d * addNewGroup(const Object3d & object);

    OLight * addNewLight(const OLight & light);
    OEntity * addNewEntity(MeshRef * meshRef);
    OEntity * addNewEntity(const OEntity & entity);
    OSound * addNewSound(SoundRef * soundRef);
    OSound * addNewSound(const OSound & sound);
    OText * addNewText(FontRef * fontRef);
    OText * addNewText(const OText & text);

    // get objects number
    inline unsigned int getObjectsNumber(void){ return m_objects.size(); }

    inline unsigned int getCamerasNumber(void){ return m_cameras.size(); }

    inline unsigned int getLightsNumber(void){ return m_lights.size(); }

    inline unsigned int getEntitiesNumber(void){ return m_entities.size(); }

    inline unsigned int getSoundsNumber(void){ return m_sounds.size(); }

    inline unsigned int getTextsNumber(void){ return m_texts.size(); }

    // current camera
    inline void setCurrentCameraId(unsigned int id){ m_currentCamera = id; }
    inline unsigned int getCurrentCameraId(void){ return m_currentCamera; }

    void setCurrentCamera(OCamera* c);

    OCamera * getCurrentCamera(void);

    // current frame
    inline void setCurrentFrame(int currentFrame){ m_currentFrame = currentFrame; }
    inline int getCurrentFrame(void){ return m_currentFrame; }

    // get objects
    Object3d * getObjectByName(const char * name);

    Object3d * getObjectByHandle(unsigned long handle) { return m_handles[handle]; }

    OLight * getLightByName(const char * name);

    OCamera * getCameraByName(const char * name);

    OEntity * getEntityByName(const char * name);

    OSound * getSoundByName(const char * name);

    OText * getTextByName(const char * name);

    bool getObjectIndex(const char * name, unsigned int * id);

    inline Object3d * getObjectByIndex(unsigned int index){ return m_objects[index]; }
    inline OLight * getLightByIndex(unsigned int index){ return m_lights[index]; }
    inline OCamera * getCameraByIndex(unsigned int index){ return m_cameras[index]; }
    inline OEntity * getEntityByIndex(unsigned int index){ return m_entities[index]; }
    inline OSound * getSoundByIndex(unsigned int index){ return m_sounds[index]; }
    inline OText * getTextByIndex(unsigned int index){ return m_texts[index]; }

    // begin / end
    void begin(void);
    void end(void);

    // physics
    void prepareCollisionShape(OEntity * entity);
    void prepareCollisionObject(OEntity * entity);
    void prepareConstraints(OEntity * entity);
    void preparePhysics(void);
    void updatePhysics(void);

    // update
    void update(void);

    // behaviors
    void updateObjectsBehaviors(void);

    void drawObjectsBehaviors(void);
    
    // update objects
    void updateObjectsMatrices(void);

    // draw
    void draw(OCamera * camera);
};
}

#endif