ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions | List of all members
Kitware.VTK.vtkCaptionActor2D Class Reference

vtkCaptionActor2D - draw text label associated with a point More...

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

Public Member Functions

 vtkCaptionActor2D (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCaptionActor2D ()
 Undocumented Block
virtual void AttachEdgeOnlyOff ()
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
virtual void AttachEdgeOnlyOn ()
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
virtual void BorderOff ()
 Enable/disable the placement of a border around the text.
virtual void BorderOn ()
 Enable/disable the placement of a border around the text.
virtual int GetAttachEdgeOnly ()
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
virtual double[] GetAttachmentPoint ()
 Set/Get the attachment point for the caption. By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.
virtual vtkCoordinate GetAttachmentPointCoordinate ()
 Set/Get the attachment point for the caption. By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.
virtual int GetBorder ()
 Enable/disable the placement of a border around the text.
virtual string GetCaption ()
 Define the text to be placed in the caption. The text can be multiple lines (separated by "
").
virtual vtkTextProperty GetCaptionTextProperty ()
 Set/Get the text property.
virtual int GetLeader ()
 Enable/disable drawing a "line" from the caption to the attachment point.
virtual vtkPolyData GetLeaderGlyph ()
 Specify a glyph to be used as the leader "head". This could be something like an arrow or sphere. If not specified, no glyph is drawn. Note that the glyph is assumed to be aligned along the x-axis and is rotated about the origin.
virtual double GetLeaderGlyphSize ()
 Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.
virtual double GetLeaderGlyphSizeMaxValue ()
 Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.
virtual double GetLeaderGlyphSizeMinValue ()
 Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.
virtual int GetMaximumLeaderGlyphSize ()
 Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.
virtual int GetMaximumLeaderGlyphSizeMaxValue ()
 Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.
virtual int GetMaximumLeaderGlyphSizeMinValue ()
 Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.
virtual int GetPadding ()
 Set/Get the padding between the caption and the border. The value is specified in pixels.
virtual int GetPaddingMaxValue ()
 Set/Get the padding between the caption and the border. The value is specified in pixels.
virtual int GetPaddingMinValue ()
 Set/Get the padding between the caption and the border. The value is specified in pixels.
virtual vtkTextActor GetTextActor ()
 Get the text actor used by the caption. This is useful if you want to control justification and other characteristics of the text actor.
virtual int GetThreeDimensionalLeader ()
 Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).
override int HasTranslucentPolygonalGeometry ()
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
override int IsA (string type)
 Undocumented Block
virtual void LeaderOff ()
 Enable/disable drawing a "line" from the caption to the attachment point.
virtual void LeaderOn ()
 Enable/disable drawing a "line" from the caption to the attachment point.
new vtkCaptionActor2D NewInstance ()
 Undocumented Block
override void ReleaseGraphicsResources (vtkWindow arg0)
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
override int RenderOpaqueGeometry (vtkViewport viewport)
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
override int RenderOverlay (vtkViewport viewport)
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
override int RenderTranslucentPolygonalGeometry (vtkViewport arg0)
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
virtual void SetAttachEdgeOnly (int _arg)
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.
virtual void SetAttachmentPoint (IntPtr x)
 Set/Get the attachment point for the caption. By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.
virtual void SetAttachmentPoint (double x, double y, double z)
 Set/Get the attachment point for the caption. By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.
virtual void SetBorder (int _arg)
 Enable/disable the placement of a border around the text.
virtual void SetCaption (string caption)
 Define the text to be placed in the caption. The text can be multiple lines (separated by "
").
virtual void SetCaptionTextProperty (vtkTextProperty p)
 Set/Get the text property.
virtual void SetLeader (int _arg)
 Enable/disable drawing a "line" from the caption to the attachment point.
virtual void SetLeaderGlyph (vtkPolyData arg0)
 Specify a glyph to be used as the leader "head". This could be something like an arrow or sphere. If not specified, no glyph is drawn. Note that the glyph is assumed to be aligned along the x-axis and is rotated about the origin.
virtual void SetLeaderGlyphSize (double _arg)
 Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.
virtual void SetMaximumLeaderGlyphSize (int _arg)
 Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.
virtual void SetPadding (int _arg)
 Set/Get the padding between the caption and the border. The value is specified in pixels.
virtual void SetThreeDimensionalLeader (int _arg)
 Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).
override void ShallowCopy (vtkProp prop)
 Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.
virtual void ThreeDimensionalLeaderOff ()
 Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).
virtual void ThreeDimensionalLeaderOn ()
 Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).
- Public Member Functions inherited from Kitware.VTK.vtkActor2D
 vtkActor2D (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkActor2D ()
 Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0.
override void GetActors2D (vtkPropCollection pc)
 For some exporters and other other operations we must be able to collect all the actors or volumes. These methods are used in that process.
virtual vtkCoordinate GetActualPosition2Coordinate ()
 Return the actual vtkCoordinate reference that the mapper should use to position the actor. This is used internally by the mappers and should be overridden in specialized subclasses and otherwise ignored.
virtual vtkCoordinate GetActualPositionCoordinate ()
 Return the actual vtkCoordinate reference that the mapper should use to position the actor. This is used internally by the mappers and should be overridden in specialized subclasses and otherwise ignored.
double GetHeight ()
 Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
virtual int GetLayerNumber ()
 Set/Get the layer number in the overlay planes into which to render.
override uint GetMTime ()
 Return this objects MTime.
virtual vtkMapper2D GetMapper ()
 Set/Get the vtkMapper2D which defines the data to be drawn.
virtual double[] GetPosition ()
 Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D
virtual double[] GetPosition2 ()
 Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable
virtual vtkCoordinate GetPosition2Coordinate ()
 Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable
virtual vtkCoordinate GetPositionCoordinate ()
 Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D
vtkProperty2D GetProperty ()
 Returns this actor's vtkProperty2D. Creates a property if one doesn't already exist.
double GetWidth ()
 Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
void SetDisplayPosition (int arg0, int arg1)
 Set the Prop2D's position in display coordinates.
void SetHeight (double h)
 Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
virtual void SetLayerNumber (int _arg)
 Set/Get the layer number in the overlay planes into which to render.
virtual void SetMapper (vtkMapper2D mapper)
 Set/Get the vtkMapper2D which defines the data to be drawn.
virtual void SetPosition (IntPtr x)
 Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D
virtual void SetPosition (double x, double y)
 Get the PositionCoordinate instance of vtkCoordinate. This is used for for complicated or relative positioning. The position variable controls the lower left corner of the Actor2D
virtual void SetPosition2 (IntPtr x)
 Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable
virtual void SetPosition2 (double x, double y)
 Access the Position2 instance variable. This variable controls the upper right corner of the Actor2D. It is by default relative to Position and in normalized viewport coordinates. Some 2D actor subclasses ignore the position2 variable
virtual void SetProperty (vtkProperty2D arg0)
 Set this vtkProp's vtkProperty2D.
void SetWidth (double w)
 Set/Get the height and width of the Actor2D. The value is expressed as a fraction of the viewport. This really is just another way of setting the Position2 instance variable.
- Public Member Functions inherited from Kitware.VTK.vtkProp
 vtkProp (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
void AddConsumer (vtkObject c)
 Tells if the prop has all the required keys.
virtual void AddEstimatedRenderTime (double t, vtkViewport arg1)
 Tells if the prop has all the required keys.
virtual void BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
 Tells if the prop has all the required keys.
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.
virtual void GetActors (vtkPropCollection arg0)
 For some exporters and other other operations we must be able to collect all the actors or volumes. These methods are used in that process.
virtual double GetAllocatedRenderTime ()
 Tells if the prop has all the required keys.
virtual double[] GetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). in world coordinates. NULL means that the bounds are not defined.
vtkObject GetConsumer (int i)
 Tells if the prop has all the required keys.
virtual int GetDragable ()
 Set/Get the value of the dragable instance variable. This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.
virtual double GetEstimatedRenderTime (vtkViewport arg0)
 Tells if the prop has all the required keys.
virtual double GetEstimatedRenderTime ()
 Tells if the prop has all the required keys.
virtual vtkMatrix4x4 GetMatrix ()
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. Generally used only for picking. See vtkProp3D for more information.
virtual vtkAssemblyPath GetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.
virtual int GetNumberOfConsumers ()
 Tells if the prop has all the required keys.
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.
virtual int GetPickable ()
 Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.
virtual vtkInformation GetPropertyKeys ()
 Set/Get property keys. Property keys can be digest by some rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow mapping render pass. Keys are documented in render pass classes. Initial value is NULL.
virtual uint GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, textures etc.
virtual double GetRenderTimeMultiplier ()
 Tells if the prop has all the required keys.
virtual bool GetSupportsSelection ()
 Tells if the prop has all the required keys.
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(). Initial value is true.
virtual int GetVisibility ()
 Set/Get visibility of this vtkProp. Initial value is true.
virtual void GetVolumes (vtkPropCollection arg0)
 For some exporters and other other operations we must be able to collect all the actors or volumes. These methods are used in that process.
virtual bool HasKeys (vtkInformation requiredKeys)
 Tells if the prop has all the required keys.
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). The following methods interface with the picking classes and return "pick paths". A pick path is a hierarchical, ordered list of props that form an assembly. Most often, when a vtkProp is picked, its path consists of a single node (i.e., the prop). However, classes like vtkAssembly and vtkPropAssembly can return more than one path, each path being several layers deep. (See vtkAssemblyPath for more information.) To use these methods - first invoke InitPathTraversal() followed by repeated calls to GetNextPath(). GetNextPath() returns a NULL pointer when the list is exhausted.
int IsConsumer (vtkObject c)
 Tells if the prop has all the required keys.
virtual void Pick ()
 Method fires PickEvent if the prop is picked.
virtual void PickableOff ()
 Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.
virtual void PickableOn ()
 Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.
virtual void PokeMatrix (vtkMatrix4x4 arg0)
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. Generally used only for picking. See vtkProp3D for more information.
void RemoveConsumer (vtkObject c)
 Tells if the prop has all the required keys.
virtual bool RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
 Tells if the prop has all the required keys.
virtual bool RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
 Tells if the prop has all the required keys.
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
 Tells if the prop has all the required keys.
virtual bool RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
 Tells if the prop has all the required keys.
virtual int RenderVolumetricGeometry (vtkViewport arg0)
 Tells if the prop has all the required keys.
virtual void RestoreEstimatedRenderTime ()
 Tells if the prop has all the required keys.
virtual void SetAllocatedRenderTime (double t, vtkViewport arg1)
 Tells if the prop has all the required keys.
virtual void SetDragable (int _arg)
 Set/Get the value of the dragable instance variable. This determines if an Prop, once picked, can be dragged (translated) through space. This is typically done through an interactive mouse interface. This does not affect methods such as SetPosition, which will continue to work. It is just intended to prevent some vtkProp'ss from being dragged from within a user interface. Initial value is true.
virtual void SetEstimatedRenderTime (double t)
 Tells if the prop has all the required keys.
virtual void SetPickable (int _arg)
 Set/Get the pickable instance variable. This determines if the vtkProp can be picked (typically using the mouse). Also see dragable. Initial value is true.
virtual void SetPropertyKeys (vtkInformation keys)
 Set/Get property keys. Property keys can be digest by some rendering passes. For instance, the user may mark a prop as a shadow caster for a shadow mapping render pass. Keys are documented in render pass classes. Initial value is NULL.
void SetRenderTimeMultiplier (double t)
 Tells if the prop has all the required keys.
virtual void SetUseBounds (bool _arg)
 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(). Initial value is true.
virtual void SetVisibility (int _arg)
 Set/Get visibility of this vtkProp. Initial value is true.
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(). Initial value is true.
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(). Initial value is true.
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. Initial value is true.
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. Initial value is true.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkCaptionActor2D New ()
 Undocumented Block
static new int IsTypeOf (string type)
 Undocumented Block
static new vtkCaptionActor2D SafeDownCast (vtkObjectBase o)
 Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCaptionActor2D"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkActor2D
new const string MRFullTypeName = "Kitware.VTK.vtkActor2D"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkProp
new const string MRFullTypeName = "Kitware.VTK.vtkProp"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkObject
new const string MRFullTypeName = "Kitware.VTK.vtkObject"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
new const string MRFullTypeName = "Kitware.VTK.vtkObjectBase"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkCaptionActor2D"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkActor2D
static new readonly string MRClassNameKey = "10vtkActor2D"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkProp
static new readonly string MRClassNameKey = "7vtkProp"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkObject
static new readonly string MRClassNameKey = "9vtkObject"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase
static new readonly string MRClassNameKey = "13vtkObjectBase"
 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.

Static Private Member Functions

static vtkCaptionActor2D ()
 Automatically generated type registration mechanics.

Additional Inherited Members

- Properties inherited from Kitware.VTK.vtkObject
Kitware.VTK.vtkObject.vtkObjectEventHandler AbortCheckEvt
 The AbortCheckEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AbortCheckEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler AnimationCueTickEvt
 The AnimationCueTickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AnimationCueTickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler AnyEvt
 The AnyEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AnyEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CharEvt
 The CharEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CharEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConfigureEvt
 The ConfigureEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConfigureEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConnectionClosedEvt
 The ConnectionClosedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConnectionClosedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConnectionCreatedEvt
 The ConnectionCreatedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConnectionCreatedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CreateTimerEvt
 The CreateTimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CreateTimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CursorChangedEvt
 The CursorChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CursorChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DeleteEvt
 The DeleteEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DeleteEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DestroyTimerEvt
 The DestroyTimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DestroyTimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DisableEvt
 The DisableEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DisableEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DomainModifiedEvt
 The DomainModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DomainModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EnableEvt
 The EnableEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EnableEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndAnimationCueEvt
 The EndAnimationCueEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndAnimationCueEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndEvt
 The EndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndInteractionEvt
 The EndInteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndInteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndPickEvt
 The EndPickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndPickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndWindowLevelEvt
 The EndWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EnterEvt
 The EnterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EnterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ErrorEvt
 The ErrorEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ErrorEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExecuteInformationEvt
 The ExecuteInformationEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExecuteInformationEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExitEvt
 The ExitEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExitEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExposeEvt
 The ExposeEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExposeEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler InteractionEvt
 The InteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.InteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler KeyPressEvt
 The KeyPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.KeyPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler KeyReleaseEvt
 The KeyReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.KeyReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeaveEvt
 The LeaveEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeaveEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeftButtonPressEvt
 The LeftButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeftButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeftButtonReleaseEvt
 The LeftButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeftButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MiddleButtonPressEvt
 The MiddleButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MiddleButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MiddleButtonReleaseEvt
 The MiddleButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MiddleButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ModifiedEvt
 The ModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseMoveEvt
 The MouseMoveEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseMoveEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseWheelBackwardEvt
 The MouseWheelBackwardEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseWheelBackwardEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseWheelForwardEvt
 The MouseWheelForwardEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseWheelForwardEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PickEvt
 The PickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PlacePointEvt
 The PlacePointEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PlacePointEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PlaceWidgetEvt
 The PlaceWidgetEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PlaceWidgetEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ProgressEvt
 The ProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PropertyModifiedEvt
 The PropertyModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PropertyModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RegisterEvt
 The RegisterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RegisterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RenderEvt
 The RenderEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RenderEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RenderWindowMessageEvt
 The RenderWindowMessageEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RenderWindowMessageEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetCameraClippingRangeEvt
 The ResetCameraClippingRangeEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetCameraClippingRangeEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetCameraEvt
 The ResetCameraEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetCameraEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetWindowLevelEvt
 The ResetWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RightButtonPressEvt
 The RightButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RightButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RightButtonReleaseEvt
 The RightButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RightButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler SelectionChangedEvt
 The SelectionChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.SelectionChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler SetOutputEvt
 The SetOutputEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.SetOutputEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartAnimationCueEvt
 The StartAnimationCueEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartAnimationCueEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartEvt
 The StartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartInteractionEvt
 The StartInteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartInteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartPickEvt
 The StartPickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartPickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartWindowLevelEvt
 The StartWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler TimerEvt
 The TimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.TimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UnRegisterEvt
 The UnRegisterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UnRegisterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdateEvt
 The UpdateEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdateEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdateInformationEvt
 The UpdateInformationEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdateInformationEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdatePropertyEvt
 The UpdatePropertyEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdatePropertyEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsEndEvt
 The VolumeMapperComputeGradientsEndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsEndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsProgressEvt
 The VolumeMapperComputeGradientsProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsStartEvt
 The VolumeMapperComputeGradientsStartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsStartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderEndEvt
 The VolumeMapperRenderEndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderEndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderProgressEvt
 The VolumeMapperRenderProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderStartEvt
 The VolumeMapperRenderStartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderStartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WarningEvt
 The WarningEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WarningEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetActivateEvt
 The WidgetActivateEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetActivateEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetModifiedEvt
 The WidgetModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetValueChangedEvt
 The WidgetValueChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetValueChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WindowLevelEvt
 The WindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WrongTagEvt
 The WrongTagEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WrongTagEvent as the eventId parameter.

