BitmapOverlay Class Reference

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

Inherits ExtendedOverlayPluginBase< PluginData.BitmapPlugInData >.

Public Member Functions
	BitmapOverlay (string text, bool canDrag, Point location, Size size, Bitmap bitmap, object tag)
	Constructor for bitmap overlays. More...
	BitmapOverlay (string text, bool canDrag, Point location, Size size, Bitmap bitmap)
	Constructor for bitmap overlays. More...
override OverlayPluginBase	Clone ()
	Virtual copy constructor. More...

Protected Member Functions
override PluginData.BitmapPlugInData	CreatePluginData ()
	Create the plugin data structure for later use. More...
Protected Member Functions inherited from ExtendedOverlayPluginBase< PluginData.BitmapPlugInData >
	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
new System.Drawing.Color	Color [get, set]
	Setting any other color than black is not possible for this overlay. More...
new bool	Filled [get, set]
	Filled property is always true on this overlay. More...
new bool	XORPainting [get, set]
	XOR painting is not possible... More...
Bitmap	Bitmap [get, set]
	Bitmap to be overlaid. More...
Point	Location [get, set]
	Position of the left top corner of the bitmap.
Size	Size [get, set]
	Size to which to stretch the bitmap.

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

Detailed Description

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

Constructor & Destructor Documentation

BitmapOverlay() [1/2]

BitmapOverlay	(	string	text,
		bool	canDrag,
		Point	location,
		Size	size,
		Bitmap	bitmap,
		object	tag
	)

Constructor for bitmap overlays.

Parameters

text	status line text
canDrag	drag-ability
location	paint position
size	size to which to stretch the bitmap
bitmap	bitmap to be used as overlay (will be cloned)
tag	object to be associated with this overlay

BitmapOverlay() [2/2]

BitmapOverlay	(	string	text,
		bool	canDrag,
		Point	location,
		Size	size,
		Bitmap	bitmap
	)

Constructor for bitmap overlays.

Parameters

text	status line text
canDrag	drag-ability
location	paint position
size	size to which to stretch the bitmap
bitmap	bitmap to be used as overlay (will be cloned)

Member Function Documentation

Clone()

override OverlayPluginBase Clone

(

)

Virtual copy constructor.

Returns

The cloned overlay object.

CreatePluginData()

override PluginData.BitmapPlugInData CreatePluginData ( )

protectedvirtual

Create the plugin data structure for later use.

Returns

A newly created plugin data structure.

Implements ExtendedOverlayPluginBase< PluginData.BitmapPlugInData >.

Property Documentation

Bitmap

Bitmap Bitmap

getset

Bitmap to be overlaid.

Exceptions

NullReferenceException

when trying to set a null handle

Color

new System.Drawing.Color Color

getset

Setting any other color than black is not possible for this overlay.

Exceptions

NotSupportedException

when trying to set a value (inheritance dictates that a set accessor needs to be present).

Filled

new bool Filled

getset

Filled property is always true on this overlay.

Exceptions

NotSupportedException

when trying to set a value of "false".

XORPainting

new bool XORPainting

getset

XOR painting is not possible...

Exceptions

NotSupportedException

when trying to set true (inheritance dictates that a set accessor needs to be present).