Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

common/vtkCommand.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkCommand.h,v $
00005   Language:  C++
00006 
00007 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00008 All rights reserved.
00009 
00010 Redistribution and use in source and binary forms, with or without
00011 modification, are permitted provided that the following conditions are met:
00012 
00013  * Redistributions of source code must retain the above copyright notice,
00014    this list of conditions and the following disclaimer.
00015 
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019 
00020  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00021    of any contributors may be used to endorse or promote products derived
00022    from this software without specific prior written permission.
00023 
00024  * Modified source versions must be plainly marked as such, and must not be
00025    misrepresented as being the original software.
00026 
00027 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00028 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00029 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00030 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00031 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00032 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00033 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00034 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00035 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 
00038 =========================================================================*/
00051 #ifndef __vtkCommand_h
00052 #define __vtkCommand_h
00053 
00054 #include "vtkWin32Header.h"
00055 
00056 class vtkObject;
00057 
00058 // The superclass that all commands should be subclasses of
00059 class VTK_EXPORT vtkCommand
00060 {
00061 public:
00062   vtkCommand() {};
00063   virtual ~vtkCommand() {};
00064   static vtkCommand *New();
00065   void Delete() {delete this;};
00066 
00067   virtual void Execute(vtkObject *caller, unsigned long, void *callData) = 0;
00068   static const char *GetStringFromEventId(unsigned long event);
00069   static unsigned long GetEventIdFromString(const char *event);
00070 
00071 //BTX
00072   // all the currently defined events
00073   // developers can use -- vtkCommand::UserEvent + int to
00074   // specify their own events. 
00075   // if this list is adjusted, be sure to adjust vtkCommandEventStrings
00076   // in vtkCommand.cxx to match.
00077   enum EventIds {
00078     NoEvent = 0,
00079     AnyEvent,
00080     DeleteEvent,
00081     StartEvent,
00082     EndEvent,
00083     ProgressEvent,
00084     PickEvent,
00085     StartPickEvent,
00086     EndPickEvent,
00087     AbortCheckEvent,
00088     ExitEvent,
00089     LeftButtonPressEvent,
00090     LeftButtonReleaseEvent,
00091     MiddleButtonPressEvent,
00092     MiddleButtonReleaseEvent,
00093     RightButtonPressEvent,
00094     RightButtonReleaseEvent,
00095     EnterEvent,
00096     LeaveEvent,
00097     KeyPressEvent,
00098     KeyReleaseEvent,
00099     CharEvent,
00100     ConfigureEvent,
00101     TimerEvent,
00102     MouseMoveEvent,
00103     ResetCameraEvent,
00104     ResetCameraClippingRangeEvent,
00105     UserEvent = 1000
00106   };
00107 //ETX
00108 };
00109 
00110 //BTX - begin tcl exclude
00111 
00112 // a good command to use for generic function callbacks
00113 // the function should have the format 
00114 // void func(vtkObject *,void *clientdata, void *calldata)
00115 class VTK_EXPORT vtkCallbackCommand : public vtkCommand
00116 {
00117 public:
00118   vtkCallbackCommand();
00119   ~vtkCallbackCommand();
00120   static vtkCallbackCommand *New() 
00121     {return new vtkCallbackCommand;};
00122 
00123   void SetClientData(void *cd) 
00124     {this->ClientData = cd;};
00125   void SetCallback(void (*f)(vtkObject *, unsigned long, void *, void *)) 
00126     {this->Callback = f;};
00127   void SetClientDataDeleteCallback(void (*f)(void *))
00128     {this->ClientDataDeleteCallback = f;};
00129   
00130   void Execute(vtkObject *caller, unsigned long event, void *callData);
00131 
00132   void *ClientData;
00133   void (*Callback)(vtkObject *, unsigned long, void *, void *);
00134   void (*ClientDataDeleteCallback)(void *);
00135 };
00136 
00137 
00138 // the old style void fund(void *) callbacks
00139 class VTK_EXPORT vtkOldStyleCallbackCommand : public vtkCommand
00140 {
00141 public:
00142   vtkOldStyleCallbackCommand();
00143   ~vtkOldStyleCallbackCommand();
00144   static vtkOldStyleCallbackCommand *New() 
00145     {return new vtkOldStyleCallbackCommand;};
00146 
00147   void SetClientData(void *cd) 
00148     {this->ClientData = cd;};
00149   void SetCallback(void (*f)(void *)) 
00150     {this->Callback = f;};
00151   void SetClientDataDeleteCallback(void (*f)(void *))
00152     {this->ClientDataDeleteCallback = f;};
00153   
00154   void Execute(vtkObject *,unsigned long, void *);
00155 
00156   void *ClientData;
00157   void (*Callback)(void *);
00158   void (*ClientDataDeleteCallback)(void *);
00159 };
00160 
00161 
00162 //ETX end tcl exclude
00163 
00164 #endif /* __vtkCommand_h */
00165  

Generated on Wed Nov 21 12:26:51 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001