User Tools

Site Tools


thinkgeo.mapsuite.core.rasterlayer

ThinkGeo.MapSuite.Core.RasterLayer

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This abstract class is the basis for all image-based layers in the system.

Inheritance Hierarchy

Members Summary

Public Constructors

Protected Constructors

RasterLayer()

  • This is a constructor for the class. If you use this constructor, you should set the properties you need manually.
Remarks
  • If you use this constructor, you should set the properties you need manually.
Parameters

Public Methods

GetProjectionText()

  • This method returns the projection parameters of the current layer.
Remarks
  • This method returns the projection parameters of the current layer.
Return Value
  • Type:String
  • Description:This method returns the projection parameters of the current layer.
Parameters

GetHorizontalResolution()

  • This method returns the horizontal resolution of the image.
Remarks
  • This method returns the horizontal resolution of the image.
Return Value
  • Type:Single
  • Description:This method returns the horizontal resolution of the image.
Parameters

GetVerticalResolution()

  • This method returns the vertical resolution of the image.
Remarks
  • This method returns the vertical resolution of the image.
Return Value
  • Type:Single
  • Description:This method returns the vertical resolution of the image.
Parameters

RequestDrawing()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

GetThreadSafetyLevel()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Layer
  • Description:N/A
Parameters

Open()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Close()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetBoundingBox()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Draw(GeoCanvas,Collection<SimpleCandidate>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

GetBoundingBoxCore()

  • This method returns the bounding box of the RasterLayer.
Remarks
  • This method returns the bounding box of the RasterLayer.
Return Value
  • Description:This method returns the bounding box of the RasterLayer.
Parameters

OpenCore()

  • This method opens the RasterLayer so that it is initialized and ready to use.
Remarks
  • The open method plays an important rol,e as it is responsible for initializing the RasterLayer. Most methods on the RasterLayer will throw an exception if the state of the RasterLayer is not opened. When the map draws each layer, it will open the RasterLayer as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the RasterLayer.
Return Value
  • Type:Void
  • Description:None
Parameters

CloseCore()

  • This method opens the RasterLayer so that it is initialized and ready to use.
Remarks
  • The close method plays an important role in the life cycle of the RasterLayer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed RasterLayer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
Return Value
  • Type:Void
  • Description:None
Parameters

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

  • This method will draw the image from the GeoImage source based on the parameters provided.
Remarks
  • The DrawCore method will be called when the layer is being drawn. It will determine if the image is within the extent and the threshold defined. If these parameters are met, it will query the RasterSource for an image and then apply the other various properties (such as transparency, etc.) on the image. Lastly, it will draw the image on the GeoImage or native image passed into the method.
Return Value
  • Type:Void
  • Description:None
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the GeoCanvas used to Draw the RasterLayer.
  • labelsInAllLayers
    • Type:Collection<SimpleCandidate>
    • Description:This parameter is not used for ImageLayers.

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetThreadSafetyLevelCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Layer
  • Description:N/A
Parameters

DrawException(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:Exception
    • Description:N/A

DrawExceptionCore(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:Exception
    • Description:N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnException(DrawnExceptionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawAttributionCore(GeoCanvas,String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • attribution
    • Type:String
    • Description:N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit)

  • This method returns whether the current extent is within the upper and lower threshold properties.
Remarks
  • This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided.
Return Value
  • Type:Boolean
  • Description:This method returns whether the current extent is within the upper and lower threshold properties.
Parameters
  • currentExtent
    • Description:This parameter is the current extent that you want determine is within the thresholds defined.
  • upperThreshold
    • Type:Double
    • Description:This parameter is the upper threshold used to test the extent.
  • lowerThreshold
    • Type:Double
    • Description:This parameter is the lower threshold used to test the extent.
  • canvasWidth
    • Type:Int32
    • Description:This parameter is the width of the canvas.
  • mapUnit
    • Description:This parameter is the unit of the map.

IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit,Single)

  • This method returns whether the current extent is within the upper and lower threshold properties.
Remarks
  • This method is used to determine whether the RasterLayer needs to draw based on the current extent and the the threshold parameters provided.
Return Value
  • Type:Boolean
  • Description:This method returns whether the current extent is within the upper and lower threshold properties.
Parameters
  • currentExtent
    • Description:This parameter is the current extent that you want determine is within the thresholds defined.
  • upperThreshold
    • Type:Double
    • Description:This parameter is the upper threshold used to test the extent.
  • lowerThreshold
    • Type:Double
    • Description:This parameter is the lower threshold used to test the extent.
  • canvasWidth
    • Type:Int32
    • Description:This parameter is the width of the canvas.
  • mapUnit
    • Description:This parameter is the unit of the map.
  • dpi
    • Type:Single
    • Description:This parameter is the dpi of the current extent.

Public Properties

ImageSource

This property gets and sets the ImageSource used by the RasterLayer.

Remarks

The set for this property is protected and only intended to be used by developers who are creating their own ImageSources. This is the main property to set for developers who are creating their own RasterLayer derivatives.

Return Value

WrappingMode

N/A

Remarks

N/A

Return Value

WrappingExtent

N/A

Remarks

N/A

Return Value

UpperThreshold

This property gets and sets the upper threshold in the scale at which to display the image.

Remarks

Above the upper threshold in scale, the image will not be displayed. This, in conjunction with the LowerThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is double.min. This means the image should always display.

Return Value
  • Type:Double

LowerThreshold

This property gets and sets the lower threshold in the scale at which to display the image.

Remarks

Below the lower threshold in scale, the image will not be displayed. This, in conjunction with the UpperThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is double.min. This means the image should always display.

Return Value
  • Type:Double

HasProjectionText

This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters.

Remarks

N/A

Return Value
  • Type:Boolean

RequestDrawingInterval

N/A

Remarks

N/A

Return Value
  • Type:TimeSpan

IsOpen

N/A

Remarks

N/A

Return Value
  • Type:Boolean

HasBoundingBox

N/A

Remarks

N/A

Return Value
  • Type:Boolean

DrawingTime

N/A

Remarks

N/A

Return Value
  • Type:TimeSpan

Name

N/A

Remarks

N/A

Return Value
  • Type:String

Attribution

N/A

Remarks

N/A

Return Value
  • Type:String

IsVisible

N/A

Remarks

N/A

Return Value
  • Type:Boolean

Transparency

N/A

Remarks

N/A

Return Value
  • Type:Single

BlueTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

RedTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

GreenTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

KeyColors

N/A

Remarks

N/A

Return Value

IsNegative

N/A

Remarks

N/A

Return Value
  • Type:Boolean

IsGrayscale

N/A

Remarks

N/A

Return Value
  • Type:Boolean

DrawingExceptionMode

N/A

Remarks

N/A

Return Value

Protected Properties

IsOpenCore

This property returns true if the RasterLayer is open and false if it is not.

Remarks

Various methods on the RasterLayer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the RasterLayer's Open method. The method will raise an exception if the current RasterLayer is already open.

Return Value
  • Type:Boolean

Public Events

RequestedDrawing N/A

Remarks

N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing N/A

Remarks

N/A

Event Arguments:RequestingDrawingLayerEventArgs

DrawingProgressChanged N/A

Remarks

N/A

Event Arguments:DrawingProgressChangedEventArgs

DrawingException N/A

Remarks

N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawnException N/A

Remarks

N/A

Event Arguments:DrawnExceptionLayerEventArgs

DrawingAttribution N/A

Remarks

N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution N/A

Remarks

N/A

Event Arguments:DrawnAttributionLayerEventArgs

thinkgeo.mapsuite.core.rasterlayer.txt · Last modified: 2017/03/16 21:59 (external edit)