create a contour with a set of points More...

#include <vtkContourWidget.h>

Inheritance diagram for vtkContourWidget:

Collaboration diagram for vtkContourWidget:

Public Types
enum	{ Start , Define , Manipulate }

Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass
	Standard macros implementing standard VTK methods.

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Member Functions
void	SetEnabled (int) override
	The method for activating and deactivating this widget.

void	SetRepresentation (vtkContourRepresentation *r)
	Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.

vtkContourRepresentation *	GetContourRepresentation ()
	Return the representation as a vtkContourRepresentation.

void	CreateDefaultRepresentation () override
	Create the default widget representation if one is not set.

void	CloseLoop ()
	Convenient method to close the contour loop.

virtual void	Initialize (vtkPolyData poly, int state=1, vtkIdList idList=nullptr)
	Initialize the contour widget from a user supplied set of points.

virtual void	Initialize ()


virtual void	SetWidgetState (int)
	Convenient method to change what state the widget is in.


virtual int	GetWidgetState ()
	Convenient method to determine the state of the method.


void	SetAllowNodePicking (vtkTypeBool)
	Set / Get the AllowNodePicking value.

virtual vtkTypeBool	GetAllowNodePicking ()
	Set / Get the AllowNodePicking value.

virtual void	AllowNodePickingOn ()
	Set / Get the AllowNodePicking value.

virtual void	AllowNodePickingOff ()
	Set / Get the AllowNodePicking value.


virtual void	SetFollowCursor (vtkTypeBool)
	Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

virtual vtkTypeBool	GetFollowCursor ()
	Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

virtual void	FollowCursorOn ()
	Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

virtual void	FollowCursorOff ()
	Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.


virtual void	SetContinuousDraw (vtkTypeBool)
	Define a contour by continuously drawing with the mouse cursor.

virtual vtkTypeBool	GetContinuousDraw ()
	Define a contour by continuously drawing with the mouse cursor.

virtual void	ContinuousDrawOn ()
	Define a contour by continuously drawing with the mouse cursor.

virtual void	ContinuousDrawOff ()
	Define a contour by continuously drawing with the mouse cursor.

Public Member Functions inherited from vtkAbstractWidget
void	SetEnabled (int) override
	Methods for activating this widget.

vtkWidgetEventTranslator *	GetEventTranslator ()
	Get the event translator.

virtual void	CreateDefaultRepresentation ()=0
	Create the default widget representation if one is not set.

void	Render ()
	This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor.

void	SetParent (vtkAbstractWidget *parent)
	Specifying a parent to this widget is used when creating composite widgets.

virtual vtkAbstractWidget *	GetParent ()

void	SetPriority (float) override
	Override the superclass method.

virtual void	SetProcessEvents (vtkTypeBool)
	Methods to change whether the widget responds to interaction.

virtual vtkTypeBool	GetProcessEvents ()
	Methods to change whether the widget responds to interaction.

virtual void	ProcessEventsOn ()
	Methods to change whether the widget responds to interaction.

virtual void	ProcessEventsOff ()
	Methods to change whether the widget responds to interaction.

vtkWidgetRepresentation *	GetRepresentation ()
	Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.

virtual void	SetManagesCursor (vtkTypeBool)
	Turn on or off the management of the cursor.

virtual vtkTypeBool	GetManagesCursor ()
	Turn on or off the management of the cursor.

virtual void	ManagesCursorOn ()
	Turn on or off the management of the cursor.

virtual void	ManagesCursorOff ()
	Turn on or off the management of the cursor.

vtkAbstractWidget *	NewInstance () const
	Standard macros implementing standard VTK methods.

Public Member Functions inherited from vtkInteractorObserver
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetEnabled (int)
	Methods for turning the interactor observer on and off, and determining its state.

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	OnChar ()
	Sets up the keypress-i event.

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
	This method is used to associate the widget with the render window interactor.

virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor.

virtual float	GetPriority ()
	Set/Get the priority at which events are processed.

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual vtkTypeBool	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer.

virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer.

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer.

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer.

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

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 Public Member Functions
static vtkContourWidget *	New ()
	Instantiate this class.

Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool	IsTypeOf (const char *type)
	Standard macros implementing standard VTK methods.

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)
	Standard macros implementing standard VTK methods.

Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes.

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes.

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
	vtkContourWidget ()

	~vtkContourWidget () override

void	SelectNode ()

void	AddNode ()

Protected Member Functions inherited from vtkAbstractWidget
	vtkAbstractWidget ()

	~vtkAbstractWidget () override

