|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More...
|
|
vtkCaptionWidget * | 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 enabling) override |
| Override superclasses' SetEnabled() method because the caption leader has its own dedicated widget. More...
|
|
void | SetRepresentation (vtkCaptionRepresentation *r) |
| Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
|
|
void | SetCaptionActor2D (vtkCaptionActor2D *capActor) |
| Specify a vtkCaptionActor2D to manage. More...
|
|
vtkCaptionActor2D * | GetCaptionActor2D () |
|
void | CreateDefaultRepresentation () override |
| Create the default widget representation if one is not set. More...
|
|
vtkBorderWidget * | NewInstance () const |
|
virtual void | SetSelectable (vtkTypeBool) |
| Indicate whether the interior region of the widget can be selected or not. More...
|
|
virtual vtkTypeBool | GetSelectable () |
|
virtual void | SelectableOn () |
|
virtual void | SelectableOff () |
|
virtual void | SetResizable (vtkTypeBool) |
| Indicate whether the boundary of the widget can be resized. More...
|
|
virtual vtkTypeBool | GetResizable () |
|
virtual void | ResizableOn () |
|
virtual void | ResizableOff () |
|
void | SetRepresentation (vtkBorderRepresentation *r) |
| Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
|
|
vtkBorderRepresentation * | GetBorderRepresentation () |
| Return the representation as a vtkBorderRepresentation. More...
|
|
vtkAbstractWidget * | NewInstance () const |
|
virtual void | SetProcessEvents (vtkTypeBool) |
| Methods to change whether the widget responds to interaction. More...
|
|
virtual vtkTypeBool | GetProcessEvents () |
|
virtual void | ProcessEventsOn () |
|
virtual void | ProcessEventsOff () |
|
vtkWidgetEventTranslator * | GetEventTranslator () |
| Get the event translator. More...
|
|
void | Render () |
| This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...
|
|
void | SetParent (vtkAbstractWidget *parent) |
| Specifying a parent to this widget is used when creating composite widgets. More...
|
|
virtual vtkAbstractWidget * | GetParent () |
|
vtkWidgetRepresentation * | GetRepresentation () |
| Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
|
|
virtual void | SetManagesCursor (vtkTypeBool) |
| Turn on or off the management of the cursor. More...
|
|
virtual vtkTypeBool | GetManagesCursor () |
|
virtual void | ManagesCursorOn () |
|
virtual void | ManagesCursorOff () |
|
void | SetPriority (float) override |
| Override the superclass method. More...
|
|
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 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 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...
|
|
void | PrintRevisions (ostream &) |
| Legacy. More...
|
|
|
static vtkCaptionWidget * | New () |
| Instantiate this class. More...
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkCaptionWidget * | SafeDownCast (vtkObjectBase *o) |
|
static vtkBorderWidget * | New () |
| Method to instantiate class. More...
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkBorderWidget * | SafeDownCast (vtkObjectBase *o) |
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkAbstractWidget * | 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 vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
|
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkCaptionWidget () |
|
| ~vtkCaptionWidget () override |
|
void | StartAnchorInteraction () |
|
void | AnchorInteraction () |
|
void | EndAnchorInteraction () |
|
| vtkBorderWidget () |
|
| ~vtkBorderWidget () override |
|
virtual void | SelectRegion (double eventPos[2]) |
| Subclasses generally implement this method. More...
|
|
virtual int | SubclassSelectAction () |
|
virtual int | SubclassTranslateAction () |
|
virtual int | SubclassEndSelectAction () |
|
virtual int | SubclassMoveAction () |
|
void | SetCursor (int State) override |
|
| vtkAbstractWidget () |
|
| ~vtkAbstractWidget () override |
|
void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
|
virtual void | SetCursor (int vtkNotUsed(state)) |
|
| 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]) |
|
virtual void | RegisterPickers () |
| Register internal Pickers in the Picking Manager. More...
|
|
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 | CollectRevisions (ostream &) |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
widget for placing a caption (text plus leader)
This class provides support for interactively placing a caption on the 2D overlay plane. A caption is defined by some text with a leader (e.g., arrow) that points from the text to a point in the scene. The caption is represented by a vtkCaptionRepresentation. It uses the event bindings of its superclass (vtkBorderWidget) to control the placement of the text, and adds the ability to move the attachment point around. In addition, when the caption text is selected, the widget emits a ActivateEvent that observers can watch for. This is useful for opening GUI dialogoues to adjust font characteristics, etc. (Please see the superclass for a description of event bindings.)
Note that this widget extends the behavior of its superclass vtkBorderWidget. The end point of the leader can be selected and moved around with an internal vtkHandleWidget.
- See also
- vtkBorderWidget vtkTextWidget
- Tests:
- vtkCaptionWidget (Tests)
Definition at line 54 of file vtkCaptionWidget.h.