VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtk3DWidget Class Referenceabstract

an abstract superclass for 3D widgets More...

#include <vtk3DWidget.h>

Inheritance diagram for vtk3DWidget:
[legend]

Public Types

typedef vtkInteractorObserver Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtk3DWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void PlaceWidget (double bounds[6])=0
 
virtual void PlaceWidget ()
 
virtual void PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 
virtual void SetProp3D (vtkProp3D *)
 
virtual vtkProp3D * GetProp3D ()
 
virtual void SetInputData (vtkDataSet *)
 
virtual void SetInputConnection (vtkAlgorithmOutput *)
 
virtual vtkDataSet * GetInput ()
 
virtual void SetPlaceFactor (double)
 
virtual double GetPlaceFactor ()
 
virtual void SetHandleSize (double)
 
virtual double GetHandleSize ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtk3DWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtk3DWidget ()
 
 ~vtk3DWidget ()
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
double SizeHandles (double factor)
 
virtual void SizeHandles ()
 
void UpdateInput ()
 

Protected Attributes

vtkProp3D * Prop3D
 
vtk3DWidgetConnection * ConnectionHolder
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
double HandleSize
 
int ValidPick
 
double LastPickPosition [3]
 

Detailed Description

an abstract superclass for 3D widgets

vtk3DWidget is an abstract superclass for 3D interactor observers. These 3D widgets represent themselves in the scene, and have special callbacks associated with them that allows interactive manipulation of the widget. Inparticular, the difference between a vtk3DWidget and its abstract superclass vtkInteractorObserver is that vtk3DWidgets are "placed" in 3D space. vtkInteractorObservers have no notion of where they are placed, and may not exist in 3D space at all. 3D widgets also provide auxiliary functions like producing a transformation, creating polydata (for seeding streamlines, probes, etc.) or creating implicit functions. See the concrete subclasses for particulars.

Typically the widget is used by specifying a vtkProp3D or VTK dataset as input, and then invoking the "On" method to activate it. (You can also specify a bounding box to help position the widget.) Prior to invoking the On() method, the user may also wish to use the PlaceWidget() to initially position it. The 'i' (for "interactor") keypresses also can be used to turn the widgets on and off (methods exist to change the key value and enable keypress activiation).

To support interactive manipulation of objects, this class (and subclasses) invoke the events StartInteractionEvent, InteractionEvent, and EndInteractionEvent. These events are invoked when the vtk3DWidget enters a state where rapid response is desired: mouse motion, etc. The events can be used, for example, to set the desired update frame rate (StartInteractionEvent), operate on the vtkProp3D or other object (InteractionEvent), and set the desired frame rate back to normal values (EndInteractionEvent).

Note that the Priority attribute inherited from vtkInteractorObserver has a new default value which is now 0.5 so that all 3D widgets have a higher priority than the usual interactor styles.

See Also
vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImplicitPlaneWidget
Events:
vtkCommand::PlaceWidgetEvent

Definition at line 69 of file vtk3DWidget.h.

Member Typedef Documentation

typedef vtkInteractorObserver vtk3DWidget::Superclass

Definition at line 72 of file vtk3DWidget.h.

Constructor & Destructor Documentation

vtk3DWidget::vtk3DWidget ( )
protected
vtk3DWidget::~vtk3DWidget ( )
protected

Member Function Documentation

static int vtk3DWidget::IsTypeOf ( const char *  type)
static
virtual int vtk3DWidget::IsA ( const char *  type)
virtual
static vtk3DWidget* vtk3DWidget::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtk3DWidget::NewInstanceInternal ( ) const
protectedvirtual
vtk3DWidget* vtk3DWidget::NewInstance ( ) const
void vtk3DWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtk3DWidget::PlaceWidget ( double  bounds[6])
pure virtual

This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.

Implemented in vtkImagePlaneWidget, vtkSplineWidget, vtkBrokenLineWidget, vtkPlaneWidget, vtkBoxWidget, vtkLineWidget, vtkImplicitPlaneWidget, vtkImageTracerWidget, vtkPointWidget, vtkSphereWidget, vtkImageCroppingRegionsWidget, and vtkPolyDataSourceWidget.

virtual void vtk3DWidget::PlaceWidget ( )
virtual

This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.

Reimplemented in vtkImagePlaneWidget, vtkSplineWidget, vtkBrokenLineWidget, vtkPlaneWidget, vtkBoxWidget, vtkLineWidget, vtkImplicitPlaneWidget, vtkImageTracerWidget, vtkPointWidget, vtkSphereWidget, and vtkPolyDataSourceWidget.

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

This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.

Reimplemented in vtkImagePlaneWidget, vtkSplineWidget, vtkBrokenLineWidget, vtkPlaneWidget, vtkBoxWidget, vtkLineWidget, vtkImplicitPlaneWidget, vtkImageTracerWidget, vtkPointWidget, vtkSphereWidget, and vtkPolyDataSourceWidget.

virtual void vtk3DWidget::SetProp3D ( vtkProp3D *  )
virtual

Specify a vtkProp3D around which to place the widget. This is not required, but if supplied, it is used to initially position the widget.

virtual vtkProp3D* vtk3DWidget::GetProp3D ( )
virtual

Specify a vtkProp3D around which to place the widget. This is not required, but if supplied, it is used to initially position the widget.

virtual void vtk3DWidget::SetInputData ( vtkDataSet *  )
virtual

Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.

virtual void vtk3DWidget::SetInputConnection ( vtkAlgorithmOutput )
virtual

Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.

Reimplemented in vtkImagePlaneWidget.

virtual vtkDataSet* vtk3DWidget::GetInput ( )
virtual

Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.

virtual void vtk3DWidget::SetPlaceFactor ( double  )
virtual

Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.

virtual double vtk3DWidget::GetPlaceFactor ( )
virtual

Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.

virtual void vtk3DWidget::SetHandleSize ( double  )
virtual

Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.

virtual double vtk3DWidget::GetHandleSize ( )
virtual

Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.

void vtk3DWidget::AdjustBounds ( double  bounds[6],
double  newBounds[6],
double  center[3] 
)
protected
double vtk3DWidget::SizeHandles ( double  factor)
protected
virtual void vtk3DWidget::SizeHandles ( )
inlineprotectedvirtual
void vtk3DWidget::UpdateInput ( )
protected

Member Data Documentation

vtkProp3D* vtk3DWidget::Prop3D
protected

Definition at line 131 of file vtk3DWidget.h.

vtk3DWidgetConnection* vtk3DWidget::ConnectionHolder
protected

Definition at line 133 of file vtk3DWidget.h.

double vtk3DWidget::PlaceFactor
protected

Definition at line 136 of file vtk3DWidget.h.

int vtk3DWidget::Placed
protected

Definition at line 137 of file vtk3DWidget.h.

double vtk3DWidget::InitialBounds[6]
protected

Definition at line 141 of file vtk3DWidget.h.

double vtk3DWidget::InitialLength
protected

Definition at line 142 of file vtk3DWidget.h.

double vtk3DWidget::HandleSize
protected

Definition at line 143 of file vtk3DWidget.h.

int vtk3DWidget::ValidPick
protected

Definition at line 148 of file vtk3DWidget.h.

double vtk3DWidget::LastPickPosition[3]
protected

Definition at line 149 of file vtk3DWidget.h.


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