Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkInteractorStyleDrawPolygon Class Reference

draw polygon during mouse move More...

#include <vtkInteractorStyleDrawPolygon.h>

Inheritance diagram for vtkInteractorStyleDrawPolygon:
Collaboration diagram for vtkInteractorStyleDrawPolygon:

Public Types

typedef vtkInteractorStyle Superclass
- Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver Superclass
- Public Types inherited from vtkInteractorObserver
typedef vtkObject Superclass

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkInteractorStyleDrawPolygonNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
void OnMouseMove () override
 Event bindings. More...
void OnLeftButtonDown () override
void OnLeftButtonUp () override
virtual void SetDrawPolygonPixels (bool)
 Whether to draw polygon in screen pixels. More...
virtual bool GetDrawPolygonPixels ()
virtual void DrawPolygonPixelsOn ()
virtual void DrawPolygonPixelsOff ()
std::vector< vtkVector2iGetPolygonPoints ()
 Get the current polygon points in display units. More...
- Public Member Functions inherited from vtkInteractorStyle
vtkInteractorStyleNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
void SetInteractor (vtkRenderWindowInteractor *interactor) override
 Set/Get the Interactor wrapper being controlled by this object. More...
void SetEnabled (int) override
 Turn on/off this interactor. More...
virtual void SetAutoAdjustCameraClippingRange (vtkTypeBool)
 If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene. More...
virtual vtkTypeBool GetAutoAdjustCameraClippingRange ()
virtual void AutoAdjustCameraClippingRangeOn ()
virtual void AutoAdjustCameraClippingRangeOff ()
void FindPokedRenderer (int, int)
 When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers. More...
virtual int GetState ()
 Some useful information for interaction. More...
virtual vtkTypeBool GetUseTimers ()
 Set/Get timer hint. More...
virtual void SetUseTimers (vtkTypeBool)
virtual void UseTimersOn ()
virtual void UseTimersOff ()
virtual void SetTimerDuration (unsigned long)
 If using timers, specify the default timer interval (in milliseconds). More...
virtual unsigned long GetTimerDuration ()
virtual void SetHandleObservers (vtkTypeBool)
 Does ProcessEvents handle observers on this class or not. More...
virtual vtkTypeBool GetHandleObservers ()
virtual void HandleObserversOn ()
virtual void HandleObserversOff ()
virtual void OnMiddleButtonDown ()
virtual void OnMiddleButtonUp ()
virtual void OnRightButtonDown ()
virtual void OnRightButtonUp ()
virtual void OnMouseWheelForward ()
virtual void OnMouseWheelBackward ()
virtual void OnFourthButtonDown ()
virtual void OnFourthButtonUp ()
virtual void OnFifthButtonDown ()
virtual void OnFifthButtonUp ()
virtual void OnMove3D (vtkEventData *)
 Generic 3D event bindings can be overridden in subclasses. More...
virtual void OnButton3D (vtkEventData *)
void OnChar () override
 OnChar is triggered when an ASCII key is pressed. More...
virtual void OnKeyDown ()
virtual void OnKeyUp ()
virtual void OnKeyPress ()
virtual void OnKeyRelease ()
virtual void OnExpose ()
 These are more esoteric events, but are useful in some cases. More...
virtual void OnConfigure ()
virtual void OnEnter ()
virtual void OnLeave ()
virtual void OnTimer ()
 OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses. More...
virtual void Rotate ()
 These methods for the different interactions in different modes are overridden in subclasses to perform the correct motion. More...
virtual void Spin ()
virtual void Pan ()
virtual void Dolly ()
virtual void Zoom ()
virtual void UniformScale ()
virtual void OnStartSwipe ()
 gesture based events More...
virtual void OnSwipe ()
virtual void OnEndSwipe ()
virtual void OnStartPinch ()
virtual void OnPinch ()
virtual void OnEndPinch ()
virtual void OnStartRotate ()
virtual void OnRotate ()
virtual void OnEndRotate ()
virtual void OnStartPan ()
virtual void OnPan ()
virtual void OnEndPan ()
virtual void OnTap ()
virtual void OnLongTap ()
virtual void StartState (int newstate)
 utility routines used by state changes More...
virtual void StopState ()
virtual void StartAnimate ()
 Interaction mode entry points used internally. More...
