User Tools

Site Tools


thinkgeo.mapsuite.core.rasterlayer

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.Core.RasterLayer

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

Inheritance Hierarchy

Members Summary

Public Constructors

Protected Constructors

RasterLayer

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This is a constructor for the class. If you use this constructor, you should set the properties you need manually.

Public Methods

CloneDeep

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

Close

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

Draw

Equals

  • Parameters:Object
  • DeclaringType:Object
  • Summary:N/A

GetBoundingBox

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

GetHashCode

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetHorizontalResolution

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the horizontal resolution of the image.

GetProjectionText

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the projection parameters of the current layer.

GetThreadSafetyLevel

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

GetType

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetVerticalResolution

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the vertical resolution of the image.

Open

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

RequestDrawing

RequestDrawing

RequestDrawing

RequestDrawing

  • Parameters:TimeSpan
  • DeclaringType:Layer
  • Summary:N/A

RequestDrawing

RequestDrawing

RequestDrawing

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

RequestDrawing

RequestDrawing

ToString

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Protected Methods

CloneDeepCore

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

CloseCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method opens the RasterLayer so that it is initialized and ready to use.

DrawAttributionCore

DrawCore

  • Parameters:GeoCanvas,Collection<SimpleCandidate>
  • DeclaringType:N/A
  • Summary:This method will draw the image from the GeoImage source based on the parameters provided.

DrawException

DrawExceptionCore

Finalize

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetBoundingBoxCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the bounding box of the RasterLayer.

GetThreadSafetyLevelCore

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

IsExtentWithinThreshold

  • Parameters:RectangleShape,Double,Double,Int32,GeographyUnit
  • DeclaringType:N/A
  • Summary:This method returns whether the current extent is within the upper and lower threshold properties.

IsExtentWithinThreshold

  • Parameters:RectangleShape,Double,Double,Int32,GeographyUnit,Single
  • DeclaringType:N/A
  • Summary:This method returns whether the current extent is within the upper and lower threshold properties.

MemberwiseClone

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

OnDrawingAttribution

OnDrawingException

OnDrawingProgressChanged

OnDrawnAttribution

OnDrawnException

OnRequestedDrawing

OnRequestingDrawing

OpenCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method opens the RasterLayer so that it is initialized and ready to use.

Public Properties

Attribution

  • Return:String
  • Summary:N/A

BlueTranslation

  • Return:Single
  • Summary:N/A

DrawingExceptionMode

DrawingTime

  • Return:TimeSpan
  • Summary:N/A

GreenTranslation

  • Return:Single
  • Summary:N/A

HasBoundingBox

  • Return:Boolean
  • Summary:N/A

HasProjectionText

  • Return:Boolean
  • Summary:This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters.

ImageSource

  • Return:RasterSource
  • Summary:This property gets and sets the ImageSource used by the RasterLayer.

IsGrayscale

  • Return:Boolean
  • Summary:N/A

IsNegative

  • Return:Boolean
  • Summary:N/A

IsOpen

  • Return:Boolean
  • Summary:N/A

IsVisible

  • Return:Boolean
  • Summary:N/A

KeyColors

  • Return:Collection<GeoColor>
  • Summary:N/A

LowerThreshold

  • Return:Double
  • Summary:This property gets and sets the lower threshold in the scale at which to display the image.

Name

  • Return:String
  • Summary:N/A

RedTranslation

  • Return:Single
  • Summary:N/A

RequestDrawingInterval

  • Return:TimeSpan
  • Summary:N/A

Transparency

  • Return:Single
  • Summary:N/A

UpperThreshold

  • Return:Double
  • Summary:This property gets and sets the upper threshold in the scale at which to display the image.

Protected Properties

IsOpenCore

  • Return:Boolean
  • Summary:This property returns true if the RasterLayer is open and false if it is not.

Public Events

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

CloneDeep()

N/A

Remarks

N/A

Return Value

  • Return Type:Layer
  • Description:N/A

Parameters

Close()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

Draw(GeoCanvas,Collection<SimpleCandidate>)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

labelsInAllLayers

Go Back

Equals(Object)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

obj

  • Type:Object
  • Description:N/A

Go Back

GetBoundingBox()

N/A

Remarks

N/A

Return Value

Parameters

GetHashCode()

N/A

Remarks

N/A

Return Value

  • Return Type:Int32
  • Description:N/A

Parameters

GetHorizontalResolution()

This method returns the horizontal resolution of the image.

Remarks

This method returns the horizontal resolution of the image.

Return Value

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

Parameters

GetProjectionText()

This method returns the projection parameters of the current layer.

Remarks

This method returns the projection parameters of the current layer.

Return Value

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

Parameters

GetThreadSafetyLevel()

N/A

Remarks

N/A

Return Value

Parameters

GetType()

N/A

Remarks

N/A

Return Value

  • Return Type:Type
  • Description:N/A

Parameters

GetVerticalResolution()

This method returns the vertical resolution of the image.

Remarks

This method returns the vertical resolution of the image.

Return Value

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

Parameters

Open()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

RequestDrawing(RectangleShape,TimeSpan)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentToRefresh

bufferTime

  • Type:TimeSpan
  • Description:N/A

Go Back

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentsToRefresh

bufferTime

  • Type:TimeSpan
  • Description:N/A

bufferTimeType

Go Back

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

bufferTime

  • Type:TimeSpan
  • Description:N/A

bufferTimeType

Go Back

RequestDrawing(TimeSpan)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

bufferTime

  • Type:TimeSpan
  • Description:N/A

Go Back

RequestDrawing(IEnumerable<RectangleShape>)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentsToRefresh

Go Back

RequestDrawing(RectangleShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentToRefresh

Go Back

RequestDrawing()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentToRefresh

bufferTime

  • Type:TimeSpan
  • Description:N/A

bufferTimeType

Go Back

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentsToRefresh

bufferTime

  • Type:TimeSpan
  • Description:N/A

Go Back

ToString()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

Protected Methods

CloneDeepCore()

N/A

Remarks

N/A

Return Value

  • Return Type:Layer
  • Description:N/A

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

  • Return Type:Void
  • Description:None

Parameters

DrawAttributionCore(GeoCanvas,String)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

attribution

  • Type:String
  • Description:N/A

Go Back

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

  • Return 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.

Go Back

DrawException(GeoCanvas,Exception)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

e

  • Type:Exception
  • Description:N/A

Go Back

DrawExceptionCore(GeoCanvas,Exception)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

e

  • Type:Exception
  • Description:N/A

Go Back

Finalize()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

GetBoundingBoxCore()

This method returns the bounding box of the RasterLayer.

Remarks

This method returns the bounding box of the RasterLayer.

Return Value

  • Return Type:RectangleShape
  • Description:This method returns the bounding box of the RasterLayer.

Parameters

GetThreadSafetyLevelCore()

N/A

Remarks

N/A

Return Value

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

  • Return 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.

Go Back

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

  • Return 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.

Go Back

MemberwiseClone()

N/A

Remarks

N/A

Return Value

  • Return Type:Object
  • Description:N/A

Parameters

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

args

Go Back

OnDrawingException(DrawingExceptionLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

args

Go Back

OnDrawnException(DrawnExceptionLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

eventArgs

Go Back

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

eventArgs

Go Back

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

  • Return Type:Void
  • Description:None

Parameters

Public Properties

Attribution

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

BlueTranslation

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

DrawingExceptionMode

N/A

Remarks

N/A

Return Value

DrawingTime

N/A

Remarks

N/A

Return Value

Return Type:TimeSpan

Go Back

GreenTranslation

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

HasBoundingBox

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

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

Return Type:Boolean

Go Back

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

Return Type:RasterSource

Go Back

IsGrayscale

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

IsNegative

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

IsOpen

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

IsVisible

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

KeyColors

N/A

Remarks

N/A

Return Value

Return Type:Collection<GeoColor>

Go Back

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

Return Type:Double

Go Back

Name

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

RedTranslation

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

RequestDrawingInterval

N/A

Remarks

N/A

Return Value

Return Type:TimeSpan

Go Back

Transparency

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

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

Return Type:Double

Go Back

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

Return Type:Boolean

Go Back

Public Events

DrawingAttribution

N/A

Remarks

DrawingException

N/A

Remarks

DrawingProgressChanged

N/A

Remarks

DrawnAttribution

N/A

Remarks

DrawnException

N/A

Remarks

RequestedDrawing

N/A

Remarks

RequestingDrawing

N/A

Remarks

thinkgeo.mapsuite.core.rasterlayer.1442486292.txt.gz · Last modified: 2015/09/17 10:38 by admin