tsc_TsFace2Display

This class can be used to draw images to the Face 2 LCD display found on Trimble S Series instruments and Trimble M3 instruments.

The display is associated with the Survey Core UITask/thread that created the tsc_TsFace2Display instance and will be the active display when your UITask is the active task.

This means that if the user switches to the main menu or map then the Face 2 display will disappear.  It will reappear when the task becomes active again.

Likewise button press events will only arrive on the display when it is active (see tsc_ITsFace2ButtonMonitor).

The display can be created, hidden and shown as desired.  The contents of the display are treated as a tsc_Image which can be accessed and changed.  While full-color images are accepted bear in mind that black and white is what the display will accept and images should be drawn accordingly for best results.

While any kind of text may be drawn, we recommend using TsFace2LcdFont as the correct tsc_Font for drawing text.

The tsc_TsInstrument instance should be queried to obtain the correct image dimensions. The supported resolutions are:

Constructor

Create a new display.  The image is not visible until Show is called.

tsc_TsFace2Display(const tsc_TsInstrument& forThisInstrument);

Destructor

The display will automatically be removed when the item is deleted or destroyed.

virtual ~tsc_TsFace2Display();

Visibility

Makes the screen active.  This will associate the display with the current thread task as well.  You may call this multiple times with no ill effect.

void Show();

Hides the screen.  This will remove any task association.  This may be called multiple times with no ill effect.

void Hide();

Returns whether the display is currently active.

bool IsShown() const;

Status line

This specifies if SurveyCore should draw reduced status line information to the bottom quarter of the display.  This will be automatically refreshed.

bool UsesStatusLine () const;

void UsesStatusLine (bool usesStatLine);

Image

Returns the current image.  Returns an empty image if not supported or the display is inactive.

tsc_Image ReadDisplay () const;

Clears the display.

x_Code ClearDisplay ();

Overwrites the current screen image.

x_Code WriteDisplay (tsc_Image& newDisplay);

Overwrites part of the current screen image. All values are in pixels and X and Y denote the top-left pixel.

x_Code WriteDisplay (tsc_Image& source, int sourceX, int sourceY, int destX, int destY, int width, int height);