void	SetWidgetRepresentation (vtkWidgetRepresentation *r)

virtual void	SetCursor (int vtkNotUsed(state))

Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong.

vtkAssemblyPath *	GetAssemblyPath (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.

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
	Utility routines used to start and end interaction.

virtual void	EndInteraction ()
	Utility routines used to start and end interaction.

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses.

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses.

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 &)

Static Protected Member Functions
static void	SelectAction (vtkAbstractWidget *)

static void	AddFinalPointAction (vtkAbstractWidget *)

static void	MoveAction (vtkAbstractWidget *)

static void	EndSelectAction (vtkAbstractWidget *)

static void	DeleteAction (vtkAbstractWidget *)

static void	TranslateContourAction (vtkAbstractWidget *)

static void	ScaleContourAction (vtkAbstractWidget *)

static void	ResetAction (vtkAbstractWidget *)

Static Protected Member Functions inherited from vtkAbstractWidget
static void	ProcessEventsHandler (vtkObject object, unsigned long event, void clientdata, void *calldata)

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.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
int	WidgetState

int	CurrentHandle

vtkTypeBool	AllowNodePicking

vtkTypeBool	FollowCursor

vtkTypeBool	ContinuousDraw

int	ContinuousActive

Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep

vtkTypeBool	ManagesCursor

vtkWidgetEventTranslator *	EventTranslator

vtkWidgetCallbackMapper *	CallbackMapper

vtkAbstractWidget *	Parent

void *	CallData

vtkTypeBool	ProcessEvents

int	LastDevice

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

vtkTypeBool	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

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

typedef vtkAbstractWidget	Superclass
	Standard methods for a VTK class.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for a VTK class.

static vtkContourWidget *	SafeDownCast (vtkObjectBase *o)
	Standard methods for a VTK class.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for a VTK class.

vtkContourWidget *	NewInstance () const
	Standard methods for a VTK class.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for a VTK class.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for a VTK class.

Detailed Description

create a contour with a set of points

The vtkContourWidget is used to select a set of points, and draw lines between these points. The contour may be opened or closed, depending on how the last point is added. The widget handles all processing of widget events (that are triggered by VTK events). The vtkContourRepresentation is responsible for all placement of the points, calculation of the lines, and contour manipulation. This is done through two main helper classes: vtkPointPlacer and vtkContourLineInterpolator. The representation is also responsible for drawing the points and lines.

Event Bindings:

By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):

  LeftButtonPressEvent - triggers a Select event
  RightButtonPressEvent - triggers a AddFinalPoint event
  MouseMoveEvent - triggers a Move event
  LeftButtonReleaseEvent - triggers an EndSelect event
  Delete key event - triggers a Delete event
  Shift + Delete key event - triggers a Reset event

Event Bindings:

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkContourWidget's widget events:

  vtkWidgetEvent::Select
       widget state is:
           Start or
           Define: If we already have at least 2 nodes, test
                whether the current (X,Y) location is near an existing
                node. If so, close the contour and change to Manipulate
                state. Otherwise, attempt to add a node at this (X,Y)
                location.
           Manipulate: If this (X,Y) location activates a node, then
                set the current operation to Translate. Otherwise, if
                this location is near the contour, attempt to add a
                new node on the contour at this (X,Y) location.

Event Bindings:

  vtkWidgetEvent::AddFinalPoint
       widget state is:
           Start: Do nothing.
           Define: If we already have at least 2 nodes, test
                whether the current (X,Y) location is near an existing
                node. If so, close the contour and change to Manipulate
                state. Otherwise, attempt to add a node at this (X,Y)
                location. If we do, then leave the contour open and
                change to Manipulate state.
           Manipulate: Do nothing.

Event Bindings:

  vtkWidgetEvent::Move
       widget state is:
           Start or
           Define: Do nothing.
           Manipulate: If our operation is Translate, then invoke
                 WidgetInteraction() on the representation. If our
                 operation is Inactive, then just attempt to activate
                 a node at this (X,Y) location.

Event Bindings:

  vtkWidgetEvent::EndSelect
       widget state is:
           Start or
           Define: Do nothing.
           Manipulate: If our operation is not Inactive, set it to
                 Inactive.

Event Bindings:

  vtkWidgetEvent::Delete
       widget state is:
           Start: Do nothing.
           Define: Remove the last point on the contour.
           Manipulate: Attempt to activate a node at (X,Y). If
                  we do activate a node, delete it. If we now
                  have less than 3 nodes, go back to Define state.

