CrossHairOverlay Class Reference

A simple Crosshair overlay. More...

Inherits PenStyleOverlayPluginBase.

Public Member Functions
	CrossHairOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point location, Size size, object tag)
	Constructor for cross hair plugins More...
	CrossHairOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point location, Size size)
	Constructor for cross hair plugins More...
	CrossHairOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point location, Size size, DashStyle dashStyle, int penWidth, object tag)
	Constructor for cross hair plugins More...
	CrossHairOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point location, Size size, DashStyle dashStyle, int penWidth)
	Constructor for cross hair plugins More...
override OverlayPluginBase	Clone ()
	Virtual copy constructor. More...

Properties
override bool	Filled [get, set]
	Filled painting is not supported on this overlay.
Size	Size [get, set]
	The sizes of the two bars for the cross hair.
Point	Location [get, set]
	Position of the cross hair.
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

A simple Crosshair overlay.

Constructor & Destructor Documentation

CrossHairOverlay() [1/4]

CrossHairOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	location,
		Size	size,
		object	tag
	)

Constructor for cross hair plugins

Parameters

text	status line text
canDrag	dragable
color	color
xorPaint	paint mode
location	position
size	size of the horizontal and vertical bar
tag	object to be associated with this overlay

CrossHairOverlay() [2/4]

CrossHairOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	location,
		Size	size
	)

Constructor for cross hair plugins

Parameters

text	status line text
canDrag	dragable
color	color
xorPaint	paint mode
location	position
size	size of the horizontal and vertical bar

CrossHairOverlay() [3/4]

CrossHairOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	location,
		Size	size,
		DashStyle	dashStyle,
		int	penWidth,
		object	tag
	)

Constructor for cross hair plugins

Parameters

text	status line text
canDrag	dragable
color	color
xorPaint	paint mode
location	position
size	size of the horizontal and vertical bar
dashStyle	dash style for painting
penWidth	pen width for painting
tag	object to be associated with this overlay

CrossHairOverlay() [4/4]

CrossHairOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	location,
		Size	size,
		DashStyle	dashStyle,
		int	penWidth
	)

Constructor for cross hair plugins

Parameters

text	status line text
canDrag	dragable
color	color
xorPaint	paint mode
location	position
size	size of the horizontal and vertical bar
dashStyle	dash style for painting
penWidth	pen width for painting

Member Function Documentation

Clone()

override OverlayPluginBase Clone

(

)

Virtual copy constructor.

Returns

Cloned CrossHairOverlay object.