OverlayBase Class Reference

Base class for Display overlays. More...

Inherited by ControlOverlay, and ImageOverlay.

Public Member Functions
	OverlayBase ()
	Creates an overlay object.

Static Public Attributes
static readonly DependencyProperty	ActualZoomFactorProperty = ActualZoomFactorKey.DependencyProperty
	Backing store for the ActualZoomFactor property.
static readonly DependencyProperty	InverseActualZoomFactorProperty = InverseActualZoomFactorPropertyKey.DependencyProperty
	Backing store.
static readonly DependencyProperty	OverlayHeightProperty
	Backing store for the OverlayHeight property.
static readonly DependencyProperty	OverlayWidthProperty
	Backing store for the OverlayWidth property.
static readonly DependencyProperty	OverlayXProperty
	Backing store for the OverlayX property.
static readonly DependencyProperty	OverlayYProperty
	Backing store for the OverlayY property.
static readonly DependencyProperty	ParentDisplayCanvasProperty
	Backing store for the readonly ParentDisplayCanvas property.
static readonly DependencyProperty	BottomProperty
	Backing store for the Bottom property.
static readonly DependencyProperty	LeftProperty
	Backing store for the Left property.
static readonly DependencyProperty	LengthUnitProperty
	Backing store for the LengthUnit property.
static readonly DependencyProperty	RightProperty
	Backing store for the Right property.
static readonly DependencyProperty	TopProperty
	Backing store for the Top property.

Protected Member Functions
virtual void	OnParentDisplayCanvasChanged (DisplayCanvas oldCanvas, DisplayCanvas newCanvas)
	Event raiser.

Static Protected Member Functions
static void	OnActualZoomFactorChanged (DependencyObject d, DependencyPropertyChangedEventArgs e)
	React to property changes.

Static Protected Attributes
static readonly DependencyPropertyKey	ActualZoomFactorKey
	The Key for readonly ActualZoomFactor property.
static readonly DependencyPropertyKey	InverseActualZoomFactorPropertyKey
	Backing store key.

Properties
double	ActualZoomFactor [get]
	Gets the actual zoom factor of the display canvas this overlay is on.
double	InverseActualZoomFactor [get, protected set]
	Gets the inverse value of the actual Zoom factor (useful for painting items that are the same size regardless of zoom factor).
double	OverlayHeight [get, set]
	Gets/sets the height of the overlay in the current length unit.
double	OverlayWidth [get, set]
	Gets/sets the width of the overlay in the current length unit.
double	OverlayX [get, set]
	Gets/sets the overlay x coordinate in the current length unit.
double	OverlayY [get, set]
	Gets/set the overlay Y in the current length unit.
DisplayCanvas	ParentDisplayCanvas [get, set]
	The DisplayCanvas this overlay is child of.
double	Bottom [get, set]
	Layouts a child from the bottom.
double	Left [get, set]
	Layouts a child from the left.
LengthUnit	LengthUnit [get]
	Defines whether the layout properties are measured in image pixels or in device independent pixels as displayed by the canvas.
double	Right [get, set]
	Layouts a child from the right.
double	Top [get, set]
	Layouts a child from the top.

Events
EventHandler< PropertyValueChangedEventArgs< DisplayCanvas > >	ParentDisplayCanvasChanged
	Event that is fired when the parent DisplayCanvas is changed.
EventHandler< DisplayZoomEventArgs >	ActualZoomFactorChanged
	Event that is fired when the parent DisplayCanvas' actual zoom factor is changed.

Detailed Description

Base class for Display overlays.

Member Function Documentation

OnActualZoomFactorChanged()

static void OnActualZoomFactorChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e )

staticprotected

React to property changes.

Parameters

d
e

OnParentDisplayCanvasChanged()

virtual void OnParentDisplayCanvasChanged ( DisplayCanvas oldCanvas, DisplayCanvas newCanvas )

protectedvirtual

Event raiser.

Parameters

oldCanvas
newCanvas

Reimplemented in Area2DOverlay.

Property Documentation

Bottom

double Bottom

getset

Layouts a child from the bottom.

Default is double.NaN.

Left

double Left

getset

Layouts a child from the left.

Default is double.NaN.

ParentDisplayCanvas

DisplayCanvas ParentDisplayCanvas

getset

The DisplayCanvas this overlay is child of.

null if no DisplayCanvas parent is present.

Right

double Right

getset

Layouts a child from the right.

Default is double.NaN.

Top

double Top

getset

Layouts a child from the top.

Default is double.NaN.