A node attribute delegate.
More...
#include <NodeDelegate.h>
A node attribute delegate.
◆ ~AttributeDelegate()
| virtual maquina::NodeDelegate::AttributeDelegate::~AttributeDelegate |
( |
| ) |
|
|
inlinevirtual |
◆ accepts_overrides()
| virtual bool maquina::NodeDelegate::AttributeDelegate::accepts_overrides |
( |
| ) |
const |
|
virtual |
Return true is the attribute accepts overrides.
The default implementation returns false.
◆ add_override()
| virtual void maquina::NodeDelegate::AttributeDelegate::add_override |
( |
| ) |
|
|
virtual |
Add add override.
The default implementation does nothing.
◆ create_observer()
| virtual std::shared_ptr<Observer> maquina::NodeDelegate::AttributeDelegate::create_observer |
( |
const std::function< void()> & |
func, |
|
|
bool |
in_interactive = true |
|
) |
| |
|
virtual |
Return an observer which will call the func function when the attribute is possibly modified.
The observer is called when the attribute is modified. It may be called more than necessary in some implementation, like with the Values's attributes.
To stop the function to be called, un-reference the Observer shared pointer.
If no observer can be created, returns nullptr.
◆ description()
| virtual std::string maquina::NodeDelegate::AttributeDelegate::description |
( |
| ) |
const |
|
virtual |
Return the description for this attribute (see Plug description).
◆ has_node_delegate()
| virtual bool maquina::NodeDelegate::AttributeDelegate::has_node_delegate |
( |
| ) |
const |
|
virtual |
Return true if this attribute has a dedicated node delegate to traverse its structure.
The default implementation returns false
◆ is_animable()
| virtual bool maquina::NodeDelegate::AttributeDelegate::is_animable |
( |
| ) |
const |
|
virtual |
Return true is the attribute is animable.
The default implementation returns false.
◆ is_mutable()
| virtual bool maquina::NodeDelegate::AttributeDelegate::is_mutable |
( |
| ) |
const |
|
virtual |
Return true is the attribute can be modified.
The default implementation returns false.
◆ is_overridden()
| virtual bool maquina::NodeDelegate::AttributeDelegate::is_overridden |
( |
| ) |
const |
|
virtual |
Return true is the attribute is overridden.
The default implementation returns false.
◆ is_plug()
| virtual bool maquina::NodeDelegate::AttributeDelegate::is_plug |
( |
| ) |
const |
|
virtual |
Return true if this attribute is a Rumba Plug.
◆ is_visible()
| virtual bool maquina::NodeDelegate::AttributeDelegate::is_visible |
( |
| ) |
const |
|
virtual |
Return true is the attribute is visible.
The default implementation returns true.
◆ name()
| virtual std::string maquina::NodeDelegate::AttributeDelegate::name |
( |
| ) |
const |
|
pure virtual |
Return the attribute name.
◆ node_delegate()
| virtual std::shared_ptr<NodeDelegate> maquina::NodeDelegate::AttributeDelegate::node_delegate |
( |
| ) |
|
|
virtual |
Return the dedicated node delegate.
Implemented by the plug-in.
◆ owner()
| virtual std::shared_ptr<NodeDelegate> maquina::NodeDelegate::AttributeDelegate::owner |
( |
| ) |
|
|
pure virtual |
Returns the owner node.
Implemented by the plug-in.
◆ plug()
| virtual Plug maquina::NodeDelegate::AttributeDelegate::plug |
( |
| ) |
const |
|
virtual |
Return the plug behind this attribute.
- Exceptions
-
| std::runtime_error | if the attribute is not mapped to a Plug |
◆ remove_override()
| virtual void maquina::NodeDelegate::AttributeDelegate::remove_override |
( |
| ) |
|
|
virtual |
Remove the override.
The default implementation does nothing.
◆ set_value()
◆ type_name()
| virtual StringView maquina::NodeDelegate::AttributeDelegate::type_name |
( |
| ) |
const |
|
pure virtual |
Get the attribute type name, without evaluating the attribute.
◆ value()
| virtual Value maquina::NodeDelegate::AttributeDelegate::value |
( |
| ) |
const |
|
pure virtual |
Return the attribute value.
The documentation for this class was generated from the following file: