Rumba C++ SDK
maquina::Workspace Class Reference

#include <Workspace.h>

Inheritance diagram for maquina::Workspace:
maquina::NodePlugin

Public Member Functions

virtual Node new_document ()
 
virtual Node load_document (const std::string_view &path, const ProgressCallback &progress={})
 
virtual void set_current_frame (float frame)
 Updates the current document frame to the specified value. 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_delete (bool)
 Prepare the node to be deleted. More...
 
virtual void on_add_to_document ()
 Callback called when the node is added to the document. More...
 
virtual void on_remove_from_document ()
 Callback called when the node is removed from the document. More...
 
virtual void on_input_connection (const Plug &, const Plug &, bool)
 Callback called when an a connection has been done between an output plug and a plug of this node as input. 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 void relationship (NodeSet &set) const
 Return the node relationships. More...
 
virtual std::shared_ptr< NodeDelegatenode_delegate () const
 Return a node delegate for this node. More...
 
virtual std::optional< Plugchannel_switch_output () const
 If that not is a channel switch node, return the output channel plug. More...
 
virtual std::vector< Plugchannel_switch_inputs () const
 Return the input channel plugs. More...
 
virtual std::optional< Plugchannel_switch_sub_channel (const std::string_view &sub_channel) const
 Return the plug for the sub channel name if available. 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...
 

Static Public Member Functions

static void set_class_name (std::string class_name)
 

Member Function Documentation

◆ load_document()

virtual Node maquina::Workspace::load_document ( const std::string_view &  path,
const ProgressCallback progress = {} 
)
virtual

◆ new_document()

virtual Node maquina::Workspace::new_document ( )
virtual

◆ set_class_name()

static void maquina::Workspace::set_class_name ( std::string  class_name)
static

◆ set_current_frame()

virtual void maquina::Workspace::set_current_frame ( float  frame)
virtual

Updates the current document frame to the specified value.

This function sets the internal states associated with the document's frame and adjusts the document time accordingly. Override this method to implement custom behavior when changing frames.

Parameters
frameThe new frame to set as the current frame.

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