virtual void StopAnimate ()
virtual void StartRotate ()
virtual void EndRotate ()
virtual void StartZoom ()
virtual void EndZoom ()
virtual void StartPan ()
virtual void EndPan ()
virtual void StartSpin ()
virtual void EndSpin ()
virtual void StartDolly ()
virtual void EndDolly ()
virtual void StartUniformScale ()
virtual void EndUniformScale ()
virtual void StartTimer ()
virtual void EndTimer ()
virtual void StartTwoPointer ()
virtual void EndTwoPointer ()
virtual void StartGesture ()
virtual void EndGesture ()
virtual void HighlightProp (vtkProp *prop)
 When picking successfully selects an actor, this method highlights the picked prop appropriately. More...
virtual void HighlightActor2D (vtkActor2D *actor2D)
virtual void HighlightProp3D (vtkProp3D *prop3D)
virtual void SetPickColor (double, double, double)
 Set/Get the pick color (used by default to color vtkActor2D's). More...
virtual void SetPickColor (double[3])
virtual doubleGetPickColor ()
virtual void GetPickColor (double data[3])
virtual void SetMouseWheelMotionFactor (double)
 Set/Get the mouse wheel motion factor. More...
virtual double GetMouseWheelMotionFactor ()
virtual vtkTDxInteractorStyleGetTDxStyle ()
 3Dconnexion device interactor style. More...
virtual void SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
void DelegateTDxEvent (unsigned long event, void *calldata)
 Called by the callback to process 3DConnexion device events. More...
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
int GetEnabled ()
void EnabledOn ()
void EnabledOff ()
void On ()
void Off ()
virtual vtkRenderWindowInteractorGetInteractor ()
virtual void SetPriority (float)
 Set/Get the priority at which events are processed. More...
virtual float GetPriority ()
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
virtual void PickingManagedOff ()
virtual void SetPickingManaged (bool managed)
virtual bool GetPickingManaged ()
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
virtual vtkTypeBool GetKeyPressActivation ()
virtual void KeyPressActivationOn ()
virtual void KeyPressActivationOff ()
virtual void SetKeyPressActivationValue (char)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
virtual char GetKeyPressActivationValue ()
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
virtual void SetDefaultRenderer (vtkRenderer *)
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
virtual void SetCurrentRenderer (vtkRenderer *)
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
void ReleaseFocus ()
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void DebugOn ()
 Turn debugging output on. More...
virtual void DebugOff ()
 Turn debugging output off. More...
bool GetDebug ()
 Get the value of the debug flag. More...
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
virtual void Modified ()
 Update the modification time for this object. More...
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
vtkTypeBool HasObserver (const char *event, vtkCommand *)
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)
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. More...
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
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. More...
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
virtual void Delete ()
 Delete a VTK object. More...
virtual void FastDelete ()
 Delete a reference to this object. More...
void InitializeObjectBase ()
void Print (ostream &os)
 Print an object to an ostream. More...
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
int GetReferenceCount ()
 Return the current reference count of this object. More...
void SetReferenceCount (int)
 Sets the reference count. More...
void PrintRevisions (ostream &)
 Legacy. More...

Static Public Member Functions

static vtkInteractorStyleDrawPolygonNew ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkInteractorStyleDrawPolygonSafeDownCast (vtkObjectBase *o)
- Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyleNew ()
 This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. More...
static vtkTypeBool IsTypeOf (const char *type)
static vtkInteractorStyleSafeDownCast (vtkObjectBase *o)
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool IsTypeOf (const char *type)
static vtkInteractorObserverSafeDownCast (vtkObjectBase *o)
static void ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
 Convenience methods for outside classes. More...
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()
- 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. More...
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkInteractorStyleDrawPolygon ()
 ~vtkInteractorStyleDrawPolygon () override
virtual void DrawPolygon ()
- Protected Member Functions inherited from vtkInteractorStyle
 vtkInteractorStyle ()
 ~vtkInteractorStyle () override
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 ~vtkInteractorObserver () override
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
virtual void EndInteraction ()
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses. More...
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
int RequestCursorShape (int requestedShape)
- 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. More...
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int StartPosition [2]
int EndPosition [2]
int Moving
bool DrawPolygonPixels
- Protected Attributes inherited from vtkInteractorStyle
int State
int AnimState
vtkTypeBool HandleObservers
vtkTypeBool UseTimers
int TimerId
vtkTypeBool AutoAdjustCameraClippingRange
int PropPicked
double PickColor [3]
double MouseWheelMotionFactor
unsigned long TimerDuration
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
float Priority
bool PickingManaged
vtkTypeBool KeyPressActivation
char KeyPressActivationValue
unsigned long CharObserverTag
unsigned long DeleteObserverTag
- Protected Attributes inherited from vtkObject
bool Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
vtkWeakPointerBase ** WeakPointers

