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

vtkCornerAnnotation - text annotation in four corners More...

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

List of all members.

Public Member Functions

 vtkCornerAnnotation (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCornerAnnotation ()
 Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
void ClearAllTexts ()
 Set/Get the text to be displayed for each corner.
void CopyAllTextsFrom (vtkCornerAnnotation ca)
 Set/Get the text to be displayed for each corner.
virtual vtkImageActor GetImageActor ()
 Set an image actor to look at for slice information.
virtual double GetLevelScale ()
 Set the value to scale the level by.
virtual double GetLevelShift ()
 Set the value to shift the level by.
virtual double GetLinearFontScaleFactor ()
 Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)
virtual int GetMaximumFontSize ()
 Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.
virtual double 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.
virtual int GetMinimumFontSize ()
 Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.
virtual double GetNonlinearFontScaleFactor ()
 Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)
virtual int GetShowSliceAndImage ()
 Even if there is an image actor, should `slice' and `image' be displayed?
string GetText (int i)
 Set/Get the text to be displayed for each corner.
virtual vtkTextProperty GetTextProperty ()
 Set/Get the text property of all corners.
virtual
vtkImageMapToWindowLevelColors 
GetWindowLevel ()
 Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.
override int HasTranslucentPolygonalGeometry ()
 Does this prop have some translucent polygonal geometry?
override int IsA (string type)
 Undocumented Block.
new vtkCornerAnnotation NewInstance ()
 Undocumented Block.
override void ReleaseGraphicsResources (vtkWindow arg0)
 Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.
override int RenderOpaqueGeometry (vtkViewport viewport)
 Draw the scalar bar and annotation text to the screen.
override int RenderOverlay (vtkViewport viewport)
 Draw the scalar bar and annotation text to the screen.
override int RenderTranslucentPolygonalGeometry (vtkViewport arg0)
 Draw the scalar bar and annotation text to the screen.
void SetImageActor (vtkImageActor arg0)
 Set an image actor to look at for slice information.
virtual void SetLevelScale (double _arg)
 Set the value to scale the level by.
virtual void SetLevelShift (double _arg)
 Set the value to shift the level by.
virtual void SetLinearFontScaleFactor (double _arg)
 Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)
virtual void SetMaximumFontSize (int _arg)
 Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.
virtual void SetMaximumLineHeight (double _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.
virtual void SetMinimumFontSize (int _arg)
 Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.
virtual void SetNonlinearFontScaleFactor (double _arg)
 Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)
virtual void SetShowSliceAndImage (int _arg)
 Even if there is an image actor, should `slice' and `image' be displayed?
void SetText (int i, string text)
 Set/Get the text to be displayed for each corner.
virtual void SetTextProperty (vtkTextProperty p)
 Set/Get the text property of all corners.
void SetWindowLevel (vtkImageMapToWindowLevelColors arg0)
 Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.
virtual void ShowSliceAndImageOff ()
 Even if there is an image actor, should `slice' and `image' be displayed?
virtual void ShowSliceAndImageOn ()
 Even if there is an image actor, should `slice' and `image' be displayed?

Static Public Member Functions

static new vtkCornerAnnotation New ()
 Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkCornerAnnotation SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "19vtkCornerAnnotation"
 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 vtkCornerAnnotation_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCornerAnnotation_ClearAllTexts_01 (HandleRef pThis)
static internal void vtkCornerAnnotation_CopyAllTextsFrom_02 (HandleRef pThis, HandleRef ca)
static internal IntPtr vtkCornerAnnotation_GetImageActor_03 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkCornerAnnotation_GetLevelScale_04 (HandleRef pThis)
static internal double vtkCornerAnnotation_GetLevelShift_05 (HandleRef pThis)
static internal double vtkCornerAnnotation_GetLinearFontScaleFactor_06 (HandleRef pThis)
static internal int vtkCornerAnnotation_GetMaximumFontSize_07 (HandleRef pThis)
static internal double vtkCornerAnnotation_GetMaximumLineHeight_08 (HandleRef pThis)
static internal int vtkCornerAnnotation_GetMinimumFontSize_09 (HandleRef pThis)
static internal double vtkCornerAnnotation_GetNonlinearFontScaleFactor_10 (HandleRef pThis)
static internal int vtkCornerAnnotation_GetShowSliceAndImage_11 (HandleRef pThis)
static internal IntPtr vtkCornerAnnotation_GetText_12 (HandleRef pThis, int i)
static internal IntPtr vtkCornerAnnotation_GetTextProperty_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCornerAnnotation_GetWindowLevel_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkCornerAnnotation_HasTranslucentPolygonalGeometry_15 (HandleRef pThis)
static internal int vtkCornerAnnotation_IsA_16 (HandleRef pThis, string type)
static internal int vtkCornerAnnotation_IsTypeOf_17 (string type)
static internal IntPtr vtkCornerAnnotation_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCornerAnnotation_ReleaseGraphicsResources_20 (HandleRef pThis, HandleRef arg0)
static internal int vtkCornerAnnotation_RenderOpaqueGeometry_21 (HandleRef pThis, HandleRef viewport)
static internal int vtkCornerAnnotation_RenderOverlay_22 (HandleRef pThis, HandleRef viewport)
static internal int vtkCornerAnnotation_RenderTranslucentPolygonalGeometry_23 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCornerAnnotation_SafeDownCast_24 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCornerAnnotation_SetImageActor_25 (HandleRef pThis, HandleRef arg0)
static internal void vtkCornerAnnotation_SetLevelScale_26 (HandleRef pThis, double _arg)
static internal void vtkCornerAnnotation_SetLevelShift_27 (HandleRef pThis, double _arg)
static internal void vtkCornerAnnotation_SetLinearFontScaleFactor_28 (HandleRef pThis, double _arg)
static internal void vtkCornerAnnotation_SetMaximumFontSize_29 (HandleRef pThis, int _arg)
static internal void vtkCornerAnnotation_SetMaximumLineHeight_30 (HandleRef pThis, double _arg)
static internal void vtkCornerAnnotation_SetMinimumFontSize_31 (HandleRef pThis, int _arg)
static internal void vtkCornerAnnotation_SetNonlinearFontScaleFactor_32 (HandleRef pThis, double _arg)
static internal void vtkCornerAnnotation_SetShowSliceAndImage_33 (HandleRef pThis, int _arg)
static internal void vtkCornerAnnotation_SetText_34 (HandleRef pThis, int i, string text)
static internal void vtkCornerAnnotation_SetTextProperty_35 (HandleRef pThis, HandleRef p)
static internal void vtkCornerAnnotation_SetWindowLevel_36 (HandleRef pThis, HandleRef arg0)
static internal void vtkCornerAnnotation_ShowSliceAndImageOff_37 (HandleRef pThis)
static internal void vtkCornerAnnotation_ShowSliceAndImageOn_38 (HandleRef pThis)

