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

3D widget for manipulating an infinite plane More...

#include <vtkImplicitPlaneWidget.h>

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

Public Types

typedef vtkPolyDataSourceWidget Superclass
- Public Types inherited from vtkPolyDataSourceWidget
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)
vtkPolyDataAlgorithmGetPolyDataAlgorithm ()
void GetPlane (vtkPlane *plane)
void UpdatePlacement ()
virtual void SizeHandles ()
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 SetOrigin (double x, double y, double z)
virtual void SetOrigin (double x[3])
double * GetOrigin ()
void GetOrigin (double xyz[3])
void SetNormal (double x, double y, double z)
void SetNormal (double x[3])
double * GetNormal ()
void GetNormal (double xyz[3])
void SetNormalToXAxis (int)
virtual int GetNormalToXAxis ()
virtual void NormalToXAxisOn ()
virtual void NormalToXAxisOff ()
void SetNormalToYAxis (int)
virtual int GetNormalToYAxis ()
virtual void NormalToYAxisOn ()
virtual void NormalToYAxisOff ()
void SetNormalToZAxis (int)
virtual int GetNormalToZAxis ()
virtual void NormalToZAxisOn ()
virtual void NormalToZAxisOff ()
virtual void SetTubing (int)
virtual int GetTubing ()
virtual void TubingOn ()
virtual void TubingOff ()
void SetDrawPlane (int plane)
virtual int GetDrawPlane ()
virtual void DrawPlaneOn ()
virtual void DrawPlaneOff ()
virtual void SetOutlineTranslation (int)
virtual int GetOutlineTranslation ()
virtual void OutlineTranslationOn ()
virtual void OutlineTranslationOff ()
virtual void SetOutsideBounds (int)
virtual int GetOutsideBounds ()
virtual void OutsideBoundsOn ()
virtual void OutsideBoundsOff ()
virtual void SetScaleEnabled (int)
virtual int GetScaleEnabled ()
virtual void ScaleEnabledOn ()
virtual void ScaleEnabledOff ()
virtual void SetOriginTranslation (int)
virtual int GetOriginTranslation ()
virtual void OriginTranslationOn ()
virtual void OriginTranslationOff ()
virtual void SetDiagonalRatio (double)
virtual double GetDiagonalRatio ()
virtual vtkPropertyGetNormalProperty ()
virtual vtkPropertyGetSelectedNormalProperty ()
virtual vtkPropertyGetPlaneProperty ()
virtual vtkPropertyGetSelectedPlaneProperty ()
virtual vtkPropertyGetOutlineProperty ()
virtual vtkPropertyGetSelectedOutlineProperty ()
virtual vtkPropertyGetEdgesProperty ()
- Public Member Functions inherited from vtkPolyDataSourceWidget
virtual vtkPolyDataSourceGetPolyDataSource ()
- 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 ()
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 vtkImplicitPlaneWidgetNew ()
static int IsTypeOf (const char *type)
static vtkImplicitPlaneWidgetSafeDownCast (vtkObject *o)

Protected Types

enum  WidgetState {
  Start = 0, MovingPlane, MovingOutline, MovingOrigin,
  Scaling, Pushing, Rotating, Outside
}

Protected Member Functions

 vtkImplicitPlaneWidget ()
 ~vtkImplicitPlaneWidget ()
void OnLeftButtonDown ()
void OnLeftButtonUp ()
void OnMiddleButtonDown ()
void OnMiddleButtonUp ()
void OnRightButtonDown ()
void OnRightButtonUp ()
void OnMouseMove ()
void UpdateRepresentation ()
void HighlightOutline (int highlight)
virtual void HighlightPlane (int highlight)
void HighlightNormal (int highlight)
void ConstrainOrigin (double x[3])
void Rotate (int X, int Y, double *p1, double *p2, double *vpn)
void TranslatePlane (double *p1, double *p2)
void TranslateOutline (double *p1, double *p2)
void TranslateOrigin (double *p1, double *p2)
void Push (double *p1, double *p2)
void Scale (double *p1, double *p2, int X, int Y)
void CreateDefaultProperties ()
void GeneratePlane ()
- Protected Member Functions inherited from vtkPolyDataSourceWidget
 vtkPolyDataSourceWidget ()
