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

vtkPen - provides a pen that draws the outlines of shapes drawn by vtkContext2D. More...

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

List of all members.

Public Types

enum  DASH_DOT_DOT_LINE_WrapperEnum {
  DASH_DOT_DOT_LINE = 5, DASH_DOT_LINE = 4, DASH_LINE = 2, DOT_LINE = 3,
  NO_PEN = 0, SOLID_LINE = 1
}
 Undocumented Block. More...

Public Member Functions

 vtkPen (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPen ()
 Undocumented Block.
void DeepCopy (vtkPen pen)
 Make a deep copy of the supplied pen.
void GetColor (IntPtr color)
 Get the color of the brush - expects an unsigned char of length 3.
IntPtr GetColor ()
 Get the color of the brush - gives a pointer to the underlying data.
void GetColorF (IntPtr color)
 Get the color of the brush - expects a double of length 3 to copy into.
int GetLineType ()
 Get the type of line that the pen will draw.
byte GetOpacity ()
 Get the opacity (unsigned char), ranging from 0 (transparent) to 255 (opaque).
virtual float GetWidth ()
 Set/Get the width of the pen.
override int IsA (string type)
 Undocumented Block.
new vtkPen NewInstance ()
 Undocumented Block.
void SetColor (IntPtr color)
 Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
void SetColor (byte r, byte g, byte b)
 Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
void SetColor (byte r, byte g, byte b, byte a)
 Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.
void SetColorF (IntPtr color)
 Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.
void SetColorF (double r, double g, double b)
 Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.
void SetColorF (double r, double g, double b, double a)
 Set the color of the brush with four component doubles (RGBA), ranging from 0.0 to 1.0.
void SetLineType (int type)
 Set the type of line that the pen should draw. The default is solid (1).
void SetOpacity (byte a)
 Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).
void SetOpacityF (double a)
 Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).
virtual void SetWidth (float _arg)
 Set/Get the width of the pen.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "6vtkPen"
 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 vtkPen_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPen_DeepCopy_01 (HandleRef pThis, HandleRef pen)
static internal void vtkPen_GetColor_02 (HandleRef pThis, IntPtr color)
static internal IntPtr vtkPen_GetColor_03 (HandleRef pThis)
static internal void vtkPen_GetColorF_04 (HandleRef pThis, IntPtr color)
static internal int vtkPen_GetLineType_05 (HandleRef pThis)
static internal byte vtkPen_GetOpacity_06 (HandleRef pThis)
static internal float vtkPen_GetWidth_07 (HandleRef pThis)
static internal int vtkPen_IsA_08 (HandleRef pThis, string type)
static internal int vtkPen_IsTypeOf_09 (string type)
static internal IntPtr vtkPen_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPen_SafeDownCast_12 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPen_SetColor_13 (HandleRef pThis, IntPtr color)
static internal void vtkPen_SetColor_14 (HandleRef pThis, byte r, byte g, byte b)
static internal void vtkPen_SetColor_15 (HandleRef pThis, byte r, byte g, byte b, byte a)
static internal void vtkPen_SetColorF_16 (HandleRef pThis, IntPtr color)
static internal void vtkPen_SetColorF_17 (HandleRef pThis, double r, double g, double b)
static internal void vtkPen_SetColorF_18 (HandleRef pThis, double r, double g, double b, double a)
static internal void vtkPen_SetLineType_19 (HandleRef pThis, int type)
static internal void vtkPen_SetOpacity_20 (HandleRef pThis, byte a)
static internal void vtkPen_SetOpacityF_21 (HandleRef pThis, double a)
static internal void vtkPen_SetWidth_22 (HandleRef pThis, float _arg)

Static Private Member Functions

static vtkPen ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPen - provides a pen that draws the outlines of shapes drawn by vtkContext2D.

Description The vtkPen defines the outline of shapes that are drawn by vtkContext2D. The color is stored as four unsigned chars (RGBA), where the opacity defaults to 255, but can be modified separately to the other components. Ideally we would use a lightweight color class to store and pass around colors.


