FCDocument/FCDEffectParameterSurface.h

Go to the documentation of this file.

/*
    Copyright (C) 2006 Feeling Software Inc.
    MIT License: http://www.opensource.org/licenses/mit-license.php
*/

#ifndef _FCD_EFFECT_PARAMETER_SURFACE_H_
#define _FCD_EFFECT_PARAMETER_SURFACE_H_

#include "FCDocument/FCDEffectParameter.h"

class FCDEffectParameterSurfaceInit;

typedef vector<FCDImage*> FCDImageList;

class FCOLLADA_EXPORT FCDEffectParameterSurface : public FCDEffectParameter
{
private:
    DeclareObjectType;
    StringList names;
    FCDImageList images;
    FCDEffectParameterSurfaceInit* initMethod;
    FMVector3 size;
    float viewportRatio;
    uint16 mipLevelCount;
    bool generateMipmaps;

public:
    FCDEffectParameterSurface(FCDocument* document);

    virtual ~FCDEffectParameterSurface();
    
    virtual Type GetType() const { return SURFACE; }

    FCDEffectParameterSurfaceInit* GetInitMethod() { return initMethod; }
    const FCDEffectParameterSurfaceInit* GetInitMethod() const { return initMethod; } 
    void SetInitMethod(FCDEffectParameterSurfaceInit* method);

    size_t GetImageCount() const { return images.size(); }

    FCDImageList& GetImages() { return images; }
    const FCDImageList& GetImages() const { return images; } 
    FCDImage* GetImage(size_t index = 0) { return index < images.size() ? images.at(index) : NULL; }
    const FCDImage* GetImage(size_t index = 0) const { return index < images.size() ? images.at(index) : NULL; } 
    size_t FindImage(const FCDImage* image) const;

    size_t AddImage(FCDImage* image);

    void RemoveImage(FCDImage* image);

    const FMVector3& GetSize() const { return size; }

    void SetSize(const FMVector3& dimensions) { size = dimensions; }

    float GetViewportRatio() const { return viewportRatio; }

    void SetViewportRatio(float ratio) { viewportRatio = ratio; }

    uint16 GetMipLevelCount() const { return mipLevelCount; }

    void SetMipLevelCount(uint16 levelCount) { mipLevelCount = levelCount; }
    
    bool IsGenerateMipMaps() const { return generateMipmaps; }

    void SetGenerateMipMaps(bool _generateMipmaps) { generateMipmaps = _generateMipmaps; }

    const char* GetName(size_t index = 0) const { return (index < names.size()) ? names[index].c_str() : NULL; }

    virtual FCDEffectParameter* Clone();

    virtual void Overwrite(FCDEffectParameter* target);

    virtual FUStatus LoadFromXML(xmlNode* parameterNode);

    virtual xmlNode* WriteToXML(xmlNode* parentNode) const;
};


class FCOLLADA_EXPORT FCDEffectParameterSurfaceInitFactory
{
private:
    // Never instantiate: this is a static class
    FCDEffectParameterSurfaceInitFactory() {}

public:

    enum InitType
    {
        FROM, 
        AS_NULL, 
        AS_TARGET, 
        CUBE, 
        VOLUME, 
        PLANAR 
    };

    static FCDEffectParameterSurfaceInit* Create(InitType type);
};


class FCOLLADA_EXPORT FCDEffectParameterSurfaceInit
{
public:
    FCDEffectParameterSurfaceInit() {}

    virtual ~FCDEffectParameterSurfaceInit() {}

    virtual FCDEffectParameterSurfaceInitFactory::InitType GetInitType() const = 0;

    void Clone(FCDEffectParameterSurfaceInit* clone);

    virtual FCDEffectParameterSurfaceInit* Clone() = 0;
};

class FCOLLADA_EXPORT FCDEffectParameterSurfaceInitCube : public FCDEffectParameterSurfaceInit
{
public:
    enum CubeType
    {
        ALL, 
        PRIMARY, 
        FACE 
    };

public:
    FCDEffectParameterSurfaceInitCube();

    virtual ~FCDEffectParameterSurfaceInitCube() {}

    virtual FCDEffectParameterSurfaceInitFactory::InitType GetInitType() const {return FCDEffectParameterSurfaceInitFactory::CUBE;}

    virtual FCDEffectParameterSurfaceInit* Clone();

    CubeType cubeType;
    
    UInt16List order;
};

class FCOLLADA_EXPORT FCDEffectParameterSurfaceInitVolume : public FCDEffectParameterSurfaceInit
{
public:
    enum VolumeType
    {
        ALL, 
        PRIMARY 
    };

public:
    FCDEffectParameterSurfaceInitVolume();

    virtual ~FCDEffectParameterSurfaceInitVolume() {}

    virtual FCDEffectParameterSurfaceInitFactory::InitType GetInitType() const {return FCDEffectParameterSurfaceInitFactory::VOLUME;}

    virtual FCDEffectParameterSurfaceInit* Clone();

    VolumeType volumeType;
};

class FCOLLADA_EXPORT FCDEffectParameterSurfaceInitFrom : public FCDEffectParameterSurfaceInit
{
public:
    FCDEffectParameterSurfaceInitFrom() {}

    virtual ~FCDEffectParameterSurfaceInitFrom() {}

    virtual FCDEffectParameterSurfaceInitFactory::InitType GetInitType() const {return FCDEffectParameterSurfaceInitFactory::FROM;}

    virtual FCDEffectParameterSurfaceInit* Clone();

    StringList mip;

    StringList slice;

    StringList face;
};

class FCOLLADA_EXPORT FCDEffectParameterSurfaceInitAsNull : public FCDEffectParameterSurfaceInit
{
public:
    FCDEffectParameterSurfaceInitAsNull() {}

    virtual ~FCDEffectParameterSurfaceInitAsNull() {}

    virtual FCDEffectParameterSurfaceInitFactory::InitType GetInitType() const {return FCDEffectParameterSurfaceInitFactory::AS_NULL;}

    virtual FCDEffectParameterSurfaceInit* Clone();
};

class FCOLLADA_EXPORT FCDEffectParameterSurfaceInitAsTarget : public FCDEffectParameterSurfaceInit
{
public:
    FCDEffectParameterSurfaceInitAsTarget() {};

    virtual ~FCDEffectParameterSurfaceInitAsTarget() {}

    virtual FCDEffectParameterSurfaceInitFactory::InitType GetInitType() const {return FCDEffectParameterSurfaceInitFactory::AS_TARGET;}

    virtual FCDEffectParameterSurfaceInit* Clone();
};

class FCOLLADA_EXPORT FCDEffectParameterSurfaceInitPlanar : public FCDEffectParameterSurfaceInit
{
public:
    FCDEffectParameterSurfaceInitPlanar() {};

    virtual ~FCDEffectParameterSurfaceInitPlanar() {}

    virtual FCDEffectParameterSurfaceInitFactory::InitType GetInitType() const {return FCDEffectParameterSurfaceInitFactory::PLANAR;}

    virtual FCDEffectParameterSurfaceInit* Clone();
};



#endif // _FCD_EFFECT_PARAMETER_SURFACE_H_

---