vtkPointWidget Class Reference

position a point in 3D space More...

#include <vtkPointWidget.h>

Inheritance diagram for vtkPointWidget:

Collaboration diagram for vtkPointWidget:

Public Types
typedef vtk3DWidget	Superclass
Public Types inherited from vtk3DWidget
typedef vtkInteractorObserver	Superclass
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	GetPolyData (vtkPolyData *pd)
virtual void	SetEnabled (int)
virtual void	PlaceWidget (double bounds[6])
void	PlaceWidget ()
void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
void	SetPosition (double x, double y, double z)
void	SetPosition (double x[3])
double *	GetPosition ()
void	GetPosition (double xyz[3])
void	SetOutline (int o)
int	GetOutline ()
void	OutlineOn ()
void	OutlineOff ()
void	SetXShadows (int o)
int	GetXShadows ()
void	XShadowsOn ()
void	XShadowsOff ()
void	SetYShadows (int o)
int	GetYShadows ()
void	YShadowsOn ()
void	YShadowsOff ()
void	SetZShadows (int o)
int	GetZShadows ()
void	ZShadowsOn ()
void	ZShadowsOff ()
void	SetTranslationMode (int mode)
int	GetTranslationMode ()
void	TranslationModeOn ()
void	TranslationModeOff ()
void	AllOn ()
void	AllOff ()
virtual vtkProperty *	GetProperty ()
virtual vtkProperty *	GetSelectedProperty ()
virtual void	SetHotSpotSize (double)
virtual double	GetHotSpotSize ()
Public Member Functions inherited from vtk3DWidget
virtual void	SetProp3D (vtkProp3D *)
virtual vtkProp3D *	GetProp3D ()
virtual void	SetInput (vtkDataSet *)
virtual vtkDataSet *	GetInput ()
virtual void	SetPlaceFactor (double)
virtual double	GetPlaceFactor ()
virtual void	SetHandleSize (double)
virtual double	GetHandleSize ()
Public Member Functions inherited from vtkInteractorObserver
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	OnChar ()
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual void	SetPriority (float)
virtual float	GetPriority ()
virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()
virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
virtual void	SetCurrentRenderer (vtkRenderer *)
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	ReleaseFocus ()
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkPointWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkPointWidget *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtk3DWidget
static int	IsTypeOf (const char *type)
static vtk3DWidget *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObject *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObject *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Types
enum	WidgetState {   Start =0, Moving, Scaling, Translating,   Outside }

Protected Member Functions
	vtkPointWidget ()
	~vtkPointWidget ()
virtual void	OnMouseMove ()
virtual void	OnLeftButtonDown ()
virtual void	OnLeftButtonUp ()
virtual void	OnMiddleButtonDown ()
virtual void	OnMiddleButtonUp ()
virtual void	OnRightButtonDown ()
virtual void	OnRightButtonUp ()
void	Highlight (int highlight)
void	Translate (double *p1, double *p2)
void	Scale (double *p1, double *p2, int X, int Y)
void	MoveFocus (double *p1, double *p2)
void	CreateDefaultProperties ()
int	DetermineConstraintAxis (int constraint, double *x)
Protected Member Functions inherited from vtk3DWidget
	vtk3DWidget ()
	~vtk3DWidget ()
void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])
double	SizeHandles (double factor)
virtual void	SizeHandles ()
Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()
	~vtkInteractorObserver ()
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
virtual void	EndInteraction ()
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &os)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ProcessEvents (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)

Protected Attributes
int	State
vtkActor *	Actor
vtkPolyDataMapper *	Mapper
vtkCursor3D *	Cursor3D
vtkCellPicker *	CursorPicker
int	ConstraintAxis
int	TranslationMode
vtkProperty *	Property
vtkProperty *	SelectedProperty
double	HotSpotSize
int	WaitingForMotion
int	WaitCount
Protected Attributes inherited from vtk3DWidget
vtkProp3D *	Prop3D
vtkDataSet *	Input
double	PlaceFactor
int	Placed
double	InitialBounds [6]
double	InitialLength
double	HandleSize
int	ValidPick
double	LastPickPosition [3]
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Friends
class	vtkLineWidget

Detailed Description

position a point in 3D space

This 3D widget allows the user to position a point in 3D space using a 3D cursor. The cursor has an outline bounding box, axes-aligned cross-hairs, and axes shadows. (The outline and shadows can be turned off.) Any of these can be turned off. A nice feature of the object is that the vtkPointWidget, like any 3D widget, will work with the current interactor style. That is, if vtkPointWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkPointWidget will terminate the processing of the event that it handles.

To use this object, just invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor. You may also wish to invoke "PlaceWidget()" to initially position the widget. The interactor will act normally until the "i" key (for "interactor") is pressed, at which point the vtkPointWidget will appear. (See superclass documentation for information about changing this behavior.) To move the point, the user can grab (left mouse) on any widget line and "slide" the point into position. Scaling is achieved by using the right mouse button "up" the render window (makes the widget bigger) or "down" the render window (makes the widget smaller). To translate the widget use the middle mouse button. (Note: all of the translation interactions can be constrained to one of the x-y-z axes by using the "shift" key.) The vtkPointWidget produces as output a polydata with a single point and a vertex cell.

