Maria GDK 4.5.0.137
Documentation of managed code in release branch
Loading...
Searching...
No Matches
TPG.GeoFramework.Interaction.InteractionLayerViewModel Class Reference

View model for layer with interaction capabilities. More...

Inheritance diagram for TPG.GeoFramework.Interaction.InteractionLayerViewModel:
TPG.GeoFramework.Core.GeoLayerViewModel TPG.GeoFramework.Interaction.Contracts.IInteractionLayerViewModel TPG.GeoFramework.Core.ViewModelBase TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase

Public Member Functions

 InteractionLayerViewModel (IGeoContext geoContext, IGeoNavigator geoNavigator, IGeoLayerViewFactory viewFactory)
 Constructor.
 
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.
 
- 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 ()
 

Protected Member Functions

override void OnDispose (bool disposing)
 Make sure that all layers disconnect their shared GeoContexts.
 
- 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

ObservableCollection< IInteractionManagerInteractionManagers [get]
 Get interaction managers.
 
- 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.Interaction.Contracts.IInteractionLayerViewModel
ObservableCollection< IInteractionManagerInteractionManagers [get]
 Get interaction managers.
 

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 layer with interaction capabilities.

Constructor & Destructor Documentation

◆ InteractionLayerViewModel()

TPG.GeoFramework.Interaction.InteractionLayerViewModel.InteractionLayerViewModel ( IGeoContext  geoContext,
IGeoNavigator  geoNavigator,
IGeoLayerViewFactory  viewFactory 
)
inline

Constructor.

Parameters
geoContextGeo context.
geoNavigatorGeo navigator.
viewFactoryLayer view factory.


Member Function Documentation

◆ HandleInputEvent()

override void TPG.GeoFramework.Interaction.InteractionLayerViewModel.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.

◆ OnDispose()

override void TPG.GeoFramework.Interaction.InteractionLayerViewModel.OnDispose ( bool  disposing)
inlineprotectedvirtual

Make sure that all layers disconnect their shared GeoContexts.

Parameters
disposingTrue if actual disposal.

Reimplemented from TPG.GeoFramework.Core.GeoLayerViewModel.

◆ Update()

override void TPG.GeoFramework.Interaction.InteractionLayerViewModel.Update ( )
inlinevirtual

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

Implements TPG.GeoFramework.Core.GeoLayerViewModel.

Property Documentation

◆ InteractionManagers

ObservableCollection<IInteractionManager> TPG.GeoFramework.Interaction.InteractionLayerViewModel.InteractionManagers
get

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