orx: include/render/orxCamera.h Source File

Go to the documentation of this file.
00001 /* Orx - Portable Game Engine
00002  *
00003  * Copyright (c) 2008-2011 Orx-Project
00004  *
00005  * This software is provided 'as-is', without any express or implied
00006  * warranty. In no event will the authors be held liable for any damages
00007  * arising from the use of this software.
00008  *
00009  * Permission is granted to anyone to use this software for any purpose,
00010  * including commercial applications, and to alter it and redistribute it
00011  * freely, subject to the following restrictions:
00012  *
00013  *    1. The origin of this software must not be misrepresented; you must not
00014  *    claim that you wrote the original software. If you use this software
00015  *    in a product, an acknowledgment in the product documentation would be
00016  *    appreciated but is not required.
00017  *
00018  *    2. Altered source versions must be plainly marked as such, and must not be
00019  *    misrepresented as being the original software.
00020  *
00021  *    3. This notice may not be removed or altered from any source
00022  *    distribution.
00023  */
00024 
00045 #ifndef _orxCAMERA_H_
00046 #define _orxCAMERA_H_
00047 
00048 
00049 #include "orxInclude.h"
00050 
00051 #include "object/orxFrame.h"
00052 #include "math/orxAABox.h"
00053 
00054 
00057 #define orxCAMERA_KU32_FLAG_NONE        0x00000000 
00059 #define orxCAMERA_KU32_FLAG_2D          0x00000001 
00061 #define orxCAMERA_KU32_MASK_USER_ALL    0x000000FF 
00066 typedef struct __orxCAMERA_t            orxCAMERA;
00067 
00068 
00071 extern orxDLLAPI void orxFASTCALL       orxCamera_Setup();
00072 
00075 extern orxDLLAPI orxSTATUS orxFASTCALL  orxCamera_Init();
00076 
00079 extern orxDLLAPI void orxFASTCALL       orxCamera_Exit();
00080 
00081 
00086 extern orxDLLAPI orxCAMERA *orxFASTCALL orxCamera_Create(orxU32 _u32Flags);
00087 
00092 extern orxDLLAPI orxCAMERA *orxFASTCALL orxCamera_CreateFromConfig(const orxSTRING _zConfigID);
00093 
00098 extern orxDLLAPI orxSTATUS orxFASTCALL  orxCamera_Delete(orxCAMERA *_pstCamera);
00099 
00100 
00109 extern orxDLLAPI orxSTATUS orxFASTCALL  orxCamera_SetFrustum(orxCAMERA *_pstCamera, orxFLOAT _fWidth, orxFLOAT _fHeight, orxFLOAT _fNear, orxFLOAT _fFar);
00110 
00116 extern orxDLLAPI orxSTATUS orxFASTCALL  orxCamera_SetPosition(orxCAMERA *_pstCamera, const orxVECTOR *_pvPosition);
00117 
00123 extern orxDLLAPI orxSTATUS orxFASTCALL  orxCamera_SetRotation(orxCAMERA *_pstCamera, orxFLOAT _fRotation);
00124 
00130 extern orxDLLAPI orxSTATUS orxFASTCALL  orxCamera_SetZoom(orxCAMERA *_pstCamera, orxFLOAT _fZoom);
00131 
00137 extern orxDLLAPI orxAABOX *orxFASTCALL  orxCamera_GetFrustum(const orxCAMERA *_pstCamera, orxAABOX *_pstFrustum);
00138 
00144 extern orxDLLAPI orxVECTOR *orxFASTCALL orxCamera_GetPosition(const orxCAMERA *_pstCamera, orxVECTOR *_pvPosition);
00145 
00150 extern orxDLLAPI orxFLOAT orxFASTCALL   orxCamera_GetRotation(const orxCAMERA *_pstCamera);
00151 
00156 extern orxDLLAPI orxFLOAT orxFASTCALL   orxCamera_GetZoom(const orxCAMERA *_pstCamera);
00157 
00162 extern orxDLLAPI const orxSTRING orxFASTCALL orxCamera_GetName(const orxCAMERA *_pstCamera);
00163 
00168 extern orxDLLAPI orxCAMERA *orxFASTCALL orxCamera_Get(const orxSTRING _zName);
00169 
00170 
00175 extern orxDLLAPI orxFRAME *orxFASTCALL  orxCamera_GetFrame(const orxCAMERA *_pstCamera);
00176 
00182 extern orxDLLAPI orxSTATUS orxFASTCALL  orxCamera_SetParent(orxCAMERA *_pstCamera, void *_pParent);
00183 
00184 #endif /* _orxCAMERA_H_ */
00185