Detailed Description

vtkCaptionActor2D - draw text label associated with a point

Description vtkCaptionActor2D is a hybrid 2D/3D actor that is used to associate text with a point (the AttachmentPoint) in the scene. The caption can be drawn with a rectangular border and a leader connecting the caption to the attachment point. Optionally, the leader can be glyphed at its endpoint to create arrow heads or other indicators.

To use the caption actor, you normally specify the Position and Position2 coordinates (these are inherited from the vtkActor2D superclass). (Note that Position2 can be set using vtkActor2D's SetWidth() and SetHeight() methods.) Position and Position2 define the size of the caption, and a third point, the AttachmentPoint, defines a point that the caption is associated with. You must also define the caption text, whether you want a border around the caption, and whether you want a leader from the caption to the attachment point. The font attributes of the text can be set through the vtkTextProperty associated to this actor. You also indicate whether you want the leader to be 2D or 3D. (2D leaders are always drawn over the underlying geometry. 3D leaders may be occluded by the geometry.) The leader may also be terminated by an optional glyph (e.g., arrow).

The trickiest part about using this class is setting Position, Position2, and AttachmentPoint correctly. These instance variables are vtkCoordinates, and can be set up in various ways. In default usage, the AttachmentPoint is defined in the world coordinate system, Position is the lower-left corner of the caption and relative to AttachmentPoint (defined in display coordaintes, i.e., pixels), and Position2 is relative to Position and is the upper-right corner (also in display coordinates). However, the user has full control over the coordinates, and can do things like place the caption in a fixed position in the renderer, with the leader moving with the AttachmentPoint.

Constructor & Destructor Documentation

static Kitware.VTK.vtkCaptionActor2D.vtkCaptionActor2D ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkCaptionActor2D.vtkCaptionActor2D ( )

Undocumented Block

Member Function Documentation

virtual void Kitware.VTK.vtkCaptionActor2D.AttachEdgeOnlyOff ( )
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

virtual void Kitware.VTK.vtkCaptionActor2D.AttachEdgeOnlyOn ( )
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

virtual void Kitware.VTK.vtkCaptionActor2D.BorderOff ( )
virtual

Enable/disable the placement of a border around the text.

virtual void Kitware.VTK.vtkCaptionActor2D.BorderOn ( )
virtual

Enable/disable the placement of a border around the text.

override void Kitware.VTK.vtkCaptionActor2D.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.vtkActor2D.

virtual int Kitware.VTK.vtkCaptionActor2D.GetAttachEdgeOnly ( )
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

virtual double [] Kitware.VTK.vtkCaptionActor2D.GetAttachmentPoint ( )
virtual

Set/Get the attachment point for the caption. By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.

virtual vtkCoordinate Kitware.VTK.vtkCaptionActor2D.GetAttachmentPointCoordinate ( )
virtual

Set/Get the attachment point for the caption. By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkCaptionActor2D.GetBorder ( )
virtual

Enable/disable the placement of a border around the text.

virtual string Kitware.VTK.vtkCaptionActor2D.GetCaption ( )
virtual

Define the text to be placed in the caption. The text can be multiple lines (separated by "
").

virtual vtkTextProperty Kitware.VTK.vtkCaptionActor2D.GetCaptionTextProperty ( )
virtual

Set/Get the text property.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkCaptionActor2D.GetLeader ( )
virtual

Enable/disable drawing a "line" from the caption to the attachment point.

virtual vtkPolyData Kitware.VTK.vtkCaptionActor2D.GetLeaderGlyph ( )
virtual

Specify a glyph to be used as the leader "head". This could be something like an arrow or sphere. If not specified, no glyph is drawn. Note that the glyph is assumed to be aligned along the x-axis and is rotated about the origin.

Here is the call graph for this function:

virtual double Kitware.VTK.vtkCaptionActor2D.GetLeaderGlyphSize ( )
virtual

Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.

virtual double Kitware.VTK.vtkCaptionActor2D.GetLeaderGlyphSizeMaxValue ( )
virtual

Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.

virtual double Kitware.VTK.vtkCaptionActor2D.GetLeaderGlyphSizeMinValue ( )
virtual

Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.

virtual int Kitware.VTK.vtkCaptionActor2D.GetMaximumLeaderGlyphSize ( )
virtual

Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.

virtual int Kitware.VTK.vtkCaptionActor2D.GetMaximumLeaderGlyphSizeMaxValue ( )
virtual

Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.

virtual int Kitware.VTK.vtkCaptionActor2D.GetMaximumLeaderGlyphSizeMinValue ( )
virtual

Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.

virtual int Kitware.VTK.vtkCaptionActor2D.GetPadding ( )
virtual

Set/Get the padding between the caption and the border. The value is specified in pixels.

virtual int Kitware.VTK.vtkCaptionActor2D.GetPaddingMaxValue ( )
virtual

Set/Get the padding between the caption and the border. The value is specified in pixels.

virtual int Kitware.VTK.vtkCaptionActor2D.GetPaddingMinValue ( )
virtual

Set/Get the padding between the caption and the border. The value is specified in pixels.

virtual vtkTextActor Kitware.VTK.vtkCaptionActor2D.GetTextActor ( )
virtual

Get the text actor used by the caption. This is useful if you want to control justification and other characteristics of the text actor.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkCaptionActor2D.GetThreeDimensionalLeader ( )
virtual

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

override int Kitware.VTK.vtkCaptionActor2D.HasTranslucentPolygonalGeometry ( )
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkCaptionActor2D.IsA ( string  type)
virtual

Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

static new int Kitware.VTK.vtkCaptionActor2D.IsTypeOf ( string  type)
static

Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

virtual void Kitware.VTK.vtkCaptionActor2D.LeaderOff ( )
virtual

Enable/disable drawing a "line" from the caption to the attachment point.

virtual void Kitware.VTK.vtkCaptionActor2D.LeaderOn ( )
virtual

Enable/disable drawing a "line" from the caption to the attachment point.

static new vtkCaptionActor2D Kitware.VTK.vtkCaptionActor2D.New ( )
static

Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

new vtkCaptionActor2D Kitware.VTK.vtkCaptionActor2D.NewInstance ( )

Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

override void Kitware.VTK.vtkCaptionActor2D.ReleaseGraphicsResources ( vtkWindow  arg0)
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkCaptionActor2D.RenderOpaqueGeometry ( vtkViewport  viewport)
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkCaptionActor2D.RenderOverlay ( vtkViewport  viewport)
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkCaptionActor2D.RenderTranslucentPolygonalGeometry ( vtkViewport  arg0)
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

Reimplemented from Kitware.VTK.vtkActor2D.

static new vtkCaptionActor2D Kitware.VTK.vtkCaptionActor2D.SafeDownCast ( vtkObjectBase  o)
static

Undocumented Block

Reimplemented from Kitware.VTK.vtkActor2D.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkCaptionActor2D.SetAttachEdgeOnly ( int  _arg)
virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

virtual void Kitware.VTK.vtkCaptionActor2D.SetAttachmentPoint ( IntPtr  x)
virtual

Set/Get the attachment point for the caption. By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.

virtual void Kitware.VTK.vtkCaptionActor2D.SetAttachmentPoint ( double  x,
double  y,
double  z 
)
virtual

Set/Get the attachment point for the caption. By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.

virtual void Kitware.VTK.vtkCaptionActor2D.SetBorder ( int  _arg)
virtual

Enable/disable the placement of a border around the text.

virtual void Kitware.VTK.vtkCaptionActor2D.SetCaption ( string  caption)
virtual

Define the text to be placed in the caption. The text can be multiple lines (separated by "
").

virtual void Kitware.VTK.vtkCaptionActor2D.SetCaptionTextProperty ( vtkTextProperty  p)
virtual

Set/Get the text property.

virtual void Kitware.VTK.vtkCaptionActor2D.SetLeader ( int  _arg)
virtual

Enable/disable drawing a "line" from the caption to the attachment point.

virtual void Kitware.VTK.vtkCaptionActor2D.SetLeaderGlyph ( vtkPolyData  arg0)
virtual

Specify a glyph to be used as the leader "head". This could be something like an arrow or sphere. If not specified, no glyph is drawn. Note that the glyph is assumed to be aligned along the x-axis and is rotated about the origin.

virtual void Kitware.VTK.vtkCaptionActor2D.SetLeaderGlyphSize ( double  _arg)
virtual

Specify the relative size of the leader head. This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.

virtual void Kitware.VTK.vtkCaptionActor2D.SetMaximumLeaderGlyphSize ( int  _arg)
virtual

Specify the maximum size of the leader head (if any) in pixels. This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.

virtual void Kitware.VTK.vtkCaptionActor2D.SetPadding ( int  _arg)
virtual

Set/Get the padding between the caption and the border. The value is specified in pixels.

virtual void Kitware.VTK.vtkCaptionActor2D.SetThreeDimensionalLeader ( int  _arg)
virtual

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

override void Kitware.VTK.vtkCaptionActor2D.ShallowCopy ( vtkProp  prop)
virtual

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkActor2D.

virtual void Kitware.VTK.vtkCaptionActor2D.ThreeDimensionalLeaderOff ( )
virtual

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

virtual void Kitware.VTK.vtkCaptionActor2D.ThreeDimensionalLeaderOn ( )
virtual

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

Member Data Documentation

new readonly string Kitware.VTK.vtkCaptionActor2D.MRClassNameKey = "17vtkCaptionActor2D"
static

Automatically generated type registration mechanics.

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

Automatically generated type registration mechanics.


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