| | 1 | = !MapGuide RFC 35 - Coordinate System API Cleanup = |
| | 2 | |
| | 3 | This page contains an change request (RFC) for the !MapGuide Open Source project. |
| | 4 | More !MapGuide RFCs can be found on the [wiki:MapGuideRfcs RFCs] page. |
| | 5 | |
| | 6 | |
| | 7 | == Status == |
| | 8 | |
| | 9 | ||RFC Template Version||(1.0)|| |
| | 10 | ||Submission Date||Sep 11, 2007|| |
| | 11 | ||Last Modified||Bruce Dechant [[Timestamp]]|| |
| | 12 | ||Author||Bruce Dechant|| |
| | 13 | ||RFC Status||draft|| |
| | 14 | ||Implementation Status||under development|| |
| | 15 | ||Proposed Milestone||2.0|| |
| | 16 | ||Assigned PSC guide(s)||(when determined)|| |
| | 17 | ||'''Voting History'''||none|| |
| | 18 | |
| | 19 | == Overview == |
| | 20 | |
| | 21 | This RFC contains a proposal for cleaning up the exiting coordinate system API. |
| | 22 | |
| | 23 | == Motivation == |
| | 24 | |
| | 25 | The existing coordinate system API as written is not very convenient to use as a library with 3rd party applications or even with MapGuide. It also has an inconsistent design for what the coordinate system factory can create. This can be addressed by cleaning up the architecture via the use of interfaces and therefore create a usable library that can be easily shared. |
| | 26 | |
| | 27 | == Proposed Solution == |
| | 28 | |
| | 29 | The existing coordinate system API architecture will be cleaned up to use interfaces instead of wrapper classes. The coordinate system factory will be updated to create all coordinate system objects (coordinate systems, transforms and measures) instead of the mixture of having to use the factory for some stuff but not all. |
| | 30 | |
| | 31 | New factory Method for creating a coordinate system transform object: |
| | 32 | |
| | 33 | MgCoordinateSystemTransform* GetTransform(MgCoordinateSystem* pSource, MgCoordinateSystem* pTarget) |
| | 34 | |
| | 35 | Measure will be accessed directly from an existing coordinate system object: |
| | 36 | MgCoordinateSystemMeasure* GetMeasure() |
| | 37 | |
| | 38 | == Implications == |
| | 39 | |
| | 40 | All of the existing coordinate system APIs will remain and be backwards compatible with only the following 2 exceptions: |
| | 41 | |
| | 42 | MgCoordinateSystemTransform constructor will be removed. |
| | 43 | MgCoordinateSystemMeasure constructor will be removed. |
| | 44 | |
| | 45 | The above 2 objects will instead be created via the updated coordinate system factory. |
| | 46 | |
| | 47 | == Test Plan == |
| | 48 | |
| | 49 | Ensure APIs behave as before. |
| | 50 | |
| | 51 | == Funding/Resources == |
| | 52 | |
| | 53 | Funding and resources to be supplied by Autodesk. |
