TPG.GeoFramework.RasterExport.Contracts.OffscreenRasterExportFactory Class Reference

Factory for creating the different objects for performing offscreen exports. More...

Public Member Functions
async Task< IOffScreenRasterExporter >	NewOffScreenExporter (INativeRenderingManager renderingManager, GeoRect visibleGeoArea, int widthInPixels, int heightInPixels, bool adjustBitmapToViewport, double dpi, string displayProjection)
	Creates an implementation of IOffscreenRasterExport. The method also ensure that the WPF rendering thread has had some time to breathe, therefore it as made async. Has to be used with the async await pattern from the UI thread.
async Task< IOffScreenRasterExporter >	NewOffScreenExporterMetric (INativeRenderingManager renderingManager, GeoRect visibleGeoArea, double widthInMillimeters, double heightInMillimeters, bool adjustBitmapToViewport, double dpi, string displayProjection)
	Creates an implementation of IOffscreenRasterExport. The method also ensure that the WPF rendering thread has had some time to breathe, therefore it as made async. Has to be used with the async await pattern from the UI thread.
async Task< IComplexOffScreenExporter >	NewComplexOffScreenExporter (INativeRenderingManager renderingManager, GeoRect visibleGeoArea, int widthInPixels, int heightInPixels, bool adjustBitmapToViewport, double dpi, string displayProjection, int leftMarginInPixels, int topMarginInPixels, int rightMarginInPixels, int bottomMarginInPixels)
	Creates a new IComplexOffScreenExporter implementation based on pixel sizes. The method also ensure that the WPF rendering thread has had some time to breathe, therefore it as made async. Has to be used with the async await pattern from the UI thread.
async Task< IComplexOffScreenExporter >	NewComplexOffScreenExporterMetric (INativeRenderingManager renderingManager, GeoRect visibleGeoArea, double widthInMillimeters, double heightInMillimeters, bool adjustBitmapToViewport, double dpi, string displayProjection, double leftMarginInMillimeters, double topMarginInMillimeters, double rightMarginInMillimeters, double bottomMarginInMillimeters)
	Creates a new IComplexOffScreenExporter implementation based on metric sizes. The method also ensure that the WPF rendering thread has had some time to breathe, therefore it as made async. Has to be used with the async await pattern from the UI thread.

Detailed Description

Factory for creating the different objects for performing offscreen exports.

Member Function Documentation

NewComplexOffScreenExporter()

async Task< IComplexOffScreenExporter > TPG.GeoFramework.RasterExport.Contracts.OffscreenRasterExportFactory.NewComplexOffScreenExporter ( INativeRenderingManager  renderingManager, GeoRect  visibleGeoArea, int  widthInPixels, int  heightInPixels, bool  adjustBitmapToViewport, double  dpi, string  displayProjection, int  leftMarginInPixels, int  topMarginInPixels, int  rightMarginInPixels, int  bottomMarginInPixels  )

inline

Creates a new IComplexOffScreenExporter implementation based on pixel sizes. The method also ensure that the WPF rendering thread has had some time to breathe, therefore it as made async. Has to be used with the async await pattern from the UI thread.

Parameters

renderingManager
visibleGeoArea	The geographical area to export.
widthInPixels	The width in pixels of the resulting bitmap.
heightInPixels	The height in pixels of the resulting bitmap.
adjustBitmapToViewport	If true, the exported bitmap size will be adjusted to the map viewport.
dpi	Dpi of the resulting bitmap.
displayProjection	The display projection string.
leftMarginInPixels	Left margin measured in pixels.
topMarginInPixels	Top margin measured in pixels.
rightMarginInPixels	Right margin measured in pixels.
bottomMarginInPixels	Bottom margin measured in pixels.

Returns

The implementation.

NewComplexOffScreenExporterMetric()

async Task< IComplexOffScreenExporter > TPG.GeoFramework.RasterExport.Contracts.OffscreenRasterExportFactory.NewComplexOffScreenExporterMetric ( INativeRenderingManager  renderingManager, GeoRect  visibleGeoArea, double  widthInMillimeters, double  heightInMillimeters, bool  adjustBitmapToViewport, double  dpi, string  displayProjection, double  leftMarginInMillimeters, double  topMarginInMillimeters, double  rightMarginInMillimeters, double  bottomMarginInMillimeters  )

inline

Creates a new IComplexOffScreenExporter implementation based on metric sizes. The method also ensure that the WPF rendering thread has had some time to breathe, therefore it as made async. Has to be used with the async await pattern from the UI thread.

Parameters

renderingManager
visibleGeoArea	The geographical area to export.
widthInMillimeters	The width in pixels of the resulting bitmap.
heightInMillimeters	The height in pixels of the resulting bitmap.
adjustBitmapToViewport	If true, the exported bitmap size will be adjusted to the map viewport.
dpi	Dpi of the resulting bitmap.
displayProjection	The display projection string.
leftMarginInMillimeters	Left margin measured in millimeters.
topMarginInMillimeters	Top margin measured in millimeters.
rightMarginInMillimeters	Right margin measured in millimeters.
bottomMarginInMillimeters	Bottom margin measured in millimeters.

Returns

The implementation.

NewOffScreenExporter()

async Task< IOffScreenRasterExporter > TPG.GeoFramework.RasterExport.Contracts.OffscreenRasterExportFactory.NewOffScreenExporter ( INativeRenderingManager  renderingManager, GeoRect  visibleGeoArea, int  widthInPixels, int  heightInPixels, bool  adjustBitmapToViewport, double  dpi, string  displayProjection  )

inline

Creates an implementation of IOffscreenRasterExport. The method also ensure that the WPF rendering thread has had some time to breathe, therefore it as made async. Has to be used with the async await pattern from the UI thread.

Parameters

renderingManager
visibleGeoArea	The geographical area to export.
widthInPixels	The width in pixels of the resulting bitmap.
heightInPixels	The height in pixels of the resulting bitmap.
adjustBitmapToViewport	If true, the exported bitmap size will be adjusted to the map viewport.
dpi	Dpi of the resulting bitmap.
displayProjection	The display projection string.

Returns

The implementation.

NewOffScreenExporterMetric()

async Task< IOffScreenRasterExporter > TPG.GeoFramework.RasterExport.Contracts.OffscreenRasterExportFactory.NewOffScreenExporterMetric ( INativeRenderingManager  renderingManager, GeoRect  visibleGeoArea, double  widthInMillimeters, double  heightInMillimeters, bool  adjustBitmapToViewport, double  dpi, string  displayProjection  )

inline

Creates an implementation of IOffscreenRasterExport. The method also ensure that the WPF rendering thread has had some time to breathe, therefore it as made async. Has to be used with the async await pattern from the UI thread.

Parameters

renderingManager
visibleGeoArea	The geographical area to export.
widthInMillimeters	The width in pixels of the resulting bitmap.
heightInMillimeters	The height in pixels of the resulting bitmap.
adjustBitmapToViewport	If true, the exported bitmap size will be adjusted to the map viewport.
dpi	Dpi of the resulting bitmap.
displayProjection	The display projection string.

Returns

The implementation.

---

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

• Src/Layers/RasterExport/TPG.GeoFramework.RasterExport/Contracts/OffscreenRasterExportFactory.cs