CWE-ou-minkata/MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/PubUtilLib/plSurface/plLayerAnimation.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

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, either version 3 of the License, or
(at your option) any later version.

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, see <http://www.gnu.org/licenses/>.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/

#ifndef plLayerAnimation_inc
#define plLayerAnimation_inc

#include "plLayerInterface.h"
#include "plInterp/plAnimTimeConvert.h"

class plMessage;
class plController;
class plLayerSDLModifier;
class plSimpleStateVariable;

// LayerAnimations take advantage of the simplifying
// factor that they are write only. That is, it always
// overwrites the output of previous interfaces with
// the current value of the animation. Unanimated channels
// are unaffected.

class plLayerAnimationBase : public plLayerInterface
{
protected:
	char*						fSegmentID;
	double						fEvalTime;
	hsScalar					fCurrentTime;
	hsScalar					fLength;

	plController*	fPreshadeColorCtl;
	plController*	fRuntimeColorCtl;
	plController*	fAmbientColorCtl;
	plController*	fSpecularColorCtl;
	plController*	fOpacityCtl;
	plController*	fTransformCtl;

	hsScalar IMakeUniformLength();
	void IEvalConvertedTime(hsScalar secs, UInt32 passChans, UInt32 evalChans, UInt32 &dirty);

public:
	plLayerAnimationBase();
	virtual ~plLayerAnimationBase();

	CLASSNAME_REGISTER( plLayerAnimationBase );
	GETINTERFACE_ANY( plLayerAnimationBase, plLayerInterface );
	
	virtual plLayerInterface*			Attach(plLayerInterface* prev);
	//virtual UInt32						Eval(double secs, UInt32 frame, UInt32 ignore) = 0;

	virtual hsBool						MsgReceive(plMessage* msg);

	virtual void						Read(hsStream* s, hsResMgr* mgr);
	virtual void						Write(hsStream* s, hsResMgr* mgr);

	// Specialized
	hsScalar GetLength() const { return fLength; }
	char *GetSegmentID() const { return fSegmentID; }
	void SetSegmentID(char *ID) { delete fSegmentID; fSegmentID = hsStrcpy(ID); }

	// Export construction functions follow
	void SetPreshadeColorCtl(plController* colCtl);
	void SetRuntimeColorCtl( plController *colCtl );
	void SetAmbientColorCtl(plController* ambCtl);
	void SetSpecularColorCtl(plController* ambCtl);
	void SetOpacityCtl(plController* opaCtl);
	void SetTransformCtl(plController* xfmCtl);

	plController* GetPreshadeColorCtl() const { return fPreshadeColorCtl; }
	plController* GetRuntimeColorCtl() const { return fRuntimeColorCtl; }
	plController* GetAmbientColorCtl() const { return fAmbientColorCtl; }
	plController* GetSpecularColorCtl() const { return fSpecularColorCtl; }
	plController* GetOpacityCtl() const { return fOpacityCtl; }
	plController* GetTransformCtl() const { return fTransformCtl; }
};

class plLayerAnimation : public plLayerAnimationBase
{
	friend class plLayerSDLModifier;	

protected:
	plAnimTimeConvert			fTimeConvert;
	plLayerSDLModifier*			fLayerSDLMod;	// handles sending/recving sdl state

public:
	plLayerAnimation();
	virtual ~plLayerAnimation();

	CLASSNAME_REGISTER( plLayerAnimation );
	GETINTERFACE_ANY( plLayerAnimation, plLayerAnimationBase );

	virtual plLayerInterface*			Attach(plLayerInterface* prev);
	virtual UInt32						Eval(double wSecs, UInt32 frame, UInt32 ignore);

	virtual hsBool						MsgReceive(plMessage* msg);

	virtual void						Read(hsStream* s, hsResMgr* mgr);
	virtual void						Write(hsStream* s, hsResMgr* mgr);
	
	const plLayerSDLModifier* GetSDLModifier() const { return fLayerSDLMod; }
	plAnimTimeConvert& GetTimeConvert() { return fTimeConvert; }

	void DefaultAnimation();
};

class plLayerLinkAnimation : public plLayerAnimation   
{
protected:
	plKey fLinkKey;
	hsBool fEnabled;
	plEventCallbackMsg *fIFaceCallback;

	enum
	{
		kFadeLinkPrep	= 0x01,
		kFadeLinking	= 0x02,
		kFadeCamera		= 0x04,
		kFadeIFace		= 0x08,
		kFadeCCR		= 0x10,
	};
	UInt8 fFadeFlags;
	UInt8 fLastFadeFlag;
	hsBool fFadeFlagsDirty;
	
public:
	plLayerLinkAnimation();
	~plLayerLinkAnimation();

	CLASSNAME_REGISTER( plLayerLinkAnimation );
	GETINTERFACE_ANY( plLayerLinkAnimation, plLayerAnimation );

	void SetLinkKey(plKey linkKey) { fLinkKey = linkKey; }
	plKey GetLinkKey() { return fLinkKey; }

	// NOTE: The link animation should NEVER NEVER NEVER send its state to the server.
	// NEVER!
	// If you think it should... talk to Bob. He will explain why it can't be, and beat you up.
	// If he can't remember, beat him up until he does (or ask Moose).
	virtual hsBool DirtySynchState(const char* sdlName, UInt32 sendFlags) { return false; }	// don't send link state

	virtual void Read(hsStream* s, hsResMgr* mgr);
	virtual void Write(hsStream* s, hsResMgr* mgr);
	virtual UInt32 Eval(double wSecs, UInt32 frame, UInt32 ignore);	
	virtual hsBool MsgReceive(plMessage* pMsg);
	void Enable(hsBool b) { fEnabled = b; }
	void SetFadeFlag(UInt8 flag, hsBool val);

	hsBool fLeavingAge;
};

class plLayerSDLAnimation : public plLayerAnimationBase
{
protected:
	plSimpleStateVariable *fVar;
	char *fVarName;

public:
	plLayerSDLAnimation();
	virtual ~plLayerSDLAnimation();

	CLASSNAME_REGISTER( plLayerSDLAnimation );
	GETINTERFACE_ANY( plLayerSDLAnimation, plLayerAnimationBase );

	virtual UInt32						Eval(double wSecs, UInt32 frame, UInt32 ignore);

	virtual hsBool						MsgReceive(plMessage* msg);

	virtual void						Read(hsStream* s, hsResMgr* mgr);
	virtual void						Write(hsStream* s, hsResMgr* mgr);

	char *GetVarName() { return fVarName; }
	void SetVarName(char *name);
};

#endif // plLayerAnimation_inc