Rumba C++ SDK
Attributes

Classes

class  maquina::NodeDelegate::Observer
 An object to keep an observer alive. More...
 
class  maquina::NodeDelegate::AttributeDelegate
 A node attribute delegate. More...
 
class  maquina::NodeDelegate::AttributeIteratorDelegate
 A node attribute iterator delegate to implement in the plugin. More...
 
class  maquina::NodeDelegate::AttributeIterator
 A node attribute iterator. More...
 
struct  maquina::NodeDelegate::Attributes
 A node attributes iteration. More...
 

Functions

virtual int maquina::NodeDelegate::attribute_count () const
 Returns the number of attributes. More...
 
virtual std::shared_ptr< AttributeDelegatemaquina::NodeDelegate::attribute (const StringView &name)
 Return a node attribute using its name. More...
 
virtual bool maquina::NodeDelegate::add_attribute (const StringView &name, const Value &value)
 Add a node attribute with the given name and value. More...
 
virtual std::shared_ptr< Channelmaquina::NodeDelegate::channel (const ChannelType sc)
 Return the specified channel if available, return nullptr otherwise. More...
 
virtual std::vector< Channelmaquina::NodeDelegate::channels ()
 Return all the node's channels. More...
 
virtual void maquina::NodeDelegate::channel_plugs (std::unordered_set< Plug > &set) const
 
virtual void maquina::NodeDelegate::animate ()
 Called when the node delegate is assigned to an animation system layer. More...
 
virtual std::shared_ptr< AttributeIteratorDelegatemaquina::NodeDelegate::_attributes_begin ()
 Return the begin iterator of the attributes. More...
 
virtual std::shared_ptr< AttributeIteratorDelegatemaquina::NodeDelegate::_attributes_end ()
 Return the end iterator of the attributes. More...
 
Attributes maquina::NodeDelegate::attributes ()
 

Detailed Description

Function Documentation

◆ _attributes_begin()

virtual std::shared_ptr<AttributeIteratorDelegate> maquina::NodeDelegate::_attributes_begin ( )
protectedvirtual

Return the begin iterator of the attributes.

Reimplemented in maquina::VirtualAttributeNodeDelegate, maquina::NodeDelegateRumba, and maquina::NodeDelegateWrapper.

◆ _attributes_end()

virtual std::shared_ptr<AttributeIteratorDelegate> maquina::NodeDelegate::_attributes_end ( )
protectedvirtual

Return the end iterator of the attributes.

Reimplemented in maquina::VirtualAttributeNodeDelegate, maquina::NodeDelegateRumba, and maquina::NodeDelegateWrapper.

◆ add_attribute()

virtual bool maquina::NodeDelegate::add_attribute ( const StringView name,
const Value value 
)
virtual

Add a node attribute with the given name and value.

Return true if the attribute was succesfully added, false otherwise. The default implementation does nothing.

Reimplemented in maquina::NodeDelegateWrapper.

◆ animate()

virtual void maquina::NodeDelegate::animate ( )
virtual

Called when the node delegate is assigned to an animation system layer.

The node delegate can use this opportunity to create default channel plugs. All document modifications must be done using the undo stack (undo_stack = true).

The default implementation does nothing.

◆ attribute()

virtual std::shared_ptr<AttributeDelegate> maquina::NodeDelegate::attribute ( const StringView name)
virtual

Return a node attribute using its name.

Return nullptr if the attribute does not exist.

Reimplemented in maquina::VirtualAttributeNodeDelegate, maquina::NodeDelegateRumba, and maquina::NodeDelegateWrapper.

◆ attribute_count()

virtual int maquina::NodeDelegate::attribute_count ( ) const
virtual

Returns the number of attributes.

Reimplemented in maquina::VirtualAttributeNodeDelegate, maquina::NodeDelegateRumba, and maquina::NodeDelegateWrapper.

◆ attributes()

Attributes maquina::NodeDelegate::attributes ( )
inline

◆ channel()

virtual std::shared_ptr<Channel> maquina::NodeDelegate::channel ( const ChannelType  sc)
virtual

Return the specified channel if available, return nullptr otherwise.

Return the animation channels of the represented node.

Reimplemented in maquina::NodeDelegateWrapper.

◆ channel_plugs()

virtual void maquina::NodeDelegate::channel_plugs ( std::unordered_set< Plug > &  set) const
virtual

◆ channels()

virtual std::vector<Channel> maquina::NodeDelegate::channels ( )
virtual

Return all the node's channels.

Reimplemented in maquina::NodeDelegateWrapper.