Additional Inherited Members

- Static Protected Member Functions inherited from vtkInteractorStyle
static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 Main process event method. More...
- Static Protected Member Functions inherited from vtkInteractorObserver
static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 Handles the char widget activation event. More...

Detailed Description

draw polygon during mouse move

This interactor style allows the user to draw a polygon in the render window using the left mouse button while mouse is moving. When the mouse button is released, a SelectionChangedEvent will be fired.

vtkInteractorStyleDrawPolygon (Tests)

Definition at line 38 of file vtkInteractorStyleDrawPolygon.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkInteractorStyleDrawPolygon.h.

Constructor & Destructor Documentation

◆ vtkInteractorStyleDrawPolygon()

vtkInteractorStyleDrawPolygon::vtkInteractorStyleDrawPolygon ( )

◆ ~vtkInteractorStyleDrawPolygon()

vtkInteractorStyleDrawPolygon::~vtkInteractorStyleDrawPolygon ( )

Member Function Documentation

◆ New()

static vtkInteractorStyleDrawPolygon* vtkInteractorStyleDrawPolygon::New ( )

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkInteractorStyleDrawPolygon::IsA ( const char *  name)

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorStyle.

◆ SafeDownCast()

static vtkInteractorStyleDrawPolygon* vtkInteractorStyleDrawPolygon::SafeDownCast ( vtkObjectBase o)

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkInteractorStyleDrawPolygon::NewInstanceInternal ( ) const

Reimplemented from vtkInteractorStyle.

◆ NewInstance()

vtkInteractorStyleDrawPolygon* vtkInteractorStyleDrawPolygon::NewInstance ( ) const

◆ PrintSelf()

void vtkInteractorStyleDrawPolygon::PrintSelf ( ostream &  os,
vtkIndent  indent 

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ OnMouseMove()

void vtkInteractorStyleDrawPolygon::OnMouseMove ( )

Event bindings.

Reimplemented from vtkInteractorStyle.

◆ OnLeftButtonDown()

void vtkInteractorStyleDrawPolygon::OnLeftButtonDown ( )

Reimplemented from vtkInteractorStyle.

◆ OnLeftButtonUp()

void vtkInteractorStyleDrawPolygon::OnLeftButtonUp ( )

Reimplemented from vtkInteractorStyle.

◆ SetDrawPolygonPixels()

virtual void vtkInteractorStyleDrawPolygon::SetDrawPolygonPixels ( bool  )

Whether to draw polygon in screen pixels.

Default is ON

◆ GetDrawPolygonPixels()

virtual bool vtkInteractorStyleDrawPolygon::GetDrawPolygonPixels ( )

◆ DrawPolygonPixelsOn()

virtual void vtkInteractorStyleDrawPolygon::DrawPolygonPixelsOn ( )

◆ DrawPolygonPixelsOff()

virtual void vtkInteractorStyleDrawPolygon::DrawPolygonPixelsOff ( )

◆ GetPolygonPoints()

std::vector<vtkVector2i> vtkInteractorStyleDrawPolygon::GetPolygonPoints ( )

Get the current polygon points in display units.

◆ DrawPolygon()

virtual void vtkInteractorStyleDrawPolygon::DrawPolygon ( )

Member Data Documentation

◆ StartPosition

int vtkInteractorStyleDrawPolygon::StartPosition[2]

Definition at line 74 of file vtkInteractorStyleDrawPolygon.h.

◆ EndPosition

int vtkInteractorStyleDrawPolygon::EndPosition[2]

Definition at line 75 of file vtkInteractorStyleDrawPolygon.h.

◆ Moving

int vtkInteractorStyleDrawPolygon::Moving

Definition at line 76 of file vtkInteractorStyleDrawPolygon.h.

◆ DrawPolygonPixels

bool vtkInteractorStyleDrawPolygon::DrawPolygonPixels

Definition at line 78 of file vtkInteractorStyleDrawPolygon.h.

◆ PixelArray

vtkUnsignedCharArray* vtkInteractorStyleDrawPolygon::PixelArray

Definition at line 80 of file vtkInteractorStyleDrawPolygon.h.

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