maquina::Workspace Class Reference
Workspace is the type of the root node of the maquina Node tree. More...
#include <Workspace.h>
Inheritance diagram for maquina::Workspace:
Additional Inherited Members | |
 Public Types inherited from maquina::Node | |
| using | Flags = Plug::Flags |
| Public Member Functions inherited from maquina::Node | |
| Node (const char *type, const char *name, Node *parent=nullptr, bool undo_stack=false) | |
| Create a node. More... | |
| Node | duplicate (Node *parent=nullptr, bool undo_stack=false) const |
| Duplicate this node, plugs, dynamic plugs and children. More... | |
| void | delete_node (bool undo_stack=false) |
| Delete this node from the document. More... | |
| void | rename (const char *new_name, bool undo_stack=false) |
| const char * | name () const |
| Return the node name. More... | |
| std::string | full_name () const |
| Return the node full name starting at the workspace node. More... | |
| std::string | full_document_name () const |
| Return the node full name starting at the document node. More... | |
| const char * | ui_descriptor () const |
| Return the node ui json descriptor. More... | |
| const char * | type_name () const |
| Return the node type name. More... | |
| StringView | ui_description () const |
| Return the node ui json description. More... | |
| bool | is_instance (const char *node_type_name) const |
| Check if this node derive from another node type. More... | |
| bool | is_referenced () const |
| Check if this node is referenced. More... | |
| bool | is_mutable () const |
| Check if this node can be modified. More... | |
| bool | is_reference_root () const |
| Check if this node is the root node of a reference. More... | |
| bool | is_reference_loaded () const |
| Returns true if this node is a root reference node and the reference is loaded. More... | |
| bool | is_serializable () const |
| Returns true if this node and all its children will be serialised on save. More... | |
| bool | is_document_node () const |
| Returns true if this node belong to a document. More... | |
| void | set_serializable (bool serialize) |
| std::wstring | reference_filename () const |
| Returns the reference file name for this node. More... | |
| void | unload_reference () |
| Unload this root reference node. More... | |
| void | load_reference () |
| Unload this root reference node. More... | |
| void | replace_reference (const std::wstring &new_reference) |
| Replace this root reference node with another file. More... | |
| void | write (const std::wstring &filename) const |
| Write the node into a file. More... | |
| Children | children () const |
| Get the node children accessor. More... | |
| bool | has_parent () const |
| Check if this node has a parent. More... | |
| Node | parent () const |
| Get the node parent. More... | |
| void | set_parent (Node &parent, bool undo_stack) |
| Set the node parent. More... | |
| bool | has_document () const |
| Check if this node is child of a Document node. More... | |
| Node | document () const |
| Get the Document parent node. More... | |
| bool | has_child (const char *child_name) const |
| Check if a child node exists. More... | |
| Node | child (const char *name) const |
| Get a child node by its name. More... | |
| bool | is_child_of (const Node &parent) const |
| Return true if this node is child of parent or is parent. More... | |
| Node | find_first (const char *name) const |
| Get the first node named name in the children hierarchy of this node. More... | |
| Plugs | plugs () const |
| Return the node plugs iteration. More... | |
| bool | has_plug (const char *plug_name) const |
| Check if a plug exists. More... | |
| Plug | add_plug (const char *name, const Value &default_value, int flags=Flags::serial, bool undo_stack=false, const std::string &description="") |
| void | remove_plug (const char *name, bool undo_stack=false) |
| void | remove_plug (const Plug &plug, bool undo_stack=false) |
| Plug | plug (const char *plug_name) const |
| Return a plug by its name. More... | |
| std::vector< Plug > | channels () const |
| Returns the channels of this node. More... | |
| std::vector< Node > | relationship () |
| Returns the nodes in relationship with this node. More... | |
| const std::vector< std::string > & | bases () const |
| Returns a list of all the types this class derives. More... | |
| Node | random_child () |
| Returns a Node with a random name as child of this node. More... | |
| std::shared_ptr< NodePlugin > | plugin () const |
| Returns the node plug-in, if this node has been created by a plug-in, or nullptr. More... | |
| std::vector< Node > | search (const std::string &key) const |
| Search in the node childrens all the name that satisfies the key. More... | |
| std::shared_ptr< class NodeDelegate > | node_delegate () |
| void | notify_first_init (bool undo_stack) |
| Do the one shot initialization tasks for this node. More... | |
| bool | operator== (const Node &o) const |
| bool | operator!= (const Node &o) const |
Detailed Description
The documentation for this class was generated from the following file:
- include/Maquina/Workspace.h