IND_AnimationManager Class Reference
[IND_AnimationManager]

List of all members.

Public Member Functions
bool	Init (IND_ImageManager *pImageManager, IND_SurfaceManager *pSurfaceManager)
void	End ()
bool	AddToImage (IND_Animation *pNewAnimation, char *pAnimation)
bool	AddToSurface (IND_Animation *pNewAnimation, char *pAnimation, IND_Type pType, IND_Quality pQuality)
bool	AddToSurface (IND_Animation *pNewAnimation, char *pAnimation, IND_Type pType, IND_Quality pQuality, byte pR, byte pG, byte pB)
bool	AddToSurface (IND_Animation *pNewAnimation, char *pAnimation, int pBlockSize, IND_Type pType, IND_Quality pQuality)
bool	AddToSurface (IND_Animation *pNewAnimation, char *pAnimation, int pBlockSize, IND_Type pType, IND_Quality pQuality, byte pR, byte pG, byte pB)
bool	Delete (IND_Animation *pAn)

---

Detailed Description

Manager of IND_Animation objects. Used for storing these type of objects.

---

Member Function Documentation

bool IND_AnimationManager::Init	(	IND_ImageManager *	pImageManager,
		IND_SurfaceManager *	pSurfaceManager
	)

Parameters:

• pImageManager Pointer to the manager IND_ImageManager correctly initialized
• pSurfaceManager Pointer to the manager IND_SurfaceManager correctly initialized

Operation:

This function returns 1 (true) if the adminstrator is successfully initialized. Must be called before using any method.

void IND_AnimationManager::End

(

)

Operation:

This function frees the manager and all the objects that it contains.

bool IND_AnimationManager::AddToImage	(	IND_Animation *	pNewAnimation,
		char *	pAnimation
	)

Parameters:

• pNewAnimation Pointer to a new animation object.
• pAnimation Name of the animation XML script.

Operation:

This function returns 1 (true) if the animation file exists and is added successfully to the manager, loading the frames as IND_Image objects. So this animation won't be able to be drawn to the screen directly, but you will be able to modify the IND_Image objects (for applying a filter, for example) accessing to them trough the GetImage() function.

Once they have been modified, they can be converted to IND_Surfaces and applied to the animation using SetSurface() and then the animation will be able to be drawn correctly

bool IND_AnimationManager::AddToSurface	(	IND_Animation *	pNewAnimation,
		char *	pAnimation,
		IND_Type	pType,
		IND_Quality	pQuality
	)

Parameters:

• pNewAnimation Pointer to a new animation object.
• mAnimation Name of the animation file.
• pType Surface type (see IND_Type)
• pQuality Surface quality (see IND_Quality)

Operation:

This function returns 1 (true) if the animation file exists and is added successfully to the manager loading the frames as IND_Surface objects. So, we will be able to draw this animation directly.

bool IND_AnimationManager::AddToSurface	(	IND_Animation *	pNewAnimation,
		char *	pAnimation,
		IND_Type	pType,
		IND_Quality	pQuality,
		byte	pR,
		byte	pG,
		byte	pB
	)

Parameters:

• pNewAnimation Pointer to a new animation object.
• mAnimation Name of the animation XML script.
• pType Surface type (see IND_Type)
• pQuality Surface quality (see IND_Quality)
• pR, pG, pB Color where the colorkey will be applied, this areas will become transparent.

Operation:

This function returns 1 (true) if the animation file exists and is added successfully to the manager, loading the frames with IND_Surface objects. So, we will be able to draw this animation directly. Furthermore, it uses the color passed as a parameter to apply a colorkey to the image. So, the zones coloured with this colour will be transparent.

bool IND_AnimationManager::AddToSurface	(	IND_Animation *	pNewAnimation,
		char *	pAnimation,
		int	pBlockSize,
		IND_Type	pType,
		IND_Quality	pQuality
	)

Parameters:

• pNewAnimation Pointer to a new animation object.
• pAnimation Name of the animation file.
• pBlockSize Width of the blocks
• pType Surface type (see IND_Type)
• pQuality Surface quality (see IND_Quality)

Operation:

This function returns 1 (true) if the animation file exists and is added successfully to the manager loading the frames as IND_Surface objects. So, we will be able to draw this animation directly.

bool IND_AnimationManager::AddToSurface	(	IND_Animation *	pNewAnimation,
		char *	pAnimation,
		int	pBlockSize,
		IND_Type	pType,
		IND_Quality	pQuality,
		byte	pR,
		byte	pG,
		byte	pB
	)

Parameters:

• pNewAnimation Pointer to a new animation object.
• pAnimation Name of the animation XML script.
• pBlockSize Width of the blocks
• pType Surface type (see IND_Type)
• pQuality Surface quality (see IND_Quality)
• pR, pG, pB Color where the colorkey will be applied, this areas will become transparent.

Operation:

This function returns 1 (true) if the animation file exists and is added successfully to the manager, loading the frames with IND_Surface objects. So, we will be able to draw this animation directly. Furthermore, it uses the color passed as a parameter to apply a colorkey to the image. So, the areas coloured with this color will become transparent.

bool IND_AnimationManager::Delete

(

IND_Animation *

pAn

)

Parameters:

• pAn Pointer to an animation object.

Operation:

This function returns 1 (true) if the animation object passed as a parameter exists and it is successfully eliminated.

---

The documentation for this class was generated from the following files:

• G:/trabajo/programacion/IndieLib/IndieLib/Common/LibHeaders/IND_AnimationManager.h
• G:/trabajo/programacion/IndieLib/IndieLib/Common/LibSources/IND_AnimationManager.cpp

---