Definition
typedef struct tagLoadShapeInfo { ShapeType type; double dLongMin; double dLatMin; double dLongMax; double dLatMax; PFNADDGRAPHICCALLBACK pfnAGCB; unsigned long ulSessionData; size_t nThemeIndex; COLORREF clr; wchar_t *pThemeNameBuffer; size_t nThemeNameBufferSize; unsigned long ulThemeKey; bool bAutoEnableEditing; size_t nPenWidth; int nIconIndex; bool bForceLayerOnTop; wchar_t *pInfoTipBuffer; size_t nInfoTipBufferSize; bool bDrawInfoTipOnMap; bool bFrameInfoTipOnMap; PFNRAISEEVENTCALLBACK pfnRECB; } LoadShapeInfo;
Members
type [in]
A ShapeType value describing what type is being loaded.
dLongMin, dLatMin, dLongMax, dLatMax [in]
Not used.
pfnAGCB [in]
A callback function of type PFNADDGRAPHICCALLBACK. This function should be called to notify ShapeUp of new shapes. If the callback returns true, the shape was accepted, if it returns false, the shape may be discarded by the plugin and its memory deleted.
ulSessionData [in]
This value should be the first argument to the callback functions of this structure. This value must not be modified.
clr [in/out]
This is the default color of the theme. It may be modified by the plugin to any other color.
pThemeNameBuffer [out]
Copy an appropriate theme name here to be displayed in the legend view of ShapeUp. Default name is the name returned by the fnGetName function.
nThemeNameBufferSize [in]
The number of wchar_t elements of pThemeNameBuffer member.
ulThemeKey [out]
This is a plugin definable value. It is used in subsequent calls to other exported functions to allow the plugin to keep track of theme specific data. Typically, this is a pointer to a larger structure.
bAutoEnableEditing [out]
Set this to true if ShapeUp should convert the newly created layer to a writable. This value is checked only on return from fnLoadShapes, so until this function returns, the plugin is responsible for maintaining the memory for each shape. If set to true, ShapeUp will call fnRemoveShapes directly after fnLoadShapes returns, and onload the loader plugin if no other layer uses it. Default is false.
nPenWidth [out]
The plugin can change the width of polylines and polygon outlines by changing this value.
nIconIndex [out]
The plugin can change the icon for point layers by changing this value. Default is a small circle.
bForceLayerOnTop [out]
If set to true, the layer will be moved to the top z-order, regardless of the users settings. Default is false.
pInfoTipBuffer [out]
Set a default InfoTip template for this layer.
nInfoTipBufferSize [in]
The number of wchar_t elements of pInfoTipBuffer member.
bDrawInfoTipOnMap [out]
If set to true, InfoTips are automatically drawn on the map. Default is false.
bFrameInfoTipOnMap [out]
Allow a frame to be drawn around an InfoTip on map. Default is false.
pfnRECB [in]
This callback function can be stored for later use if the plugin supports real-time data updates. Calling this function will trigger an event synchronized with the main thread in ShapeUp, and the function fnHandleCustomEvent will be called. The fnHandleCustomEvent function is the only place the plugin is allowed to alter any shape data that has been pushed to ShapeUp main executable.
Remarks
None
See Also
Loader API, fnLoadShapes, fnGetName, fnRemoveShapes, fnHandleCustomEvent