/*
	Copyright (C) 2005-2007 Feeling Software Inc.
	Portions of the code are:
	Copyright (C) 2005-2007 Sony Computer Entertainment America
	
	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
*/

/**
	@file FCDEffect.h
	This file contains the FCDEffect class.
*/

#ifndef _FCD_EFFECT_H_
#define _FCD_EFFECT_H_

#ifndef _FU_DAE_ENUM_H_
#include "FUtils/FUDaeEnum.h"
#endif // _FU_DAE_ENUM_H_
#ifndef _FCD_ENTITY_H_
#include "FCDocument/FCDEntity.h"
#endif // _FCD_ENTITY_H_

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

/**	
	@defgroup FCDEffect COLLADA Effect Classes [ColladaFX]
*/

/**
	A COLLADA effect.
	
	A COLLADA effect is one of many abstraction level that defines how
	to render mesh polygon sets. It contains one or more rendering profile
	that the application can choose to support. In theory, all the rendering
	profiles should reach the same render output, using different
	rendering technologies.

	An effect may also declare new general purpose parameters that are common
	to all the profiles.

	@ingroup FCDEffect
*/
class FCOLLADA_EXPORT FCDEffect : public FCDEntity
{
private:
	DeclareObjectType(FCDEntity);
	DeclareParameterContainer(FCDEffectProfile, profiles, FC("Profiles"));
	DeclareParameterContainer(FCDEffectParameter, parameters, FC("Parameters"));

public:
	/** Constructor: do not use directly.
		Instead use the FCDLibrary::AddEntity function.
		@param document The COLLADA document that owns this effect. */
	FCDEffect(FCDocument* document);

	/** Destructor. */
	virtual ~FCDEffect();

	/** Retrieves the type for this entity class.
		This function is a part of the FCDEntity interface.
		@return The entity type: EFFECT. */
	virtual Type GetType() const { return FCDEntity::EFFECT; }

	/** Retrieves the number of profiles contained within the effect.
		@return The number of profiles within the effect. */
	size_t GetProfileCount() const { return profiles.size(); }

	/** Retrieves a profile contained within the effect.
		@param index The index of the profile.
		@return The profile. This pointer will be NULL, if the given index is out-of-bounds. */
	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); } /**< See above. */

	/** Retrieves the list of the profiles contained within the effect.
		@return The list of effect profiles. */
	DEPRECATED(3.05A, GetProfileCount and GetProfile(index)) void GetProfiles() const {}

	/** Retrieves the first profile for a specific profile type.
		There should only be one profile of each type within an effect. This
		function allows you to retrieve the profile for a given type.
		@param type The profile type.
		@return The first profile of this type. This pointer will be NULL if the effect
			does not have any profile of this type. */
	const FCDEffectProfile* FindProfile(FUDaeProfileType::Type type) const; 
	inline FCDEffectProfile* FindProfile(FUDaeProfileType::Type type) { return const_cast<FCDEffectProfile*>(const_cast<const FCDEffect*>(this)->FindProfile(type)); } /**< See above. */
	
	/** Retrieves the profile for a specific profile type and platform.
		There should only be one profile of each type within an effect. This
		function allows you to retrieve the profile for a given type.
		@param type The profile type.
		@param platform The profile platform.
		@return The profile of this type. This pointer will be NULL if the effect
			does not have any profile of this type. */
	inline FCDEffectProfile* FindProfileByTypeAndPlatform(FUDaeProfileType::Type type, const fm::string& platform) { return const_cast<FCDEffectProfile*>(const_cast<const FCDEffect*>(this)->FindProfileByTypeAndPlatform(type, platform)); }
	const FCDEffectProfile* FindProfileByTypeAndPlatform(FUDaeProfileType::Type type, const fm::string& platform) const; /**< See above. */

	/** Retrieves whether the effect contains a profile of the given type.
		@param type The profile type.
		@return Whether the effect has a profile of this type. */
	inline bool HasProfile(FUDaeProfileType::Type type) const { return FindProfile(type) != NULL; }

	/** Creates a profile of the given type.
		If a profile of this type already exists, it will be released, as
		a COLLADA effect should only contain one profile of each type.
		@param type The profile type.
		@return The new effect profile. */
	FCDEffectProfile* AddProfile(FUDaeProfileType::Type type);
	
	/** Retrieves the number of local effect parameters
		@return The number of local effect parameters. */
	inline size_t GetEffectParameterCount() const { return parameters.size(); }

	/** Retrieves a given local effect parameter.
		@param index An index.
		@return The local effect parameter at the given index. */
	inline FCDEffectParameter* GetEffectParameter(size_t index) { FUAssert(index < parameters.size(), return NULL); return parameters.at(index); }
	inline const FCDEffectParameter* GetEffectParameter(size_t index) const { FUAssert(index < parameters.size(), return NULL); return parameters.at(index); }

	/** Adds a local effect parameter to the local list.
		@see FCDEffectParameter::Type
		@param type The value type of the effect parameter to create.
		@return The new local effect parameter. */
	FCDEffectParameter* AddEffectParameter(uint32 type);

	/** Clones the effect object.
		@param clone The clone object into which to copy the effect information.
			If this pointer is NULL, a new effect will be created and your will
			need to release the returned pointer.
		@param cloneChildren Whether to recursively clone this entity's children.
		@return The cloned effect object. You will must delete this pointer. */
	virtual FCDEntity* Clone(FCDEntity* clone = NULL, bool cloneChildren = false) const;

	/** [INTERNAL] Flattens the effect, pushing all the common effect parameters
		into to the effect technique level of abstraction. To correctly flatten a
		material, use the FCDMaterialInstance::FlattenMaterial function. */
	DEPRECATED(3.05A, not recommended) void Flatten();
};

#endif // _FCD_MATERIAL_H_