1 // Base class for elements of property controlled subsystems
3 // Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Library General Public
7 // License as published by the Free Software Foundation; either
8 // version 2 of the License, or (at your option) any later version.
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Library General Public License for more details.
15 // You should have received a copy of the GNU Library General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 #ifndef SG_PROPERTY_BASED_ELEMENT_HXX_
20 #define SG_PROPERTY_BASED_ELEMENT_HXX_
22 #include <simgear/props/props.hxx>
23 #include <simgear/structure/SGWeakReferenced.hxx>
29 * Base class for a property controlled element
31 class PropertyBasedElement:
32 public SGPropertyChangeListener,
33 public virtual SGVirtualWeakReferenced
36 PropertyBasedElement(SGPropertyNode* node);
37 virtual ~PropertyBasedElement();
40 * Remove the property listener of the element.
42 * You will need to call the appropriate methods (#childAdded,
43 * #childRemoved, #valueChanged) yourself to ensure the element still
44 * receives the needed events.
46 void removeListener();
49 * Destroys this element (removes node from property tree)
53 virtual void update(double delta_time_sec) = 0;
55 SGConstPropertyNode_ptr getProps() const;
56 SGPropertyNode_ptr getProps();
59 void set( const std::string& name,
62 setValue(_node->getNode(name, true), val);
66 T get( const std::string& name,
69 SGPropertyNode const* child = _node->getNode(name);
73 return getValue<T>(child);
76 // Unshadow what we have just hidden...
77 using SGWeakReferenced::get;
80 /** @brief Set a HTML5 like data property on this element.
82 * Set data-* properties on this element. A camel-case @a name will be
83 * converted to a hyphenated name with 'data-' prefixed. Setting a value
84 * with this method does not trigger an update of the canvas and is meant
85 * to store data related to this element (used eg. inside scripts).
89 * my_element->setDataProp("mySpecialInt", 3);
91 * // Get value (with default value)
92 * int val = my_element->getDataProp<int>("mySpecialInt"); // val == 3
93 * val = my_element->getDataProp<int>("notExisting", 5); // val == 5
95 * // Check if value exists
96 * SGPropertyNode* node =
97 * my_element->getDataProp<SGPropertyNode*>("mySpecialInt");
99 * val = node->getIntValue(); // node != NULL, val == 3
101 * node = my_element->getDataProp<SGPropertyNode*>("notExisting");
106 void setDataProp( const std::string& name,
109 const std::string& attr = dataPropToAttrName(name);
113 SG_LOG(SG_GENERAL, SG_WARN, "Invalid data-prop name: " << name);
116 /** @brief Get a HTML5 like data property on this element.
118 * Get value or default value.
123 typename boost::disable_if<
124 boost::is_same<T, SGPropertyNode*>,
126 >::type getDataProp( const std::string& name,
127 const T& def = T() ) const
129 SGPropertyNode* node = getDataProp<SGPropertyNode*>(name);
131 return getValue<T>(node);
136 /** @brief Get a HTML5 like data property on this element.
138 * Use this variant to check if a property exists.
143 typename boost::enable_if<
144 boost::is_same<T, SGPropertyNode*>,
146 >::type getDataProp( const std::string& name,
147 SGPropertyNode* = NULL ) const
149 const std::string& attr = dataPropToAttrName(name);
152 SG_LOG(SG_GENERAL, SG_WARN, "Invalid data-prop name: " << name);
156 return _node->getNode(attr);
159 /** @brief Check whether a HTML5 like data property exists on this
163 bool hasDataProp(const std::string& name) const;
165 /** @brief Remove a HTML5 like data property (if it exists).
168 void removeDataProp(const std::string& name);
170 virtual void onDestroy() {};
172 static std::string dataPropToAttrName(const std::string& name);
173 static std::string attrToDataPropName(const std::string& name);
177 SGPropertyNode_ptr _node;
181 typedef SGSharedPtr<PropertyBasedElement> PropertyBasedElementPtr;
182 typedef SGWeakPtr<PropertyBasedElement> PropertyBasedElementWeakPtr;
184 } // namespace simgear
186 #endif /* SG_PROPERTY_BASED_ELEMENT_HXX_ */