orx  stable
Portable Game Engine
orxAnimSet.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2017 Orx-Project
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  *
18  * 2. Altered source versions must be plainly marked as such, and must not be
19  * misrepresented as being the original software.
20  *
21  * 3. This notice may not be removed or altered from any source
22  * distribution.
23  */
24 
47 #ifndef _orxANIMSET_H_
48 #define _orxANIMSET_H_
49 
50 
51 #include "orxInclude.h"
52 
53 #include "anim/orxAnim.h"
54 
55 
58 #define orxANIMSET_KU32_FLAG_NONE 0x00000000
60 #define orxANIMSET_KU32_FLAG_REFERENCE_LOCK 0x00100000
61 #define orxANIMSET_KU32_FLAG_LINK_STATIC 0x00200000
65 #define orxANIMSET_KU32_LINK_FLAG_NONE 0x00000000
67 #define orxANIMSET_KU32_LINK_FLAG_LOOP_COUNTER 0x10000000
68 #define orxANIMSET_KU32_LINK_FLAG_PRIORITY 0x20000000
69 #define orxANIMSET_KU32_LINK_FLAG_IMMEDIATE_CUT 0x40000000
70 #define orxANIMSET_KU32_LINK_FLAG_CLEAR_TARGET 0x80000000
74 #define orxANIMSET_KU32_MAX_ANIM_NUMBER 128
79 typedef struct __orxANIMSET_t orxANIMSET;
80 
83 typedef struct __orxANIMSET_LINK_TABLE_t orxANIMSET_LINK_TABLE;
84 
85 
88 extern orxDLLAPI void orxFASTCALL orxAnimSet_Setup();
89 
93 extern orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_Init();
94 
97 extern orxDLLAPI void orxFASTCALL orxAnimSet_Exit();
98 
99 
104 extern orxDLLAPI orxANIMSET *orxFASTCALL orxAnimSet_Create(orxU32 _u32Size);
105 
110 extern orxDLLAPI orxANIMSET *orxFASTCALL orxAnimSet_CreateFromConfig(const orxSTRING _zConfigID);
111 
115 extern orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_Delete(orxANIMSET *_pstAnimSet);
116 
120 extern orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_ClearCache();
121 
125 extern orxDLLAPI void orxFASTCALL orxAnimSet_AddReference(orxANIMSET *_pstAnimSet);
126 
130 extern orxDLLAPI void orxFASTCALL orxAnimSet_RemoveReference(orxANIMSET *_pstAnimSet);
131 
136 extern orxDLLAPI orxANIMSET_LINK_TABLE *orxFASTCALL orxAnimSet_CloneLinkTable(const orxANIMSET *_pstAnimSet);
137 
141 extern orxDLLAPI void orxFASTCALL orxAnimSet_DeleteLinkTable(orxANIMSET_LINK_TABLE *_pstLinkTable);
142 
143 
149 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_AddAnim(orxANIMSET *_pstAnimSet, orxANIM *_pstAnim);
150 
156 extern orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_RemoveAnim(orxANIMSET *_pstAnimSet, orxU32 _u32AnimID);
157 
162 extern orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_RemoveAllAnims(orxANIMSET *_pstAnimSet);
163 
164 
171 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_AddLink(orxANIMSET *_pstAnimSet, orxU32 _u32SrcAnim, orxU32 _u32DstAnim);
172 
178 extern orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_RemoveLink(orxANIMSET *_pstAnimSet, orxU32 _u32LinkID);
179 
186 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetLink(const orxANIMSET *_pstAnimSet, orxU32 _u32SrcAnim, orxU32 _u32DstAnim);
187 
195 extern orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_SetLinkProperty(orxANIMSET *_pstAnimSet, orxU32 _u32LinkID, orxU32 _u32Property, orxU32 _u32Value);
196 
203 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetLinkProperty(const orxANIMSET *_pstAnimSet, orxU32 _u32LinkID, orxU32 _u32Property);
204 
215 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_ComputeAnim(orxANIMSET *_pstAnimSet, orxU32 _u32SrcAnim, orxU32 _u32DstAnim, orxFLOAT *_pfTime, orxANIMSET_LINK_TABLE *_pstLinkTable, orxBOOL *_pbCut, orxBOOL *_pbClearTarget);
216 
223 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_FindNextAnim(orxANIMSET *_pstAnimSet, orxU32 _u32SrcAnim, orxU32 _u32DstAnim);
224 
230 extern orxDLLAPI orxANIM *orxFASTCALL orxAnimSet_GetAnim(const orxANIMSET *_pstAnimSet, orxU32 _u32AnimID);
231 
236 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetAnimStorageSize(const orxANIMSET *_pstAnimSet);
237 
242 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetAnimCounter(const orxANIMSET *_pstAnimSet);
243 
249 extern orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetAnimIDFromName(const orxANIMSET *_pstAnimSet, const orxSTRING _zAnimName);
250 
255 extern orxDLLAPI const orxSTRING orxFASTCALL orxAnimSet_GetName(const orxANIMSET *_pstAnimSet);
256 
257 #endif /* _orxANIMSET_H_ */
258 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_Delete(orxANIMSET *_pstAnimSet)
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetAnimIDFromName(const orxANIMSET *_pstAnimSet, const orxSTRING _zAnimName)
orxDLLAPI orxANIMSET *orxFASTCALL orxAnimSet_Create(orxU32 _u32Size)
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetAnimStorageSize(const orxANIMSET *_pstAnimSet)
orxDLLAPI void orxFASTCALL orxAnimSet_RemoveReference(orxANIMSET *_pstAnimSet)
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetLink(const orxANIMSET *_pstAnimSet, orxU32 _u32SrcAnim, orxU32 _u32DstAnim)
orxDLLAPI orxANIM *orxFASTCALL orxAnimSet_GetAnim(const orxANIMSET *_pstAnimSet, orxU32 _u32AnimID)
orxDLLAPI void orxFASTCALL orxAnimSet_AddReference(orxANIMSET *_pstAnimSet)
orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_RemoveLink(orxANIMSET *_pstAnimSet, orxU32 _u32LinkID)
orxDLLAPI void orxFASTCALL orxAnimSet_Exit()
orxDLLAPI void orxFASTCALL orxAnimSet_Setup()
orxSTATUS
Definition: orxType.h:243
struct __orxANIMSET_t orxANIMSET
Definition: orxAnimSet.h:79
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_ComputeAnim(orxANIMSET *_pstAnimSet, orxU32 _u32SrcAnim, orxU32 _u32DstAnim, orxFLOAT *_pfTime, orxANIMSET_LINK_TABLE *_pstLinkTable, orxBOOL *_pbCut, orxBOOL *_pbClearTarget)
struct __orxANIMSET_LINK_TABLE_t orxANIMSET_LINK_TABLE
Definition: orxAnimSet.h:83
#define orxDLLAPI
Definition: orxDecl.h:387
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetAnimCounter(const orxANIMSET *_pstAnimSet)
orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_RemoveAnim(orxANIMSET *_pstAnimSet, orxU32 _u32AnimID)
orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_ClearCache()
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_GetLinkProperty(const orxANIMSET *_pstAnimSet, orxU32 _u32LinkID, orxU32 _u32Property)
orxDLLAPI void orxFASTCALL orxAnimSet_DeleteLinkTable(orxANIMSET_LINK_TABLE *_pstLinkTable)
orxDLLAPI orxANIMSET_LINK_TABLE *orxFASTCALL orxAnimSet_CloneLinkTable(const orxANIMSET *_pstAnimSet)
orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_SetLinkProperty(orxANIMSET *_pstAnimSet, orxU32 _u32LinkID, orxU32 _u32Property, orxU32 _u32Value)
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_AddLink(orxANIMSET *_pstAnimSet, orxU32 _u32SrcAnim, orxU32 _u32DstAnim)
struct __orxANIM_t orxANIM
Definition: orxAnim.h:74
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_AddAnim(orxANIMSET *_pstAnimSet, orxANIM *_pstAnim)
orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_RemoveAllAnims(orxANIMSET *_pstAnimSet)
orxDLLAPI orxU32 orxFASTCALL orxAnimSet_FindNextAnim(orxANIMSET *_pstAnimSet, orxU32 _u32SrcAnim, orxU32 _u32DstAnim)
orxDLLAPI const orxSTRING orxFASTCALL orxAnimSet_GetName(const orxANIMSET *_pstAnimSet)
orxDLLAPI orxSTATUS orxFASTCALL orxAnimSet_Init()
orxDLLAPI orxANIMSET *orxFASTCALL orxAnimSet_CreateFromConfig(const orxSTRING _zConfigID)

Generated for orx by doxygen 1.5.6