Some additional features of this class include the ability to control the rendered properties of the widget. You can set the properties of the selected and unselected representations of the parts of the widget. For example, you can set the property of the 3D cursor in its normal and selected states.

Warning

Note that widget can be picked even when it is "behind" other actors. This is an intended feature and not a bug.

The constrained translation/sliding action (i.e., when the "shift" key is depressed) along the axes is based on a combination of a "hot" spot around the cursor focus plus the initial mouse motion after selection. That is, if the user selects an axis outside of the hot spot, then the motion is constrained along that axis. If the user selects the point widget near the focus (within the hot spot), the initial motion defines a vector which is compared to the x-y-z axes. The motion is constrained to the axis that is most parallel to the initial motion vector.

See also

vtk3DWidget vtkLineWidget vtkBoxWidget vtkPlaneWidget

Events:

vtkCommand::DisableEvent vtkCommand::InteractionEvent vtkCommand::EndInteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EnableEvent

Examples:

vtkPointWidget (Examples)

Tests:

vtkPointWidget (Tests)

Definition at line 88 of file vtkPointWidget.h.

Member Typedef Documentation

typedef vtk3DWidget vtkPointWidget::Superclass

Definition at line 94 of file vtkPointWidget.h.

Member Enumeration Documentation

enum vtkPointWidget::WidgetState

protected

Enumerator
Start
Moving
Scaling
Translating
Outside

Definition at line 230 of file vtkPointWidget.h.

Constructor & Destructor Documentation

vtkPointWidget::vtkPointWidget ( )

protected

vtkPointWidget::~vtkPointWidget ( )

protected

Member Function Documentation

static vtkPointWidget* vtkPointWidget::New ( )

static

Instantiate this widget

virtual const char* vtkPointWidget::GetClassName ( )

virtual

Reimplemented from vtk3DWidget.

static int vtkPointWidget::IsTypeOf ( const char *  type )

static

virtual int vtkPointWidget::IsA ( const char *  name )

virtual

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 vtk3DWidget.

static vtkPointWidget* vtkPointWidget::SafeDownCast ( vtkObject *  o )

static

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

virtual

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 vtk3DWidget.

virtual void vtkPointWidget::SetEnabled ( int  )

virtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

virtual void vtkPointWidget::PlaceWidget ( double  bounds[6] )

virtual

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

void vtkPointWidget::PlaceWidget ( )

inlinevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 101 of file vtkPointWidget.h.

void vtkPointWidget::PlaceWidget ( double  xmin, double  xmax, double  ymin, double  ymax, double  zmin, double  zmax  )

inlinevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 103 of file vtkPointWidget.h.

void vtkPointWidget::GetPolyData

(

vtkPolyData *

pd

)

Grab the polydata (including points) that defines the point. A single point and a vertex compose the vtkPolyData.

void vtkPointWidget::SetPosition ( double  x, double  y, double  z  )

inline

Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.

Definition at line 116 of file vtkPointWidget.h.

void vtkPointWidget::SetPosition ( double  x[3] )

inline

Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.

Definition at line 118 of file vtkPointWidget.h.

double* vtkPointWidget::GetPosition ( )

inline

Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.

Definition at line 120 of file vtkPointWidget.h.

void vtkPointWidget::GetPosition ( double  xyz[3] )

inline

Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.

Definition at line 122 of file vtkPointWidget.h.

void vtkPointWidget::SetOutline ( int  o )

inline

Turn on/off the wireframe bounding box.

Definition at line 128 of file vtkPointWidget.h.

int vtkPointWidget::GetOutline ( )

inline

Turn on/off the wireframe bounding box.

Definition at line 130 of file vtkPointWidget.h.

void vtkPointWidget::OutlineOn ( )

inline

Turn on/off the wireframe bounding box.

Definition at line 132 of file vtkPointWidget.h.

void vtkPointWidget::OutlineOff ( )

inline

Turn on/off the wireframe bounding box.

Definition at line 134 of file vtkPointWidget.h.

void vtkPointWidget::SetXShadows ( int  o )

inline

Turn on/off the wireframe x-shadows.

Definition at line 140 of file vtkPointWidget.h.

int vtkPointWidget::GetXShadows ( )

inline

Turn on/off the wireframe x-shadows.

Definition at line 142 of file vtkPointWidget.h.

void vtkPointWidget::XShadowsOn ( )

inline

Turn on/off the wireframe x-shadows.

Definition at line 144 of file vtkPointWidget.h.

void vtkPointWidget::XShadowsOff ( )

inline

Turn on/off the wireframe x-shadows.

Definition at line 146 of file vtkPointWidget.h.

void vtkPointWidget::SetYShadows ( int  o )

inline

Turn on/off the wireframe y-shadows.

Definition at line 152 of file vtkPointWidget.h.

int vtkPointWidget::GetYShadows ( )

inline

Turn on/off the wireframe y-shadows.