Event Bindings:

  vtkWidgetEvent::Reset
       widget state is:
           Start: Do nothing.
           Define: Remove all points and line segments of the contour.
                Essentially calls Initialize(nullptr)
           Manipulate: Do nothing.

Event Bindings:

This widget invokes the following VTK events on itself (which observers can listen for):

  vtkCommand::StartInteractionEvent (beginning to interact)
  vtkCommand::EndInteractionEvent (completing interaction)
  vtkCommand::InteractionEvent (moving after selecting something)
  vtkCommand::PlacePointEvent (after point is positioned;
                               call data includes handle id (0,1))
  vtkCommand::WidgetValueChangedEvent (Invoked when the contour is closed
                                       for the first time. )

See also: vtkHandleWidget

Events:: vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent

Online Examples:

PolygonalSurfaceContourLineInterpolator

PolygonalSurfacePointPlacer

ContourWidget

Tests:: vtkContourWidget (Tests)

Definition at line 168 of file vtkContourWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractWidget vtkContourWidget::Superclass

Standard methods for a VTK class.

Definition at line 180 of file vtkContourWidget.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
Start
Define
Manipulate

Definition at line 285 of file vtkContourWidget.h.

Constructor & Destructor Documentation

◆ vtkContourWidget()

vtkContourWidget::vtkContourWidget ( )

protected

◆ ~vtkContourWidget()

vtkContourWidget::~vtkContourWidget ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkContourWidget * vtkContourWidget::New ( )

static

Instantiate this class.

◆ IsTypeOf()

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

static

Standard methods for a VTK class.

◆ IsA()

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

virtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

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

static

Standard methods for a VTK class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkContourWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkContourWidget * vtkContourWidget::NewInstance ( ) const

Standard methods for a VTK class.

◆ PrintSelf()

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

overridevirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

◆ SetEnabled()

void vtkContourWidget::SetEnabled ( int )

overridevirtual

The method for activating and deactivating this widget.

This method must be overridden because it is a composite widget and does more than its superclasses' vtkAbstractWidget::SetEnabled() method.

Reimplemented from vtkAbstractWidget.

◆ SetRepresentation()

void vtkContourWidget::SetRepresentation ( vtkContourRepresentation * r )

inline

Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.

Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.

Definition at line 196 of file vtkContourWidget.h.

◆ GetContourRepresentation()

vtkContourRepresentation * vtkContourWidget::GetContourRepresentation ( )

inline

Return the representation as a vtkContourRepresentation.

Definition at line 204 of file vtkContourWidget.h.

◆ CreateDefaultRepresentation()

void vtkContourWidget::CreateDefaultRepresentation ( )

overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ CloseLoop()

void vtkContourWidget::CloseLoop ( )

Convenient method to close the contour loop.

◆ SetWidgetState()

virtual void vtkContourWidget::SetWidgetState ( int )

virtual

Convenient method to change what state the widget is in.

◆ GetWidgetState()

virtual int vtkContourWidget::GetWidgetState ( )

virtual

Convenient method to determine the state of the method.

◆ SetAllowNodePicking()

void vtkContourWidget::SetAllowNodePicking ( vtkTypeBool )

Set / Get the AllowNodePicking value.

This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

◆ GetAllowNodePicking()

virtual vtkTypeBool vtkContourWidget::GetAllowNodePicking ( )

virtual

Set / Get the AllowNodePicking value.

This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

◆ AllowNodePickingOn()

virtual void vtkContourWidget::AllowNodePickingOn ( )

virtual

Set / Get the AllowNodePicking value.

This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

◆ AllowNodePickingOff()

virtual void vtkContourWidget::AllowNodePickingOff ( )

virtual

Set / Get the AllowNodePicking value.

This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

◆ SetFollowCursor()

virtual void vtkContourWidget::SetFollowCursor ( vtkTypeBool )

virtual

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

◆ GetFollowCursor()

virtual vtkTypeBool vtkContourWidget::GetFollowCursor ( )

virtual

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

◆ FollowCursorOn()

virtual void vtkContourWidget::FollowCursorOn ( )

virtual

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

◆ FollowCursorOff()

virtual void vtkContourWidget::FollowCursorOff ( )

virtual

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

◆ SetContinuousDraw()

virtual void vtkContourWidget::SetContinuousDraw ( vtkTypeBool )

virtual

Define a contour by continuously drawing with the mouse cursor.

Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

