ImageOverlay Class Reference

A picture in picture display of a CVB image by means of an overlay. More...

Inherits ExtendedOverlayPluginBase< PluginData.ImagePlugInData >.

Public Member Functions
	ImageOverlay (string text, bool canDrag, Point location, Size size, Image image, object tag)
	Standard constructor for Image Overlays. More...
	ImageOverlay (string text, bool canDrag, Point location, Size size, Image image)
	Standard constructor for Stemmer.Cvb.Image Overlays. More...
override OverlayPluginBase	Clone ()
	Virtual copy Constructor. More...

Protected Member Functions
override PluginData.ImagePlugInData	CreatePluginData ()
	Create the plugin data structure for later use More...
Protected Member Functions inherited from ExtendedOverlayPluginBase< PluginData.ImagePlugInData >
	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...
Stemmer.Cvb.Image	Image [get, set]
	Image to be displayed in picture-in-picture style. More...
Point	Location [get, set]
	position of the left top corner of the bitmap
Size	Size [get, set]
	Size to which to stretch the image.

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

Detailed Description

A picture in picture display of a CVB image by means of an overlay.

Constructor & Destructor Documentation

ImageOverlay() [1/2]

ImageOverlay	(	string	text,
		bool	canDrag,
		Point	location,
		Size	size,
		Image	image,
		object	tag
	)

Standard constructor for Image Overlays.

Parameters

text	status line text
canDrag	drag-ability
location	paint position
size	size to which to stretch the image
image	Stemmer.Cvb.Image to be used as overlay
tag	object to be associated with this overlay

Using a Stemmer.Cvb.Image as an overlay will of course increment the reference count for that image, making it live at least as long as the overlay object.

Exceptions

ArgumentNullException

if the input image is null

ImageOverlay() [2/2]

ImageOverlay	(	string	text,
		bool	canDrag,
		Point	location,
		Size	size,
		Image	image
	)

Standard constructor for Stemmer.Cvb.Image Overlays.

Parameters

text	status line text
canDrag	drag-ability
location	paint position
size	size to which to stretch the image
image	Stemmer.Cvb.Image to be used as overlay

Using a Stemmer.Cvb.Image as an overlay will of course increment the reference count for that image, making it live at least as long as the overlay object.

Exceptions

ArgumentNullException

if the input image is null

Member Function Documentation

Clone()

override OverlayPluginBase Clone

(

)

Virtual copy Constructor.

Returns

The cloned ImageOverlay object.

CreatePluginData()

override PluginData.ImagePlugInData CreatePluginData ( )

protectedvirtual

Create the plugin data structure for later use

Returns

The overlay plugin data structure.

Implements ExtendedOverlayPluginBase< PluginData.ImagePlugInData >.

Property Documentation

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".

Image

Stemmer.Cvb.Image Image

getset

Image to be displayed in picture-in-picture style.

Exceptions

ArgumentNullException

when trying to set a null handle

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).