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.vtkCaptionRepresentation Class Reference

vtkCaptionRepresentation - represents vtkCaptionWidget in the scene More...

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

List of all members.

Public Member Functions

 vtkCaptionRepresentation (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCaptionRepresentation ()
 Instantiate this class.
override void BuildRepresentation ()
 Satisfy the superclasses API.
override void GetActors2D (vtkPropCollection arg0)
 These methods are necessary to make this representation behave as a vtkProp.
void GetAnchorPosition (IntPtr pos)
 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.
virtual
vtkPointHandleRepresentation3D 
GetAnchorRepresentation ()
 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.
virtual vtkCaptionActor2D GetCaptionActor2D ()
 Specify the vtkCaptionActor2D to manage. If not specified, then one is automatically created.
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.
virtual double GetFontFactorMaxValue ()
 Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF.
virtual double GetFontFactorMinValue ()
 Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF.
override void GetSize (IntPtr size)
 Satisfy the superclasses API.
override int HasTranslucentPolygonalGeometry ()
 These methods are necessary to make this representation behave as a vtkProp.
override int IsA (string type)
 Standard VTK class methods.
new vtkCaptionRepresentation NewInstance ()
 Standard VTK class methods.
override void ReleaseGraphicsResources (vtkWindow arg0)
 These methods are necessary to make this representation behave as a vtkProp.
override int RenderOpaqueGeometry (vtkViewport arg0)
 These methods are necessary to make this representation behave as a vtkProp.
override int RenderOverlay (vtkViewport arg0)
 These methods are necessary to make this representation behave as a vtkProp.
override int RenderTranslucentPolygonalGeometry (vtkViewport arg0)
 These methods are necessary to make this representation behave as a vtkProp.
void SetAnchorPosition (IntPtr pos)
 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.
void SetAnchorRepresentation (vtkPointHandleRepresentation3D arg0)
 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.
void SetCaptionActor2D (vtkCaptionActor2D captionActor)
 Specify the vtkCaptionActor2D to manage. If not specified, then one is automatically created.
virtual void SetFontFactor (double _arg)
 Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkCaptionRepresentation"
 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 vtkCaptionRepresentation_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCaptionRepresentation_BuildRepresentation_01 (HandleRef pThis)
static internal void vtkCaptionRepresentation_GetActors2D_02 (HandleRef pThis, HandleRef arg0)
static internal void vtkCaptionRepresentation_GetAnchorPosition_03 (HandleRef pThis, IntPtr pos)
static internal IntPtr vtkCaptionRepresentation_GetAnchorRepresentation_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCaptionRepresentation_GetCaptionActor2D_05 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkCaptionRepresentation_GetFontFactor_06 (HandleRef pThis)
static internal double vtkCaptionRepresentation_GetFontFactorMaxValue_07 (HandleRef pThis)
static internal double vtkCaptionRepresentation_GetFontFactorMinValue_08 (HandleRef pThis)
static internal void vtkCaptionRepresentation_GetSize_09 (HandleRef pThis, IntPtr size)
static internal int vtkCaptionRepresentation_HasTranslucentPolygonalGeometry_10 (HandleRef pThis)
static internal int vtkCaptionRepresentation_IsA_11 (HandleRef pThis, string type)
static internal int vtkCaptionRepresentation_IsTypeOf_12 (string type)
static internal IntPtr vtkCaptionRepresentation_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCaptionRepresentation_ReleaseGraphicsResources_15 (HandleRef pThis, HandleRef arg0)
static internal int vtkCaptionRepresentation_RenderOpaqueGeometry_16 (HandleRef pThis, HandleRef arg0)
static internal int vtkCaptionRepresentation_RenderOverlay_17 (HandleRef pThis, HandleRef arg0)
static internal int vtkCaptionRepresentation_RenderTranslucentPolygonalGeometry_18 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCaptionRepresentation_SafeDownCast_19 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCaptionRepresentation_SetAnchorPosition_20 (HandleRef pThis, IntPtr pos)
static internal void vtkCaptionRepresentation_SetAnchorRepresentation_21 (HandleRef pThis, HandleRef arg0)
static internal void vtkCaptionRepresentation_SetCaptionActor2D_22 (HandleRef pThis, HandleRef captionActor)
static internal void vtkCaptionRepresentation_SetFontFactor_23 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkCaptionRepresentation ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCaptionRepresentation - represents vtkCaptionWidget in the scene

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


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Instantiate this class.


Member Function Documentation

Satisfy the superclasses API.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

override void Kitware.VTK.vtkCaptionRepresentation.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.vtkBorderRepresentation.

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

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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.

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.

Here is the call graph for this function:

Specify the vtkCaptionActor2D to manage. If not specified, then one is automatically created.

Here is the call graph for this function:

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

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

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

override void Kitware.VTK.vtkCaptionRepresentation.GetSize ( IntPtr  size) [virtual]

Satisfy the superclasses API.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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

Standard VTK class methods.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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

Standard VTK class methods.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

Instantiate this class.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

Standard VTK class methods.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

Standard VTK class methods.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

Here is the call graph for this function:

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.

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.

Specify the vtkCaptionActor2D to manage. If not specified, then one is automatically created.

virtual void Kitware.VTK.vtkCaptionRepresentation.SetFontFactor ( double  _arg) [virtual]

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

static internal void Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_GetActors2D_02 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_GetAnchorPosition_03 ( HandleRef  pThis,
IntPtr  pos 
) [private]
static internal IntPtr Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_GetAnchorRepresentation_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_GetCaptionActor2D_05 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal double Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_GetFontFactor_06 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_GetSize_09 ( HandleRef  pThis,
IntPtr  size 
) [private]
static internal int Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_IsA_11 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_IsTypeOf_12 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_NewInstance_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_ReleaseGraphicsResources_15 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_RenderOpaqueGeometry_16 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_RenderOverlay_17 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_RenderTranslucentPolygonalGeometry_18 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_SafeDownCast_19 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_SetAnchorPosition_20 ( HandleRef  pThis,
IntPtr  pos 
) [private]
static internal void Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_SetAnchorRepresentation_21 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_SetCaptionActor2D_22 ( HandleRef  pThis,
HandleRef  captionActor 
) [private]
static internal void Kitware.VTK.vtkCaptionRepresentation.vtkCaptionRepresentation_SetFontFactor_23 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCaptionRepresentation.MRClassNameKey = "24vtkCaptionRepresentation" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkBorderRepresentation.


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