TPG.GeoFramework.Core.GeoLayerViewModel Class Reference

Inheritance diagram for TPG.GeoFramework.Core.GeoLayerViewModel:

Public Member Functions
	GeoLayerViewModel (IGeoContext geoContext, IGeoNavigator geoNavigator)
abstract void	HandleInputEvent (GeoInputEventArgs inputEventArgs)
	Called to forward events to the layer.
virtual void	Generate ()
	Requests that the layer generates it's view.
abstract void	Update ()
	Event called at regular intervals to update contents of the layer.
virtual void	SetDirty (bool isDirty)
	Sets a boolean value indicating the need for an update of the contents of a layer.
void	SetDirty (object sender)
	Sets dirty flag and stores sender, use to avoid cyclic dirtying.
virtual bool	IsDirty ()
Public Member Functions inherited from TPG.GeoFramework.Core.ViewModelBase
void	Dispose ()
	Invoked when this object is being removed from the application and will be subject to garbage collection.
void	HandleInputEvent (GeoInputEventArgs inputEventArgs)
	Called to forward events to the layer.
void	Generate ()
	Requests that the layer generates it's view.
void	Update ()
	Event called at regular intervals to update contents of the layer.
void	SetDirty (bool isDirty)
	Sets a boolean value indicating the need for an update of the contents of a layer.
void	SetDirty (object dirtySource)
	Sets dirty flag and stores sender, use to avoid cyclic dirtying.
bool	IsDirty ()

Protected Member Functions
virtual void	SetVisible (bool value)
override void	OnDispose (bool disposing)
	Make sure that all layers disconnect their shared GeoContexts.
Protected Member Functions inherited from TPG.GeoFramework.Core.ViewModelBase
virtual void	OnDispose (bool disposing)
	Child classes can override this method to perform clean-up logic, such as removing event handlers.
void	NotifyPropertyChanged< TProperty > (Expression< Func< TProperty > > property, INotifyPropertyChanged sender)
void	NotifyPropertyChanged (string propertyName)
virtual void	OnPropertyChanged ([CallerMemberName] string propertyName=null)

Protected Attributes
string	_name = null

Properties
IGeoControlViewModel	GeoControlViewModel [get, set]
	Get or set geo control view model.
UIElement	Tooltip [get, set]
	Get or set tooltip UI element.
string	Name [get]
	A name representing the type of layer.
bool	Visible [get, set]
	Gets or sets the visibility of the layer.
IGeoContext	GeoContext [get, set]
	Gets or sets the GeoContext related to the layer.
IGeoNavigator	GeoNavigator [get, set]
	Gets or sets the GeoNavigator related to the GeoControl.
IGeoLayerViewFactory	GeoLayerViewFactory [get, set]
	Gets a factory responsible for creating a IGeoLayerViewFactory view.
IGeoLayerView	GeoLayerView [get, set]
	Gets or sets the view associated with this view model.
ClipMargins	ClipMargins [get, set]
	Enables or disables clipping of the contents of the view, based on the specifed clip margins.
HashSet< object >	DirtySources [get]
	All contributors to current dirty.
Properties inherited from TPG.GeoFramework.Core.ViewModelBase
virtual string	DisplayName [get, protected set]
	Returns the user-friendly name of this object. Child classes can set this property to a new value, or override it to determine the value on-demand.
Properties inherited from TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase
string	DisplayName [get]
Properties inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
string	Name [get]
	A name representing the type of layer.
bool	Visible [get, set]
	Gets or sets the visibility of the layer.
IGeoContext	GeoContext [get, set]
	Gets or sets the GeoContext related to the layer.
IGeoLayerViewFactory	GeoLayerViewFactory [get]
	Gets a factory responsible for creating a IGeoLayerViewFactory view.
IGeoLayerView	GeoLayerView [get, set]
	Gets or sets the view associated with this view model.
IGeoNavigator	GeoNavigator [get, set]
	Gets or sets the GeoNavigator related to the GeoControl.
IGeoControlViewModel	GeoControlViewModel [get, set]
	Get or set geo control view model.
ClipMargins	ClipMargins [get, set]
	Enables or disables clipping of the contents of the view, based on the specifed clip margins.
HashSet< object >	DirtySources [get]
	All contributors to current dirty.
UIElement	Tooltip [get, set]
	Get or set tooltip UI element.

Events
VisibleChangedEventHandler	VisibleChanged = delegate { }
LayerChangedEventHandler	LayerChanged = delegate { }
Events inherited from TPG.GeoFramework.Core.ViewModelBase
PropertyChangedEventHandler	PropertyChanged = delegate { }
	Raised when a property on this object has a new value.
Events inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
VisibleChangedEventHandler	VisibleChanged
	Visibility changed.
LayerChangedEventHandler	LayerChanged
	Layer changed.

Member Function Documentation

Generate()

virtual void TPG.GeoFramework.Core.GeoLayerViewModel.Generate ( )

inlinevirtual

Requests that the layer generates it's view.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

Reimplemented in TPG.GeoFramework.GridLayer.GridLayerViewModel, TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel, and TPG.GeoFramework.VideoMetadataLayer.VideoMetadataLayerViewModel.

HandleInputEvent()

abstract void TPG.GeoFramework.Core.GeoLayerViewModel.HandleInputEvent ( GeoInputEventArgs  inputEventArgs )

pure virtual

Called to forward events to the layer.

Parameters

inputEventArgs

If the layer handles the event, it must set the Handled property to true.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

