VTK
9.4.20241221
|
3D widget for manipulating an infinite annulus More...
#include <vtkImplicitAnnulusWidget.h>
Public Types | |
typedef vtkAbstractWidget | Superclass |
Public Types inherited from vtkAbstractWidget | |
typedef vtkInteractorObserver | Superclass |
Standard macros implementing standard VTK methods. | |
Public Types inherited from vtkInteractorObserver | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Standard macros implementing standard VTK methods. | |
vtkImplicitAnnulusWidget * | NewInstance () const |
void | SetRepresentation (vtkImplicitAnnulusRepresentation *rep) |
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. | |
vtkImplicitAnnulusRepresentation * | GetAnnulusRepresentation () |
Return the representation as a vtkImplicitAnnulusRepresentation. | |
void | CreateDefaultRepresentation () override |
Create the default widget representation if one is not set. | |
Public Member Functions inherited from vtkAbstractWidget | |
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. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard macros implementing standard VTK methods. | |
Public Member Functions inherited from vtkInteractorObserver | |
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. | |
Public Member Functions inherited from vtkObject | |
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. | |
Public Member Functions inherited from vtkObjectBase | |
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 Public Member Functions | |
static vtkImplicitAnnulusWidget * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkImplicitAnnulusWidget * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkAbstractWidget | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard macros implementing standard VTK methods. | |
static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
Standard macros implementing standard VTK methods. | |
Static Public Member Functions inherited from vtkInteractorObserver | |
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 Public Member Functions inherited from vtkObject | |
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 Public Member Functions inherited from vtkObjectBase | |
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. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard macros implementing standard VTK methods. | |
Protected Member Functions inherited from vtkAbstractWidget | |
vtkAbstractWidget () | |
~vtkAbstractWidget () override | |
void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
virtual void | SetCursor (int vtkNotUsed(state)) |
Protected Member Functions inherited from vtkInteractorObserver | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkInteractorObserver () | |
~vtkInteractorObserver () override | |
virtual void | RegisterPickers () |
Register internal Pickers in the Picking Manager. | |
void | UnRegisterPickers () |
Unregister internal pickers from the Picking Manager. | |
vtkPickingManager * | GetPickingManager () |
Return the picking manager associated on the context on which the observer currently belong. | |
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. | |
int | RequestCursorShape (int requestedShape) |
virtual void | StartInteraction () |
Utility routines used to start and end interaction. | |
virtual void | EndInteraction () |
Utility routines used to start and end interaction. | |
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
Helper method for subclasses. | |
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
Helper method for subclasses. | |
Protected Member Functions inherited from vtkObject | |
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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
3D widget for manipulating an infinite annulus
This 3D widget defines an infinite annulus that can be interactively placed in a scene. The widget is assumed to consist of four parts: 1) an annulus contained in a 2) bounding box, with an 3) annulus axis, which is rooted at an 4) origin point in the bounding box. (The representation paired with this widget determines the actual geometry of the widget.)
To use this widget, you generally pair it with a vtkImplicitAnnulusRepresentation (or a subclass). Various options are available for controlling how the representation appears, and how the widget functions.
If the annulus axis is selected:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkImplicitAnnulusWidget'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 -- MoveAnnulusAction
In turn, when these widget events are processed, the vtkImplicitAnnulusWidget 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)
Definition at line 86 of file vtkImplicitAnnulusWidget.h.
Definition at line 91 of file vtkImplicitAnnulusWidget.h.
|
static |
|
static |
|
virtual |
Standard macros implementing standard VTK methods.
Reimplemented from vtkAbstractWidget.
|
static |
|
protectedvirtual |
Standard macros implementing standard VTK methods.
Reimplemented from vtkAbstractWidget.
vtkImplicitAnnulusWidget * vtkImplicitAnnulusWidget::NewInstance | ( | ) | const |
void vtkImplicitAnnulusWidget::SetRepresentation | ( | vtkImplicitAnnulusRepresentation * | rep | ) |
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.
|
inline |
Return the representation as a vtkImplicitAnnulusRepresentation.
Definition at line 103 of file vtkImplicitAnnulusWidget.h.
|
overridevirtual |
Create the default widget representation if one is not set.
Implements vtkAbstractWidget.