CustomImageGlobeOverlay Class

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

Inheritance Hierarchy

SystemObject
  AGI.Foundation.Graphics.AdvancedGlobeOverlay
    AGI.Foundation.GraphicsGlobeImageOverlay
      AGI.Foundation.Graphics.AdvancedCustomImageGlobeOverlay
        AGI.Foundation.GraphicsBingMapsForEnterpriseImageGlobeOverlay
        AGI.Foundation.GraphicsOpenStreetMapImageGlobeOverlay

Namespace: AGI.Foundation.Graphics.Advanced
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public abstract class CustomImageGlobeOverlay : GlobeImageOverlay

Public MustInherit Class CustomImageGlobeOverlay
	Inherits GlobeImageOverlay

public ref class CustomImageGlobeOverlay abstract : public GlobeImageOverlay

[<AbstractClassAttribute>]
type CustomImageGlobeOverlay =  
    class
        inherit GlobeImageOverlay
    end

The CustomImageGlobeOverlay type exposes the following members.

Constructors

	Name	Description
	CustomImageGlobeOverlay	Initializes a new instance.

Top

Properties

	Name	Description
	AltitudeBasedTranslucencyLowerAltitude	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.)
	AltitudeBasedTranslucencyLowerTranslucency	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.)
	AltitudeBasedTranslucencyUpperAltitude	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.)
	AltitudeBasedTranslucencyUpperTranslucency	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.)
	CentralBody	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.)
	DisplayCondition	Gets or sets the DisplayCondition that controls whether or not the GlobeOverlay is displayed. (Inherited from GlobeOverlay.)
	Extent	Gets the CartographicExtent that represents the area covered by the GlobeOverlay. (Overrides GlobeOverlayExtent.)
	IsTranslucent	Gets whether the overlay contains translucent imagery.
	IsValid	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.)
	MaximumMetersPerPixel	Gets the maximum resolution of the inlay in meters per pixel.
	Projection	Gets the map projection. Valid values are MapProjection.Mercator and MapProjection.EquidistantCylindical.
	Role	Gets the GlobeOverlayRole of the GlobeOverlay. (Inherited from GlobeOverlay.)
	Tag	Gets or sets custom data associated with this globe overlay. (Inherited from GlobeOverlay.)
	Tiler	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).
	Translucency	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.)
	Uri	Gets the URI, if applicable. If not overridden in the derived class, this method returns GUID that is unique to this instance. (Overrides GlobeOverlayUri.)
	UseAltitudeBasedTranslucency	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

	Name	Description
	ClearCache	Clears the image data cache associated with this instance. This is equivalent to deleting and re-adding the overlay.
	Dispose	(Inherited from GlobeOverlay.)
	Dispose(Boolean)	(Overrides GlobeImageOverlayDispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Read	Reads a tile from the specified extent, scales it to and stores the result in image.
	Reload	Reloads the image data associated with this instance. Preserves the current image data until new image data replaces it.
	ShutDown	Called automatically when imagery is being removed from the globe.
	ShuttingDown	Called by the base class when imagery is being removed from the globe.
	StartingUp	Called by the base class when imagery is being added to the globe.
	StartUp	Called automatically when imagery is being added to the globe.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.Graphics.Advanced Namespace