ADTF_DISPLAY_TOOLBOX  3.8.0 (ADTF 3.14.3)
IDrawerabstract

ADTF 2D Display Drawer interface. More...

Inheritance diagram for IDrawer:
[legend]

Public Member Functions

 ADTF_IID (IDrawer, "drawer.dengar.drawerlib.disptb.adtf.iid")
 Define an interface id for this class

 
virtual tInt GetZOrder () const =0
 The ZOrder defines the order of drawing the objects, if they are in the same coordinate space level. More...
 
virtual tBool IsVisible () const =0
 IsVisible() is not the same as IsActive()! If a drawer is invisible all Handlers will be called except the Draw method. More...
 
virtual tResult Draw (const ucom::ant::iobject_ptr< disptb::graphicslib::dengar::ICanvas > &pCanvas)=0
 This method is where the user code defines what is drawn on the canvas. More...
 
virtual tResult OnDraw (const ucom::ant::iobject_ptr< disptb::graphicslib::dengar::ICanvas > &pCanvas)=0
 This method is called from the drawer manager to draw on the give canvas. More...
 

Detailed Description

ADTF 2D Display Drawer interface.

This is the basic Drawer interface which enables developers to extend the functionality of the 2D Display in order to display new data.

Definition at line 30 of file drawer_intf.h.

Member Function Documentation

◆ Draw()

virtual tResult Draw ( const ucom::ant::iobject_ptr< disptb::graphicslib::dengar::ICanvas > &  pCanvas)
pure virtual

This method is where the user code defines what is drawn on the canvas.

Parameters
pCanvas[in/out] Pointer to the current Canvas object
Returns
always NO_ERROR because the base class cDrawer has nothing to draw

◆ GetZOrder()

virtual tInt GetZOrder ( ) const
pure virtual

The ZOrder defines the order of drawing the objects, if they are in the same coordinate space level.

Returns
the current ZOrder value

◆ IsVisible()

virtual tBool IsVisible ( ) const
pure virtual

IsVisible() is not the same as IsActive()! If a drawer is invisible all Handlers will be called except the Draw method.

Returns
tTrue, if the drawer is visibel otherwise tFalse

◆ OnDraw()

virtual tResult OnDraw ( const ucom::ant::iobject_ptr< disptb::graphicslib::dengar::ICanvas > &  pCanvas)
pure virtual

This method is called from the drawer manager to draw on the give canvas.

Parameters
pCanvas[in/out] Pointer to the current Canvas object
Returns
always NO_ERROR because the base class cDrawer has nothing to draw