CVB.Net 14.0
CircleOverlay Class Reference

An circle overlay. More...

Inherits PenStyleOverlayPluginBase.

Public Member Functions

 CircleOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point center, double radius, object tag)
 Constructor for a circle overlay. More...
 
 CircleOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point center, double radius)
 Constructor for a circle overlay. More...
 
 CircleOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point center, double radius, DashStyle dashStyle, int penWidth, object tag)
 Constructor for a circle overlay. More...
 
 CircleOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point center, double radius, DashStyle dashStyle, int penWidth)
 Constructor for a circle overlay. More...
 
override OverlayPluginBase Clone ()
 virtual copy ctor More...
 

Properties

double Radius [get]
 The radius of the circle.
 
Point Center [get, set]
 Center of the circle.
 
Point Perimeter [get, set]
 Point on the circle's perimeter defining the circle's radius.
 
- Properties inherited from PenStyleOverlayPluginBase
int PenWidth [get, set]
 Width of the pen to be used for painting. More...
 
DashStyle DashStyle [get, set]
 Dash style to be used for painting. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PenStyleOverlayPluginBase
 PenStyleOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag)
 Constructor for pen-styled overlay plugins. More...
 
 PenStyleOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, DashStyle dashStyle, int penWidth, object tag)
 Constructor for pen-styled overlay plugins. More...
 
override PluginData.PenStylePlugInData CreatePluginData ()
 Build the plugin data structure using the current settings. More...
 
- Protected Member Functions inherited from ExtendedOverlayPluginBase< PluginData.PenStylePlugInData >
 ExtendedOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag)
 Standard constructor for overlays with a plugin data structure. More...
 
override OverlayPluginWrapper CreateOverlayWrapper ()
 overrideable creation function for overlay wrapper objects More...
 
abstract TData CreatePluginData ()
 Inheritors must override this and in the override prepare the plugin data reflecting the OPI's current state (depending usually on the current values of the Overlay object's properties) More...
 
virtual void OpiDataPropertyChanged ()
 A property that is relevant for the opi data structure has been changed; as a consequence, the opi may potentially need to be re-generated in order to reflect the changes.
 
virtual void OpiDataPropertyChanged (bool skipDestroyAndCreate)
 A property that is relevant for the opi data structure has been changed; as a consequence, the opi may potentially need to be re-generated in order to reflect the changes. More...
 
- Protected Attributes inherited from ExtendedOverlayPluginBase< PluginData.PenStylePlugInData >
TData opiData_
 The plugin-specific data structure
 

Detailed Description

An circle overlay.

Constructor & Destructor Documentation

◆ CircleOverlay() [1/4]

CircleOverlay ( string  text,
bool  canDrag,
System.Drawing.Color  color,
bool  xorPaint,
bool  filled,
Point  center,
double  radius,
object  tag 
)

Constructor for a circle overlay.

Parameters
textstatus line string
canDragdrag able or not
colorcolor
xorPaintpaint mode
filledpaint mode
centercircle's center
radiuscircle's radius
tagobject to be associated with this overlay

◆ CircleOverlay() [2/4]

CircleOverlay ( string  text,
bool  canDrag,
System.Drawing.Color  color,
bool  xorPaint,
bool  filled,
Point  center,
double  radius 
)

Constructor for a circle overlay.

Parameters
textstatus line string
canDragdrag able or not
colorcolor
xorPaintpaint mode
filledpaint mode
centercircle's center
radiuscircle's radius

◆ CircleOverlay() [3/4]

CircleOverlay ( string  text,
bool  canDrag,
System.Drawing.Color  color,
bool  xorPaint,
bool  filled,
Point  center,
double  radius,
DashStyle  dashStyle,
int  penWidth,
object  tag 
)

Constructor for a circle overlay.

Parameters
textstatus line string
canDragdrag able or not
colorcolor
xorPaintpaint mode
filledpaint mode
centercircle's center
radiuscircle's radius
dashStyledash style for painting the line
penWidthpen width for painting the line
tagobject to be associated with this overlay

◆ CircleOverlay() [4/4]

CircleOverlay ( string  text,
bool  canDrag,
System.Drawing.Color  color,
bool  xorPaint,
bool  filled,
Point  center,
double  radius,
DashStyle  dashStyle,
int  penWidth 
)

Constructor for a circle overlay.

Parameters
textstatus line string
canDragdrag able or not
colorcolor
xorPaintpaint mode
filledpaint mode
centercircle's center
radiuscircle's radius
dashStyledash style for painting the line
penWidthpen width for painting the line

Member Function Documentation

◆ Clone()

override OverlayPluginBase Clone ( )

virtual copy ctor

Returns
The clonsed CircleOverlay object.