orxCamera.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2022 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxCAMERA_H_
#define _orxCAMERA_H_


#include "orxInclude.h"

#include "object/orxFrame.h"
#include "object/orxStructure.h"
#include "math/orxAABox.h"


#define orxCAMERA_KU32_FLAG_NONE                        0x00000000 
#define orxCAMERA_KU32_FLAG_2D                          0x00000001 
#define orxCAMERA_KU32_MASK_USER_ALL                    0x000000FF 
#define orxCAMERA_KU32_GROUP_ID_NUMBER                  32


typedef struct __orxCAMERA_t                            orxCAMERA;


extern orxDLLAPI void orxFASTCALL                       orxCamera_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_Init();

extern orxDLLAPI void orxFASTCALL                       orxCamera_Exit();


extern orxDLLAPI orxCAMERA *orxFASTCALL                 orxCamera_Create(orxU32 _u32Flags);

extern orxDLLAPI orxCAMERA *orxFASTCALL                 orxCamera_CreateFromConfig(const orxSTRING _zConfigID);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_Delete(orxCAMERA *_pstCamera);


extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_AddGroupID(orxCAMERA *_pstCamera, orxSTRINGID _stGroupID, orxBOOL _bAddFirst);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_RemoveGroupID(orxCAMERA *_pstCamera, orxSTRINGID _stGroupID);

extern orxDLLAPI orxU32 orxFASTCALL                     orxCamera_GetGroupIDCount(const orxCAMERA *_pstCamera);

extern orxDLLAPI orxSTRINGID orxFASTCALL                orxCamera_GetGroupID(const orxCAMERA *_pstCamera, orxU32 _u32Index);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_EnableGroupIDSorting(orxCAMERA *_pstCamera, orxU32 _u32Index, orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL                    orxCamera_IsGroupIDSortingEnabled(const orxCAMERA *_pstCamera, orxU32 _u32Index);


extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_SetFrustum(orxCAMERA *_pstCamera, orxFLOAT _fWidth, orxFLOAT _fHeight, orxFLOAT _fNear, orxFLOAT _fFar);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_SetPosition(orxCAMERA *_pstCamera, const orxVECTOR *_pvPosition);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_SetRotation(orxCAMERA *_pstCamera, orxFLOAT _fRotation);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_SetZoom(orxCAMERA *_pstCamera, orxFLOAT _fZoom);

extern orxDLLAPI orxAABOX *orxFASTCALL                  orxCamera_GetFrustum(const orxCAMERA *_pstCamera, orxAABOX *_pstFrustum);

extern orxDLLAPI orxVECTOR *orxFASTCALL                 orxCamera_GetPosition(const orxCAMERA *_pstCamera, orxVECTOR *_pvPosition);

extern orxDLLAPI orxFLOAT orxFASTCALL                   orxCamera_GetRotation(const orxCAMERA *_pstCamera);

extern orxDLLAPI orxFLOAT orxFASTCALL                   orxCamera_GetZoom(const orxCAMERA *_pstCamera);

extern orxDLLAPI const orxSTRING orxFASTCALL            orxCamera_GetName(const orxCAMERA *_pstCamera);

extern orxDLLAPI orxCAMERA *orxFASTCALL                 orxCamera_Get(const orxSTRING _zName);


extern orxDLLAPI orxFRAME *orxFASTCALL                  orxCamera_GetFrame(const orxCAMERA *_pstCamera);


extern orxDLLAPI orxSTATUS orxFASTCALL                  orxCamera_SetParent(orxCAMERA *_pstCamera, void *_pParent);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxCamera_GetParent(const orxCAMERA *_pstCamera);

#endif /* _orxCAMERA_H_ */