VTK  9.0.20210415
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCaptionRepresentation Class Reference

represents vtkCaptionWidget in the scene More...

#include <vtkCaptionRepresentation.h>

Inheritance diagram for vtkCaptionRepresentation:
[legend]
Collaboration diagram for vtkCaptionRepresentation:
[legend]

Public Member Functions

void BuildRepresentation () override
 Satisfy the superclasses API. More...
 
void GetSize (double size[2]) override
 Subclasses should implement these methods. More...
 
void SetAnchorPosition (double pos[3])
 Specify the position of the anchor (i.e., the point that the caption is anchored to). More...
 
void GetAnchorPosition (double pos[3])
 Specify the position of the anchor (i.e., the point that the caption is anchored to). More...
 
void SetCaptionActor2D (vtkCaptionActor2D *captionActor)
 Specify the vtkCaptionActor2D to manage. More...
 
virtual vtkCaptionActor2DGetCaptionActor2D ()
 Specify the vtkCaptionActor2D to manage. More...
 
void SetAnchorRepresentation (vtkPointHandleRepresentation3D *)
 Set and get the instances of vtkPointHandleRepresention3D used to implement this representation. More...
 
virtual vtkPointHandleRepresentation3DGetAnchorRepresentation ()
 Set and get the instances of vtkPointHandleRepresention3D used to implement this representation. More...
 
