This class describes a property object. More...

#include <PropertyObject.h>

Inherits QObject.

Public Member Functions
virtual bool	addProperty (Property *)
	Tag a new CamiTK property to this object. More...

virtual unsigned int	getNumberOfProperties () const
	get the current number of property More...

virtual Q_INVOKABLE Property *	getProperty (QString name)
	Get a Property given its name. More...

virtual QString	getPropertyName (unsigned int index) const
	get the name of the property at the given index, null string if index is out of bounds (i.e., isNull() == true) More...

virtual QVariant	getPropertyValue (unsigned int index)
	get the value of the property at the given index, a non valid QVariant if the index is out of bounds (i.e., isValid() == false) More...

virtual QVariant	getPropertyValue (const QString name)
	conveniant method to get the value of a given property, returns a non valid QVariant if no property with that name exists More...

void	loadFromSettings (const QString &settingGroupName)
	initializes all property values from setting values found in the given group name More...

	PropertyObject (QString name)
	Default constructor. More...

virtual void	removeProperty (Property *)
	Remove a CamiTK property of this object. More...

void	saveToSettings (const QString &settingGroupName)
	save setting in the given group name using all the property values More...

	~PropertyObject () override
	Destructor. More...

Static Public Member Functions
static QString	toCamelCase (const QString &)
	utility method to transform property name to camel case. Quite useful to make sure all settings are stored as lowerCamelCase More...

Private Attributes
Property management
list of CamiTK properties decorating the object
QMap< QString, Property * >	propertiesMap

Detailed Description

This class describes a property object.

A property object is simply a QObject tagged with some CamiTK Properties The idea is to have an object which implements all the necessary methods to take advantages of the CamiTK Properties within the ObjectController

PropertyObject can be saved/loaded from settings. A typical use in this case is to

PropertyObject = new PropertyObject(...);
// set default value
propertyObject->addProperty(...);
propertyObject->addProperty(...);
propertyObject->addProperty(...);
// load values from settings
loadFromSettings("mySection");
...
saveToSettings("mySection")

See the Application class for an example of a property object load/save to settings.

See also: ObjectController, Property

Constructor & Destructor Documentation

◆ PropertyObject()

camitk::PropertyObject::PropertyObject ( QString name )

Default constructor.

Parameters

name	The name of the PropertyObject instance. This one would be displayed in any SettingsDialog entries.

◆ ~PropertyObject()

camitk::PropertyObject::~PropertyObject ( )

override

Destructor.

References propertiesMap.

Member Function Documentation

◆ addProperty()

bool camitk::PropertyObject::addProperty ( Property * prop )

virtual

Tag a new CamiTK property to this object.

If the property already exist, it will just change its value.

Note: The object takes ownership of the Property instance.

Returns: false if the Qt Meta Object property was added by this method (otherwise the property was already defined and true is returned if it was successfully updated)

References camitk::Property::getInitialValue(), camitk::Property::getName(), and propertiesMap.

Referenced by camitk::Application::createProperties(), and camitk::InteractiveViewer::createProperties().