◆ GetContinuousDraw()

virtual vtkTypeBool vtkContourWidget::GetContinuousDraw ( )

virtual

Define a contour by continuously drawing with the mouse cursor.

Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

◆ ContinuousDrawOn()

virtual void vtkContourWidget::ContinuousDrawOn ( )

virtual

Define a contour by continuously drawing with the mouse cursor.

Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

◆ ContinuousDrawOff()

virtual void vtkContourWidget::ContinuousDrawOff ( )

virtual

Define a contour by continuously drawing with the mouse cursor.

Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

◆ Initialize() [1/2]

virtual void vtkContourWidget::Initialize	(	vtkPolyData *	poly,
		int	state = `1`,
		vtkIdList *	idList = `nullptr`
	)

virtual

Initialize the contour widget from a user supplied set of points.

The state of the widget decides if you are still defining the widget, or if you've finished defining (added the last point) are manipulating it. Note that if the polydata supplied is closed, the state will be set to manipulate. State: Define = 0, Manipulate = 1.

◆ Initialize() [2/2]

virtual void vtkContourWidget::Initialize ( )

inlinevirtual

Definition at line 281 of file vtkContourWidget.h.

◆ SelectAction()

static void vtkContourWidget::SelectAction ( vtkAbstractWidget * )

staticprotected

◆ AddFinalPointAction()

static void vtkContourWidget::AddFinalPointAction ( vtkAbstractWidget * )

staticprotected

◆ MoveAction()

static void vtkContourWidget::MoveAction ( vtkAbstractWidget * )

staticprotected

◆ EndSelectAction()

static void vtkContourWidget::EndSelectAction ( vtkAbstractWidget * )

staticprotected

◆ DeleteAction()

static void vtkContourWidget::DeleteAction ( vtkAbstractWidget * )

staticprotected

◆ TranslateContourAction()

static void vtkContourWidget::TranslateContourAction ( vtkAbstractWidget * )

staticprotected

◆ ScaleContourAction()

static void vtkContourWidget::ScaleContourAction ( vtkAbstractWidget * )

staticprotected

◆ ResetAction()

static void vtkContourWidget::ResetAction ( vtkAbstractWidget * )

staticprotected

◆ SelectNode()

void vtkContourWidget::SelectNode ( )

protected

◆ AddNode()

void vtkContourWidget::AddNode ( )

protected

Member Data Documentation

◆ WidgetState

int vtkContourWidget::WidgetState

protected

Definition at line 296 of file vtkContourWidget.h.

◆ CurrentHandle

int vtkContourWidget::CurrentHandle

protected

Definition at line 297 of file vtkContourWidget.h.

◆ AllowNodePicking

vtkTypeBool vtkContourWidget::AllowNodePicking

protected

Definition at line 298 of file vtkContourWidget.h.

◆ FollowCursor

vtkTypeBool vtkContourWidget::FollowCursor

protected

Definition at line 299 of file vtkContourWidget.h.

◆ ContinuousDraw

vtkTypeBool vtkContourWidget::ContinuousDraw

protected

Definition at line 300 of file vtkContourWidget.h.

◆ ContinuousActive

int vtkContourWidget::ContinuousActive

protected

Definition at line 301 of file vtkContourWidget.h.

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

Interaction/Widgets/vtkContourWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkContourWidget()

◆ ~vtkContourWidget()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetEnabled()

◆ SetRepresentation()

◆ GetContourRepresentation()

◆ CreateDefaultRepresentation()

◆ CloseLoop()

◆ SetWidgetState()

◆ GetWidgetState()

◆ SetAllowNodePicking()

◆ GetAllowNodePicking()

◆ AllowNodePickingOn()

◆ AllowNodePickingOff()

◆ SetFollowCursor()

◆ GetFollowCursor()

◆ FollowCursorOn()

◆ FollowCursorOff()

◆ SetContinuousDraw()

◆ GetContinuousDraw()

◆ ContinuousDrawOn()

◆ ContinuousDrawOff()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ SelectAction()

◆ AddFinalPointAction()

◆ MoveAction()

◆ EndSelectAction()

◆ DeleteAction()

◆ TranslateContourAction()

◆ ScaleContourAction()

◆ ResetAction()

◆ SelectNode()

◆ AddNode()

Member Data Documentation

◆ WidgetState

◆ CurrentHandle

◆ AllowNodePicking

◆ FollowCursor

◆ ContinuousDraw

◆ ContinuousActive