Interface for Objects that display informations based on a Navigation Instruction. More...
Public Member Functions | |
| virtual void | updateWithInstruction (VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigation > const &pNavigation, unsigned int pIndex)=0 |
| Updates this Display with an instruction. | |
| virtual void | clear ()=0 |
| Clears the content. | |
| virtual void | show ()=0 |
| Declaration from interface : VgMyDisplayable. | |
| virtual void | hide ()=0 |
| Hides this Object. | |
| virtual bool | isVisible ()=0 |
Detailed Description
Interface for Objects that display informations based on a Navigation Instruction.
VgNavigationModule::VgINavigationInstruction.
VgMyInstructionDisplay subclasses do not need to implement VgNavigationModule::VgINavigationListener. They will be notified by the application controller through updateWithInstruction();
Member Function Documentation
| virtual void VgMyInstructionDisplay::clear | ( | ) | [pure virtual] |
Clears the content.
Implemented in VgMyInstructionPathDisplay.
| virtual void VgMyInstructionDisplay::hide | ( | ) | [pure virtual] |
Hides this Object.
No effect if it is already hidden.
Implements VgMyDisplayable.
Implemented in VgMyInstructionPathDisplay.
| virtual bool VgMyInstructionDisplay::isVisible | ( | ) | [pure virtual] |
- Returns:
- TRUE if this Object is visible (i.e. shown). FALSE otherwise.
Implements VgMyDisplayable.
Implemented in VgMyInstructionPathDisplay.
| virtual void VgMyInstructionDisplay::show | ( | ) | [pure virtual] |
Declaration from interface : VgMyDisplayable.
Implements VgMyDisplayable.
Implemented in VgMyInstructionPathDisplay.
| virtual void VgMyInstructionDisplay::updateWithInstruction | ( | VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigation > const & | pNavigation, |
| unsigned int | pIndex | ||
| ) | [pure virtual] |
Updates this Display with an instruction.
- Parameters:
-
pNavigation The navigation object used. pIndex The instruction index to use.
Implemented in VgMyInstructionPathDisplay.
The documentation for this class was generated from the following file:
- VgMyInstructionDisplay.h