Eaagles::BasicGL::LcPage

Eaagles::BasicGL::LcPage Class Reference

Inherits Eaagles::BasicGL::LcGraphic.

Inherited by Eaagles::BasicGL::LcDisplay, Eaagles::Instruments::EngPage, Eaagles::Instruments::MfdPage, Eaagles::Instruments::PfdPage, Eaagles::Instruments::TestAlt, Eaagles::Instruments::TestCas, Eaagles::Instruments::TestCompass, Eaagles::Instruments::TestDigitalGauge, Eaagles::Instruments::TestDynamicMapPage, Eaagles::Instruments::TestEngineDial, Eaagles::Instruments::TestFtitDial, Eaagles::Instruments::TestGauge1, Eaagles::Instruments::TestGMeterDial, Eaagles::Instruments::TestHsi, Eaagles::Instruments::TestLandingGear, Eaagles::Instruments::TestNozzle, Eaagles::Instruments::TestOilPressure, Eaagles::Instruments::TestRpmDial, Eaagles::Instruments::TestSpeedBrake, and Eaagles::Instruments::TestVVI.

Inheritance diagram for Eaagles::BasicGL::LcPage:

Inheritance graph
[legend]
Collaboration diagram for Eaagles::BasicGL::LcPage:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 LcPage ()
const char * subpageName () const
LcPage * subpage () const
bool isPostDrawSubpage () const
virtual Basic::LcPair * findSubpageByName (const char *const slotname)
virtual Basic::LcPair * findSubpageByType (const std::type_info &type)
bool isFocusSlavedToSubpage () const
void setFocusSlavedToSubpage (const bool f)
virtual void draw ()
virtual Basic::LcPair * findBySelectName (const GLuint name)
virtual bool event (const int event, LcObject *const obj=0)
virtual void updateTC (const LCreal dt=0.0f)
virtual void updateData (const LCreal dt=0.0f)
virtual void reset ()
bool setPage (const Basic::LcIdent *const pobj)
bool setSubpageStream (Basic::LcPairStream *const psobj)
bool setSubpageSingle (LcPage *const pobj)
bool setPagingEvent (Basic::LcPairStream *const peobj)
bool drawSubpageFirst (const Basic::LcNumber *const spfobj)
bool setSlotFocusSlavedToSubpage (const Basic::LcNumber *const spfobj)
virtual bool onEntry ()
virtual bool onExit ()
virtual bool onButtonHit (const Basic::LcString *const obhobj)
virtual bool onKeyHit (const int key)
bool newSubpage (LcPage *const newPage, LcPage *theCaller, LcObject *theArg=0)
bool newSubpage (const char *const name, LcPage *theCaller, LcObject *theArg=0)

Protected Member Functions

LcObject * getArgument ()
const LcPage * getCaller ()
Basic::LcPairStream * subPages ()
bool clearSubpageStack ()
bool pushSubpage (const char *const name, LcPage *theCaller, Basic::LcObject *theArg=0)
bool popSubpage (LcPage *theCaller, LcObject *theArg=0)
bool newPage (LcPage *const newPage, LcPage *theCaller, LcObject *theArg=0)
bool newPage (const char *const name, LcPage *theCaller, LcObject *theArg=0)
bool pushPage (const char *const name, LcPage *theCaller, LcObject *theArg=0)
bool popPage (LcPage *theCaller, Basic::LcObject *theArg=0)

Private Member Functions

bool processSubpages ()

Private Attributes

LcPage * cp
Basic::LcIdent cpName
LcPage * np
Basic::LcPairStream * subpages
Basic::LcPairStream * pageChgEvents
bool postDraw1
bool focusSlavedToSubpage
Basic::LcObject * pageArg
const LcPage * caller
LcPage * subpageStack [SUBPAGE_STACK_SIZE]
int subpageSP

Static Private Attributes

static const int SUBPAGE_STACK_SIZE = 50

Detailed Description

Page format. A list of graphic objects and methods to manage
                 them as a page, also contains subpages and a background page.

    Slots:
   	1. page			(LcIdent)		Initial subpage
   	2. pages			(LcPairStream)	Subpages
   	3. pagingEvent		(LcPage)		Page change event
   	4. subpagesFirst		(LcPairStream)	Draw subpages first (default: draw our page graphics first)
   	5. focusSlavedToSubpage	(LcNumber)		Slave the focus to the subpage (default: true)

    Events
   	1. ON_ENTRY
   	2. ON_EXIT
   	3. BUTTON_HIT
   	4. ON_ANYKEY

     ( def-form Page
         is= Graphic
         'page       ;; Initial subpage
         'pages      ;; Subpages
     )

Constructor & Destructor Documentation

Eaagles::BasicGL::LcPage::LcPage (  ) 

