AbstractParameter Class Reference
Abstract base class for parameters of a node. More...
#include <AbstractParameter.h>
Public Types | |
| typedef QMap< QString, AbstractParameter * > | Map |
| Type definition for a map of parameters and parameter groups. | |
| typedef QList < AbstractParameter * > | List |
| Type definition for a list of parameters and parameter groups. | |
Public Member Functions | |
| AbstractParameter (const QString &name) | |
| Constructor of the AbstractParameter class. | |
| AbstractParameter (const AbstractParameter ¶meter) | |
| Copy constructor of the AbstractParameter class. | |
| virtual | ~AbstractParameter () |
| Destructor of the AbstractParameter class. | |
| QString | getName () const |
| Returns the name of the parameter or parameter group. | |
| bool | isEnabled () const |
| Returns whether the controls for editing the parameter or parameter group in the UI should be enabled. | |
| virtual void | setEnabled (bool enabled) |
| Sets whether the controls for editing the parameter or parameter group in the UI should be enabled. | |
| virtual void | setName (const QString &name) |
| Sets name of the parameter. | |
| Node * | getNode () const |
| Returns the node to which this parameter or parameter group belongs. | |
| virtual void | setNode (Node *node) |
| Sets the node to which this parameter or parameter group belongs. | |
| virtual AbstractParameter * | clone ()=0 |
| Creates an exact copy of the parameter. | |
| virtual bool | isGroup () const =0 |
| Returns whether the parameter object derived from this class is a parameter group. | |
| virtual void | reset ()=0 |
| Resets the parameter to its default value or parameters contained in the group to their default values. | |
Protected Attributes | |
| QString | m_name |
| The name of the parameter or parameter group. | |
| bool | m_enabled |
| Flag that states whether the controls for editing the parameter or parameter group in the UI should be enabled. | |
| Node * | m_node |
| The name of the parent node that this parameter or parameter group belongs to. | |
Detailed Description
Abstract base class for parameters of a node.Member Typedef Documentation
| typedef QMap<QString, AbstractParameter *> AbstractParameter::Map |
Type definition for a map of parameters and parameter groups.
| typedef QList<AbstractParameter *> AbstractParameter::List |
Type definition for a list of parameters and parameter groups.
Constructor & Destructor Documentation
| AbstractParameter::AbstractParameter | ( | const QString & | name | ) |
Constructor of the AbstractParameter class.
Constructors and Destructors.
- Parameters:
-
name The name of the parameter or parameter group.
- Parameters:
-
name The name of the parameter.
| AbstractParameter::AbstractParameter | ( | const AbstractParameter & | parameter | ) |
| AbstractParameter::~AbstractParameter | ( | ) | [virtual] |
Destructor of the AbstractParameter class.
Member Function Documentation
| QString AbstractParameter::getName | ( | ) | const |
Returns the name of the parameter or parameter group.
Public Functions.
- Returns:
- The name of the parameter or parameter group.
- Returns:
- The name of the parameter or parameter group.
| bool AbstractParameter::isEnabled | ( | ) | const |
Returns whether the controls for editing the parameter or parameter group in the UI should be enabled.
- Returns:
- True if the controls should be enabled, otherwise False.
| void AbstractParameter::setEnabled | ( | bool | enabled | ) | [virtual] |
Sets whether the controls for editing the parameter or parameter group in the UI should be enabled.
- Parameters:
-
enabled The value for the parameter's enabled flag.
Reimplemented in NumberParameter, Parameter, and ParameterGroup.
| void AbstractParameter::setName | ( | const QString & | name | ) | [virtual] |
Sets name of the parameter.
- Parameters:
-
name The parameter name.
| Node * AbstractParameter::getNode | ( | ) | const |
Returns the node to which this parameter or parameter group belongs.
- Returns:
- The node to which the parameter or parameter group belongs.
| void AbstractParameter::setNode | ( | Node * | node | ) | [virtual] |
Sets the node to which this parameter or parameter group belongs.
- Parameters:
-
node The node to which the parameter or parameter group belongs.
Reimplemented in ParameterGroup.
| virtual AbstractParameter* AbstractParameter::clone | ( | ) | [pure virtual] |
Creates an exact copy of the parameter.
- Returns:
- An exact copy of the parameter.
Implemented in EnumerationParameter, FilenameParameter, NumberParameter, Parameter, ParameterGroup, and SceneNodeParameter< T >.
| virtual bool AbstractParameter::isGroup | ( | ) | const [pure virtual] |
Returns whether the parameter object derived from this class is a parameter group.
- Returns:
- True if the parameter object is a parameter group, otherwise False.
Implemented in Parameter, and ParameterGroup.
| virtual void AbstractParameter::reset | ( | ) | [pure virtual] |
Resets the parameter to its default value or parameters contained in the group to their default values.
Implemented in Parameter, and ParameterGroup.
Member Data Documentation
QString AbstractParameter::m_name [protected] |
The name of the parameter or parameter group.
bool AbstractParameter::m_enabled [protected] |
Flag that states whether the controls for editing the parameter or parameter group in the UI should be enabled.
Node* AbstractParameter::m_node [protected] |
The name of the parent node that this parameter or parameter group belongs to.
The documentation for this class was generated from the following files:
