vtkBoxWidget Class Reference

#include <vtkBoxWidget.h>

Inheritance diagram for vtkBoxWidget:

Inheritance graph
[legend]
Collaboration diagram for vtkBoxWidget:

Collaboration graph
[legend]

List of all members.


Detailed Description

orthogonal hexahedron 3D widget

This 3D widget defines a region of interest that is represented by an arbitrarily oriented hexahedron with interior face angles of 90 degrees (orthogonal faces). The object creates 7 handles that can be moused on and manipulated. The first six correspond to the six faces, the seventh is in the center of the hexahedron. In addition, a bounding box outline is shown, the "faces" of which can be selected for object rotation or scaling. A nice feature of the object is that the vtkBoxWidget, like any 3D widget, will work with the current interactor style. That is, if vtkBoxWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkBoxWidget 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 vtkBoxWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing the six face handles (use the left mouse button), faces can be moved. By grabbing the center handle (with the left mouse button), the entire hexahedron can be translated. (Translation can also be employed by using the "shift-left-mouse-button" combination inside of the widget.) 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 rotate vtkBoxWidget, pick a face (but not a face handle) and move the left mouse. (Note: the mouse button must be held down during manipulation.) 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. (See the superclass documentation on key press activiation.)

The vtkBoxWidget is very flexible. It can be used to select, cut, clip, or perform any other operation that depends on an implicit function (use the GetPlanes() method); or it can be used to transform objects using a linear transformation (use the GetTransform() method). 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).

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 for the handles, faces, and outline in their normal and selected states.

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

The box widget can be oriented by specifying a transformation matrix. This transformation is applied to the initial bounding box as defined by the PlaceWidget() method. DO NOT ASSUME that the transformation is applied to a unit box centered at the origin; this is wrong!

See also:
vtk3DWidget vtkPointWidget vtkLineWidget vtkPlaneWidget vtkImplicitPlaneWidget vtkImagePlaneWidget
Events:
vtkCommand::DisableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EnableEvent
Tests:
vtkBoxWidget (Tests)

Definition at line 101 of file vtkBoxWidget.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 GetPlanes (vtkPlanes *planes)
virtual void GetTransform (vtkTransform *t)
virtual void SetTransform (vtkTransform *t)
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)
virtual void SetInsideOut (int)
virtual int GetInsideOut ()
virtual void InsideOutOn ()
virtual void InsideOutOff ()
virtual vtkPropertyGetHandleProperty ()
virtual vtkPropertyGetSelectedHandleProperty ()
void HandlesOn ()
void HandlesOff ()
virtual vtkPropertyGetFaceProperty ()
virtual vtkPropertyGetSelectedFaceProperty ()
virtual vtkPropertyGetOutlineProperty ()
virtual vtkPropertyGetSelectedOutlineProperty ()
void SetOutlineFaceWires (int)
virtual int GetOutlineFaceWires ()
void OutlineFaceWiresOn ()
void OutlineFaceWiresOff ()
void SetOutlineCursorWires (int)
virtual int GetOutlineCursorWires ()
void OutlineCursorWiresOn ()
void OutlineCursorWiresOff ()
virtual void SetTranslationEnabled (int)
virtual int GetTranslationEnabled ()
virtual void TranslationEnabledOn ()
virtual void TranslationEnabledOff ()
virtual void SetScalingEnabled (int)
virtual int GetScalingEnabled ()
virtual void ScalingEnabledOn ()
virtual void ScalingEnabledOff ()
virtual void SetRotationEnabled (int)
virtual int GetRotationEnabled ()
virtual void RotationEnabledOn ()
virtual void RotationEnabledOff ()

Static Public Member Functions

static vtkBoxWidgetNew ()
static int IsTypeOf (const char *type)
static vtkBoxWidgetSafeDownCast (vtkObject *o)

Protected Types

enum  WidgetState { Start = 0, Moving, Scaling, Outside }

Protected Member Functions

 vtkBoxWidget ()
 ~vtkBoxWidget ()
