vtkSphereWidget Class Reference

#include <vtkSphereWidget.h>

Inheritance diagram for vtkSphereWidget:

[legend]

Collaboration diagram for vtkSphereWidget:

[legend]

List of all members.

Detailed Description

3D widget for manipulating a sphere

This 3D widget defines a sphere that can be interactively placed in a scene.

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 vtkSphereWidget will appear. (See superclass documentation for information about changing this behavior.) Events that occur outside of the widget (i.e., no part of the widget is picked) are propagated to any other registered obsevers (such as the interaction style). Turn off the widget by pressing the "i" key again (or invoke the Off() method).

The vtkSphereWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetThetaResolution() and Set/GetPhiResolution() methods control the number of subdivisions of the sphere in the theta and phi directions; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding streamlines. The GetSphere() method returns a sphere implicit function that can be used for cutting and clipping. Typical usage of the widget is to make use of the StartInteractionEvent, InteractionEvent, and EndInteractionEvent events. The InteractionEvent is called on mouse motion; the other two events are called on button down and button up (any mouse button).

Some additional features of this class include the ability to control the properties of the widget. You can set the properties of the selected and unselected representations of the sphere.

Warning:: Note that the sphere can be picked even when they are "behind" other actors. This is an intended feature and not a bug.

See also:: vtk3DWidget vtkLineWidget vtkBoxWidget vtkPlaneWidget

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

Examples:: vtkSphereWidget (Examples)

Definition at line 81 of file vtkSphereWidget.h.


Public Types
typedef vtk3DWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	GetPolyData (vtkPolyData *pd)
void	GetSphere (vtkSphere *sphere)

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)

virtual void	SetRepresentation (int)
virtual int	GetRepresentation ()
void	SetRepresentationToOff ()
void	SetRepresentationToWireframe ()
void	SetRepresentationToSurface ()

void	SetThetaResolution (int r)
int	GetThetaResolution ()

void	SetPhiResolution (int r)
int	GetPhiResolution ()

void	SetRadius (double r)
double	GetRadius ()

void	SetCenter (double x, double y, double z)
void	SetCenter (double x[3])
double *	GetCenter ()
void	GetCenter (double xyz[3])

virtual void	SetTranslation (int)
virtual int	GetTranslation ()
virtual void	TranslationOn ()
virtual void	TranslationOff ()
virtual void	SetScale (int)
virtual int	GetScale ()
virtual void	ScaleOn ()
virtual void	ScaleOff ()

virtual void	SetHandleVisibility (int)
virtual int	GetHandleVisibility ()
virtual void	HandleVisibilityOn ()
virtual void	HandleVisibilityOff ()

virtual void	SetHandleDirection (double, double, double)
virtual void	SetHandleDirection (double[3])
virtual double *	GetHandleDirection ()
virtual void	GetHandleDirection (double &, double &, double &)
virtual void	GetHandleDirection (double[3])

virtual double *	GetHandlePosition ()
virtual void	GetHandlePosition (double &, double &, double &)
virtual void	GetHandlePosition (double[3])

virtual vtkProperty *	GetSphereProperty ()
virtual vtkProperty *	GetSelectedSphereProperty ()

virtual vtkProperty *	GetHandleProperty ()
virtual vtkProperty *	GetSelectedHandleProperty ()
Static Public Member Functions
static vtkSphereWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkSphereWidget *	SafeDownCast (vtkObject *o)
Protected Types
enum	WidgetState { Start = 0, Moving, Scaling, Positioning, Outside }
Protected Member Functions
	vtkSphereWidget ()
	~vtkSphereWidget ()
void	OnLeftButtonDown ()
void	OnLeftButtonUp ()
void	OnRightButtonDown ()
void	OnRightButtonUp ()
void	OnMouseMove ()
void	HighlightSphere (int highlight)
void	SelectRepresentation ()
void	Translate (double p1, double p2)
void	ScaleSphere (double p1, double p2, int X, int Y)
void	MoveHandle (double p1, double p2, int X, int Y)
void	PlaceHandle (double *center, double radius)
void	CreateDefaultProperties ()
void	HighlightHandle (int)
virtual void	SizeHandles ()
Static Protected Member Functions
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
Protected Attributes
int	State
vtkActor *	SphereActor
vtkPolyDataMapper *	SphereMapper
vtkSphereSource *	SphereSource
int	Representation
vtkCellPicker *	Picker
int	Translation
int	Scale
vtkProperty *	SphereProperty
vtkProperty *	SelectedSphereProperty
vtkProperty *	HandleProperty
vtkProperty *	SelectedHandleProperty
vtkActor *	HandleActor
vtkPolyDataMapper *	HandleMapper
vtkSphereSource *	HandleSource
int	HandleVisibility
double	HandleDirection [3]
double	HandlePosition [3]

