vtkWidgetEvent Class Reference

define widget events More...

#include <vtkWidgetEvent.h>

Inheritance diagram for vtkWidgetEvent:

Collaboration diagram for vtkWidgetEvent:

Public Types
enum	WidgetEventIds {   NoEvent = 0 , Select , EndSelect , Delete ,   Translate , EndTranslate , Scale , EndScale ,   Resize , EndResize , Rotate , EndRotate ,   Move , SizeHandles , AddPoint , AddFinalPoint ,   Completed , PickPoint , PickNormal , PickDirectionPoint ,   TimedOut , ModifyEvent , Reset , Up ,   Down , Left , Right , Select3D ,   EndSelect3D , Move3D , AddPoint3D , AddFinalPoint3D ,   HoverLeave }
	All the widget events are defined here. More...

Static Public Member Functions
static vtkWidgetEvent *	New ()
	The object factory constructor.
static const char *	GetStringFromEventId (unsigned long event)
	Convenience methods for translating between event names and event ids.
static unsigned long	GetEventIdFromString (const char *event)
	Convenience methods for translating between event names and event ids.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkWidgetEvent ()=default
	~vtkWidgetEvent () override=default
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
typedef vtkObject	Superclass
	Standard macros.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard macros.
static vtkWidgetEvent *	SafeDownCast (vtkObjectBase *o)
	Standard macros.
virtual vtkTypeBool	IsA (const char *type)
	Standard macros.
vtkWidgetEvent *	NewInstance () const
	Standard macros.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard macros.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard macros.

Additional Inherited Members
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

define widget events

vtkWidgetEvent defines widget events. These events are processed by subclasses of vtkInteractorObserver.

Online Examples:

BorderWidgetQt

BorderWidget

Tests:

vtkWidgetEvent (Tests)

Definition at line 50 of file vtkWidgetEvent.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkWidgetEvent::Superclass

Standard macros.

Definition at line 62 of file vtkWidgetEvent.h.

Member Enumeration Documentation

WidgetEventIds

enum vtkWidgetEvent::WidgetEventIds

All the widget events are defined here.

Enumerator
NoEvent
Select
EndSelect
Delete
Translate
EndTranslate
Scale
EndScale
Resize
EndResize
Rotate
EndRotate
Move
SizeHandles
AddPoint
AddFinalPoint
Completed
PickPoint
PickNormal
PickDirectionPoint
TimedOut
ModifyEvent
Reset
Up
Down
Left
Right
Select3D
EndSelect3D
Move3D
AddPoint3D
AddFinalPoint3D
HoverLeave

Definition at line 69 of file vtkWidgetEvent.h.

Constructor & Destructor Documentation

vtkWidgetEvent()

vtkWidgetEvent::vtkWidgetEvent ( )

protecteddefault

~vtkWidgetEvent()

vtkWidgetEvent::~vtkWidgetEvent ( )

overrideprotecteddefault

Member Function Documentation

New()

static vtkWidgetEvent * vtkWidgetEvent::New ( )

static

The object factory constructor.

IsTypeOf()

static vtkTypeBool vtkWidgetEvent::IsTypeOf ( const char *  type )

static

Standard macros.

IsA()

virtual vtkTypeBool vtkWidgetEvent::IsA ( const char *  type )

virtual

Standard macros.

Reimplemented from vtkObjectBase.

SafeDownCast()

static vtkWidgetEvent * vtkWidgetEvent::SafeDownCast ( vtkObjectBase *  o )

static

Standard macros.

NewInstanceInternal()

virtual vtkObjectBase * vtkWidgetEvent::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

NewInstance()

vtkWidgetEvent * vtkWidgetEvent::NewInstance

(

)

const

Standard macros.

PrintSelf()

void vtkWidgetEvent::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Standard macros.

Reimplemented from vtkObject.

GetStringFromEventId()

static const char * vtkWidgetEvent::GetStringFromEventId ( unsigned long  event )

static

Convenience methods for translating between event names and event ids.

GetEventIdFromString()

static unsigned long vtkWidgetEvent::GetEventIdFromString ( const char *  event )

static

Convenience methods for translating between event names and event ids.

---

The documentation for this class was generated from the following file:

• Interaction/Widgets/vtkWidgetEvent.h