forked from bartvdbraak/blender
c85de34c26
This is 'ported' from Nicholas Bishop's sculpting GSoC tree. I'm bringing it over now so a) it can be there for when lukep does his GHOST refactor b) it's something that GHOST should have anyway, particularly now there's interest in painting tools and c) it's missing support in Windows, so hopefully now some enterprising Windows coder can add that more easily in the main bf tree. Right now X11 and Mac OS X are supported. I added and can maintain the Mac OS X part, but I'm not familiar with the Xinput stuff, which Nicholas wrote. Both X11 and Mac are collecting active device and pressure, and Mac is also collecting x and y tilt data. Up to coders how they want to use this info! :) Although the data's coming in, I haven't actually made this do anything. I thought it best to leave it to brecht to figure out what he wants to do with the painting stuff, and I wonder what other interesting uses there could be for it (proportional edit?). I'll write implementation details in a separate mail to the committers list.
262 lines
7.8 KiB
C++
262 lines
7.8 KiB
C++
/**
|
|
* $Id$
|
|
* ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
|
|
*
|
|
* 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. The Blender
|
|
* Foundation also sells licenses for use in proprietary software under
|
|
* the Blender License. See http://www.blender.org/BL/ for information
|
|
* about this.
|
|
*
|
|
* 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,
|
|
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*
|
|
* 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/BL DUAL LICENSE BLOCK *****
|
|
*/
|
|
/**
|
|
* @file GHOST_IWindow.h
|
|
* Declaration of GHOST_IWindow interface class.
|
|
*/
|
|
|
|
#ifndef _GHOST_IWINDOW_H_
|
|
#define _GHOST_IWINDOW_H_
|
|
|
|
#include "STR_String.h"
|
|
#include "GHOST_Rect.h"
|
|
#include "GHOST_Types.h"
|
|
|
|
|
|
/**
|
|
* Interface for GHOST windows.
|
|
*
|
|
* You can create a window with the system's GHOST_ISystem::createWindow
|
|
* method.
|
|
* @see GHOST_ISystem#createWindow
|
|
*
|
|
* There are two coordinate systems:
|
|
* <ul>
|
|
* <li>The screen coordinate system. The origin of the screen is located in the
|
|
* upper left corner of the screen.</li>
|
|
* <li>The client rectangle coordinate system. The client rectangle of a window
|
|
* is the area that is drawable by the application (excluding title bars etc.).
|
|
* </li>
|
|
* </ul>
|
|
* @author Maarten Gribnau
|
|
* @date May 31, 2001
|
|
*/
|
|
class GHOST_IWindow
|
|
{
|
|
public:
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~GHOST_IWindow()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Returns indication as to whether the window is valid.
|
|
* @return The validity of the window.
|
|
*/
|
|
virtual bool getValid() const = 0;
|
|
|
|
/**
|
|
* Returns the type of drawing context used in this window.
|
|
* @return The current type of drawing context.
|
|
*/
|
|
virtual GHOST_TDrawingContextType getDrawingContextType() = 0;
|
|
|
|
/**
|
|
* Tries to install a rendering context in this window.
|
|
* @param type The type of rendering context installed.
|
|
* @return Indication as to whether installation has succeeded.
|
|
*/
|
|
virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0;
|
|
|
|
/**
|
|
* Sets the title displayed in the title bar.
|
|
* @param title The title to display in the title bar.
|
|
*/
|
|
virtual void setTitle(const STR_String& title) = 0;
|
|
|
|
/**
|
|
* Returns the title displayed in the title bar.
|
|
* @param title The title displayed in the title bar.
|
|
*/
|
|
virtual void getTitle(STR_String& title) const = 0;
|
|
|
|
/**
|
|
* Returns the window rectangle dimensions.
|
|
* These are screen coordinates.
|
|
* @param bounds The bounding rectangle of the window.
|
|
*/
|
|
virtual void getWindowBounds(GHOST_Rect& bounds) const = 0;
|
|
|
|
/**
|
|
* Returns the client rectangle dimensions.
|
|
* The left and top members of the rectangle are always zero.
|
|
* @param bounds The bounding rectangle of the client area of the window.
|
|
*/
|
|
virtual void getClientBounds(GHOST_Rect& bounds) const = 0;
|
|
|
|
/**
|
|
* Resizes client rectangle width.
|
|
* @param width The new width of the client area of the window.
|
|
*/
|
|
virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
|
|
|
|
/**
|
|
* Resizes client rectangle height.
|
|
* @param height The new height of the client area of the window.
|
|
*/
|
|
virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
|
|
|
|
/**
|
|
* Resizes client rectangle.
|
|
* @param width The new width of the client area of the window.
|
|
* @param height The new height of the client area of the window.
|
|
*/
|
|
virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
|
|
|
|
/**
|
|
* Converts a point in screen coordinates to client rectangle coordinates
|
|
* @param inX The x-coordinate on the screen.
|
|
* @param inY The y-coordinate on the screen.
|
|
* @param outX The x-coordinate in the client rectangle.
|
|
* @param outY The y-coordinate in the client rectangle.
|
|
*/
|
|
virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
|
|
|
|
/**
|
|
* Converts a point in screen coordinates to client rectangle coordinates
|
|
* @param inX The x-coordinate in the client rectangle.
|
|
* @param inY The y-coordinate in the client rectangle.
|
|
* @param outX The x-coordinate on the screen.
|
|
* @param outY The y-coordinate on the screen.
|
|
*/
|
|
virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
|
|
|
|
/**
|
|
* Returns the state of the window (normal, minimized, maximized).
|
|
* @return The state of the window.
|
|
*/
|
|
virtual GHOST_TWindowState getState() const = 0;
|
|
|
|
/**
|
|
* Sets the state of the window (normal, minimized, maximized).
|
|
* @param state The state of the window.
|
|
* @return Indication of success.
|
|
*/
|
|
virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
|
|
|
|
/**
|
|
* Sets the order of the window (bottom, top).
|
|
* @param order The order of the window.
|
|
* @return Indication of success.
|
|
*/
|
|
virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
|
|
|
|
/**
|
|
* Swaps front and back buffers of a window.
|
|
* @return A boolean success indicator.
|
|
*/
|
|
virtual GHOST_TSuccess swapBuffers() = 0;
|
|
|
|
/**
|
|
* Activates the drawing context of this window.
|
|
* @return A boolean success indicator.
|
|
*/
|
|
virtual GHOST_TSuccess activateDrawingContext() = 0;
|
|
|
|
/**
|
|
* Invalidates the contents of this window.
|
|
* @return Indication of success.
|
|
*/
|
|
virtual GHOST_TSuccess invalidate() = 0;
|
|
|
|
/**
|
|
* Returns the window user data.
|
|
* @return The window user data.
|
|
*/
|
|
virtual GHOST_TUserDataPtr getUserData() const = 0;
|
|
|
|
/**
|
|
* Changes the window user data.
|
|
* @param data The window user data.
|
|
*/
|
|
virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
|
|
|
|
/**
|
|
* Returns the tablet data (pressure etc).
|
|
* @return The tablet data (pressure etc).
|
|
*/
|
|
virtual const GHOST_TabletData* GetTabletData() = 0;
|
|
|
|
/***************************************************************************************
|
|
** Cursor management functionality
|
|
***************************************************************************************/
|
|
|
|
/**
|
|
* Returns the current cursor shape.
|
|
* @return The current cursor shape.
|
|
*/
|
|
virtual GHOST_TStandardCursor getCursorShape() const = 0;
|
|
|
|
/**
|
|
* Set the shape of the cursor.
|
|
* @param cursor The new cursor shape type id.
|
|
* @return Indication of success.
|
|
*/
|
|
virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0;
|
|
|
|
/**
|
|
* Set the shape of the cursor to a custom cursor.
|
|
* @param bitmap The bitmap data for the cursor.
|
|
* @param mask The mask data for the cursor.
|
|
* @param hotX The X coordinate of the cursor hotspot.
|
|
* @param hotY The Y coordinate of the cursor hotspot.
|
|
* @return Indication of success.
|
|
*/
|
|
virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2],
|
|
GHOST_TUns8 mask[16][2],
|
|
int hotX,
|
|
int hotY) = 0;
|
|
|
|
virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap,
|
|
GHOST_TUns8 *mask,
|
|
int sizex, int sizey,
|
|
int hotX, int hotY,
|
|
int fg_color, int bg_color) = 0;
|
|
|
|
/**
|
|
* Returns the visibility state of the cursor.
|
|
* @return The visibility state of the cursor.
|
|
*/
|
|
virtual bool getCursorVisibility() const = 0;
|
|
|
|
/**
|
|
* Shows or hides the cursor.
|
|
* @param visible The new visibility state of the cursor.
|
|
* @return Indication of success.
|
|
*/
|
|
virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0;
|
|
};
|
|
|
|
#endif // _GHOST_IWINDOW_H_
|
|
|