Abstract base class for IPixelPyramid s that fetch tiles from a HTTP web server.
abstract class
|
HttpPyramid
|
extends
|
PixelPyramid
|
||
base of
|
BingMapsPyramid
|
||||
GoogleMapsPyramid
|
|||||
OpenStreetMapPyramid
|
|||||
UrlPatternPyramid
|
Does this map allow updates to its content (i.e. sample data and/or metadata)?
public
override
property
|
CanUpdate
{
get
}
|
||
type
|
bool
|
||
value
|
true
if
the
map
content
can
be
updated,
false
if
not. |
||
inherited
|
PixelPyramid.CanUpdate
|
Additional behaviour flags of the pyramid.
public
override
sealed
property
|
Flags
{
get
}
|
||
type
|
PyramidFlags
|
||
value
|
The pyramid flags. | ||
overrides
|
Pyramid.Flags
|
The size of the bottom-most pyramid level.
public
property
|
FullSize
{
get
}
|
||
type
|
int32
|
||
value
|
|
The pyramid size (width and height), in samples. | |
inherited
|
Pyramid.FullSize
|
Returns georeferencing information.
public
override
property
|
Georef
{
get
}
|
||
type
|
Raster
|
||
value
|
The
georeferencing
object
or
null
if
no
georeferencing
is
available. |
||
overrides
|
Pyramid.Georef
|
The ISimpleHttp object that is used to make HTTP requests.
public
property
|
Http
{
get
}
|
||
type
|
ISimpleHttp
|
||
value
|
|
The ISimpleHttp object. |
Remarks:
The default value is a SimpleHttp instance.
The number of pyramid levels.
public
property
|
Levels
{
get
}
|
||
type
|
int32
|
||
value
|
|
The number of pyramid levels. | |
inherited
|
Pyramid.Levels
|
Returns the lifecycle state of this object.
public
virtual
property
|
LifecycleState
{
get
}
|
||
type
|
LifecycleState
|
||
value
|
The lifecycle state. | ||
inherited
|
Disposable.LifecycleState
|
Returns a MapInfo value that describes the used map raster.
public
property
|
Map
{
get
}
|
||
type
|
MapInfo
|
||
value
|
The map info value. | ||
inherited
|
Pyramid.Map
|
Event for listening to updates made to this pixel pyramid.
public
property
|
OnUpdated
{
get
}
|
||
type
|
IEventGeneric<PyramidEventArgs>
|
||
value
|
|
The event object. | |
inherited
|
Pyramid.OnUpdated
|
Remarks:
This event will be fired by the thread that performs the map update.
Is this pixel pyramid solid?
public
property
|
Solid
{
get
set
}
|
||
type
|
bool
|
||
value
|
true
if
the
pyramid
is
solid,
false
if
not. |
Remarks:
The
HasTileData
method
of
a
solid
pyramid
will
always
return
true
,
and
HEAD
requests
will
not
be
performed
(see
Head).
The
default
value
is
false
.
The pad width of this cube pyramid.
public
property
|
TilePad
{
get
}
|
||
type
|
int32
|
||
value
|
|
The pad width. | |
inherited
|
Pyramid.TilePad
|
Remarks:
Tile padding is used to avoid color bleeding that will occur when texture samples are filtered at the edge of a pyramid tile (assuming tiles are stored in some kind of texture atlas). The tile pad width gives the number of safety pixels at the that are borrowed from neighbouring pyramid tiles:
8x8 tile, with a pad of 2: 0 1 2 3 4 5 6 7 +---+---+---+---+---+---+---+---+ 0 |###|###|###|###|###|###|###|###| +---+---+---+---+---+---+---+---+ 1 |###|###|###|###|###|###|###|###| +---+--(X)--+---+---+--(X)--+---+ 2 |###|###| | | | |###|###| +---+---+---+---+---+---+---+---+ 3 |###|###| | | | |###|###| +---+---+---+---+---+---+---+---+ 4 |###|###| | | | |###|###| +---+---+---+---+---+---+---+---+ 5 |###|###| | | | |###|###| +---+--(X)--+---+---+--(X)--+---+ 6 |###|###|###|###|###|###|###|###| +---+---+---+---+---+---+---+---+ 7 |###|###|###|###|###|###|###|###| +---+---+---+---+---+---+---+---+The point coordinates marked with
(X)
will
be
mapped
to
the
corner
vertices
of
each
terrain
mesh
sector.
Only
the
effective
region
of
a
padded
tile
(i.e.
the
square
surrounded
by
(X)
)
contains
actual
data.
The
padded
pixels
are
sampled
from
neighbouring
source
tiles
and
carry
redundant
information.
The size of a single map tile, in pixels.
public
property
|
TileSize
{
get
}
|
||
type
|
int32
|
||
value
|
|
The tile size. | |
inherited
|
Pyramid.TileSize
|
Acquires a strong reference to this disposable object.
[OwnerReturn, ThreadSafe]
|
||||
public
method
|
AcquireTry
()
|
|||
type
|
IDisposable
|
|||
returns
|
this
if
a
new
strong
reference
has
been
acquired,
null
if
this
object
is
already
being
disposed.
|
|||
inherited
|
Disposable.AcquireTry
|
Remarks:
The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.
This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.
Wraps this pixel pyramid in a memory cache.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
Cache
()
|
|||
type
|
IPixelPyramid
|
|||
returns
|
|
The cached map pyramid. | ||
inherited
|
PixelPyramid.Cache
|
Remarks:
The built-in pixel pyramid operations already make use of the Cache method where applicable, so client code usually does not need to call it.
If
the
Cache
method
has
already
been
called
on
this
object,
the
method
silently
returns
this
.
See also:
PyramidsUtil.CacheMemoryWraps this pixel pyramid in a file cache.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
Cache
(PyramidFileCache cache,
int32 pyramidId)
|
|||
type
|
IPixelPyramid
|
|||
params
|
cache
|
[not-null]
|
The cache to use. | |
pyramidId
|
[0..1023]
|
Persistent unique identifier of the pixel pyramid being cached. | ||
returns
|
|
The cached map pyramid. | ||
inherited
|
PixelPyramid.Cache
|
Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.
[Dispose, OwnerThis, ThreadSafe]
|
||||
public
method
|
Dispose
()
|
|||
inherited
|
Disposable.Dispose
|
Remarks:
The Dispose method silently returns if the object has already been disposed.
Flushes all cached data.
public
virtual
method
|
Flush
()
|
||
inherited
|
Pyramid.Flush
|
Remarks:
Performing a flush may result in I/O work. Depending on the semantics of the implementing class, this work may need to be wrapped in special Begin / End method calls. See the documentation of the implementing classes for details.
In case this object represents a read-only resource, calling the Flush method has no effect.
Returns the data content of the given map tile.
[ThreadSafe]
|
||||
public
method
|
GetTileData
(PyramidCoords coords,
TData data,
int32 dataX = 0,
int32 dataY = 0)
|
|||
type
|
TileDataResult
|
|||
params
|
coords
|
The pyramid tile coords. | ||
data
|
[not-null]
|
The output buffer to use. | ||
dataX
|
[>=0]
|
X-coordinate of top-left corner of output rectangle. | ||
dataY
|
[>=0]
|
Y-coordinate of top-left corner of output rectangle. | ||
returns
|
The result code. | |||
inherited
|
Pyramid.GetTileData
|
Returns the image pixels of the given map tile.
[ThreadSafe]
|
||||
public
method
|
GetTileData
(CubemapFace face,
int32 level,
int32 x,
int32 y,
TData data,
int32 dataX = 0,
int32 dataY = 0)
|
|||
type
|
TileDataResult
|
|||
params
|
face
|
Cubemap face of map tile. Set to NegZ for unprojected map pyramids. Defaults to NegZ. | ||
level
|
[>=0]
|
The pyramid level. | ||
x
|
Cubemap face X-coordinate of map tile in level. | |||
y
|
Cubemap face Y-coordinate of map tile in level. | |||
data
|
[not-null]
|
The output buffer to use. | ||
dataX
|
[>=0]
|
X-coordinate of top-left corner of output rectangle. | ||
dataY
|
[>=0]
|
Y-coordinate of top-left corner of output rectangle. | ||
returns
|
The result code. | |||
inherited
|
Pyramid.GetTileData
|
Returns if there is any data content for the given map tile.
[ThreadSafe]
|
||||
public
method
|
HasTileData
(PyramidCoords coords)
|
|||
type
|
bool
|
|||
params
|
coords
|
The pyramid tile coords. | ||
returns
|
true
if
data
for
the
given
map
tile
exists,
false
if
not. |
|||
inherited
|
Pyramid.HasTileData
|
Returns if there is any data content for the given map tile (i.e. Ok or Empty).
[ThreadSafe]
|
||||
public
method
|
HasTileData
(CubemapFace face,
int32 level,
int32 x,
int32 y)
|
|||
type
|
bool
|
|||
params
|
face
|
Cubemap face of map tile. Set to NegZ for unprojected map pyramids. Defaults to NegZ. | ||
level
|
[>=0]
|
The pyramid level. | ||
x
|
Cubemap face X-coordinate of map tile in level. | |||
y
|
Cubemap face Y-coordinate of map tile in level. | |||
returns
|
true
if
data
for
the
given
map
tile
exists,
false
if
not. |
|||
inherited
|
Pyramid.HasTileData
|
Returns the configuration value that describes this object.
public
abstract
method
|
ToConfig
()
|
||
type
|
ConfigValue
|
||
returns
|
|
The configuration value. | |
inherited
|
Pyramid.ToConfig
|
Remarks:
All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.
The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.
Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.
Changes the level count resp. full size of this pixel pyramid.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
ToFullSize
(int32 fullSize)
|
|||
type
|
IPixelPyramid
|
|||
params
|
fullSize
|
[pow2]
|
The new full size (i.e. size of bottommost level). | |
returns
|
|
The resulting pixel pyramid. | ||
inherited
|
PixelPyramid.ToFullSize
|
See also:
IPyramidBase.FullSizeChanges the tile padding of this pixel pyramid.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
ToTilePad
(int32 tilePad)
|
|||
type
|
IPixelPyramid
|
|||
params
|
tilePad
|
[>=0]
|
The new tile padding value. | |
returns
|
|
The resulting pixel pyramid. | ||
inherited
|
PixelPyramid.ToTilePad
|
See also:
IPyramidBase.TilePadChanges the tile size of this pixel pyramid.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
ToTileSize
(int32 tileSize)
|
|||
type
|
IPixelPyramid
|
|||
params
|
tileSize
|
[pow2]
|
The new tile size. | |
returns
|
|
The resulting pixel pyramid. | ||
inherited
|
PixelPyramid.ToTileSize
|
See also:
IPyramidBase.TileSizeUpdates georeferencing data of this heightmap.
[ThreadSafe]
|
||||
public
override
method
|
UpdateGeoref
(Raster georef)
|
|||
params
|
georef
|
The
new
georeferencing
data
or
null . |
||
inherited
|
PixelPyramid.UpdateGeoref
|
See also:
IMapEntity.CanUpdateThe full pyramid size.
protected
readonly
field
|
fullSize
|
||
type
|
int32
|
||
inherited
|
Pyramid.fullSize
|
Remarks:
This is the size of the bottom-most pyramid level, given in tile pixels.
The number of pyramid levels.
protected
readonly
field
|
levels
|
||
type
|
int32
|
||
inherited
|
Pyramid.levels
|
The event object of OnUpdated.
[Owner]
|
||||
protected
field
|
onUpdated
|
|||
type
|
EventGeneric<PyramidEventArgs>
|
|||
inherited
|
Pyramid.onUpdated
|
The pad width of this cube pyramid.
protected
readonly
field
|
tilePad
|
||
type
|
int32
|
||
inherited
|
Pyramid.tilePad
|
Size of a pyramid tile, in pixels.
protected
readonly
field
|
tileSize
|
||
type
|
int32
|
||
inherited
|
Pyramid.tileSize
|
Logarithm of base two of tileSize.
protected
readonly
field
|
tileSizeShift
|
||
type
|
int32
|
||
inherited
|
Pyramid.tileSizeShift
|
Creates a new instance of HttpPyramid.
protected
constructor
|
HttpPyramid
(int32 tileSize,
int32 levels,
PyramidFlags flags,
Raster georef,
[Owner]
ISimpleHttp http = null)
|
||
params
|
tileSize
|
[pow2]
|
The pyramid tile size, in pixels. |
levels
|
[>=1]
|
The number of pyramid levels. | |
flags
|
The pyramid flags. | ||
georef
|
[not-null]
|
The georeference of the pyramid. | |
http
|
The
custom
ISimpleHttp
object
to
use.
If
null ,
a
new
instance
of
SimpleHttp
will
be
used.
Defaults
to
null .
|
Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.
protected
override
method
|
DisposeManaged
()
|
||
overrides
|
Pyramid.DisposeManaged
|
Remarks:
This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.
Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.
The DisposeManaged method is called before the DisposeUnmanaged method.
Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.
protected
virtual
method
|
DisposeUnmanaged
()
|
||
inherited
|
Disposable.DisposeUnmanaged
|
Remarks:
Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.
The DisposeUnmanaged method is called after the DisposeManaged method.
Get the data content of the given pyramid tile.
protected
override
method
|
DoGetTileData
(CubemapFace face,
int32 level,
int32 x,
int32 y,
ColorBuffer data,
int32 dataX,
int32 dataY)
|
||
type
|
TileDataResult
|
||
params
|
face
|
The cubemap face. | |
level
|
The pyramid level. | ||
x
|
The tile X-coordinate. | ||
y
|
The tile Y-coordinate. | ||
data
|
Output buffer to data content. | ||
dataX
|
X-coordinate of top-left pixel in data to fill. | ||
dataY
|
Y-coordinate of top-left pixel in data to fill. | ||
returns
|
The result code. | ||
implements
|
Pyramid.DoGetTileData
|
Remarks:
The given pyramid tile coordinates are always valid.
Checks if data content for the given pyramid tile exists.
protected
override
sealed
method
|
DoHasTileData
(CubemapFace face,
int32 level,
int32 x,
int32 y)
|
||
type
|
bool
|
||
params
|
face
|
The cubemap face. | |
level
|
The pyramid level. | ||
x
|
The tile X-coordinate. | ||
y
|
The tile Y-coordinate. | ||
returns
|
true
if
data
content
is
available,
false
if
not. |
||
implements
|
Pyramid.DoHasTileData
|
Remarks:
The given pyramid tile coordinates are always valid.
protected
abstract
method
|
GetTileUrl
(int32 level,
int32 x,
int32 y)
|
||
type
|
string
|
||
params
|
level
|
||
x
|
|||
y
|
After the web request has succeeded, this method is called to determine if the response has delivered a valid tile image.
protected
virtual
method
|
IsExistingTile
(SimpleHttpResult result)
|
||
type
|
bool
|
||
params
|
result
|
The request result to inspect. | |
returns
|
true
if
the
request
has
delivered
a
valid
tile
image,
false
if
the
response
indicated
a
missing
tile.
|
Remarks:
This
default
implementation
just
returns
true
.
After
a
web
request
has
failed
because
of
some
reason
other
than
404
-
Not
Found
,
this
method
is
called
to
determine
if
the
response
indicates
a
missing
tile
(no
error
reporting
is
necessary
in
this
case).
protected
virtual
method
|
IsMissingTile
(SimpleHttpResult result)
|
||
type
|
bool
|
||
params
|
result
|
The request result to inspect. | |
returns
|
true
if
the
request
result
indicates
a
missing
tile,
false
if
some
unexpected
error
has
occurred.
|
The logger object of this class.
public
static
readonly
field
|
Logger
|
||
type
|
ILogger
|