Display a bounded raster chart via a Win32 Device Context. More...

import"encxcom.idl";

Inheritance diagram for ENCX::RasDraw:

[legend]

Public Member Functions
HRESULT	OpenChart ([in] IRasManager *rasmanager, [in] BSTR ChartIdentifier)
	Use a specific chart. More...

HRESULT	PanelAtPoint ([in] IPixelPoint ipPixelPt, [out, retval] IRasPanelIdentifier *rpid)
	Obtain the identity of the panel at a specified pixel position. More...

HRESULT	GeoPix ([in] IPixelPoint ipPixelPt, [out, retval] IGeoPix *geoPix)
	Obtain the GeoPix at a specified pixel position. More...

HRESULT	HorizontalDatum ([in] IPixelPoint ipPixelPt, [out, retval] IHorizontalDatum *hd)
	Obtain the HorizontalDatum at a specified pixel position. More...

HRESULT	Draw ([in] OLE_HANDLE hDC)
	Draw the Rect() portion of the chart to the specified device context. More...

HRESULT	PanelNotes ([in] IRasPanelIdentifier panelId, [out, retval] IRasPanelNotes *pVal)
	Obtain a collection of notes associated with the specified panel. More...

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. More...

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. More...

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. More...

HRESULT	PanelGeoPix ([in] IRasPanelIdentifier panelID, [out, retval] IGeoPix *geoPix)
	Obtain the GeoPix for the specified panel. More...

Properties
BSTR	ChartIdentifier `[get]`
	The chart's number. Not necessarily numeric. E.g. "109", "2182C", "AUS1234". More...

VARIANT_BOOL	DisplayFullSize `[get, set]`
	When true, the chart will be drawn at a much reduced size (typically 1/6th of normal size). More...

VARIANT_BOOL	HasUpdates `[get]`
	True iff there are currently corrections on the chart. More...

VARIANT_BOOL	DisplayUpdates `[get, set]`
	Draw the chart using the available updates. On by default. More...

VARIANT_BOOL	IndicateUpdates `[get, set]`
	Highlight the updated areas on the chart. Off by default. More...

IDisplayPalette	DisplayPalette `[get, set]`
	The colour scheme for the chart. Use to draw the chart with lower luminance for twilight and night viewing. More...

BSTR	PermanentMessage `[get]`
	This message should be displayed on top of the chart at all times. More...

BSTR	WarningMessage `[get]`
	This message should be brought to the operator's attention when the chart is opened. More...

BSTR	UpdateMessage `[get]`
	This message should be brought to the operator's attention when the chart is opened. More...

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. More...

DOUBLE	PixelSizeMetres `[get]`
	Returns the nominal size of a pixel. More...

IPixelSize	ChartSize `[get]`
	Return the size of the whole chart in pixels, allowing for it being either full-size or overview. More...

ULONG	Magnify `[get, set]`
	Magnification of raster image - 100% is normal. Range is from 25% to 4000% in 25% intervals. More...

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.
Hit testing.

Properties and methods via IRasDraw.

Notifications via _IRasDrawEvents.

Definition at line 4115 of file encxcom.idl.

Member Function Documentation

◆ Draw()

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().

◆ GeoPix()

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.

◆ GetRect()

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().

◆ HorizontalDatum()

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.

◆ OpenAtPositionOnPanel()

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

◆ OpenChart()

HRESULT IRasDraw::OpenChart	(	[in] IRasManager *	rasmanager,
		[in] BSTR	ChartIdentifier
	)

inherited

Use a specific chart.

◆ PanelAtPoint()

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.

◆ PanelGeoPix()

HRESULT IRasDraw::PanelGeoPix	(	[in] IRasPanelIdentifier *	panelID,
		[out, retval] IGeoPix **	geoPix
	)

inherited

Obtain the GeoPix for the specified panel.

The chart containing the panel must be loaded first with OpenChart or OpenAtPositionOnPanel.

◆ PanelNotes()

HRESULT IRasDraw::PanelNotes	(	[in] IRasPanelIdentifier *	panelId,
		[out, retval] IRasPanelNotes **	pVal
	)

inherited

Obtain a collection of notes associated with the specified panel.

◆ SetRect()

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().

Property Documentation

◆ ChartIdentifier

BSTR IRasDraw::ChartIdentifier

getinherited

The chart's number. Not necessarily numeric. E.g. "109", "2182C", "AUS1234".

◆ ChartSize

IPixelSize IRasDraw::ChartSize

getinherited

Return the size of the whole chart in pixels, allowing for it being either full-size or overview.

◆ DisplayFullSize

VARIANT_BOOL IRasDraw::DisplayFullSize

getsetinherited

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).

◆ DisplayPalette

IDisplayPalette IRasDraw::DisplayPalette

getsetinherited

The colour scheme for the chart. Use to draw the chart with lower luminance for twilight and night viewing.

◆ DisplayUpdates

VARIANT_BOOL IRasDraw::DisplayUpdates

getsetinherited

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.

◆ HasUpdates

VARIANT_BOOL IRasDraw::HasUpdates

getinherited

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.

◆ IndicateUpdates

VARIANT_BOOL IRasDraw::IndicateUpdates

getsetinherited

Highlight the updated areas on the chart. Off by default.

Change to true to draw a red box round each updated square.

◆ Magnify

ULONG IRasDraw::Magnify

getsetinherited

Magnification of raster image - 100% is normal. Range is from 25% to 4000% in 25% intervals.

Change magnification of raster image - 100% is normal. Range is from 25% to 4000% in 25% intervals.

If the percent value is not a multiple of 25 it is rounded up to the next multiple of 25.

◆ PermanentMessage

BSTR IRasDraw::PermanentMessage

getinherited

This message should be displayed on top of the chart at all times.

◆ PixelSizeMetres

DOUBLE IRasDraw::PixelSizeMetres

getinherited

Returns the nominal size of a pixel.

The approximate distance on the ground can be obtained from PixelSizeMetres * IGeoPix::DisplayScale().

◆ UpdateMessage

BSTR IRasDraw::UpdateMessage

getinherited

This message should be brought to the operator's attention when the chart is opened.

◆ VisibleGeoPix

IGeoPixCollection IRasDraw::VisibleGeoPix

getinherited

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.

◆ WarningMessage

BSTR IRasDraw::WarningMessage

getinherited

This message should be brought to the operator's attention when the chart is opened.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Draw()

◆ GeoPix()

◆ GetRect()

◆ HorizontalDatum()

◆ OpenAtPositionOnPanel()

◆ OpenChart()

◆ PanelAtPoint()

◆ PanelGeoPix()

◆ PanelNotes()

◆ SetRect()

Property Documentation

◆ ChartIdentifier

◆ ChartSize

◆ DisplayFullSize

◆ DisplayPalette

◆ DisplayUpdates

◆ HasUpdates

◆ IndicateUpdates

◆ Magnify

◆ PermanentMessage

◆ PixelSizeMetres

◆ UpdateMessage

◆ VisibleGeoPix

◆ WarningMessage