TargetOverlay Class Reference

A "target" - in principle a stack of crosshair plugins More...

Inherits ExtendedOverlayPluginBase< PluginData.TargetPlugInData >.

Inherited by CircularTargetOverlay, and RectangularTargetOverlay.

Protected Member Functions
override PluginData.TargetPlugInData	CreatePluginData ()
	Create the plugin data structure for later use More...
Protected Member Functions inherited from ExtendedOverlayPluginBase< PluginData.TargetPlugInData >
	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
int	roundRadius_
	to be used by inheritors only
Protected Attributes inherited from ExtendedOverlayPluginBase< PluginData.TargetPlugInData >
TData	opiData_
	The plugin-specific data structure

Properties
int	CrosshairSize [get, set]
	Size of the crosshair. More...
int	Distance [get, set]
	Distance between two adjacent circles or rectangles. More...
int	Count [get, set]
	Number of crosshairs to be stacked. More...
DashStyle	DashStyle [get, set]
	Dash style to be used for painting. More...
int	PenWidth [get, set]
	Width of the pen to be used for painting. More...
new bool	Filled [get, set]
	Filled property is always false on this overlay. More...
Point	Location [get, set]
	position of the center of the circle

Detailed Description

A "target" - in principle a stack of crosshair plugins

Member Function Documentation

CreatePluginData()

override PluginData.TargetPlugInData CreatePluginData ( )

protectedvirtual

Create the plugin data structure for later use

Returns

The overlay plugin data structure.

Implements ExtendedOverlayPluginBase< PluginData.TargetPlugInData >.

Property Documentation

Count

int Count

getset

Number of crosshairs to be stacked.

Exceptions

ArgumentException

when trying to specify a value less than 1

CrosshairSize

int CrosshairSize

getset

Size of the crosshair.

Exceptions

ArgumentException

when trying to specify a crosshair size less than 0

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"

Distance

int Distance

getset

Distance between two adjacent circles or rectangles.

Exceptions

ArgumentException

when trying to specify a distance of less than 0

Filled

new bool Filled

getset

Filled property is always false on this overlay.

Exceptions

NotSupportedException

when trying to set a value of "true".

PenWidth

int PenWidth

getset

Width of the pen to be used for painting.

Exceptions

ArgumentException

If the pen width is 0 or less