void GetActors2D (vtkPropCollection *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
int RenderOverlay (vtkViewport *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
int RenderOpaqueGeometry (vtkViewport *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
virtual void SetFontFactor (double)
 Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF. More...
 
virtual double GetFontFactor ()
 Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF. More...
 
- Public Member Functions inherited from vtkBorderRepresentation
virtual void SetInteractionState (int)
 
vtkMTimeType GetMTime () override
 Return the MTime of this object. More...
 
void SetBWActorDisplayOverlay (bool)
 
virtual vtkCoordinateGetPositionCoordinate ()
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual void SetPosition (float x[2])
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual void SetPosition (float x, float y)
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual float * GetPosition ()
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual vtkCoordinateGetPosition2Coordinate ()
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual void SetPosition2 (float x[2])
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual void SetPosition2 (float x, float y)
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual float * GetPosition2 ()
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual void SetShowBorder (int border)
 Specify when and if the border should appear. More...
 
virtual int GetShowBorderMinValue ()
 Specify when and if the border should appear. More...
 
virtual int GetShowBorderMaxValue ()
 Specify when and if the border should appear. More...
 
virtual int GetShowBorder ()
 Specify when and if the border should appear. More...
 
void SetShowBorderToOff ()
 Specify when and if the border should appear. More...
 
void SetShowBorderToOn ()
 Specify when and if the border should appear. More...
 
void SetShowBorderToActive ()
 Specify when and if the border should appear. More...
 
virtual void SetShowVerticalBorder (int)
 Specify when and if the vertical border should appear. More...
 
virtual int GetShowVerticalBorder ()
 Specify when and if the vertical border should appear. More...
 
virtual void SetShowHorizontalBorder (int)
 Specify when and if the horizontal border should appear. More...
 
virtual int GetShowHorizontalBorder ()
 Specify when and if the horizontal border should appear. More...
 
virtual vtkProperty2DGetBorderProperty ()
 Specify the properties of the border. More...
 
virtual void SetProportionalResize (vtkTypeBool)
 Indicate whether resizing operations should keep the x-y directions proportional to one another. More...
 
virtual vtkTypeBool GetProportionalResize ()
 Indicate whether resizing operations should keep the x-y directions proportional to one another. More...
 
virtual void ProportionalResizeOn ()
 Indicate whether resizing operations should keep the x-y directions proportional to one another. More...
 
virtual void ProportionalResizeOff ()
 Indicate whether resizing operations should keep the x-y directions proportional to one another. More...
 
virtual void SetMinimumSize (int, int)
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
void SetMinimumSize (int[2])
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
virtual int * GetMinimumSize ()
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
virtual void GetMinimumSize (int &, int &)
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
virtual void GetMinimumSize (int[2])
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
virtual void SetMaximumSize (int, int)
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
void SetMaximumSize (int[2])
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
virtual int * GetMaximumSize ()
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
virtual void GetMaximumSize (int &, int &)
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
virtual void GetMaximumSize (int[2])
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
virtual void SetTolerance (int)
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). More...
 
virtual int GetTolerance ()
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). More...
 
virtual double * GetSelectionPoint ()
 After a selection event within the region interior to the border; the normalized selection coordinates may be obtained. More...
 
virtual void GetSelectionPoint (double data[2])
 After a selection event within the region interior to the border; the normalized selection coordinates may be obtained. More...
 
virtual void SetMoving (vtkTypeBool)
 This is a modifier of the interaction state. More...
 
virtual vtkTypeBool GetMoving ()
 This is a modifier of the interaction state. More...
 
virtual void MovingOn ()
 This is a modifier of the interaction state. More...
 
virtual void MovingOff ()
 This is a modifier of the interaction state. More...
 
void StartWidgetInteraction (double eventPos[2]) override
 Subclasses should implement these methods. More...
 
void WidgetInteraction (double eventPos[2]) override
 Subclasses should implement these methods. More...
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 Subclasses should implement these methods. More...
 
virtual void SetBorderColor (double, double, double)
 Set/Get the RGB color of the border. More...
 
virtual void SetBorderColor (double[3])
 Set/Get the RGB color of the border. More...
 
virtual double * GetBorderColor ()
 Set/Get the RGB color of the border. More...
 
virtual void GetBorderColor (double &, double &, double &)
 Set/Get the RGB color of the border. More...
 
virtual void GetBorderColor (double[3])
 Set/Get the RGB color of the border. More...
 
virtual void SetBorderThickness (float)
 Set/Get the thickness of the border in screen units. More...
 
virtual float GetBorderThickness ()
 Set/Get the thickness of the border in screen units. More...
 
virtual void SetCornerRadiusStrength (double)
 Set/Get the ratio between no radius and maximum radius. More...
 
virtual double GetCornerRadiusStrength ()
 Set/Get the ratio between no radius and maximum radius. More...
 
virtual void SetCornerResolution (int)
 Set/Get the number of points that define each round corners. More...
 
virtual int GetCornerResolution ()
 Set/Get the number of points that define each round corners. More...
 
virtual void SetPolygonColor (double, double, double)
 Set/Get the RGB color of the background polygon. More...
 
virtual void SetPolygonColor (double[3])
 Set/Get the RGB color of the background polygon. More...
 
virtual double * GetPolygonColor ()
 Set/Get the RGB color of the background polygon. More...
 
virtual void GetPolygonColor (double &, double &, double &)
 Set/Get the RGB color of the background polygon. More...
 
virtual void GetPolygonColor (double[3])
 Set/Get the RGB color of the background polygon. More...
 
virtual void SetPolygonOpacity (double)
 Set/Get the opacity of the background color. More...
 
virtual double GetPolygonOpacity ()
 Set/Get the opacity of the background color. More...
 
void SetPolygonRGBA (double rgba[4])
 Convenience method to set the background color and the opacity at once. More...
 
void SetPolygonRGBA (double r, double g, double b, double a)
 Convenience method to set the background color and the opacity at once. More...
 
void GetPolygonRGBA (double rgba[4])
 Convenience method to get the background color and the opacity at once. More...
 
void GetPolygonRGBA (double &r, double &g, double &b, double &a)
 Convenience method to set the background color and the opacity at once. More...
 
vtkBorderRepresentationNewInstance () const
 Define standard methods. More...
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PlaceWidget (double vtkNotUsed(bounds)[6])
 The following is a suggested API for widget representations. More...
 
virtual void EndWidgetInteraction (double newEventPos[2])
 
virtual int GetInteractionState ()
 
virtual void Highlight (int vtkNotUsed(highlightOn))
 
double * GetBounds () override
 Methods to make this class behave as a vtkProp. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void GetActors2D (vtkPropCollection *) override
 
void GetVolumes (vtkPropCollection *) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
int RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking. More...
 
void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetRenderer (vtkRenderer *ren)
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual vtkRendererGetRenderer ()
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual void StartComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void ComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *callData, int modify=0)
 
virtual void SetPlaceFactor (double)
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual double GetPlaceFactor ()
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual void SetHandleSize (double)
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
virtual double GetHandleSize ()
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
virtual vtkTypeBool GetNeedToRender ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
virtual void SetNeedToRender (vtkTypeBool)
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
virtual void NeedToRenderOn ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
virtual void NeedToRenderOff ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
vtkWidgetRepresentationNewInstance () const
 Standard methods for instances of this class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual bool GetUseBounds ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void UseBoundsOn ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void UseBoundsOff ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkCaptionRepresentationNew ()
 Instantiate this class. More...
 
- Static Public Member Functions inherited from vtkBorderRepresentation
static vtkBorderRepresentationNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Define standard methods. More...
 
static vtkBorderRepresentationSafeDownCast (vtkObjectBase *o)
 Define standard methods. More...
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. 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 vtkObjectBaseNew ()
 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...
 

Protected Member Functions

 vtkCaptionRepresentation ()
 
 ~vtkCaptionRepresentation () override
 
virtual void AdjustCaptionBoundary ()
 
- Protected Member Functions inherited from vtkBorderRepresentation
 vtkBorderRepresentation ()
 
 ~vtkBorderRepresentation () override
 
