Rumba C++ SDK
Channel.h File Reference
#include <optional>
#include <unordered_set>
#include "ChannelMode.h"
#include "NodeDelegate.h"
#include "Plug.h"

Go to the source code of this file.

Classes

class  maquina::Channel
 Node's plugs and node delegate's attributes may be modified by animation layers through channels. More...
 

Namespaces

 maquina
 This version of the SDK is unstable, i-e, it may change with no warning.
 

Functions

MAQUINA_EXPORT std::string maquina::channel_plug_to_channel_path (const Plug &channel_plug)
 Get the channel path on a channel plug. More...
 
MAQUINA_EXPORT std::optional< std::pair< Plug, std::string > > maquina::channel_plug_to_controller_plug (const Plug &channel_plug)
 Get the channel path on a channel plug. More...
 
MAQUINA_EXPORT Plug maquina::channel_path_to_channel_plug (const StringView &channel_path, const Node &document, Node *layer=nullptr)
 Get the channel plug using a channel path. More...
 
MAQUINA_EXPORT bool maquina::extract_channel_path (const std::string &channel_path, std::string &asset_path, std::string &ctrl_path, std::string &plug, std::string &subchannel)
 Parse the channel path and extract the asset, controller, plug and subchannel strings. More...
 
MAQUINA_EXPORT bool maquina::add_plugs_to_layer (const std::vector< Plug > &plugs, Node &layer, bool check_editable=true, bool selection_mask=true)
 Update the animation graph so that these plug channels are animated in the layer. More...
 
MAQUINA_EXPORT void maquina::layer_animated_plugs (const Node &layer, std::unordered_set< Plug > &animated_plugs, bool only_curve=true, bool recursive=true)
 Return the list of animated plugs in the layer. More...
 
MAQUINA_EXPORT std::vector< Plug > maquina::channels_in_layer (const Node &layer)
 Return the list of channels that are animated in the layer. More...
 
MAQUINA_EXPORT void maquina::remove_channels_from_layer (const std::vector< Plug > &channels, Node &layer, bool undo_stack)
 Update the animation graph so that these plug channels are not animated anymore in the layer. More...
 
MAQUINA_EXPORT bool maquina::anim_curve_keys_selected ()
 Return true if the curve editor is open and keys are selected in it. More...
 
MAQUINA_EXPORT Plug maquina::controller_plug (const Plug &channel_plug)
 Return the controller plug driven by channel_plug. More...