virtual void OnMouseMove ()
virtual void OnLeftButtonDown ()
virtual void OnLeftButtonUp ()
virtual void OnMiddleButtonDown ()
virtual void OnMiddleButtonUp ()
virtual void OnRightButtonDown ()
virtual void OnRightButtonUp ()
virtual void PositionHandles ()
int HighlightHandle (vtkProp *prop)
void HighlightFace (int cellId)
void HighlightOutline (int highlight)
void ComputeNormals ()
virtual void SizeHandles ()
virtual void Translate (double *p1, double *p2)
virtual void Scale (double *p1, double *p2, int X, int Y)
virtual void Rotate (int X, int Y, double *p1, double *p2, double *vpn)
void MovePlusXFace (double *p1, double *p2)
void MoveMinusXFace (double *p1, double *p2)
void MovePlusYFace (double *p1, double *p2)
void MoveMinusYFace (double *p1, double *p2)
void MovePlusZFace (double *p1, double *p2)
void MoveMinusZFace (double *p1, double *p2)
void MoveFace (double *p1, double *p2, double *dir, double *x1, double *x2, double *x3, double *x4, double *x5)
void GetDirection (const double Nx[3], const double Ny[3], const double Nz[3], double dir[3])
void CreateDefaultProperties ()
void GenerateOutline ()

Static Protected Member Functions

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

Protected Attributes

int State
vtkActorHexActor
vtkPolyDataMapperHexMapper
vtkPolyDataHexPolyData
vtkPointsPoints
double N [6][3]
vtkActorHexFace
vtkPolyDataMapperHexFaceMapper
vtkPolyDataHexFacePolyData
vtkActor ** Handle
vtkPolyDataMapper ** HandleMapper
vtkSphereSource ** HandleGeometry
vtkActorHexOutline
vtkPolyDataMapperOutlineMapper
vtkPolyDataOutlinePolyData
vtkCellPickerHandlePicker
vtkCellPickerHexPicker
vtkActorCurrentHandle
int CurrentHexFace
vtkTransformTransform
vtkPropertyHandleProperty
vtkPropertySelectedHandleProperty
vtkPropertyFaceProperty
vtkPropertySelectedFaceProperty
vtkPropertyOutlineProperty
vtkPropertySelectedOutlineProperty
int InsideOut
int OutlineFaceWires
int OutlineCursorWires
int TranslationEnabled
int ScalingEnabled
int RotationEnabled

Member Typedef Documentation

Reimplemented from vtk3DWidget.

Definition at line 107 of file vtkBoxWidget.h.


Member Enumeration Documentation

enum vtkBoxWidget::WidgetState [protected]

Enumerator:
Start 
Moving 
Scaling 
Outside 

Definition at line 228 of file vtkBoxWidget.h.


Constructor & Destructor Documentation

vtkBoxWidget::vtkBoxWidget (  )  [protected]

vtkBoxWidget::~vtkBoxWidget (  )  [protected]


Member Function Documentation

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

Instantiate the object.

Reimplemented from vtkObject.

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

Reimplemented from vtk3DWidget.

static int vtkBoxWidget::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtk3DWidget.

virtual int vtkBoxWidget::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtk3DWidget.

static vtkBoxWidget* vtkBoxWidget::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtk3DWidget.

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

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

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

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

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

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 114 of file vtkBoxWidget.h.

void vtkBoxWidget::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 116 of file vtkBoxWidget.h.

void vtkBoxWidget::GetPlanes ( vtkPlanes planes  ) 

Get the planes describing the implicit function defined by the box widget. The user must provide the instance of the class vtkPlanes. Note that vtkPlanes is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data. (The direction of the normals of the planes can be reversed enabling the InsideOut flag.)

virtual void vtkBoxWidget::SetInsideOut ( int   )  [virtual]

Set/Get the InsideOut flag. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

virtual int vtkBoxWidget::GetInsideOut (  )  [virtual]

Set/Get the InsideOut flag. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

virtual void vtkBoxWidget::InsideOutOn (  )  [virtual]

Set/Get the InsideOut flag. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

virtual void vtkBoxWidget::InsideOutOff (  )  [virtual]

Set/Get the InsideOut flag. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

virtual void vtkBoxWidget::GetTransform ( vtkTransform t  )  [virtual]

Retrieve a linear transform characterizing the transformation of the box. Note that the transformation is relative to where PlaceWidget was initially called. This method modifies the transform provided. The transform can be used to control the position of vtkProp3D's, as well as other transformation operations (e.g., vtkTranformPolyData).

virtual void vtkBoxWidget::SetTransform ( vtkTransform t  )  [virtual]

Set the position, scale and orientation of the box widget using the transform specified. Note that the transformation is relative to where PlaceWidget was initially called (i.e., the original bounding box).

