Logo Search packages:      
Sourcecode: blender version File versions

GHOST_System.h

Go to the documentation of this file.
/**
 * $Id: GHOST_System.h,v 1.6 2002/12/28 22:26:45 maarten Exp $
 * ***** 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_System.h
 * Declaration of GHOST_System class.
 */

#ifndef _GHOST_SYSTEM_H_
#define _GHOST_SYSTEM_H_

#include "GHOST_ISystem.h"

#include "GHOST_Debug.h"
#include "GHOST_Buttons.h"
#include "GHOST_ModifierKeys.h"
#include "GHOST_EventManager.h"
#ifdef GHOST_DEBUG
#include "GHOST_EventPrinter.h"
#endif // GHOST_DEBUG

class GHOST_DisplayManager;
class GHOST_Event;
class GHOST_TimerManager;
class GHOST_Window;
class GHOST_WindowManager;

/**
 * Implementation of platform independent functionality of the GHOST_ISystem
 * interface.
 * GHOST_System is an abstract class because not all methods of GHOST_ISystem
 * are implemented.
 * @see GHOST_ISystem.
 * @author  Maarten Gribnau
 * @date    May 7, 2001
 */
00064 class GHOST_System : public GHOST_ISystem
{
protected:
      /**
       * Constructor.
       * Protected default constructor to force use of static createSystem member.
       */
      GHOST_System();

      /**
       * Destructor.
       * Protected default constructor to force use of static dispose member.
       */
      virtual ~GHOST_System();

public:
      /***************************************************************************************
       ** Time(r) functionality
       ***************************************************************************************/

      /**
       * Returns the system time.
       * Returns the number of milliseconds since the start of the system process.
       * Based on ANSI clock() routine.
       * @return The number of milliseconds.
       */
      virtual GHOST_TUns64 getMilliSeconds() const;

      /**
       * Installs a timer.
       * Note that, on most operating systems, messages need to be processed in order 
       * for the timer callbacks to be invoked.
       * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
       * @param interval      The interval between calls to the timerProc
       * @param timerProc     The callback invoked when the interval expires,
       * @param userData      Placeholder for user data.
       * @return A timer task (0 if timer task installation failed).
       */
      virtual GHOST_ITimerTask* installTimer(GHOST_TUns64 delay, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = 0);

      /**
       * Removes a timer.
       * @param timerTask Timer task to be removed.
       * @return Indication of success.
       */
      virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask* timerTask);

      /***************************************************************************************
       ** Display/window management functionality
       ***************************************************************************************/
      
      /**
       * Inherited from GHOST_ISystem but left pure virtual
       *
       * virtual  GHOST_TUns8 getNumDisplays() const = 0;
       * virtual void getMainDisplayDimensions(...) const = 0;
       * virtual GHOST_IWindow* createWindow(..)
       */

      /**
       * Dispose a window.
       * @param   window Pointer to the window to be disposed.
       * @return  Indication of success.
       */
      virtual GHOST_TSuccess disposeWindow(GHOST_IWindow* window);

      /**
       * Returns whether a window is valid.
       * @param   window Pointer to the window to be checked.
       * @return  Indication of validity.
       */
      virtual bool validWindow(GHOST_IWindow* window);

      /**
       * Begins full screen mode.
       * @param setting The new setting of the display.
       * @param window  Window displayed in full screen.
       * @param stereoVisual  Stereo visual for quad buffered stereo.
       * This window is invalid after full screen has been ended.
       * @return  Indication of success.
       */
      virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow** window,
            const bool stereoVisual);

      /**
       * Ends full screen mode.
       * @return  Indication of success.
       */
      virtual GHOST_TSuccess endFullScreen(void);

      /**
       * Returns current full screen mode status.
       * @return The current status.
       */
      virtual bool getFullScreen(void);


      /***************************************************************************************
       ** Event management functionality
       ***************************************************************************************/

      /**
       * Inherited from GHOST_ISystem but left pure virtual
       *
       *    virtual bool processEvents(bool waitForEvent) = 0;
       */



      /**
       * Dispatches all the events on the stack.
       * The event stack will be empty afterwards.
       * @return Indication as to whether any of the consumers handled the events.
       */
      virtual bool dispatchEvents();

      /**
       * Adds the given event consumer to our list.
       * @param consumer The event consumer to add.
       * @return Indication of success.
       */
      virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer* consumer);

      /***************************************************************************************
       ** Cursor management functionality
       ***************************************************************************************/

      /** Inherited from GHOST_ISystem but left pure virtual
       *    GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0; 
       *  GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y)
       */

      /***************************************************************************************
       ** Access to mouse button and keyboard states.
       ***************************************************************************************/

      /**
       * Returns the state of a modifier key (ouside the message queue).
       * @param mask          The modifier key state to retrieve.
       * @param isDown  The state of a modifier key (true == pressed).
       * @return              Indication of success.
       */
      virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const;

      /**
       * Returns the state of a mouse button (ouside the message queue).
       * @param mask          The button state to retrieve.
       * @param isDown  Button state.
       * @return              Indication of success.
       */
      virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const;

      /***************************************************************************************
       ** Other (internal) functionality.
       ***************************************************************************************/

      /**
       * Pushes an event on the stack.
       * To dispatch it, call dispatchEvent() or dispatchEvents().
       * Do not delete the event!
       * @param event   The event to push on the stack.
       */
      virtual GHOST_TSuccess pushEvent(GHOST_IEvent* event);

      /**
       * Returns the timer manager.
       * @return The timer manager.
       */
      inline virtual GHOST_TimerManager* getTimerManager() const;

      /**
       * Returns a pointer to our event manager.
       * @return A pointer to our event manager.
       */
      virtual inline GHOST_EventManager* getEventManager() const;

      /**
       * Returns a pointer to our window manager.
       * @return A pointer to our window manager.
       */
      virtual inline GHOST_WindowManager* getWindowManager() const;

      /**
       * Returns the state of all modifier keys.
       * @param keys    The state of all modifier keys (true == pressed).
       * @return        Indication of success.
       */
      virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const = 0;

      /**
       * Returns the state of the mouse buttons (ouside the message queue).
       * @param buttons The state of the buttons.
       * @return              Indication of success.
       */
      virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const = 0;

