[mapguide-commits] r10195 - in branches/4.0/MgDev: Common/CoordinateSystem Common/Geometry/CoordinateSystem Portable/OSGeo.MapGuide.Viewer.Portable Web/src/WebApp
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Sun Sep 28 08:08:41 PDT 2025
Author: jng
Date: 2025-09-28 08:08:40 -0700 (Sun, 28 Sep 2025)
New Revision: 10195
Modified:
branches/4.0/MgDev/Common/CoordinateSystem/MentorDictionary.h
branches/4.0/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemTransform.h
branches/4.0/MgDev/Portable/OSGeo.MapGuide.Viewer.Portable/MgPortableMapViewerProvider.cs
branches/4.0/MgDev/Portable/OSGeo.MapGuide.Viewer.Portable/MgPortableTransientMapState.cs
branches/4.0/MgDev/Web/src/WebApp/WebActions.h
branches/4.0/MgDev/Web/src/WebApp/WebTargetType.h
branches/4.0/MgDev/Web/src/WebApp/WebTargetViewerType.h
branches/4.0/MgDev/Web/src/WebApp/WebTaskButtonType.h
branches/4.0/MgDev/Web/src/WebApp/WebWidgetType.h
Log:
Doxygen-ify and fill in missing documentation.
Modified: branches/4.0/MgDev/Common/CoordinateSystem/MentorDictionary.h
===================================================================
--- branches/4.0/MgDev/Common/CoordinateSystem/MentorDictionary.h 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Common/CoordinateSystem/MentorDictionary.h 2025-09-28 15:08:40 UTC (rev 10195)
@@ -325,7 +325,7 @@
Ptr<MgDisposableCollection> filteredCollection = new MgDisposableCollection();
for(std::vector<MgCoordinateSystemFilter*>::size_type j = 0; j < filterCount; j++)
{
- Ptr<MgDisposable> disposableItem = toBeFiltered->GetItem(j);
+ Ptr<MgDisposable> disposableItem = toBeFiltered->GetItem(static_cast<int>(j));
T* mgCsItem = dynamic_cast<T*>(disposableItem.p);
if (NULL == mgCsItem)
throw new MgException(MgExceptionCodes::MgInvalidArgumentException, L"MentorDictionary.FilterDefinitions", __LINE__, __WFILE__, NULL, L"", NULL);
Modified: branches/4.0/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemTransform.h
===================================================================
--- branches/4.0/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemTransform.h 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystemTransform.h 2025-09-28 15:08:40 UTC (rev 10195)
@@ -525,7 +525,7 @@
/// dictionary.
/// \exception MgIndexOutOfRangeException if index is out of range. See MgCoordinateSystemTransform::GetGeodeticTransformationCount.
/// \exception MgCoordinateSystemLoadFailedException if the geodetic transformation
- /// denoted by the index is not contained in the dictionries
+ /// denoted by the index is not contained in the dictionaries
/// but has been created in-memory only. Note though, that this will only
/// in very rare circumstances.
/// \exception MgCoordinateSystemInitializationFailedException if the
Modified: branches/4.0/MgDev/Portable/OSGeo.MapGuide.Viewer.Portable/MgPortableMapViewerProvider.cs
===================================================================
--- branches/4.0/MgDev/Portable/OSGeo.MapGuide.Viewer.Portable/MgPortableMapViewerProvider.cs 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Portable/OSGeo.MapGuide.Viewer.Portable/MgPortableMapViewerProvider.cs 2025-09-28 15:08:40 UTC (rev 10195)
@@ -1,5 +1,8 @@
namespace OSGeo.MapGuide.Viewer.Portable
{
+ /// <summary>
+ /// A map viewer platform provider that connects this viewer to MapGuide Portable
+ /// </summary>
public class MgPortableMapViewerProvider : MgMapViewerProvider
{
private MgPortableMap _implMap;
@@ -7,16 +10,19 @@
private MgPortableMappingService _mappingSvc;
private MgPortableServiceFactory _fact;
+ /// <inheritdoc />
public MgPortableMapViewerProvider(MgPortableMap map) : base(map)
{
_implMap = map;
}
+ /// <inheritdoc />
protected override void OnNewMapLoaded(MgMapBase map)
{
_implMap = (MgPortableMap)map;
}
+ /// <inheritdoc />
protected override void SubInit()
{
_fact = new MgPortableServiceFactory();
@@ -49,31 +55,37 @@
return _lastRenderOpts;
}
+ /// <inheritdoc />
public override OSGeo.MapGuide.MgByteReader RenderDynamicOverlay(OSGeo.MapGuide.MgSelectionBase selection, MgViewerRenderingOptions args)
{
return _renderSvc.RenderDynamicOverlay(_implMap, selection as MgPortableSelection, CreateRenderingOptions(args));
}
+ /// <inheritdoc />
public override void SetDisplaySize(int width, int height)
{
_implMap.SetDisplaySize(width, height);
}
+ /// <inheritdoc />
public override OSGeo.MapGuide.MgSelectionBase CreateSelectionForMap()
{
return new MgPortableSelection(_implMap);
}
+ /// <inheritdoc />
public override double GetMetersPerUnit()
{
return _implMap.GetMetersPerUnit();
}
+ /// <inheritdoc />
public override void SetViewCenterXY(double x, double y)
{
_implMap.SetViewCenterXY(x, y);
}
+ /// <inheritdoc />
public override void ClearSelection(OSGeo.MapGuide.MgSelectionBase sel)
{
var selImpl = sel as MgPortableSelection;
@@ -81,36 +93,43 @@
selImpl.Clear();
}
+ /// <inheritdoc />
public override void SetViewScale(double scale)
{
_implMap.SetViewScale(scale);
}
+ /// <inheritdoc />
public override void MakeGroupNormal(OSGeo.MapGuide.MgLayerGroup group)
{
_implMap.MakeGroupNormal(group);
}
+ /// <inheritdoc />
public override MgService CreateService(int serviceType)
{
return _fact.CreateService(serviceType);
}
+ /// <inheritdoc />
public override MgByteReader GenerateLegendImage(MgResourceIdentifier layerDefinition, double viewScale, int width, int height, string format, int geomType, int themeCategory)
{
return _mappingSvc.GenerateLegendImage(layerDefinition, viewScale, width, height, format, geomType, themeCategory);
}
+ /// <inheritdoc />
public override void SetGroupExpandInLegend(MgLayerGroup group, bool bExpanded)
{
MgPortableMap.SetGroupExpandInLegend(group, bExpanded);
}
+ /// <inheritdoc />
public override void SetLayerExpandInLegend(MgLayerBase layer, bool bExpanded)
{
MgPortableMap.SetLayerExpandInLegend(layer, bExpanded);
}
+ /// <inheritdoc />
public override bool LayerHasTooltips(MgLayerBase layer)
{
var layerImpl = layer as MgPortableLayer;
@@ -120,6 +139,7 @@
throw new InvalidOperationException(string.Format(Strings.ErrorLayerIncorrectImpl, typeof(MgPortableLayer).FullName));
}
+ /// <inheritdoc />
public override bool IsLayerPotentiallyVisibleAtScale(MgLayerBase layer, bool bConsiderParentGroupVisibility)
{
var layerImpl = layer as MgPortableLayer;
@@ -129,11 +149,13 @@
throw new InvalidOperationException(string.Format(Strings.ErrorLayerIncorrectImpl, typeof(MgPortableLayer).FullName));
}
+ /// <inheritdoc />
public override MgLayerBase CreateLayer(MgResourceIdentifier layerDefId)
{
return new MgPortableLayer(layerDefId, _resSvc);
}
+ /// <inheritdoc />
public override MgMapBase CreateMap(MgResourceIdentifier mapDefinitionId, string name)
{
var map = new MgPortableMap(mapDefinitionId, name);
@@ -140,21 +162,25 @@
return map;
}
+ /// <inheritdoc />
protected override MgSpatialContextReader GetSpatialContexts(MgLayerBase layer, bool activeOnly)
{
return ((MgPortableLayer)layer).GetSpatialContexts(activeOnly);
}
+ /// <inheritdoc />
public override MgTransientMapState CreateTransientState(MgMapBase map)
{
return new MgPortableTransientMapState((MgPortableMap)map);
}
+ /// <inheritdoc />
public override MgByteReader RenderMap(MgSelectionBase selection, string format)
{
return _renderSvc.RenderMap(_implMap, (MgPortableSelection)selection, format);
}
+ /// <inheritdoc />
public override MgQueryMapFeaturesResult QueryMapFeatures(MgQueryRequestType queryType, MgStringCollection layerNames, MgGeometry filterGeom, int selectionVariant, string featureFilter, int maxFeatures, int layerAttributeFilter)
{
var fi = _renderSvc.QueryFeatures(_implMap, layerNames, filterGeom, selectionVariant, featureFilter, maxFeatures, layerAttributeFilter);
Modified: branches/4.0/MgDev/Portable/OSGeo.MapGuide.Viewer.Portable/MgPortableTransientMapState.cs
===================================================================
--- branches/4.0/MgDev/Portable/OSGeo.MapGuide.Viewer.Portable/MgPortableTransientMapState.cs 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Portable/OSGeo.MapGuide.Viewer.Portable/MgPortableTransientMapState.cs 2025-09-28 15:08:40 UTC (rev 10195)
@@ -8,23 +8,27 @@
/// </summary>
public class MgPortableTransientMapState : MgTransientMapState<MgPortableMap>
{
- internal MgPortableTransientMapState(MgPortableMap map) : base(map) { }
+ internal MgPortableTransientMapState(MgPortableMap map) : base(map) { }
+ /// <inheritdoc />
protected override void ApplyViewCenter(double x, double y)
{
_map.SetViewCenterXY(x, y);
}
+ /// <inheritdoc />
protected override void ApplyViewScale(double scale)
{
_map.SetViewScale(scale);
}
+ /// <inheritdoc />
protected override void ApplyDisplaySize(int width, int height)
{
_map.SetDisplaySize(width, height);
}
+ /// <inheritdoc />
protected override void ApplyDPI(int dpi)
{
_map.DisplayDpi = dpi;
Modified: branches/4.0/MgDev/Web/src/WebApp/WebActions.h
===================================================================
--- branches/4.0/MgDev/Web/src/WebApp/WebActions.h 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Web/src/WebApp/WebActions.h 2025-09-28 15:08:40 UTC (rev 10195)
@@ -19,44 +19,139 @@
#define _MGWEBACTIONS_H_
////////////////////////////////////////////////////////////////////////////////
-/// <summary>
+/// \brief
/// Enumeration of all the possible actions that can be executed from the viewer.
-/// </summary>
class MgWebActions
{
//NOTE: If you change these values, make sure to update the javascript code accordingly
PUBLISHED_API:
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Pan
static const INT32 Pan = 1;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Pan up
static const INT32 PanUp = 2;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Pan down
static const INT32 PanDown = 3;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Pan right
static const INT32 PanRight = 4;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Pan left
static const INT32 PanLeft = 5;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Zoom
static const INT32 Zoom = 6;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Zoom in
static const INT32 ZoomIn = 7;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Zoom out
static const INT32 ZoomOut = 8;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Zoom rectangle
static const INT32 ZoomRectangle = 9;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Zoom selection
static const INT32 ZoomSelection = 10;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Fit window
static const INT32 FitWindow = 11;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// View previous
static const INT32 ViewPrevious = 12;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// View next
static const INT32 ViewNext = 13;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// View restore
static const INT32 ViewRestore = 14;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Select
static const INT32 Select = 15;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Select radius
static const INT32 SelectRadius = 16;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Select polygon
static const INT32 SelectPolygon = 17;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Select clear
static const INT32 SelectClear = 19;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Refresh
static const INT32 Refresh = 20;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Copy
static const INT32 Copy = 21;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// About
static const INT32 About = 22;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Print map
static const INT32 PrintMap = 23;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Get printable page
static const INT32 GetPrintablePage = 24;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Measure
static const INT32 Measure = 25;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Invoke URL
static const INT32 InvokeUrl = 26;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Search
static const INT32 Search = 27;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Buffer
static const INT32 Buffer = 28;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// View Options
static const INT32 ViewOptions = 30;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Invoke script
static const INT32 InvokeScript = 31;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Select within
static const INT32 SelectWithin = 32;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Help
static const INT32 Help = 33;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Map tip
static const INT32 MapTip = 34;
};
Modified: branches/4.0/MgDev/Web/src/WebApp/WebTargetType.h
===================================================================
--- branches/4.0/MgDev/Web/src/WebApp/WebTargetType.h 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Web/src/WebApp/WebTargetType.h 2025-09-28 15:08:40 UTC (rev 10195)
@@ -19,14 +19,22 @@
#define _MGWEBTARGETTYPE_H_
////////////////////////////////////////////////////////////////////////////////
-/// <summary>
+/// \brief
/// Types of UI target for a command
-/// </summary>
class MgWebTargetType
{
PUBLISHED_API:
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Task Pane
static const INT32 TaskPane = 1;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// New Window
static const INT32 NewWindow = 2;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Specific Frame
static const INT32 SpecifiedFrame = 3;
};
Modified: branches/4.0/MgDev/Web/src/WebApp/WebTargetViewerType.h
===================================================================
--- branches/4.0/MgDev/Web/src/WebApp/WebTargetViewerType.h 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Web/src/WebApp/WebTargetViewerType.h 2025-09-28 15:08:40 UTC (rev 10195)
@@ -19,14 +19,22 @@
#define _MGWEBTARGETVIEWERTYPE_H_
////////////////////////////////////////////////////////////////////////////////
-/// <summary>
+/// \brief
/// Types of target viewer
-/// </summary>
class MgWebTargetViewerType
{
PUBLISHED_API:
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Dwf viewer
static const INT32 Dwf = 1;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// AJAX viewer
static const INT32 Ajax = 2;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// All viewers
static const INT32 All = 3;
};
Modified: branches/4.0/MgDev/Web/src/WebApp/WebTaskButtonType.h
===================================================================
--- branches/4.0/MgDev/Web/src/WebApp/WebTaskButtonType.h 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Web/src/WebApp/WebTaskButtonType.h 2025-09-28 15:08:40 UTC (rev 10195)
@@ -19,15 +19,26 @@
#define _MGWEBTASKBUTTONTYPE_H_
////////////////////////////////////////////////////////////////////////////////
-/// <summary>
+/// \brief
/// Types of task buttons
-/// </summary>
class MgWebTaskButtonType
{
PUBLISHED_API:
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Home button
static const INT32 Home = 0;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Back button
static const INT32 Back = 1;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Forward button
static const INT32 Forward = 2;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Tasks button
static const INT32 Tasks = 3;
};
Modified: branches/4.0/MgDev/Web/src/WebApp/WebWidgetType.h
===================================================================
--- branches/4.0/MgDev/Web/src/WebApp/WebWidgetType.h 2025-09-12 14:08:50 UTC (rev 10194)
+++ branches/4.0/MgDev/Web/src/WebApp/WebWidgetType.h 2025-09-28 15:08:40 UTC (rev 10195)
@@ -19,15 +19,26 @@
#define _MGWEBWIDGETTYPE_H_
////////////////////////////////////////////////////////////////////////////////
-/// <summary>
+/// \brief
/// Types of UI Widget
-/// </summary>
class MgWebWidgetType
{
PUBLISHED_API:
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Command reference
static const INT32 Command = 1;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Toolbar or menu separator
static const INT32 Separator = 2;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Flyout menu
static const INT32 Flyout = 3;
+ ////////////////////////////////////////////////////////////////////////////////
+ /// \brief
+ /// Task button
static const INT32 TaskButton = 4;
};
More information about the mapguide-commits
mailing list