virtual void NegotiateLayout ()
 
virtual void UpdateShowBorder ()
 
void ComputeRoundCorners ()
 Create all 4 round corners with the specified radius and resolution. More...
 
void ComputeOneRoundCorner (vtkCellArray *polys, vtkPoints *points, const double radius, vtkIdType xPt, vtkIdType yPt, const double startAngle)
 Create a quarter circle centered in point[idCenterX].x, point[idCenterY].y), of radius 'radius' with a starting angle 'startAngle' ending in 'startAngle + PI/2' with CornerResolution number of points. More...
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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 registered picker, and return the assembly path. More...
 
vtkAssemblyPathGetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)
 
bool NearbyEvent (int X, int Y, double bounds[6])
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
void UpdatePropPose (vtkProp3D *prop, const double *pos1, const double *orient1, const double *pos2, const double *orient2)
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp () override
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkCaptionActor2DCaptionActor2D
 
vtkConeSourceCaptionGlyph
 
int PointWidgetState
 
int DisplayAttachmentPoint [2]
 
double FontFactor
 
vtkPointHandleRepresentation3DAnchorRepresentation
 
- Protected Attributes inherited from vtkBorderRepresentation
int ShowVerticalBorder
 
int ShowHorizontalBorder
 
vtkNew< vtkProperty2DBorderProperty
 
vtkNew< vtkProperty2DPolygonProperty
 
vtkTypeBool ProportionalResize
 
int Tolerance
 
vtkTypeBool Moving
 
double SelectionPoint [2]
 
vtkNew< vtkCoordinatePositionCoordinate
 
vtkNew< vtkCoordinatePosition2Coordinate
 
int Negotiated
 
double StartPosition [2]
 
vtkNew< vtkPointsBWPoints
 
vtkNew< vtkPolyDataBWPolyData
 
vtkNew< vtkPolyDataPolyDataEdges
 
vtkNew< vtkPolyDataPolyDataPolygon
 
vtkNew< vtkTransformBWTransform
 
vtkNew< vtkTransformPolyDataFilterBWTransformFilter
 
vtkNew< vtkPolyDataMapper2DBWMapperEdges
 
vtkNew< vtkPolyDataMapper2DBWMapperPolygon
 
vtkNew< vtkActor2DBWActorEdges
 
vtkNew< vtkActor2DBWActorPolygon
 
int MinimumSize [2]
 
int MaximumSize [2]
 
double BorderColor [3] = { 1.0, 1.0, 1.0 }
 
float BorderThickness = 1.0
 
double CornerRadiusStrength = 0.0
 
int CornerResolution = 20
 
double PolygonColor [3] = { 1.0, 1.0, 1.0 }
 
double PolygonOpacity = 0.0
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRendererRenderer
 
int InteractionState
 
double StartEventPosition [3]
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
int ValidPick
 
bool PickingManaged
 
double HandleSize
 
vtkTypeBool NeedToRender
 
vtkTimeStamp BuildTime
 
vtkNew< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkBorderRepresentation Superclass
 Standard VTK class methods. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK class methods. More...
 
static vtkCaptionRepresentationSafeDownCast (vtkObjectBase *o)
 Standard VTK class methods. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard VTK class methods. More...
 
vtkCaptionRepresentationNewInstance () const
 Standard VTK class methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard VTK class methods. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard VTK class methods. More...
 

Additional Inherited Members

- Public Types inherited from vtkBorderRepresentation
enum  { BORDER_OFF = 0, BORDER_ON, BORDER_ACTIVE }
 
enum  _InteractionState {
  Outside = 0, Inside, AdjustingP0, AdjustingP1,
  AdjustingP2, AdjustingP3, AdjustingE0, AdjustingE1,
  AdjustingE2, AdjustingE3
}
 Define the various states that the representation can be in. More...
 
typedef vtkWidgetRepresentation Superclass
 Define standard methods. More...
 
- Public Types inherited from vtkWidgetRepresentation
enum  Axis { NONE = -1, XAxis = 0, YAxis = 1, ZAxis = 2 }
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

represents vtkCaptionWidget in the scene

This class represents vtkCaptionWidget. 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 defined by an instance of vtkCaptionActor2D. 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 vtkBorderRepresentation.

See also
vtkCaptionWidget vtkBorderWidget vtkBorderRepresentation vtkCaptionActor

Definition at line 47 of file vtkCaptionRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard VTK class methods.

Definition at line 59 of file vtkCaptionRepresentation.h.

Constructor & Destructor Documentation

◆ vtkCaptionRepresentation()

vtkCaptionRepresentation::vtkCaptionRepresentation ( )
protected

◆ ~vtkCaptionRepresentation()

vtkCaptionRepresentation::~vtkCaptionRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCaptionRepresentation* vtkCaptionRepresentation::New ( )
static