Static Private Member Functions

static vtkCornerAnnotation ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCornerAnnotation - text annotation in four corners

Description This is an annotation object that manages four text actors / mappers to provide annotation in the four corners of a viewport

vtkActor2D vtkTextMapper


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation ( 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

Set/Get the text to be displayed for each corner.

Set/Get the text to be displayed for each corner.

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

Set an image actor to look at for slice information.

Here is the call graph for this function:

virtual double Kitware.VTK.vtkCornerAnnotation.GetLevelScale ( ) [virtual]

Set the value to scale the level by.

virtual double Kitware.VTK.vtkCornerAnnotation.GetLevelShift ( ) [virtual]

Set the value to shift the level by.

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.

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.

Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

Even if there is an image actor, should `slice' and `image' be displayed?

Set/Get the text to be displayed for each corner.

Set/Get the text property of all corners.

Here is the call graph for this function:

Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.

Here is the call graph for this function:

Does this prop have some translucent polygonal geometry?

Reimplemented from Kitware.VTK.vtkActor2D.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

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

Reimplemented from Kitware.VTK.vtkActor2D.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from Kitware.VTK.vtkActor2D.

Draw the scalar bar and annotation text to the screen.

Reimplemented from Kitware.VTK.vtkActor2D.

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

Draw the scalar bar and annotation text to the screen.

Reimplemented from Kitware.VTK.vtkActor2D.

Draw the scalar bar and annotation text to the screen.

Reimplemented from Kitware.VTK.vtkActor2D.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkActor2D.

Here is the call graph for this function:

Set an image actor to look at for slice information.

virtual void Kitware.VTK.vtkCornerAnnotation.SetLevelScale ( double  _arg) [virtual]

Set the value to scale the level by.

virtual void Kitware.VTK.vtkCornerAnnotation.SetLevelShift ( double  _arg) [virtual]

Set the value to shift the level by.

virtual void Kitware.VTK.vtkCornerAnnotation.SetLinearFontScaleFactor ( double  _arg) [virtual]

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

virtual void Kitware.VTK.vtkCornerAnnotation.SetMaximumFontSize ( int  _arg) [virtual]

Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.

virtual void Kitware.VTK.vtkCornerAnnotation.SetMaximumLineHeight ( double  _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.

virtual void Kitware.VTK.vtkCornerAnnotation.SetMinimumFontSize ( int  _arg) [virtual]

Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.

virtual void Kitware.VTK.vtkCornerAnnotation.SetNonlinearFontScaleFactor ( double  _arg) [virtual]

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

virtual void Kitware.VTK.vtkCornerAnnotation.SetShowSliceAndImage ( int  _arg) [virtual]

Even if there is an image actor, should `slice' and `image' be displayed?

void Kitware.VTK.vtkCornerAnnotation.SetText ( int  i,
string  text 
)

Set/Get the text to be displayed for each corner.

Set/Get the text property of all corners.

Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.

Even if there is an image actor, should `slice' and `image' be displayed?

Even if there is an image actor, should `slice' and `image' be displayed?

static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_ClearAllTexts_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_CopyAllTextsFrom_02 ( HandleRef  pThis,
HandleRef  ca 
) [private]
static internal IntPtr Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetImageActor_03 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal double Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetLevelScale_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetLevelShift_05 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetLinearFontScaleFactor_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetMaximumFontSize_07 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetMaximumLineHeight_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetMinimumFontSize_09 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetNonlinearFontScaleFactor_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetShowSliceAndImage_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetText_12 ( HandleRef  pThis,
int  i 
) [private]
static internal IntPtr Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetTextProperty_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_GetWindowLevel_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_IsA_16 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_IsTypeOf_17 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_ReleaseGraphicsResources_20 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_RenderOpaqueGeometry_21 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal int Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_RenderOverlay_22 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal int Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_RenderTranslucentPolygonalGeometry_23 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SafeDownCast_24 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetImageActor_25 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetLevelScale_26 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetLevelShift_27 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetLinearFontScaleFactor_28 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetMaximumFontSize_29 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetMaximumLineHeight_30 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetMinimumFontSize_31 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetNonlinearFontScaleFactor_32 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetShowSliceAndImage_33 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetText_34 ( HandleRef  pThis,
int  i,
string  text 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetTextProperty_35 ( HandleRef  pThis,
HandleRef  p 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_SetWindowLevel_36 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_ShowSliceAndImageOff_37 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCornerAnnotation.vtkCornerAnnotation_ShowSliceAndImageOn_38 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCornerAnnotation.MRClassNameKey = "19vtkCornerAnnotation" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkActor2D.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkActor2D.


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