Return to ButtonBoxEvent.c++ CVS log

Up to [Development] / inventor / apps / examples / Toolmaker / 11.Events

Initial check-in based on 2.1.5 (SGI IRIX) source tree.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */

/*-------------------------------------------------------------
 *  This is an example from The Inventor Toolmaker,
 *  chapter 11.
 *
 *  This is the header file for the "ButtonBox" event.
 *------------------------------------------------------------*/

#include "ButtonBoxEvent.h"


SO_EVENT_SOURCE(ButtonBoxEvent);


////////////////////////////////////////////////////////////////////////
//
// Class initialization
//
// SoINTERNAL public
//
void
ButtonBoxEvent::initClass()
//
////////////////////////////////////////////////////////////////////////
{
   SO_EVENT_INIT_CLASS(ButtonBoxEvent, SoButtonEvent);
}

////////////////////////////////////////////////////////////////////////
//
// Constructor
//
ButtonBoxEvent::ButtonBoxEvent()
//
////////////////////////////////////////////////////////////////////////
{
   button = 0;
}

////////////////////////////////////////////////////////////////////////
//
// Convenience routine - this returns TRUE if the event is a button box
// press event matching the passed button.
//
// static public
//
SbBool
ButtonBoxEvent::isButtonPressEvent(const SoEvent *e, int whichButton)
//
////////////////////////////////////////////////////////////////////////
{
   SbBool isMatch = FALSE;
   
   // is it a button box event?
   if (e->isOfType(ButtonBoxEvent::getClassTypeId())) {
      const ButtonBoxEvent *be = (const ButtonBoxEvent *) e;
   
      // is it a press event?
      if (be->getState() == SoButtonEvent::DOWN) {
   
         // did the caller want any button press? or do they match?
         if ((whichButton == -1) ||
             (be->getButton() == whichButton))
            isMatch = TRUE;
      }
   }
   
   return isMatch;
}

////////////////////////////////////////////////////////////////////////
//
// Convenience routine - this returns TRUE if the event is a button box
// release event matching the passed button.
//
// static public
//
SbBool
ButtonBoxEvent::isButtonReleaseEvent(const SoEvent *e, int whichButton)
//
////////////////////////////////////////////////////////////////////////
{
   SbBool isMatch = FALSE;
   
   // is it a button box event?
   if (e->isOfType(ButtonBoxEvent::getClassTypeId())) {
      const ButtonBoxEvent *be = (const ButtonBoxEvent *) e;
   
      // is it a release event?
      if (be->getState() == SoButtonEvent::UP) {
      
         // did the caller want any button release? or do they match?
         if ((whichButton == -1) ||
             (be->getButton() == whichButton))
            isMatch = TRUE;
      }
   }
   
   return isMatch;
}