ArcOverlay Class Reference

An arc zoom factor More...

Inherits ExtendedOverlayPluginBase< PluginData.ArcPlugInData >.

Public Member Functions
	ArcOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point center, Point p0, Point p1, int penWidth, DashStyle dashStyle, bool showHandles, object tag)
	Constructor for an arc segment overlay. More...
	ArcOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point center, Point p0, Point p1, int penWidth, DashStyle dashStyle, bool showHandles)
	Constructor for an arc segment overlay. More...
override OverlayPluginBase	Clone ()
	Virtual copy constructor. More...

Protected Member Functions
override PluginData.ArcPlugInData	CreatePluginData ()
	Create the plugin data structure for later use More...
Protected Member Functions inherited from ExtendedOverlayPluginBase< PluginData.ArcPlugInData >
	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...

Properties
bool	ShowHandles [get, set]
	gets or sets whether the drag handles of the two vertices indicating the start and the stop of the arc are to be displayed
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...
double	Radius [get]
	Current radius of the arc.
Angle	StartAngle [get]
	Angle between first point (P0) and center point (in radians).
Angle	StopAngle [get]
	Angle between second point (P1) and center point (in radians).
Point	Center [get, set]
	Location of the center point of the Arc.
Point	P0 [get, set]
	Location of the start point of the Arc.
Point	P1 [get, set]
	Location of the end point of the Arc.
new bool	Filled [get, set]
	Filled property is always false.

Additional Inherited Members
Protected Attributes inherited from ExtendedOverlayPluginBase< PluginData.ArcPlugInData >
TData	opiData_
	The plugin-specific data structure

Detailed Description

An arc zoom factor

Constructor & Destructor Documentation

ArcOverlay() [1/2]

ArcOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	center,
		Point	p0,
		Point	p1,
		int	penWidth,
		DashStyle	dashStyle,
		bool	showHandles,
		object	tag
	)

Constructor for an arc segment overlay.

Parameters

text	status line string
canDrag	dragable or not
color	color
xorPaint	paint mode
center	arc's center
p0	start point of the arc
p1	stop point of the arc
penWidth	pen width with which to paint the arc
dashStyle	dash style with which to paint the arc
showHandles	display drag handles?
tag	object to be associated with this overlay

ArcOverlay() [2/2]

ArcOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	center,
		Point	p0,
		Point	p1,
		int	penWidth,
		DashStyle	dashStyle,
		bool	showHandles
	)

Constructor for an arc segment overlay.

Parameters

text	status line string
canDrag	dragable or not
color	color
xorPaint	paint mode
center	arc's center
p0	start point of the arc
p1	stop point of the arc
penWidth	pen width with which to paint the arc
dashStyle	dash style with which to paint the arc
showHandles	display drag handles?

Member Function Documentation

Clone()

override OverlayPluginBase Clone

(

)

Virtual copy constructor.

Returns

Cloned overlay.

CreatePluginData()

override PluginData.ArcPlugInData CreatePluginData ( )

protectedvirtual

Create the plugin data structure for later use

Returns

Plugin data.

Implements ExtendedOverlayPluginBase< PluginData.ArcPlugInData >.

Property Documentation

DashStyle

DashStyle DashStyle

getset

Dash style to be used for painting.

Dash style "Custom" is not supported.

Dash style setting will only have an effect if the pen width has been set to 1. If pen width is greater than 1, a solid brush will always be used. This is a limitation coming from the GDI function CreatePen that is being used internally by the overlay plugin.

Exceptions

ArgumentException

If the dash style is "Custom"

PenWidth

int PenWidth

getset

Width of the pen to be used for painting.

Exceptions

ArgumentException

If the pen width is 0 or less