FCDocument/FCDEffect.h

Go to the documentation of this file.

/*
    Copyright (C) 2005-2006 Feeling Software Inc.
    MIT License: http://www.opensource.org/licenses/mit-license.php
*/
/*
    Based on the FS Import classes:
    Copyright (C) 2005-2006 Feeling Software Inc
    Copyright (C) 2005-2006 Autodesk Media Entertainment
    MIT License: http://www.opensource.org/licenses/mit-license.php
*/

#ifndef _FCD_EFFECT_H_
#define _FCD_EFFECT_H_

#include "FUtils/FUDaeEnum.h"
#include "FCDocument/FCDEntity.h"

class FCDocument;
class FCDEffectStandard;
class FCDEffectParameter;
class FCDEffectProfile;
class FCDEffectParameterList;

class FCDEffectProfile;
class FCDEffectParameterList;
class FCDImage;

typedef vector<FCDEffectProfile*> FCDEffectProfileList;
typedef vector<FCDImage*> FCDEffectImageList;

class FCOLLADA_EXPORT FCDEffect : public FCDEntity
{
private:
    DeclareObjectType;
    FCDEffectProfileList profiles;
    FCDEffectParameterList* parameters;
    FCDEffectImageList images;

public:
    FCDEffect(FCDocument* document);

    virtual ~FCDEffect();

    virtual Type GetType() const { return FCDEntity::EFFECT; }

    size_t GetProfileCount() const { return profiles.size(); }

    FCDEffectProfile* GetProfile(size_t index) { FUAssert(index < GetProfileCount(), return NULL); return profiles.at(index); }
    const FCDEffectProfile* GetProfile(size_t index) const { FUAssert(index < GetProfileCount(), return NULL); return profiles.at(index); } 
    FCDEffectProfileList& GetProfiles() { return profiles; }
    const FCDEffectProfileList& GetProfiles() const { return profiles; } 
    FCDEffectProfile* FindProfile(FUDaeProfileType::Type type);
    const FCDEffectProfile* FindProfile(FUDaeProfileType::Type type) const; 
    FCDEffectProfile* FindProfileByTypeAndPlatform(FUDaeProfileType::Type type, string platform);
    const FCDEffectProfile* FindProfileByTypeAndPlatform(FUDaeProfileType::Type type, string platform) const; 
    inline bool HasProfile(FUDaeProfileType::Type type) const { return FindProfile(type) != NULL; }

    FCDEffectProfile* AddProfile(FUDaeProfileType::Type type);

    void ReleaseProfile(FCDEffectProfile* profile);

    FCDEffectParameterList* GetParameters() { return parameters; }
    const FCDEffectParameterList* GetParameters() const { return parameters; } 
    void AddParameter(FCDEffectParameter* parameter);

    FCDEffectParameter* FindParameterBySemantic(const string& semantic);

    void FindParametersBySemantic(const string& semantic, FCDEffectParameterList& parameters);

    void FindParametersByReference(const string& reference, FCDEffectParameterList& parameters);

    FCDEffect* Clone();

    void Flatten();

    virtual FUStatus LoadFromXML(xmlNode* effectNode);

    virtual xmlNode* WriteToXML(xmlNode* parentNode) const;
    
    FCDEffectImageList& GetImages() { return images; }
    const FCDEffectImageList& GetImages() const { return images; } 
};

#endif // _FCD_MATERIAL_H_

---