Click or drag to resize

CustomImageGlobeOverlay Class

A GlobeImageOverlay that allows for a user defined image to be specified.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Graphics.Advanced
Assembly:  AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public abstract class CustomImageGlobeOverlay : GlobeImageOverlay

The CustomImageGlobeOverlay type exposes the following members.

Constructors
  NameDescription
Protected methodCustomImageGlobeOverlay
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyAltitudeBasedTranslucencyLowerAltitude
Gets or sets the lower altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to . When the altitude of the viewer is at or below this value, the image will have the translucency specified by AltitudeBasedTranslucencyLowerTranslucency, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyLowerAltitude and AltitudeBasedTranslucencyUpperAltitude.
(Inherited from GlobeImageOverlay.)
Public propertyAltitudeBasedTranslucencyLowerTranslucency
Gets or sets the lower translucency value for the image when UseAltitudeBasedTranslucency is set to . When the altitude of the viewer is at or below AltitudeBasedTranslucencyLowerAltitude, the image will have the translucency specified by this property, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyLowerAltitude and AltitudeBasedTranslucencyUpperAltitude.
(Inherited from GlobeImageOverlay.)
Public propertyAltitudeBasedTranslucencyUpperAltitude
Gets or sets the upper altitude bound used to calculate translucency for the image when UseAltitudeBasedTranslucency is set to . When the altitude of the viewer is at or above this value, the image will have the translucency specified by AltitudeBasedTranslucencyUpperTranslucency, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyUpperAltitude and AltitudeBasedTranslucencyLowerAltitude.
(Inherited from GlobeImageOverlay.)
Public propertyAltitudeBasedTranslucencyUpperTranslucency
Gets or sets the upper translucency value for the image when UseAltitudeBasedTranslucency is set to . When the altitude of the viewer is at or above AltitudeBasedTranslucencyUpperAltitude, the image will have the translucency specified by this property, and will be linearly interpolated at altitude values between AltitudeBasedTranslucencyUpperAltitude and AltitudeBasedTranslucencyLowerAltitude.
(Inherited from GlobeImageOverlay.)
Public propertyCentralBody
Gets the CentralBody that the GlobeOverlay is displayed on. It will return if the GlobeOverlay hasn't been added to a CentralBody.
(Inherited from GlobeOverlay.)
Public propertyDisplayCondition
Gets or sets the DisplayCondition that controls whether or not the GlobeOverlay is displayed.
(Inherited from GlobeOverlay.)
Public propertyExtent
Gets the CartographicExtent that represents the area covered by the GlobeOverlay.
(Overrides GlobeOverlayExtent.)
Public propertyIsTranslucent
Gets whether the overlay contains translucent imagery.
Public propertyIsValid
Gets whether or not the overlay is valid. It can be invalid because of a missing file, corrupt file, unlicensed file, or a file on the incorrect CentralBody.
(Inherited from GlobeOverlay.)
Public propertyMaximumMetersPerPixel
Gets the maximum resolution of the inlay in meters per pixel.
Public propertyProjection
Gets the map projection. Valid values are MapProjection.Mercator and MapProjection.EquidistantCylindical.
Public propertyRole
Gets the GlobeOverlayRole of the GlobeOverlay.
(Inherited from GlobeOverlay.)
Public propertyTag
Gets or sets custom data associated with this globe overlay.
(Inherited from GlobeOverlay.)
Public propertyTiler
Gets or sets a custom tiler, if the plugin requires it. The tiler is used to control which extents are requested during a call to Read(CartographicExtent, Object, Bitmap).
Public propertyTranslucency
Gets or sets the translucency value for the image. The translucency is between 0 and 1, where 0 is fully opaque and 1 is invisible.
(Inherited from GlobeImageOverlay.)
Public propertyUri
Gets the URI, if applicable. If not overridden in the derived class, this method returns GUID that is unique to this instance.
(Overrides GlobeOverlayUri.)
Public propertyUseAltitudeBasedTranslucency
Gets or sets whether to use altitude to determine the translucency value for the image or not. If , the Translucency value is used. If , the translucency will be determined by the values of AltitudeBasedTranslucencyLowerTranslucency, AltitudeBasedTranslucencyUpperTranslucency, AltitudeBasedTranslucencyLowerAltitude, and AltitudeBasedTranslucencyUpperAltitude.
(Inherited from GlobeImageOverlay.)
Top
Methods
  NameDescription
Public methodClearCache
Clears the image data cache associated with this instance. This is equivalent to deleting and re-adding the overlay.
Public methodDispose (Inherited from GlobeOverlay.)
Protected methodDispose(Boolean) (Overrides GlobeImageOverlayDispose(Boolean).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRead
Reads a tile from the specified extent, scales it to and stores the result in image.
Public methodReload
Reloads the image data associated with this instance. Preserves the current image data until new image data replaces it.
Public methodShutDown
Called automatically when imagery is being removed from the globe.
Protected methodShuttingDown
Called by the base class when imagery is being removed from the globe.
Protected methodStartingUp
Called by the base class when imagery is being added to the globe.
Public methodStartUp
Called automatically when imagery is being added to the globe.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also