This method allows a customized drawing of a HUD Layer. It accepts a serialized meta DC that is saved into a stream, and draws it on top of the 3D window.
Note: To constantly update the HUD, call this method on each OnDrawHud event (See: OnDrawHud). If the HUD layer is permanent, call this method once. TerraExplorer maintains the HUD layer until another call to the method is performed.
HRESULT SetHUDLayer(
[in] IUnknown* pIStream,
[in, optional, defaultvalue(0)] long Index,
[in, optional, defaultvalue(0)] long MapMode)
Parameters:
pIStream – Meta DC saved as a stream. Passing Null clears the current HUD layer.
Index – Reserved. Currently not used. Should be set to 0 (zero).
MapMode – Reserved. Currently not used.
Return Values:
The return value obtained from the returned HRESULT can be one of the following:
|
Return value |
Meaning |
|
S_OK |
Success. |
|
TE_E_MPTNOTLOADED |
An MPT file must be loaded in TerraExplorer for this method to work. |