albaGUIGizmoInterface Class Reference

#include <albaGUIGizmoInterface.h>

Inheritance diagram for albaGUIGizmoInterface:

Collaboration diagram for albaGUIGizmoInterface:

Public Member Functions
virtual	~albaGUIGizmoInterface ()
virtual void	OnEvent (albaEventBase *alba_event)
albaGUI *	GetGui ()
virtual void	EnableWidgets (bool enable)
void	TestModeOn ()
void	TestModeOff ()
bool	GetTestMode ()
Public Member Functions inherited from albaObserver
	albaObserver ()
virtual	~albaObserver ()
virtual void	OnEvent (albaEventBase *e)=0

Protected Member Functions
virtual void	CreateGui ()
	albaGUIGizmoInterface (albaObserver *listener=NULL)

Protected Attributes
albaObserver *	m_Listener
albaGUI *	m_Gui
bool	m_TestMode

Friends
class	albaGUIGizmoInterfaceTest

Detailed Description

abstract base class for gizmo gui

See also

Todo:

• add an ivar to register widgets enabling status: should also refactor dependencies to use this flag.
• provide a barebone implementation for functions doing nothing
• enforce superclass implementation by using pure virtuals

Definition at line 43 of file albaGUIGizmoInterface.h.

Constructor & Destructor Documentation

~albaGUIGizmoInterface()

virtual albaGUIGizmoInterface::~albaGUIGizmoInterface ( )

virtual

albaGUIGizmoInterface()

albaGUIGizmoInterface::albaGUIGizmoInterface ( albaObserver *  listener = NULL )

protected

Member Function Documentation

OnEvent()

virtual void albaGUIGizmoInterface::OnEvent ( albaEventBase *  e )

inlinevirtual

process the events sent by subjects

Implements albaObserver.

Reimplemented in albaGUIGizmoRotate, albaGUIGizmoScale, and albaGUIGizmoTranslate.

Definition at line 49 of file albaGUIGizmoInterface.h.

GetGui()

albaGUI * albaGUIGizmoInterface::GetGui ( )

inline

Return the gui to be plugged.

Definition at line 52 of file albaGUIGizmoInterface.h.

Referenced by albaGizmoCrossRotate::GetGui(), and albaGizmoCrossTranslate::GetGui().

EnableWidgets()

virtual void albaGUIGizmoInterface::EnableWidgets ( bool  enable )

inlinevirtual

Enable-Disable the GUI's widgets.

Reimplemented in albaGUIGizmoRotate, albaGUIGizmoScale, and albaGUIGizmoTranslate.

Definition at line 55 of file albaGUIGizmoInterface.h.

TestModeOn()

void albaGUIGizmoInterface::TestModeOn ( )

inline

Turn On m_TestMode flag.

The m_TestMode flag is used to exclude the execution of splash screen or wxBusyInfo that conflicts with test machine.

Definition at line 59 of file albaGUIGizmoInterface.h.

TestModeOff()

void albaGUIGizmoInterface::TestModeOff ( )

inline

Used to turn off m_TestMode flag.

Definition at line 62 of file albaGUIGizmoInterface.h.

GetTestMode()

bool albaGUIGizmoInterface::GetTestMode ( )

inline

Get TestMode.

Definition at line 65 of file albaGUIGizmoInterface.h.

CreateGui()

virtual void albaGUIGizmoInterface::CreateGui ( )

inlineprotectedvirtual

Reimplemented in albaGUIGizmoRotate, albaGUIGizmoScale, and albaGUIGizmoTranslate.

Definition at line 68 of file albaGUIGizmoInterface.h.

Friends And Related Function Documentation

albaGUIGizmoInterfaceTest

friend class albaGUIGizmoInterfaceTest

friend

Test friend.

Definition at line 77 of file albaGUIGizmoInterface.h.

Member Data Documentation

m_Listener

albaObserver* albaGUIGizmoInterface::m_Listener

protected

Definition at line 72 of file albaGUIGizmoInterface.h.

m_Gui

albaGUI* albaGUIGizmoInterface::m_Gui

protected

Definition at line 73 of file albaGUIGizmoInterface.h.

m_TestMode

bool albaGUIGizmoInterface::m_TestMode

protected

Definition at line 74 of file albaGUIGizmoInterface.h.

---

The documentation for this class was generated from the following file:

• albaGUIGizmoInterface.h