Definition at line 154 of file vtkPointWidget.h.

void vtkPointWidget::YShadowsOn ( )

inline

Turn on/off the wireframe y-shadows.

Definition at line 156 of file vtkPointWidget.h.

void vtkPointWidget::YShadowsOff ( )

inline

Turn on/off the wireframe y-shadows.

Definition at line 158 of file vtkPointWidget.h.

void vtkPointWidget::SetZShadows ( int  o )

inline

Turn on/off the wireframe z-shadows.

Definition at line 164 of file vtkPointWidget.h.

int vtkPointWidget::GetZShadows ( )

inline

Turn on/off the wireframe z-shadows.

Definition at line 166 of file vtkPointWidget.h.

void vtkPointWidget::ZShadowsOn ( )

inline

Turn on/off the wireframe z-shadows.

Definition at line 168 of file vtkPointWidget.h.

void vtkPointWidget::ZShadowsOff ( )

inline

Turn on/off the wireframe z-shadows.

Definition at line 170 of file vtkPointWidget.h.

void vtkPointWidget::SetTranslationMode ( int  mode )

inline

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.

Definition at line 178 of file vtkPointWidget.h.

int vtkPointWidget::GetTranslationMode ( )

inline

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.

Definition at line 180 of file vtkPointWidget.h.

void vtkPointWidget::TranslationModeOn ( )

inline

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.

Definition at line 182 of file vtkPointWidget.h.

void vtkPointWidget::TranslationModeOff ( )

inline

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.

Definition at line 184 of file vtkPointWidget.h.

void vtkPointWidget::AllOn ( )

inline

Convenience methods to turn outline and shadows on and off.

Definition at line 190 of file vtkPointWidget.h.

void vtkPointWidget::AllOff ( )

inline

Convenience methods to turn outline and shadows on and off.

Definition at line 197 of file vtkPointWidget.h.

virtual vtkProperty* vtkPointWidget::GetProperty ( )

virtual

Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be set.

virtual vtkProperty* vtkPointWidget::GetSelectedProperty ( )

virtual

Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be set.

virtual void vtkPointWidget::SetHotSpotSize ( double  )

virtual

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

virtual double vtkPointWidget::GetHotSpotSize ( )

virtual

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

static void vtkPointWidget::ProcessEvents ( vtkObject *  object, unsigned long  event, void *  clientdata, void *  calldata  )

staticprotected

virtual void vtkPointWidget::OnMouseMove ( )

protectedvirtual

virtual void vtkPointWidget::OnLeftButtonDown ( )

protectedvirtual

virtual void vtkPointWidget::OnLeftButtonUp ( )

protectedvirtual

virtual void vtkPointWidget::OnMiddleButtonDown ( )

protectedvirtual

virtual void vtkPointWidget::OnMiddleButtonUp ( )

protectedvirtual

virtual void vtkPointWidget::OnRightButtonDown ( )

protectedvirtual

virtual void vtkPointWidget::OnRightButtonUp ( )

protectedvirtual

void vtkPointWidget::Highlight ( int  highlight )

protected

void vtkPointWidget::Translate ( double *  p1, double *  p2  )

protected

void vtkPointWidget::Scale ( double *  p1, double *  p2, int  X, int  Y  )

protected

void vtkPointWidget::MoveFocus ( double *  p1, double *  p2  )

protected

void vtkPointWidget::CreateDefaultProperties ( )

protected

int vtkPointWidget::DetermineConstraintAxis ( int  constraint, double *  x  )

protected

Friends And Related Function Documentation

friend class vtkLineWidget

friend

Definition at line 227 of file vtkPointWidget.h.

Member Data Documentation

int vtkPointWidget::State

protected

Definition at line 229 of file vtkPointWidget.h.

vtkActor* vtkPointWidget::Actor

protected

Definition at line 256 of file vtkPointWidget.h.

vtkPolyDataMapper* vtkPointWidget::Mapper

protected

Definition at line 257 of file vtkPointWidget.h.

vtkCursor3D* vtkPointWidget::Cursor3D

protected

Definition at line 258 of file vtkPointWidget.h.

vtkCellPicker* vtkPointWidget::CursorPicker

protected

Definition at line 262 of file vtkPointWidget.h.

int vtkPointWidget::ConstraintAxis

protected

Definition at line 265 of file vtkPointWidget.h.

int vtkPointWidget::TranslationMode

protected

Definition at line 269 of file vtkPointWidget.h.

vtkProperty* vtkPointWidget::Property

protected

Definition at line 273 of file vtkPointWidget.h.

vtkProperty* vtkPointWidget::SelectedProperty

protected

Definition at line 274 of file vtkPointWidget.h.

double vtkPointWidget::HotSpotSize

protected

Definition at line 278 of file vtkPointWidget.h.

int vtkPointWidget::WaitingForMotion

protected

Definition at line 280 of file vtkPointWidget.h.

int vtkPointWidget::WaitCount

protected

Definition at line 281 of file vtkPointWidget.h.

---

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

• dox/Widgets/vtkPointWidget.h