RasterSource¶

Inheritance Hierarchy¶

• Object
• RasterSource
  • GeoTiffRasterSource
  • NativeImageRasterSource
  • NoaaRadarRasterSource
  • WmsRasterSource

Members Summary¶

Public Constructors Summary¶

Protected Constructors Summary¶

Public Properties Summary¶

Protected Properties Summary¶

Public Methods Summary¶

Protected Methods Summary¶

Public Events Summary¶

Members Detail¶

Public Constructors¶

Protected Constructors¶

RasterSource()¶

Summary

This is the default new constructor for the RasterSource.

Remarks

None

Return Value

Parameters

Public Properties¶

BlueTranslation¶

Summary

This property gets and sets the amount of blue to apply to the image.

Remarks

None

Return Value

Single

GreenTranslation¶

Summary

This property gets and sets the amount of green to apply to the image.

Remarks

None

Return Value

Single

IsGrayscale¶

Summary

This property gets and sets if the image should be converted to grayscale.

Remarks

None

Return Value

Boolean

IsNegative¶

Summary

This property gets and sets whether the image should be converted to negative (inverse colors).

Remarks

None

Return Value

Boolean

IsOpen¶

Summary

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

Remarks

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

Return Value

Boolean

Projection¶

Summary

N/A

Remarks

N/A

Return Value

Projection

ProjectionConverter¶

Summary

N/A

Remarks

N/A

Return Value

ProjectionConverter

RedTranslation¶

Summary

This property gets and sets the amount of red to apply to the image.

Remarks

None

Return Value

Single

ScaleFactor¶

Summary

The scale factor when drawing the primitive image. For example I am looking for an image with 100100px, If the ScaleFactor is set to 2, it means the component will get the image with 200200px. We want to keep it as 1 (by default) for most cases.

Remarks

N/A

Return Value

Double

Transparency¶

Summary

This property gets and sets the amount of transparency to apply to the image.

Remarks

None

Return Value

Single

Protected Properties¶

Public Methods¶

CloneDeep()¶

Summary

Create a copy of RasterSource using the deep clone process.

Remarks

The difference between deep clone and shallow clone is: when shallow cloned, only the object is copied, but the contained objects are not; while in deep clone it does copy the cloned object as well as all the objects within.

Return Value

Parameters

Close()¶

Summary

This method closes the RasterSource and releases any resources it was using.

Remarks

This method is the concrete wrapper for the abstract method CloseCore. The Close method plays an important role in the life cycle of the RasterSource. 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 the Core version of 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 RasterSource 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. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

Equals(Object)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GenerateWorldFileText(RectangleShape,Int32,Int32)¶

Summary

This method returns a string that represents the image's world file based on the parameters passed in.

Remarks

This method returns a string that represents the image's world file. The world file is a file type that can accompany image files. It contains information about the image's position, resolution and other spatial-related items. It is common to have this kind of file associated with generic image types such as JPG, BMP, and normal TIFF because they do not have a mechanism to store this data internally. Modern GIS image types such as JPEG2000, ECW, and MrSid typically have this information stored internally. We provide this method in the event that you want to create your own world file from any image that either already has one or has its data stored internally.

Return Value

Parameters

GetBoundingBox()¶

Summary

This method returns the bounding box of the RasterSource.

Remarks

This method returns the bounding box of the RasterSource. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

GetHashCode()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetHorizontalResolution()¶

Summary

This method returns the horizontal resolution of the image.

Remarks

This method returns the horizontal resolution of the image. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

GetImage(RectangleShape,Int32,Int32)¶

Summary

This method returns an image based on the worldExtent and image width and height.

Remarks

This method is responsible for returning the image based on the parameters passed in. As the core version of this method is abstract, you will need to override it when creating your own RasterSource. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

GetImageHeight()¶

Summary

This method returns the height of the image in screen coordinates.

Remarks

This method returns the height of the image in screen coordinates. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

GetImageWidth()¶

Summary

This method returns the width of the image in screen coordinates.

Remarks

This method returns the width of the image in screen coordinates. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

GetType()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetVerticalResolution()¶

Summary

This method returns the vertical resolution of the image.

Remarks

This method returns the vertical resolution of the image. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

GetWorldFileText()¶

Summary

This method returns a string that represents the image's world file.

Remarks

This method wraps the Core version of this method and returns a string that represents the image's world file. The world file is a file type that can accompany image files. It contains information about the image's position, resolution and other spatial-related items. It is common to have this kind of file associated with generic image types such as JPG, BMP, and normal TIFF because they do not have a mechanism to store this data internally. Modern GIS image types such as JPEG2000, ECW, and MrSid typically have this information stored internally. We provide this method in the event that you want to create your own world file from any image that either already has one or has its data stored internally. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

Open()¶

Summary

This method opens the RasterSource so that it is initialized and ready to use.

Remarks

This method is the concrete wrapper for the abstract method OpenCore. The Open method plays an important role, as it is responsible for initializing the RasterSource. Most methods on the RasterSource will throw an exception if the state of the RasterSource is not opened. When the map draws each layer, it will open the RasterSource 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 RasterSource. When implementing the abstract method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the RasterSource. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Parameters

