Abstract base class for parameters of a node. More...

#include <AbstractParameter.h>

Inheritance diagram for Frapper::AbstractParameter:

[legend]

Collaboration diagram for Frapper::AbstractParameter:

Public Types
typedef QHash< 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.

Signals
void	enabledChanged ()
	Signal that is emitted when the parameter is enabled or disabled.

Public Member Functions
	AbstractParameter (const QString &name)
	Constructor of the AbstractParameter class.

	AbstractParameter (const AbstractParameter &parameter)
	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, bool propagate=true)
	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 QHash<QString, AbstractParameter *> Frapper::AbstractParameter::Map

Type definition for a map of parameters and parameter groups.

typedef QList<AbstractParameter *> Frapper::AbstractParameter::List

Type definition for a list of parameters and parameter groups.

Constructor & Destructor Documentation

Frapper::AbstractParameter::AbstractParameter ( const QString & name )

Constructor of the AbstractParameter class.

Constructors and Destructors.

Parameters

name	The name of the parameter or parameter group.

Constructor of the AbstractParameter class.

Parameters

name	The name of the parameter.

Frapper::AbstractParameter::AbstractParameter ( const AbstractParameter & parameter )

Copy constructor of the AbstractParameter class.

Parameters

parameter The parameter to copy.

Frapper::AbstractParameter::~AbstractParameter ( )

virtual

Destructor of the AbstractParameter class.

Member Function Documentation

QString Frapper::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.

Returns: The name of the parameter or parameter group.

bool Frapper::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 Frapper::AbstractParameter::setEnabled	(	bool	enabled,
		bool	propagate = `true`
	)

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 Frapper::ParameterGroup, and Frapper::NumberParameter.

void Frapper::AbstractParameter::setName ( const QString & name )

virtual

Sets name of the parameter.

Parameters

name	The parameter name.

Node * Frapper::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 Frapper::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 Frapper::ParameterGroup.

virtual AbstractParameter* Frapper::AbstractParameter::clone ( )

pure virtual

Creates an exact copy of the parameter.

Returns: An exact copy of the parameter.

Implemented in Frapper::Parameter, Frapper::ParameterGroup, Frapper::NumberParameter, Frapper::SceneNodeParameter< T >, Frapper::FilenameParameter, Frapper::GenericParameter, and Frapper::EnumerationParameter.

virtual bool Frapper::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 Frapper::Parameter, and Frapper::ParameterGroup.

virtual void Frapper::AbstractParameter::reset ( )

pure virtual

Resets the parameter to its default value or parameters contained in the group to their default values.

Implemented in Frapper::Parameter, and Frapper::ParameterGroup.

void Frapper::AbstractParameter::enabledChanged ( )

signal

Signal that is emitted when the parameter is enabled or disabled.

Member Data Documentation

QString Frapper::AbstractParameter::m_name

protected

The name of the parameter or parameter group.

bool Frapper::AbstractParameter::m_enabled

protected

Flag that states whether the controls for editing the parameter or parameter group in the UI should be enabled.

Node* Frapper::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:

Public Types

Signals

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation