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

vtkTextActor - An actor that displays text. Scaled or unscaled More...

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

List of all members.

Public Types

enum  TEXT_SCALE_MODE_NONE_WrapperEnum { TEXT_SCALE_MODE_NONE = 0, TEXT_SCALE_MODE_PROP = 1, TEXT_SCALE_MODE_VIEWPORT = 2 }
 Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in. More...

Public Member Functions

 vtkTextActor (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTextActor ()
 Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
virtual void ComputeScaledFont (vtkViewport viewport)
 Compute the scale the font should be given the viewport. The result is placed in the ScaledTextProperty ivar.
void DisplayToSpecified (IntPtr pos, vtkViewport vport, int specified)
 This is just a simple coordinate conversion method used in the render process.
int GetAlignmentPoint ()
 This method is being depricated. Use SetJustification and SetVerticalJustification in text property instead. Set/Get the Alignment point if zero (default), the text aligns itself to the bottom left corner (which is defined by the PositionCoordinate) otherwise the text aligns itself to corner/midpoint or centre.
string GetInput ()
 Set the text string to be displayed. "
" is recognized as a carriage return/linefeed (line separator). The characters must be in the ISO-8859-1 encoding. Convenience method to the underlying mapper.
virtual float GetMaximumLineHeight ()
 Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0. Only valid when TextScaleMode is PROP.
virtual int[] GetMinimumSize ()
 Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.
virtual void GetMinimumSize (ref int _arg1, ref int _arg2)
 Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.
virtual void GetMinimumSize (IntPtr _arg)
 Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.
virtual float GetOrientation ()
 Counterclockwise rotation around the Alignment point. Units are in degrees and defaults to 0. The orientation in the text property rotates the text in the texture map. It will proba ly not give you the effect you desire.
virtual vtkTextProperty GetScaledTextProperty ()
 Get the scaled font. Use ComputeScaledFont to set the scale for a given viewport.
virtual vtkTextProperty GetTextProperty ()
 Set/Get the text property.
virtual int GetTextScaleMode ()
 Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
virtual int GetTextScaleModeMaxValue ()
 Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
virtual int GetTextScaleModeMinValue ()
 Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
virtual int GetUseBorderAlign ()
 Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation.
override int HasTranslucentPolygonalGeometry ()
 Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.
override int IsA (string type)
 Undocumented Block.
new vtkTextActor NewInstance ()
 Undocumented Block.
override void ReleaseGraphicsResources (vtkWindow arg0)
 Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.
override int RenderOpaqueGeometry (vtkViewport viewport)
 Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.
override int RenderOverlay (vtkViewport viewport)
 Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.
override int RenderTranslucentPolygonalGeometry (vtkViewport arg0)
 Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.
void SetAlignmentPoint (int point)
 This method is being depricated. Use SetJustification and SetVerticalJustification in text property instead. Set/Get the Alignment point if zero (default), the text aligns itself to the bottom left corner (which is defined by the PositionCoordinate) otherwise the text aligns itself to corner/midpoint or centre.
void SetInput (string inputString)
 Set the text string to be displayed. "
" is recognized as a carriage return/linefeed (line separator). The characters must be in the ISO-8859-1 encoding. Convenience method to the underlying mapper.
void SetMapper (vtkPolyDataMapper2D mapper)
 Override the vtkPolyDataMapper2D that defines the text to be drawn. One will be created by default if none is supplied.
virtual void SetMaximumLineHeight (float _arg)
 Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0. Only valid when TextScaleMode is PROP.
virtual void SetMinimumSize (int _arg1, int _arg2)
 Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.
void SetMinimumSize (IntPtr _arg)
 Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.
virtual void SetNonLinearFontScale (double exponent, int target)
 Enable non-linear scaling of font sizes. This is useful in combination with scaled text. With small windows you want to use the entire scaled text area. With larger windows you want to reduce the font size some so that the entire area is not used. These values modify the computed font size as follows: newFontSize = pow(FontSize,exponent)*pow(target,1.0 - exponent) typically exponent should be around 0.7 and target should be around 10.
void SetOrientation (float orientation)
 Counterclockwise rotation around the Alignment point. Units are in degrees and defaults to 0. The orientation in the text property rotates the text in the texture map. It will proba ly not give you the effect you desire.
virtual void SetTextProperty (vtkTextProperty p)
 Set/Get the text property.
virtual void SetTextScaleMode (int _arg)
 Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
void SetTextScaleModeToNone ()
 Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
void SetTextScaleModeToProp ()
 Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
void SetTextScaleModeToViewport ()
 Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.
virtual void SetUseBorderAlign (int _arg)
 Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation.
override void ShallowCopy (vtkProp prop)
 Shallow copy of this text actor. Overloads the virtual vtkProp method.
void SpecifiedToDisplay (IntPtr pos, vtkViewport vport, int specified)
 This is just a simple coordinate conversion method used in the render process.
virtual void UseBorderAlignOff ()
 Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation.
virtual void UseBorderAlignOn ()
 Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation.

Static Public Member Functions

static new vtkTextActor New ()
 Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
static float GetFontScale (vtkViewport viewport)
 Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkTextActor SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "12vtkTextActor"
 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 vtkTextActor_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTextActor_ComputeScaledFont_01 (HandleRef pThis, HandleRef viewport)
static internal void vtkTextActor_DisplayToSpecified_02 (HandleRef pThis, IntPtr pos, HandleRef vport, int specified)
static internal int vtkTextActor_GetAlignmentPoint_03 (HandleRef pThis)
static internal float vtkTextActor_GetFontScale_04 (HandleRef viewport)
static internal IntPtr vtkTextActor_GetInput_05 (HandleRef pThis)
static internal float vtkTextActor_GetMaximumLineHeight_06 (HandleRef pThis)
static internal IntPtr vtkTextActor_GetMinimumSize_07 (HandleRef pThis)
static internal void vtkTextActor_GetMinimumSize_08 (HandleRef pThis, ref int _arg1, ref int _arg2)
static internal void vtkTextActor_GetMinimumSize_09 (HandleRef pThis, IntPtr _arg)
static internal float vtkTextActor_GetOrientation_10 (HandleRef pThis)
static internal IntPtr vtkTextActor_GetScaledTextProperty_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTextActor_GetTextProperty_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkTextActor_GetTextScaleMode_13 (HandleRef pThis)
static internal int vtkTextActor_GetTextScaleModeMaxValue_14 (HandleRef pThis)
static internal int vtkTextActor_GetTextScaleModeMinValue_15 (HandleRef pThis)
static internal int vtkTextActor_GetUseBorderAlign_16 (HandleRef pThis)
static internal int vtkTextActor_HasTranslucentPolygonalGeometry_17 (HandleRef pThis)
static internal int vtkTextActor_IsA_18 (HandleRef pThis, string type)
static internal int vtkTextActor_IsTypeOf_19 (string type)
static internal IntPtr vtkTextActor_NewInstance_21 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTextActor_ReleaseGraphicsResources_22 (HandleRef pThis, HandleRef arg0)
static internal int vtkTextActor_RenderOpaqueGeometry_23 (HandleRef pThis, HandleRef viewport)
static internal int vtkTextActor_RenderOverlay_24 (HandleRef pThis, HandleRef viewport)
static internal int vtkTextActor_RenderTranslucentPolygonalGeometry_25 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkTextActor_SafeDownCast_26 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTextActor_SetAlignmentPoint_27 (HandleRef pThis, int point)
static internal void vtkTextActor_SetInput_28 (HandleRef pThis, string inputString)
static internal void vtkTextActor_SetMapper_29 (HandleRef pThis, HandleRef mapper)
static internal void vtkTextActor_SetMaximumLineHeight_30 (HandleRef pThis, float _arg)
static internal void vtkTextActor_SetMinimumSize_31 (HandleRef pThis, int _arg1, int _arg2)
static internal void vtkTextActor_SetMinimumSize_32 (HandleRef pThis, IntPtr _arg)
static internal void vtkTextActor_SetNonLinearFontScale_33 (HandleRef pThis, double exponent, int target)
static internal void vtkTextActor_SetOrientation_34 (HandleRef pThis, float orientation)
static internal void vtkTextActor_SetTextProperty_35 (HandleRef pThis, HandleRef p)
static internal void vtkTextActor_SetTextScaleMode_36 (HandleRef pThis, int _arg)
static internal void vtkTextActor_SetTextScaleModeToNone_37 (HandleRef pThis)
static internal void vtkTextActor_SetTextScaleModeToProp_38 (HandleRef pThis)
static internal void vtkTextActor_SetTextScaleModeToViewport_39 (HandleRef pThis)
static internal void vtkTextActor_SetUseBorderAlign_40 (HandleRef pThis, int _arg)
static internal void vtkTextActor_ShallowCopy_41 (HandleRef pThis, HandleRef prop)
static internal void vtkTextActor_SpecifiedToDisplay_42 (HandleRef pThis, IntPtr pos, HandleRef vport, int specified)
static internal void vtkTextActor_UseBorderAlignOff_43 (HandleRef pThis)
static internal void vtkTextActor_UseBorderAlignOn_44 (HandleRef pThis)

Static Private Member Functions

static vtkTextActor ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTextActor - An actor that displays text. Scaled or unscaled

Description vtkTextActor can be used to place text annotation into a window. When TextScaleMode is NONE, the text is fixed font and operation is the same as a vtkPolyDataMapper2D/vtkActor2D pair. When TextScaleMode is VIEWPORT, the font resizes such that it maintains a consistent size relative to the viewport in which it is rendered. When TextScaleMode is PROP, the font resizes such that the text fits inside the box defined by the position 1 & 2 coordinates. This class replaces the deprecated vtkScaledTextActor and acts as a convenient wrapper for a vtkTextMapper/vtkActor2D pair. Set the text property/attributes through the vtkTextProperty associated to this actor.

vtkActor2D vtkPolyDataMapper vtkTextProperty vtkFreeTypeUtilities


Member Enumeration Documentation

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Enumerator:
TEXT_SCALE_MODE_NONE 

enum member

TEXT_SCALE_MODE_PROP 

enum member

TEXT_SCALE_MODE_VIEWPORT 

enum member


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).


Member Function Documentation

virtual void Kitware.VTK.vtkTextActor.ComputeScaledFont ( vtkViewport  viewport) [virtual]

Compute the scale the font should be given the viewport. The result is placed in the ScaledTextProperty ivar.

void Kitware.VTK.vtkTextActor.DisplayToSpecified ( IntPtr  pos,
vtkViewport  vport,
int  specified 
)

This is just a simple coordinate conversion method used in the render process.

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

Reimplemented in Kitware.VTK.vtkScaledTextActor.

This method is being depricated. Use SetJustification and SetVerticalJustification in text property instead. Set/Get the Alignment point if zero (default), the text aligns itself to the bottom left corner (which is defined by the PositionCoordinate) otherwise the text aligns itself to corner/midpoint or centre.

   ///      6   7   8
   ///      3   4   5
   ///      0   1   2
   /// 

This is the same as setting the TextProperty's justification. Currently TextActor is not oriented around its AlignmentPoint.

static float Kitware.VTK.vtkTextActor.GetFontScale ( vtkViewport  viewport) [static]

Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.

Set the text string to be displayed. "
" is recognized as a carriage return/linefeed (line separator). The characters must be in the ISO-8859-1 encoding. Convenience method to the underlying mapper.

virtual float Kitware.VTK.vtkTextActor.GetMaximumLineHeight ( ) [virtual]

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0. Only valid when TextScaleMode is PROP.

