Rumba C++ SDK
maquina::VirtualAttribute Struct Reference

Virtual Attributes are shown in a node's UI, but may not be backed by an actual plug. The plug is created when the value is set (plug is considered overwritten). More...

#include <NodeDelegateVirtualPlug.h>

Public Types

typedef std::function< void(const maquina::Plug &)> plug_callback
 

Public Member Functions

 VirtualAttribute (const std::string &name_, const maquina::Value &default_value_, const maquina::Value &plug_creation_value_, const std::string &description_, const plug_callback &plug_added_=plug_callback(), const plug_callback &plug_removed_=plug_callback())
 

Public Attributes

std::string name
 
std::string value_type
 
std::shared_ptr< maquina::AttributeDescriptordescription
 
maquina::Value default_value
 
maquina::Value plug_creation_value
 
std::function< void(const maquina::Plug &)> plug_added
 
std::function< void(const maquina::Plug &)> plug_removed
 

Detailed Description

Virtual Attributes are shown in a node's UI, but may not be backed by an actual plug. The plug is created when the value is set (plug is considered overwritten).

Member Typedef Documentation

◆ plug_callback

typedef std::function<void(const maquina::Plug&)> maquina::VirtualAttribute::plug_callback

Constructor & Destructor Documentation

◆ VirtualAttribute()

maquina::VirtualAttribute::VirtualAttribute ( const std::string &  name_,
const maquina::Value default_value_,
const maquina::Value plug_creation_value_,
const std::string &  description_,
const plug_callback plug_added_ = plug_callback(),
const plug_callback plug_removed_ = plug_callback() 
)
inline

Member Data Documentation

◆ default_value

maquina::Value maquina::VirtualAttribute::default_value

◆ description

std::shared_ptr<maquina::AttributeDescriptor> maquina::VirtualAttribute::description

◆ name

std::string maquina::VirtualAttribute::name

◆ plug_added

std::function<void(const maquina::Plug&)> maquina::VirtualAttribute::plug_added

◆ plug_creation_value

maquina::Value maquina::VirtualAttribute::plug_creation_value

◆ plug_removed

std::function<void(const maquina::Plug&)> maquina::VirtualAttribute::plug_removed

◆ value_type

std::string maquina::VirtualAttribute::value_type

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