|
void | SetRepresentation (vtkDisplaySizedImplicitPlaneRepresentation *rep) |
| Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
|
|
void | SetEnabled (int enabling) override |
| Methods for activating this widget.
|
|
void | SetLockNormalToCamera (int lock) |
| Observe/Unobserve the camera if the widget is locked/unlocked to update the vtkImplicitePlaneRepresentation's normal.
|
|
vtkDisplaySizedImplicitPlaneRepresentation * | GetDisplaySizedImplicitPlaneRepresentation () |
| Return the representation as a vtkDisplaySizedImplicitPlaneRepresentation.
|
|
void | CreateDefaultRepresentation () override |
| Create the default widget representation if one is not set.
|
|
void | SetEnabled (int) override |
| Methods for activating this widget.
|
|
vtkWidgetEventTranslator * | GetEventTranslator () |
| Get the event translator.
|
|
virtual void | CreateDefaultRepresentation ()=0 |
| Create the default widget representation if one is not set.
|
|
void | Render () |
| This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor.
|
|
void | SetParent (vtkAbstractWidget *parent) |
| Specifying a parent to this widget is used when creating composite widgets.
|
|
virtual vtkAbstractWidget * | GetParent () |
|
void | SetPriority (float) override |
| Override the superclass method.
|
|
virtual void | SetProcessEvents (vtkTypeBool) |
| Methods to change whether the widget responds to interaction.
|
|
virtual vtkTypeBool | GetProcessEvents () |
| Methods to change whether the widget responds to interaction.
|
|
virtual void | ProcessEventsOn () |
| Methods to change whether the widget responds to interaction.
|
|
virtual void | ProcessEventsOff () |
| Methods to change whether the widget responds to interaction.
|
|
vtkWidgetRepresentation * | GetRepresentation () |
| Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.
|
|
virtual void | SetManagesCursor (vtkTypeBool) |
| Turn on or off the management of the cursor.
|
|
virtual vtkTypeBool | GetManagesCursor () |
| Turn on or off the management of the cursor.
|
|
virtual void | ManagesCursorOn () |
| Turn on or off the management of the cursor.
|
|
virtual void | ManagesCursorOff () |
| Turn on or off the management of the cursor.
|
|
vtkAbstractWidget * | NewInstance () const |
| Standard macros implementing standard VTK methods.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkInteractorObserver * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | SetEnabled (int) |
| Methods for turning the interactor observer on and off, and determining its state.
|
|
int | GetEnabled () |
|
void | EnabledOn () |
|
void | EnabledOff () |
|
void | On () |
|
void | Off () |
|
virtual void | OnChar () |
| Sets up the keypress-i event.
|
|
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
| This method is used to associate the widget with the render window interactor.
|
|
virtual vtkRenderWindowInteractor * | GetInteractor () |
| This method is used to associate the widget with the render window interactor.
|
|
virtual float | GetPriority () |
| Set/Get the priority at which events are processed.
|
|
virtual void | PickingManagedOn () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | PickingManagedOff () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | SetPickingManaged (bool managed) |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual bool | GetPickingManaged () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | SetKeyPressActivation (vtkTypeBool) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual vtkTypeBool | GetKeyPressActivation () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | KeyPressActivationOn () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | KeyPressActivationOff () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | SetKeyPressActivationValue (char) |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
|
|
virtual char | GetKeyPressActivationValue () |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
|
|
virtual vtkRenderer * | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer.
|
|
virtual void | SetDefaultRenderer (vtkRenderer *) |
| Set/Get the default renderer to use when activating the interactor observer.
|
|
virtual vtkRenderer * | GetCurrentRenderer () |
| Set/Get the current renderer.
|
|
virtual void | SetCurrentRenderer (vtkRenderer *) |
| Set/Get the current renderer.
|
|
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
|
|
void | ReleaseFocus () |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
|
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
| Turn debugging output on.
|
|
virtual void | DebugOff () |
| Turn debugging output off.
|
|
bool | GetDebug () |
| Get the value of the debug flag.
|
|
void | SetDebug (bool debugFlag) |
| Set the value of the debug flag.
|
|
virtual void | Modified () |
| Update the modification time for this object.
|
|
virtual vtkMTimeType | GetMTime () |
| Return this object's modified time.
|
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
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) |
|
vtkTypeBool | InvokeEvent (unsigned long event) |
|
vtkTypeBool | InvokeEvent (const char *event) |
|
std::string | GetObjectDescription () const override |
| The object description printed in messages and PrintSelf output.
|
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
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.
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
|
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.
|
|
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
virtual void | SetObjectName (const std::string &objectName) |
| Set/get the name of this object for reporting purposes.
|
|
virtual std::string | GetObjectName () const |
| Set/get the name of this object for reporting purposes.
|
|
const char * | GetClassName () const |
| Return the class name as a string.
|
|
virtual std::string | GetObjectDescription () const |
| The object description printed in messages and PrintSelf output.
|
|
virtual vtkTypeBool | IsA (const char *name) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
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).
|
|
virtual void | Delete () |
| Delete a VTK object.
|
|
virtual void | FastDelete () |
| Delete a reference to this object.
|
|
void | InitializeObjectBase () |
|
void | Print (ostream &os) |
| Print an object to an ostream.
|
|
void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object).
|
|
virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object).
|
|
int | GetReferenceCount () |
| Return the current reference count of this object.
|
|
void | SetReferenceCount (int) |
| Sets the reference count.
|
|
bool | GetIsInMemkind () const |
| A local state flag that remembers whether this object lives in the normal or extended memory space.
|
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual bool | UsesGarbageCollector () const |
| Indicate whether the class uses vtkGarbageCollector or not.
|
|
|
static vtkDisplaySizedImplicitPlaneWidget * | New () |
| Instantiate the object.
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
| Standard macros implementing standard VTK methods.
|
|
static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
| Standard macros implementing standard VTK methods.
|
|
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.
|
|
static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
| Convenience methods for outside classes.
|
|
static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
|
static void | BreakOnError () |
| This method is called when vtkErrorMacro executes.
|
|
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static vtkTypeBool | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class.
|
|
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).
|
|
static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
|
static void | SetMemkindDirectory (const char *directoryname) |
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
|
|
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.
|
|
3D widget for manipulating a display sized plane
This 3D widget defines a display sized plane represented as a disk, that can be interactively placed in a scene. The widget is assumed to consist of three parts: 1) a disk plane with a 2) plane normal, which is rooted at a 3) point on the plane. (The representation paired with this widget determines the actual geometry of the widget.)
To use this widget, you generally pair it with a vtkDisplaySizedImplicitPlaneRepresentation (or a subclass). Various options are available for controlling how the representation appears, and how the widget functions.
- Event Bindings:
- By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
If the mouse is over the plane normal:
LeftButtonPressEvent - select normal
LeftButtonReleaseEvent - release normal
MouseMoveEvent - orient the normal vector
If the mouse is over the origin point (handle):
LeftButtonPressEvent - select handle
LeftButtonReleaseEvent - release handle (if selected)
MouseMoveEvent - move the origin point (constrained to the plane)
If the mouse is over the plane:
LeftButtonPressEvent - select plane
LeftButtonReleaseEvent - release plane (if selected)
MouseMoveEvent - move the plane
If the mouse is over the perimeter of the disk plane:
LeftButtonPressEvent - select perimeter
LeftButtonReleaseEvent - release perimeter (if selected)
MouseMoveEvent - resize the perimeter -> radius of the disk plane
If the keypress characters are used
'Down/Left' Move plane down
'Up/Right' Move plane up
'P/p' Pick a new origin from the intersection with a mesh cell rendered by the renderer
'Ctrl' + 'P/p' Snap to a new origin from the closest mesh point rendered by the renderer
'N/n' Pick a new normal from the intersection with a mesh cell rendered by the renderer
'Ctrl' + 'N/n' Snap to a new normal from the closest mesh point rendered by the renderer
In all the cases, independent of what is picked, the widget responds to the following VTK events:
MiddleButtonPressEvent - move the plane
MiddleButtonReleaseEvent - release the plane
RightButtonPressEvent - scale the widget's representation
RightButtonReleaseEvent - stop scaling the widget
MouseMoveEvent - scale (if right button) or move (if middle button) the widget
- Event Bindings:
- Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkDisplaySizedImplicitPlaneWidget's widget events:
vtkWidgetEvent::Select -- some part of the widget has been selected
vtkWidgetEvent::EndSelect -- the selection process has completed
vtkWidgetEvent::Move -- a request for widget motion has been invoked
vtkWidgetEvent::Up and vtkWidgetEvent::Down -- MovePlaneAction
vtkWidgetEvent::PickPoint -- PickOriginAction
vtkWidgetEvent::PickNormal -- PickNormalAction
- Event Bindings:
- In turn, when these widget events are processed, the vtkDisplaySizedImplicitPlaneWidget invokes the following VTK events on itself (which observers can listen for):
vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
- Event Bindings:
- This class, and vtkDisplaySizedImplicitPlaneRepresentation, are next generation VTK widgets.
- See also
- vtk3DWidget vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget vtkImplicitCylinderWidget, vtkImplicitPlaneWidget2
- Events:
- vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
- Tests:
- vtkDisplaySizedImplicitPlaneWidget (Tests)
Definition at line 101 of file vtkDisplaySizedImplicitPlaneWidget.h.