orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
orxFrame.h
Go to the documentation of this file.
1/* Orx - Portable Game Engine
2 *
3 * Copyright (c) 2008- 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
34
49
50
51#ifndef _orxFRAME_H_
52#define _orxFRAME_H_
53
54#include "orxInclude.h"
55
56#include "math/orxVector.h"
57
58
61#define orxFRAME_KU32_FLAG_NONE 0x00000000
62
63#define orxFRAME_KU32_FLAG_SCROLL_X 0x00000001
64#define orxFRAME_KU32_FLAG_SCROLL_Y 0x00000002
65#define orxFRAME_KU32_MASK_SCROLL_BOTH 0x00000003
66
67#define orxFRAME_KU32_FLAG_DEPTH_SCALE 0x00000004
68
69#define orxFRAME_KU32_FLAG_IGNORE_NONE 0x00000000
70#define orxFRAME_KU32_FLAG_IGNORE_ROTATION 0x00000100
71#define orxFRAME_KU32_FLAG_IGNORE_SCALE_X 0x00000200
72#define orxFRAME_KU32_FLAG_IGNORE_SCALE_Y 0x00000400
73#define orxFRAME_KU32_FLAG_IGNORE_SCALE_Z 0x00000800
74#define orxFRAME_KU32_MASK_IGNORE_SCALE 0x00000E00
75#define orxFRAME_KU32_FLAG_IGNORE_POSITION_ROTATION 0x00001000
76#define orxFRAME_KU32_FLAG_IGNORE_POSITION_SCALE_X 0x00002000
77#define orxFRAME_KU32_FLAG_IGNORE_POSITION_SCALE_Y 0x00004000
78#define orxFRAME_KU32_FLAG_IGNORE_POSITION_SCALE_Z 0x00008000
79#define orxFRAME_KU32_MASK_IGNORE_POSITION_SCALE 0x0000E000
80#define orxFRAME_KU32_FLAG_IGNORE_POSITION_POSITION_X 0x00010000
81#define orxFRAME_KU32_FLAG_IGNORE_POSITION_POSITION_Y 0x00020000
82#define orxFRAME_KU32_FLAG_IGNORE_POSITION_POSITION_Z 0x00040000
83#define orxFRAME_KU32_MASK_IGNORE_POSITION_POSITION 0x00070000
84#define orxFRAME_KU32_MASK_IGNORE_POSITION 0x0007F000
85#define orxFRAME_KU32_MASK_IGNORE_ALL 0x0007FF00
86
87#define orxFRAME_KU32_MASK_USER_ALL 0x0007FFFF
88
89
92typedef enum __orxFRAME_SPACE_t
93{
96
98
99 orxFRAME_SPACE_NONE = orxENUM_NONE
100
102
103
106typedef struct __orxFRAME_t orxFRAME;
107
108
113extern orxDLLAPI orxU32 orxFASTCALL orxFrame_GetIgnoreFlagValues(const orxSTRING _zFlags);
114
119extern orxDLLAPI const orxSTRING orxFASTCALL orxFrame_GetIgnoreFlagNames(orxU32 _u32Flags);
120
121
124extern orxDLLAPI void orxFASTCALL orxFrame_Setup();
125
129extern orxDLLAPI orxSTATUS orxFASTCALL orxFrame_Init();
130
133extern orxDLLAPI void orxFASTCALL orxFrame_Exit();
134
135
140extern orxDLLAPI orxFRAME *orxFASTCALL orxFrame_Create(orxU32 _u32Flags);
141
146extern orxDLLAPI orxSTATUS orxFASTCALL orxFrame_Delete(orxFRAME *_pstFrame);
147
148
153extern orxDLLAPI void orxFASTCALL orxFrame_SetParent(orxFRAME *_pstFrame, orxFRAME * _pstParent);
154
159extern orxDLLAPI orxFRAME *orxFASTCALL orxFrame_GetParent(const orxFRAME *_pstFrame);
160
165extern orxDLLAPI orxFRAME *orxFASTCALL orxFrame_GetChild(const orxFRAME *_pstFrame);
166
171extern orxDLLAPI orxFRAME *orxFASTCALL orxFrame_GetSibling(const orxFRAME *_pstFrame);
172
177extern orxDLLAPI orxBOOL orxFASTCALL orxFrame_IsRootChild(const orxFRAME *_pstFrame);
178
179
185extern orxDLLAPI void orxFASTCALL orxFrame_SetPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, const orxVECTOR *_pvPos);
186
192extern orxDLLAPI void orxFASTCALL orxFrame_SetRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxFLOAT _fRotation);
193
199extern orxDLLAPI void orxFASTCALL orxFrame_SetScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, const orxVECTOR *_pvScale);
200
201
208extern orxDLLAPI orxVECTOR *orxFASTCALL orxFrame_GetPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvPos);
209
215extern orxDLLAPI orxFLOAT orxFASTCALL orxFrame_GetRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace);
216
223extern orxDLLAPI orxVECTOR *orxFASTCALL orxFrame_GetScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvScale);
224
225
232extern orxDLLAPI orxVECTOR *orxFASTCALL orxFrame_TransformPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvPos);
233
240extern orxDLLAPI orxFLOAT orxFASTCALL orxFrame_TransformRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxFLOAT _fRotation);
241
248extern orxDLLAPI orxVECTOR *orxFASTCALL orxFrame_TransformScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvScale);
249
250#endif /* _orxFRAME_H_ */
251
#define orxDLLAPI
Definition orxDecl.h:381
orxDLLAPI orxFLOAT orxFASTCALL orxFrame_TransformRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxFLOAT _fRotation)
orxDLLAPI void orxFASTCALL orxFrame_SetScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, const orxVECTOR *_pvScale)
orxDLLAPI orxFRAME *orxFASTCALL orxFrame_GetParent(const orxFRAME *_pstFrame)
orxFRAME_SPACE
Definition orxFrame.h:93
orxDLLAPI orxSTATUS orxFASTCALL orxFrame_Delete(orxFRAME *_pstFrame)
orxDLLAPI void orxFASTCALL orxFrame_Setup()
orxDLLAPI orxVECTOR *orxFASTCALL orxFrame_GetScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvScale)
orxDLLAPI orxFRAME *orxFASTCALL orxFrame_GetChild(const orxFRAME *_pstFrame)
orxDLLAPI orxFRAME *orxFASTCALL orxFrame_Create(orxU32 _u32Flags)
orxDLLAPI orxVECTOR *orxFASTCALL orxFrame_TransformScale(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvScale)
orxDLLAPI orxVECTOR *orxFASTCALL orxFrame_TransformPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvPos)
orxDLLAPI orxU32 orxFASTCALL orxFrame_GetIgnoreFlagValues(const orxSTRING _zFlags)
orxDLLAPI orxVECTOR *orxFASTCALL orxFrame_GetPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxVECTOR *_pvPos)
orxDLLAPI void orxFASTCALL orxFrame_SetPosition(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, const orxVECTOR *_pvPos)
orxDLLAPI orxBOOL orxFASTCALL orxFrame_IsRootChild(const orxFRAME *_pstFrame)
orxDLLAPI void orxFASTCALL orxFrame_SetParent(orxFRAME *_pstFrame, orxFRAME *_pstParent)
orxDLLAPI const orxSTRING orxFASTCALL orxFrame_GetIgnoreFlagNames(orxU32 _u32Flags)
orxDLLAPI void orxFASTCALL orxFrame_SetRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace, orxFLOAT _fRotation)
orxDLLAPI orxFRAME *orxFASTCALL orxFrame_GetSibling(const orxFRAME *_pstFrame)
orxDLLAPI orxFLOAT orxFASTCALL orxFrame_GetRotation(orxFRAME *_pstFrame, orxFRAME_SPACE _eSpace)
orxDLLAPI orxSTATUS orxFASTCALL orxFrame_Init()
orxDLLAPI void orxFASTCALL orxFrame_Exit()
@ orxFRAME_SPACE_NONE
Definition orxFrame.h:99
@ orxFRAME_SPACE_NUMBER
Definition orxFrame.h:97
@ orxFRAME_SPACE_LOCAL
Definition orxFrame.h:95
@ orxFRAME_SPACE_GLOBAL
Definition orxFrame.h:94
#define orxFRAME(STRUCTURE)
orxSTATUS
Definition orxType.h:270

Generated for orx by doxygen 1.8.11