- Protected Member Functions inherited from vtk3DWidget
 vtk3DWidget ()
 ~vtk3DWidget ()
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
double SizeHandles (double factor)
- 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)

Protected Attributes

int State
int NormalToXAxis
int NormalToYAxis
int NormalToZAxis
vtkPlanePlane
vtkImageDataBox
vtkOutlineFilterOutline
vtkPolyDataMapperOutlineMapper
vtkActorOutlineActor
int OutlineTranslation
int ScaleEnabled
int OutsideBounds
vtkCutterCutter
vtkPolyDataMapperCutMapper
vtkActorCutActor
int DrawPlane
vtkFeatureEdgesEdges
vtkTubeFilterEdgesTuber
vtkPolyDataMapperEdgesMapper
vtkActorEdgesActor
int Tubing
double DiagonalRatio
vtkConeSourceConeSource
vtkPolyDataMapperConeMapper
vtkActorConeActor
vtkLineSourceLineSource
vtkPolyDataMapperLineMapper
vtkActorLineActor
vtkConeSourceConeSource2
vtkPolyDataMapperConeMapper2
vtkActorConeActor2
vtkLineSourceLineSource2
vtkPolyDataMapperLineMapper2
vtkActorLineActor2
vtkSphereSourceSphere
vtkPolyDataMapperSphereMapper
vtkActorSphereActor
int OriginTranslation
vtkCellPickerPicker
vtkTransformTransform
vtkPropertyNormalProperty
vtkPropertySelectedNormalProperty
vtkPropertyPlaneProperty
vtkPropertySelectedPlaneProperty
vtkPropertyOutlineProperty
vtkPropertySelectedOutlineProperty
vtkPropertyEdgesProperty

Detailed Description

3D widget for manipulating an infinite plane

This 3D widget defines an infinite plane that can be interactively placed in a scene. The widget is represented by a plane with a normal vector; the plane is contained by a bounding box, and where the plane intersects the bounding box the edges are shown (possibly tubed). The normal can be selected and moved to rotate the plane; the plane itself can be selected and translated in various directions. As the plane is moved, the implicit plane function and polygon (representing the plane cut against the bounding box) is updated.

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. If the "i" key (for "interactor") is pressed, the vtkImplicitPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) If you select the normal vector, the plane can be arbitrarily rotated. The plane can be translated along the normal by selecting the plane and moving it. The plane (the plane origin) can also be arbitrary moved by selecting the plane with the middle mouse button. The right mouse button can be used to uniformly scale the bounding box (moving "up" the box scales larger; moving "down" the box scales smaller). 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 vtkImplicitPlaneWidget has several methods that can be used in conjunction with other VTK objects. The GetPolyData() method can be used to get a polygonal representation (the single polygon clipped by the bounding box). 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 (either left or right button). (Note: there is also a PlaceWidgetEvent that is invoked when the widget is placed with PlaceWidget().)

Some additional features of this class include the ability to control the properties of the widget. You do this by setting property values on the normal vector (selected and unselected properties); the plane (selected and unselected properties); the outline (selected and unselected properties); and the edges. The edges may also be tubed or not.

Warning
Note that the widget can be picked even when it is "behind" other actors. This is an intended feature and not a bug.
See Also
vtk3DWidget vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget
Events:
vtkCommand::DisableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EnableEvent
Examples:
vtkImplicitPlaneWidget (Examples)
Tests:
vtkImplicitPlaneWidget (Tests)

Definition at line 97 of file vtkImplicitPlaneWidget.h.

Member Typedef Documentation

Definition at line 103 of file vtkImplicitPlaneWidget.h.

Member Enumeration Documentation

Enumerator:
Start 
MovingPlane 
MovingOutline 
MovingOrigin 
Scaling 
Pushing 
Rotating 
Outside 

Definition at line 258 of file vtkImplicitPlaneWidget.h.

Constructor & Destructor Documentation

vtkImplicitPlaneWidget::vtkImplicitPlaneWidget ( )
protected
vtkImplicitPlaneWidget::~vtkImplicitPlaneWidget ( )
protected

Member Function Documentation

static vtkImplicitPlaneWidget* vtkImplicitPlaneWidget::New ( )
static

Instantiate the object.

Reimplemented from vtkObject.

virtual const char* vtkImplicitPlaneWidget::GetClassName ( )
virtual

Reimplemented from vtkPolyDataSourceWidget.

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

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

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

Reimplemented from vtkPolyDataSourceWidget.

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

virtual void vtkImplicitPlaneWidget::SetEnabled ( int  )
virtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

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

Methods that satisfy the superclass' API.

Implements vtkPolyDataSourceWidget.

void vtkImplicitPlaneWidget::PlaceWidget ( )
inlinevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtkPolyDataSourceWidget.

Definition at line 110 of file vtkImplicitPlaneWidget.h.

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

Methods that satisfy the superclass' API.

Reimplemented from vtkPolyDataSourceWidget.

Definition at line 112 of file vtkImplicitPlaneWidget.h.

virtual void vtkImplicitPlaneWidget::SetOrigin ( double  x,
double  y,
double  z 
)
virtual

Get the origin of the plane.

virtual void vtkImplicitPlaneWidget::SetOrigin ( double  x[3])
virtual

Get the origin of the plane.

double* vtkImplicitPlaneWidget::GetOrigin ( )

Get the origin of the plane.

void vtkImplicitPlaneWidget::GetOrigin ( double  xyz[3])

Get the origin of the plane.

void vtkImplicitPlaneWidget::SetNormal ( double  x,
double  y,
double  z 
)

Get the normal to the plane.

void vtkImplicitPlaneWidget::SetNormal ( double  x[3])

Get the normal to the plane.

double* vtkImplicitPlaneWidget::GetNormal ( )

Get the normal to the plane.

void vtkImplicitPlaneWidget::GetNormal ( double  xyz[3])

Get the normal to the plane.

void vtkImplicitPlaneWidget::SetNormalToXAxis ( int  )

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual int vtkImplicitPlaneWidget::GetNormalToXAxis ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void vtkImplicitPlaneWidget::NormalToXAxisOn ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void vtkImplicitPlaneWidget::NormalToXAxisOff ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

void vtkImplicitPlaneWidget::SetNormalToYAxis ( int  )

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual int vtkImplicitPlaneWidget::GetNormalToYAxis ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void vtkImplicitPlaneWidget::NormalToYAxisOn ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void vtkImplicitPlaneWidget::NormalToYAxisOff ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

void vtkImplicitPlaneWidget::SetNormalToZAxis ( int  )

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual int vtkImplicitPlaneWidget::GetNormalToZAxis ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void vtkImplicitPlaneWidget::NormalToZAxisOn ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void vtkImplicitPlaneWidget::NormalToZAxisOff ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void vtkImplicitPlaneWidget::SetTubing ( int  )
virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

virtual int vtkImplicitPlaneWidget::GetTubing ( )
virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

virtual void vtkImplicitPlaneWidget::TubingOn ( )
virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

virtual void vtkImplicitPlaneWidget::TubingOff ( )
virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

void vtkImplicitPlaneWidget::SetDrawPlane ( int  plane)

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual int vtkImplicitPlaneWidget::GetDrawPlane ( )
virtual

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual void vtkImplicitPlaneWidget::DrawPlaneOn ( )
virtual

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual void vtkImplicitPlaneWidget::DrawPlaneOff ( )
virtual

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual void vtkImplicitPlaneWidget::SetOutlineTranslation ( int  )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual int vtkImplicitPlaneWidget::GetOutlineTranslation ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void vtkImplicitPlaneWidget::OutlineTranslationOn ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void vtkImplicitPlaneWidget::OutlineTranslationOff ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void vtkImplicitPlaneWidget::SetOutsideBounds ( int  )
virtual

Turn on/off the ability to move the widget outside of the input's bound

virtual int vtkImplicitPlaneWidget::GetOutsideBounds ( )
virtual

Turn on/off the ability to move the widget outside of the input's bound

virtual void vtkImplicitPlaneWidget::OutsideBoundsOn ( )
virtual

Turn on/off the ability to move the widget outside of the input's bound

virtual void vtkImplicitPlaneWidget::OutsideBoundsOff ( )
virtual

Turn on/off the ability to move the widget outside of the input's bound

virtual void vtkImplicitPlaneWidget::SetScaleEnabled ( int  )
virtual

Turn on/off the ability to scale with the mouse

virtual int vtkImplicitPlaneWidget::GetScaleEnabled ( )
virtual

Turn on/off the ability to scale with the mouse

virtual void vtkImplicitPlaneWidget::ScaleEnabledOn ( )
virtual

Turn on/off the ability to scale with the mouse

virtual void vtkImplicitPlaneWidget::ScaleEnabledOff ( )
virtual

Turn on/off the ability to scale with the mouse

virtual void vtkImplicitPlaneWidget::SetOriginTranslation ( int  )
virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

virtual int vtkImplicitPlaneWidget::GetOriginTranslation ( )
virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

virtual void vtkImplicitPlaneWidget::OriginTranslationOn ( )
virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

virtual void vtkImplicitPlaneWidget::OriginTranslationOff ( )
virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

virtual void vtkImplicitPlaneWidget::SetDiagonalRatio ( double  )
virtual

By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2]

virtual double vtkImplicitPlaneWidget::GetDiagonalRatio ( )
virtual

By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2]

void vtkImplicitPlaneWidget::GetPolyData ( vtkPolyData pd)

Grab the polydata that defines the plane. The polydata contains a single polygon that is clipped by the bounding box.

vtkPolyDataAlgorithm* vtkImplicitPlaneWidget::GetPolyDataAlgorithm ( )
virtual

Satisfies superclass API. This returns a pointer to the underlying PolyData (which represents the plane).

Implements vtkPolyDataSourceWidget.

void vtkImplicitPlaneWidget::GetPlane ( vtkPlane plane)

Get the implicit function for the plane. The user must provide the instance of the class vtkPlane. Note that vtkPlane is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data.

void vtkImplicitPlaneWidget::UpdatePlacement ( )
virtual

Satisfies the superclass API. This will change the state of the widget to match changes that have been made to the underlying PolyDataSource

Implements vtkPolyDataSourceWidget.

virtual void vtkImplicitPlaneWidget::SizeHandles ( )
virtual

Control widget appearance

Reimplemented from vtk3DWidget.

virtual vtkProperty* vtkImplicitPlaneWidget::GetNormalProperty ( )
virtual

Get the properties on the normal (line and cone).

virtual vtkProperty* vtkImplicitPlaneWidget::GetSelectedNormalProperty ( )
virtual

Get the properties on the normal (line and cone).

virtual vtkProperty* vtkImplicitPlaneWidget::GetPlaneProperty ( )
virtual

Get the plane properties. The properties of the plane when selected and unselected can be manipulated.

virtual vtkProperty* vtkImplicitPlaneWidget::GetSelectedPlaneProperty ( )
virtual

Get the plane properties. The properties of the plane when selected and unselected can be manipulated.

virtual vtkProperty* vtkImplicitPlaneWidget::GetOutlineProperty ( )
virtual

Get the property of the outline.

virtual vtkProperty* vtkImplicitPlaneWidget::GetSelectedOutlineProperty ( )
virtual

Get the property of the outline.

virtual vtkProperty* vtkImplicitPlaneWidget::GetEdgesProperty ( )
virtual

Get the property of the intersection edges. (This property also applies to the edges when tubed.)

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

Handles the char widget activation event. Also handles the delete event.

Reimplemented from vtkInteractorObserver.

void vtkImplicitPlaneWidget::OnLeftButtonDown ( )
protected
void vtkImplicitPlaneWidget::OnLeftButtonUp ( )
protected
void vtkImplicitPlaneWidget::OnMiddleButtonDown ( )
protected
void vtkImplicitPlaneWidget::OnMiddleButtonUp ( )
protected
void vtkImplicitPlaneWidget::OnRightButtonDown ( )
protected
void vtkImplicitPlaneWidget::OnRightButtonUp ( )
protected
void vtkImplicitPlaneWidget::OnMouseMove ( )
protected
void vtkImplicitPlaneWidget::UpdateRepresentation ( )
protected
void vtkImplicitPlaneWidget::HighlightOutline ( int  highlight)
protected
virtual void vtkImplicitPlaneWidget::HighlightPlane ( int  highlight)
protectedvirtual
void vtkImplicitPlaneWidget::HighlightNormal ( int  highlight)
protected
void vtkImplicitPlaneWidget::ConstrainOrigin ( double  x[3])
protected
void vtkImplicitPlaneWidget::Rotate ( int  X,
int  Y,
double *  p1,
double *  p2,
double *  vpn 
)
protected
void vtkImplicitPlaneWidget::TranslatePlane ( double *  p1,
double *  p2 
)
protected
void vtkImplicitPlaneWidget::TranslateOutline ( double *  p1,
double *  p2 
)
protected
void vtkImplicitPlaneWidget::TranslateOrigin ( double *  p1,
double *  p2 
)
protected
void vtkImplicitPlaneWidget::Push ( double *  p1,
double *  p2 
)
protected
void vtkImplicitPlaneWidget::Scale ( double *  p1,
double *  p2,
int  X,
int  Y 
)
protected
void vtkImplicitPlaneWidget::CreateDefaultProperties ( )
protected
void vtkImplicitPlaneWidget::GeneratePlane ( )
protected

Member Data Documentation

int vtkImplicitPlaneWidget::State
protected

Definition at line 257 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::NormalToXAxis
protected

Definition at line 285 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::NormalToYAxis
protected

Definition at line 286 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::NormalToZAxis
protected

Definition at line 287 of file vtkImplicitPlaneWidget.h.

vtkPlane* vtkImplicitPlaneWidget::Plane
protected

Definition at line 291 of file vtkImplicitPlaneWidget.h.

vtkImageData* vtkImplicitPlaneWidget::Box
protected

Definition at line 294 of file vtkImplicitPlaneWidget.h.

vtkOutlineFilter* vtkImplicitPlaneWidget::Outline
protected

Definition at line 295 of file vtkImplicitPlaneWidget.h.

vtkPolyDataMapper* vtkImplicitPlaneWidget::OutlineMapper
protected

Definition at line 296 of file vtkImplicitPlaneWidget.h.

vtkActor* vtkImplicitPlaneWidget::OutlineActor
protected

Definition at line 297 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::OutlineTranslation
protected

Definition at line 299 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::ScaleEnabled
protected

Definition at line 300 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::OutsideBounds
protected

Definition at line 301 of file vtkImplicitPlaneWidget.h.

vtkCutter* vtkImplicitPlaneWidget::Cutter
protected

Definition at line 304 of file vtkImplicitPlaneWidget.h.

vtkPolyDataMapper* vtkImplicitPlaneWidget::CutMapper
protected

Definition at line 305 of file vtkImplicitPlaneWidget.h.

vtkActor* vtkImplicitPlaneWidget::CutActor
protected

Definition at line 306 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::DrawPlane
protected

Definition at line 307 of file vtkImplicitPlaneWidget.h.

vtkFeatureEdges* vtkImplicitPlaneWidget::Edges
protected

Definition at line 311 of file vtkImplicitPlaneWidget.h.

vtkTubeFilter* vtkImplicitPlaneWidget::EdgesTuber
protected

Definition at line 312 of file vtkImplicitPlaneWidget.h.

vtkPolyDataMapper* vtkImplicitPlaneWidget::EdgesMapper
protected

Definition at line 313 of file vtkImplicitPlaneWidget.h.

vtkActor* vtkImplicitPlaneWidget::EdgesActor
protected

Definition at line 314 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::Tubing
protected

Definition at line 315 of file vtkImplicitPlaneWidget.h.

double vtkImplicitPlaneWidget::DiagonalRatio
protected

Definition at line 318 of file vtkImplicitPlaneWidget.h.

vtkConeSource* vtkImplicitPlaneWidget::ConeSource
protected

Definition at line 321 of file vtkImplicitPlaneWidget.h.

vtkPolyDataMapper* vtkImplicitPlaneWidget::ConeMapper
protected

Definition at line 322 of file vtkImplicitPlaneWidget.h.

vtkActor* vtkImplicitPlaneWidget::ConeActor
protected

Definition at line 323 of file vtkImplicitPlaneWidget.h.

vtkLineSource* vtkImplicitPlaneWidget::LineSource
protected

Definition at line 327 of file vtkImplicitPlaneWidget.h.

vtkPolyDataMapper* vtkImplicitPlaneWidget::LineMapper
protected

Definition at line 328 of file vtkImplicitPlaneWidget.h.

vtkActor* vtkImplicitPlaneWidget::LineActor
protected

Definition at line 329 of file vtkImplicitPlaneWidget.h.

vtkConeSource* vtkImplicitPlaneWidget::ConeSource2
protected

Definition at line 332 of file vtkImplicitPlaneWidget.h.

vtkPolyDataMapper* vtkImplicitPlaneWidget::ConeMapper2
protected

Definition at line 333 of file vtkImplicitPlaneWidget.h.

vtkActor* vtkImplicitPlaneWidget::ConeActor2
protected

Definition at line 334 of file vtkImplicitPlaneWidget.h.

vtkLineSource* vtkImplicitPlaneWidget::LineSource2
protected

Definition at line 337 of file vtkImplicitPlaneWidget.h.

vtkPolyDataMapper* vtkImplicitPlaneWidget::LineMapper2
protected

Definition at line 338 of file vtkImplicitPlaneWidget.h.

vtkActor* vtkImplicitPlaneWidget::LineActor2
protected

Definition at line 339 of file vtkImplicitPlaneWidget.h.

vtkSphereSource* vtkImplicitPlaneWidget::Sphere
protected

Definition at line 342 of file vtkImplicitPlaneWidget.h.

vtkPolyDataMapper* vtkImplicitPlaneWidget::SphereMapper
protected

Definition at line 343 of file vtkImplicitPlaneWidget.h.

vtkActor* vtkImplicitPlaneWidget::SphereActor
protected

Definition at line 344 of file vtkImplicitPlaneWidget.h.

int vtkImplicitPlaneWidget::OriginTranslation
protected

Definition at line 345 of file vtkImplicitPlaneWidget.h.

vtkCellPicker* vtkImplicitPlaneWidget::Picker
protected

Definition at line 348 of file vtkImplicitPlaneWidget.h.

vtkTransform* vtkImplicitPlaneWidget::Transform
protected

Definition at line 351 of file vtkImplicitPlaneWidget.h.

vtkProperty* vtkImplicitPlaneWidget::NormalProperty
protected

Definition at line 364 of file vtkImplicitPlaneWidget.h.

vtkProperty* vtkImplicitPlaneWidget::SelectedNormalProperty
protected

Definition at line 365 of file vtkImplicitPlaneWidget.h.

vtkProperty* vtkImplicitPlaneWidget::PlaneProperty
protected

Definition at line 366 of file vtkImplicitPlaneWidget.h.

vtkProperty* vtkImplicitPlaneWidget::SelectedPlaneProperty
protected

Definition at line 367 of file vtkImplicitPlaneWidget.h.

vtkProperty* vtkImplicitPlaneWidget::OutlineProperty
protected

Definition at line 368 of file vtkImplicitPlaneWidget.h.

vtkProperty* vtkImplicitPlaneWidget::SelectedOutlineProperty
protected

Definition at line 369 of file vtkImplicitPlaneWidget.h.

vtkProperty* vtkImplicitPlaneWidget::EdgesProperty
protected

Definition at line 370 of file vtkImplicitPlaneWidget.h.


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