ExtendedOverlayPluginBase< TData > Class Template Reference

Base class for all overlays that come with a plugin data structure More...

Inherits OverlayPluginBase.

Protected Member Functions
	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 Member Functions inherited from OverlayPluginBase
	OverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag)
	ctor for Overlay objects with user data More...
virtual OverlayPluginWrapper	CreateOverlayWrapper ()
	Overrideable creation function for overlay wrapper objects More...
override void	Overlay_ConnectedToDisplay ()
	Connect the overlay plugin to the display by means of an OPI wrapper
override void	Overlay_DisconnectedFromDisplay (bool handBackID)
	Remove an OPI from a display (effectively: kill it...) More...
Protected Member Functions inherited from OverlayBase
	OverlayBase (string text, bool canDrag, System.Drawing.Color color, object tag)
	ctor for DisplayObjects More...

Protected Attributes
TData	opiData_
	The plugin-specific data structure
Protected Attributes inherited from OverlayPluginBase
OverlayPluginInfo	opiInfo_
	information about the OPI that is being used by this object
Point[]	vertices_
	Array with the most up-to-date construction vertices
Protected Attributes inherited from OverlayBase
System.Drawing.Color	color_ = System.Drawing.Color.White
	Internally stored color.

Additional Inherited Members
Public Member Functions inherited from OverlayPluginBase
abstract OverlayPluginBase	Clone ()
	virtual copy constructor for overlay objects More...
Properties inherited from OverlayPluginBase
string	Name [get]
	Friendly name of the overlay plugin
virtual bool	Filled [get, set]
	Specifies whether or not the OPI should be painted filled
virtual bool	XORPainting [get, set]
	specifies the paint mode (opaque or XOR)
Properties inherited from OverlayBase
Display	Parent [get]
	The display on which the label lives (if any...). Note that a label may only be associated with one display at a time
object	Tag [get, set]
	Field for user-definable data to be associated with the overlay object.
bool	InvokeRequired [get]
	tell whether actions on the display object require an invoke action or not (being user interface objects, display objects should not be modified asynchronously)
string	Text [get, set]
	Text being displayed on the label and/or in the status line
virtual System.Drawing.Color	Color [get, set]
	Color of the label
bool	IsDragable [get, set]
	Label dragable?

Detailed Description

Base class for all overlays that come with a plugin data structure

Template Parameters

TData

Type of the information container for the plugin.

Type Constraints

TData

:

struct

Constructor & Destructor Documentation

ExtendedOverlayPluginBase()

ExtendedOverlayPluginBase ( string  text, bool  canDrag, System.Drawing.Color  color, bool  xorPaint, bool  filled, Point[]  vertices, OverlayPluginInfo  info, object  tag  )

protected

Standard constructor for overlays with a plugin data structure.

Parameters

text	status line text
canDrag	drag-ability
color	color
xorPaint	paint mode
filled	paint mode
vertices	vertices for the opi
info	which opi
tag	object to be associated with this overlay

Member Function Documentation

CreateOverlayWrapper()

override OverlayPluginWrapper CreateOverlayWrapper ( )

protectedvirtual

overrideable creation function for overlay wrapper objects

Returns

a newly create overlay plugin wrapper

Reimplemented from OverlayPluginBase.

CreatePluginData()

abstract TData CreatePluginData ( )

protectedpure virtual

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)

Returns

Return the fully created plugin data structure here.

Implemented in ArcOverlay, BitmapOverlay, CompassOverlay, FixedSizeBitmapOverlay, ImageOverlay, PenStyleOverlayPluginBase, PixelListOverlay, PolyLineOverlay, RotatedRectangleOverlay, TargetOverlay, and TextOverlay.

OpiDataPropertyChanged()

virtual void OpiDataPropertyChanged ( bool  skipDestroyAndCreate )

protectedvirtual

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.

Parameters

skipDestroyAndCreate

set to true if the destroy-and- recreate step is to be omitted (e.g. if multiple settings are about to change)