ENCX::RasDraw Class Reference
Display a bounded raster chart via a Win32 Device Context. More...
import "_encxcom_encx.idl";
Public Member Functions | |
| HRESULT | OpenChart ([in] IRasManager *rasmanager,[in] BSTR ChartIdentifier) |
| Use a specific chart. | |
| HRESULT | PanelAtPoint ([in] IPixelPoint *ipPixelPt,[out, retval] IRasPanelIdentifier **rpid) |
| Obtain the identity of the panel at a specified pixel position. | |
| HRESULT | GeoPix ([in] IPixelPoint *ipPixelPt,[out, retval] IGeoPix **geoPix) |
| Obtain the GeoPix at a specified pixel position. | |
| HRESULT | HorizontalDatum ([in] IPixelPoint *ipPixelPt,[out, retval] IHorizontalDatum **hd) |
| Obtain the HorizontalDatum at a specified pixel position. | |
| HRESULT | Draw ([in] OLE_HANDLE hDC) |
| Draw the Rect() portion of the chart to the specified device context. | |
| HRESULT | PanelNotes ([in] IRasPanelIdentifier *panelId,[out, retval] IRasPanelNotes **pVal) |
| Obtain a collection of notes associated with the specified panel. | |
| HRESULT | GetRect ([out, retval] IPixelRect **rect) |
| The area of the chart to be drawn. Pixel position (0,0) is always at the top left corner of the chart. | |
| HRESULT | SetRect ([in] IPixelRect *rect) |
| The area of the chart to be drawn. Pixel position (0,0) is always at the top left corner of the chart. | |
| HRESULT | OpenAtPositionOnPanel ([in] IRasManager *rasManager,[in] IRasChartPanelIdentifier *chartAndPanel,[in] IGeoPoint *geoPt) |
| Set the view rectangle to display the geographical position specified on the panel specified. Returns true if it succeeded. | |
| HRESULT | OnFailedAutoLoadChart ([in] BSTR ChartIdentifier,[in] BSTR sErrorMsg) |
| Occurs when a chart has been modified but failed to reload. | |
Properties | |
| BSTR * | ChartIdentifier [get] |
| The chart's number. Not necessarily numeric. E.g. "109", "2182C", "AUS1234". | |
| VARIANT_BOOL * | DisplayFullSize [get] |
| When true, the chart will be drawn at a much reduced size (typically 1/6th of normal size). | |
| VARIANT_BOOL | DisplayFullSize [set] |
| When true, the chart will be drawn at a much reduced size (typically 1/6th of normal size). | |
| VARIANT_BOOL * | HasUpdates [get] |
| True iff there are currently corrections on the chart. | |
| VARIANT_BOOL * | DisplayUpdates [get] |
| Draw the chart using the available updates. On by default. | |
| VARIANT_BOOL | DisplayUpdates [set] |
| Draw the chart using the available updates. On by default. | |
| VARIANT_BOOL * | IndicateUpdates [get] |
| Highlight the updated areas on the chart. Off by default. | |
| VARIANT_BOOL | IndicateUpdates [set] |
| Highlight the updated areas on the chart. Off by default. | |
| IDisplayPalette ** | DisplayPalette [get] |
| The colour scheme for the chart. Use to draw the chart with lower luminance for twilight and night viewing. | |
| IDisplayPalette * | DisplayPalette [set] |
| The colour scheme for the chart. Use to draw the chart with lower luminance for twilight and night viewing. | |
| BSTR * | PermanentMessage [get] |
| This message should be displayed on top of the chart at all times. | |
| BSTR * | WarningMessage [get] |
| This message should be brought to the operator's attention when the chart is opened. | |
| BSTR * | UpdateMessage [get] |
| This message should be brought to the operator's attention when the chart is opened. | |
| IGeoPixCollection ** | VisibleGeoPix [get] |
| Obtain a snapshot of all the geopixes that are inside Rect(). If you call this property twice you will get a different collection though it will behave identically provided Rect has not changed. In .NET ReferenceEquals(draw.VisibleGeoPix, draw.VisibleGeoPix) will be false. | |
| DOUBLE * | PixelSizeMetres [get] |
| Returns the nominal size of a pixel. | |
| IPixelSize ** | ChartSize [get] |
| Return the size of the whole chart in pixels, allowing for it being either fullsize or overview. | |
Detailed Description
Display a bounded raster chart via a Win32 Device Context.Supports
- Changing chart at any time.
- Changing between full size and overview.
- Alternative colour schemes (palettes) as per S-52.
- Display of chart updates.
- Geographical referencing.
- Hittesting.
For ARCS charts before a chart can be drawn, a Personal Identification Number must be entered using IRasManager::DisplayPinDialog().
Properties and methods via IRasDraw.
Notifications via _IRasDrawEvents.
Definition at line 3298 of file _encxcom_encx.idl.
Member Function Documentation
| HRESULT IRasDraw::OpenChart | ( | [in] IRasManager * | rasmanager, | |
| [in] BSTR | ChartIdentifier | |||
| ) | [inherited] |
Use a specific chart.
| HRESULT IRasDraw::PanelAtPoint | ( | [in] IPixelPoint * | ipPixelPt, | |
| [out, retval] IRasPanelIdentifier ** | rpid | |||
| ) | [inherited] |
Obtain the identity of the panel at a specified pixel position.
If there is no panel at ipPixelPt, then null / Nothing will be returned.
| HRESULT IRasDraw::GeoPix | ( | [in] IPixelPoint * | ipPixelPt, | |
| [out, retval] IGeoPix ** | geoPix | |||
| ) | [inherited] |
Obtain the GeoPix at a specified pixel position.
If there is no panel at ipPixelPt, then null / Nothing will be returned.
| HRESULT IRasDraw::HorizontalDatum | ( | [in] IPixelPoint * | ipPixelPt, | |
| [out, retval] IHorizontalDatum ** | hd | |||
| ) | [inherited] |
Obtain the HorizontalDatum at a specified pixel position.
If there is no panel at ipPixelPt, then null / Nothing will be returned.
| HRESULT IRasDraw::Draw | ( | [in] OLE_HANDLE | hDC | ) | [inherited] |
Draw the Rect() portion of the chart to the specified device context.
When drawing away from the origin, it is also necessary to adjust the device context using SetWindowOrg().
| HRESULT IRasDraw::PanelNotes | ( | [in] IRasPanelIdentifier * | panelId, | |
| [out, retval] IRasPanelNotes ** | pVal | |||
| ) | [inherited] |
Obtain a collection of notes associated with the specified panel.
| HRESULT IRasDraw::GetRect | ( | [out, retval] IPixelRect ** | rect | ) | [inherited] |
The area of the chart to be drawn. Pixel position (0,0) is always at the top left corner of the chart.
When drawing away from the origin, it is also necessary to adjust the device context using SetWindowOrg().
| HRESULT IRasDraw::SetRect | ( | [in] IPixelRect * | rect | ) | [inherited] |
The area of the chart to be drawn. Pixel position (0,0) is always at the top left corner of the chart.
When drawing away from the origin, it is also necessary to adjust the device context using SetWindowOrg().
| HRESULT IRasDraw::OpenAtPositionOnPanel | ( | [in] IRasManager * | rasManager, | |
| [in] IRasChartPanelIdentifier * | chartAndPanel, | |||
| [in] IGeoPoint * | geoPt | |||
| ) | [inherited] |
Set the view rectangle to display the geographical position specified on the panel specified. Returns true if it succeeded.
Could fail if the position is not on the panel or the panel is not on the current raster chart
| HRESULT ENCX::_IRasDrawEvents::OnFailedAutoLoadChart | ( | [in] BSTR | ChartIdentifier, | |
| [in] BSTR | sErrorMsg | |||
| ) | [inherited] |
Occurs when a chart has been modified but failed to reload.
Property Documentation
BSTR* IRasDraw::ChartIdentifier [get, inherited] |
The chart's number. Not necessarily numeric. E.g. "109", "2182C", "AUS1234".
VARIANT_BOOL* IRasDraw::DisplayFullSize [get, inherited] |
When true, the chart will be drawn at a much reduced size (typically 1/6th of normal size).
The purpose of drawing a chart as an overview is to allow the whole chart to be seen on a screen (which is very small compared with a chart table).
VARIANT_BOOL IRasDraw::DisplayFullSize [set, inherited] |
When true, the chart will be drawn at a much reduced size (typically 1/6th of normal size).
The purpose of drawing a chart as an overview is to allow the whole chart to be seen on a screen (which is very small compared with a chart table).
VARIANT_BOOL* IRasDraw::HasUpdates [get, inherited] |
True iff there are currently corrections on the chart.
Use IndicateUpdates() to highlight them with a red box round each updated square.
Use DisplayUpdates() to show the updated content.
VARIANT_BOOL* IRasDraw::DisplayUpdates [get, inherited] |
Draw the chart using the available updates. On by default.
Change to false to draw the chart as it was when this edition of the chart was first issued.
VARIANT_BOOL IRasDraw::DisplayUpdates [set, inherited] |
Draw the chart using the available updates. On by default.
Change to false to draw the chart as it was when this edition of the chart was first issued.
VARIANT_BOOL* IRasDraw::IndicateUpdates [get, inherited] |
Highlight the updated areas on the chart. Off by default.
Change to true to draw a red box round each updated square.
VARIANT_BOOL IRasDraw::IndicateUpdates [set, inherited] |
Highlight the updated areas on the chart. Off by default.
Change to true to draw a red box round each updated square.
IDisplayPalette ** IRasDraw::DisplayPalette [get, inherited] |
The colour scheme for the chart. Use to draw the chart with lower luminance for twilight and night viewing.
IDisplayPalette * IRasDraw::DisplayPalette [set, inherited] |
The colour scheme for the chart. Use to draw the chart with lower luminance for twilight and night viewing.
BSTR* IRasDraw::PermanentMessage [get, inherited] |
This message should be displayed on top of the chart at all times.
BSTR* IRasDraw::WarningMessage [get, inherited] |
This message should be brought to the operator's attention when the chart is opened.
BSTR* IRasDraw::UpdateMessage [get, inherited] |
This message should be brought to the operator's attention when the chart is opened.
IGeoPixCollection ** IRasDraw::VisibleGeoPix [get, inherited] |
Obtain a snapshot of all the geopixes that are inside Rect(). If you call this property twice you will get a different collection though it will behave identically provided Rect has not changed. In .NET ReferenceEquals(draw.VisibleGeoPix, draw.VisibleGeoPix) will be false.
DOUBLE* IRasDraw::PixelSizeMetres [get, inherited] |
Returns the nominal size of a pixel.
The approximate distance on the ground can be obtained from PixelSizeMetres * IGeoPix::DisplayScale().
IPixelSize** IRasDraw::ChartSize [get, inherited] |
Return the size of the whole chart in pixels, allowing for it being either fullsize or overview.