Member Function Documentation

const char* Eaagles::BasicGL::LcPage::subpageName (  )  const [inline]

Returns cpName.

LcPage* Eaagles::BasicGL::LcPage::subpage (  )  const [inline]

Returns cp.

bool Eaagles::BasicGL::LcPage::isPostDrawSubpage (  )  const [inline]

Returns postDraw1.

Basic::LcPair * Eaagles::BasicGL::LcPage::findSubpageByName ( const char *const  slotname  )  [virtual]

Returns a member from the slot name given, else 0.

Basic::LcPair * Eaagles::BasicGL::LcPage::findSubpageByType ( const std::type_info &  type  )  [virtual]

Returns a member of the given type, else 0.

bool Eaagles::BasicGL::LcPage::isFocusSlavedToSubpage (  )  const [inline]

Returns true if the focus is slaved to a subpage.

void Eaagles::BasicGL::LcPage::setFocusSlavedToSubpage ( const bool  f  )  [inline]

Sets focusSlavedToSubpage to f.

void Eaagles::BasicGL::LcPage::draw (  )  [virtual]

LcGraphic Interface. Draw this object and its children.

Reimplemented from Eaagles::BasicGL::LcGraphic.

Reimplemented in Eaagles::Instruments::PfdPage, and Eaagles::Instruments::SymbolLoader.

Basic::LcPair * Eaagles::BasicGL::LcPage::findBySelectName ( const GLuint  name  )  [virtual]

Finds one of the components by it's GL Select (pick) name - children first then grandchildren.

Reimplemented from Eaagles::BasicGL::LcGraphic.

virtual bool Eaagles::BasicGL::LcPage::event ( const int  event,
LcObject *const  obj = 0 
) [virtual]

LcComponent interface. This is an event function for the LcComponent interface.

Reimplemented from Eaagles::BasicGL::LcGraphic.

Reimplemented in Eaagles::BasicGL::LcDisplay.

void Eaagles::BasicGL::LcPage::updateTC ( const LCreal  dt = 0.0f  )  [virtual]

Update time critical stuff here.

Reimplemented from Eaagles::Basic::LcComponent.

Reimplemented in Eaagles::BasicGL::LcDisplay, and Eaagles::Instruments::SymbolLoader.

void Eaagles::BasicGL::LcPage::updateData ( const LCreal  dt = 0.0f  )  [virtual]

Function to update non time critical stuff.

Reimplemented from Eaagles::Basic::LcComponent.

Reimplemented in Eaagles::Fox::Display, Eaagles::Instruments::EngPage, Eaagles::Instruments::MapPage, Eaagles::Instruments::MfdPage, Eaagles::Instruments::SymbolLoader, Eaagles::Instruments::TestAlt, Eaagles::Instruments::TestCas, Eaagles::Instruments::TestCompass, Eaagles::Instruments::TestDigitalGauge, Eaagles::Instruments::TestDynamicMapPage, Eaagles::Instruments::TestEngineDial, Eaagles::Instruments::TestEngPage, Eaagles::Instruments::TestFtitDial, Eaagles::Instruments::TestGauge1, Eaagles::Instruments::TestGMeterDial, Eaagles::Instruments::TestHsi, Eaagles::Instruments::TestLandingGear, Eaagles::Instruments::TestNozzle, Eaagles::Instruments::TestOilPressure, Eaagles::Instruments::TestRpmDial, Eaagles::Instruments::TestSpeedBrake, Eaagles::Instruments::TestVVI, and Eaagles::MovingMap::MovingMapImage.

void Eaagles::BasicGL::LcPage::reset (  )  [virtual]

Resets the parameters.

Reimplemented from Eaagles::Basic::LcComponent.

Reimplemented in Eaagles::BasicGL::LcDisplay, and Eaagles::BasicGL::GlutDisplay.

bool Eaagles::BasicGL::LcPage::setPage ( const Basic::LcIdent *const  pobj  ) 

macro slottable function - sets the page to pobj and returns true if successful

bool Eaagles::BasicGL::LcPage::setSubpageStream ( Basic::LcPairStream *const   psobj  ) 

macro slottable function - sets the subpage stream to psobj and returns true if successful

bool Eaagles::BasicGL::LcPage::setSubpageSingle ( LcPage *const   pobj  ) 

macro slottable function - sets the subpage single to pobj and returns true if successful

bool Eaagles::BasicGL::LcPage::setPagingEvent ( Basic::LcPairStream *const   peobj  ) 

macro slottable function - sets the paging event to peobj and returns true if successful

bool Eaagles::BasicGL::LcPage::drawSubpageFirst ( const Basic::LcNumber *const  spfobj  ) 

macro slottable function - set drawSubpageFirst (boolean) then return true if successful

