Maria GDK 4.5.0.137
Documentation of managed code in release branch
Loading...
Searching...
No Matches
TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer Interface Reference

Interface to be implemented by layers that want to provide export functionality. More...

Inheritance diagram for TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer:
TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel TPG.GeoFramework.Contracts.Geo.Layer.IViewModelBase TPG.GeoFramework.DrawObjectLayer.Contracts.IDrawObjectLayerViewModel TPG.GeoFramework.GridLayer.Contracts.IGridLayerViewModel TPG.GeoFramework.MapLayer.Contracts.IMapLayerViewModel TPG.GeoFramework.RoutePlanningLayer.Contracts.IRoutePlanningLayerViewModel TPG.GeoFramework.TrackLayer.Contracts.Layer.ITrackLayerViewModel TPG.GeoFramework.DrawObjectLayer.DrawObjectLayerViewModel TPG.GeoFramework.GridLayer.GridLayerViewModel TPG.GeoFramework.MapLayer.NativeMapLayerViewModel TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel TPG.GeoFramework.TrackLayer.TrackLayerViewModel

Public Member Functions

void PreExport ()
 Called before actual export is performed. The layer must ensure that state that changes the appearance of the layer is not altered.
 
void Export (Canvas canvas, IGeoContext geoContext, double targetDpi)
 The actual export function. Implementing classes should draw their content using the provided canvas and geo context.
 
void PostExport ()
 Called after export is performed. After this no more export functions will be called and the layer should go back to normal operation.
 
- Public Member Functions inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
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 ()
 

Additional Inherited Members

- 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.Contracts.Geo.Layer.IViewModelBase
string DisplayName [get]
 
- Events inherited from TPG.GeoFramework.Contracts.Geo.Layer.IGeoLayerViewModel
VisibleChangedEventHandler VisibleChanged
 Visibility changed.
 
LayerChangedEventHandler LayerChanged
 Layer changed.
 

Detailed Description

Interface to be implemented by layers that want to provide export functionality.

Member Function Documentation

◆ Export()

void TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.Export ( Canvas  canvas,
IGeoContext  geoContext,
double  targetDpi 
)

The actual export function. Implementing classes should draw their content using the provided canvas and geo context.

Parameters
canvasThe canvas to draw into.
geoContextThe geo context relevant for this export.
targetDpiThe wanted dpi for the export.

Implemented in TPG.GeoFramework.DrawObjectLayer.DrawObjectLayerViewModel, TPG.GeoFramework.GridLayer.GridLayerViewModel, TPG.GeoFramework.MapLayer.NativeMapLayerViewModel, TPG.GeoFramework.RoutePlanningLayer.RoutePlanningLayerViewModel, and TPG.GeoFramework.TrackLayer.TrackLayerViewModel.

◆ PostExport()

void TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.PostExport ( )

◆ PreExport()

void TPG.GeoFramework.Contracts.Geo.Layer.IExportableLayer.PreExport ( )

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