====== ThinkGeo.Core.RasterLayer ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.Core.Layer ***ThinkGeo.Core.RasterLayer** *[[ThinkGeo.Core.GeoTiffRasterLayer]] *[[ThinkGeo.Core.NativeImageRasterLayer]] *[[ThinkGeo.Core.NoaaRadarRasterLayer]] *[[ThinkGeo.Core.WmsRasterLayer]] ===== Members Summary ===== ==== Public Constructors ==== ==== Protected Constructors ==== ** {{wiki:ProtectedMethod.gif|}} 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 ==== ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** * //N/A// == 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 ==
** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** * //N/A// == 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 ==
** {{wiki:PublicMethod.gif|}} CloneDeep() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.Layer|Layer]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Open() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Close() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.Core.SimpleCandidate|SimpleCandidate]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
===== Protected Methods ===== ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** * //N/A// == Remarks == * //This method returns the bounding box of the RasterLayer.// == Return Value == * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:This method returns the bounding box of the RasterLayer. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** * //N/A// == 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 ==
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** * //N/A// == 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 ==
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection) ** * //N/A// == 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 NativeImage or native image passed into the method.// == Return Value == * Type:Void * Description:None == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:This parameter is the GeoCanvas used to Draw the RasterLayer. * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.Core.SimpleCandidate|SimpleCandidate]]> * Description:This parameter is not used for ImageLayers.
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.Layer|Layer]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //attribution// * Type:String * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} ImageSource ** * //N/A// == 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 == * Type:[[ThinkGeo.Core.RasterSource|RasterSource]] ** {{wiki:PublicProperty.gif|}} WrappingMode ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.WrappingMode|WrappingMode]] ** {{wiki:PublicProperty.gif|}} WrappingExtent ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] ** {{wiki:PublicProperty.gif|}} UpperThreshold ** * //N/A// == 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 ** {{wiki:PublicProperty.gif|}} LowerThreshold ** * //N/A// == 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 ** {{wiki:PublicProperty.gif|}} ScaleFactor ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} Projection ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.Projection|Projection]] ** {{wiki:PublicProperty.gif|}} IsOpen ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} DrawingTime ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} Name ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Attribution ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} IsVisible ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} Transparency ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} BlueTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} RedTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} GreenTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} KeyColors ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection<[[ThinkGeo.Core.GeoColor|GeoColor]]> ** {{wiki:PublicProperty.gif|}} IsNegative ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsGrayscale ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} ColorMappings ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary<[[ThinkGeo.Core.GeoColor|GeoColor]],[[ThinkGeo.Core.GeoColor|GeoColor]]> ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.DrawingExceptionMode|DrawingExceptionMode]] ** {{wiki:PublicProperty.gif|}} ThreadSafe ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.ThreadSafetyLevel|ThreadSafetyLevel]] ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** * //N/A// == 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 ==== ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingException ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnException ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]