orx: include/io/orxMouse.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 
00043 #ifndef _orxMOUSE_H_
00044 #define _orxMOUSE_H_
00045 
00046 #include "orxInclude.h"
00047 #include "plugin/orxPluginCore.h"
00048 #include "math/orxVector.h"
00049 
00050 
00053 typedef enum __orxMOUSE_BUTTON_t
00054 {
00055   orxMOUSE_BUTTON_LEFT = 0,
00056   orxMOUSE_BUTTON_RIGHT,
00057   orxMOUSE_BUTTON_MIDDLE,
00058   orxMOUSE_BUTTON_EXTRA_1,
00059   orxMOUSE_BUTTON_EXTRA_2,
00060   orxMOUSE_BUTTON_WHEEL_UP,
00061   orxMOUSE_BUTTON_WHEEL_DOWN,
00062   orxMOUSE_BUTTON_NUMBER,
00063 
00064   orxMOUSE_BUTTON_NONE = orxENUM_NONE
00065 
00066 } orxMOUSE_BUTTON;
00067 
00068 typedef enum __orxMOUSE_AXIS_t
00069 {
00070   orxMOUSE_AXIS_X = 0,
00071   orxMOUSE_AXIS_Y,
00072   orxMOUSE_AXIS_NUMBER,
00073 
00074   orxMOUSE_AXIS_NONE = orxENUM_NONE
00075 
00076 } orxMOUSE_AXIS;
00077 
00078 #define orxMOUSE_KZ_CONFIG_SECTION      "Mouse"
00079 #define orxMOUSE_KZ_CONFIG_SHOW_CURSOR  "ShowCursor"
00080 
00081 
00082 /***************************************************************************
00083  * Functions directly implemented by orx core
00084  ***************************************************************************/
00085 
00088 extern orxDLLAPI void orxFASTCALL             orxMouse_Setup();
00089 
00090 
00091 /***************************************************************************
00092  * Functions extended by plugins
00093  ***************************************************************************/
00094 
00098 extern orxDLLAPI orxSTATUS orxFASTCALL        orxMouse_Init();
00099 
00102 extern orxDLLAPI void orxFASTCALL             orxMouse_Exit();
00103 
00108 extern orxDLLAPI orxSTATUS orxFASTCALL        orxMouse_SetPosition(const orxVECTOR *_pvPosition);
00109 
00114 extern orxDLLAPI orxVECTOR *orxFASTCALL       orxMouse_GetPosition(orxVECTOR *_pvPosition);
00115 
00120 extern orxDLLAPI orxBOOL orxFASTCALL          orxMouse_IsButtonPressed(orxMOUSE_BUTTON _eButton);
00121 
00126 extern orxDLLAPI orxVECTOR *orxFASTCALL       orxMouse_GetMoveDelta(orxVECTOR *_pvMoveDelta);
00127 
00131 extern orxDLLAPI orxFLOAT orxFASTCALL         orxMouse_GetWheelDelta();
00132 
00136 extern orxDLLAPI orxSTATUS orxFASTCALL        orxMouse_ShowCursor(orxBOOL _bShow);
00137 
00142 extern orxDLLAPI const orxSTRING orxFASTCALL  orxMouse_GetButtonName(orxMOUSE_BUTTON _eButton);
00143 
00148 extern orxDLLAPI const orxSTRING orxFASTCALL  orxMouse_GetAxisName(orxMOUSE_AXIS _eAxis);
00149 
00150 #endif /* _orxMOUSE_H_ */
00151