pseffectmanager.h

Go to the documentation of this file.

/*
 * Author: Andrew Robberts
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program 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 (version 2 of the License)
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef PS_EFFECT_MANAGER_HEADER
#define PS_EFFECT_MANAGER_HEADER


// CS includes
#include <csutil/csstring.h>
#include <csutil/array.h>
#include <csutil/parray.h>
#include <csutil/ref.h>
#include <iengine/collection.h>
#include <iutil/virtclk.h>
#include <csutil/hash.h>
#include <imap/reader.h>
#include <ivideo/graph3d.h>
#include <csutil/scf_implementation.h>
#include <csutil/threading/rwmutex.h>

#include "effects/pseffect2drenderer.h"

struct iLight;
struct iMeshWrapper;
struct iMovable;
struct iSector;
struct iSectorList;
struct iThreadReturn;
struct iView;
class psEffect;
class psLight;

class psEffectManager;

class psEffectGroup
{
public:
    csString name;
    csArray<csString> effects;
};


class psEffectLoader : public scfImplementation1<psEffectLoader,iLoaderPlugin>
{
public:
    psEffectLoader();

    void SetManager(psEffectManager* manager);

    // used to handle and parse the <addon> tags.
    csPtr<iBase> Parse(iDocumentNode* node, iStreamSource*, iLoaderContext* ldr_context, iBase* context);

    bool IsThreadSafe()
    {
        return true;
    }

private:
    psEffectManager* manager;
    CS::Threading::ReadWriteMutex parseLock;
};


class psEffectManager : public csRefCount
{
public:
    psEffectManager(iObjectRegistry* objReg);
    virtual ~psEffectManager();

    csPtr<iThreadReturn> LoadEffects(const csString &fileName, iView* parentView);

    bool LoadFromEffectsList(const csString &fileName, iView* parentView);

    bool LoadFromDirectory(const csString &path, bool includeSubDirs, iView* parentView);

    bool DeleteEffect(unsigned int effectID);

    unsigned int RenderEffect(const csString &effectName, const csVector3 &offset, iMeshWrapper* attachPos,
                              iMeshWrapper* attachTarget=0, const csVector3 &up=csVector3(0,1,0),
                              const unsigned int uniqueIDOverride = 0, bool rotateWithMesh = false, const float* scale = NULL);

    unsigned int RenderEffect(const csString &effectName, iSector* sector, const csVector3 &pos,
                              iMeshWrapper* attachTarget, const csVector3 &up=csVector3(0,1,0),
                              const unsigned int uniqueIDOverride = 0, const float* scale = NULL);

    unsigned int RenderEffect(const csString &effectName, iSectorList* sectors, const csVector3 &pos,
                              iMeshWrapper* attachTarget=0, const csVector3 &up=csVector3(0,1,0),
                              const unsigned int uniqueIDOverride = 0, const float* scale = NULL);

    unsigned int AttachLight(const char* name, const csVector3 &pos,
                             float radius, const csColor &colour, iMeshWrapper* mw);
    void DetachLight(unsigned int lightID);

    void Update(csTicks elapsed = 0);

    void Clear();

    psEffect* FindEffect(unsigned int ID) const;

    psEffect* FindEffect(const csString &name) const;

    csHash<psEffect*, csString>::GlobalIterator GetEffectsIterator();


    void ShowEffect(unsigned int id,bool value = true);

    void AddEffect(const char* name, psEffect* effect);

    iView* GetView() const
    {
        return view;
    }

    void Render2D(iGraphics3D* g3d, iGraphics2D* g2d);

    psEffect2DRenderer* Get2DRenderer() const
    {
        return effect2DRenderer;
    }

private:

    iObjectRegistry* object_reg;

    csRef<iVirtualClock> vc;

    csHash<psEffect*, csString> effectFactories;

    csHash<psEffect*, unsigned int> actualEffects;

    csRef<iCollection> effectsCollection;

    iView* view;

    csRef<psEffectLoader> effectLoader;

    psEffect2DRenderer* effect2DRenderer;

    csHash<psLight*, unsigned int> lightList;
};

#endif