SoEventCallback.h
#ifndef COIN_SOEVENTCALLBACK_H
#define COIN_SOEVENTCALLBACK_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/lists/SbList.h>
#ifndef COIN_INTERNAL
// Added for Inventor compliance
#include <Inventor/actions/SoHandleEventAction.h>
#endif // !COIN_INTERNAL
class SoEventCallback;
class SoPath;
class SoEvent;
class SoPickedPoint;
class SoHandleEventAction;
typedef void SoEventCallbackCB(void * userdata, SoEventCallback * node);
class COIN_DLL_API SoEventCallback : public SoNode {
typedef SoNode inherited;
SO_NODE_HEADER(SoEventCallback);
public:
static void initClass(void);
SoEventCallback(void);
void setPath(SoPath * path);
const SoPath * getPath(void);
void addEventCallback(SoType eventtype, SoEventCallbackCB * f,
void * userdata = NULL);
void removeEventCallback(SoType eventtype, SoEventCallbackCB * f,
void * userdata = NULL);
SoHandleEventAction * getAction(void) const;
const SoEvent * getEvent(void) const;
const SoPickedPoint * getPickedPoint(void) const;
void setHandled(void);
SbBool isHandled(void) const;
void grabEvents(void);
void releaseEvents(void);
protected:
virtual ~SoEventCallback();
virtual void handleEvent(SoHandleEventAction * action);
private:
struct CallbackInfo {
SoEventCallbackCB * func;
SoType eventtype;
void * userdata;
// AIX native compiler xlC needs equality and inequality operators
// to compile templates where these operators are referenced (even
// if they are actually never used).
SbBool operator==(const CallbackInfo & cbi) {
return this->func == cbi.func && this->eventtype == cbi.eventtype && this->userdata == cbi.userdata;
}
SbBool operator!=(const CallbackInfo & cbi) {
return !(*this == cbi);
}
};
SbList<CallbackInfo> callbacks;
SoHandleEventAction * heaction;
SoPath * path;
};
#endif // !COIN_SOEVENTCALLBACK_H
SbList
The SbList class is a template container class for lists.
Definition SbList.h:70
SoEventCallback
The SoEventCallback class provides functionality for catching events.
Definition SoEventCallback.h:52
SoEventCallback::removeEventCallback
void removeEventCallback(SoType eventtype, SoEventCallbackCB *f, void *userdata=NULL)
Definition SoEventCallback.cpp:192
SoEventCallback::getPath
const SoPath * getPath(void)
Definition SoEventCallback.cpp:165
SoEventCallback::getEvent
const SoEvent * getEvent(void) const
Definition SoEventCallback.cpp:230
SoEventCallback::isHandled
SbBool isHandled(void) const
Definition SoEventCallback.cpp:282
SoEventCallback::setHandled
void setHandled(void)
Definition SoEventCallback.cpp:264
SoEventCallback::addEventCallback
void addEventCallback(SoType eventtype, SoEventCallbackCB *f, void *userdata=NULL)
Definition SoEventCallback.cpp:177
SoEventCallback::releaseEvents
void releaseEvents(void)
Definition SoEventCallback.cpp:320
SoEventCallback::getPickedPoint
const SoPickedPoint * getPickedPoint(void) const
Definition SoEventCallback.cpp:242
SoEventCallback::grabEvents
void grabEvents(void)
Definition SoEventCallback.cpp:301
SoEventCallback::getAction
SoHandleEventAction * getAction(void) const
Definition SoEventCallback.cpp:216
SoEventCallback::SoEventCallback
SoEventCallback(void)
Definition SoEventCallback.cpp:106
SoEventCallback::setPath
void setPath(SoPath *path)
Definition SoEventCallback.cpp:141
SoEvent
The SoEvent class is the base class for all Coin events.
Definition SoEvent.h:45
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:46
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoNode.cpp:1132
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoPickedPoint
The SoPickedPoint class is used for specifying picked points.
Definition SoPickedPoint.h:48
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
Definition Coin_macros.dox:50