You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
201 lines
7.5 KiB
C++
201 lines
7.5 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkBoxWidget2.h
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notice for more information.
|
|
|
|
=========================================================================*/
|
|
/**
|
|
* @class vtkBoxWidget2
|
|
* @brief 3D widget for manipulating a box
|
|
*
|
|
* This 3D widget interacts with a vtkBoxRepresentation class (i.e., it
|
|
* handles the events that drive its corresponding representation). The
|
|
* representation is assumed to represent a region of interest that is
|
|
* represented by an arbitrarily oriented hexahedron (or box) with interior
|
|
* face angles of 90 degrees (i.e., orthogonal faces). The representation
|
|
* manifests seven handles that can be moused on and manipulated, plus the
|
|
* six faces can also be interacted with. The first six handles are placed on
|
|
* the six faces, the seventh is in the center of the box. In addition, a
|
|
* bounding box outline is shown, the "faces" of which can be selected for
|
|
* object rotation or scaling. A nice feature of vtkBoxWidget2, like any 3D
|
|
* widget, will work with the current interactor style. That is, if
|
|
* vtkBoxWidget2 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 widget, you generally pair it with a vtkBoxRepresentation
|
|
* (or a subclass). Various options are available in the representation for
|
|
* controlling how the widget appears, and how the widget functions.
|
|
*
|
|
* @par Event Bindings:
|
|
* By default, the widget responds to the following VTK events (i.e., it
|
|
* watches the vtkRenderWindowInteractor for these events):
|
|
* <pre>
|
|
* If one of the seven handles are selected:
|
|
* LeftButtonPressEvent - select the appropriate handle
|
|
* LeftButtonReleaseEvent - release the currently selected handle
|
|
* MouseMoveEvent - move the handle
|
|
* If one of the faces is selected:
|
|
* LeftButtonPressEvent - select a box face
|
|
* LeftButtonReleaseEvent - release the box face
|
|
* MouseMoveEvent - rotate the box
|
|
* In all the cases, independent of what is picked, the widget responds to the
|
|
* following VTK events:
|
|
* MiddleButtonPressEvent - translate the widget
|
|
* MiddleButtonReleaseEvent - release the widget
|
|
* RightButtonPressEvent - scale the widget's representation
|
|
* RightButtonReleaseEvent - stop scaling the widget
|
|
* MouseMoveEvent - scale (if right button) or move (if middle button) the widget
|
|
* </pre>
|
|
*
|
|
* @par Event Bindings:
|
|
* Note that the event bindings described above can be changed using this
|
|
* class's vtkWidgetEventTranslator. This class translates VTK events
|
|
* into the vtkBoxWidget2's widget events:
|
|
* <pre>
|
|
* vtkWidgetEvent::Select -- some part of the widget has been selected
|
|
* vtkWidgetEvent::EndSelect -- the selection process has completed
|
|
* vtkWidgetEvent::Scale -- some part of the widget has been selected
|
|
* vtkWidgetEvent::EndScale -- the selection process has completed
|
|
* vtkWidgetEvent::Translate -- some part of the widget has been selected
|
|
* vtkWidgetEvent::EndTranslate -- the selection process has completed
|
|
* vtkWidgetEvent::Move -- a request for motion has been invoked
|
|
* </pre>
|
|
*
|
|
* @par Event Bindings:
|
|
* In turn, when these widget events are processed, the vtkBoxWidget2
|
|
* invokes the following VTK events on itself (which observers can listen for):
|
|
* <pre>
|
|
* vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
|
|
* vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
|
|
* vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
|
|
* </pre>
|
|
*
|
|
*
|
|
* @par Event Bindings:
|
|
* This class, and the affiliated vtkBoxRepresentation, are second generation
|
|
* VTK widgets. An earlier version of this functionality was defined in the
|
|
* class vtkBoxWidget.
|
|
*
|
|
* @sa
|
|
* vtkBoxRepresentation vtkBoxWidget
|
|
*/
|
|
|
|
#ifndef vtkBoxWidget2_h
|
|
#define vtkBoxWidget2_h
|
|
|
|
#include "vtkAbstractWidget.h"
|
|
#include "vtkInteractionWidgetsModule.h" // For export macro
|
|
|
|
class vtkBoxRepresentation;
|
|
class vtkHandleWidget;
|
|
|
|
class VTKINTERACTIONWIDGETS_EXPORT vtkBoxWidget2 : public vtkAbstractWidget
|
|
{
|
|
public:
|
|
/**
|
|
* Instantiate the object.
|
|
*/
|
|
static vtkBoxWidget2* New();
|
|
|
|
//@{
|
|
/**
|
|
* Standard class methods for type information and printing.
|
|
*/
|
|
vtkTypeMacro(vtkBoxWidget2, vtkAbstractWidget);
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
|
//@}
|
|
|
|
/**
|
|
* Specify an instance of vtkWidgetRepresentation used to represent this
|
|
* widget in the scene. Note that the representation is a subclass of vtkProp
|
|
* so it can be added to the renderer independent of the widget.
|
|
*/
|
|
void SetRepresentation(vtkBoxRepresentation* r)
|
|
{
|
|
this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
|
|
}
|
|
|
|
//@{
|
|
/**
|
|
* Control the behavior of the widget (i.e., how it processes
|
|
* events). Translation, rotation, scaling and face movement can all be enabled and
|
|
* disabled. Scaling refers to scaling of the whole widget at once,
|
|
* (default is through right mouse button) while face movement refers to
|
|
* scaling of the widget one face (axis) at a time (default through grabbing
|
|
* one of the representation spherical handles).
|
|
*/
|
|
vtkSetMacro(TranslationEnabled, vtkTypeBool);
|
|
vtkGetMacro(TranslationEnabled, vtkTypeBool);
|
|
vtkBooleanMacro(TranslationEnabled, vtkTypeBool);
|
|
vtkSetMacro(ScalingEnabled, vtkTypeBool);
|
|
vtkGetMacro(ScalingEnabled, vtkTypeBool);
|
|
vtkBooleanMacro(ScalingEnabled, vtkTypeBool);
|
|
vtkSetMacro(RotationEnabled, vtkTypeBool);
|
|
vtkGetMacro(RotationEnabled, vtkTypeBool);
|
|
vtkBooleanMacro(RotationEnabled, vtkTypeBool);
|
|
vtkSetMacro(MoveFacesEnabled, vtkTypeBool);
|
|
vtkGetMacro(MoveFacesEnabled, vtkTypeBool);
|
|
vtkBooleanMacro(MoveFacesEnabled, vtkTypeBool);
|
|
//@}
|
|
|
|
/**
|
|
* Create the default widget representation if one is not set. By default,
|
|
* this is an instance of the vtkBoxRepresentation class.
|
|
*/
|
|
void CreateDefaultRepresentation() override;
|
|
|
|
/**
|
|
* Override superclasses' SetEnabled() method because the line
|
|
* widget must enable its internal handle widgets.
|
|
*/
|
|
void SetEnabled(int enabling) override;
|
|
|
|
protected:
|
|
vtkBoxWidget2();
|
|
~vtkBoxWidget2() override;
|
|
|
|
// Manage the state of the widget
|
|
int WidgetState;
|
|
enum _WidgetState
|
|
{
|
|
Start = 0,
|
|
Active
|
|
};
|
|
|
|
// These methods handle events
|
|
static void SelectAction(vtkAbstractWidget*);
|
|
static void EndSelectAction(vtkAbstractWidget*);
|
|
static void TranslateAction(vtkAbstractWidget*);
|
|
static void ScaleAction(vtkAbstractWidget*);
|
|
static void MoveAction(vtkAbstractWidget*);
|
|
static void SelectAction3D(vtkAbstractWidget*);
|
|
static void EndSelectAction3D(vtkAbstractWidget*);
|
|
static void MoveAction3D(vtkAbstractWidget*);
|
|
static void StepAction3D(vtkAbstractWidget*);
|
|
|
|
// Control whether scaling, rotation, and translation are supported
|
|
vtkTypeBool TranslationEnabled;
|
|
vtkTypeBool ScalingEnabled;
|
|
vtkTypeBool RotationEnabled;
|
|
vtkTypeBool MoveFacesEnabled;
|
|
|
|
vtkCallbackCommand* KeyEventCallbackCommand;
|
|
static void ProcessKeyEvents(vtkObject*, unsigned long, void*, void*);
|
|
|
|
private:
|
|
vtkBoxWidget2(const vtkBoxWidget2&) = delete;
|
|
void operator=(const vtkBoxWidget2&) = delete;
|
|
};
|
|
|
|
#endif
|