Rumba C++ SDK
maquina::BaseLayer Class Reference

#include <BaseLayer.h>

Inheritance diagram for maquina::BaseLayer:
maquina::NodePlugin maquina::AnimLayer maquina::DeformLayer

Public Member Functions

 BaseLayer (Node *node)
 
void on_delete (bool undo_stack) override
 Prepare the node to be deleted. More...
 
void on_add_to_document () override
 Callback called when the node is added to the document. More...
 
void on_remove_from_document () override
 Callback called when the node is removed from the document. More...
 
void relationship (NodeSet &set) const override
 Return the node relationships. More...
 
void on_input_connection (const Plug &output, const Plug &input, bool serial) override
 Callback called when an a connection has been done between an output plug and a plug of this node as input. More...
 
- Public Member Functions inherited from maquina::NodePlugin
 NodePlugin (Node *node)
 
virtual ~NodePlugin ()
 
virtual void on_first_init (bool)
 Perform the one shot initialization tasks for this node. More...
 
virtual void on_output_connection (const Plug &, const Plug &, bool)
 Callback called when an a connection has been done between a plug of this node as output and an input plug. More...
 
virtual void on_input_disconnection (const Plug &, const Plug &)
 Callback called when an a connection has been broken between an output plug and a plug of this node as input. More...
 
virtual void on_output_disconnection (const Plug &, const Plug &)
 Callback called when an a connection has been broken between a plug of this node as output and an input plug. More...
 
virtual std::shared_ptr< NodeDelegatenode_delegate () const
 Return a node delegate for this node. More...
 
Node node () const
 Returns the Node interface for this object. More...
 
virtual std::string selection_path () const
 Returns the node delegate path to use to select that node. More...
 

Constructor & Destructor Documentation

◆ BaseLayer()

maquina::BaseLayer::BaseLayer ( Node node)

Member Function Documentation

◆ on_add_to_document()

void maquina::BaseLayer::on_add_to_document ( )
overridevirtual

Callback called when the node is added to the document.

Let the node perform some operations, like creating internal nodes and connections, when the node is added to the document. This callback is called at the end of a document modification on every new document nodes. This callback is called after an Undo operation which restaures deleted nodes. This callback is called after a Redo operation which create new nodes.

Reimplemented from maquina::NodePlugin.

◆ on_delete()

void maquina::BaseLayer::on_delete ( bool  )
overridevirtual

Prepare the node to be deleted.

Let the node perform some operations (like delete other nodes) before being deleted. This callback is called before the node is removed from its parent or disconnected.

Reimplemented from maquina::NodePlugin.

Reimplemented in maquina::DeformLayer.

◆ on_input_connection()

void maquina::BaseLayer::on_input_connection ( const Plug ,
const Plug ,
bool   
)
overridevirtual

Callback called when an a connection has been done between an output plug and a plug of this node as input.

Let the node perform some operations, like creating internal connections. This callback is called after every connections between two plugs

Reimplemented from maquina::NodePlugin.

◆ on_remove_from_document()

void maquina::BaseLayer::on_remove_from_document ( )
overridevirtual

Callback called when the node is removed from the document.

Let the node perform some operations, like deleting internal nodes and connections, when the node is removed from the document. This callback is called at the beginning of the Delete operation, before the node is actually deleted or disconnected. This callback is called after an Undo operation which delete created nodes. This callback is called after a Redo operation which delete nodes.

Reimplemented from maquina::NodePlugin.

◆ relationship()

void maquina::BaseLayer::relationship ( NodeSet set) const
overridevirtual

Return the node relationships.

The relationship nodes will be highlighted with a specific color when this node is selected This method must be implemented by the plug-in.

Reimplemented from maquina::NodePlugin.


The documentation for this class was generated from the following file: