|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More...
|
|
vtkBoxWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
void | SetEnabled (int) override |
| Methods that satisfy the superclass' API. More...
|
|
void | PlaceWidget (double bounds[6]) override |
| This method is used to initially place the widget. More...
|
|
void | PlaceWidget () override |
|
void | PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override |
|
void | GetPlanes (vtkPlanes *planes) |
| Get the planes describing the implicit function defined by the box widget. More...
|
|
virtual void | SetInsideOut (vtkTypeBool) |
| Set/Get the InsideOut flag. More...
|
|
virtual vtkTypeBool | GetInsideOut () |
|
virtual void | InsideOutOn () |
|
virtual void | InsideOutOff () |
|
virtual void | GetTransform (vtkTransform *t) |
| Retrieve a linear transform characterizing the transformation of the box. More...
|
|
virtual void | SetTransform (vtkTransform *t) |
| Set the position, scale and orientation of the box widget using the transform specified. More...
|
|
void | GetPolyData (vtkPolyData *pd) |
| Grab the polydata (including points) that define the box widget. More...
|
|
virtual vtkProperty * | GetHandleProperty () |
| Get the handle properties (the little balls are the handles). More...
|
|
virtual vtkProperty * | GetSelectedHandleProperty () |
|
void | HandlesOn () |
| Switches handles (the spheres) on or off by manipulating the actor visibility. More...
|
|
void | HandlesOff () |
|
virtual vtkProperty * | GetFaceProperty () |
| Get the face properties (the faces of the box). More...
|
|
virtual vtkProperty * | GetSelectedFaceProperty () |
|
virtual vtkProperty * | GetOutlineProperty () |
| Get the outline properties (the outline of the box). More...
|
|
virtual vtkProperty * | GetSelectedOutlineProperty () |
|
void | SetOutlineFaceWires (int) |
| Control the representation of the outline. More...
|
|
virtual int | GetOutlineFaceWires () |
|
void | OutlineFaceWiresOn () |
|
void | OutlineFaceWiresOff () |
|
void | SetOutlineCursorWires (int) |
| Control the representation of the outline. More...
|
|
virtual int | GetOutlineCursorWires () |
|
void | OutlineCursorWiresOn () |
|
void | OutlineCursorWiresOff () |
|
virtual void | SetTranslationEnabled (vtkTypeBool) |
| Control the behavior of the widget. More...
|
|
virtual vtkTypeBool | GetTranslationEnabled () |
|
virtual void | TranslationEnabledOn () |
|
virtual void | TranslationEnabledOff () |
|
virtual void | SetScalingEnabled (vtkTypeBool) |
|
virtual vtkTypeBool | GetScalingEnabled () |
|
virtual void | ScalingEnabledOn () |
|
virtual void | ScalingEnabledOff () |
|
virtual void | SetRotationEnabled (vtkTypeBool) |
|
virtual vtkTypeBool | GetRotationEnabled () |
|
virtual void | RotationEnabledOn () |
|
virtual void | RotationEnabledOff () |
|
vtk3DWidget * | NewInstance () const |
|
virtual void | SetProp3D (vtkProp3D *) |
| Specify a vtkProp3D around which to place the widget. More...
|
|
virtual vtkProp3D * | GetProp3D () |
|
virtual void | SetInputData (vtkDataSet *) |
| Specify the input dataset. More...
|
|
virtual void | SetInputConnection (vtkAlgorithmOutput *) |
|
virtual vtkDataSet * | GetInput () |
|
virtual void | SetPlaceFactor (double) |
| Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
|
|
virtual double | GetPlaceFactor () |
|
virtual void | SetHandleSize (double) |
| Set/Get the factor that controls the size of the handles that appear as part of the widget. More...
|
|
virtual double | GetHandleSize () |
|
vtkInteractorObserver * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
int | GetEnabled () |
|
void | EnabledOn () |
|
void | EnabledOff () |
|
void | On () |
|
void | Off () |
|
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
| This method is used to associate the widget with the render window interactor. More...
|
|
virtual vtkRenderWindowInteractor * | GetInteractor () |
|
virtual void | SetPriority (float) |
| Set/Get the priority at which events are processed. More...
|
|
virtual float | GetPriority () |
|
virtual void | PickingManagedOn () |
| Enable/Disable the use of a manager to process the picking. More...
|
|
virtual void | PickingManagedOff () |
|
virtual void | SetPickingManaged (bool managed) |
|
virtual bool | GetPickingManaged () |
|
virtual void | SetKeyPressActivation (vtkTypeBool) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
|
|
virtual vtkTypeBool | GetKeyPressActivation () |
|
virtual void | KeyPressActivationOn () |
|
virtual void | KeyPressActivationOff () |
|
virtual void | SetKeyPressActivationValue (char) |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
|
|
virtual char | GetKeyPressActivationValue () |
|
virtual vtkRenderer * | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer. More...
|
|
virtual void | SetDefaultRenderer (vtkRenderer *) |
|
virtual vtkRenderer * | GetCurrentRenderer () |
| Set/Get the current renderer. More...
|
|
virtual void | SetCurrentRenderer (vtkRenderer *) |
|
virtual void | OnChar () |
| Sets up the keypress-i event. More...
|
|
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
|
|
void | ReleaseFocus () |
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
| Turn debugging output on. More...
|
|
virtual void | DebugOff () |
| Turn debugging output off. More...
|
|
bool | GetDebug () |
| Get the value of the debug flag. More...
|
|
void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More...
|
|
virtual void | Modified () |
| Update the modification time for this object. More...
|
|
virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More...
|
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
|
vtkCommand * | GetCommand (unsigned long tag) |
|
void | RemoveObserver (vtkCommand *) |
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
|
void | RemoveObservers (const char *event, vtkCommand *) |
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
|
void | RemoveObserver (unsigned long tag) |
|
void | RemoveObservers (unsigned long event) |
|
void | RemoveObservers (const char *event) |
|
void | RemoveAllObservers () |
|
vtkTypeBool | HasObserver (unsigned long event) |
|
vtkTypeBool | HasObserver (const char *event) |
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More...
|
|
int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More...
|
|
int | InvokeEvent (const char *event, void *callData) |
|
int | InvokeEvent (unsigned long event) |
|
int | InvokeEvent (const char *event) |
|
const char * | GetClassName () const |
| Return the class name as a string. More...
|
|
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
|
|
virtual void | Delete () |
| Delete a VTK object. More...
|
|
virtual void | FastDelete () |
| Delete a reference to this object. More...
|
|
void | InitializeObjectBase () |
|
void | Print (ostream &os) |
| Print an object to an ostream. More...
|
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
|
virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More...
|
|
virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More...
|
|
int | GetReferenceCount () |
| Return the current reference count of this object. More...
|
|
void | SetReferenceCount (int) |
| Sets the reference count. More...
|
|
bool | GetIsInMemkind () const |
| A local state flag that remembers whether this object lives in the normal or extended memory space. More...
|
|
|
static vtkBoxWidget * | New () |
| Instantiate the object. More...
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkBoxWidget * | SafeDownCast (vtkObjectBase *o) |
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtk3DWidget * | SafeDownCast (vtkObjectBase *o) |
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkInteractorObserver * | SafeDownCast (vtkObjectBase *o) |
|
static void | ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4]) |
| Convenience methods for outside classes. More...
|
|
static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
|
static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
|
|
static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More...
|
|
static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
|
static void | GlobalWarningDisplayOn () |
|
static void | GlobalWarningDisplayOff () |
|
static int | GetGlobalWarningDisplay () |
|
static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More...
|
|
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
| Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
|
|
static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
|
|
static void | SetMemkindDirectory (const char *directoryname) |
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
|
|
static bool | GetUsingMemkind () |
| A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
|
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkBoxWidget () |
|
| ~vtkBoxWidget () override |
|
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 () |
|
void | SizeHandles () override |
|
void | RegisterPickers () override |
| Register internal Pickers in the Picking Manager. More...
|
|
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 () |
|
| vtk3DWidget () |
|
| ~vtk3DWidget () override |
|
void | AdjustBounds (double bounds[6], double newBounds[6], double center[3]) |
|
double | SizeHandles (double factor) |
|
void | UpdateInput () |
|
| vtkInteractorObserver () |
|
| ~vtkInteractorObserver () override |
|
virtual void | StartInteraction () |
| Utility routines used to start and end interaction. More...
|
|
virtual void | EndInteraction () |
|
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
| Helper method for subclasses. More...
|
|
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
|
void | UnRegisterPickers () |
| Unregister internal pickers from the Picking Manager. More...
|
|
vtkPickingManager * | GetPickingManager () |
| Return the picking manager associated on the context on which the observer currently belong. More...
|
|
vtkAssemblyPath * | GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker) |
| Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
|
|
int | RequestCursorShape (int requestedShape) |
|
| vtkObject () |
|
| ~vtkObject () override |
|
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
|
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
|
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More...
|
|
void | InternalReleaseFocus () |
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
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.
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::EnableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
- Examples:
- vtkBoxWidget (Examples)
- Tests:
- vtkBoxWidget (Tests)
Definition at line 101 of file vtkBoxWidget.h.