Changes between Version 5 and Version 6 of MapGuideRfc170

Timestamp:

05/21/19 05:34:58 (6 years ago)

Author:

jng

Comment:

--

MapGuideRfc170

@@ -64 +64 @@
 ...
 EXTERNAL_API:
+
     /////////////////////////////////////////////////////////////////
     /// \brief
@@ -106 +107 @@
     /// \param metaTilingFactor
     /// Input
-    /// The meta-tiling factor, If less than or equal to 1 no meta-tiling is done. If greater than 1, a tile m times the original requested
-    /// size is rendered instead (where m is the specified factor)
+    /// The meta-tiling factor. If less than or equal to 1, no meta-tiling is done and the returned meta-tile can be extracted
+    /// as the orignally requested tile image. If greater than 1, a tile that is m times bigger than the requested tile is rendered
+    /// (where m is the specified tiling factor) and the raw image frame buffer of this meta-tile is returned instead.
     ///
     /// \return
-    /// A byte reader containing the rendered tile image. If metaTilingFactor is greater than 1, then a raw image frame buffer is returned 
-    /// instead. This raw image frame buffer is not intended to be used by MapGuide applications and is reserved for the rendering infrastructre
-    /// to sub-divide back into tiles of the original requested size.
+    /// A meta-tile with sufficient information for the consumer to properly sub-divide this back into sub-tiles of the
+    /// originally requested size.
     ///
     /// \since 3.3
-    virtual MgByteReader* RenderTile(
+    virtual MgMetatile* RenderMetatile(
         MgMap* map,
         CREFSTRING baseMapLayerGroupName,
@@ -125 +126 @@
         CREFSTRING tileImageFormat,
         double tileExtentOffset,
-        INT32 metaTileFactor) = 0;
+        INT32 metaTilingFactor) = 0;
 
     /////////////////////////////////////////////////////////////////
@@ -161 +162 @@
     /// \param metaTilingFactor
     /// Input
-    /// The meta-tiling factor, If less than or equal to 1 no meta-tiling is done. If greater than 1, a tile m times the original requested
-    /// size is rendered instead (where m is the specified factor)
+    /// The meta-tiling factor. If less than or equal to 1, no meta-tiling is done and the returned meta-tile can be extracted
+    /// as the orignally requested tile image. If greater than 1, a tile that is m times bigger than the requested tile is rendered
+    /// (where m is the specified tiling factor) and the raw image frame buffer of this meta-tile is returned instead.
     ///
     /// \return
-    /// A byte reader containing the rendered tile image. If metaTilingFactor is greater than 1, then a raw image frame buffer is returned 
-    /// instead. This raw image frame buffer is not intended to be used by MapGuide applications and is reserved for the rendering infrastructre
-    /// to sub-divide back into tiles of the original requested size.
+    /// A meta-tile with sufficient information for the consumer to properly sub-divide this back into sub-tiles of the
+    /// originally requested size.
     ///
     /// \since 3.3
-    virtual MgByteReader* RenderTileXYZ(
+    virtual MgMetatile* RenderMetatileXYZ(
         MgMap* map,
         CREFSTRING baseMapLayerGroupName,
@@ -180 +181 @@
         double tileExtentOffset,
         INT32 metaTilingFactor) = 0;
+
+
+    /////////////////////////////////////////////////////////////////
+    /// \brief
+    /// Returns the requested sub-tile from the given metatile
+    ///
+    /// \param map
+    /// Input
+    /// map object containing current state of map.
+    /// \param metaTile
+    /// Input
+    /// The meta-tile from which a subtile is being requested for
+    /// \param rendererName
+    /// Input
+    /// The name of the renderer to create for sub-tile slicing
+    /// \param subTileX
+    /// Input
+    /// The x sub-tile coordinate of the meta-tile to request
+    /// \param subTileY
+    /// Input
+    /// The y sub-tile coordinate of the meta-tile to request
+    ///
+    /// \return
+    /// The requested sub-tile
+    ///
+    /// \since 3.3
+    virtual MgByteReader* RenderTileFromMetaTile(MgMap* map, MgMetatile* metaTile, CREFSTRING rendererName, INT32 subTileX, INT32 subTileY) = 0;
 };
 }}}
 
-These new overloads are designated {{{EXTERNAL_API}}} because meta-tiles are not intended to be consumed by regular MapGuide applications. They are raw image frame buffers that the rendering infrastructure will use to sub-divide back into tiles of the original requested size. But at the same time, these overloads have to be present in the {{{MgRenderingService}}} contract to allow a server-based tile service to still request meta-tiles through a proxy instance (should a server-based instance not be available) hence the {{{EXTERNAL_API}}} designation.
+These new overloads are designated {{{EXTERNAL_API}}} because meta-tiles are not intended to be consumed by regular MapGuide applications. They are raw image frame buffers that the rendering infrastructure will use to sub-divide back into tiles of the original requested size. But at the same time, these overloads have to be present in the {{{MgRenderingService}}} contract to allow a server-based tile service to still request meta-tiles through a proxy instance (should a server-based instance not be available).
 
 If applications do take advantage of these new overloads, it is expected they will always pass a {{{metaTilingFactor}}} of {{{0}}} when calling these new overloads or they know how to process and sub-divide the raw image frame buffer back into tile images of the original tile size.