Instantiate this class.

◆ IsTypeOf()

static vtkTypeBool vtkCaptionRepresentation::IsTypeOf ( const char *  type)
static

Standard VTK class methods.

◆ IsA()

virtual vtkTypeBool vtkCaptionRepresentation::IsA ( const char *  type)
virtual

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

◆ SafeDownCast()

static vtkCaptionRepresentation* vtkCaptionRepresentation::SafeDownCast ( vtkObjectBase o)
static

Standard VTK class methods.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCaptionRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

◆ NewInstance()

vtkCaptionRepresentation* vtkCaptionRepresentation::NewInstance ( ) const

Standard VTK class methods.

◆ PrintSelf()

void vtkCaptionRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

◆ SetAnchorPosition()

void vtkCaptionRepresentation::SetAnchorPosition ( double  pos[3])

Specify the position of the anchor (i.e., the point that the caption is anchored to).

Note that the position should be specified in world coordinates.

◆ GetAnchorPosition()

void vtkCaptionRepresentation::GetAnchorPosition ( double  pos[3])

Specify the position of the anchor (i.e., the point that the caption is anchored to).

Note that the position should be specified in world coordinates.

◆ SetCaptionActor2D()

void vtkCaptionRepresentation::SetCaptionActor2D ( vtkCaptionActor2D captionActor)

Specify the vtkCaptionActor2D to manage.

If not specified, then one is automatically created.

◆ GetCaptionActor2D()

virtual vtkCaptionActor2D* vtkCaptionRepresentation::GetCaptionActor2D ( )
virtual

Specify the vtkCaptionActor2D to manage.

If not specified, then one is automatically created.

◆ SetAnchorRepresentation()

void vtkCaptionRepresentation::SetAnchorRepresentation ( vtkPointHandleRepresentation3D )

Set and get the instances of vtkPointHandleRepresention3D used to implement this representation.

Normally default representations are created, but you can specify the ones you want to use.

◆ GetAnchorRepresentation()

virtual vtkPointHandleRepresentation3D* vtkCaptionRepresentation::GetAnchorRepresentation ( )
virtual

Set and get the instances of vtkPointHandleRepresention3D used to implement this representation.

Normally default representations are created, but you can specify the ones you want to use.

◆ BuildRepresentation()

void vtkCaptionRepresentation::BuildRepresentation ( )
overridevirtual

Satisfy the superclasses API.

Reimplemented from vtkBorderRepresentation.

◆ GetSize()

void vtkCaptionRepresentation::GetSize ( double  size[2])
inlineoverridevirtual

Subclasses should implement these methods.

See the superclasses' documentation for more information.

Reimplemented from vtkBorderRepresentation.

Definition at line 95 of file vtkCaptionRepresentation.h.

◆ GetActors2D()

void vtkCaptionRepresentation::GetActors2D ( vtkPropCollection )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

◆ ReleaseGraphicsResources()

void vtkCaptionRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

◆ RenderOverlay()

int vtkCaptionRepresentation::RenderOverlay ( vtkViewport )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

◆ RenderOpaqueGeometry()

int vtkCaptionRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

◆ RenderTranslucentPolygonalGeometry()

int vtkCaptionRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkCaptionRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

◆ SetFontFactor()

virtual void vtkCaptionRepresentation::SetFontFactor ( double  )
virtual

Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF.

◆ GetFontFactor()

virtual double vtkCaptionRepresentation::GetFontFactor ( )
virtual

Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF.

◆ AdjustCaptionBoundary()

virtual void vtkCaptionRepresentation::AdjustCaptionBoundary ( )
protectedvirtual

Member Data Documentation

◆ CaptionActor2D

vtkCaptionActor2D* vtkCaptionRepresentation::CaptionActor2D
protected

Definition at line 128 of file vtkCaptionRepresentation.h.

◆ CaptionGlyph

vtkConeSource* vtkCaptionRepresentation::CaptionGlyph
protected

Definition at line 129 of file vtkCaptionRepresentation.h.

◆ PointWidgetState

int vtkCaptionRepresentation::PointWidgetState
protected

Definition at line 131 of file vtkCaptionRepresentation.h.

◆ DisplayAttachmentPoint

int vtkCaptionRepresentation::DisplayAttachmentPoint[2]
protected

Definition at line 132 of file vtkCaptionRepresentation.h.

◆ FontFactor

double vtkCaptionRepresentation::FontFactor
protected

Definition at line 133 of file vtkCaptionRepresentation.h.

◆ AnchorRepresentation

vtkPointHandleRepresentation3D* vtkCaptionRepresentation::AnchorRepresentation
protected

Definition at line 136 of file vtkCaptionRepresentation.h.


The documentation for this class was generated from the following file: