Area2DOverlay Class Reference

An overlay object representing an Area2D object on a Display. More...

Inherits PenStyleOverlayPluginBase.

Public Member Functions
	Area2DOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Area2D area2D, object tag)
	Constructor for an Area2D overlay. More...
	Area2DOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Area2D area2D)
	Constructor for an Area2D overlay. More...
	Area2DOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Area2D area2D, DashStyle dashStyle, int penWidth, object tag)
	Constructor for an Area2D overlay. More...
	Area2DOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Area2D area2D, DashStyle dashStyle, int penWidth)
	Constructor for an Area2D overlay. More...
override OverlayPluginBase	Clone ()
	Virtual copy Constructor. More...

Properties
Area2D	Area2D [get, set]
	The two axises of the ellipse in x and y direction
new bool	Filled [get, set]
	filled property is always false
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 overlay object representing an Area2D object on a Display.

Constructor & Destructor Documentation

Area2DOverlay() [1/4]

Area2DOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Area2D	area2D,
		object	tag
	)

Constructor for an Area2D overlay.

Parameters

text	status line string
canDrag	drag able or not
color	color
xorPaint	paint mode
area2D	Area2D's extent
tag	object to be associated with this overlay

Area2DOverlay() [2/4]

Area2DOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Area2D	area2D
	)

Constructor for an Area2D overlay.

Parameters

text	status line string
canDrag	drag able or not
color	color
xorPaint	paint mode
area2D	Area2D's extent

Area2DOverlay() [3/4]

Area2DOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Area2D	area2D,
		DashStyle	dashStyle,
		int	penWidth,
		object	tag
	)

Constructor for an Area2D overlay.

Parameters

text	status line string
canDrag	drag able or not
color	color
xorPaint	paint mode
area2D	Area2D's extent
dashStyle	dash style for painting
penWidth	pen width for painting
tag	object to be associated with this overlay

Area2DOverlay() [4/4]

Area2DOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Area2D	area2D,
		DashStyle	dashStyle,
		int	penWidth
	)

Constructor for an Area2D overlay.

Parameters

text	status line string
canDrag	drag able or not
color	color
xorPaint	paint mode
area2D	Area2D's extent
dashStyle	dash style for painting
penWidth	pen width for painting

Member Function Documentation

Clone()

override OverlayPluginBase Clone

(

)

Virtual copy Constructor.

Returns

Cloned overlay.