
 Usage

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.
To create an instance of class vtkBoxWidget, simply invoke
its constructor as follows

    obj = vtkBoxWidget



 Methods

The class vtkBoxWidget has several methods that can be used.
They are listed below. Note that the documentation is
translated automatically from the VTK sources, and may not
be completely intelligible. When in doubt, consult the VTK
website. In the methods listed below, obj is an instance of
the vtkBoxWidget class.

* string = obj.GetClassName ()
* int = obj.IsA (string name)
* vtkBoxWidget = obj.NewInstance ()
* vtkBoxWidget = obj.SafeDownCast (vtkObject o)
* obj.SetEnabled (int ) - Methods that satisfy the
  superclass' API.
* obj.PlaceWidget (double bounds[6]) - Methods that satisfy
  the superclass' API.
* obj.PlaceWidget () - Methods that satisfy the superclass'
  API.
* obj.PlaceWidget (double xmin, double xmax, double ymin,
  double ymax, double zmin, double zmax) - 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.)
* obj.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.)
* obj.SetInsideOut (int ) - 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.
* int = obj.GetInsideOut () - 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.
* obj.InsideOutOn () - 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.
* obj.InsideOutOff () - 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.
* obj.GetTransform (vtkTransform t) - 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).
* obj.SetTransform (vtkTransform t) - 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).
* obj.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.
* vtkProperty = obj.GetHandleProperty () - Get the handle
  properties (the little balls are the handles). The
  properties of the handles when selected and normal can be
  set.
* vtkProperty = obj.GetSelectedHandleProperty () - Get the
  handle properties (the little balls are the handles). The
  properties of the handles when selected and normal can be
  set.
* obj.HandlesOn () - Switches handles (the spheres) on or
  off by manipulating the actor visibility.
* obj.HandlesOff () - Switches handles (the spheres) on or
  off by manipulating the actor visibility.
* vtkProperty = obj.GetFaceProperty () - Get the face
  properties (the faces of the box). The properties of the
  face when selected and normal can be set.
* vtkProperty = obj.GetSelectedFaceProperty () - Get the
  face properties (the faces of the box). The properties of
  the face when selected and normal can be set.
* vtkProperty = obj.GetOutlineProperty () - Get the outline
  properties (the outline of the box). The properties of the
  outline when selected and normal can be set.
* vtkProperty = obj.GetSelectedOutlineProperty () - Get the
  outline properties (the outline of the box). The
  properties of the outline when selected and normal can be
  set.
* obj.SetOutlineFaceWires (int ) - Control the
  representation of the outline. This flag enables face
  wires. By default face wires are off.
* int = obj.GetOutlineFaceWires () - Control the
  representation of the outline. This flag enables face
  wires. By default face wires are off.
* obj.OutlineFaceWiresOn () - Control the representation of
  the outline. This flag enables face wires. By default face
  wires are off.
* obj.OutlineFaceWiresOff () - Control the representation of
  the outline. This flag enables the cursor lines running
  between the handles. By default cursor wires are on.
* obj.SetOutlineCursorWires (int ) - Control the
  representation of the outline. This flag enables the
  cursor lines running between the handles. By default
  cursor wires are on.
* int = obj.GetOutlineCursorWires () - Control the
  representation of the outline. This flag enables the
  cursor lines running between the handles. By default
  cursor wires are on.
* obj.OutlineCursorWiresOn () - Control the representation
  of the outline. This flag enables the cursor lines running
  between the handles. By default cursor wires are on.
* obj.OutlineCursorWiresOff () - Control the behavior of the
  widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* obj.SetTranslationEnabled (int ) - Control the behavior of
  the widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* int = obj.GetTranslationEnabled () - Control the behavior
  of the widget. Translation, rotation, and scaling can all
  be enabled and disabled.
* obj.TranslationEnabledOn () - Control the behavior of the
  widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* obj.TranslationEnabledOff () - Control the behavior of the
  widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* obj.SetScalingEnabled (int ) - Control the behavior of the
  widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* int = obj.GetScalingEnabled () - Control the behavior of
  the widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* obj.ScalingEnabledOn () - Control the behavior of the
  widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* obj.ScalingEnabledOff () - Control the behavior of the
  widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* obj.SetRotationEnabled (int ) - Control the behavior of
  the widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* int = obj.GetRotationEnabled () - Control the behavior of
  the widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* obj.RotationEnabledOn () - Control the behavior of the
  widget. Translation, rotation, and scaling can all be
  enabled and disabled.
* obj.RotationEnabledOff () - Control the behavior of the
  widget. Translation, rotation, and scaling can all be
  enabled and disabled.


* FreeMat_Documentation
* Visualization_Toolkit_Widget_Classes
* Generated on Thu Jul 25 2013 17:18:36 for FreeMat by
  doxygen_ 1.8.1.1