Member Enumeration Documentation

Undocumented Block.

Enumerator:
DASH_DOT_DOT_LINE 

enum member

DASH_DOT_LINE 

enum member

DASH_LINE 

enum member

DOT_LINE 

enum member

NO_PEN 

enum member

SOLID_LINE 

enum member


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

Make a deep copy of the supplied pen.

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

void Kitware.VTK.vtkPen.GetColor ( IntPtr  color)

Get the color of the brush - expects an unsigned char of length 3.

Get the color of the brush - gives a pointer to the underlying data.

void Kitware.VTK.vtkPen.GetColorF ( IntPtr  color)

Get the color of the brush - expects a double of length 3 to copy into.

Get the type of line that the pen will draw.

Get the opacity (unsigned char), ranging from 0 (transparent) to 255 (opaque).

virtual float Kitware.VTK.vtkPen.GetWidth ( ) [virtual]

Set/Get the width of the pen.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

void Kitware.VTK.vtkPen.SetColor ( IntPtr  color)

Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.

void Kitware.VTK.vtkPen.SetColor ( byte  r,
byte  g,
byte  b 
)

Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.

void Kitware.VTK.vtkPen.SetColor ( byte  r,
byte  g,
byte  b,
byte  a 
)

Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.

void Kitware.VTK.vtkPen.SetColorF ( IntPtr  color)

Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.

void Kitware.VTK.vtkPen.SetColorF ( double  r,
double  g,
double  b 
)

Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.

void Kitware.VTK.vtkPen.SetColorF ( double  r,
double  g,
double  b,
double  a 
)

Set the color of the brush with four component doubles (RGBA), ranging from 0.0 to 1.0.

void Kitware.VTK.vtkPen.SetLineType ( int  type)

Set the type of line that the pen should draw. The default is solid (1).

Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).

void Kitware.VTK.vtkPen.SetOpacityF ( double  a)

Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).

virtual void Kitware.VTK.vtkPen.SetWidth ( float  _arg) [virtual]

Set/Get the width of the pen.

static internal void Kitware.VTK.vtkPen.vtkPen_DeepCopy_01 ( HandleRef  pThis,
HandleRef  pen 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_GetColor_02 ( HandleRef  pThis,
IntPtr  color 
) [private]
static internal IntPtr Kitware.VTK.vtkPen.vtkPen_GetColor_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_GetColorF_04 ( HandleRef  pThis,
IntPtr  color 
) [private]
static internal int Kitware.VTK.vtkPen.vtkPen_GetLineType_05 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkPen.vtkPen_GetOpacity_06 ( HandleRef  pThis) [private]
static internal float Kitware.VTK.vtkPen.vtkPen_GetWidth_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPen.vtkPen_IsA_08 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkPen.vtkPen_IsTypeOf_09 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPen.vtkPen_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPen.vtkPen_NewInstance_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPen.vtkPen_SafeDownCast_12 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetColor_13 ( HandleRef  pThis,
IntPtr  color 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetColor_14 ( HandleRef  pThis,
byte  r,
byte  g,
byte  b 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetColor_15 ( HandleRef  pThis,
byte  r,
byte  g,
byte  b,
byte  a 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetColorF_16 ( HandleRef  pThis,
IntPtr  color 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetColorF_17 ( HandleRef  pThis,
double  r,
double  g,
double  b 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetColorF_18 ( HandleRef  pThis,
double  r,
double  g,
double  b,
double  a 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetLineType_19 ( HandleRef  pThis,
int  type 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetOpacity_20 ( HandleRef  pThis,
byte  a 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetOpacityF_21 ( HandleRef  pThis,
double  a 
) [private]
static internal void Kitware.VTK.vtkPen.vtkPen_SetWidth_22 ( HandleRef  pThis,
float  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkPen.MRClassNameKey = "6vtkPen" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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