bool Eaagles::BasicGL::LcPage::setSlotFocusSlavedToSubpage ( const Basic::LcNumber *const  spfobj  ) 

macro slottable function - set focusSlavedToSubpage (boolean) and return true if successful

bool Eaagles::BasicGL::LcPage::onEntry (  )  [virtual]

macro event handler function - always returns true. The function is not yet implemented

Reimplemented in Eaagles::Instruments::MfdPage.

bool Eaagles::BasicGL::LcPage::onExit (  )  [virtual]

macro event handler function - always returns true. The function is not yet implemented

Reimplemented in Eaagles::Instruments::MfdPage.

bool Eaagles::BasicGL::LcPage::onButtonHit ( const Basic::LcString *const  obhobj  )  [virtual]

macro event handler function - handles the button hit as a page change event

bool Eaagles::BasicGL::LcPage::onKeyHit ( const int  key  )  [virtual]

macro event handler function - handles the keyboard hit as a page change event

bool Eaagles::BasicGL::LcPage::newSubpage ( LcPage *const   newPage,
LcPage *  theCaller,
LcObject *  theArg = 0 
)

Call new sub-page. Changes subpages by page. Returns true if page was found.

bool Eaagles::BasicGL::LcPage::newSubpage ( const char *const  name,
LcPage *  theCaller,
LcObject *  theArg = 0 
)

Call new sub-page. Changes subpages by name. Returns true if the page was found.

LcObject* Eaagles::BasicGL::LcPage::getArgument (  )  [inline, protected]

Returns the paging arguments.

const LcPage* Eaagles::BasicGL::LcPage::getCaller (  )  [inline, protected]

Returns the calling page.

Basic::LcPairStream* Eaagles::BasicGL::LcPage::subPages (  )  [inline, protected]

Returns the subpages.

bool Eaagles::BasicGL::LcPage::clearSubpageStack (  )  [protected]

(sub)page stack management function. Clears the subpage stack

bool Eaagles::BasicGL::LcPage::pushSubpage ( const char *const  name,
LcPage *  theCaller,
Basic::LcObject *  theArg = 0 
) [protected]

(sub)page stack management function. Push the current subpage and change to new subpage 'name'

bool Eaagles::BasicGL::LcPage::popSubpage ( LcPage *  theCaller,
LcObject *  theArg = 0 
) [protected]

(sub)page stack management function. Pop to the previous subpage on the stack

bool Eaagles::BasicGL::LcPage::newPage ( LcPage *const   newPage,
LcPage *  theCaller,
LcObject *  theArg = 0 
) [protected]

Function that asks the container to change to newpage by pointer.

bool Eaagles::BasicGL::LcPage::newPage ( const char *const  name,
LcPage *  theCaller,
LcObject *  theArg = 0 
) [protected]

Function that asks the container to change to newpage by name.

bool Eaagles::BasicGL::LcPage::pushPage ( const char *const  name,
LcPage *  theCaller,
LcObject *  theArg = 0 
) [protected]

Push new page.

bool Eaagles::BasicGL::LcPage::popPage ( LcPage *  theCaller,
Basic::LcObject *  theArg = 0 
) [protected]

Pop back to previous page.

bool Eaagles::BasicGL::LcPage::processSubpages (  )  [private]

Process the subpages; make sure they are all of type LcPage (or derived from it)and tell them that this is their container.

Member Data Documentation

LcPage* Eaagles::BasicGL::LcPage::cp [private]

Current Subpage.

Basic::LcIdent Eaagles::BasicGL::LcPage::cpName [private]

Current Subpage Name.

LcPage* Eaagles::BasicGL::LcPage::np [private]

New subpage (requesting a page change).

Basic::LcPairStream* Eaagles::BasicGL::LcPage::subpages [private]

Subpages.

Basic::LcPairStream* Eaagles::BasicGL::LcPage::pageChgEvents [private]

Page change events.

bool Eaagles::BasicGL::LcPage::postDraw1 [private]

Post draw component (child) graphic.

bool Eaagles::BasicGL::LcPage::focusSlavedToSubpage [private]

Input event focus should follow subpage changes.

Basic::LcObject* Eaagles::BasicGL::LcPage::pageArg [private]

Paging argument. Passed by calling page.

const LcPage* Eaagles::BasicGL::LcPage::caller [private]

Calling page.

const int Eaagles::BasicGL::LcPage::SUBPAGE_STACK_SIZE = 50 [static, private]

Subpage Stack.

LcPage* Eaagles::BasicGL::LcPage::subpageStack[SUBPAGE_STACK_SIZE] [private]

int Eaagles::BasicGL::LcPage::subpageSP [private]

Stack pointer.

Generated on Tue Dec 19 16:26:44 2006 for Eaagles by  doxygen 1.5.0