VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPolyDataSourceWidget Class Reference

abstract PolyDataSource-based 3D widget More...

#include <vtkPolyDataSourceWidget.h>

Inheritance diagram for vtkPolyDataSourceWidget:
[legend]
Collaboration diagram for vtkPolyDataSourceWidget:
[legend]

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)
virtual void PlaceWidget ()
virtual void PlaceWidget (double bounds[6])=0
virtual void UpdatePlacement ()=0
void PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
virtual vtkPolyDataSourceGetPolyDataSource ()
virtual vtkPolyDataAlgorithmGetPolyDataAlgorithm ()=0
- Public Member Functions inherited from vtk3DWidget
virtual void SetProp3D (vtkProp3D *)
virtual vtkProp3DGetProp3D ()
virtual void SetInput (vtkDataSet *)
virtual vtkDataSetGetInput ()
virtual void SetPlaceFactor (double)
virtual double GetPlaceFactor ()
virtual void SetHandleSize (double)
virtual double GetHandleSize ()
- Public Member Functions inherited from vtkInteractorObserver
virtual void OnChar ()
virtual void SetEnabled (int)
int GetEnabled ()
void EnabledOn ()
void EnabledOff ()
void On ()
void Off ()
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
virtual vtkRenderWindowInteractorGetInteractor ()
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 vtkRendererGetDefaultRenderer ()
virtual void SetDefaultRenderer (vtkRenderer *)
virtual vtkRendererGetCurrentRenderer ()
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)
vtkCommandGetCommand (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 int IsTypeOf (const char *type)
static vtkPolyDataSourceWidgetSafeDownCast (vtkObject *o)

Protected Member Functions

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

Additional Inherited Members

- Static Protected Member Functions inherited from vtkInteractorObserver
static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
- Protected Attributes inherited from vtk3DWidget
vtkProp3DProp3D
vtkDataSetInput
double PlaceFactor
int Placed
double InitialBounds [6]
double InitialLength
double HandleSize
int ValidPick
double LastPickPosition [3]
- Friends inherited from vtkObject

Detailed Description

abstract PolyDataSource-based 3D widget

This abstract class serves as parent to 3D widgets that have simple vtkPolyDataSource instances defining their geometry.

In addition to what is offered by the vtk3DWidget parent, this class makes it possible to manipulate the underlying polydatasource and to PlaceWidget() according to that, instead of having to make use of SetInput() or SetProp3D().

Implementors of child classes HAVE to implement their PlaceWidget(bounds) to check for the existence of Input and Prop3D FIRST. If these don't exist, place according to the underlying PolyDataSource. Child classes also have to imprement UpdatePlacement(), which updates the widget according to the geometry of the underlying PolyDataSource.

See Also
vtk3DWidget vtkLineWidget vtkPlaneWidget vtkSphereWidget

Definition at line 44 of file vtkPolyDataSourceWidget.h.

Member Typedef Documentation

Definition at line 47 of file vtkPolyDataSourceWidget.h.

Constructor & Destructor Documentation

vtkPolyDataSourceWidget::vtkPolyDataSourceWidget ( )
protected

Empty constructor that calls the parent constructor. Child classes should call this constructor as part of their initialisation.

Member Function Documentation

virtual const char* vtkPolyDataSourceWidget::GetClassName ( )
virtual

Reimplemented from vtk3DWidget.

Reimplemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

static int vtkPolyDataSourceWidget::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.

Reimplemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

virtual int vtkPolyDataSourceWidget::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.

Reimplemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

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

Reimplemented from vtk3DWidget.

Reimplemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

void vtkPolyDataSourceWidget::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.

Reimplemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

virtual void vtkPolyDataSourceWidget::PlaceWidget ( )
virtual

Overrides vtk3DWidget PlaceWidget() so that it doesn't complain if there's no Input and no Prop3D.

Reimplemented from vtk3DWidget.

Reimplemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

virtual void vtkPolyDataSourceWidget::PlaceWidget ( double  bounds[6])
pure virtual

We have to redeclare this abstract, PlaceWidget() requires it. You HAVE to override this in your concrete child classes. If there's no Prop3D and no Input, your PlaceWidget must make use of the underlying PolyDataSource to do its work.

Implements vtk3DWidget.

Implemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

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

Convenience method brought over from vtkPlaneWidget.

Reimplemented from vtk3DWidget.

Reimplemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

Definition at line 62 of file vtkPolyDataSourceWidget.h.

virtual vtkPolyDataSource* vtkPolyDataSourceWidget::GetPolyDataSource ( )
virtual

Returns underlying vtkPolyDataSource that determines geometry. This can be modified after which PlaceWidget() or UpdatePlacement() can be called. UpdatePlacement() will always update the planewidget according to the geometry of the underlying PolyDataSource. PlaceWidget() will only make use of this geometry if there is no Input and no Prop3D set.

virtual vtkPolyDataAlgorithm* vtkPolyDataSourceWidget::GetPolyDataAlgorithm ( )
pure virtual

Returns underlying vtkPolyDataSource that determines geometry. This can be modified after which PlaceWidget() or UpdatePlacement() can be called. UpdatePlacement() will always update the planewidget according to the geometry of the underlying PolyDataSource. PlaceWidget() will only make use of this geometry if there is no Input and no Prop3D set.

Implemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.

virtual void vtkPolyDataSourceWidget::UpdatePlacement ( )
pure virtual

If you've made changes to the underlying vtkPolyDataSource AFTER your initial call to PlaceWidget(), use this method to realise the changes in the widget.

Implemented in vtkImagePlaneWidget, vtkPlaneWidget, and vtkImplicitPlaneWidget.


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