Implemented in TPG.GeoFramework.Interaction.InteractionLayerViewModel, TPG.GeoFramework.DrawObjectLayer.DrawObjectLayerViewModel, TPG.GeoFramework.GridLayer.GridLayerViewModel, TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel, TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel, TPG.GeoFramework.ElevationAnalysisLayer.MinMaxElevMarkerLayerViewModel, TPG.GeoFramework.SearchLayer.SearchLayerViewModel, TPG.GeoFramework.Lybin.LybinViewModel, TPG.GeoFramework.PropagationLayer.Network.RadioUnitNetworkLayerViewModel, TPG.GeoFramework.MapLayer.NativeMapLayerViewModel, TPG.GeoFramework.RadioPropagation.Provider.RadioConnectivityViewModel, TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel, TPG.GeoFramework.Terminator.TerminatorViewModel, TPG.GeoFramework.TerrainRoutingLayer.TerrainRoutingViewModel, TPG.GeoFramework.TrackLayer.TrackLayerViewModel, and TPG.GeoFramework.VideoMetadataLayer.VideoMetadataLayerViewModel.

IsDirty()

virtual bool TPG.GeoFramework.Core.GeoLayerViewModel.IsDirty ( )

inlinevirtual

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

Reimplemented in TPG.GeoFramework.MapLayer.NativeMapLayerViewModel.

OnDispose()

override void TPG.GeoFramework.Core.GeoLayerViewModel.OnDispose ( bool  disposing )

inlineprotectedvirtual

Make sure that all layers disconnect their shared GeoContexts.

Parameters

disposing

True if actual disposal.

Reimplemented from TPG.GeoFramework.Core.ViewModelBase.

Reimplemented in TPG.GeoFramework.Interaction.InteractionLayerViewModel.

SetDirty() [1/2]

virtual void TPG.GeoFramework.Core.GeoLayerViewModel.SetDirty ( bool  isDirty )

inlinevirtual

Sets a boolean value indicating the need for an update of the contents of a layer.

Parameters

isDirty

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

Reimplemented in TPG.GeoFramework.ElevationAnalysisLayer.MinMaxElevMarkerLayerViewModel, TPG.GeoFramework.DrawObjectLayer.DrawObjectLayerViewModel, and TPG.GeoFramework.TrackLayer.TrackLayerViewModel.

SetDirty() [2/2]

void TPG.GeoFramework.Core.GeoLayerViewModel.SetDirty ( object  dirtySource )

inline

Sets dirty flag and stores sender, use to avoid cyclic dirtying.

Parameters

sender

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

SetVisible()

virtual void TPG.GeoFramework.Core.GeoLayerViewModel.SetVisible ( bool  value )

inlineprotectedvirtual

Reimplemented in TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.

Update()

abstract void TPG.GeoFramework.Core.GeoLayerViewModel.Update ( )

pure virtual

Event called at regular intervals to update contents of the layer.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

Implemented in TPG.GeoFramework.Interaction.InteractionLayerViewModel, TPG.GeoFramework.DrawObjectLayer.DrawObjectLayerViewModel, TPG.GeoFramework.GridLayer.GridLayerViewModel, TPG.GeoFramework.HeatMapLayer.HeatMapLayerViewModel, TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel, TPG.GeoFramework.ElevationAnalysisLayer.MinMaxElevMarkerLayerViewModel, TPG.GeoFramework.SearchLayer.SearchLayerViewModel, TPG.GeoFramework.Lybin.LybinViewModel, TPG.GeoFramework.PropagationLayer.Network.RadioUnitNetworkLayerViewModel, TPG.GeoFramework.MapLayer.NativeMapLayerViewModel, TPG.GeoFramework.RadioPropagation.Provider.RadioConnectivityViewModel, TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel, TPG.GeoFramework.Terminator.TerminatorViewModel, TPG.GeoFramework.TerrainRoutingLayer.TerrainRoutingViewModel, TPG.GeoFramework.TrackLayer.TrackLayerViewModel, and TPG.GeoFramework.VideoMetadataLayer.VideoMetadataLayerViewModel.

Property Documentation

ClipMargins

ClipMargins TPG.GeoFramework.Core.GeoLayerViewModel.ClipMargins

getset

Enables or disables clipping of the contents of the view, based on the specifed clip margins.

Set the clip margins, e.g. ClipLeftMargin, to specify a clip rectangle.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

DirtySources

HashSet<object> TPG.GeoFramework.Core.GeoLayerViewModel.DirtySources

get

All contributors to current dirty.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

GeoContext

IGeoContext TPG.GeoFramework.Core.GeoLayerViewModel.GeoContext

getset

Gets or sets the GeoContext related to the layer.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

GeoControlViewModel

IGeoControlViewModel TPG.GeoFramework.Core.GeoLayerViewModel.GeoControlViewModel

getset

Get or set geo control view model.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

GeoLayerView

IGeoLayerView TPG.GeoFramework.Core.GeoLayerViewModel.GeoLayerView

getset

Gets or sets the view associated with this view model.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

GeoLayerViewFactory

IGeoLayerViewFactory TPG.GeoFramework.Core.GeoLayerViewModel.GeoLayerViewFactory

getset

Gets a factory responsible for creating a IGeoLayerViewFactory view.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

GeoNavigator

IGeoNavigator TPG.GeoFramework.Core.GeoLayerViewModel.GeoNavigator

getset

Gets or sets the GeoNavigator related to the GeoControl.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

Name

string TPG.GeoFramework.Core.GeoLayerViewModel.Name

get

A name representing the type of layer.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

Tooltip

UIElement TPG.GeoFramework.Core.GeoLayerViewModel.Tooltip

getset

Get or set tooltip UI element.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

Visible

bool TPG.GeoFramework.Core.GeoLayerViewModel.Visible

getset

Gets or sets the visibility of the layer.

Implements TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel.

---

The documentation for this class was generated from the following file:

• Src/Common/TPG.GeoFramework.Core/GeoLayerViewModel.cs