View model for elevation analysis layer. More...

Inheritance diagram for TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel:

Public Member Functions

ElevationAnalysisLayerViewModel (IMapResources mapResources, IUndoRedoStack undoRedoStack, IGeoContext geoContext, IGeoUnitsSetting geoUnitsSetting, int maxRange, IElevationAnalysisViewFactory layerViewFactory, IElevationAnalysisToolManager toolManager, string layerName)

Create a new instance of ElevationAnalysisLayerViewModel.

override void HandleInputEvent (GeoInputEventArgs inputEventArgs)

Called to forward events to the layer.

Parameters

inputEventArgs

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

override void Update ()

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

void UpdateObserver (IObserverData observerData)

Adds or updates an observer.

Parameters

observerData The observer to add or update.

void ActivateCreationWorkflow (ObserverType observerType, IObserverData initialData=null)

Activates a creation workflow in this layer.

Parameters

observerType	Observer type.
initialData	Initial data for the observer. If no initial data is given, a new is created.

void DeactivateCreationWorkflow ()

Deactivates the currently active workflow.

bool HasActiveCreationWorkflow ()

Checks if layer has an active workflow.

Returns: True if an active workflow exists.

void SetUndoRedoStack (IUndoRedoStack undoRedoStack)

Sets a new undo redo stack to use.

Parameters

undoRedoStack The undo redo stack.

void UndoRedoAddObserverData (IObserverData observerData)

Add observer data for undo/redo stack.

Parameters

observerData Observer data to add.

void UndoRedoRemoveObserData (IObserverData observerData)

Remove observer data for undo/redo stack.

Parameters

observerData Observer data to remove.

void UndoRedoUpdateObserverData (IObserverData observerData)

Update observer data for undo/redo stack.

Parameters

observerData Observer data to update.

List< string > GetClickedObservers (Point point)

Get observer ids at clicked position.

Parameters

point Clicked position.

Returns: List of ids.

Public Member Functions inherited from TPG.GeoFramework.Core.GeoLayerViewModel

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

void UpdateObserver (IObserverData observerData)

Adds or updates an observer.

void ActivateCreationWorkflow (ObserverType observerType, IObserverData initialData=null)

Activates a creation workflow in this layer.

void DeactivateCreationWorkflow ()

Deactivates the currently active workflow.

bool HasActiveCreationWorkflow ()

Checks if layer has an active workflow.

void SetUndoRedoStack (IUndoRedoStack undoRedoStack)

Sets a new undo redo stack to use.

List< string > GetClickedObservers (Point point)

Get observer ids at clicked position.

void UndoRedoAddObserverData (IObserverData observerData)

Add observer data for undo/redo stack.

void UndoRedoRemoveObserData (IObserverData observerData)

Remove observer data for undo/redo stack.

void UndoRedoUpdateObserverData (IObserverData observerData)

Update observer data for undo/redo stack.

Protected Member Functions
override void	SetVisible (bool value)
	Set RasterLayerData visibility to same value as this layer.

Protected Member Functions inherited from TPG.GeoFramework.Core.GeoLayerViewModel
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)

Properties
DrawingVisual	RenderTarget `[get, set]`
	The render target to use for rendering in this layer.

ObservableCollection< IObserverData >	Observers `[get]`
	The active observers.

int	NumActiveCalculations `[get, set]`
	The number of currently running elevation analysis calculations. These calculations are run asynchronously and may take some time. There will be at most one active calculation per observer.

Properties inherited from TPG.GeoFramework.Core.GeoLayerViewModel
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.

Properties inherited from TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel
DrawingVisual	RenderTarget `[get, set]`
	The render target to use for rendering in this layer.

ObservableCollection< IObserverData >	Observers `[get]`
	The active observers.

int	NumActiveCalculations `[get, set]`
	The number of currently running elevation analysis calculations. These calculations are run asynchronously and may take some time. There will be at most one active calculation per observer.

Additional Inherited Members
Protected Attributes inherited from TPG.GeoFramework.Core.GeoLayerViewModel
string	_name = null

Events inherited from TPG.GeoFramework.Core.GeoLayerViewModel
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.

Detailed Description

View model for elevation analysis layer.

Constructor & Destructor Documentation

◆ ElevationAnalysisLayerViewModel()

TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.ElevationAnalysisLayerViewModel	(	IMapResources	mapResources,
		IUndoRedoStack	undoRedoStack,
		IGeoContext	geoContext,
		IGeoUnitsSetting	geoUnitsSetting,
		int	maxRange,
		IElevationAnalysisViewFactory	layerViewFactory,
		IElevationAnalysisToolManager	toolManager,
		string	layerName
	)

inline

Create a new instance of ElevationAnalysisLayerViewModel.

Parameters

mapResources	Map resources to use.
undoRedoStack	Undo redo stack to use. Can be null.
geoContext	The associated geo context.
geoUnitsSetting	The associated geo unit settings.
maxRange	Optional maximum observer radius, in m.
layerViewFactory	Factory for creating layer view.
toolManager	Manager for elevation analysis tools.
layerName	Name of elevation analysis layer.

Member Function Documentation

◆ ActivateCreationWorkflow()

void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.ActivateCreationWorkflow	(	ObserverType	observerType,
		IObserverData	initialData = `null`
	)

inline

Activates a creation workflow in this layer.

Parameters

observerType	Observer type.
initialData	Initial data for the observer. If no initial data is given, a new is created.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

◆ DeactivateCreationWorkflow()

void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.DeactivateCreationWorkflow ( )

inline

Deactivates the currently active workflow.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

◆ GetClickedObservers()

List< string > TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.GetClickedObservers ( Point point )

inline

Get observer ids at clicked position.

Parameters

point Clicked position.

Returns: List of ids.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

◆ HandleInputEvent()

override void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.HandleInputEvent ( GeoInputEventArgs inputEventArgs )

inlinevirtual

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.Core.GeoLayerViewModel.

◆ HasActiveCreationWorkflow()

bool TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.HasActiveCreationWorkflow ( )

inline

Checks if layer has an active workflow.

Returns: True if an active workflow exists.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

◆ SetUndoRedoStack()

void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.SetUndoRedoStack ( IUndoRedoStack undoRedoStack )

inline

Sets a new undo redo stack to use.

Parameters

undoRedoStack The undo redo stack.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

◆ SetVisible()

override void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.SetVisible ( bool value )

inlineprotectedvirtual

Set RasterLayerData visibility to same value as this layer.

Parameters

value Visibility value.

Reimplemented from TPG.GeoFramework.Core.GeoLayerViewModel.

◆ UndoRedoAddObserverData()

void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.UndoRedoAddObserverData ( IObserverData observerData )

inline

Add observer data for undo/redo stack.

Parameters

observerData Observer data to add.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerUndoRedo.

◆ UndoRedoRemoveObserData()

void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.UndoRedoRemoveObserData ( IObserverData observerData )

inline

Remove observer data for undo/redo stack.

Parameters

observerData Observer data to remove.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerUndoRedo.

◆ UndoRedoUpdateObserverData()

void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.UndoRedoUpdateObserverData ( IObserverData observerData )

inline

Update observer data for undo/redo stack.

Parameters

observerData Observer data to update.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerUndoRedo.

◆ Update()

override void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.Update ( )

inlinevirtual

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

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

◆ UpdateObserver()

void TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.UpdateObserver ( IObserverData observerData )

inline

Adds or updates an observer.

Parameters

observerData The observer to add or update.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

Property Documentation

◆ NumActiveCalculations

int TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.NumActiveCalculations

getset

The number of currently running elevation analysis calculations. These calculations are run asynchronously and may take some time. There will be at most one active calculation per observer.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

◆ Observers

ObservableCollection<IObserverData> TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.Observers

get

The active observers.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

◆ RenderTarget

DrawingVisual TPG.GeoFramework.ElevationAnalysisLayer.ElevationAnalysisLayerViewModel.RenderTarget

getset

The render target to use for rendering in this layer.

Implements TPG.GeoFramework.ElevationAnalysisLayer.Contracts.IElevationAnalysisLayerViewModel.

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

Src/Layers/LineOfSight/LineOfSightLayer/ElevationAnalysisLayerViewModel.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ElevationAnalysisLayerViewModel()

Member Function Documentation

◆ ActivateCreationWorkflow()

◆ DeactivateCreationWorkflow()

◆ GetClickedObservers()

◆ HandleInputEvent()

◆ HasActiveCreationWorkflow()

◆ SetUndoRedoStack()

◆ SetVisible()

◆ UndoRedoAddObserverData()

◆ UndoRedoRemoveObserData()

◆ UndoRedoUpdateObserverData()

◆ Update()

◆ UpdateObserver()

Property Documentation

◆ NumActiveCalculations

◆ Observers

◆ RenderTarget