Files
itgmania212121/stepmania/src/ActorUtil.h
T

90 lines
3.9 KiB
C++
Raw Normal View History

2005-02-09 05:31:14 +00:00
/* ActorUtil - Utility functions for creating and manipulating Actors. */
2005-02-09 05:27:51 +00:00
2003-04-13 21:52:50 +00:00
#ifndef ActorUtil_H
#define ActorUtil_H
#include "Actor.h"
#include "RageTexture.h"
2003-04-13 21:52:50 +00:00
2005-01-07 14:28:00 +00:00
struct XNode;
2003-04-13 21:52:50 +00:00
2005-02-09 05:31:14 +00:00
typedef Actor* (*CreateActorFn)(const CString& sDir, const XNode* pNode);
// Each Actor class should have a REGISTER_ACTOR_CLASS in its CPP file.
#define REGISTER_ACTOR_CLASS( className ) \
Actor* Create##className(const CString& sDir, const XNode* pNode) { \
className *pRet = new className; \
pRet->LoadFromNode(sDir, pNode); \
return pRet; } \
class Register##className { \
public: \
Register##className() { ActorUtil::Register(#className,Create##className); } \
}; \
static Register##className register##className;
2003-04-13 21:52:50 +00:00
2005-01-17 05:42:52 +00:00
namespace ActorUtil
{
2005-02-09 05:31:14 +00:00
// Every screen should register its class at program initialization.
void Register( const CString& sClassName, CreateActorFn pfn );
Actor* Create( const CString& sClassName, const CString& sDir, const XNode* pNode );
2005-01-17 05:42:52 +00:00
void SetXY( Actor& actor, const CString &sScreenName );
inline void SetXY( Actor* pActor, const CString &sScreenName ) { SetXY( *pActor, sScreenName ); }
2003-09-21 02:36:48 +00:00
2005-01-17 22:45:00 +00:00
void RunCommand( Actor& actor, const CString &sScreenName, const CString &sCommandName );
2005-01-17 22:45:00 +00:00
inline void OnCommand( Actor& actor, const CString &sScreenName ) { RunCommand( actor, sScreenName, "On" ); }
inline void OffCommand( Actor& actor, const CString &sScreenName ) { RunCommand( actor, sScreenName, "Off" ); }
2005-01-17 05:42:52 +00:00
inline void SetXYAndOnCommand( Actor& actor, const CString &sScreenName )
{
SetXY( actor, sScreenName );
OnCommand( actor, sScreenName );
}
2005-01-17 05:42:52 +00:00
/* convenience */
2005-01-17 22:45:00 +00:00
inline void RunCommand( Actor* pActor, const CString &sScreenName, const CString &sCommandName ) { if(pActor) RunCommand( *pActor, sScreenName, sCommandName ); }
2005-01-17 05:42:52 +00:00
inline void OnCommand( Actor* pActor, const CString &sScreenName ) { if(pActor) OnCommand( *pActor, sScreenName ); }
inline void OffCommand( Actor* pActor, const CString &sScreenName ) { if(pActor) OffCommand( *pActor, sScreenName ); }
inline void SetXYAndOnCommand( Actor* pActor, const CString &sScreenName ) { if(pActor) SetXYAndOnCommand( *pActor, sScreenName ); }
// Return a Sprite, BitmapText, or Model depending on the file type
Actor* LoadFromActorFile( const CString& sAniDir, const XNode* pNode );
Actor* MakeActor( const RageTextureID &ID );
};
2003-09-21 02:36:48 +00:00
2005-02-09 05:27:51 +00:00
#define SET_XY( actor ) ActorUtil::SetXY( actor, m_sName )
#define ON_COMMAND( actor ) ActorUtil::OnCommand( actor, m_sName )
#define OFF_COMMAND( actor ) ActorUtil::OffCommand( actor, m_sName )
#define SET_XY_AND_ON_COMMAND( actor ) ActorUtil::SetXYAndOnCommand( actor, m_sName )
#define COMMAND( actor, command_name ) ActorUtil::RunCommand( actor, m_sName, command_name )
2003-09-21 02:36:48 +00:00
2003-06-30 06:05:05 +00:00
#endif
2004-06-08 00:47:53 +00:00
/*
* (c) 2003-2004 Chris Danford
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, and/or sell copies of the Software, and to permit persons to
* whom the Software is furnished to do so, provided that the above
* copyright notice(s) and this permission notice appear in all copies of
* the Software and that both the above copyright notice(s) and this
* permission notice appear in supporting documentation.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/