blender/intern/ghost/GHOST_IEvent.h
Joseph Eagar 53920b1b83 =BMesh: (personal) Testing Framework=
I've got my testing framework done now.  It's based on 
recording events at the GHOST level.  This has issues;
a test created on one computer might not pass on
another, due to floating point inaccuracies (though
I tried to blunt this a bit).

This isn't appropriate for general use.  I
wrote it for personal use, and other devs might 
find it useful for their personal use as well.
However, it lacks the reliability you'd need for
a real unit testing framework.

This isn't meant to replace lief's work, by any means, which
is a real unit testing framework.
2010-11-11 23:36:56 +00:00

108 lines
2.9 KiB
C++

/**
* $Id$
* ***** BEGIN GPL 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.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 LICENSE BLOCK *****
*/
/**
* @file GHOST_IEvent.h
* Declaration of GHOST_IEvent interface class.
*/
#ifndef _GHOST_IEVENT_H_
#define _GHOST_IEVENT_H_
#include "GHOST_Types.h"
#include "GHOST_IWindow.h"
#include "intern/GHOST_ModifierKeys.h"
/**
* Interface class for events received from GHOST.
* You should not need to inherit this class. The system will pass these events
* to the GHOST_IEventConsumer::processEvent() method of event consumers.<br>
* Use the getType() method to retrieve the type of event and the getData()
* method to get the event data out. Using the event type you can cast the
* event data to the correct event dat structure.
* @see GHOST_IEventConsumer#processEvent
* @see GHOST_TEventType
* @author Maarten Gribnau
* @date May 31, 2001
*/
class GHOST_IEvent
{
public:
/**
* Destructor.
*/
virtual ~GHOST_IEvent()
{
}
/**
* Returns the event type.
* @return The event type.
*/
virtual GHOST_TEventType getType() = 0;
/**
* Returns the time this event was generated.
* @return The event generation time.
*/
virtual GHOST_TUns64 getTime() = 0;
virtual void setTime(GHOST_TUns64 t) = 0;
virtual void setPlaybackModifierKeys(GHOST_ModifierKeys keys) = 0;
virtual void getPlaybackModifierKeys(GHOST_ModifierKeys &keys) = 0;
virtual void setPlaybackCursor(GHOST_TInt32 x, GHOST_TInt32 y) = 0;
virtual void getPlaybackCursor(GHOST_TInt32 &x, GHOST_TInt32 &y) = 0;
/**
* Returns the window this event was generated on,
* or NULL if it is a 'system' event.
* @return The generating window.
*/
virtual GHOST_IWindow* getWindow() = 0;
/**
* Returns the event data.
* @return The event data.
*/
virtual GHOST_TEventDataPtr getData() = 0;
virtual int serialize(char buf[256])
{
return 0;
}
int writeheader(char buf[256])
{
sprintf(buf, "%lf %d %d", ((double)this->getTime())*0.001, this->getType(), this->getWindow()->getID());
return 0;
}
};
#endif // _GHOST_IEVENT_H_