blender/source/gameengine/Rasterizer/RAS_ICanvas.h

230 lines
3.3 KiB
C
Raw Normal View History

/*
* ***** BEGIN GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
2002-10-12 11:37:38 +00:00
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2002-10-12 11:37:38 +00:00
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*/
/** \file RAS_ICanvas.h
* \ingroup bgerast
2002-10-12 11:37:38 +00:00
*/
#ifndef __RAS_ICANVAS_H__
#define __RAS_ICANVAS_H__
#ifdef WITH_CXX_GUARDEDALLOC
#include "MEM_guardedalloc.h"
#endif
2002-10-12 11:37:38 +00:00
class RAS_Rect;
/**
* 2D rendering device context. The connection from 3d rendercontext to 2d surface.
*/
2002-10-12 11:37:38 +00:00
class RAS_ICanvas
{
public:
enum BufferType {
COLOR_BUFFER=1,
DEPTH_BUFFER=2
};
enum RAS_MouseState
{
MOUSE_INVISIBLE=1,
MOUSE_WAIT,
MOUSE_NORMAL
};
virtual
~RAS_ICanvas(
) {
};
virtual
void
Init(
) = 0;
virtual
void
BeginFrame(
)=0;
virtual
void
EndFrame(
)=0;
/**
* Initializes the canvas for drawing. Drawing to the canvas is
* only allowed between BeginDraw() and EndDraw().
*
* \retval false Acquiring the canvas failed.
* \retval true Acquiring the canvas succeeded.
2002-10-12 11:37:38 +00:00
*
*/
virtual
bool
BeginDraw(
)=0;
/**
* Unitializes the canvas for drawing.
*/
virtual
void
EndDraw(
)=0;
/// probably needs some arguments for PS2 in future
virtual
void
SwapBuffers(
)=0;
virtual
void
ClearBuffer(
int type
)=0;
virtual
void
ClearColor(
float r,
float g,
float b,
float a
)=0;
virtual
int
GetWidth(
) const = 0;
virtual
int
GetHeight(
) const = 0;
virtual
int
GetMouseX( int x
)=0;
virtual
int
GetMouseY( int y
)= 0;
virtual
float
GetMouseNormalizedX( int x
)=0;
virtual
float
GetMouseNormalizedY( int y
)= 0;
2002-10-12 11:37:38 +00:00
virtual
const RAS_Rect &
GetDisplayArea(
) const = 0;
virtual
void
SetDisplayArea(RAS_Rect *rect
2002-10-12 11:37:38 +00:00
) = 0;
/**
* Used to get canvas area within blender.
*/
virtual
RAS_Rect &
GetWindowArea(
) = 0;
2002-10-12 11:37:38 +00:00
/**
* Set the visible view-port
2002-10-12 11:37:38 +00:00
*/
virtual
void
SetViewPort(
int x1, int y1,
int x2, int y2
) = 0;
virtual
void
SetMouseState(
RAS_MouseState mousestate
)=0;
virtual
void
SetMousePosition(
int x,
int y
)=0;
Patch #21789 - BGE Keyboard and Mouse Python types - by Mitchell Stokes(Moguri) The patch exposes mouse and keyboard read-only properties in the GameLogic module Also renames bge.keys to bge.events (* Note: name of bge submodules (logic, render, ...) may change before 2.5 final release [right Campbell?]). """ This patch adds two new types to the BGE: SCA_PythonKeyboard SCA_PythonMouse These two types allow users to make use of the keyboard and mouse without the need for a keyboard or mouse sensor. SCA_PythonKeyboard has an events property that acts just like SCA_KeyboardSensor.events. SCA_PythonMouse also has an events property to check for mouse events. Further more it supports getting and setting normalized cursor position (from 0.0 to 1.0) with SCA_PythonMouse.position. The cursor can be shown/hidden using SCA_PythonMouse.visible. """ Its use is similar with current mouse and keyboard controllers. With the exception of mouse position being normalized and writable as well (replacing Rasterizer.setMousePosition). Code Sample: ###### from bge import logic, events mouse = logic.mouse keyboard = logic.keyboard for key,status in keyboard.events: if status == logic.KX_INPUT_JUST_ACTIVATED: if key == events.WKEY: print(mouse.position) # move_forward() mouse.visible = True # turn cursor visible mouse.position = 0.5,0.5 # centralize mouse - use tuple ###### * Important Note: mouse.position still will not work properly for Letterbox mode. In order to fix letterboxing I may need to move the set x,y mouse function to inside the canvas code (to avoid duplicated code between mouse sensor and bge.logic.mouse). I'll leave this for another commit though. Thanks Mitchell for the work on that.
2010-04-17 06:52:14 +00:00
virtual
RAS_MouseState
GetMouseState()
{
return m_mousestate;
}
2002-10-12 11:37:38 +00:00
virtual
void
MakeScreenShot(
const char* filename
)=0;
virtual
void
ResizeWindow(
int width,
int height
)=0;
Patch #21789 - BGE Keyboard and Mouse Python types - by Mitchell Stokes(Moguri) The patch exposes mouse and keyboard read-only properties in the GameLogic module Also renames bge.keys to bge.events (* Note: name of bge submodules (logic, render, ...) may change before 2.5 final release [right Campbell?]). """ This patch adds two new types to the BGE: SCA_PythonKeyboard SCA_PythonMouse These two types allow users to make use of the keyboard and mouse without the need for a keyboard or mouse sensor. SCA_PythonKeyboard has an events property that acts just like SCA_KeyboardSensor.events. SCA_PythonMouse also has an events property to check for mouse events. Further more it supports getting and setting normalized cursor position (from 0.0 to 1.0) with SCA_PythonMouse.position. The cursor can be shown/hidden using SCA_PythonMouse.visible. """ Its use is similar with current mouse and keyboard controllers. With the exception of mouse position being normalized and writable as well (replacing Rasterizer.setMousePosition). Code Sample: ###### from bge import logic, events mouse = logic.mouse keyboard = logic.keyboard for key,status in keyboard.events: if status == logic.KX_INPUT_JUST_ACTIVATED: if key == events.WKEY: print(mouse.position) # move_forward() mouse.visible = True # turn cursor visible mouse.position = 0.5,0.5 # centralize mouse - use tuple ###### * Important Note: mouse.position still will not work properly for Letterbox mode. In order to fix letterboxing I may need to move the set x,y mouse function to inside the canvas code (to avoid duplicated code between mouse sensor and bge.logic.mouse). I'll leave this for another commit though. Thanks Mitchell for the work on that.
2010-04-17 06:52:14 +00:00
protected:
RAS_MouseState m_mousestate;
#ifdef WITH_CXX_GUARDEDALLOC
public:
void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:RAS_ICanvas"); }
void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
2002-10-12 11:37:38 +00:00
};
#endif //__RAS_ICANVAS_H__