Member Typedef Documentation

typedef vtk3DWidget vtkSphereWidget::Superclass

Reimplemented from vtk3DWidget.

Definition at line 87 of file vtkSphereWidget.h.

Member Enumeration Documentation

enum vtkSphereWidget::WidgetState [protected]

Enumerator:

Start
Moving
Scaling
Positioning
Outside

Definition at line 232 of file vtkSphereWidget.h.

Constructor & Destructor Documentation

vtkSphereWidget::vtkSphereWidget ( ) [protected]

vtkSphereWidget::~vtkSphereWidget ( ) [protected]

Member Function Documentation

static vtkSphereWidget* vtkSphereWidget::New ( ) [static]

Instantiate the object.

Reimplemented from vtkObject.

virtual const char* vtkSphereWidget::GetClassName ( ) [virtual]

Reimplemented from vtk3DWidget.

static int vtkSphereWidget::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkSphereWidget::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 vtkSphereWidget* vtkSphereWidget::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtk3DWidget.

void vtkSphereWidget::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 vtkSphereWidget::SetEnabled ( int ) [virtual]

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

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

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

void vtkSphereWidget::PlaceWidget ( ) [inline, virtual]

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 94 of file vtkSphereWidget.h.

void vtkSphereWidget::PlaceWidget	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)			`[inline, virtual]`

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 96 of file vtkSphereWidget.h.

virtual void vtkSphereWidget::SetRepresentation ( int ) [virtual]

Set the representation of the sphere. Different representations are useful depending on the application. The default is VTK_SPHERE_WIREFRAME.

virtual int vtkSphereWidget::GetRepresentation ( ) [virtual]

Set the representation of the sphere. Different representations are useful depending on the application. The default is VTK_SPHERE_WIREFRAME.

void vtkSphereWidget::SetRepresentationToOff ( ) [inline]

Set the representation of the sphere. Different representations are useful depending on the application. The default is VTK_SPHERE_WIREFRAME.

Definition at line 107 of file vtkSphereWidget.h.

void vtkSphereWidget::SetRepresentationToWireframe ( ) [inline]

Set the representation of the sphere. Different representations are useful depending on the application. The default is VTK_SPHERE_WIREFRAME.

Definition at line 109 of file vtkSphereWidget.h.

void vtkSphereWidget::SetRepresentationToSurface ( ) [inline]

Set the representation of the sphere. Different representations are useful depending on the application. The default is VTK_SPHERE_WIREFRAME.

Definition at line 111 of file vtkSphereWidget.h.

void vtkSphereWidget::SetThetaResolution ( int r ) [inline]

Set/Get the resolution of the sphere in the Theta direction. The default is 16.

Definition at line 118 of file vtkSphereWidget.h.

int vtkSphereWidget::GetThetaResolution ( ) [inline]

Set/Get the resolution of the sphere in the Theta direction. The default is 16.

Definition at line 120 of file vtkSphereWidget.h.

void vtkSphereWidget::SetPhiResolution ( int r ) [inline]

Set/Get the resolution of the sphere in the Phi direction. The default is 8.

Definition at line 127 of file vtkSphereWidget.h.

int vtkSphereWidget::GetPhiResolution ( ) [inline]

Set/Get the resolution of the sphere in the Phi direction. The default is 8.

Definition at line 129 of file vtkSphereWidget.h.

void vtkSphereWidget::SetRadius ( double r ) [inline]

Set/Get the radius of sphere. Default is .5.

Definition at line 135 of file vtkSphereWidget.h.

double vtkSphereWidget::GetRadius ( ) [inline]

Set/Get the radius of sphere. Default is .5.

Definition at line 143 of file vtkSphereWidget.h.

void vtkSphereWidget::SetCenter	(	double	x,
		double	y,
		double	z
	)			`[inline]`

Set/Get the center of the sphere.

Definition at line 149 of file vtkSphereWidget.h.

void vtkSphereWidget::SetCenter ( double x[3] ) [inline]

Set/Get the center of the sphere.

Definition at line 153 of file vtkSphereWidget.h.

double* vtkSphereWidget::GetCenter ( ) [inline]

Set/Get the center of the sphere.

Definition at line 157 of file vtkSphereWidget.h.

void vtkSphereWidget::GetCenter ( double xyz[3] ) [inline]

Set/Get the center of the sphere.

Definition at line 159 of file vtkSphereWidget.h.

virtual void vtkSphereWidget::SetTranslation ( int ) [virtual]