MenuObject Class Reference

This is the base class of all widgets and the menu. More...

#include <MenuObject.h>

Inherits NamedObject.

Inherited by Menu, and Widget.

Collaboration diagram for MenuObject:

[legend]

List of all members.

Public Member Functions
virtual	~MenuObject ()
SceneGraph *	getSceneGraph ()
void	setVisibility (bool vis)
Protected Member Functions
	MenuObject (XMLNode *xml)
Private Attributes
SceneGraph *	scene
std::string	visibilityAnimation
bool	visible

---

Detailed Description

This is the base class of all widgets and the menu.

The MenuObject is the base class of all widgets and the menu. It performs basic tasks like providing a SceneGraph -object and scaling it.

The information for setting up the SceneGraph -object is read from an XMLNode -object, which focuses on a specific node in an XML-file.

The animation for making a widget visible or invisible can be defined by the attribute "visibilityanimation". If no animation has been asigned to this attribute, the method setVisibility( bool vis ) has no effect.

This class should be used as base-class. Direct object instantiation is NOT intended. Therefore, this class has a protected constructor.

Date:

23rd of March 2007

Author:

Thomas Weberndorfer

Updates:

• removed all OSG-depending parts into the SceneGraph -class (26th of April 2007)
• moved the naming functionality into the class NamedObject (3rd of May 2007)
• the animation for changing the visibility can be defined per XML-file (15th of May 2007)

---

Constructor & Destructor Documentation

MenuObject::MenuObject

(

XMLNode *

xml

)

[protected]

The constructor needs an XMLNode -object for setting up the base properties.

Parameters:

xml

Pass an XMLNode -object, which focuses on the correct XML-node in the XML-file.

MenuObject::~MenuObject

(

)

[virtual]

The destructor deletes the SceneGraph -object.

---

Member Function Documentation

SceneGraph* MenuObject::getSceneGraph

(

)

[inline]

This method returns the SceneGraph -object.

Returns:

the SceneGraph -object

void MenuObject::setVisibility

(

bool

vis

)

This method handels the visibility. The animation used for changing the visibility can be described using the XML-file.

Parameters:

vis

Set the visibility. true makes the MenuObject visible; false makes the MenuObject invisible;

---

Member Data Documentation

SceneGraph* MenuObject::scene [private]

std::string MenuObject::visibilityAnimation [private]

bool MenuObject::visible [private]

---

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

• tools/libraries/3DMenu/core/MenuObject.h
• tools/libraries/3DMenu/core/MenuObject.cpp