virtual int [] Kitware.VTK.vtkTextActor.GetMinimumSize ( ) [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

virtual void Kitware.VTK.vtkTextActor.GetMinimumSize ( ref int  _arg1,
ref int  _arg2 
) [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

virtual void Kitware.VTK.vtkTextActor.GetMinimumSize ( IntPtr  _arg) [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

virtual float Kitware.VTK.vtkTextActor.GetOrientation ( ) [virtual]

Counterclockwise rotation around the Alignment point. Units are in degrees and defaults to 0. The orientation in the text property rotates the text in the texture map. It will proba ly not give you the effect you desire.

Get the scaled font. Use ComputeScaledFont to set the scale for a given viewport.

Here is the call graph for this function:

Set/Get the text property.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkTextActor.GetTextScaleMode ( ) [virtual]

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

virtual int Kitware.VTK.vtkTextActor.GetUseBorderAlign ( ) [virtual]

Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation.

Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.

Reimplemented from Kitware.VTK.vtkActor2D.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

Reimplemented in Kitware.VTK.vtkScaledTextActor.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

Reimplemented in Kitware.VTK.vtkScaledTextActor.

static new vtkTextActor Kitware.VTK.vtkTextActor.New ( ) [static]

Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).

Reimplemented from Kitware.VTK.vtkActor2D.

Reimplemented in Kitware.VTK.vtkScaledTextActor.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

Reimplemented in Kitware.VTK.vtkScaledTextActor.

Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkTextActor.RenderOpaqueGeometry ( vtkViewport  viewport) [virtual]

Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.

Reimplemented from Kitware.VTK.vtkActor2D.

override int Kitware.VTK.vtkTextActor.RenderOverlay ( vtkViewport  viewport) [virtual]

Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.

Reimplemented from Kitware.VTK.vtkActor2D.

Provide a font scaling based on a viewport. This is the scaling factor used when the TextScaleMode is set to VIEWPORT and has been made public for other components to use. This scaling assumes that the long dimension of the viewport is meant to be 6 inches (a typical width of text in a paper) and then resizes based on if that long dimension was 72 DPI.

Reimplemented from Kitware.VTK.vtkActor2D.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

Reimplemented in Kitware.VTK.vtkScaledTextActor.

Here is the call graph for this function:

This method is being depricated. Use SetJustification and SetVerticalJustification in text property instead. Set/Get the Alignment point if zero (default), the text aligns itself to the bottom left corner (which is defined by the PositionCoordinate) otherwise the text aligns itself to corner/midpoint or centre.

   ///      6   7   8
   ///      3   4   5
   ///      0   1   2
   /// 

This is the same as setting the TextProperty's justification. Currently TextActor is not oriented around its AlignmentPoint.

void Kitware.VTK.vtkTextActor.SetInput ( string  inputString)

Set the text string to be displayed. "
" is recognized as a carriage return/linefeed (line separator). The characters must be in the ISO-8859-1 encoding. Convenience method to the underlying mapper.

Override the vtkPolyDataMapper2D that defines the text to be drawn. One will be created by default if none is supplied.

virtual void Kitware.VTK.vtkTextActor.SetMaximumLineHeight ( float  _arg) [virtual]

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0. Only valid when TextScaleMode is PROP.

virtual void Kitware.VTK.vtkTextActor.SetMinimumSize ( int  _arg1,
int  _arg2 
) [virtual]

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

Set/Get the minimum size in pixels for this actor. Defaults to 10,10. Only valid when TextScaleMode is PROP.

virtual void Kitware.VTK.vtkTextActor.SetNonLinearFontScale ( double  exponent,
int  target 
) [virtual]

Enable non-linear scaling of font sizes. This is useful in combination with scaled text. With small windows you want to use the entire scaled text area. With larger windows you want to reduce the font size some so that the entire area is not used. These values modify the computed font size as follows: newFontSize = pow(FontSize,exponent)*pow(target,1.0 - exponent) typically exponent should be around 0.7 and target should be around 10.

void Kitware.VTK.vtkTextActor.SetOrientation ( float  orientation)

Counterclockwise rotation around the Alignment point. Units are in degrees and defaults to 0. The orientation in the text property rotates the text in the texture map. It will proba ly not give you the effect you desire.

Set/Get the text property.

virtual void Kitware.VTK.vtkTextActor.SetTextScaleMode ( int  _arg) [virtual]

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

Set how text should be scaled. If set to vtkTextActor::TEXT_SCALE_MODE_NONE, the the font size will be fixed by the size given in TextProperty. If set to vtkTextActor::TEXT_SCALE_MODE_PROP, the text will be scaled to fit exactly in the prop as specified by the position 1 & 2 coordinates. If set to vtkTextActor::TEXT_SCALE_MODE_VIEWPORT, the text will be scaled based on the size of the viewport it is displayed in.

virtual void Kitware.VTK.vtkTextActor.SetUseBorderAlign ( int  _arg) [virtual]

Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation.

override void Kitware.VTK.vtkTextActor.ShallowCopy ( vtkProp  prop) [virtual]

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

Reimplemented from Kitware.VTK.vtkActor2D.

void Kitware.VTK.vtkTextActor.SpecifiedToDisplay ( IntPtr  pos,
vtkViewport  vport,
int  specified 
)

This is just a simple coordinate conversion method used in the render process.

virtual void Kitware.VTK.vtkTextActor.UseBorderAlignOff ( ) [virtual]

Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation.

virtual void Kitware.VTK.vtkTextActor.UseBorderAlignOn ( ) [virtual]

Turn on or off the UseBorderAlign option. When UseBorderAlign is on, the bounding rectangle is used to align the text, which is the proper behavior when using vtkTextRepresentation.

static internal void Kitware.VTK.vtkTextActor.vtkTextActor_ComputeScaledFont_01 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_DisplayToSpecified_02 ( HandleRef  pThis,
IntPtr  pos,
HandleRef  vport,
int  specified 
) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_GetAlignmentPoint_03 ( HandleRef  pThis) [private]
static internal float Kitware.VTK.vtkTextActor.vtkTextActor_GetFontScale_04 ( HandleRef  viewport) [private]
static internal IntPtr Kitware.VTK.vtkTextActor.vtkTextActor_GetInput_05 ( HandleRef  pThis) [private]
static internal float Kitware.VTK.vtkTextActor.vtkTextActor_GetMaximumLineHeight_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTextActor.vtkTextActor_GetMinimumSize_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_GetMinimumSize_08 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_GetMinimumSize_09 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal float Kitware.VTK.vtkTextActor.vtkTextActor_GetOrientation_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTextActor.vtkTextActor_GetScaledTextProperty_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTextActor.vtkTextActor_GetTextProperty_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_GetTextScaleMode_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_GetTextScaleModeMaxValue_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_GetTextScaleModeMinValue_15 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_GetUseBorderAlign_16 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_HasTranslucentPolygonalGeometry_17 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_IsA_18 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_IsTypeOf_19 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkTextActor.vtkTextActor_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTextActor.vtkTextActor_NewInstance_21 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_ReleaseGraphicsResources_22 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_RenderOpaqueGeometry_23 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_RenderOverlay_24 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal int Kitware.VTK.vtkTextActor.vtkTextActor_RenderTranslucentPolygonalGeometry_25 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkTextActor.vtkTextActor_SafeDownCast_26 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetAlignmentPoint_27 ( HandleRef  pThis,
int  point 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetInput_28 ( HandleRef  pThis,
string  inputString 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetMapper_29 ( HandleRef  pThis,
HandleRef  mapper 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetMaximumLineHeight_30 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetMinimumSize_31 ( HandleRef  pThis,
int  _arg1,
int  _arg2 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetMinimumSize_32 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetNonLinearFontScale_33 ( HandleRef  pThis,
double  exponent,
int  target 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetOrientation_34 ( HandleRef  pThis,
float  orientation 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetTextProperty_35 ( HandleRef  pThis,
HandleRef  p 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetTextScaleMode_36 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetTextScaleModeToNone_37 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetTextScaleModeToProp_38 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetTextScaleModeToViewport_39 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SetUseBorderAlign_40 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_ShallowCopy_41 ( HandleRef  pThis,
HandleRef  prop 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_SpecifiedToDisplay_42 ( HandleRef  pThis,
IntPtr  pos,
HandleRef  vport,
int  specified 
) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_UseBorderAlignOff_43 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTextActor.vtkTextActor_UseBorderAlignOn_44 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTextActor.MRClassNameKey = "12vtkTextActor" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkActor2D.

Reimplemented in Kitware.VTK.vtkScaledTextActor.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkActor2D.

Reimplemented in Kitware.VTK.vtkScaledTextActor.


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