ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkCaptionWidget Class Reference

vtkCaptionWidget - widget for placing a caption (text plus leader) More...

Inheritance diagram for Kitware.VTK.vtkCaptionWidget:
[legend]
Collaboration diagram for Kitware.VTK.vtkCaptionWidget:
[legend]

List of all members.

Public Member Functions

 vtkCaptionWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCaptionWidget ()
 Instantiate this class.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
vtkCaptionActor2D GetCaptionActor2D ()
 Specify a vtkCaptionActor2D to manage. This is convenient, alternative method to SetRepresentation(). It internally create a vtkCaptionRepresentation and then invokes vtkCaptionRepresentation::SetCaptionActor2D().
override int IsA (string type)
 Standard VTK class methods.
new vtkCaptionWidget NewInstance ()
 Standard VTK class methods.
void SetCaptionActor2D (vtkCaptionActor2D capActor)
 Specify a vtkCaptionActor2D to manage. This is convenient, alternative method to SetRepresentation(). It internally create a vtkCaptionRepresentation and then invokes vtkCaptionRepresentation::SetCaptionActor2D().
override void SetEnabled (int enabling)
 Override superclasses' SetEnabled() method because the caption leader has its own dedicated widget.
void SetRepresentation (vtkCaptionRepresentation r)
 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.

Static Public Member Functions

static new vtkCaptionWidget New ()
 Instantiate this class.
static new int IsTypeOf (string type)
 Standard VTK class methods.
static new vtkCaptionWidget SafeDownCast (vtkObjectBase o)
 Standard VTK class methods.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCaptionWidget"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkCaptionWidget"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkCaptionWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCaptionWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal IntPtr vtkCaptionWidget_GetCaptionActor2D_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkCaptionWidget_IsA_03 (HandleRef pThis, string type)
static internal int vtkCaptionWidget_IsTypeOf_04 (string type)
static internal IntPtr vtkCaptionWidget_NewInstance_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCaptionWidget_SafeDownCast_07 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCaptionWidget_SetCaptionActor2D_08 (HandleRef pThis, HandleRef capActor)
static internal void vtkCaptionWidget_SetEnabled_09 (HandleRef pThis, int enabling)
static internal void vtkCaptionWidget_SetRepresentation_10 (HandleRef pThis, HandleRef r)

Static Private Member Functions

static vtkCaptionWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCaptionWidget - widget for placing a caption (text plus leader)

Description 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.


Constructor & Destructor Documentation

static Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Instantiate this class.


Member Function Documentation

Create the default widget representation if one is not set.

Reimplemented from Kitware.VTK.vtkBorderWidget.

override void Kitware.VTK.vtkCaptionWidget.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkBorderWidget.

Specify a vtkCaptionActor2D to manage. This is convenient, alternative method to SetRepresentation(). It internally create a vtkCaptionRepresentation and then invokes vtkCaptionRepresentation::SetCaptionActor2D().

Here is the call graph for this function:

override int Kitware.VTK.vtkCaptionWidget.IsA ( string  type) [virtual]

Standard VTK class methods.

Reimplemented from Kitware.VTK.vtkBorderWidget.

static new int Kitware.VTK.vtkCaptionWidget.IsTypeOf ( string  type) [static]

Standard VTK class methods.

Reimplemented from Kitware.VTK.vtkBorderWidget.

Instantiate this class.

Reimplemented from Kitware.VTK.vtkBorderWidget.

Standard VTK class methods.

Reimplemented from Kitware.VTK.vtkBorderWidget.

Standard VTK class methods.

Reimplemented from Kitware.VTK.vtkBorderWidget.

Here is the call graph for this function:

Specify a vtkCaptionActor2D to manage. This is convenient, alternative method to SetRepresentation(). It internally create a vtkCaptionRepresentation and then invokes vtkCaptionRepresentation::SetCaptionActor2D().

override void Kitware.VTK.vtkCaptionWidget.SetEnabled ( int  enabling) [virtual]

Override superclasses' SetEnabled() method because the caption leader has its own dedicated widget.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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.

static internal void Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_GetCaptionActor2D_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_IsA_03 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_IsTypeOf_04 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_NewInstance_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_SafeDownCast_07 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_SetCaptionActor2D_08 ( HandleRef  pThis,
HandleRef  capActor 
) [private]
static internal void Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_SetEnabled_09 ( HandleRef  pThis,
int  enabling 
) [private]
static internal void Kitware.VTK.vtkCaptionWidget.vtkCaptionWidget_SetRepresentation_10 ( HandleRef  pThis,
HandleRef  r 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCaptionWidget.MRClassNameKey = "16vtkCaptionWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkBorderWidget.

new const string Kitware.VTK.vtkCaptionWidget.MRFullTypeName = "Kitware.VTK.vtkCaptionWidget"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkBorderWidget.


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