void vtkBoxWidget::GetPolyData ( vtkPolyData pd  ) 

Grab the polydata (including points) that define the box widget. The polydata consists of 6 quadrilateral faces and 15 points. The first eight points define the eight corner vertices; the next six define the -x,+x, -y,+y, -z,+z face points; and the final point (the 15th out of 15 points) defines the center of the hexahedron. These point values are guaranteed to be up-to-date when either the InteractionEvent or EndInteractionEvent events are invoked. The user provides the vtkPolyData and the points and cells are added to it.

virtual vtkProperty* vtkBoxWidget::GetHandleProperty (  )  [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* vtkBoxWidget::GetSelectedHandleProperty (  )  [virtual]

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

void vtkBoxWidget::HandlesOn (  ) 

Switches handles (the spheres) on or off by manipulating the actor visibility.

void vtkBoxWidget::HandlesOff (  ) 

Switches handles (the spheres) on or off by manipulating the actor visibility.

virtual vtkProperty* vtkBoxWidget::GetFaceProperty (  )  [virtual]

Get the face properties (the faces of the box). The properties of the face when selected and normal can be set.

virtual vtkProperty* vtkBoxWidget::GetSelectedFaceProperty (  )  [virtual]

Get the face properties (the faces of the box). The properties of the face when selected and normal can be set.

virtual vtkProperty* vtkBoxWidget::GetOutlineProperty (  )  [virtual]

Get the outline properties (the outline of the box). The properties of the outline when selected and normal can be set.

virtual vtkProperty* vtkBoxWidget::GetSelectedOutlineProperty (  )  [virtual]

Get the outline properties (the outline of the box). The properties of the outline when selected and normal can be set.

void vtkBoxWidget::SetOutlineFaceWires ( int   ) 

Control the representation of the outline. This flag enables face wires. By default face wires are off.

virtual int vtkBoxWidget::GetOutlineFaceWires (  )  [virtual]

Control the representation of the outline. This flag enables face wires. By default face wires are off.

void vtkBoxWidget::OutlineFaceWiresOn (  )  [inline]

Control the representation of the outline. This flag enables face wires. By default face wires are off.

Definition at line 194 of file vtkBoxWidget.h.

void vtkBoxWidget::OutlineFaceWiresOff (  )  [inline]

Control the representation of the outline. This flag enables face wires. By default face wires are off.

Definition at line 195 of file vtkBoxWidget.h.

void vtkBoxWidget::SetOutlineCursorWires ( int   ) 

Control the representation of the outline. This flag enables the cursor lines running between the handles. By default cursor wires are on.

virtual int vtkBoxWidget::GetOutlineCursorWires (  )  [virtual]

Control the representation of the outline. This flag enables the cursor lines running between the handles. By default cursor wires are on.

void vtkBoxWidget::OutlineCursorWiresOn (  )  [inline]

Control the representation of the outline. This flag enables the cursor lines running between the handles. By default cursor wires are on.

Definition at line 204 of file vtkBoxWidget.h.

void vtkBoxWidget::OutlineCursorWiresOff (  )  [inline]

Control the representation of the outline. This flag enables the cursor lines running between the handles. By default cursor wires are on.

Definition at line 205 of file vtkBoxWidget.h.

virtual void vtkBoxWidget::SetTranslationEnabled ( int   )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual int vtkBoxWidget::GetTranslationEnabled (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual void vtkBoxWidget::TranslationEnabledOn (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual void vtkBoxWidget::TranslationEnabledOff (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual void vtkBoxWidget::SetScalingEnabled ( int   )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual int vtkBoxWidget::GetScalingEnabled (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual void vtkBoxWidget::ScalingEnabledOn (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual void vtkBoxWidget::ScalingEnabledOff (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual void vtkBoxWidget::SetRotationEnabled ( int   )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual int vtkBoxWidget::GetRotationEnabled (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual void vtkBoxWidget::RotationEnabledOn (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

virtual void vtkBoxWidget::RotationEnabledOff (  )  [virtual]

Control the behavior of the widget. Translation, rotation, and scaling can all be enabled and disabled.

static void vtkBoxWidget::ProcessEvents ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
) [static, protected]

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

Reimplemented from vtkInteractorObserver.

virtual void vtkBoxWidget::OnMouseMove (  )  [protected, virtual]

virtual void vtkBoxWidget::OnLeftButtonDown (  )  [protected, virtual]

virtual void vtkBoxWidget::OnLeftButtonUp (  )  [protected, virtual]

virtual void vtkBoxWidget::OnMiddleButtonDown (  )  [protected, virtual]

virtual void vtkBoxWidget::OnMiddleButtonUp (  )  [protected, virtual]

virtual void vtkBoxWidget::OnRightButtonDown (  )  [protected, virtual]

virtual void vtkBoxWidget::OnRightButtonUp (  )  [protected, virtual]

virtual void vtkBoxWidget::PositionHandles (  )  [protected, virtual]

int vtkBoxWidget::HighlightHandle ( vtkProp prop  )  [protected]

void vtkBoxWidget::HighlightFace ( int  cellId  )  [protected]

void vtkBoxWidget::HighlightOutline ( int  highlight  )  [protected]

void vtkBoxWidget::ComputeNormals (  )  [protected]

virtual void vtkBoxWidget::SizeHandles (  )  [protected, virtual]

Reimplemented from vtk3DWidget.

virtual void vtkBoxWidget::Translate ( double *  p1,
double *  p2 
) [protected, virtual]

virtual void vtkBoxWidget::Scale ( double *  p1,
double *  p2,
int  X,
int  Y 
) [protected, virtual]

virtual void vtkBoxWidget::Rotate ( int  X,
int  Y,
double *  p1,
double *  p2,
double *  vpn 
) [protected, virtual]

void vtkBoxWidget::MovePlusXFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxWidget::MoveMinusXFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxWidget::MovePlusYFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxWidget::MoveMinusYFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxWidget::MovePlusZFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxWidget::MoveMinusZFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxWidget::MoveFace ( double *  p1,
double *  p2,
double *  dir,
double *  x1,
double *  x2,
double *  x3,
double *  x4,
double *  x5 
) [protected]

void vtkBoxWidget::GetDirection ( const double  Nx[3],
const double  Ny[3],
const double  Nz[3],
double  dir[3] 
) [protected]

void vtkBoxWidget::CreateDefaultProperties (  )  [protected]

void vtkBoxWidget::GenerateOutline (  )  [protected]


Member Data Documentation

int vtkBoxWidget::State [protected]

Definition at line 227 of file vtkBoxWidget.h.

Definition at line 253 of file vtkBoxWidget.h.

Definition at line 254 of file vtkBoxWidget.h.

Definition at line 255 of file vtkBoxWidget.h.

Definition at line 256 of file vtkBoxWidget.h.

double vtkBoxWidget::N[6][3] [protected]

Definition at line 257 of file vtkBoxWidget.h.

Definition at line 260 of file vtkBoxWidget.h.

Definition at line 261 of file vtkBoxWidget.h.

Definition at line 262 of file vtkBoxWidget.h.

Definition at line 265 of file vtkBoxWidget.h.

Definition at line 266 of file vtkBoxWidget.h.

Definition at line 267 of file vtkBoxWidget.h.

Definition at line 276 of file vtkBoxWidget.h.

Definition at line 277 of file vtkBoxWidget.h.

Definition at line 278 of file vtkBoxWidget.h.

Definition at line 281 of file vtkBoxWidget.h.

Definition at line 282 of file vtkBoxWidget.h.

Definition at line 283 of file vtkBoxWidget.h.

Definition at line 284 of file vtkBoxWidget.h.

Definition at line 308 of file vtkBoxWidget.h.

Definition at line 312 of file vtkBoxWidget.h.

Definition at line 313 of file vtkBoxWidget.h.

Definition at line 314 of file vtkBoxWidget.h.

Definition at line 315 of file vtkBoxWidget.h.

Definition at line 316 of file vtkBoxWidget.h.

Definition at line 317 of file vtkBoxWidget.h.

int vtkBoxWidget::InsideOut [protected]

Definition at line 321 of file vtkBoxWidget.h.

Definition at line 322 of file vtkBoxWidget.h.

Definition at line 323 of file vtkBoxWidget.h.

Definition at line 327 of file vtkBoxWidget.h.

Definition at line 328 of file vtkBoxWidget.h.

Definition at line 329 of file vtkBoxWidget.h.


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

Generated on Wed Jun 3 18:54:44 2009 for VTK by  doxygen 1.5.6