protected:
      /**
       * Initialize the system.
       * @return Indication of success.
       */
      virtual GHOST_TSuccess init();

      /**
       * Shut the system down.
       * @return Indication of success.
       */
      virtual GHOST_TSuccess exit();

      /**
       * Creates a fullscreen window.
       * @param window The window created.
       * @return Indication of success.
       */
      virtual GHOST_TSuccess createFullScreenWindow(GHOST_Window** window,
            const bool stereoVisual);

      /** The display manager (platform dependant). */
00282       GHOST_DisplayManager* m_displayManager;

      /** The timer manager. */
00285       GHOST_TimerManager* m_timerManager;

      /** The window manager. */
00288       GHOST_WindowManager* m_windowManager;

      /** The event manager. */
00291       GHOST_EventManager* m_eventManager;

      /** Prints all the events. */
#ifdef GHOST_DEBUG
      GHOST_EventPrinter m_eventPrinter;
#endif // GHOST_DEBUG

      /** Settings of the display before the display went fullscreen. */
00299       GHOST_DisplaySetting m_preFullScreenSetting;
};

00302 inline GHOST_TimerManager* GHOST_System::getTimerManager() const
{
      return m_timerManager;
}

00307 inline GHOST_EventManager* GHOST_System::getEventManager() const
{
      return m_eventManager;
}

00312 inline GHOST_WindowManager* GHOST_System::getWindowManager() const
{
      return m_windowManager;
}

#endif // _GHOST_SYSTEM_H_


Generated by  Doxygen 1.6.0   Back to index