ToString()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Protected Methods¶

CloneDeepCore()¶

Summary

Create a copy of RasterSource using the deep clone process. The default implementation uses serialization.

Remarks

The difference between deep clone and shallow clone is: when shallow cloned, only the object is copied, but the contained objects are not; while in deep clone it does copy the cloned object as well as all the objects within.

Return Value

Parameters

CloseCore()¶

Summary

This method opens the RasterSource so that it is initialized and ready to use.

Remarks

This protected virtual method is called from the concrete public method Close. The Close method plays an important role in the life cycle of the RasterSource. 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 RasterSource 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

Parameters

Finalize()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetBoundingBoxCore()¶

Summary

This method returns the bounding box of the RasterSource.

Remarks

This method returns the bounding box of the RasterSource.

Return Value

Parameters

GetImageCore(RectangleShape,Int32,Int32)¶

Summary

This method returns an image based on the worldExtent and image width and height.

Remarks

This method is responsible for returning the image based on the parameters passed in. As the core version of this method is abstract, you will need to override it when creating our own RasterSource.

Return Value

Parameters

GetImageHeightCore()¶

Summary

This method returns the height of the image in screen coordinates.

Remarks

This abstract method is called from the concrete method GetImageHeight. You need to override it if you inherit from the RasterSource to return the height of your image. It returns the height of the image in screen coordinates.

Return Value

Parameters

GetImageWidthCore()¶

Summary

This method returns the width of the image in screen coordinates.

Remarks

This abstract method is called from the concrete method GetImageWidth. You need to override it if you inherit from the RasterSource to return the width of your image. It returns the width of the image in screen coordinates.

Return Value

Parameters

GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

MemberwiseClone()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnChangedSourceStatus(ChangedSourceStatusEventArgs)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

OnClosedRasterSource(ClosedRasterSourceEventArgs)¶

Summary

This method allows you to raise the ClosedRasterSource event from a derived class.

Remarks

You can call this method from a derived class to enable it to raise the ClosedRasterSource event. This may be useful if you plan to extend the RasterSource and you need access to the event. Details on the event: This event is called after the closing of the RasterSource. Technically, this event is called after the calling of the Close method on the RasterSource and after the protected CloseCore method. It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.

Return Value

Parameters

OnClosingRasterSource(ClosingRasterSourceEventArgs)¶

Summary

This method allows you to raise the ClosingRasterSource event from a derived class.

Remarks

You can call this method from a derived class to enable it to raise the ClosingRasterSource event. This may be useful if you plan to extend the RasterSource and you need access to the event. Details on the event: This event is called before the closing of the RasterSource. Technically, this event is called after the calling of the Close method on the RasterSource, but before the protected CloseCore method. It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.

Return Value

Parameters

OnOpenedRasterSource(OpenedRasterSourceEventArgs)¶

Summary

This method allows you to raise the OpenedRasterSource event from a derived class.

Remarks

You can call this method from a derived class to enable it to raise the OpenedRasterSource event. This may be useful if you plan to extend the RasterSource and you need access to the event. Details on the event: This event is called after the opening of the RasterSource. Technically, this event is called after the calling of the Open method on the RasterSource and after the protected OpenCore method is called. It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.

Return Value

Parameters

OnOpeningRasterSource(OpeningRasterSourceEventArgs)¶

Summary

This method allows you to raise the OpeningRasterSource event from a derived class.

Remarks

You can call this method from a derived class to enable it to raise the OpeningRasterSource event. This may be useful if you plan to extend the RasterSource and you need access to the event. Details on the event: This event is called before the opening of the RasterSource. Technically, this event is called after the calling of the Open method on the RasterSource, but before the protected OpenCore method. It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.

Return Value

Parameters

OpenCore()¶

Summary

This method opens the RasterSource so that it is initialized and ready to use.

Remarks

This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the RasterSource. Most methods on the RasterSource will throw an exception if the state of the RasterSource is not opened. When the map draws each layer, it will open the RasterSource 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 RasterSource. When implementing this abstract method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the RasterSource.

Return Value

Parameters

Public Events¶

OpeningRasterSource¶

N/A

Remarks

This event is called before the opening of the RasterSource. Technically, this event is called after the calling of the Open method on the RasterSource, but before the protected OpenCore method. It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.

Event Arguments

OpeningRasterSourceEventArgs

OpenedRasterSource¶

N/A

Remarks

This event is called after the opening of the RasterSource. Technically, this event is called after the calling of the Open method on the RasterSource and after the protected OpenCore method is called. It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.

Event Arguments

OpenedRasterSourceEventArgs

ClosingRasterSource¶

N/A

Remarks

This event is called before the closing of the RasterSource. Technically, this event is called after the calling of the Close method on the RasterSource, but before the protected CloseCore method. It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.

Event Arguments

ClosingRasterSourceEventArgs

ClosedRasterSource¶

N/A

Remarks

This event is called after the closing of the RasterSource. Technically, this event is called after the calling of the Close method on the RasterSource and after the protected CloseCore method. It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.

Event Arguments

ClosedRasterSourceEventArgs