From c59a350a1229343afbe90de57b6de479ca3bef39 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Tue, 20 Feb 2018 16:49:12 +0100 Subject: [PATCH 01/35] Fix object's remove tasks. --- Modules/KiwiEngine/KiwiEngine_Object.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Modules/KiwiEngine/KiwiEngine_Object.cpp b/Modules/KiwiEngine/KiwiEngine_Object.cpp index b0ad9799..30bf8326 100644 --- a/Modules/KiwiEngine/KiwiEngine_Object.cpp +++ b/Modules/KiwiEngine/KiwiEngine_Object.cpp @@ -99,11 +99,11 @@ namespace kiwi void Object::removeTasks(std::set> & tasks) { - for (auto task_it = m_tasks.begin(); task_it != m_tasks.end(); ) + for (auto task_it = tasks.begin(); task_it != tasks.end(); ) { if ((*task_it)->executed() == true) { - task_it = m_tasks.erase(task_it); + task_it = tasks.erase(task_it); } else { From 359fcd8c3e62260d145eba5aa69198dbf28df502 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Fri, 2 Mar 2018 13:25:23 +0100 Subject: [PATCH 02/35] Using flip::ref instead of uint64_t for engine's objets id. --- Modules/KiwiEngine/KiwiEngine_Patcher.cpp | 24 +++++++++++------------ Modules/KiwiEngine/KiwiEngine_Patcher.h | 13 ++++++------ 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/Modules/KiwiEngine/KiwiEngine_Patcher.cpp b/Modules/KiwiEngine/KiwiEngine_Patcher.cpp index f3a6282e..deecc442 100644 --- a/Modules/KiwiEngine/KiwiEngine_Patcher.cpp +++ b/Modules/KiwiEngine/KiwiEngine_Patcher.cpp @@ -56,7 +56,7 @@ namespace kiwi return m_patcher_model; } - void Patcher::addObject(uint64_t object_id, std::shared_ptr object) + void Patcher::addObject(flip::Ref object_id, std::shared_ptr object) { m_objects[object_id] = object; @@ -68,7 +68,7 @@ namespace kiwi } } - void Patcher::removeObject(uint64_t object_id) + void Patcher::removeObject(flip::Ref object_id) { auto processor = std::dynamic_pointer_cast(m_objects[object_id]); @@ -80,7 +80,7 @@ namespace kiwi m_objects.erase(object_id); } - void Patcher::addLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal) + void Patcher::addLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal) { std::shared_ptr from = m_objects[from_id]; std::shared_ptr to = m_objects[to_id]; @@ -102,7 +102,7 @@ namespace kiwi } } - void Patcher::removeLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal) + void Patcher::removeLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal) { std::shared_ptr from = m_objects[from_id]; std::shared_ptr to = m_objects[to_id]; @@ -306,8 +306,8 @@ namespace kiwi for (std::string const& param_name : changed_params) { - m_objects.at(object.ref().obj())->modelAttributeChanged(param_name, - object.getAttribute(param_name)); + m_objects.at(object.ref())->modelAttributeChanged(param_name, + object.getAttribute(param_name)); } } } @@ -316,28 +316,28 @@ namespace kiwi void Patcher::objectAdded(model::Object const& object_m) { - addObject(object_m.ref().obj(), Factory::create(*this, object_m)); + addObject(object_m.ref(), Factory::create(*this, object_m)); } void Patcher::objectRemoved(model::Object const& object_m) { - removeObject(object_m.ref().obj()); + removeObject(object_m.ref()); } void Patcher::linkAdded(model::Link const& link_m) { - addLink(link_m.getSenderObject().ref().obj(), + addLink(link_m.getSenderObject().ref(), link_m.getSenderIndex(), - link_m.getReceiverObject().ref().obj(), + link_m.getReceiverObject().ref(), link_m.getReceiverIndex(), link_m.isSignal()); } void Patcher::linkRemoved(model::Link const& link_m) { - removeLink(link_m.getSenderObject().ref().obj(), + removeLink(link_m.getSenderObject().ref(), link_m.getSenderIndex(), - link_m.getReceiverObject().ref().obj(), + link_m.getReceiverObject().ref(), link_m.getReceiverIndex(), link_m.isSignal()); } diff --git a/Modules/KiwiEngine/KiwiEngine_Patcher.h b/Modules/KiwiEngine/KiwiEngine_Patcher.h index e485e8fb..c39d5c23 100644 --- a/Modules/KiwiEngine/KiwiEngine_Patcher.h +++ b/Modules/KiwiEngine/KiwiEngine_Patcher.h @@ -22,7 +22,8 @@ #pragma once #include -#include +#include +#include #include @@ -57,16 +58,16 @@ namespace kiwi ~Patcher(); //! @brief Adds an object to the patcher. - void addObject(uint64_t object_id, std::shared_ptr object); + void addObject(flip::Ref object_id, std::shared_ptr object); //! @brief Removes an object from the patcher. - void removeObject(uint64_t object_id); + void removeObject(flip::Ref object_id); //! @brief Adds a link between to object of the patcher. - void addLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal); + void addLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal); //! @brief Removes a link between two objects. - void removeLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal); + void removeLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal); //! @brief Updates the dsp chain held by the engine patcher void updateChain(); @@ -161,7 +162,7 @@ namespace kiwi using SoLinks = std::queue; Instance& m_instance; - std::map> m_objects; + std::map> m_objects; std::vector m_so_links; dsp::Chain m_chain; model::Patcher & m_patcher_model; From 43ea9d39916dc7e880eca267bb7cea7adba891a4 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Tue, 13 Mar 2018 16:49:42 +0100 Subject: [PATCH 03/35] Fix low level network implementation. --- Client/Source/KiwiApp_Network/KiwiApp_Api.cpp | 2 +- Modules/KiwiNetwork/KiwiHttp/KiwiHttp.h | 56 +++---- Modules/KiwiNetwork/KiwiHttp/KiwiHttp.hpp | 147 +++++++++++------- .../KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp | 96 ++++++------ .../KiwiNetwork/KiwiHttp/KiwiHttp_Session.h | 30 ++-- Test/Network/test_Http.cpp | 146 +++++++++++++++-- 6 files changed, 311 insertions(+), 166 deletions(-) diff --git a/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp b/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp index d03f2518..84178c57 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp +++ b/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp @@ -517,7 +517,7 @@ namespace kiwi { for(auto it = m_pending_requests.begin(); it != m_pending_requests.end();) { - if (!(*it)->isPending()) + if ((*it)->executed()) { it = m_pending_requests.erase(it); } diff --git a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp.h b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp.h index 41f80b70..e93b8172 100644 --- a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp.h +++ b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp.h @@ -24,7 +24,8 @@ #include #include #include -#include +#include +#include #include #include @@ -54,25 +55,6 @@ namespace kiwi { namespace network { namespace http { template using Request = beast::http::request; - //! @brief Sends an http request. - //! @details Returns the response generated by the server. The function blocks until response - //! is received or error occurs. - template - static Response - write(std::unique_ptr> request, - std::string port, - Timeout timeout = Timeout(0)); - - //! @brief Sends an http request asynchronously. - //! @details Returns the response generated by the server. The function is non blocking. callback - //! is called on another thread once response is received or error occurs. - template - static std::future - writeAsync(std::unique_ptr> request, - std::string port, - std::function)> callback, - Timeout timeout = Timeout(0)); - // ================================================================================ // // QUERY // // ================================================================================ // @@ -80,27 +62,44 @@ namespace kiwi { namespace network { namespace http { template class Query { + private: // classes + + using Callback = std::function const&)>; + public: // methods //! @brief Constructor. Query(std::unique_ptr> request, - std::string port, - Timeout timeout = Timeout(0)); + std::string port); //! @brief Destructor. + //! @details Wait for asynchronous operation to terminate. ~Query(); - //! @brief Process the underlying service. - //! @details Returns if the request terminated and response can be returned. - bool process(); + //! @brief Call request on the network. + //! @details If query is already executed query will not be sent again. + //! Previous reponse will be returned. + Response writeQuery(Timeout timeout = Timeout(0)); - //! @brief Returns the reponse of the query. - Response const& getResponse() const; + //! @brief Calls the request on a specific thread. + //! @details If an asnchronous read is currently running, it will not be updated or relaunched. + void writeQueryAsync(std::function const& res)> && callback, Timeout timeout = Timeout(0)); + + //! @brief Cancels the request. + //! @details Once cancel is called query is executed and cannot be invoked again. + //! If query was launched asynchronously callback will be called with a timeout error. + void cancel(); + + //! @brief Returns true if the query was executed or cancelled. + bool executed(); private: // methods using tcp = boost::asio::ip::tcp; + //! @internal + void init(Timeout timeout); + //! @internal void handleTimeout(beast::error_code const& error); @@ -127,6 +126,9 @@ namespace kiwi { namespace network { namespace http { boost::asio::steady_timer m_timer; tcp::resolver m_resolver; beast::flat_buffer m_buffer; + std::thread m_thread; + std::atomic m_executed; + Callback m_callback; private: // deleted methods diff --git a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp.hpp b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp.hpp index b76712ed..3df9b2f1 100644 --- a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp.hpp +++ b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp.hpp @@ -24,55 +24,100 @@ namespace kiwi { namespace network { namespace http { // ================================================================================ // - // HTTP // + // HTTP QUERY // // ================================================================================ // template - Response - write(std::unique_ptr> request, - std::string port, - Timeout timeout) + Query::Query(std::unique_ptr> request, + std::string port) + : m_request(std::move(request)) + , m_response() + , m_port(port) + , m_io_service() + , m_socket(m_io_service) + , m_timer(m_socket.get_io_service()) + , m_resolver(m_socket.get_io_service()) + , m_buffer() + , m_thread() + , m_executed(false) + , m_callback() + { + } + + template + Query::~Query() + { + if (m_thread.joinable()) + { + m_thread.join(); + } + } + + template + Response Query::writeQuery(Timeout timeout) { - Query query(std::move(request), port, timeout); + if (m_thread.joinable()) + { + m_thread.join(); + } - while(!query.process()){} + if (!executed()) + { + init(timeout); + + while(!executed()) + { + m_socket.get_io_service().poll_one(); + } + } - return query.getResponse(); + return m_response; } - template - std::future - writeAsync(std::unique_ptr> request, - std::string port, - std::function)> callback, - Timeout timeout) + template + void Query::writeQueryAsync(std::function const& res)> && callback, Timeout timeout) { - auto query = std::make_unique>(std::move(request), port, timeout); - - return std::async(std::launch::async, [query = std::move(query), cb = std::move(callback)]() + if (!executed() && !m_thread.joinable()) { - while(!query->process()){} + init(timeout); - return cb(query->getResponse()); - }); + m_callback = std::move(callback); + + m_thread = std::thread([this]() + { + while(!executed()) + { + m_socket.get_io_service().poll_one(); + } + }); + } } - // ================================================================================ // - // HTTP QUERY // - // ================================================================================ // + template + void Query::cancel() + { + if (m_timer.cancel() != 0) + { + if (m_thread.joinable()) + { + m_thread.join(); + } + } + + if (!m_executed) + { + shutdown(boost::asio::error::basic_errors::timed_out); + } + } template - Query::Query(std::unique_ptr> request, - std::string port, - Timeout timeout) - : m_request(std::move(request)) - , m_response() - , m_port(port) - , m_io_service() - , m_socket(m_io_service) - , m_timer(m_io_service) - , m_resolver(m_io_service) - , m_buffer() + bool Query::executed() + { + return m_executed.load(); + } + + template + void Query::init(Timeout timeout) { if (timeout > Timeout(0)) { @@ -81,10 +126,11 @@ namespace kiwi { namespace network { namespace http { m_timer.async_wait([this](Error const& error) { handleTimeout(error); - }); } + m_request->prepare_payload(); + const std::string host = m_request->at(beast::http::field::host).to_string(); m_resolver.async_resolve({host, m_port}, [this](Error const& error, @@ -99,26 +145,6 @@ namespace kiwi { namespace network { namespace http { connect(iterator); } }); - - m_io_service.reset(); - } - - template - Query::~Query() - { - ; - } - - template - bool Query::process() - { - return !m_io_service.run_one() || m_response.error; - } - - template - Response const& Query::getResponse() const - { - return m_response; } template @@ -131,7 +157,7 @@ namespace kiwi { namespace network { namespace http { void Query::connect(tcp::resolver::iterator iterator) { boost::asio::async_connect(m_socket, iterator, [this](Error const& error, - tcp::resolver::iterator i) { + tcp::resolver::iterator i){ if (error) { shutdown(error); @@ -171,8 +197,6 @@ namespace kiwi { namespace network { namespace http { template void Query::shutdown(Error const& error) { - m_io_service.stop(); - if (error) { m_response.error = error; @@ -180,6 +204,13 @@ namespace kiwi { namespace network { namespace http { boost::system::error_code ec; m_socket.shutdown(tcp::socket::shutdown_both, ec); + + if (m_callback) + { + m_callback(m_response); + } + + m_executed.store(true); } }}} // namespace kiwi::network::http diff --git a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp index 14c5dc3d..6f25f1de 100644 --- a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp +++ b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp @@ -96,8 +96,7 @@ namespace kiwi { namespace network { namespace http { , m_payload() , m_body() , m_timeout(0) - , m_future() - , m_keep_processing(true) + , m_query() , m_req_header() { ; @@ -143,14 +142,17 @@ namespace kiwi { namespace network { namespace http { m_body.content = content; } - bool Session::isPending() + bool Session::executed() { - return m_future.valid() && m_future.wait_for(std::chrono::seconds(0)) != std::future_status::ready; + return m_query && m_query->executed(); } void Session::cancel() { - m_keep_processing = false; + if (m_query) + { + m_query->cancel(); + } } Session::Response Session::Get() @@ -193,73 +195,65 @@ namespace kiwi { namespace network { namespace http { makeResponse(beast::http::verb::delete_, std::move(callback)); } - std::unique_ptr> Session::makeQuery() + void Session::initQuery() { - const auto makeTarget = [this]() { + if (!m_query) + { + const auto makeTarget = [this]() { + + if(!m_parameters.content.empty()) + { + return m_target + "?" + m_parameters.content; + } + + return m_target; + }; - if(!m_parameters.content.empty()) - { - return m_target + "?" + m_parameters.content; - } + auto request = std::make_unique>(std::move(m_req_header)); + request->target(makeTarget()); - return m_target; - }; - - auto request = std::make_unique>(std::move(m_req_header)); - request->target(makeTarget()); - - if(!(m_req_header.method() == beast::http::verb::get) && - (!m_payload.content.empty() - || !m_body.content.empty())) - { - if(!m_payload.content.empty()) - { - request->set(beast::http::field::content_type, "application/x-www-form-urlencoded"); - request->body = std::move(m_payload.content); - } - else if(!m_body.content.empty()) + if(!(m_req_header.method() == beast::http::verb::get) && + (!m_payload.content.empty() + || !m_body.content.empty())) { - auto& req = *request; - const auto content_type = req[beast::http::field::content_type]; - if(content_type.empty()) + if(!m_payload.content.empty()) { - request->set(beast::http::field::content_type, "application/octet-stream"); + request->set(beast::http::field::content_type, "application/x-www-form-urlencoded"); + request->body = std::move(m_payload.content); + } + else if(!m_body.content.empty()) + { + auto& req = *request; + const auto content_type = req[beast::http::field::content_type]; + if(content_type.empty()) + { + request->set(beast::http::field::content_type, "application/octet-stream"); + } + + request->body = std::move(m_body.content); } - - request->body = std::move(m_body.content); } + + m_query = std::make_unique(std::move(request), m_port); } - - request->prepare_payload(); - return std::make_unique>(std::move(request), m_port, m_timeout); } Session::Response Session::makeResponse(beast::http::verb verb) { m_req_header.method(verb); - auto query = makeQuery(); - - while(!query->process()){} + initQuery(); - return query->getResponse(); + return m_query->writeQuery(m_timeout); } void Session::makeResponse(beast::http::verb verb, Session::Callback && callback) { m_req_header.method(verb); - m_future = std::async(std::launch::async, [this, query = makeQuery(), cb = std::move(callback)]() - { - while(m_keep_processing) - { - if (query->process()) - { - cb(query->getResponse()); - m_keep_processing = false; - } - } - }); + initQuery(); + + m_query->writeQueryAsync(callback, m_timeout); } }}} // namespace kiwi::network::http diff --git a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h index 4a8922f2..bf091fd0 100644 --- a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h +++ b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h @@ -94,10 +94,13 @@ namespace kiwi { namespace network { namespace http { class Session { + private: // classes + + using HttpQuery = Query; + public: // methods using Response = http::Response; - using AsyncResponse = std::future; using Callback = std::function; Session(); @@ -113,7 +116,7 @@ namespace kiwi { namespace network { namespace http { void setPayload(Payload && payload); void setBody(std::string const& content); - bool isPending(); + bool executed(); void cancel(); Response Get(); @@ -128,23 +131,24 @@ namespace kiwi { namespace network { namespace http { Response Delete(); void DeleteAsync(Callback callback); - private: // variables + private: // methods - std::unique_ptr> makeQuery(); + void initQuery(); Response makeResponse(beast::http::verb verb); void makeResponse(beast::http::verb verb, Callback && callback); - std::string m_port; - std::string m_target; - Parameters m_parameters; - Payload m_payload; - Body m_body; - Timeout m_timeout; - std::future m_future; - std::atomic m_keep_processing; + private: // members + + std::string m_port; + std::string m_target; + Parameters m_parameters; + Payload m_payload; + Body m_body; + Timeout m_timeout; - beast::http::request_header<> m_req_header; + std::unique_ptr m_query; + beast::http::request_header<> m_req_header; }; }}} // namespace kiwi::network::http diff --git a/Test/Network/test_Http.cpp b/Test/Network/test_Http.cpp index 3e70f842..ae79e07f 100755 --- a/Test/Network/test_Http.cpp +++ b/Test/Network/test_Http.cpp @@ -33,13 +33,12 @@ namespace beast = boost::beast; #include -TEST_CASE("Network - Http", "[Network, Http]") +TEST_CASE("Network - Http Query", "[Network, Http]") { using namespace kiwi::network; - SECTION("Client get request to echo server") + SECTION("Query - Client get request to echo server") { - // Construct request and response. auto request = std::make_unique>(); request->method(beast::http::verb::get); request->target("/get"); @@ -47,21 +46,17 @@ TEST_CASE("Network - Http", "[Network, Http]") request->set(beast::http::field::host, "httpbin.org"); request->set(beast::http::field::user_agent, "test"); - request->prepare_payload(); + http::Query query(std::move(request), "80"); - beast::error_code error; - - // Send request and waits for response. - http::Response response = - http::write(std::move(request), "80"); + http::Response response = query.writeQuery(); REQUIRE(!response.error); CHECK(response.result() == beast::http::status::ok); + CHECK(query.executed()); } - SECTION("Client asynchronous get request to echo server") + SECTION("Query - Client asynchronous get request to echo server") { - // Construct request and response. auto request = std::make_unique>(); request->method(beast::http::verb::get); request->target("/get"); @@ -69,17 +64,108 @@ TEST_CASE("Network - Http", "[Network, Http]") request->set(beast::http::field::host, "httpbin.org"); request->set(beast::http::field::user_agent, "test"); - request->prepare_payload(); + http::Query query(std::move(request), "80"); + + int callback_called = 0; - std::function)> - callback = [](http::Response response) + std::function const&)> + callback_1 = [&query, &callback_called](http::Response const & response) { + CHECK(!query.executed()); REQUIRE(!response.error); CHECK(response.result() == beast::http::status::ok); + callback_called = 1; + }; + + std::function const&)> + callback_2 = [&callback_called](http::Response const & response) + { + callback_called = 2; + }; + + query.writeQueryAsync(std::move(callback_1)); + query.writeQueryAsync(std::move(callback_2)); + + while(!query.executed()){}; + + CHECK(callback_called == 1); + } + + SECTION("Query - Reaching timeout sync query") + { + auto request = std::make_unique>(); + request->method(beast::http::verb::get);; + request->version = 11; + request->set(beast::http::field::host, "example.com"); + + http::Query query(std::move(request), "81"); + + http::Response response = query.writeQuery(http::Timeout(100)); + + CHECK(response.error); + CHECK(response.error == boost::asio::error::basic_errors::timed_out); + } + + SECTION("Query - Reaching timeout async query") + { + auto request = std::make_unique>(); + request->method(beast::http::verb::get); + request->version = 11; + request->set(beast::http::field::host, "example.com"); + + std::function const&)> + callback = [](http::Response const & response) + { + CHECK(response.error); + CHECK(response.error == boost::asio::error::basic_errors::timed_out); + }; + + http::Query query(std::move(request), "81"); + + query.writeQueryAsync(std::move(callback), http::Timeout(100)); + } + + SECTION("Query - Cancelling query sync request") + { + auto request = std::make_unique>(); + request->method(beast::http::verb::get); + request->target("/get"); + request->version = 11; + request->set(beast::http::field::host, "httpbin.org"); + request->set(beast::http::field::user_agent, "test"); + + http::Query query(std::move(request), "80"); + + query.cancel(); + + CHECK(query.executed()); + + http::Response response = query.writeQuery(); + + CHECK(response.error == boost::asio::error::basic_errors::timed_out); + } + + SECTION("Query - Cancelling query async request") + { + auto request = std::make_unique>(); + request->method(beast::http::verb::get); + request->version = 11; + request->set(beast::http::field::host, "example.com"); + + std::function const&)> + callback = [](http::Response const & response) + { + CHECK(response.error); + CHECK(response.error == boost::asio::error::basic_errors::timed_out); }; - auto future = http::writeAsync(std::move(request), "80", callback); - future.get(); + http::Query query(std::move(request), "81"); + + query.writeQueryAsync(std::move(callback)); + + query.cancel(); + + CHECK(query.executed()); } } @@ -114,4 +200,32 @@ TEST_CASE("Network - Http Session", "[Network, Http]") CHECK(response.result() == beast::http::status::ok); }); } + + SECTION("Session Get request with timeout") + { + http::Session session; + session.setHost("example.com"); + session.setTarget("/get"); + session.setPort("81"); + session.setTimeout(http::Timeout(100)); + + http::Session::Response response = session.Get(); + + CHECK(response.error); + CHECK(response.error == boost::asio::error::basic_errors::timed_out); + } + + SECTION("Session GetAsync with timeout") + { + http::Session session; + session.setHost("example.com"); + session.setTarget("/get"); + session.setPort("81"); + session.setTimeout(http::Timeout(100)); + + session.GetAsync([](http::Session::Response response) { + CHECK(response.error); + CHECK(response.error == boost::asio::error::basic_errors::timed_out); + }); + } } From cc2dd1416ddc05268e116e4a780236300e23dae6 Mon Sep 17 00:00:00 2001 From: jmillot Date: Thu, 8 Mar 2018 00:07:41 +0100 Subject: [PATCH 04/35] Fix network callback crash. --- Client/Source/KiwiApp.cpp | 59 ++- Client/Source/KiwiApp.h | 38 +- .../KiwiApp_Application/KiwiApp_Console.cpp | 2 +- .../KiwiApp_Application/KiwiApp_Instance.cpp | 10 +- .../KiwiApp_Application/KiwiApp_Instance.h | 13 +- .../Source/KiwiApp_Auth/KiwiApp_AuthPanel.cpp | 152 ++++--- .../Source/KiwiApp_Auth/KiwiApp_AuthPanel.h | 6 +- Client/Source/KiwiApp_Network/KiwiApp_Api.cpp | 165 +++++--- Client/Source/KiwiApp_Network/KiwiApp_Api.h | 84 ++-- .../KiwiApp_Network/KiwiApp_ApiController.cpp | 36 +- .../KiwiApp_Network/KiwiApp_ApiController.h | 22 +- .../KiwiApp_DocumentBrowser.cpp | 389 ++++++++++-------- .../KiwiApp_Network/KiwiApp_DocumentBrowser.h | 2 + .../KiwiApp_Objects/KiwiApp_BangView.cpp | 37 +- .../KiwiApp_Objects/KiwiApp_BangView.h | 3 - .../KiwiApp_Objects/KiwiApp_ObjectView.cpp | 2 +- .../KiwiApp_PatcherComponent.cpp | 27 +- .../KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp | 17 + .../KiwiNetwork/KiwiHttp/KiwiHttp_Session.h | 5 +- 19 files changed, 594 insertions(+), 475 deletions(-) diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index bc72ebbf..ddcb1bee 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -112,7 +112,9 @@ namespace kiwi m_settings->network().addListener(*this); - m_menu_model.reset(new MainMenuModel()); + m_menu_model.reset(new MainMenuModel()); + + m_scheduler.reset(new tool::Scheduler<>()); m_api_controller.reset(new ApiController()); m_api.reset(new Api(*m_api_controller)); @@ -120,7 +122,9 @@ namespace kiwi m_instance = std::make_unique(); m_command_manager->registerAllCommandsForTarget(this); - checkLatestRelease(); + checkLatestRelease(); + + startTimer(10); #if JUCE_WINDOWS m_instance->openFile(juce::File(commandLine.unquoted())); @@ -220,11 +224,15 @@ namespace kiwi { #if JUCE_MAC juce::MenuBarModel::setMacMainMenu(nullptr); - #endif + #endif - m_api->cancelPendingRequest(); + stopTimer(); + + m_instance.reset(); + m_api->cancelAll(); m_api.reset(); - m_api_controller.reset(); + m_api_controller.reset(); + m_scheduler.reset(); m_settings.reset(); } @@ -238,8 +246,6 @@ namespace kiwi { if(m_instance->closeAllPatcherWindows()) { - m_instance.reset(); - quit(); } } @@ -258,6 +264,11 @@ namespace kiwi bool KiwiApp::moreThanOneInstanceAllowed() { return true; + } + + void KiwiApp::timerCallback() + { + m_scheduler->process(); } bool KiwiApp::isMacOSX() @@ -306,32 +317,18 @@ namespace kiwi Api& KiwiApp::useApi() { return *KiwiApp::use().m_api; + } + + tool::Scheduler<>& KiwiApp::useScheduler() + { + return *KiwiApp::use().m_scheduler; } - void KiwiApp::login(std::string const& name_or_email, - std::string const& password, - std::function success_callback, - Api::ErrorCallback error_callback) - { - auto& api_controller = *KiwiApp::use().m_api_controller; + void KiwiApp::setAuthUser(Api::AuthUser const& auth_user) + { + (*KiwiApp::use().m_api_controller).setAuthUser(auth_user); - auto success = [cb = std::move(success_callback)]() - { - KiwiApp::useInstance().login(); - cb(); - }; - - api_controller.login(name_or_email, password, std::move(success), std::move(error_callback)); - } - - void KiwiApp::signup(std::string const& username, - std::string const& email, - std::string const& password, - std::function success_callback, - Api::ErrorCallback error_callback) - { - auto& api_controller = *KiwiApp::use().m_api_controller; - api_controller.signup(username, email, password, std::move(success_callback), std::move(error_callback)); + KiwiApp::useInstance().login(); } Api::AuthUser const& KiwiApp::getCurrentUser() @@ -352,7 +349,7 @@ namespace kiwi Api::CallbackFn on_success = [current_version](std::string const& latest_version) { - KiwiApp::useInstance().useScheduler().schedule([current_version, latest_version]() + KiwiApp::useScheduler().schedule([current_version, latest_version]() { if (current_version.compare(latest_version) != 0) { diff --git a/Client/Source/KiwiApp.h b/Client/Source/KiwiApp.h index f8a4c621..d0ec2cff 100644 --- a/Client/Source/KiwiApp.h +++ b/Client/Source/KiwiApp.h @@ -45,7 +45,8 @@ namespace kiwi // ================================================================================ // class KiwiApp : public juce::JUCEApplication, - public NetworkSettings::Listener + public NetworkSettings::Listener, + public juce::Timer { public: // methods @@ -72,7 +73,10 @@ namespace kiwi const juce::String getApplicationVersion() override; //! @brief Checks whether multiple instances of the app are allowed. - bool moreThanOneInstanceAllowed() override; + bool moreThanOneInstanceAllowed() override; + + //! @brief Timer call back, processes the scheduler events list. + void timerCallback() override final; //! @brief Returns true if the app is running in a Mac OSX operating system. static bool isMacOSX(); @@ -95,26 +99,13 @@ namespace kiwi static Instance& useInstance(); //! @brief Get the Api object. - static Api& useApi(); - - //! @brief Attempt to log-in the user (Async). - //! @param name_or_email The name or email of the user. - //! @param password The user password. - //! @see logout, getCurrentUser - static void login(std::string const& name_or_email, - std::string const& password, - std::function success_callback, - Api::ErrorCallback error_callback); - - //! @brief Attempt to register/signup the user. - //! @param username user name - //! @param email email address - //! @param password password - static void signup(std::string const& username, - std::string const& email, - std::string const& password, - std::function success_callback, - Api::ErrorCallback error_callback); + static Api& useApi(); + + //! @brief Gets the application scheduler. + static tool::Scheduler<>& useScheduler(); + + //! @brief Sets the auth user. + static void setAuthUser(Api::AuthUser const& auth_user); //! @brief Returns the current user static Api::AuthUser const& getCurrentUser(); @@ -257,6 +248,7 @@ namespace kiwi LookAndFeel m_looknfeel; TooltipWindow m_tooltip_window; - std::unique_ptr m_settings; + std::unique_ptr m_settings; + std::unique_ptr> m_scheduler; }; } diff --git a/Client/Source/KiwiApp_Application/KiwiApp_Console.cpp b/Client/Source/KiwiApp_Application/KiwiApp_Console.cpp index 337c734d..5cae1fe5 100644 --- a/Client/Source/KiwiApp_Application/KiwiApp_Console.cpp +++ b/Client/Source/KiwiApp_Application/KiwiApp_Console.cpp @@ -127,7 +127,7 @@ namespace kiwi void ConsoleContent::consoleHistoryChanged(ConsoleHistory const&) { - tool::Scheduler<> &scheduler = KiwiApp::useInstance().useScheduler(); + tool::Scheduler<> &scheduler = KiwiApp::useScheduler(); scheduler.defer([this]() { diff --git a/Client/Source/KiwiApp_Application/KiwiApp_Instance.cpp b/Client/Source/KiwiApp_Application/KiwiApp_Instance.cpp index 9eb4cb9a..33e04117 100644 --- a/Client/Source/KiwiApp_Application/KiwiApp_Instance.cpp +++ b/Client/Source/KiwiApp_Application/KiwiApp_Instance.cpp @@ -42,8 +42,7 @@ namespace kiwi size_t Instance::m_untitled_patcher_index(1); Instance::Instance() : - m_scheduler(), - m_instance(std::make_unique(), m_scheduler), + m_instance(std::make_unique(), KiwiApp::useScheduler()), m_browser(KiwiApp::getCurrentUser().isLoggedIn() ? KiwiApp::getCurrentUser().getName(): "logged out", 1000), m_console_history(std::make_shared(m_instance)), @@ -68,8 +67,6 @@ namespace kiwi void Instance::timerCallback() { - m_scheduler.process(); - for(auto manager = m_patcher_managers.begin(); manager != m_patcher_managers.end();) { bool keep_patcher = true; @@ -155,11 +152,6 @@ namespace kiwi return m_instance; } - tool::Scheduler<> & Instance::useScheduler() - { - return m_scheduler; - } - void Instance::newPatcher() { std::string patcher_name = "Untitled " diff --git a/Client/Source/KiwiApp_Application/KiwiApp_Instance.h b/Client/Source/KiwiApp_Application/KiwiApp_Instance.h index f2588328..3ca2fe70 100644 --- a/Client/Source/KiwiApp_Application/KiwiApp_Instance.h +++ b/Client/Source/KiwiApp_Application/KiwiApp_Instance.h @@ -55,9 +55,9 @@ namespace kiwi Instance(); //! @brief Destructor - ~Instance(); - - //! @brief Timer call back, processes the scheduler events list. + ~Instance(); + + //! @brief Timer call back, processes the scheduler events list. void timerCallback() override final; //! @brief Get the user ID of the Instance. @@ -78,9 +78,6 @@ namespace kiwi //! @brief Returns the engine::Instance engine::Instance const& useEngineInstance() const; - //! @brief Returns the instance's scheduler - tool::Scheduler<> & useScheduler(); - //! @brief Open a File. bool openFile(juce::File const& file); @@ -150,9 +147,7 @@ namespace kiwi //! @param create_fn The window factory function. void showWindowWithId(WindowId id, std::function()> create_fn); - private: // variables - - tool::Scheduler<> m_scheduler; + private: // variables engine::Instance m_instance; diff --git a/Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.cpp b/Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.cpp index 91d6b640..c1886b7a 100644 --- a/Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.cpp +++ b/Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.cpp @@ -19,10 +19,10 @@ ============================================================================== */ -#include "KiwiApp_AuthPanel.h" +#include -#include "../KiwiApp.h" -#include "../KiwiApp_General/KiwiApp_CommandIDs.h" +#include +#include namespace kiwi { @@ -105,20 +105,30 @@ namespace kiwi void LoginForm::performPassReset() { - auto success_callback = [this](std::string const& message) + Component::SafePointer form(this); + + auto success_callback = [form](std::string const& message) { - KiwiApp::useInstance().useScheduler().schedule([this]() { - setState(State::Login); - showAlert("Password reset. Try login again.", AlertBox::Type::Info); + KiwiApp::useScheduler().schedule([form]() + { + if (form) + { + form.getComponent()->setState(State::Login); + form.getComponent()->showAlert("Password reset. Try login again.", AlertBox::Type::Info); + } }); }; - auto error_callback = [this](Api::Error error) + auto error_callback = [form](Api::Error error) { std::string error_message = error.getMessage(); - KiwiApp::useInstance().useScheduler().schedule([this, error_message]() { - showAlert(error_message, AlertBox::Type::Error); + KiwiApp::useScheduler().schedule([form, error_message]() + { + if (form) + { + form.getComponent()->showAlert(error_message, AlertBox::Type::Error); + } }); }; @@ -130,20 +140,24 @@ namespace kiwi void LoginForm::performPassRequest() { - auto success_callback = [this](std::string const& message) + Component::SafePointer form(this); + + auto success_callback = [form](std::string const& message) { - KiwiApp::useInstance().useScheduler().schedule([this]() { - setState(State::Reset); - showAlert("Reset token sent. Check your email.", AlertBox::Type::Info); + KiwiApp::useScheduler().schedule([form]() + { + form.getComponent()->setState(State::Reset); + form.getComponent()->showAlert("Reset token sent. Check your email.", AlertBox::Type::Info); }); }; - auto error_callback = [this](Api::Error error) + auto error_callback = [form](Api::Error error) { std::string error_message = error.getMessage(); - KiwiApp::useInstance().useScheduler().schedule([this, error_message]() { - showAlert(error_message, AlertBox::Type::Error); + KiwiApp::useScheduler().schedule([form, error_message]() + { + form.getComponent()->showAlert(error_message, AlertBox::Type::Error); }); }; @@ -172,36 +186,50 @@ namespace kiwi showOverlay(); - auto success_callback = [this, remember_me]() + Component::SafePointer form(this); + + auto success_callback = [form, remember_me](Api::AuthUser auth_user) { - KiwiApp::useInstance().useScheduler().schedule([this, remember_me]() { + KiwiApp::useScheduler().schedule([form, remember_me, auth_user]() { - showSuccessOverlay("Login success !"); + getAppSettings().network().setRememberUserFlag(remember_me); - KiwiApp::useInstance().useScheduler().schedule([this, remember_me]() { - - getAppSettings().network().setRememberUserFlag(remember_me); - dismiss(); + KiwiApp::use().setAuthUser(auth_user); + + if (form) + { + form.getComponent()->showSuccessOverlay("Login success !"); - }, std::chrono::milliseconds(1000)); + KiwiApp::useScheduler().schedule([form](){ + + if (form) + { + form.getComponent()->dismiss(); + } + + }, std::chrono::milliseconds(1000)); + } }, std::chrono::milliseconds(500)); }; - auto error_callback = [this](Api::Error error) + auto error_callback = [form](Api::Error error) { - KiwiApp::useInstance().useScheduler().schedule([this, message = error.getMessage()]() { - - hideOverlay(); - showAlert(message, AlertBox::Type::Error); + KiwiApp::useScheduler().schedule([form, message = error.getMessage()]() + { + if (form) + { + form.getComponent()->hideOverlay(); + form.getComponent()->showAlert(message, AlertBox::Type::Error); + } }, std::chrono::milliseconds(500)); }; - KiwiApp::login(username.toStdString(), - password.toStdString(), - std::move(success_callback), - std::move(error_callback)); + KiwiApp::useApi().login(username.toStdString(), + password.toStdString(), + std::move(success_callback), + std::move(error_callback)); } void LoginForm::onUserSubmit() @@ -297,40 +325,54 @@ namespace kiwi showOverlay(); - auto success_callback = [this](std::string message) + Component::SafePointer form(this); + + auto success_callback = [form](std::string message) { - KiwiApp::useInstance().useScheduler().schedule([this, message]() { - - showSuccessOverlay(message); + KiwiApp::useScheduler().schedule([form, message]() { - KiwiApp::useInstance().useScheduler().schedule([this]() { + if (form) + { + form.getComponent()->showSuccessOverlay(message); - if(AuthPanel* auth_panel = findParentComponentOfClass()) + KiwiApp::useScheduler().schedule([form]() { - hideOverlay(); - auth_panel->setCurrentTabIndex(AuthPanel::FormType::Login); - } - - }, std::chrono::milliseconds(1000)); + SignUpForm * this_form = form.getComponent(); + + if (this_form) + { + if(AuthPanel* auth_panel = this_form->findParentComponentOfClass()) + { + this_form->hideOverlay(); + auth_panel->setCurrentTabIndex(AuthPanel::FormType::Login); + } + } + + }, std::chrono::milliseconds(1000)); + } }, std::chrono::milliseconds(500)); }; - auto error_callback = [this](Api::Error error) + auto error_callback = [form](Api::Error error) { - KiwiApp::useInstance().useScheduler().schedule([this, message = error.getMessage()](){ - - hideOverlay(); - showAlert(message, AlertBox::Type::Error); + + KiwiApp::useScheduler().schedule([form, message = error.getMessage()]() + { + if (form) + { + form.getComponent()->hideOverlay(); + form.getComponent()->showAlert(message, AlertBox::Type::Error); + } }, std::chrono::milliseconds(500)); }; - KiwiApp::signup(username.toStdString(), - email.toStdString(), - password.toStdString(), - std::move(success_callback), - std::move(error_callback)); + KiwiApp::useApi().signup(username.toStdString(), + email.toStdString(), + password.toStdString(), + std::move(success_callback), + std::move(error_callback)); } // ================================================================================ // diff --git a/Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.h b/Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.h index f8152c0d..4a8b0a0a 100644 --- a/Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.h +++ b/Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.h @@ -21,7 +21,9 @@ #pragma once -#include "../KiwiApp_Components/KiwiApp_FormComponent.h" +#include + +#include namespace kiwi { @@ -71,7 +73,7 @@ namespace kiwi private: // members - State m_state; + State m_state; JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(LoginForm) }; diff --git a/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp b/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp index 84178c57..418013e8 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp +++ b/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp @@ -44,7 +44,8 @@ namespace kiwi // ================================================================================ // Api::Api(Api::Controller& controller) : - m_controller(controller) + m_controller(controller), + m_requests() { ; } @@ -54,24 +55,50 @@ namespace kiwi } - void Api::cancelPendingRequest() + // ================================================================================ // + // API REQUESTS // + // ================================================================================ // + + void Api::cancelRequest(uint64_t request_id) { - for(auto & session : m_pending_requests) + auto request = std::find_if(m_requests.begin(), + m_requests.end(), + [request_id](std::unique_ptr const& session) + { + return session->getId() == request_id; + }); + + if (request != m_requests.end()) { - session->cancel(); + (*request)->cancel(); + m_requests.erase(request); } + } + + bool Api::isPending(uint64_t request_id) + { + auto request = std::find_if(m_requests.begin(), + m_requests.end(), + [request_id](std::unique_ptr const& session) + { + return session->getId() == request_id; + }); - m_pending_requests.clear(); + return request != m_requests.end() && !(*request)->executed(); } - // ================================================================================ // - // API REQUESTS // - // ================================================================================ // + void Api::cancelAll() + { + for (auto request = m_requests.begin(); request != m_requests.end(); ++request) + { + (*request)->cancel(); + } + } - void Api::login(std::string const& username_or_email, - std::string const& password, - CallbackFn success_cb, - ErrorCallback error_cb) + uint64_t Api::login(std::string const& username_or_email, + std::string const& password, + CallbackFn success_cb, + ErrorCallback error_cb) { assert(!username_or_email.empty()); assert(!password.empty()); @@ -113,14 +140,15 @@ namespace kiwi }; session->PostAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::signup(std::string const& username, - std::string const& email, - std::string const& password, - CallbackFn success_cb, - ErrorCallback error_cb) + uint64_t Api::signup(std::string const& username, + std::string const& email, + std::string const& password, + CallbackFn success_cb, + ErrorCallback error_cb) { assert(!username.empty()); assert(!email.empty()); @@ -160,12 +188,13 @@ namespace kiwi }; session->PostAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::getUsers(std::unordered_set const& user_ids, - CallbackFn success_cb, - ErrorCallback error_cb) + uint64_t Api::getUsers(std::unordered_set const& user_ids, + CallbackFn success_cb, + ErrorCallback error_cb) { auto cb = [success = std::move(success_cb), fail = std::move(error_cb)] @@ -198,10 +227,11 @@ namespace kiwi session->setParameters({{"ids", j_users.dump()}}); session->GetAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::getDocuments(std::function callback) + uint64_t Api::getDocuments(std::function callback) { auto cb = [callback = std::move(callback)](Response res) { @@ -226,11 +256,12 @@ namespace kiwi auto session = makeSession(Endpoint::documents); session->GetAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::createDocument(std::string const& document_name, - std::function callback) + uint64_t Api::createDocument(std::string const& document_name, + std::function callback) { auto cb = [callback = std::move(callback)](Response res) { @@ -262,13 +293,14 @@ namespace kiwi } session->PostAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::uploadDocument(std::string const& name, - std::string const& data, - std::string const& kiwi_version, - std::function callback) + uint64_t Api::uploadDocument(std::string const& name, + std::string const& data, + std::string const& kiwi_version, + std::function callback) { auto cb = [callback = std::move(callback)](Response res) { @@ -295,19 +327,21 @@ namespace kiwi session->setBody(data); session->PostAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::duplicateDocument(std::string const& document_id, Callback callback) + uint64_t Api::duplicateDocument(std::string const& document_id, Callback callback) { auto session = makeSession(Endpoint::document(document_id) + "/clone"); session->PostAsync(std::move(callback)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::renameDocument(std::string document_id, std::string const& new_name, - Callback callback) + uint64_t Api::renameDocument(std::string document_id, std::string const& new_name, + Callback callback) { assert(!new_name.empty() && "name should not be empty!"); @@ -317,10 +351,11 @@ namespace kiwi }); session->PutAsync(std::move(callback)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::untrashDocument(std::string document_id, Callback callback) + uint64_t Api::untrashDocument(std::string document_id, Callback callback) { auto session = makeSession(Endpoint::document(document_id)); @@ -329,10 +364,11 @@ namespace kiwi }); session->PutAsync(std::move(callback)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::trashDocument(std::string document_id, Callback callback) + uint64_t Api::trashDocument(std::string document_id, Callback callback) { auto session = makeSession(Endpoint::document(document_id)); @@ -341,12 +377,13 @@ namespace kiwi }); session->PutAsync(std::move(callback)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::getOpenToken(std::string document_id, - CallbackFn success_cb, - ErrorCallback error_cb) + uint64_t Api::getOpenToken(std::string document_id, + CallbackFn success_cb, + ErrorCallback error_cb) { auto session = makeSession(Endpoint::document(document_id) + "/opentoken"); @@ -367,20 +404,21 @@ namespace kiwi }; session->GetAsync(std::move(callback)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::downloadDocument(std::string document_id, Callback callback) + uint64_t Api::downloadDocument(std::string document_id, Callback callback) { auto session = makeSession(Endpoint::document(document_id) + "/download"); session->setParameters({{"alt", "download"}}); - session->GetAsync(std::move(callback)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::getRelease(CallbackFn success_cb, ErrorCallback error_cb) + uint64_t Api::getRelease(CallbackFn success_cb, ErrorCallback error_cb) { auto session = makeSession(Endpoint::release); @@ -406,10 +444,13 @@ namespace kiwi }; session->GetAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::requestPasswordToken(std::string const& user_mail, CallbackFn success_cb, ErrorCallback error_cb) + uint64_t Api::requestPasswordToken(std::string const& user_mail, + CallbackFn success_cb, + ErrorCallback error_cb) { auto session = makeSession(Endpoint::users + "/passtoken"); @@ -439,10 +480,11 @@ namespace kiwi }; session->PostAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } - void Api::resetPassword(std::string const& token, + uint64_t Api::resetPassword(std::string const& token, std::string const& newpass, CallbackFn success_cb, ErrorCallback error_cb) @@ -476,7 +518,8 @@ namespace kiwi }; session->PostAsync(std::move(cb)); - storeSession(std::move(session)); + + return storeSession(std::move(session)); } std::string Api::convertDate(std::string const& date) @@ -513,13 +556,13 @@ namespace kiwi return std::move(session); } - void Api::storeSession(std::unique_ptr session) + uint64_t Api::storeSession(std::unique_ptr session) { - for(auto it = m_pending_requests.begin(); it != m_pending_requests.end();) + for(auto it = m_requests.begin(); it != m_requests.end();) { if ((*it)->executed()) { - it = m_pending_requests.erase(it); + it = m_requests.erase(it); } else { @@ -527,7 +570,11 @@ namespace kiwi } } - m_pending_requests.emplace_back(std::move(session)); + uint64_t session_id = session->getId(); + + m_requests.emplace(std::move(session)); + + return session_id; } // ================================================================================ // diff --git a/Client/Source/KiwiApp_Network/KiwiApp_Api.h b/Client/Source/KiwiApp_Network/KiwiApp_Api.h index 1a68cfcf..84b5745e 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_Api.h +++ b/Client/Source/KiwiApp_Network/KiwiApp_Api.h @@ -22,6 +22,7 @@ #pragma once #include +#include #include @@ -71,77 +72,83 @@ namespace kiwi //! @brief Destructor ~Api(); - //! @brief Cancel pending execution. - void cancelPendingRequest(); + //! @brief Cancels a request. + void cancelRequest(uint64_t request_id); + + //! @brief Returns true if the request is currently pending. + bool isPending(uint64_t request_id); + + //! @brief Cancel all pending requests. + void cancelAll(); public: // requests //! @brief Attempt to log-in the user. //! @param username_or_email user name or email address //! @param password password - void login(std::string const& username_or_email, - std::string const& password, - CallbackFn success_cb, - ErrorCallback error_cb); + uint64_t login(std::string const& username_or_email, + std::string const& password, + CallbackFn success_cb, + ErrorCallback error_cb); //! @brief Attempt to register/signup the user. //! @param username user name //! @param email email address //! @param password password - void signup(std::string const& username, - std::string const& email, - std::string const& password, - CallbackFn success_cb, - ErrorCallback error_cb); + uint64_t signup(std::string const& username, + std::string const& email, + std::string const& password, + CallbackFn success_cb, + ErrorCallback error_cb); //! @brief Returns a list of users, retrieved with user ids. - void getUsers(std::unordered_set const& user_ids, CallbackFn sucess_cb, ErrorCallback error_cb); + uint64_t getUsers(std::unordered_set const& user_ids, CallbackFn sucess_cb, ErrorCallback error_cb); //! @brief Make an async API request to get a list of documents - void getDocuments(std::function callback); + uint64_t getDocuments(std::function callback); //! @brief Make an async API request to create a new document //! @param callback - void createDocument(std::string const& document_name, - std::function callback); + uint64_t createDocument(std::string const& document_name, + std::function callback); //! @brief Uploads a document to the server. - void uploadDocument(std::string const& name, - std::string const& data, - std::string const& kiwi_version, - std::function callback); + uint64_t uploadDocument(std::string const& name, + std::string const& data, + std::string const& kiwi_version, + std::function callback); //! @brief Duplicates a document on server side. - void duplicateDocument(std::string const& document_id, Callback callback); + uint64_t duplicateDocument(std::string const& document_id, Callback callback); //! @brief Rename a document asynchronously. //! @param callback The callback method that will be called when the request is completed. - void renameDocument(std::string document_id, - std::string const& new_name, - Callback callback); + uint64_t renameDocument(std::string document_id, + std::string const& new_name, + Callback callback); //! @brief Moves a document to trash. - void trashDocument(std::string document_id, Callback callback); + uint64_t trashDocument(std::string document_id, Callback callback); //! @brief Moves document out of the trash. - void untrashDocument(std::string document_id, Callback callback); + uint64_t untrashDocument(std::string document_id, Callback callback); //! @brief Returns the open token used to open document. - void getOpenToken(std::string document_id, + uint64_t getOpenToken(std::string document_id, CallbackFn success_cb, ErrorCallback error_cb); //! @brief Make an async API request to download a document. - void downloadDocument(std::string document_id, Callback success_cb); + uint64_t downloadDocument(std::string document_id, Callback success_cb); //! @brief Retrieve version of kiwi compatible with the api server. - void getRelease(CallbackFn success_cb, ErrorCallback error_cb); + uint64_t getRelease(CallbackFn success_cb, ErrorCallback error_cb); //! @brief Requests a reset token to the server. - void requestPasswordToken(std::string const& user_mail, CallbackFn success_cb, ErrorCallback error_cb); + uint64_t requestPasswordToken(std::string const& user_mail, CallbackFn success_cb, ErrorCallback error_cb); //! @brief Sends reset request token to the server. - void resetPassword(std::string const& token, + uint64_t resetPassword(std::string const& token, std::string const& newpass, CallbackFn success_cb, ErrorCallback error_cb); @@ -177,15 +184,26 @@ namespace kiwi std::unique_ptr makeSession(std::string const& endpoint, bool add_auth = true); //! @internal Store the async future response in a vector - void storeSession(std::unique_ptr session); + uint64_t storeSession(std::unique_ptr session); //! @internal Check if the response header has a JSON content-type static bool hasJsonHeader(Response const& res); + private: // helper functions + + struct comp_session + { + bool operator() (std::unique_ptr const& lhs, + std::unique_ptr const& rhs) + { + return lhs->getId() < rhs->getId(); + } + }; + private: // variables - Api::Controller& m_controller; - std::vector> m_pending_requests; + Api::Controller& m_controller; + std::set, comp_session> m_requests; private: // deleted methods diff --git a/Client/Source/KiwiApp_Network/KiwiApp_ApiController.cpp b/Client/Source/KiwiApp_Network/KiwiApp_ApiController.cpp index ba3820e9..8868f49f 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_ApiController.cpp +++ b/Client/Source/KiwiApp_Network/KiwiApp_ApiController.cpp @@ -66,41 +66,9 @@ namespace kiwi return false; } - void ApiController::login(std::string const& name_or_email, - std::string const& password, - std::function success_callback, - Api::ErrorCallback error_callback) + void ApiController::setAuthUser(Api::AuthUser const& auth_user) { - auto success_cb = [this, success_callback = std::move(success_callback)](Api::AuthUser user){ - - auto& scheduler = KiwiApp::useInstance().useScheduler(); - scheduler.schedule([this, success_callback, user](){ - - m_auth_user.resetWith(user); - - success_callback(); - }); - }; - - KiwiApp::useApi().login(name_or_email, password, std::move(success_cb), std::move(error_callback)); - } - - void ApiController::signup(std::string const& username, - std::string const& email, - std::string const& password, - std::function success_callback, - Api::ErrorCallback error_callback) - { - auto success_cb = [this, success_callback = std::move(success_callback)](std::string message){ - - auto& scheduler = KiwiApp::useInstance().useScheduler(); - scheduler.schedule([this, success_callback, message](){ - success_callback(message); - }); - }; - - KiwiApp::useApi().signup(username, email, password, - std::move(success_cb), std::move(error_callback)); + m_auth_user.resetWith(auth_user); } void ApiController::logout() diff --git a/Client/Source/KiwiApp_Network/KiwiApp_ApiController.h b/Client/Source/KiwiApp_Network/KiwiApp_ApiController.h index c8c68a01..ac456156 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_ApiController.h +++ b/Client/Source/KiwiApp_Network/KiwiApp_ApiController.h @@ -42,24 +42,10 @@ namespace kiwi //! If false, the user profile will be saved whithout the token. ~ApiController(); - //! @brief Attempt to log the client api user in (Async). - //! @param name_or_email The name or email of the user. - //! @param password The user password. - //! @see logout, isUserLoggedIn - void login(std::string const& name_or_email, - std::string const& password, - std::function success_callback, - Api::ErrorCallback error_callback); - - //! @brief Attempt to register/signup the user. - //! @param username user name - //! @param email email address - //! @param password password - void signup(std::string const& username, - std::string const& email, - std::string const& password, - std::function success_cb, - Api::ErrorCallback error_cb); + //! @brief Changes the API's authenticated user. + //! @details All authenticated will now use this user to + //! query the server. + void setAuthUser(Api::AuthUser const& auth_user); //! @brief Log-out the user. //! @see login, isUserLoggedIn diff --git a/Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.cpp b/Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.cpp index b43df53e..8d099aa8 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.cpp +++ b/Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.cpp @@ -83,10 +83,13 @@ namespace kiwi DocumentBrowser::Drive::Drive(std::string const& name) : m_name(name), + m_documents(), + m_listeners(), m_sort([](DocumentSession const& l_hs, DocumentSession const& r_hs) { return l_hs.getName() < r_hs.getName(); - }) + }), + m_drive(this, [](DocumentBrowser::Drive*){}) { ; }; @@ -129,54 +132,64 @@ namespace kiwi void DocumentBrowser::Drive::uploadDocument(std::string const& name, std::string const& data) { + std::weak_ptr drive(m_drive); + KiwiApp::useApi().uploadDocument(name, data, KiwiApp::use().getApplicationVersion().toStdString(), - [this](Api::Response res, Api::Document document) + [drive](Api::Response res, Api::Document document) { - if (res.result() == beast::http::status::forbidden) - { - DocumentBrowser::handleDeniedRequest(); - } - else if(res.error) - { - juce::MessageManager::callAsync([message = res.error.message()](){ - KiwiApp::error("Error: can't create document"); - KiwiApp::error("=> " + message); - }); - } - else + KiwiApp::useScheduler().schedule([drive, res, document]() { - juce::MessageManager::callAsync([this]() + std::shared_ptr drive_ptr = drive.lock(); + + if (drive_ptr != nullptr) { - refresh(); - }); - } + if (res.result() == beast::http::status::forbidden) + { + DocumentBrowser::handleDeniedRequest(); + } + else if(res.error) + { + KiwiApp::error("Error: can't create document"); + KiwiApp::error("=> " + res.error.message()); + } + else + { + drive_ptr->refresh(); + } + } + }); }); } void DocumentBrowser::Drive::createNewDocument() { - KiwiApp::useApi().createDocument("", [this](Api::Response res, Api::Document document) { - - if (res.result() == beast::http::status::forbidden) - { - DocumentBrowser::handleDeniedRequest(); - } - else if(res.error) - { - juce::MessageManager::callAsync([message = res.error.message()](){ - KiwiApp::error("Error: can't create document"); - KiwiApp::error("=> " + message); - }); - } - else + std::weak_ptr drive(m_drive); + + KiwiApp::useApi().createDocument("", [drive](Api::Response res, Api::Document document) + { + KiwiApp::useScheduler().schedule([drive, res, document]() { - juce::MessageManager::callAsync([this]() + std::shared_ptr drive_ptr = drive.lock(); + + if(drive_ptr != nullptr) { - refresh(); - }); - } + if (res.result() == beast::http::status::forbidden) + { + DocumentBrowser::handleDeniedRequest(); + } + else if(res.error) + { + KiwiApp::error("Error: can't create document"); + KiwiApp::error("=> " + res.error.message()); + } + else + { + drive_ptr->refresh(); + } + } + }); }); } @@ -271,40 +284,50 @@ namespace kiwi void DocumentBrowser::Drive::refresh_internal() { - KiwiApp::useApi().getDocuments([this](Api::Response res, Api::Documents docs) + std::weak_ptr drive(m_drive); + + KiwiApp::useApi().getDocuments([drive](Api::Response res, Api::Documents docs) { - if (res.result() == beast::http::status::ok - && !res.error) + KiwiApp::useScheduler().schedule([drive, res, docs]() { - KiwiApp::useInstance().useScheduler().schedule([this, docs]() + std::shared_ptr drive_ptr = drive.lock(); + + if (drive_ptr != nullptr + && res.result() == beast::http::status::ok + && !res.error) { - updateDocumentList(docs); - }); - } + drive_ptr->updateDocumentList(docs); + } + }); }); } void DocumentBrowser::Drive::refresh() { - KiwiApp::useApi().getDocuments([this](Api::Response res, Api::Documents docs) { - - if (res.result() == beast::http::status::forbidden) + std::weak_ptr drive(m_drive); + + KiwiApp::useApi().getDocuments([drive](Api::Response res, Api::Documents docs) + { + KiwiApp::useScheduler().schedule([drive, res, docs]() { - KiwiApp::useInstance().useScheduler().schedule([]() + std::shared_ptr drive_ptr = drive.lock(); + + if(drive_ptr != nullptr) { - DocumentBrowser::handleDeniedRequest(); - }); - } - else if(res.error) - { - KiwiApp::error("Kiwi API error: can't get documents => " + res.error.message()); - } - else - { - KiwiApp::useInstance().useScheduler().schedule([this, docs]() { - updateDocumentList(docs); - }); - } + if (res.result() == beast::http::status::forbidden) + { + DocumentBrowser::handleDeniedRequest(); + } + else if(res.error) + { + KiwiApp::error("Kiwi API error: can't get documents => " + res.error.message()); + } + else + { + drive_ptr->updateDocumentList(docs); + } + } + }); }); } @@ -316,9 +339,9 @@ namespace kiwi Api::Document document) : m_drive(parent), m_document(std::move(document)), - m_open_token("") + m_open_token(""), + m_session(this, [](DocumentSession *){}) { - } DocumentBrowser::Drive::DocumentSession::~DocumentSession() @@ -378,77 +401,88 @@ namespace kiwi void DocumentBrowser::Drive::DocumentSession::untrash() { - KiwiApp::useApi().untrashDocument(m_document._id, [this](Api::Response res) + std::weak_ptr session(m_session); + + KiwiApp::useApi().untrashDocument(m_document._id, [session](Api::Response res) { - if (res.result() == beast::http::status::forbidden) + KiwiApp::useScheduler().schedule([session, res]() { - KiwiApp::useInstance().useScheduler().schedule([]() + std::shared_ptr session_ptr = session.lock(); + + if (session_ptr != nullptr) { - DocumentBrowser::handleDeniedRequest(); - }); - } - else if(res.error) - { - KiwiApp::error(res.error.message()); - } - else - { - KiwiApp::useInstance().useScheduler().schedule([this]() - { - m_drive.refresh(); - }); - } + if (res.result() == beast::http::status::forbidden) + { + DocumentBrowser::handleDeniedRequest(); + } + else if(res.error) + { + KiwiApp::error(res.error.message()); + } + else + { + session_ptr->m_drive.refresh(); + } + } + }); }); } void DocumentBrowser::Drive::DocumentSession::trash() { - KiwiApp::useApi().trashDocument(m_document._id, [this](Api::Response res) { - - if (res.result() == beast::http::status::forbidden) - { - KiwiApp::useInstance().useScheduler().schedule([]() - { - DocumentBrowser::handleDeniedRequest(); - - }); - } - else if(res.error) - { - KiwiApp::error(res.error.message()); - } - else + std::weak_ptr session(m_session); + + KiwiApp::useApi().trashDocument(m_document._id, [session](Api::Response res) + { + KiwiApp::useScheduler().schedule([session, res]() { - KiwiApp::useInstance().useScheduler().schedule([this]() + std::shared_ptr session_ptr = session.lock(); + + if (session_ptr != nullptr) { - m_drive.refresh(); - }); - } + if (res.result() == beast::http::status::forbidden) + { + DocumentBrowser::handleDeniedRequest(); + } + else if(res.error) + { + KiwiApp::error(res.error.message()); + } + else + { + session_ptr->m_drive.refresh(); + } + } + }); }); } void DocumentBrowser::Drive::DocumentSession::duplicate() { - KiwiApp::useApi().duplicateDocument(m_document._id, [this](Api::Response res) { - - if (res.result() == beast::http::status::forbidden) - { - KiwiApp::useInstance().useScheduler().schedule([]() - { - DocumentBrowser::handleDeniedRequest(); - }); - } - else if(res.error) - { - KiwiApp::error(res.error.message()); - } - else + std::weak_ptr session(m_session); + + KiwiApp::useApi().duplicateDocument(m_document._id, [session](Api::Response res) + { + KiwiApp::useScheduler().schedule([res, session]() { - KiwiApp::useInstance().useScheduler().schedule([this]() + std::shared_ptr session_ptr = session.lock(); + + if (session_ptr != nullptr) { - m_drive.refresh(); - }); - } + if (res.result() == beast::http::status::forbidden) + { + DocumentBrowser::handleDeniedRequest(); + } + else if(res.error) + { + KiwiApp::error(res.error.message()); + } + else + { + session_ptr->m_drive.refresh(); + } + } + }); }); } @@ -459,51 +493,60 @@ namespace kiwi return; } - KiwiApp::useApi().renameDocument(m_document._id, new_name, [this](Api::Response res) { - - if (res.result() == beast::http::status::forbidden) - { - KiwiApp::useInstance().useScheduler().schedule([]() - { - DocumentBrowser::handleDeniedRequest(); - }); - } - else if(res.error) - { - KiwiApp::error(res.error.message()); - } - else + std::weak_ptr session(m_session); + + KiwiApp::useApi().renameDocument(m_document._id, new_name, [session](Api::Response res) + { + KiwiApp::useScheduler().schedule([session, res]() { - KiwiApp::useInstance().useScheduler().schedule([this]() + std::shared_ptr session_ptr = session.lock(); + + if (session_ptr != nullptr) { - m_drive.refresh(); - }); - } + if (res.result() == beast::http::status::forbidden) + { + DocumentBrowser::handleDeniedRequest(); + } + else if(res.error) + { + KiwiApp::error(res.error.message()); + } + else + { + session_ptr->m_drive.refresh(); + } + } + }); }); } void DocumentBrowser::Drive::DocumentSession::download(std::function callback) { + std::weak_ptr session(m_session); + KiwiApp::useApi().downloadDocument(m_document._id, - [this, cb = std::move(callback)](Api::Response res) + [session, cb = std::move(callback)](Api::Response res) { - - if (res.result() == beast::http::status::forbidden) + KiwiApp::useScheduler().schedule([session, res, func = std::bind(cb, res.body)]() { - KiwiApp::useInstance().useScheduler().schedule([]() + std::shared_ptr session_ptr = session.lock(); + + if (session_ptr) { - DocumentBrowser::handleDeniedRequest(); - - }); - } - else if(res.error) - { - KiwiApp::error(res.error.message()); - } - else - { - KiwiApp::useInstance().useScheduler().schedule(std::bind(cb, res.body)); - } + if (res.result() == beast::http::status::forbidden) + { + DocumentBrowser::handleDeniedRequest(); + } + else if(res.error) + { + KiwiApp::error(res.error.message()); + } + else + { + func(); + } + } + }); }); } @@ -519,33 +562,41 @@ namespace kiwi void DocumentBrowser::Drive::DocumentSession::open() { - auto success = [this](std::string const& token) + std::weak_ptr session(m_session); + + auto success = [session](std::string const& token) { - m_open_token = token; - - KiwiApp::useInstance().useScheduler().schedule([this]() + KiwiApp::useScheduler().schedule([session, token]() { - KiwiApp::useInstance().openRemotePatcher(*this); - m_drive.refresh(); + std::shared_ptr session_ptr = session.lock(); + + if (session_ptr != nullptr) + { + session_ptr->m_open_token = token; + session_ptr->m_drive.refresh(); + KiwiApp::useInstance().openRemotePatcher(*session_ptr); + } }); }; - auto error = [this](Api::Error er) + auto error = [session](Api::Error er) { - if (er.getStatusCode() == static_cast(beast::http::status::forbidden)) - { - KiwiApp::useInstance().useScheduler().schedule([]() - { - DocumentBrowser::handleDeniedRequest(); - }); - } - else + KiwiApp::useScheduler().schedule([session, er]() { - KiwiApp::useInstance().useScheduler().schedule([er]() + std::shared_ptr session_ptr = session.lock(); + + if (session_ptr != nullptr) { - KiwiApp::error(er.getMessage()); - }); - } + if (er.getStatusCode() == static_cast(beast::http::status::forbidden)) + { + DocumentBrowser::handleDeniedRequest(); + } + else + { + KiwiApp::error(er.getMessage()); + } + } + }); }; KiwiApp::useApi().getOpenToken(m_document._id, success, error); diff --git a/Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.h b/Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.h index 534634fd..f098e9f4 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.h +++ b/Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.h @@ -141,6 +141,7 @@ namespace kiwi DocumentSessions m_documents; tool::Listeners m_listeners; Comp m_sort; + std::shared_ptr m_drive; friend class DocumentBrowser; }; @@ -244,6 +245,7 @@ namespace kiwi DocumentBrowser::Drive& m_drive; Api::Document m_document; std::string m_open_token; + std::shared_ptr m_session; friend class DocumentBrowser::Drive; }; diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.cpp index beba0e8c..843b1289 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.cpp @@ -45,14 +45,12 @@ namespace kiwi { m_signal(model.getSignal<>(model::Bang::Signal::TriggerBang)), m_connection(m_signal.connect(std::bind(&BangView::signalTriggered, this))), m_active(false), - m_mouse_down(false), - m_switch_off(std::make_shared::CallBack>(std::bind(&BangView::switchOff, this))) + m_mouse_down(false) { } BangView::~BangView() { - getScheduler().unschedule(m_switch_off); } void BangView::paint(juce::Graphics & g) @@ -98,22 +96,29 @@ namespace kiwi { { m_active = true; repaint(); - } + } + + Component::SafePointer form(this); + + getScheduler().schedule([form]() + { + if (form) + { + form.getComponent()->m_active = false; + form.getComponent()->repaint(); + } + }, std::chrono::milliseconds(150)); - getScheduler().schedule(m_switch_off, std::chrono::milliseconds(150)); - } - - void BangView::switchOff() - { - m_active = false; - repaint(); - } + } void BangView::signalTriggered() - { - getScheduler().defer([this]() - { - flash(); + { + Component::SafePointer form(this); + + getScheduler().defer([form]() + { + if (form) + form.getComponent()->flash(); }); } } diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.h b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.h index 7685382a..3ab0cdd6 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.h +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.h @@ -57,8 +57,6 @@ namespace kiwi { void flash(); - void switchOff(); - void signalTriggered(); private: // members @@ -68,7 +66,6 @@ namespace kiwi { flip::SignalConnection m_connection; bool m_active; bool m_mouse_down; - std::shared_ptr::CallBack> m_switch_off; private: // deleted methods diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp index 306a26dd..8ad24b9c 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp @@ -111,7 +111,7 @@ namespace kiwi tool::Scheduler<> & ObjectView::getScheduler() const { - return KiwiApp::useInstance().useScheduler(); + return KiwiApp::useScheduler(); } void ObjectView::defer(std::function call_back) diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherComponent.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherComponent.cpp index b743e1d4..8450e715 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherComponent.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherComponent.cpp @@ -181,27 +181,32 @@ namespace kiwi startFlashing(); - auto success = [this](Api::Users users) + Component::SafePointer form(this); + + auto success = [form](Api::Users users) { - KiwiApp::useInstance().useScheduler().schedule([this, users]() + KiwiApp::useScheduler().schedule([form, users]() { - m_users.clear(); - - for(Api::User const& user : users) + if (form) { - m_users.push_back(user.getName()); + form.getComponent()->m_users.clear(); + for(Api::User const& user : users) + { + form.getComponent()->m_users.push_back(user.getName()); + } } - }); }; - auto fail = [this](Api::Error error) + auto fail = [form](Api::Error error) { - KiwiApp::useInstance().useScheduler().schedule([this, error]() + KiwiApp::useScheduler().schedule([form, error]() { - m_users.clear(); - + if (form) + { + form.getComponent()->m_users.clear(); + } }); }; diff --git a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp index 6f25f1de..44eb9220 100644 --- a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp +++ b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp @@ -24,6 +24,17 @@ namespace kiwi { namespace network { namespace http { + // ================================================================================ // + // SESSION ID // + // ================================================================================ // + + static uint64_t id_cnt = 0; + + uint64_t getNextId() + { + return ++id_cnt; + } + // ================================================================================ // // HTTP PAYLOAD // // ================================================================================ // @@ -96,12 +107,18 @@ namespace kiwi { namespace network { namespace http { , m_payload() , m_body() , m_timeout(0) + , m_id(getNextId()) , m_query() , m_req_header() { ; } + uint64_t Session::getId() const + { + return m_id; + } + void Session::setHost(std::string const& host) { m_req_header.set(beast::http::field::host, host); diff --git a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h index bf091fd0..aa35c463 100644 --- a/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h +++ b/Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h @@ -104,7 +104,9 @@ namespace kiwi { namespace network { namespace http { using Callback = std::function; Session(); - ~Session() = default; + ~Session() = default; + + uint64_t getId() const; void setHost(std::string const& host); void setPort(std::string const& port); @@ -146,6 +148,7 @@ namespace kiwi { namespace network { namespace http { Payload m_payload; Body m_body; Timeout m_timeout; + uint64_t m_id; std::unique_ptr m_query; beast::http::request_header<> m_req_header; From bd6184da21b638e46e7e427717ba0d516a98dd65 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Fri, 16 Mar 2018 14:00:16 +0100 Subject: [PATCH 05/35] Adding matrix data structure. --- Modules/KiwiTool/KiwiTool_Matrix.h | 87 ++++++++++++++++++ Modules/KiwiTool/KiwiTool_Matrix.hpp | 129 +++++++++++++++++++++++++++ Test/Tool/test_Matrix.cpp | 110 +++++++++++++++++++++++ 3 files changed, 326 insertions(+) create mode 100644 Modules/KiwiTool/KiwiTool_Matrix.h create mode 100644 Modules/KiwiTool/KiwiTool_Matrix.hpp create mode 100644 Test/Tool/test_Matrix.cpp diff --git a/Modules/KiwiTool/KiwiTool_Matrix.h b/Modules/KiwiTool/KiwiTool_Matrix.h new file mode 100644 index 00000000..b2dda53f --- /dev/null +++ b/Modules/KiwiTool/KiwiTool_Matrix.h @@ -0,0 +1,87 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace tool { + + // ================================================================================ // + // MATRIX // + // ================================================================================ // + + //! @brief A matrix data structure. + //! @details Implementation of basic matrix operation. + //! @todo Adds more usefull operation. + template + class Matrix final + { + public: // methods + + //! @brief Constructor. + //! @details Initializes matrix with default constructor. + Matrix(size_t num_rows, size_t num_cols); + + //! @brief Destructor. + ~Matrix(); + + //! @brief Copy constructor. + Matrix(Matrix const& other); + + //! @brief Move constructor. + Matrix(Matrix && other); + + //! @brief Assignment operator. + //! @details Number of rows and columns must match. + Matrix& operator=(Matrix const& other); + + //! @brief Move assignement operator. + //! @details Number of rows and columns must match. + Matrix& operator=(Matrix && other); + + //! @brief Returns the number of rows. + size_t getNumRows() const; + + //! @brief Returns the number of colunms. + size_t getNumCols() const; + + //! @brief Gets a value stored in matrix. + //! @details row (res column) must be inferior to number of rows (res num columns). + Type & at(size_t row, size_t colunm); + + //! @brief Gets a value stored in matrix. + //! @details row (res column) must be inferior to number of rows (res num columns). + Type const& at(size_t row, size_t column) const; + + private: // members + + size_t m_num_rows; + size_t m_num_cols; + Type* m_data; + + private: // deleted methods + + Matrix() = delete; + }; +}} + +#include diff --git a/Modules/KiwiTool/KiwiTool_Matrix.hpp b/Modules/KiwiTool/KiwiTool_Matrix.hpp new file mode 100644 index 00000000..cad72058 --- /dev/null +++ b/Modules/KiwiTool/KiwiTool_Matrix.hpp @@ -0,0 +1,129 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include +#include + +#include + +namespace kiwi { namespace tool { + + // ================================================================================ // + // MATRIX // + // ================================================================================ // + + template + void copy(Type * const dest, Type const * const src, size_t size) + { + for (size_t index = 0; index < size; ++index) + { + dest[index] = src[index]; + } + } + + template + Matrix::Matrix(size_t num_rows, size_t num_cols): + m_num_rows(num_rows), + m_num_cols(num_cols), + m_data(new Type[m_num_rows * m_num_cols]()) + { + } + + template + Matrix::~Matrix() + { + delete[] m_data; + } + + template + Matrix::Matrix(Matrix const& other): + m_num_rows(other.m_num_rows), + m_num_cols(other.m_num_cols), + m_data(new Type[m_num_rows * m_num_cols]()) + { + copy(m_data, other.m_data, m_num_rows * m_num_cols); + } + + template + Matrix::Matrix(Matrix && other): + m_num_rows(other.m_num_rows), + m_num_cols(other.m_num_cols), + m_data(new Type[m_num_rows * m_num_cols]()) + { + copy(m_data, other.m_data, m_num_rows * m_num_cols); + + other.m_num_cols = 0; + other.m_num_rows = 0; + other.m_data = nullptr; + } + + template + Matrix & Matrix::operator=(Matrix const& other) + { + assert((m_num_rows == other.m_num_rows && m_num_cols == other.m_num_cols) + && "Assigning matrixes with different size"); + + copy(m_data, other.m_data, m_num_rows * m_num_cols); + + return *this; + } + + template + Matrix & Matrix::operator=(Matrix && other) + { + assert((m_num_rows == other.m_num_rows && m_num_cols == other.m_num_cols) + && "Assigning matrixes with different size"); + + copy(m_data, other.m_data, m_num_rows * m_num_cols); + + other.m_num_cols = 0; + other.m_num_rows = 0; + other.m_data = nullptr; + + return *this; + } + + template + size_t Matrix::getNumRows() const + { + return m_num_rows; + } + + template + size_t Matrix::getNumCols() const + { + return m_num_cols; + } + + template + Type & Matrix::at(size_t row, size_t column) + { + assert((row < m_num_rows && column < m_num_cols) && "Accessing matrix out of bounds"); + return m_data[m_num_cols * row + column]; + } + + template + Type const& Matrix::at(size_t row, size_t column) const + { + assert((row < m_num_rows && column < m_num_cols) && "Accessing matrix out of bounds"); + return m_data[m_num_cols * row + column]; + } +}} diff --git a/Test/Tool/test_Matrix.cpp b/Test/Tool/test_Matrix.cpp new file mode 100644 index 00000000..7fbfeabd --- /dev/null +++ b/Test/Tool/test_Matrix.cpp @@ -0,0 +1,110 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + + +#include "../catch.hpp" + +#include + +using namespace kiwi; + +// ==================================================================================== // +// MATRIX // +// ==================================================================================== // + +void fill(tool::Matrix & matrix) +{ + for (size_t row = 0; row < matrix.getNumRows(); ++row) + { + for (size_t col = 0; col < matrix.getNumCols(); ++col) + { + matrix.at(row, col) = row * matrix.getNumCols() + col; + } + } +} + +TEST_CASE("Matrix", "[Matrix]") +{ + tool::Matrix matrix(3, 4); + + fill(matrix); + + SECTION("Constructor") + { + tool::Matrix matrix_cons(3, 4); + + CHECK(matrix_cons.getNumRows() == 3); + CHECK(matrix_cons.getNumCols() == 4); + CHECK(matrix_cons.at(2, 3) == 0); + } + + SECTION("Copy Constructor") + { + tool::Matrix matrix_cp(matrix); + + CHECK(matrix_cp.getNumRows() == matrix.getNumRows()); + CHECK(matrix_cp.getNumCols() == matrix.getNumCols()); + CHECK(matrix_cp.at(2, 1)== matrix.at(2, 1)); + } + + SECTION("Move Constructors") + { + size_t rows = matrix.getNumRows(); + size_t cols = matrix.getNumCols(); + int value22 = matrix.at(2, 2); + + tool::Matrix matrix_mv(std::move(matrix)); + + CHECK(matrix.getNumRows() == 0); + CHECK(matrix.getNumCols() == 0); + CHECK(matrix_mv.getNumRows() == rows); + CHECK(matrix_mv.getNumCols() == cols); + CHECK(matrix_mv.at(2, 2) == value22); + } + + SECTION("Assignement") + { + tool::Matrix matrix_as(matrix.getNumRows(), matrix.getNumCols()); + matrix_as = matrix; + + CHECK(matrix_as.getNumRows() == matrix.getNumRows()); + CHECK(matrix_as.getNumCols() == matrix.getNumCols()); + CHECK(matrix_as.at(2, 2) == matrix.at(2, 2)); + } + + SECTION("Move assignement") + { + size_t rows = matrix.getNumRows(); + size_t cols = matrix.getNumCols(); + int value22 = matrix.at(2, 2); + + tool::Matrix matrix_mv(matrix.getNumRows(), matrix.getNumCols()); + matrix_mv = std::move(matrix); + + CHECK(matrix.getNumRows() == 0); + CHECK(matrix.getNumCols() == 0); + CHECK(matrix_mv.getNumRows() == rows); + CHECK(matrix_mv.getNumCols() == cols); + CHECK(matrix_mv.at(2, 2) == value22); + } +} From 8be77f4673b6a742fb0cf8ba0da1421c9b60aa03 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Mon, 19 Mar 2018 11:59:08 +0100 Subject: [PATCH 06/35] Add object gate. --- Client/Source/KiwiApp.cpp | 3 +- .../KiwiEngine_Objects/KiwiEngine_Gate.cpp | 88 ++++++++++++++ .../KiwiEngine_Objects/KiwiEngine_Gate.h | 54 +++++++++ .../KiwiEngine_Objects/KiwiEngine_Objects.h | 3 +- Modules/KiwiModel/KiwiModel_DataModel.cpp | 3 +- .../KiwiModel_Objects/KiwiModel_Gate.cpp | 110 ++++++++++++++++++ .../KiwiModel_Objects/KiwiModel_Gate.h | 47 ++++++++ .../KiwiModel_Objects/KiwiModel_Objects.h | 3 +- 8 files changed, 307 insertions(+), 4 deletions(-) create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.cpp create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.h create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.cpp create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.h diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index ddcb1bee..f887b213 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -205,7 +205,8 @@ namespace kiwi engine::NumberTilde::declare(); engine::Hub::declare(); engine::Mtof::declare(); - engine::Send::declare(); + engine::Send::declare(); + engine::Gate::declare(); } void KiwiApp::declareObjectViews() diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.cpp new file mode 100644 index 00000000..39afc893 --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.cpp @@ -0,0 +1,88 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // GATE // + // ================================================================================ // + + void Gate::declare() + { + Factory::add("gate", &Gate::create); + } + + std::unique_ptr Gate::create(model::Object const& model, Patcher & patcher) + { + return std::make_unique(model, patcher); + } + + Gate::Gate(model::Object const& model, Patcher& patcher) : + Object(model, patcher), + m_opened_output(), + m_num_outputs(model.getArguments()[0].getInt()) + { + std::vector const& args = model.getArguments(); + + if (args.size() > 1) + { + openOutput(args[1].getInt()); + } + } + + void Gate::openOutput(int output) + { + m_opened_output = std::max(0, std::min(output, static_cast(m_num_outputs))); + } + + void Gate::receive(size_t index, std::vector const& args) + { + if (args.size() > 0) + { + if (index == 0) + { + if (args[0].isBang()) + { + send(0, {static_cast(m_opened_output)}); + } + else if (args[0].isNumber()) + { + openOutput(args[0].getInt()); + } + else + { + warning("gate inlet 1 receives only numbers"); + } + } + else if(index == 1) + { + if (m_opened_output > 0) + { + send(m_opened_output - 1, args); + } + } + } + } + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.h new file mode 100644 index 00000000..fd51df9d --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.h @@ -0,0 +1,54 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // GATE // + // ================================================================================ // + + class Gate : public engine::Object + { + public: + + static void declare(); + + static std::unique_ptr create(model::Object const& model, Patcher & patcher); + + Gate(model::Object const& model, Patcher& patcher); + + void receive(size_t index, std::vector const& args) override; + + private: + + void openOutput(int output); + + private: + + size_t m_opened_output; + size_t m_num_outputs; + }; + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h index dca288df..454ab06f 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h @@ -77,4 +77,5 @@ #include #include #include -#include +#include +#include diff --git a/Modules/KiwiModel/KiwiModel_DataModel.cpp b/Modules/KiwiModel/KiwiModel_DataModel.cpp index 40ceb00a..5228fbaf 100644 --- a/Modules/KiwiModel/KiwiModel_DataModel.cpp +++ b/Modules/KiwiModel/KiwiModel_DataModel.cpp @@ -89,7 +89,8 @@ namespace kiwi model::NumberTilde::declare(); model::Hub::declare(); model::Mtof::declare(); - model::Send::declare(); + model::Send::declare(); + model::Gate::declare(); } void DataModel::init(std::function declare_object) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.cpp new file mode 100755 index 00000000..a430650b --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.cpp @@ -0,0 +1,110 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // GATE // + // ================================================================================ // + + void Gate::declare() + { + std::unique_ptr gate_class(new ObjectClass("gate", &Gate::create)); + + flip::Class & gate_model = DataModel::declare() + .name(gate_class->getModelName().c_str()) + .inherit(); + + Factory::add(std::move(gate_class), gate_model); + } + + std::unique_ptr Gate::create(std::vector const& args) + { + return std::make_unique(args); + } + + Gate::Gate(std::vector const& args) + { + if (args.size() <= 0) + throw Error("gate number of gates must be specified"); + + if (args.size() > 2) + throw Error("gate takes at most 2 arguments"); + + if (args.size() > 1 && !args[1].isNumber()) + throw Error("gate 2nd argument must be a number"); + + if (args.size() > 0) + { + if (!args[0].isInt()) + { + throw Error("gate 1rst argument must be an integer"); + } + else if(args[0].getInt() < 0) + { + throw Error("gate 1rst argument must be greater than 0"); + } + } + + pushInlet({PinType::IType::Control}); + pushInlet({PinType::IType::Control}); + + if (args.empty()) + { + pushOutlet(PinType::IType::Control); + } + else + { + for(int outlet = 0; outlet < args[0].getInt(); ++outlet) + { + pushOutlet(PinType::IType::Control); + } + } + } + + std::string Gate::getIODescription(bool is_inlet, size_t index) const + { + std::string description = ""; + + if (is_inlet) + { + if (index == 0) + { + description = "Int Open/Close gate"; + } + else if(index == 1) + { + description = "Dispatch message to opened gate"; + } + } + else + { + description = "Ouput " + std::to_string(index + 1) + " sends message when opened"; + } + + return description; + } + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.h new file mode 100755 index 00000000..7833df56 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.h @@ -0,0 +1,47 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // GATE // + // ================================================================================ // + + class Gate : public model::Object + { + public: + + static void declare(); + + static std::unique_ptr create(std::vector const& args); + + Gate(flip::Default& d) : model::Object(d) {} + + Gate(std::vector const& args); + + std::string getIODescription(bool is_inlet, size_t index) const override; + }; + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h index 8ec00922..31e9b5a5 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h @@ -77,4 +77,5 @@ #include #include #include -#include +#include +#include From 87a026146f2fcd70f6a6984c4f7ec8b45293d9ff Mon Sep 17 00:00:00 2001 From: jean-millot Date: Mon, 19 Mar 2018 12:55:13 +0100 Subject: [PATCH 07/35] Object switch. --- Client/Source/KiwiApp.cpp | 3 +- .../KiwiEngine_Objects/KiwiEngine_Objects.h | 3 +- .../KiwiEngine_Objects/KiwiEngine_Switch.cpp | 86 +++++++++++++ .../KiwiEngine_Objects/KiwiEngine_Switch.h | 54 +++++++++ Modules/KiwiModel/KiwiModel_DataModel.cpp | 3 +- .../KiwiModel_Objects/KiwiModel_Objects.h | 3 +- .../KiwiModel_Objects/KiwiModel_Switch.h | 47 ++++++++ .../KiwiModel_Objects/KiwiModel_Swith.cpp | 113 ++++++++++++++++++ 8 files changed, 308 insertions(+), 4 deletions(-) create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.cpp create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.h create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Switch.h create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Swith.cpp diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index f887b213..87789956 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -206,7 +206,8 @@ namespace kiwi engine::Hub::declare(); engine::Mtof::declare(); engine::Send::declare(); - engine::Gate::declare(); + engine::Gate::declare(); + engine::Switch::declare(); } void KiwiApp::declareObjectViews() diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h index 454ab06f..02dec864 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h @@ -78,4 +78,5 @@ #include #include #include -#include +#include +#include diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.cpp new file mode 100644 index 00000000..afe773f1 --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.cpp @@ -0,0 +1,86 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // SWITCH // + // ================================================================================ // + + void Switch::declare() + { + Factory::add("switch", &Switch::create); + } + + std::unique_ptr Switch::create(model::Object const& model, Patcher & patcher) + { + return std::make_unique(model, patcher); + } + + Switch::Switch(model::Object const& model, Patcher& patcher) : + Object(model, patcher), + m_opened_input(), + m_num_inputs(model.getArguments()[0].getInt()) + { + std::vector const& args = model.getArguments(); + + if (args.size() > 1) + { + openInput(args[1].getInt()); + } + } + + void Switch::openInput(int input) + { + m_opened_input = std::max(0, std::min(input, static_cast(m_num_inputs))); + } + + void Switch::receive(size_t index, std::vector const& args) + { + if (args.size() > 0) + { + if (index == 0) + { + if (args[0].isBang()) + { + send(0, {static_cast(m_opened_input)}); + } + else if(args[0].isNumber()) + { + openInput(args[0].getInt()); + } + else + { + warning("switch inlet 1 receives only numbers"); + } + } + else if(index == m_opened_input) + { + send(0, args); + } + } + } + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.h new file mode 100644 index 00000000..58e1a6da --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.h @@ -0,0 +1,54 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // SWITCH // + // ================================================================================ // + + class Switch : public engine::Object + { + public: + + static void declare(); + + static std::unique_ptr create(model::Object const& model, Patcher & patcher); + + Switch(model::Object const& model, Patcher& patcher); + + void receive(size_t index, std::vector const& args) override; + + private: + + void openInput(int input); + + private: + + size_t m_opened_input; + size_t m_num_inputs; + }; + +}} diff --git a/Modules/KiwiModel/KiwiModel_DataModel.cpp b/Modules/KiwiModel/KiwiModel_DataModel.cpp index 5228fbaf..9fb0933c 100644 --- a/Modules/KiwiModel/KiwiModel_DataModel.cpp +++ b/Modules/KiwiModel/KiwiModel_DataModel.cpp @@ -90,7 +90,8 @@ namespace kiwi model::Hub::declare(); model::Mtof::declare(); model::Send::declare(); - model::Gate::declare(); + model::Gate::declare(); + model::Switch::declare(); } void DataModel::init(std::function declare_object) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h index 31e9b5a5..e021813e 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h @@ -78,4 +78,5 @@ #include #include #include -#include +#include +#include diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Switch.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Switch.h new file mode 100755 index 00000000..e21df944 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Switch.h @@ -0,0 +1,47 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // SWITCH // + // ================================================================================ // + + class Switch : public model::Object + { + public: + + static void declare(); + + static std::unique_ptr create(std::vector const& args); + + Switch(flip::Default& d) : model::Object(d) {} + + Switch(std::vector const& args); + + std::string getIODescription(bool is_inlet, size_t index) const override; + }; + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Swith.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Swith.cpp new file mode 100755 index 00000000..dd56aeb0 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Swith.cpp @@ -0,0 +1,113 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // SWITCH // + // ================================================================================ // + + void Switch::declare() + { + std::unique_ptr switch_class(new ObjectClass("switch", &Switch::create)); + + flip::Class & switch_model = DataModel::declare() + .name(switch_class->getModelName().c_str()) + .inherit(); + + Factory::add(std::move(switch_class), switch_model); + } + + std::unique_ptr Switch::create(std::vector const& args) + { + return std::make_unique(args); + } + + Switch::Switch(std::vector const& args) + { + if (args.size() <= 0) + throw Error("switch number of inputs must be specified"); + + if (args.size() > 2) + throw Error("switch takes at most 2 arguments"); + + if (args.size() > 1 && !args[1].isNumber()) + throw Error("switch 2nd argument must be a number"); + + if (args.size() > 0) + { + if (!args[0].isInt()) + { + throw Error("switch 1rst argument must be an integer"); + } + else if(args[0].getInt() < 0) + { + throw Error("switch 1rst argument must be greater than 0"); + } + } + + pushInlet({PinType::IType::Control}); + + pushOutlet(PinType::IType::Control); + + if (args.empty()) + { + pushInlet({PinType::IType::Control}); + } + else + { + for(int inlet = 0; inlet < args[0].getInt(); ++inlet) + { + pushInlet({PinType::IType::Control}); + } + } + } + + std::string Switch::getIODescription(bool is_inlet, size_t index) const + { + std::string description = ""; + + if (is_inlet) + { + if (index == 0) + { + description = "Integer opens inlet. 0 closes all inlets"; + } + else if(index < getNumberOfInlets()) + { + description = "Input " + std::to_string(index) + " sends message when inlet is opened"; + } + } + else + { + description = "Sends message received in opened inlet"; + } + + return description; + } + +}} From 1b7126bffff63c0fad163a66a5e60404f3eeb15a Mon Sep 17 00:00:00 2001 From: jean-millot Date: Mon, 19 Mar 2018 16:14:28 +0100 Subject: [PATCH 08/35] Adding object gate~. --- Client/Source/KiwiApp.cpp | 3 +- .../KiwiEngine_GateTilde.cpp | 129 ++++++++++++++++++ .../KiwiEngine_Objects/KiwiEngine_GateTilde.h | 62 +++++++++ .../KiwiEngine_Objects/KiwiEngine_Objects.h | 3 +- Modules/KiwiModel/KiwiModel_DataModel.cpp | 3 +- .../KiwiModel_Objects/KiwiModel_GateTilde.cpp | 105 ++++++++++++++ .../KiwiModel_Objects/KiwiModel_GateTilde.h | 47 +++++++ .../KiwiModel_Objects/KiwiModel_Objects.h | 3 +- 8 files changed, 351 insertions(+), 4 deletions(-) create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.cpp create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.h create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.cpp create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.h diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index 87789956..c716d42e 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -207,7 +207,8 @@ namespace kiwi engine::Mtof::declare(); engine::Send::declare(); engine::Gate::declare(); - engine::Switch::declare(); + engine::Switch::declare(); + engine::GateTilde::declare(); } void KiwiApp::declareObjectViews() diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.cpp new file mode 100644 index 00000000..1d3c31ee --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.cpp @@ -0,0 +1,129 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // GATE~ // + // ================================================================================ // + + void GateTilde::declare() + { + Factory::add("gate~", &GateTilde::create); + } + + std::unique_ptr GateTilde::create(model::Object const& model, Patcher & patcher) + { + return std::make_unique(model, patcher); + } + + GateTilde::GateTilde(model::Object const& model, Patcher& patcher) : + AudioObject(model, patcher), + m_opened_output(), + m_num_outputs(model.getArguments()[0].getInt()) + { + std::vector const& args = model.getArguments(); + + if (args.size() > 1) + { + openOutput(args[1].getInt()); + } + } + + void GateTilde::openOutput(int output) + { + m_opened_output = std::max(0, std::min(output, static_cast(m_num_outputs))); + } + + void GateTilde::receive(size_t index, std::vector const& args) + { + if (args.size() > 0) + { + if (index == 0) + { + if (args[0].isNumber()) + { + openOutput(args[0].getInt()); + } + else + { + warning("gate~ inlet 1 receives only numbers"); + } + } + } + } + + void GateTilde::prepare(PrepareInfo const& infos) + { + if (infos.inputs[0]) + { + setPerformCallBack(this, &GateTilde::performSig); + } + else + { + setPerformCallBack(this, &GateTilde::performValue); + } + } + + void GateTilde::performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept + { + size_t output_number = output.getNumberOfChannels(); + + for(size_t outlet = 0; outlet < output_number; ++outlet) + { + output[outlet].fill(0); + } + + if (m_opened_output != 0) + { + output[m_opened_output - 1].copy(input[1]); + } + } + + void GateTilde::performSig(dsp::Buffer const& input, dsp::Buffer& output) noexcept + { + dsp::sample_t const * route_signal = input[0].data(); + dsp::sample_t const * input_signal = input[1].data(); + size_t sample_index = input[0ul].size(); + size_t output_number = output.getNumberOfChannels(); + size_t opened_output = 0; + + for(size_t outlet = 0; outlet < output_number; ++outlet) + { + output[outlet].fill(0); + } + + while(sample_index--) + { + opened_output = std::max((size_t) 0, std::min(m_num_outputs, (size_t) route_signal[sample_index])); + + if (opened_output) + { + output[opened_output - 1][sample_index] = input_signal[sample_index]; + } + } + } + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.h new file mode 100644 index 00000000..a9f94995 --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.h @@ -0,0 +1,62 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // GATE~ // + // ================================================================================ // + + class GateTilde : public AudioObject + { + public: + + static void declare(); + + static std::unique_ptr create(model::Object const& model, Patcher & patcher); + + GateTilde(model::Object const& model, Patcher& patcher); + + void receive(size_t index, std::vector const& args) override final; + + void prepare(PrepareInfo const& infos) override final; + + void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept; + + void performSig(dsp::Buffer const& input, dsp::Buffer& output) noexcept; + + private: + + void openOutput(int output); + + private: + + size_t m_opened_output; + size_t m_num_outputs; + }; + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h index 02dec864..77c0a913 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h @@ -79,4 +79,5 @@ #include #include #include -#include +#include +#include diff --git a/Modules/KiwiModel/KiwiModel_DataModel.cpp b/Modules/KiwiModel/KiwiModel_DataModel.cpp index 9fb0933c..64696874 100644 --- a/Modules/KiwiModel/KiwiModel_DataModel.cpp +++ b/Modules/KiwiModel/KiwiModel_DataModel.cpp @@ -91,7 +91,8 @@ namespace kiwi model::Mtof::declare(); model::Send::declare(); model::Gate::declare(); - model::Switch::declare(); + model::Switch::declare(); + model::GateTilde::declare(); } void DataModel::init(std::function declare_object) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.cpp new file mode 100755 index 00000000..b3acf3be --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.cpp @@ -0,0 +1,105 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // GATE~ // + // ================================================================================ // + + void GateTilde::declare() + { + std::unique_ptr gatetilde_class(new ObjectClass("gate~", &GateTilde::create)); + + flip::Class & gatetilde_model = DataModel::declare() + .name(gatetilde_class->getModelName().c_str()) + .inherit(); + + Factory::add(std::move(gatetilde_class), gatetilde_model); + } + + std::unique_ptr GateTilde::create(std::vector const& args) + { + return std::make_unique(args); + } + + GateTilde::GateTilde(std::vector const& args) + { + if (args.size() <= 0) + throw Error("gate~ number of gates must be specified"); + + if (args.size() > 2) + throw Error("gate~ takes at most 2 arguments"); + + if (args.size() > 1 && !args[1].isNumber()) + throw Error("gate~ 2nd argument must be a number"); + + if (args.size() > 0) + { + if (!args[0].isInt()) + { + throw Error("gate~ 1rst argument must be an integer"); + } + else if(args[0].getInt() < 0) + { + throw Error("gate~ 1rst argument must be greater than 0"); + } + } + + pushInlet({PinType::IType::Control, PinType::IType::Signal}); + pushInlet({PinType::IType::Signal}); + + for(int outlet = 0; outlet < args[0].getInt(); ++outlet) + { + pushOutlet(PinType::IType::Signal); + } + } + + std::string GateTilde::getIODescription(bool is_inlet, size_t index) const + { + std::string description = ""; + + if (is_inlet) + { + if (index == 0) + { + description = "Int Open/Close output"; + } + else if(index == 1) + { + description = "Sends signal to opened output"; + } + } + else + { + description = "Output " + std::to_string(index) + " receives signal if opened"; + } + + return description; + } + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.h new file mode 100755 index 00000000..4ab18aa5 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.h @@ -0,0 +1,47 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // GATE~ // + // ================================================================================ // + + class GateTilde : public model::Object + { + public: + + static void declare(); + + static std::unique_ptr create(std::vector const& args); + + GateTilde(flip::Default& d) : model::Object(d) {} + + GateTilde(std::vector const& args); + + std::string getIODescription(bool is_inlet, size_t index) const override; + }; + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h index e021813e..ebf6c495 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h @@ -79,4 +79,5 @@ #include #include #include -#include +#include +#include From 7e65329a7a55e8a874d1660bcca0ad2be7de5c13 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Mon, 19 Mar 2018 16:57:07 +0100 Subject: [PATCH 09/35] Add object switch~. --- Client/Source/KiwiApp.cpp | 3 +- .../KiwiEngine_Objects/KiwiEngine_Objects.h | 1 + .../KiwiEngine_SwitchTilde.cpp | 117 ++++++++++++++++++ .../KiwiEngine_SwitchTilde.h | 62 ++++++++++ Modules/KiwiModel/KiwiModel_DataModel.cpp | 3 +- .../KiwiModel_Objects/KiwiModel_Objects.h | 3 +- .../KiwiModel_SwitchTilde.cpp | 108 ++++++++++++++++ .../KiwiModel_Objects/KiwiModel_SwitchTilde.h | 47 +++++++ 8 files changed, 341 insertions(+), 3 deletions(-) create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.cpp create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.h create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.cpp create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.h diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index c716d42e..4ab7b121 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -208,7 +208,8 @@ namespace kiwi engine::Send::declare(); engine::Gate::declare(); engine::Switch::declare(); - engine::GateTilde::declare(); + engine::GateTilde::declare(); + engine::SwitchTilde::declare(); } void KiwiApp::declareObjectViews() diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h index 77c0a913..ecd43b79 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h @@ -81,3 +81,4 @@ #include #include #include +#include diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.cpp new file mode 100644 index 00000000..45e98825 --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.cpp @@ -0,0 +1,117 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // SWITCH~ // + // ================================================================================ // + + void SwitchTilde::declare() + { + Factory::add("switch~", &SwitchTilde::create); + } + + std::unique_ptr SwitchTilde::create(model::Object const& model, Patcher & patcher) + { + return std::make_unique(model, patcher); + } + + SwitchTilde::SwitchTilde(model::Object const& model, Patcher& patcher) : + AudioObject(model, patcher), + m_opened_input(), + m_num_inputs(model.getArguments()[0].getInt()) + { + std::vector const& args = model.getArguments(); + + if (args.size() > 1) + { + openInput(args[1].getInt()); + } + } + + void SwitchTilde::openInput(int input) + { + m_opened_input = std::max(0, std::min(input, static_cast(m_num_inputs))); + } + + void SwitchTilde::receive(size_t index, std::vector const& args) + { + if (args.size() > 0) + { + if (index == 0) + { + if (args[0].isNumber()) + { + openInput(args[0].getInt()); + } + else + { + warning("switch~ inlet 1 receives only numbers"); + } + } + } + } + + void SwitchTilde::prepare(PrepareInfo const& infos) + { + if (infos.inputs[0]) + { + setPerformCallBack(this, &SwitchTilde::performSig); + } + else + { + setPerformCallBack(this, &SwitchTilde::performValue); + } + } + + void SwitchTilde::performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept + { + if (m_opened_input != 0) + { + output[0].copy(input[m_opened_input]); + } + else + { + output[0].fill(0); + } + } + + void SwitchTilde::performSig(dsp::Buffer const& input, dsp::Buffer& output) noexcept + { + dsp::sample_t const * route_signal = input[0].data(); + dsp::sample_t * output_signal = output[0].data(); + size_t sample_index = output[0ul].size(); + size_t opened_input = 0; + + while(sample_index--) + { + opened_input = std::max((size_t) 0, std::min(m_num_inputs, (size_t) route_signal[sample_index])); + + output_signal[sample_index] = opened_input ? input[opened_input][sample_index] : 0; + } + } + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.h new file mode 100644 index 00000000..f41b4b08 --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.h @@ -0,0 +1,62 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // SWITCH~ // + // ================================================================================ // + + class SwitchTilde : public AudioObject + { + public: + + static void declare(); + + static std::unique_ptr create(model::Object const& model, Patcher & patcher); + + SwitchTilde(model::Object const& model, Patcher& patcher); + + void receive(size_t index, std::vector const& args) override final; + + void prepare(PrepareInfo const& infos) override final; + + void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept; + + void performSig(dsp::Buffer const& input, dsp::Buffer& output) noexcept; + + private: + + void openInput(int input); + + private: + + size_t m_opened_input; + size_t m_num_inputs; + }; + +}} diff --git a/Modules/KiwiModel/KiwiModel_DataModel.cpp b/Modules/KiwiModel/KiwiModel_DataModel.cpp index 64696874..9b4c89eb 100644 --- a/Modules/KiwiModel/KiwiModel_DataModel.cpp +++ b/Modules/KiwiModel/KiwiModel_DataModel.cpp @@ -92,7 +92,8 @@ namespace kiwi model::Send::declare(); model::Gate::declare(); model::Switch::declare(); - model::GateTilde::declare(); + model::GateTilde::declare(); + model::SwitchTilde::declare(); } void DataModel::init(std::function declare_object) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h index ebf6c495..11c546cd 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h @@ -80,4 +80,5 @@ #include #include #include -#include +#include +#include diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.cpp new file mode 100755 index 00000000..c1f768f4 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.cpp @@ -0,0 +1,108 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // SWITCH~ // + // ================================================================================ // + + void SwitchTilde::declare() + { + std::unique_ptr switchtilde_class(new ObjectClass("switch~", &SwitchTilde::create)); + + flip::Class & switchtilde_model = DataModel::declare() + .name(switchtilde_class->getModelName().c_str()) + .inherit(); + + Factory::add(std::move(switchtilde_class), switchtilde_model); + } + + std::unique_ptr SwitchTilde::create(std::vector const& args) + { + return std::make_unique(args); + } + + SwitchTilde::SwitchTilde(std::vector const& args) + { + if (args.size() <= 0) + throw Error("switch~ number of inputs must be specified"); + + if (args.size() > 2) + throw Error("switch~ takes at most 2 arguments"); + + if (args.size() > 1 && !args[1].isNumber()) + throw Error("switch~ 2nd argument must be a number"); + + if (args.size() > 0) + { + if (!args[0].isInt()) + { + throw Error("switch~ 1rst argument must be an integer"); + } + else if(args[0].getInt() < 0) + { + throw Error("switch~ 1rst argument must be greater than 0"); + } + } + + pushInlet({PinType::IType::Control, PinType::IType::Signal}); + pushOutlet(PinType::IType::Signal); + + for(int inlet = 0; inlet < args[0].getInt(); ++inlet) + { + pushInlet({PinType::IType::Signal}); + } + } + + std::string SwitchTilde::getIODescription(bool is_inlet, size_t index) const + { + std::string description = ""; + + if (is_inlet) + { + if (index == 0) + { + description = "Int Open/Close input"; + } + else + { + description = "Input " + std::to_string(index) + " sends signal if opened"; + } + } + else + { + if (index == 0) + { + description = "Output sends signal from opened input"; + } + } + + return description; + } + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.h new file mode 100755 index 00000000..e4895c96 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.h @@ -0,0 +1,47 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // SWITCH~ // + // ================================================================================ // + + class SwitchTilde : public model::Object + { + public: + + static void declare(); + + static std::unique_ptr create(std::vector const& args); + + SwitchTilde(flip::Default& d) : model::Object(d) {} + + SwitchTilde(std::vector const& args); + + std::string getIODescription(bool is_inlet, size_t index) const override; + }; + +}} From 2dfce234c8beb616df0460fd7f74cf766307f123 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Wed, 21 Mar 2018 15:30:15 +0100 Subject: [PATCH 10/35] Object float. --- Client/Source/KiwiApp.cpp | 3 +- .../KiwiEngine_Objects/KiwiEngine_Float.cpp | 88 ++++++++++++++++++ .../KiwiEngine_Objects/KiwiEngine_Float.h | 48 ++++++++++ .../KiwiEngine_Objects/KiwiEngine_Objects.h | 1 + Modules/KiwiModel/KiwiModel_DataModel.cpp | 3 +- .../KiwiModel_Objects/KiwiModel_Float.cpp | 91 +++++++++++++++++++ .../KiwiModel_Objects/KiwiModel_Float.h | 47 ++++++++++ .../KiwiModel_Objects/KiwiModel_Objects.h | 3 +- 8 files changed, 281 insertions(+), 3 deletions(-) create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.cpp create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.h create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.cpp create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.h diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index 4ab7b121..7e792982 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -209,7 +209,8 @@ namespace kiwi engine::Gate::declare(); engine::Switch::declare(); engine::GateTilde::declare(); - engine::SwitchTilde::declare(); + engine::SwitchTilde::declare(); + engine::Float::declare(); } void KiwiApp::declareObjectViews() diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.cpp new file mode 100644 index 00000000..a595897a --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.cpp @@ -0,0 +1,88 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // FLOAT // + // ================================================================================ // + + void Float::declare() + { + Factory::add("float", &Float::create); + } + + std::unique_ptr Float::create(model::Object const& model, Patcher & patcher) + { + return std::make_unique(model, patcher); + } + + Float::Float(model::Object const& model, Patcher& patcher): + Object(model, patcher), + m_stored_value() + { + std::vector const& args = model.getArguments(); + + if (args.size() > 0 && args[0].isNumber()) + { + m_stored_value = args[0].getFloat(); + } + } + + void Float::receive(size_t index, std::vector const& args) + { + if (!args.empty()) + { + if (index == 0) + { + if (args[0].isNumber()) + { + m_stored_value = args[0].getFloat(); + send(0, {m_stored_value}); + } + else if(args[0].isBang()) + { + send(0, {m_stored_value}); + } + else + { + warning("float inlet 1 only understand numbers"); + } + } + else if(index == 1) + { + if (args[0].isNumber()) + { + m_stored_value = args[0].getFloat(); + } + else + { + warning("float inlet 2 only understand numbers"); + } + } + } + } + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.h new file mode 100644 index 00000000..90f0c902 --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.h @@ -0,0 +1,48 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // FLOAT // + // ================================================================================ // + + class Float : public Object + { + public: + + static void declare(); + + static std::unique_ptr create(model::Object const& model, Patcher& patcher); + + Float(model::Object const& model, Patcher& patcher); + + void receive(size_t index, std::vector const& args) override final; + + private: + + double m_stored_value; + }; +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h index ecd43b79..b964544c 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h @@ -82,3 +82,4 @@ #include #include #include +#include diff --git a/Modules/KiwiModel/KiwiModel_DataModel.cpp b/Modules/KiwiModel/KiwiModel_DataModel.cpp index 9b4c89eb..87da205e 100644 --- a/Modules/KiwiModel/KiwiModel_DataModel.cpp +++ b/Modules/KiwiModel/KiwiModel_DataModel.cpp @@ -93,7 +93,8 @@ namespace kiwi model::Gate::declare(); model::Switch::declare(); model::GateTilde::declare(); - model::SwitchTilde::declare(); + model::SwitchTilde::declare(); + model::Float::declare(); } void DataModel::init(std::function declare_object) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.cpp new file mode 100755 index 00000000..1df86c58 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.cpp @@ -0,0 +1,91 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // FLOAT // + // ================================================================================ // + + void Float::declare() + { + std::unique_ptr float_class(new ObjectClass("float", + &Float::create)); + + float_class->addAlias("f"); + + flip::Class & float_model = DataModel::declare() + .name(float_class->getModelName().c_str()) + .inherit(); + + Factory::add(std::move(float_class), float_model); + } + + std::unique_ptr Float::create(std::vector const& args) + { + return std::make_unique(args); + } + + Float::Float(std::vector const& args) + { + if (args.size() > 1) + throw Error("float only take one argument"); + + if (args.size() > 0 && !args[0].isNumber()) + throw Error("float initial value must be a number"); + + pushInlet({PinType::IType::Control}); + pushInlet({PinType::IType::Control}); + + pushOutlet(PinType::IType::Control); + } + + std::string Float::getIODescription(bool is_inlet, size_t index) const + { + std::string description = ""; + + if (is_inlet) + { + if (index == 0) + { + description = "Store and output value. Bang to ouput"; + } + else if(index == 1) + { + description = "Store value without output"; + } + } + else + { + if (index == 0) + { + description = "Ouput stored value"; + } + } + + return description; + } + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.h new file mode 100755 index 00000000..982bcb1d --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.h @@ -0,0 +1,47 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // FLOAT // + // ================================================================================ // + + class Float : public Object + { + public: + + Float(flip::Default& d) : Object(d) {} + + Float(std::vector const& args); + + static void declare(); + + static std::unique_ptr create(std::vector const& args); + + std::string getIODescription(bool is_inlet, size_t index) const override; + }; + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h index 11c546cd..b4b427b7 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h @@ -81,4 +81,5 @@ #include #include #include -#include +#include +#include From d3391a146f312e436258ef67e723394a3a32ca7f Mon Sep 17 00:00:00 2001 From: jean-millot Date: Wed, 21 Mar 2018 17:16:16 +0100 Subject: [PATCH 11/35] Object clip~. --- Client/Source/KiwiApp.cpp | 3 +- .../KiwiEngine_ClipTilde.cpp | 169 ++++++++++++++++++ .../KiwiEngine_Objects/KiwiEngine_ClipTilde.h | 62 +++++++ .../KiwiEngine_Objects/KiwiEngine_Objects.h | 1 + Modules/KiwiModel/KiwiModel_DataModel.cpp | 3 +- .../KiwiModel_Objects/KiwiModel_ClipTilde.cpp | 93 ++++++++++ .../KiwiModel_Objects/KiwiModel_ClipTilde.h | 47 +++++ .../KiwiModel_Objects/KiwiModel_Objects.h | 3 +- 8 files changed, 378 insertions(+), 3 deletions(-) create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.cpp create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.h create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.cpp create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.h diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index 7e792982..1cb2ac85 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -210,7 +210,8 @@ namespace kiwi engine::Switch::declare(); engine::GateTilde::declare(); engine::SwitchTilde::declare(); - engine::Float::declare(); + engine::Float::declare(); + engine::ClipTilde::declare(); } void KiwiApp::declareObjectViews() diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.cpp new file mode 100644 index 00000000..4d05592e --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.cpp @@ -0,0 +1,169 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // CLIP~ // + // ================================================================================ // + + void ClipTilde::declare() + { + Factory::add("clip~", &ClipTilde::create); + } + + std::unique_ptr ClipTilde::create(model::Object const& model, Patcher & patcher) + { + return std::make_unique(model, patcher); + } + + ClipTilde::ClipTilde(model::Object const& model, Patcher& patcher): + AudioObject(model, patcher), + m_minimum(0.), + m_maximum(0.) + { + std::vector const& args = model.getArguments(); + + if (args.size() > 0) + { + m_minimum.store(args[0].getFloat()); + + if (args.size() > 1) + { + m_maximum.store(args[1].getFloat()); + } + } + } + + void ClipTilde::receive(size_t index, std::vector const& args) + { + if (!args.empty()) + { + if (index == 1) + { + if (args[0].isNumber()) + { + m_minimum.store(args[0].getFloat()); + + if (m_minimum.load() > m_maximum.load()) + { + warning("clip~ minimum is higher than maximum"); + } + } + else + { + warning("clip~ inlet 2 only take numbers"); + } + } + else if(index == 2) + { + if (args[0].isNumber()) + { + m_maximum.store(args[0].getFloat()); + + if (m_minimum.load() > m_maximum.load()) + { + warning("clip~ maximum is lower than minimum"); + } + } + else + { + warning("clip~ inlet 3 only take numbers"); + } + } + } + } + + void ClipTilde::prepare(dsp::Processor::PrepareInfo const& infos) + { + if (infos.inputs[1] && infos.inputs[2]) + { + setPerformCallBack(this, &ClipTilde::performMinMax); + } + else if(infos.inputs[2]) + { + setPerformCallBack(this, &ClipTilde::performMax); + } + else if(infos.inputs[1]) + { + setPerformCallBack(this, &ClipTilde::performMin); + } + else + { + setPerformCallBack(this, &ClipTilde::perform); + } + } + + void ClipTilde::perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept + { + dsp::sample_t *output_data = output[0ul].data(); + dsp::sample_t const *input_data = input[0].data(); + size_t sample_index = output[0ul].size(); + + while(sample_index--) + { + *output_data++ = std::max(m_minimum.load(), std::min(*input_data++, m_maximum.load())); + } + } + + void ClipTilde::performMinMax(dsp::Buffer const& input, dsp::Buffer& output) noexcept + { + dsp::sample_t *output_data = output[0ul].data(); + dsp::sample_t const *input_data = input[0].data(); + dsp::sample_t const *input_min = input[1].data(); + dsp::sample_t const *input_max = input[2].data(); + size_t sample_index = output[0ul].size(); + + while(sample_index--) + { + *output_data++ = std::max(*input_min++, std::min(*input_data++, *input_max++)); + } + } + + void ClipTilde::performMin(dsp::Buffer const& input, dsp::Buffer& output) noexcept + { + dsp::sample_t *output_data = output[0ul].data(); + dsp::sample_t const *input_data = input[0].data(); + dsp::sample_t const *input_min = input[1].data(); + size_t sample_index = output[0ul].size(); + + while(sample_index--) + { + *output_data++ = std::max(*input_min++, std::min(*input_data++, m_maximum.load())); + } + } + + void ClipTilde::performMax(dsp::Buffer const& input, dsp::Buffer& output) noexcept + { + dsp::sample_t *output_data = output[0ul].data(); + dsp::sample_t const *input_data = input[0].data(); + dsp::sample_t const *input_max = input[2].data(); + size_t sample_index = output[0ul].size(); + + while(sample_index--) + { + *output_data++ = std::max(m_minimum.load(), std::min(*input_data++, *input_max++)); + } + } +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.h new file mode 100644 index 00000000..49fb0f78 --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.h @@ -0,0 +1,62 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // CLIP~ // + // ================================================================================ // + + class ClipTilde : public AudioObject + { + public: // methods + + static void declare(); + + static std::unique_ptr create(model::Object const& model, Patcher & patcher); + + ClipTilde(model::Object const& model, Patcher& patcher); + + void receive(size_t index, std::vector const& args) override final; + + void prepare(dsp::Processor::PrepareInfo const& infos) override final; + + void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept; + + void performMinMax(dsp::Buffer const& input, dsp::Buffer& output) noexcept; + + void performMin(dsp::Buffer const& input, dsp::Buffer& output) noexcept; + + void performMax(dsp::Buffer const& input, dsp::Buffer& output) noexcept; + + private: // methods + + std::atomic m_minimum; + std::atomic m_maximum; + }; + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h index b964544c..88413505 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h @@ -83,3 +83,4 @@ #include #include #include +#include diff --git a/Modules/KiwiModel/KiwiModel_DataModel.cpp b/Modules/KiwiModel/KiwiModel_DataModel.cpp index 87da205e..e6930cdc 100644 --- a/Modules/KiwiModel/KiwiModel_DataModel.cpp +++ b/Modules/KiwiModel/KiwiModel_DataModel.cpp @@ -94,7 +94,8 @@ namespace kiwi model::Switch::declare(); model::GateTilde::declare(); model::SwitchTilde::declare(); - model::Float::declare(); + model::Float::declare(); + model::ClipTilde::declare(); } void DataModel::init(std::function declare_object) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.cpp new file mode 100755 index 00000000..b1a0fc54 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.cpp @@ -0,0 +1,93 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // CLIP~ // + // ================================================================================ // + + void ClipTilde::declare() + { + std::unique_ptr cliptilde_class(new ObjectClass("clip~", &ClipTilde::create)); + + flip::Class & cliptilde_model = DataModel::declare() + .name(cliptilde_class->getModelName().c_str()) + .inherit(); + + Factory::add(std::move(cliptilde_class), cliptilde_model); + } + + std::unique_ptr ClipTilde::create(std::vector const& args) + { + return std::make_unique(args); + } + + ClipTilde::ClipTilde(std::vector const& args): + Object() + { + if (args.size() > 2) + throw Error("clip~ only takes two arguments"); + + if (args.size() > 1 && !args[1].isNumber()) + throw Error("clip~ maximum must be a number"); + + if(args.size() > 0 && !args[0].isNumber()) + throw Error("clip~ minimum value must be a number"); + + pushInlet({PinType::IType::Signal}); + pushInlet({PinType::IType::Signal, PinType::IType::Control}); + pushInlet({PinType::IType::Signal, PinType::IType::Control}); + + pushOutlet(PinType::IType::Signal); + } + + std::string ClipTilde::getIODescription(bool is_inlet, size_t index) const + { + std::string description = ""; + + if (is_inlet) + { + if (index == 0) + { + description = "clipped input"; + } + else if (index == 1) + { + description = "signal or float, minimum value"; + } + else if(index == 2) + { + description = "signal or float, maximum value"; + } + } + else + { + description = "clipped signal"; + } + + return description; + } + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.h new file mode 100755 index 00000000..ffa70efe --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.h @@ -0,0 +1,47 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // CLIP~ // + // ================================================================================ // + + class ClipTilde : public Object + { + public: + + static void declare(); + + static std::unique_ptr create(std::vector const& args); + + ClipTilde(flip::Default& d): Object(d){}; + + ClipTilde(std::vector const& args); + + std::string getIODescription(bool is_inlet, size_t index) const override; + }; + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h index b4b427b7..70c7bb58 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h @@ -82,4 +82,5 @@ #include #include #include -#include +#include +#include From cf26683b7c0e3274d44a251bb8cd791e72ce5dce Mon Sep 17 00:00:00 2001 From: jean-millot Date: Wed, 21 Mar 2018 17:53:13 +0100 Subject: [PATCH 12/35] Object clip. --- Client/Source/KiwiApp.cpp | 3 +- .../KiwiEngine_Objects/KiwiEngine_Clip.cpp | 108 ++++++++++++++++++ .../KiwiEngine_Objects/KiwiEngine_Clip.h | 52 +++++++++ .../KiwiEngine_Objects/KiwiEngine_Objects.h | 1 + Modules/KiwiModel/KiwiModel_DataModel.cpp | 3 +- .../KiwiModel_Objects/KiwiModel_Clip.cpp | 93 +++++++++++++++ .../KiwiModel_Objects/KiwiModel_Clip.h | 47 ++++++++ .../KiwiModel_Objects/KiwiModel_Objects.h | 3 +- 8 files changed, 307 insertions(+), 3 deletions(-) create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.cpp create mode 100644 Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.h create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.cpp create mode 100755 Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.h diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index 1cb2ac85..30c2b39b 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -211,7 +211,8 @@ namespace kiwi engine::GateTilde::declare(); engine::SwitchTilde::declare(); engine::Float::declare(); - engine::ClipTilde::declare(); + engine::ClipTilde::declare(); + engine::Clip::declare(); } void KiwiApp::declareObjectViews() diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.cpp new file mode 100644 index 00000000..2089f781 --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.cpp @@ -0,0 +1,108 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // CLIP~ // + // ================================================================================ // + + void Clip::declare() + { + Factory::add("clip", &Clip::create); + } + + std::unique_ptr Clip::create(model::Object const& model, Patcher & patcher) + { + return std::make_unique(model, patcher); + } + + Clip::Clip(model::Object const& model, Patcher& patcher): + Object(model, patcher), + m_minimum(0.), + m_maximum(0.) + { + std::vector const& args = model.getArguments(); + + if (args.size() > 0) + { + m_minimum = args[0].getFloat(); + + if (args.size() > 1) + { + m_maximum = args[1].getFloat(); + } + } + } + + void Clip::receive(size_t index, std::vector const& args) + { + if (!args.empty()) + { + if (index == 0) + { + if (args[0].isNumber()) + { + send(0, {std::max(m_minimum, std::min(args[0].getFloat(), m_maximum))}); + } + else + { + warning("clip inlet 1 only takes numbers"); + } + } + else if (index == 1) + { + if (args[0].isNumber()) + { + m_minimum = args[0].getFloat(); + + if (m_minimum > m_maximum) + { + warning("clip minimum is higher than maximum"); + } + } + else + { + warning("clip inlet 2 only takes numbers"); + } + } + else if(index == 2) + { + if (args[0].isNumber()) + { + m_maximum = args[0].getFloat(); + + if (m_minimum > m_maximum) + { + warning("clip maximum is lower than minimum"); + } + } + else + { + warning("clip inlet 3 only takes numbers"); + } + } + } + } +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.h new file mode 100644 index 00000000..89cb24ba --- /dev/null +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.h @@ -0,0 +1,52 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +#include + +namespace kiwi { namespace engine { + + // ================================================================================ // + // CLIP // + // ================================================================================ // + + class Clip : public Object + { + public: // methods + + static void declare(); + + static std::unique_ptr create(model::Object const& model, Patcher & patcher); + + Clip(model::Object const& model, Patcher& patcher); + + void receive(size_t index, std::vector const& args) override final; + + private: // methods + + double m_minimum; + double m_maximum; + }; + +}} diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h index 88413505..cb719e42 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h @@ -84,3 +84,4 @@ #include #include #include +#include diff --git a/Modules/KiwiModel/KiwiModel_DataModel.cpp b/Modules/KiwiModel/KiwiModel_DataModel.cpp index e6930cdc..9e82d92b 100644 --- a/Modules/KiwiModel/KiwiModel_DataModel.cpp +++ b/Modules/KiwiModel/KiwiModel_DataModel.cpp @@ -95,7 +95,8 @@ namespace kiwi model::GateTilde::declare(); model::SwitchTilde::declare(); model::Float::declare(); - model::ClipTilde::declare(); + model::ClipTilde::declare(); + model::Clip::declare(); } void DataModel::init(std::function declare_object) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.cpp new file mode 100755 index 00000000..6574537c --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.cpp @@ -0,0 +1,93 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#include +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // CLIP // + // ================================================================================ // + + void Clip::declare() + { + std::unique_ptr clip_class(new ObjectClass("clip", &Clip::create)); + + flip::Class & clip_model = DataModel::declare() + .name(clip_class->getModelName().c_str()) + .inherit(); + + Factory::add(std::move(clip_class), clip_model); + } + + std::unique_ptr Clip::create(std::vector const& args) + { + return std::make_unique(args); + } + + Clip::Clip(std::vector const& args): + Object() + { + if (args.size() > 2) + throw Error("clip only takes two arguments"); + + if (args.size() > 1 && !args[1].isNumber()) + throw Error("clip maximum must be a number"); + + if(args.size() > 0 && !args[0].isNumber()) + throw Error("clip minimum value must be a number"); + + pushInlet({PinType::IType::Control}); + pushInlet({PinType::IType::Control}); + pushInlet({PinType::IType::Control}); + + pushOutlet(PinType::IType::Control); + } + + std::string Clip::getIODescription(bool is_inlet, size_t index) const + { + std::string description = ""; + + if (is_inlet) + { + if (index == 0) + { + description = "float to be clipped"; + } + else if (index == 1) + { + description = "float minimum value"; + } + else if(index == 2) + { + description = "float maximum value"; + } + } + else + { + description = "clipped values"; + } + + return description; + } + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.h new file mode 100755 index 00000000..d347a714 --- /dev/null +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.h @@ -0,0 +1,47 @@ +/* + ============================================================================== + + This file is part of the KIWI library. + - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris. + - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot. + + Permission is granted to use this software under the terms of the GPL v3 + (or any later version). Details can be found at: www.gnu.org/licenses + + KIWI is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + ------------------------------------------------------------------------------ + + Contact : cicm.mshparisnord@gmail.com + + ============================================================================== + */ + +#pragma once + +#include + +namespace kiwi { namespace model { + + // ================================================================================ // + // CLIP // + // ================================================================================ // + + class Clip : public Object + { + public: + + static void declare(); + + static std::unique_ptr create(std::vector const& args); + + Clip(flip::Default& d): Object(d){}; + + Clip(std::vector const& args); + + std::string getIODescription(bool is_inlet, size_t index) const override; + }; + +}} diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h index 70c7bb58..4de18ba2 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h @@ -83,4 +83,5 @@ #include #include #include -#include +#include +#include From bda47a682536b8af8995f3016a9adabdecb5055b Mon Sep 17 00:00:00 2001 From: jean-millot Date: Fri, 23 Mar 2018 14:46:10 +0100 Subject: [PATCH 13/35] Pack left inlet is hot. --- .../KiwiEngine_Objects/KiwiEngine_Pack.cpp | 66 ++++++++++++++----- .../KiwiEngine_Objects/KiwiEngine_Pack.h | 2 + 2 files changed, 50 insertions(+), 18 deletions(-) diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.cpp index c33f333e..5faf8a44 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.cpp +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.cpp @@ -49,35 +49,65 @@ namespace kiwi { namespace engine { send(0, m_list); } + void Pack::setElement(size_t index, tool::Atom const& atom) + { + switch (m_list[index].getType()) + { + case tool::Atom::Type::Float: + { + m_list[index] = atom.getFloat(); + break; + } + case tool::Atom::Type::Int: + { + m_list[index] = atom.getInt(); + break; + } + case tool::Atom::Type::String: + { + m_list[index] = atom.getString(); + break; + } + default: break; + } + + } + void Pack::receive(size_t index, std::vector const& args) { - const bool is_bang = args[0].isBang(); - if (!is_bang) + if (!args.empty()) { - switch (m_list[index].getType()) + if (index == 0) { - case tool::Atom::Type::Float: + if (args[0].isBang()) { - m_list[index] = args[0].getFloat(); - break; + output_list(); } - case tool::Atom::Type::Int: + else if (args[0].isString() + && args[0].getString() == "set" + && args.size() > 1) { - m_list[index] = args[0].getInt(); - break; + setElement(index, args[1]); } - case tool::Atom::Type::String: + else { - m_list[index] = args[0].getString(); - break; + setElement(index, args[0]); + output_list(); + } + } + else + { + if (args[0].isString() + && args[0].getString() == "set" + && args.size() > 1) + { + setElement(index, args[1]); + } + else + { + setElement(index, args[0]); } - default: break; } - } - - if (index == 0 && is_bang) - { - output_list(); } } diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.h b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.h index b42a08bd..aa8a9df9 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.h +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.h @@ -41,6 +41,8 @@ namespace kiwi { namespace engine { ~Pack() = default; + void setElement(size_t index, tool::Atom const& atom); + void receive(size_t index, std::vector const& args) override; private: From c5ecf7aff6ada4f1a726e285593831d4bb78a214 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Mon, 26 Mar 2018 11:35:39 +0200 Subject: [PATCH 14/35] osc~ take frequency into account when phase is controlled by signal. --- .../KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.cpp | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.cpp index 4297626f..a75da5e0 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.cpp +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.cpp @@ -149,11 +149,15 @@ namespace kiwi { namespace engine { dsp::sample_t* output_sig = output[0ul].data(); size_t sample_index = output[0ul].size(); dsp::sample_t const* phase = input[1ul].data(); + dsp::sample_t const time_inc = m_freq/m_sr; while(sample_index--) { - *output_sig++ = std::cos(2.f * dsp::pi * fmodf(*phase++, 1.f)); + *output_sig++ = std::cos(2.f * dsp::pi * (m_time + fmodf(*phase++, 1.f))); + m_time += time_inc; } + + m_time = fmodf(m_time, 1.f); } void OscTilde::performPhaseAndFreq(dsp::Buffer const& input, dsp::Buffer& output) noexcept From f1b3a8409c569b0421f6c43a26d97439787613d1 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Mon, 26 Mar 2018 11:50:04 +0200 Subject: [PATCH 15/35] Bump kiwi model version. --- Modules/KiwiModel/KiwiModel_Converters/KiwiModel_Converter.cpp | 2 +- Modules/KiwiModel/KiwiModel_Def.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Modules/KiwiModel/KiwiModel_Converters/KiwiModel_Converter.cpp b/Modules/KiwiModel/KiwiModel_Converters/KiwiModel_Converter.cpp index 72ae4bfe..355bf162 100755 --- a/Modules/KiwiModel/KiwiModel_Converters/KiwiModel_Converter.cpp +++ b/Modules/KiwiModel/KiwiModel_Converters/KiwiModel_Converter.cpp @@ -58,7 +58,7 @@ namespace kiwi { namespace model { convert_v1_v2(backend); } - if (backend.version.compare("v2") == 0) + if (backend.version.compare("v2") == 0 || backend.version.compare("v3") == 0) { success = true; } diff --git a/Modules/KiwiModel/KiwiModel_Def.h b/Modules/KiwiModel/KiwiModel_Def.h index 49915e86..e78c0eac 100644 --- a/Modules/KiwiModel/KiwiModel_Def.h +++ b/Modules/KiwiModel/KiwiModel_Def.h @@ -21,4 +21,4 @@ #pragma once -#define KIWI_MODEL_VERSION_STRING "v2" +#define KIWI_MODEL_VERSION_STRING "v3" From b15d92ae3718868c236b512c59ed3c6952acdd54 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 29 Mar 2018 11:44:37 +0200 Subject: [PATCH 16/35] Fix comment label justification. --- .../KiwiApp_Objects/KiwiApp_CommentView.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_CommentView.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_CommentView.cpp index e6f27c81..5fc49a66 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_CommentView.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_CommentView.cpp @@ -45,7 +45,9 @@ namespace kiwi { { setColour(ObjectView::ColourIds::Background, juce::Colours::transparentWhite); - juce::Label & label = getLabel(); + juce::Label & label = getLabel(); + + label.setJustificationType(juce::Justification::topLeft); label.setText(object_model.getAttribute("text")[0].getString(), juce::NotificationType::dontSendNotification); @@ -105,7 +107,8 @@ namespace kiwi { juce::TextEditor * editor = new juce::TextEditor(); editor->setBounds(getLocalBounds()); - editor->setBorder(juce::BorderSize(0)); + editor->setBorder(juce::BorderSize(0)); + editor->setFont(getLabel().getFont()); editor->setColour(juce::TextEditor::ColourIds::textColourId, From 33ce31dc7336e8187c3673edc4263ba921ae31fe Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 29 Mar 2018 12:32:09 +0200 Subject: [PATCH 17/35] Remove unused member in model::Object. --- Modules/KiwiModel/KiwiModel_Object.cpp | 3 +-- Modules/KiwiModel/KiwiModel_Object.h | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/Modules/KiwiModel/KiwiModel_Object.cpp b/Modules/KiwiModel/KiwiModel_Object.cpp index 4586b4a2..3c33ce7b 100755 --- a/Modules/KiwiModel/KiwiModel_Object.cpp +++ b/Modules/KiwiModel/KiwiModel_Object.cpp @@ -175,8 +175,7 @@ namespace kiwi m_parameters(), m_args(nullptr), m_signals(), - m_listeners(), - m_class(nullptr) + m_listeners() { } diff --git a/Modules/KiwiModel/KiwiModel_Object.h b/Modules/KiwiModel/KiwiModel_Object.h index 9efed14a..24af8298 100755 --- a/Modules/KiwiModel/KiwiModel_Object.h +++ b/Modules/KiwiModel/KiwiModel_Object.h @@ -386,7 +386,6 @@ namespace kiwi mutable std::unique_ptr> m_args; std::map> m_signals; mutable tool::Listeners m_listeners; - ObjectClass * m_class; friend class Factory; From 42024f463b96a48bdde4b8146210ae4590bd730e Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 29 Mar 2018 13:16:12 +0200 Subject: [PATCH 18/35] Fix linkview component size. --- .../KiwiApp_Patcher/KiwiApp_LinkView.cpp | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_LinkView.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_LinkView.cpp index 98d48f10..dcdaf98a 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_LinkView.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_LinkView.cpp @@ -32,12 +32,9 @@ namespace kiwi void LinkViewBase::updateBounds() { const juce::Rectangle link_bounds(m_last_outlet_pos, m_last_inlet_pos); - const juce::Rectangle new_bounds = link_bounds.expanded(20); - const juce::Point comp_pos = new_bounds.getPosition(); - - const juce::Point local_inlet_pos(m_last_inlet_pos - comp_pos); - const juce::Point local_outlet_pos(m_last_outlet_pos - comp_pos); + const juce::Point local_inlet_pos(m_last_inlet_pos ); + const juce::Point local_outlet_pos(m_last_outlet_pos); const juce::Point start_point = local_outlet_pos.translated(0.f, 2.f).toFloat(); const juce::Point end_point = local_inlet_pos.translated(0.f, -1.f).toFloat(); @@ -46,13 +43,16 @@ namespace kiwi const float shift = (max_shift < 10) ? max_shift * 0.2 : (max_shift * 0.5); const juce::Point ctrl_pt1 { start_point.x, static_cast(start_point.y + shift) }; - const juce::Point ctrl_pt2 { end_point.x, static_cast(end_point.y - shift) }; - - m_path.clear(); - m_path.startNewSubPath(start_point.x, start_point.y); - m_path.cubicTo(ctrl_pt1, ctrl_pt2, end_point); + const juce::Point ctrl_pt2 { end_point.x, static_cast(end_point.y - shift) }; + + juce::Path path; + path.startNewSubPath(start_point.x, start_point.y); + path.cubicTo(ctrl_pt1, ctrl_pt2, end_point); - setBounds(new_bounds); + setBounds(path.getBounds().toNearestInt().expanded(2, 2)); + + path.applyTransform(juce::AffineTransform::translation(-1 * getX(), -1 * getY())); + m_path = path; } // ================================================================================ // From 77683c8c7ef7524df9c391a0c30727ab185d0f65 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Tue, 3 Apr 2018 15:37:24 +0200 Subject: [PATCH 19/35] Correct bug with inlet/outlet hilighter. --- .../KiwiApp_PatcherViewIoletHighlighter.cpp | 28 ++++++++++++------- .../KiwiApp_PatcherViewIoletHighlighter.h | 5 ++-- 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.cpp index ca1fc7dc..03ee3ceb 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.cpp @@ -30,7 +30,12 @@ namespace kiwi // IOLET HILIGHTER // // ================================================================================ // - IoletHighlighter::IoletHighlighter() + IoletHighlighter::IoletHighlighter(): + m_text(""), + m_object_name(""), + m_show_tooltip_on_left(false), + m_last_index(), + m_object_ref() { setInterceptsMouseClicks(false, false); setAlwaysOnTop(true); @@ -62,29 +67,32 @@ namespace kiwi void IoletHighlighter::highlightInlet(ObjectFrame const& object, const size_t index) { - m_is_inlet = true; - highlight(object, index); + highlight(object, index, true); } void IoletHighlighter::highlightOutlet(ObjectFrame const& object, const size_t index) { - m_is_inlet = false; - highlight(object, index); + highlight(object, index, false); } - void IoletHighlighter::highlight(ObjectFrame const& object, const size_t index) + void IoletHighlighter::highlight(ObjectFrame const& object, const size_t index, bool is_inlet) { const auto& object_model = object.getModel(); + auto new_name = object_model.getName(); auto new_text = object_model.getIODescription(m_is_inlet, index); - if(!isVisible() || m_text != new_text || m_object_name != new_name || m_last_index != index) + //! Only hilight if either no pin is currently hilighted + //! or hilighted pin is different. + if(!isVisible() || (m_object_ref != object_model.ref() || m_is_inlet != is_inlet || m_last_index != index)) { - auto pos = m_is_inlet + auto pos = is_inlet ? object.getInletPatcherPosition(index) : object.getOutletPatcherPosition(index); - m_text = std::move(new_text); - m_object_name = std::move(new_name); + m_text = object_model.getIODescription(is_inlet, index); + m_object_name = object_model.getName(); + m_is_inlet = is_inlet; + m_object_ref = object_model.ref(); m_last_index = index; setBounds(juce::Rectangle(pos, pos).expanded(5)); diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.h b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.h index fcce4758..f9fd2729 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.h +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.h @@ -73,7 +73,7 @@ namespace kiwi private: // methods - void highlight(ObjectFrame const& object, const size_t index); + void highlight(ObjectFrame const& object, const size_t index, bool is_inlet); private: // members @@ -81,6 +81,7 @@ namespace kiwi std::string m_text; std::string m_object_name; bool m_show_tooltip_on_left; - size_t m_last_index; + size_t m_last_index; + flip::Ref m_object_ref; }; } From e50e2679c5ed646143ec55a9428cc630f242bdad Mon Sep 17 00:00:00 2001 From: jean-millot Date: Tue, 3 Apr 2018 15:43:13 +0200 Subject: [PATCH 20/35] Reduce magnet radius for link creation. --- Client/Source/KiwiApp_Patcher/KiwiApp_PatcherView.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherView.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherView.cpp index 8bd93bfe..ab048658 100755 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherView.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherView.cpp @@ -773,7 +773,7 @@ namespace kiwi const ObjectFrame& binded_object = m_link_creator->getBindedObject(); const juce::Point end_pos = m_link_creator->getEndPosition(); - const int max_distance = 50; + const int max_distance = 30; int min_distance = max_distance; for(auto& object_frame_uptr : m_objects) From 8f000bdd67cef95e48ac475f465bd1a102391e5a Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 12 Apr 2018 16:41:39 +0200 Subject: [PATCH 21/35] Update flip retrieving process. --- .gitignore | 1 + .travis.yml | 8 --- CMakeLists.txt | 13 ++-- Scripts/configure.py | 21 +++--- Scripts/flip.py | 161 +++++++++++++++++++++++++++++++++++++++++++ appveyor.yml | 9 +-- 6 files changed, 178 insertions(+), 35 deletions(-) create mode 100755 Scripts/flip.py diff --git a/.gitignore b/.gitignore index a4ad3a6b..91a82521 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ # Project specific Build/ +ThirdParty/flip diff --git a/.travis.yml b/.travis.yml index 610a6d26..06286b60 100755 --- a/.travis.yml +++ b/.travis.yml @@ -37,10 +37,6 @@ matrix: - if [[ "${COMPILER}" != "" ]]; then export CXX=${COMPILER}; fi - git submodule update --init --recursive ThirdParty/Juce ThirdParty/concurrentqueue ThirdParty/Beast - pip install --user cpp-coveralls - - wget --no-check-certificate -O ../flip-demo.tar.gz http://developer.irisate.com.s3-website-us-east-1.amazonaws.com/files/flip-demo-linux-c47e41da05.tar.gz - - cd .. - - tar xvzf flip-demo.tar.gz &> /dev/null - - export KIWI_FLIP_LIB=$(pwd)/flip-demo/lib/gcc && export KIWI_FLIP_INCLUDE=$(pwd)/flip-demo/include - cd ${HOME} - wget --no-check-certificate -O ./boost_1_63_0.tar.gz https://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.tar.gz - tar xvzf ./boost_1_63_0.tar.gz &> /dev/null @@ -106,10 +102,6 @@ matrix: install: - git submodule update --init --recursive ThirdParty/Juce ThirdParty/concurrentqueue ThirdParty/Beast - - curl -o ../flip-demo.tar.gz -L http://developer.irisate.com.s3-website-us-east-1.amazonaws.com/files/flip-demo-macos-c47e41da05.tar.gz - - cd .. - - tar xvzf flip-demo.tar.gz &> /dev/null - - export KIWI_FLIP_LIB=$(pwd)/flip-demo/lib && export KIWI_FLIP_INCLUDE=$(pwd)/flip-demo/include - cd ${HOME} - curl -o ./boost_1_63_0.tar.gz -L https://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.tar.gz - tar xvzf ./boost_1_63_0.tar.gz &> /dev/null diff --git a/CMakeLists.txt b/CMakeLists.txt index 047388b8..fa73a9f7 100755 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -257,17 +257,18 @@ source_group_rec("${JUCE_SRC}" ${ROOT_DIR}/ThirdParty/Juce/modules) # Flip #---------------------------------- +set(KIWI_FLIP_INCLUDE ${ROOT_DIR}/ThirdParty/flip/include) + if(WIN32) if (CMAKE_CL_64) - set(KIWI_FLIP_LIB $ENV{KIWI_FLIP_LIB_x64}) - set(KIWI_FLIP_INCLUDE $ENV{KIWI_FLIP_INCLUDE_x64}) + set(KIWI_FLIP_LIB ${ROOT_DIR}/ThirdParty/flip/lib/VS2015/x64/Release) else() - set(KIWI_FLIP_LIB $ENV{KIWI_FLIP_LIB_WIN32}) - set(KIWI_FLIP_INCLUDE $ENV{KIWI_FLIP_INCLUDE_WIN32}) + set(KIWI_FLIP_LIB ${ROOT_DIR}/ThirdParty/flip/lib/VS2015/Win32/Release) endif() +elseif(LINUX) + set(KIWI_FLIP_LIB ${ROOT_DIR}/ThirdParty/flip/lib/gcc) else() - set(KIWI_FLIP_LIB $ENV{KIWI_FLIP_LIB}) - set(KIWI_FLIP_INCLUDE $ENV{KIWI_FLIP_INCLUDE}) + set(KIWI_FLIP_LIB ${ROOT_DIR}/ThirdParty/flip/lib) endif() message(STATUS "Searching flip library") diff --git a/Scripts/configure.py b/Scripts/configure.py index 0508585c..e9456162 100755 --- a/Scripts/configure.py +++ b/Scripts/configure.py @@ -38,6 +38,12 @@ def parse_args (): return arg_parser.parse_args (sys.argv[1:]) +#============================================================================== +# Name : update_flip +#============================================================================== +def update_flip(): + subprocess.check_call("python " + os.path.join(project_dir, "Scripts", "flip.py"), shell= True); + #============================================================================== # Name : create_dir #============================================================================== @@ -46,19 +52,6 @@ def create_dir(dir): if not os.path.exists(dir): os.makedirs(dir); -#============================================================================== -# Name : flip_private -#============================================================================== - -def build_flip_private(): - flip_path = os.path.join(project_dir, "ThirdParty", "flip") - os.chdir(flip_path); - configure_path = os.path.join(flip_path, "configure.py") - build_path = os.path.join(flip_path, "build.py") - subprocess.check_call("python " + configure_path, shell= True); - subprocess.check_call("python " + build_path + " -c Debug -t flip", shell= True); - subprocess.check_call("python " + build_path + " -c Release -t flip", shell= True); - #============================================================================== # Name : mac_release #============================================================================== @@ -238,6 +231,8 @@ def configure_linux(args): # Name : main #============================================================================== +update_flip() + root_build_dir = os.path.join(project_dir, "Build") create_dir(root_build_dir) diff --git a/Scripts/flip.py b/Scripts/flip.py new file mode 100755 index 00000000..b72784de --- /dev/null +++ b/Scripts/flip.py @@ -0,0 +1,161 @@ +#!/usr/bin/env python + +##### IMPORT ################################################################# + +import os +import sys +import argparse +import urllib +import tarfile +import zipfile +import shutil +import subprocess +import platform + + +root_dir = os.path.split(os.path.dirname(os.path.realpath(__file__)))[0] +flip_dir = os.path.join(root_dir, "ThirdParty", "flip") +flip_commit = "c47e41da05" +flip_url = "http://developer.irisate.com.s3-website-us-east-1.amazonaws.com/files/" + +#============================================================================== +# Name : get_private_commit +#============================================================================== + +def get_private_commit(): + commit = subprocess.check_output(["git", "submodule", "status", "flip"]) + return commit[1:11] + +#============================================================================== +# Name : get_public_commit +#============================================================================== + +def read_commit(): + + commit = "" + + config_file = os.path.join(flip_dir, "config") + + if os.path.exists(config_file): + fo = open(config_file, "r") + commit = fo.readline() + fo.close() + + return commit[0:10] + +#============================================================================== +# Name : set_public_commit +#============================================================================== + +def write_commit(commit): + + config_file = os.path.join(flip_dir, "config") + fo = open(config_file, "w") + fo.write(commit) + fo.close() + + +#============================================================================== +# Name : download_flip_mac +#============================================================================== + +def download_flip_mac(commit): + + archive_file = "flip-demo-macos-" + commit + ".tar.gz" + + # download archive + print "-- downloading archive" + urllib.urlretrieve (flip_url + archive_file, os.path.join(root_dir, "ThirdParty", archive_file)) + + # ectract archive files + print "-- extracting archive" + archive = tarfile.open(os.path.join(root_dir, "ThirdParty", archive_file), "r:gz") + archive.extractall(os.path.join(root_dir, "ThirdParty")) + archive.close() + + os.rename(os.path.join(root_dir, "ThirdParty", "flip-demo"), flip_dir) + + # remove archive + os.remove(os.path.join(root_dir, "ThirdParty", archive_file)) + +#============================================================================== +# Name : download_flip_windows +#============================================================================== + +def download_flip_windows(commit): + + archive_file = "flip-demo-windows-" + commit + ".zip" + + # download archive + print "-- downloading flip archive" + urllib.urlretrieve (flip_url + archive_file, os.path.join(root_dir, "ThirdParty", archive_file)) + + # extract archive + print "-- extracting archive" + + os.mkdir(flip_dir) + archive = zipfile.ZipFile(os.path.join(root_dir, "ThirdParty", archive_file), 'r') + archive.extractall(flip_dir) + archive.close() + + os.remove(os.path.join(root_dir, "ThirdParty", archive_file)) + +#============================================================================== +# Name : download_flip_linux +#============================================================================== + +def download_flip_linux(commit): + + archive_file = "flip-demo-linux-" + commit + ".tar.gz" + + # download archive + print "-- downloading archive" + urllib.urlretrieve (flip_url + archive_file, os.path.join(root_dir, "ThirdParty", archive_file)) + + print "-- extracting archive" + + archive = tarfile.open(os.path.join(root_dir, "ThirdParty", archive_file), "r:gz") + archive.extractall(os.path.join(root_dir, "ThirdParty")) + archive.close() + + os.rename(os.path.join(root_dir, "ThirdParty", "flip-demo"), flip_dir) + + # remove archive + os.remove(os.path.join(root_dir, "ThirdParty", archive_file)) + +#============================================================================== +# Name : checkout +#============================================================================== + +def download_flip(commit): + + if (platform.system() == "Darwin"): + download_flip_mac(commit) + elif (platform.system() == "Windows"): + download_flip_windows(commit) + elif platform.system() == "Linux": + download_flip_linux(commit) + + +#============================================================================== +# Name : main +#============================================================================== + +current_commit = read_commit() + +if current_commit != flip_commit: + + print "-- flip is not up-to-date :" + + if os.path.exists(flip_dir): + shutil.rmtree(flip_dir) + + download_flip(flip_commit) + + write_commit(flip_commit) + + print "-- flip successfully updated" + +else: + + print "-- flip already up to date" diff --git a/appveyor.yml b/appveyor.yml index 77b977ff..aa45155e 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -16,17 +16,10 @@ install: - git submodule update --init --recursive "ThirdParty/Juce" - git submodule update --init --recursive "ThirdParty/concurrentqueue" - git submodule update --init --recursive "ThirdParty/Beast" - - set PATH=C:\Python27;%PATH% - - curl -o ..\flip-demo.zip -L -k http://developer.irisate.com.s3-website-us-east-1.amazonaws.com/files/flip-demo-windows-c47e41da05.zip - - cd .. - - 7z x flip-demo.zip -o./flip-demo - - set KIWI_FLIP_LIB_x64=%cd%/flip-demo/lib/VS2015/x64/Release - - set KIWI_FLIP_INCLUDE_x64=%cd%/flip-demo/include - - set KIWI_FLIP_LIB_WIN32=%cd%/flip-demo/lib/VS2015/Win32/Release - - set KIWI_FLIP_INCLUDE_WIN32=%cd%/flip-demo/include - set KIWI_BOOST_INCLUDE=C:\Libraries\boost_1_63_0 - set KIWI_BOOST_LIB_x64=C:\Libraries\boost_1_63_0\lib64-msvc-14.0 - set KIWI_BOOST_LIB_WIN32=C:\Libraries\boost_1_63_0\lib32-msvc-14.0 + - set PATH=C:\Python27;%PATH% - cd %APPVEYOR_BUILD_FOLDER% - if "%APPVEYOR_REPO_BRANCH%"=="master" (set KIWI_DEPLOY=release) else (set KIWI_DEPLOY=draft) From d54a0483c9dac870451b6084969adb2172b185c8 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Fri, 20 Apr 2018 12:36:10 +0200 Subject: [PATCH 22/35] Update boost retrieving process. --- .gitignore | 1 + .travis.yml | 32 +++---- CMakeLists.txt | 10 +-- Scripts/boost.py | 201 +++++++++++++++++++++++++++++++++++++++++++ Scripts/configure.py | 9 ++ Scripts/flip.py | 5 ++ appveyor.yml | 3 - 7 files changed, 232 insertions(+), 29 deletions(-) create mode 100755 Scripts/boost.py diff --git a/.gitignore b/.gitignore index 91a82521..1a760685 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ # Project specific Build/ ThirdParty/flip +ThirdParty/boost diff --git a/.travis.yml b/.travis.yml index 06286b60..72996801 100755 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ language: cpp dist: trusty -sudo: required +sudo: false notifications: email: false @@ -15,6 +15,8 @@ matrix: env: COMPILER=g++-4.9 before_install: + - python --version + - python -c 'import ssl; print ssl.OPENSSL_VERSION;' - sudo add-apt-repository ppa:webkit-team/ppa -y - sudo apt-get update - sudo apt-get install libfreetype6-dev @@ -27,25 +29,17 @@ matrix: - sudo apt-get install libgtk-3-dev - sudo apt-get install libwebkit2gtk-4.0-dev + addons: apt: sources: ['ubuntu-toolchain-r-test'] - packages: [g++-4.9, 'python-pip', 'python-yaml'] + packages: [g++-4.9, 'python-pip', 'python-yaml', 'libssl1.0.0'] install: # make sure CXX is correctly set - if [[ "${COMPILER}" != "" ]]; then export CXX=${COMPILER}; fi - git submodule update --init --recursive ThirdParty/Juce ThirdParty/concurrentqueue ThirdParty/Beast - pip install --user cpp-coveralls - - cd ${HOME} - - wget --no-check-certificate -O ./boost_1_63_0.tar.gz https://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.tar.gz - - tar xvzf ./boost_1_63_0.tar.gz &> /dev/null - - cd ./boost_1_63_0 - - ./bootstrap.sh toolset=gcc link=static - - ./b2 --with-system stage - - export KIWI_BOOST_INCLUDE=${HOME}/boost_1_63_0 - - export KIWI_BOOST_LIB=${HOME}/boost_1_63_0/stage/lib - - cd ${TRAVIS_BUILD_DIR} script: - python ./Scripts/configure.py -coverage @@ -100,17 +94,15 @@ matrix: env: COMPILER=clang++ osx_image: xcode9.2 + before_install: + - pyenv install 2.7.11 + - pyenv global 2.7.11 + - eval "$(pyenv init -)" + - python --version + - python -c 'import ssl; print ssl.OPENSSL_VERSION;' + install: - git submodule update --init --recursive ThirdParty/Juce ThirdParty/concurrentqueue ThirdParty/Beast - - cd ${HOME} - - curl -o ./boost_1_63_0.tar.gz -L https://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.tar.gz - - tar xvzf ./boost_1_63_0.tar.gz &> /dev/null - - cd ./boost_1_63_0 - - ./bootstrap.sh toolset=clang macosx-version-min=10.8 architecture=combined link=static - - ./b2 address-model=32_64 --with-system stage - - export KIWI_BOOST_INCLUDE=${HOME}/boost_1_63_0 - - export KIWI_BOOST_LIB=${HOME}/boost_1_63_0/stage/lib - - cd ${TRAVIS_BUILD_DIR} script: - python ./Scripts/configure.py -c Release diff --git a/CMakeLists.txt b/CMakeLists.txt index fa73a9f7..798c587e 100755 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -296,18 +296,16 @@ set(FLIP_COMPILE_DEFINITIONS "flip_NOTHING=flip_NOTHING_FATAL") # Beast #---------------------------------- -set(Boost_INCLUDE_DIR $ENV{KIWI_BOOST_INCLUDE}) +set(Boost_INCLUDE_DIR ${ROOT_DIR}/ThirdParty/boost) if (WIN32) if (CMAKE_CL_64) - set(Boost_LIBRARY_DIR $ENV{KIWI_BOOST_LIB_x64}) + set(Boost_LIBRARY_DIR ${ROOT_DIR}/ThirdParty/boost/stage64/lib) else() - set(Boost_LIBRARY_DIR $ENV{KIWI_BOOST_LIB_WIN32}) + set(Boost_LIBRARY_DIR ${ROOT_DIR}/ThirdParty/boost/stage32/lib) endif() else() - set(Boost_LIBRARY_DIR $ENV{KIWI_BOOST_LIB}) - set(Boost_NO_BOOST_CMAKE true) - set(Boost_NO_SYSTEM_PATHS true) + set(Boost_LIBRARY_DIR ${ROOT_DIR}/ThirdParty/boost/stage/lib) endif() option (Boost_USE_STATIC_LIBS "Use static libraries for boost" ON) diff --git a/Scripts/boost.py b/Scripts/boost.py new file mode 100755 index 00000000..4ecc6ac3 --- /dev/null +++ b/Scripts/boost.py @@ -0,0 +1,201 @@ +#!/usr/bin/env python + +##### IMPORT ################################################################# + +import os +import sys +import argparse +import subprocess +import platform +import urllib2 +import ssl +import zipfile +import tarfile +import shutil + +##### VERSION ################################################################# + +if sys.version_info[0] != 2 or sys.version_info[1] < 7: + print("This script requires version python 2, 2.7 or higher") + sys.exit(1) + +root_dir = os.path.split(os.path.dirname(os.path.realpath(__file__)))[0] +boost_dir = os.path.join(root_dir, "ThirdParty", "boost") +boost_version = "1.63.0" +boost_url = "https://sourceforge.net/projects/boost/files/boost/" + +#============================================================================== +# Name : get_public_commit +#============================================================================== + +def read_version(): + + version = "" + + config_file = os.path.join(boost_dir, "config") + + if os.path.exists(config_file): + fo = open(config_file, "r") + version = fo.readline() + fo.close() + + return version[0:10] + +#============================================================================== +# Name : set_public_commit +#============================================================================== + +def write_version(version): + + config_file = os.path.join(boost_dir, "config") + fo = open(config_file, "w") + fo.write(version) + fo.close() + + +#============================================================================== +# Name : init_boost_macos +#============================================================================== + +def init_boost_macos(): + + subprocess.check_call("./bootstrap.sh toolset=clang macosx-version-min=10.8 architecture=combined link=static", shell= True) + + subprocess.check_call("./b2 address-model=32_64 --with-system stage", shell= True) + +#============================================================================== +# Name : download_flip_windows +#============================================================================== + +def init_boost_windows(): + + subprocess.check_call("bootstrap.bat", shell= True) + + subprocess.check_call("b2 --toolset=msvc-14.0 -j4 --with-system --stagedir=stage64 variant=release architecture=x86 address-model=64 link=static", shell= True) + + subprocess.check_call("b2 --toolset=msvc-14.0 -j4 --with-system --stagedir=stage32 variant=release architecture=x86 address-model=32 link=static", shell= True) + +#============================================================================== +# Name : download_flip_linux +#============================================================================== + +def init_boost_linux(): + + subprocess.check_call("./bootstrap.sh toolset=gcc link=static", shell= True); + + subprocess.check_call("./b2 --with-system stage", shell= True); + +#============================================================================== +# Name : init_boost +#============================================================================== + +def init_boost(): + + os.chdir(os.path.join(root_dir, "ThirdParty", "boost")); + + if (platform.system() == "Darwin"): + init_boost_macos() + elif (platform.system() == "Windows"): + init_boost_windows() + elif platform.system() == "Linux": + init_boost_linux() + + os.chdir(root_dir); + +#============================================================================== +# Name : download_boost_unix +#============================================================================== + +def download_boost_unix(): + + boost_archive_file = "boost_" + boost_version.replace(".", "_") + ".tar.gz" + + # download archive + print "-- downloading archive" + + endpoint = boost_url + boost_version + "/" + boost_archive_file + + f = open(os.path.join(root_dir, "ThirdParty", boost_archive_file), 'wb') + f.write(urllib2.urlopen(endpoint).read()) + f.close() + + print "-- extracting archive" + + archive = tarfile.open(os.path.join(root_dir, "ThirdParty", boost_archive_file), "r:gz") + archive.extractall(os.path.join(root_dir, "ThirdParty")) + archive.close() + + os.rename(os.path.join(root_dir, "ThirdParty", "boost_" + boost_version.replace(".", "_")), boost_dir) + + # remove archive + os.remove(os.path.join(root_dir, "ThirdParty", boost_archive_file)) + +#============================================================================== +# Name : download_boost_windows +#============================================================================== + +def download_boost_windows(): + + boost_archive_file = "boost_" + boost_version.replace(".", "_") + ".zip" + + # download archive + print "-- downloading archive" + + endpoint = boost_url + boost_version + "/" + boost_archive_file + + ctx = ssl.create_default_context() + ctx.check_hostname = False + ctx.verify_mode = ssl.CERT_NONE + + f = open(os.path.join(root_dir, "ThirdParty", boost_archive_file), 'wb') + f.write(urllib2.urlopen(boost_url + boost_version + "/" + boost_archive_file, context=ctx).read()) + f.close() + + print "-- extracting archive" + + archive = zipfile.ZipFile(os.path.join(root_dir, "ThirdParty", boost_archive_file), "r") + archive.extractall(os.path.join(root_dir, "ThirdParty")) + archive.close() + + os.rename(os.path.join(root_dir, "ThirdParty", "boost_" + boost_version.replace(".", "_")), boost_dir) + + # remove archive + os.remove(os.path.join(root_dir, "ThirdParty", boost_archive_file)) + +#============================================================================== +# Name : download_boost +#============================================================================== + +def download_boost(): + + if (platform.system() == "Darwin"): + download_boost_unix() + elif (platform.system() == "Windows"): + download_boost_windows() + elif platform.system() == "Linux": + download_boost_unix() + +#============================================================================== +# Name : main +#============================================================================== + +current_version = read_version() + +if current_version != boost_version: + + print "-- boost is not up-to-date :" + + if os.path.exists(boost_dir): + shutil.rmtree(boost_dir) + + download_boost() + + init_boost() + + write_version(boost_version) + + print "-- boost successfully updated" + +else: + + print "-- boost already up to date" diff --git a/Scripts/configure.py b/Scripts/configure.py index e9456162..6eef8b36 100755 --- a/Scripts/configure.py +++ b/Scripts/configure.py @@ -44,6 +44,13 @@ def parse_args (): def update_flip(): subprocess.check_call("python " + os.path.join(project_dir, "Scripts", "flip.py"), shell= True); +#============================================================================== +# Name : init_boost +#============================================================================== + +def init_boost(): + subprocess.check_call("python " + os.path.join(project_dir, "Scripts", "boost.py"), shell= True); + #============================================================================== # Name : create_dir #============================================================================== @@ -231,6 +238,8 @@ def configure_linux(args): # Name : main #============================================================================== +init_boost() + update_flip() root_build_dir = os.path.join(project_dir, "Build") diff --git a/Scripts/flip.py b/Scripts/flip.py index b72784de..9d866511 100755 --- a/Scripts/flip.py +++ b/Scripts/flip.py @@ -12,6 +12,11 @@ import subprocess import platform +##### VERSION ################################################################# + +if sys.version_info[0] != 2 or sys.version_info[1] < 7: + print("This script requires version python 2, 2.7 or higher") + sys.exit(1) root_dir = os.path.split(os.path.dirname(os.path.realpath(__file__)))[0] flip_dir = os.path.join(root_dir, "ThirdParty", "flip") diff --git a/appveyor.yml b/appveyor.yml index aa45155e..c2e935f9 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -16,9 +16,6 @@ install: - git submodule update --init --recursive "ThirdParty/Juce" - git submodule update --init --recursive "ThirdParty/concurrentqueue" - git submodule update --init --recursive "ThirdParty/Beast" - - set KIWI_BOOST_INCLUDE=C:\Libraries\boost_1_63_0 - - set KIWI_BOOST_LIB_x64=C:\Libraries\boost_1_63_0\lib64-msvc-14.0 - - set KIWI_BOOST_LIB_WIN32=C:\Libraries\boost_1_63_0\lib32-msvc-14.0 - set PATH=C:\Python27;%PATH% - cd %APPVEYOR_BUILD_FOLDER% - if "%APPVEYOR_REPO_BRANCH%"=="master" (set KIWI_DEPLOY=release) else (set KIWI_DEPLOY=draft) From 3e33e1bc2759594e55b66b1d41a1633ec667b4be Mon Sep 17 00:00:00 2001 From: jean-millot Date: Fri, 20 Apr 2018 12:36:59 +0200 Subject: [PATCH 23/35] Documentation --- docs/css/main.css | 72 ++++++++++++++++++++++++++ docs/css/navbar.css | 61 ++++++++++++++++++++++ docs/developper/dev.md | 93 ++++++++++++++++++++++++++++++++++ docs/index.html | 73 ++++++++++++++++++++++++++ docs/ressources/kiwi_icon.png | Bin 0 -> 24099 bytes docs/software/versions.md | 50 ++++++++++++++++++ 6 files changed, 349 insertions(+) create mode 100644 docs/css/main.css create mode 100644 docs/css/navbar.css create mode 100644 docs/developper/dev.md create mode 100644 docs/index.html create mode 100644 docs/ressources/kiwi_icon.png create mode 100644 docs/software/versions.md diff --git a/docs/css/main.css b/docs/css/main.css new file mode 100644 index 00000000..e304d4f3 --- /dev/null +++ b/docs/css/main.css @@ -0,0 +1,72 @@ +.main { font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif; line-height: 1.6; word-wrap: break-word; padding: 30px; font-size: 16px; color: rgb(51, 51, 51); background-color: rgb(255, 255, 255); overflow: scroll; margin-left: 250px} +.main > :first-child { margin-top: 0px !important; } +.main > :last-child { margin-bottom: 0px !important; } +.main a:not([href]) { color: inherit; text-decoration: none; } +.main .absent { color: rgb(204, 0, 0); } +.main .anchor { position: absolute; top: 0px; left: 0px; display: block; padding-right: 6px; padding-left: 30px; margin-left: -30px; } +.main .anchor:focus { outline: none; } +.main h1, .main h2, .main h3, .main h4, .main h5, .main h6 { position: relative; margin-top: 1em; margin-bottom: 16px; font-weight: bold; line-height: 1.4; } +.main h1 .octicon-link, .main h2 .octicon-link, .main h3 .octicon-link, .main h4 .octicon-link, .main h5 .octicon-link, .main h6 .octicon-link { display: none; color: rgb(0, 0, 0); vertical-align: middle; } +.main h1:hover .anchor, .main h2:hover .anchor, .main h3:hover .anchor, .main h4:hover .anchor, .main h5:hover .anchor, .main h6:hover .anchor { padding-left: 8px; margin-left: -30px; text-decoration: none; } +.main h1:hover .anchor .octicon-link, .main h2:hover .anchor .octicon-link, .main h3:hover .anchor .octicon-link, .main h4:hover .anchor .octicon-link, .main h5:hover .anchor .octicon-link, .main h6:hover .anchor .octicon-link { display: inline-block; } +.main h1 tt, .main h2 tt, .main h3 tt, .main h4 tt, .main h5 tt, .main h6 tt, .main h1 code, .main h2 code, .main h3 code, .main h4 code, .main h5 code, .main h6 code { font-size: inherit; } +.main h1 { padding-bottom: 0.3em; font-size: 2.25em; line-height: 1.2; border-bottom: 1px solid rgb(238, 238, 238); } +.main h1 .anchor { line-height: 1; } +.main h2 { padding-bottom: 0.3em; font-size: 1.75em; line-height: 1.225; border-bottom: 1px solid rgb(238, 238, 238); } +.main h2 .anchor { line-height: 1; } +.main h3 { font-size: 1.5em; line-height: 1.43; } +.main h3 .anchor { line-height: 1.2; } +.main h4 { font-size: 1.25em; } +.main h4 .anchor { line-height: 1.2; } +.main h5 { font-size: 1em; } +.main h5 .anchor { line-height: 1.1; } +.main h6 { font-size: 1em; color: rgb(119, 119, 119); } +.main h6 .anchor { line-height: 1.1; } +.main p, .main blockquote, .main ul, .main ol, .main dl, .main table, .main pre { margin-top: 0px; margin-bottom: 16px; } +.main hr { height: 4px; padding: 0px; margin: 16px 0px; background-color: rgb(231, 231, 231); border: 0px none; } +.main ul, .main ol { padding-left: 2em; } +.main ul.no-list, .main ol.no-list { padding: 0px; list-style-type: none; } +.main ul ul, .main ul ol, .main ol ol, .main ol ul { margin-top: 0px; margin-bottom: 0px; } +.main li > p { margin-top: 16px; } +.main dl { padding: 0px; } +.main dl dt { padding: 0px; margin-top: 16px; font-size: 1em; font-style: italic; font-weight: bold; } +.main dl dd { padding: 0px 16px; margin-bottom: 16px; } +.main blockquote { padding: 0px 15px; color: rgb(119, 119, 119); border-left: 4px solid rgb(221, 221, 221); } +.main blockquote > :first-child { margin-top: 0px; } +.main blockquote > :last-child { margin-bottom: 0px; } +.main table { display: block; width: 100%; overflow: auto; word-break: keep-all; } +.main table th { font-weight: bold; } +.main table th, .main table td { padding: 6px 13px; border: 1px solid rgb(221, 221, 221); } +.main table tr { background-color: rgb(255, 255, 255); border-top: 1px solid rgb(204, 204, 204); } +.main table tr:nth-child(2n) { background-color: rgb(248, 248, 248); } +.main img { max-width: 100%; box-sizing: border-box; } +.main .emoji { max-width: none; } +.main span.frame { display: block; overflow: hidden; } +.main span.frame > span { display: block; float: left; width: auto; padding: 7px; margin: 13px 0px 0px; overflow: hidden; border: 1px solid rgb(221, 221, 221); } +.main span.frame span img { display: block; float: left; } +.main span.frame span span { display: block; padding: 5px 0px 0px; clear: both; color: rgb(51, 51, 51); } +.main span.align-center { display: block; overflow: hidden; clear: both; } +.main span.align-center > span { display: block; margin: 13px auto 0px; overflow: hidden; text-align: center; } +.main span.align-center span img { margin: 0px auto; text-align: center; } +.main span.align-right { display: block; overflow: hidden; clear: both; } +.main span.align-right > span { display: block; margin: 13px 0px 0px; overflow: hidden; text-align: right; } +.main span.align-right span img { margin: 0px; text-align: right; } +.main span.float-left { display: block; float: left; margin-right: 13px; overflow: hidden; } +.main span.float-left span { margin: 13px 0px 0px; } +.main span.float-right { display: block; float: right; margin-left: 13px; overflow: hidden; } +.main span.float-right > span { display: block; margin: 13px auto 0px; overflow: hidden; text-align: right; } +.main code, .main tt { padding: 0.2em 0px; margin: 0px; font-size: 85%; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; } +.main code::before, .main tt::before, .main code::after, .main tt::after { letter-spacing: -0.2em; content: " "; } +.main code br, .main tt br { display: none; } +.main del code { text-decoration: inherit; } +.main pre > code { padding: 0px; margin: 0px; font-size: 100%; word-break: normal; white-space: pre; background: transparent; border: 0px; } +.main .highlight { margin-bottom: 16px; } +.main .highlight pre, .main pre { padding: 16px; overflow: auto; font-size: 85%; line-height: 1.45; background-color: rgb(247, 247, 247); border-radius: 3px; } +.main .highlight pre { margin-bottom: 0px; word-break: normal; } +.main pre { word-wrap: normal; } +.main pre code, .main pre tt { display: inline; max-width: initial; padding: 0px; margin: 0px; overflow: initial; line-height: inherit; word-wrap: normal; background-color: transparent; border: 0px; } +.main pre code::before, .main pre tt::before, .main pre code::after, .main pre tt::after { content: normal; } +.main kbd { display: inline-block; padding: 3px 5px; font-size: 11px; line-height: 10px; color: rgb(85, 85, 85); vertical-align: middle; background-color: rgb(252, 252, 252); border-width: 1px; border-style: solid; border-color: rgb(204, 204, 204) rgb(204, 204, 204) rgb(187, 187, 187); border-image: initial; border-radius: 3px; box-shadow: rgb(187, 187, 187) 0px -1px 0px inset; } +.main a { color: rgb(51, 122, 183); } +.main code { color: inherit; } +.main pre.editor-colors { padding: 0.8em 1em; margin-bottom: 1em; font-size: 0.85em; border-radius: 4px; overflow: auto; } diff --git a/docs/css/navbar.css b/docs/css/navbar.css new file mode 100644 index 00000000..89d74149 --- /dev/null +++ b/docs/css/navbar.css @@ -0,0 +1,61 @@ +body { + font-family: "Lato", sans-serif; +} + +/* Fixed sidenav, full height */ +.sidenav { + height: 100%; + width: 250px; + position: fixed; + z-index: 1; + top: 0; + left: 0; + background-color: #111; + overflow-x: hidden; + padding-top: 20px; +} + +/* Style the sidenav links and the dropdown button */ +.sidenav a, .dropdown-btn { + padding: 6px 8px 6px 16px; + text-decoration: none; + font-size: 20px; + color: #818181; + display: block; + border: none; + background: none; + width: 100%; + text-align: left; + cursor: pointer; + outline: none; +} + +/* On mouse-over */ +.sidenav a:hover, .dropdown-btn:hover { + color: #f1f1f1; +} + +/* Add an active class to the active dropdown button */ +.active { + background-color: green; + color: white; +} + +/* Dropdown container (hidden by default). Optional: add a lighter background color and some left padding to change the design of the dropdown content */ +.dropdown-container { + display: none; + background-color: #262626; + padding-left: 8px; +} + +/* Optional: Style the caret down icon */ +.fa-caret-down { + float: right; + padding-right: 8px; +} + +/* Some media queries for responsiveness */ +@media screen and (max-height: 450px) { + .sidenav {padding-top: 15px;} + .sidenav a {font-size: 18px;} +} diff --git a/docs/developper/dev.md b/docs/developper/dev.md new file mode 100644 index 00000000..ec822107 --- /dev/null +++ b/docs/developper/dev.md @@ -0,0 +1,93 @@ +# Developper guide + +### Table of Contents +1. [Building Kiwi](#build) +2. [Code](#code) +3. [Server](#server) +3. [Scripts](#scripts) + +### Building Kiwi + +##### Python + +Our build system uses python 2.7 to execute scripts. Please download and install python before going any further. python version 2.7.11 is tested. + +##### Cloning + +Use git clone comment to clone the repository. + +```shell +git clone --recursive https://github.com/Musicoll/Kiwi.git +``` + +##### Configuring + +Before building kiwi, you'll need to create a project from source code. Configuring will download certain dependencies (boost/flip) into /ThirdParty and create a /Build containing the project. We create a Visual Studio project on Windows, a Xcode project on MacOs and a makefile on linux. To configure execute the following command. + +```shell +python ./Script/configure.py +``` + +##### Building + +To build Kiwi, you can either open your code editor and build the project or use our build script. +Here is a list of tested compilers depending on your platform. + +* MacOs: clang 7.3.1 +* Windows: msvc 19.0 +* Linus: gcc-4.9 + +```shell +python ./Script/build.py +``` + +To build a specific target you can use argument -t and you can choose your configuration (Debug/Release) using -c argument. + +ex: + +```shell +python ./Script/build.py -t Server -c Debug +``` + +##### Tests + +Tests are ran as a post build command of target Tests. To run run tests + +```shell +python ./Srcipts/build.py -t Tests -c Release +``` + + +### Code + +The documentation of Kiwi's classes can be found [here](html/index.html). + +### Server +### Scripts + +##### Documentation + +The documentation can be generated using [Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html). +It is generated in directory /docs in html format. + +```shell +# Execute doxygen from root directory. +$ Doxygen ./docs/Doxyfile +``` +##### Ressources + +You can generate binary data for ressources with the `Scripts/ressource.py` script. +This script takes 2 optional arguments: + - `-i / --input` : The ressources input directory, Default is `./Ressources/BinaryRes`. + - `-o / --output` : The output directory in which the binary data files will be generated, + Default is `./Client/Source/KiwiApp_Ressources`. + + ex: + + ```shell + $ cd {kiwi_directory_path} + # with default paths: + $ python ./Scripts/ressource.py + # or with custom paths + $ python ./Scripts/ressource.py -i input/ressources/path -o output/binary/path + ``` diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..cc7d2f01 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,73 @@ + + + + + Kiwi Wiki + + + + + + + + + +
+ Getting started + Objects + Tutorials + Versions + Developper guide +
+ +
+

Kiwi Wiki

+

Welcome to our wiki !

+

You will find here all relevent informations on how to use kiwi as well + as guidance for fellow developpers eager to contribute.

+
+ + + + + diff --git a/docs/ressources/kiwi_icon.png b/docs/ressources/kiwi_icon.png new file mode 100644 index 0000000000000000000000000000000000000000..abf618831b038fcb58be937b99574df6176c4875 GIT binary patch literal 24099 zcmZ_02UJsC(=d7x0)!@^7YhMFdhgPL^xlyUQUnA+0Vz@vK%|L)NJrpNib(Grf=UrY z5TpoFR6yxSFCn=nKJWYe-~I2pu9Zc~oar-r_Uzfl8yjlTP_k1306?Rot!@ecQ1C4j zfRllL_JhBif`1_Xrdl_Es!x|z!4DMow5|OCfQo_mf&e*rtROg*r@2*tm4W_s7vH-g zw_JUl-9&=#-UFclKr#3_`1Y<_z%69(U2h-%>%mG~e<7}e?}=ZFav}eM1b8WNSs553 z)qMTjkkTSjB4S+1lt?5}(a-hvbyIcC|2z(UQsVLm2)K7$R5U0kNF+#7#MjSVR9s$O zUQ|p%R6;@+gb?-*@d>yUEbQZd^e|oK zMaL(=%?~8@pQr!J;Qv3we{d;^64mv;)c3D#{(cJ@N10Ml^nVPkOi8ODkOlxKKu2BG zJQ%Xs8T#b%RQNCJX8x{MElQm3m)uNU9|LL;pkxl6u6KW1gys~_G_&AC+Z9Cf$FO}vQX##rTx z;tkJ-H+pU*j&y}aH2bDD`!3iXeL2G!hEx9TO1}Q!({@ixwql_4vA}yu<6RhnI;*>UZ+v`wC7lL};7bIc zg+jZ}ZTX=tF0@aY<{G!fB5Qr3UY?j;{Fbzu?Y$?+_0MgGXwvbuQE!8+d}Rq2<$6^B zDo>9Bmf)EcnvAHuZ_R{I`SBle1 zalI!*k%ltAF(Ke2_+3B$rB1dAt%6QybFYkv4aG-QNfMG_ODIg$JL=NnMG&>`m15;^ zii-V(>RBV~cH-bVY%{9xb4y^}eV9Xg?%)GX4DcHoQ;p+79DWxSB@Z?5--$45Z*!C` zl3}CElATlTCnt+yc)~dl$M;pv0Dvqugo=sqM;^9^jTeck7SKRz;aSYkt7Lb0Jub(^ zB)w07BLPNvDzjG<+K%`}uOy?~)Wxx6l}j&jIuSLzPVcdK*$?IFee5?w$QWk)uNKdO z%Jn%TUq3~_qm>QL!cnyfdeGr2=zCO#_J?w6C>$g4+U&Lf6n1WYEGK6Rjf?aSd1f04 zK1KSrlQ4>8CxO0V{w~t=~E6=0*L_z050n#H7B=yd^&}s z{r33&>aTZMc6*#i7qXAQ+h4LicD~HqOJ7M(jIT{KfLJ{#{K8gXef|Bzm(Fuw;hNj- zhMClf*J>nk3;*CgztT!(v6op^MJ51HWWt3r%Bu*OKe==`hHE>t%$8!Ls)b0XCOl78 zlH%Gb7av@%cb^B;Z(BlHXXqqN#u4Uv^$#Ao00F(`Z0$hPqp_dfelHIEWDYIj%7os_gp`1?F z-+!cr?%9f)QLJ8B3>(MR5t5vIgD#pnt>zUxbvu02PKxgraOjgwnzVdbafTo6z!+szgiZLj4n_h5kn1?3)kI5*EIJv7$ZT8v*6 zova2Nug^|PdsR*l^5ko-oH<8)^V!|IF8CmSo2h`is>` z*S)wOgDHuPE=7w@_6Z^@e}qr1&O{f06n?pHoh5vZ+wKfn{bN&k&Fheux|p~|J*4vI zIzoOjP%~Dfj4QlJ0Dc3e>B;+hH+#pwFhDyg#FPtVa|Je30rQ@ryAKqDcNTYc{od)X zziREKq4MQ4z7I{xj*Oi7URGAtnh^ck{D2N%x-UC?&U9aD;t`4x8bDQqDcv!KVQ!T6 zN{57ng`r=Wr1gfa-B0EL)3vcYbPr7GJ4BzqS+&AcE(XQA#18$&Yr3FT_O_2&a?HWZ zJP?UtsNNO}+7b*p;K{bIs@2oe>%rloJl(9QKfO?3L0+I#D|mynAu;{#zv~3U zr1`|VGX|ai31&*SfwsX8#YTrhDe&H%6xvjganZ)C1EF-(-Xe5`(pVnfqFPc&%Hw>J ze!r=048s$O%^ruGO`g%_qv7^j#fE}K#i&P-PgGJSq3Wt95k=C4VH~cvAW$S#0?$&d zL^Wa8|H+Ohq>JA)s(pWIA#nEYaC_L+M&g0mwCTN-k8D>dKS{MSBs5~i9s!c10R`l6 zAO@dSdMM34v~c?o`u-;`+GG0T)^^dSod!B%y2u-Vs*{@Ftkf90aXHPmelxQAWgB%L zIEIVQ-KvjQMc!xSU~ea%IyG=uH)sE7gUxgPJHt*pm*447pz6-)di|5Dd|2DMghf5k z%Sv`A6UJ0JF#I)WTeJ5MFfVyirY7vU9qU5hDg?N5%&juOQs}$Tm$H}!n_n*Fw zjB*MLoa7nrsBtUSL&_;CDM_zt#3)w5px9f#22tIKETTi~c!mqPWit(D+bW1layt|g z53t8eFxP~C8Yq!u&m^D7`T32P(8OBn%0(G}XrD~CQ|>)NA`S4FqK;{i5l8#lZ>QK0 zDe|Y^*FxD`wU`It6^`9q@`*n`DX6f23*GKo%&_$lmwrv^K9X-?$-p~&xyx^PMyWk$ z`*dA)A#AVI(8lWiD+F*M9~fKe?znVGx~F@qFvKDI5wJ7(qD)}ifLfbMwfPrUk-+O4 z1)9pZ|urNF=G^8_kFCNSRjNm z;MT=yc|vrd4L}jhs`gzmkCUq__wjN6w$D?Rl;wCj=pk=pYhO6_303gG6RKm8pU{og z<#c*T3XAnnn5`MkK}Ll-2Pd5EmQ4*w;Tc|AVhW_I(C55N`Efh*fK+Hsbn5yz{m$s8 z7wycfEKU@{rLJ&H9(KmnD~jNMZ7$P$?AbLAFtEc~EcvHuEKq%v-g9k@Cp9kxZ&sO8 zsE)O5$#NC?sACIwhA}_K=$xog*CXPeI%F@PS7&dxefD@sEypJbeF7Pv=3#53le_=J z_1?yG!EVY+nQNU3GPh;!&IEJ(gg#^#^r968LQ*$Vx06oJ8y8knA5~Lvqo`1kHG<~m zomZ;F&=?EI76>1bde`c9@I+r|`W0*NChaOvI+Qhj&~CJvGYeR~bffa`X3a5X^7^n>-(CI7fzD+5T?Y|S`CTtEZ$g^KK+NXgW) z>FgYE?UsJ~o7(2;IY+!#_=|=|*KUW!~j_i73%8LSuG^dqF*j5Su(9(Q( zhw{Ow(?0g?4xie|R|*OX^6}aFk<%HL`Y--Qwg%yK zg|xfiX8w4%WAWmoKHTLE|uC5wvg&b!%M-`mq?*ASJ{Y;gJxpfwa>qy!~i?!zn*x?d*ye*BSsn6%*rwCOc5^)xOa(+fL*wBtiE$ljc%0pDs;42 zIJ!tD7QAV*lj&D^&{?H1k<5&t)@Hy-VysM=8-VAqeCJAvf#_J*wZ(j;t36-q-32?} z6w*O*Gcu#anW^iP!?_r^0Iom#3pzX7BLmBfa3HfY`tBx-jGR1I7$Tv(xW6iyzR8S& zH54$d&R+#gcP?^pEOd9+oi#}r6c0RB)8obfe00hhyj;kiB+B?d?YYp!%I109=dp*; zH|Ta!lQ(dm%gjn6UUw?HeN6_mwH-1JrH%H|Lh!ltw|j0~0R2a95vCt!fNCQR+@7Bc z>%#~M;#e6YS?tmtlpZG+v`V&9k=-MAFeHspB>II(8P5jFc=2dQnNt! z*MufA#i=$+h3`~TNhrW7Si9sj`!hbB3V*bKMjpRY!8xPGyL)wR(8J}_Q4#gKv*`=> zCS+PI>#b5=Owj@1au)aV2~RI8l$Ug@hb0zN$ zGtRBBK#EQIc(L>$;=30dg_4Av+#T|@i&(dqMnKLxp8&t#YF}9uq@>m z3jJVjC%fKIBN*wBQvvGO8MDif(Y_+#W7_8M&E?r0u2K2Xk)c6TemKgB26D1_vse!s zhqS^7XRmG-=I1S_m{coAyvX+{Z^v&w1f7x$BRP^xt2AqY8InOV&`o%GcOa*5u}@^Yp`zVp5b>t9Es6^ji(oo6-K8 ztBw-su_#TLK)~>8+_Ro^CgA%G6}I!+c^@^ubnI_h6zYuV;8{r_m9V$>A$~M}LedT# zY-FR9Z`Qld3Gf51Z3Xu`s89C-@5j}sRG0qx3IV$rg|v``ei|L>6f5HiX($LK;?S{w z_h+zZ=~+zl`J0BVpaL(}c1|FY5fuN&-XbcVl%By9X&UOW48yP;-#W#4y}F~se5(b9 zCOgvroLOMVlsJ@}+~~sA`?nmm^gN0aKIN(^Y#e43Tto$&`GeX%R<~0NC(lsO( zs!B=Okl}eYgkJJeUqQC#JQc<$!VkyBp@kcwHPT$E19uN##{^>+t;hsQ!(*LJe6^N6B3&WPRBC{6`Y7bGJ*S zr#p)SCZ zyHg%Qp?gB^3yk%&D)eh0OwrXv+r*OhmpJlS3LStf>D+>}uIzx)(u-OQxVaq?OOV7@ zh8-Q4_Q%xeG^Ju^e{*4=uOGcl_cQLimusk0Dx@w0hx$wISQk}wze`cW*g5$ z5a{dcTN@fm>X&{;dpFbFTLmZ9qq5W^2zJCoA+3`iq(@>6oKxO&RX#8g1fmL8G{(De zh%2ERiHc)4*G1t(kF|m=nY{HI-cyBD1gK1X2_${Z2nY^~G=8>ne-RzO9E-eTHk0-JW|7Ye{J2hS0kiNe@1gtzcNV=eZKL`p-kv83pt*2Gr4gI)D&7#K_9kXD&H z1#C!rNDedHloQln|IyG(Dz*aOnA^?aXNN0aGH*~7ixJzB3Gjh^RIBBkd2UOck7LH< zzeurzHiSlZDeQ*Zt0%|k{m<|8kJd@!wmCtWS)pBaf)|r!B-z`bc`N|9jn=U|EBC@b z5c}a+e^hfB42EYIUP+R*%4rMkwrMwcVc^0QMY)P|@$N2apZM_G_lZ5w$Vad+Rw3b9 zJ!h*Mu$W6L4S?8H0Snpl(3h@M@^t(#uvLmufNK0wev+IgMrWLXlbiA4 zcE9qcViNWw>{m#nAtk`3SXp*UC8`7Q8}zASKZA+3$_kp% zOCPuFnDQ8a-5QQz62g+J(!E87Px9>1e|?c zb@S_FdH}KCo4{SzZ9CC9z49Djy%_3bzK2yg=k-WcaUTTJ7}CiIMWD%`hCgTh^$CQ4 zN4Yfy5hNBI{Tb2~O1U%sa$|_9s%_&aS+RWLuL(4i=zeK$pWF1!-rjCP*IWQSAr`ZH z09g|;pbEGFcoZBS?Yt}a^J_}OfXJboA!<*03Um=eI0oFTsl0qJQ=o7384uU%N3Um* zgGzK_g0!yOdBM(CYv?@xhBAHsp8&{c+ZiED=fKE9$P91#{ihRAEAbQ_`RpDx5asQ+ z<4`>oK$Al0)t@a#%_8M}gaIKQ-FXQPVngykTFHhQt!7sSf1rvfF_UlM3^RGWhq`;? zhnus~IZua)I_W?nr<^+NAGrW_JH%r+;}8 z87na)a$B>Q0vHY=NS*g94ryP2BvWYD6udZhkOXv)2{Ub^{B%%1v)Z6-duqO?Q7pAa zRUZn@@)&-uaaC-zdA)uAmbav|^jG`V@X62^42AgJaaOvj@=NmB24~?T3~Vpc5pTG+ zC7JYL%o&M(mMP^qbh$DPk`zAcDOV&fvq5=0+5EKlLrIa#kQb@dP0gg6TX?TDx92ZP z^i9?Z&b|?zU89=l&zJYt^pv#q-SGRzO-RdEdBa){1trLK{TW`Iu2rG=l&{n-qnhBG zk&zK4JAbUYGbo6rv+I1=_*J7O;{23R-tw2Rr$%Z*yUN+gm*Mk2x->b_6dLzBcHSo5r>%5-*h|vjCWPwrC}k1> zqz=#Z9P=j2u4xn)KPQJQz_k}TV7FQYMZFjZc_4fFclg@3jb`Wuwgf}{Ld8X1=u!*Tq3{rTq<+z~ps27A|hl-F9YLw$J zDeC)zmB8mPSKnJuETi=2g-gw*HDa;0cq}`dQ5AW2hhusaE;CgP+iw49T62!Jqr`t8 zgnd6P2x~rQ79p3N>&SZ}zy-Bi&C#|kreCJx@pPSVV3l9!hNP0vK@4`iJ9%?mV^7vkp zHeOB5Eiv@fslBD)JJ2yoVvFYunNd?d70V^KGc_h>sjO-gf=^_ScgDDj_35~ zu20s}Z=;?M>hHa+%ysRDw}fy?6~@EaPxxlbj60{eWDrD5Ch*?dmeMPmT+N5{xVc^O zNfgousuR@>+jL|LuV!nhuQP}usL1>z{gD8yQl^m8*B)Fe+{tn9?fo>LKImk$1x1}o zO4QWX2xT4KWW7Tfg<6F@gQ3N3ppDckLk}5lrGm?(KgIMzhEX};nz-rg^1nIs%f37H zQD947!2;Jy(R(a|r0_+%))G-DnfVqI6X7PO0TZNZM zF;!(~O09U!g4K-}0A@)CZmD^8^u$CSruj8T3`Ep?UmY(^lrganp{zb=eNg<13urJn zPisfV?5R(j?})KN-H4C$-d;TuJ>61qZ9HhMdgOc7B_h-@Cu=alFwp4mmAUAAELw%J2lf*BjAi3NKDpI6F+j25I-3bJxq z0V_7#&5IL$miLaTd(EaPB9CEpaJ=c7X8k90cJ8Kbw4NTzpp==x*HatFomZ8S2iX#z z>;NftX$vaCZ?mZE(}Iu4Md8SbsBWqA%n2OF^oq{czD*)E-6Z7KtLklDU#=xu$Q*2!5`SZP zcVvjRYbbM5J+4amuIwlITP2=CRvEP*nVOEg5yf6bL%O@KRQ8-u`G}nuRDO?&t9cW= zW#90Gi`(`4&+?M26t{|DbzlIeJ}&jokJ@hAChyNpl+Tm9W!GSl`fx@%T<@r!yYJxp zdG73iIfBN}ZtUa7&lpWkTwIk{<7wDs;v20iDN^Er0hb78ho>z^^Wh) z@utO8Dh`fL!22Uy8kkvDheXc{Y!C(L8R6VfVXsob5axEjpHhMiIBg{RR zvY+GM5r!cPqfpj8j*HsJr{k9jNJk4syqi8fZby5WD>2+jptF8I{{@OHFNw>)^1*}L zj35EkkwNgqqq2KcD(Yaav-~07#dRDB_(p@C3CC&2m&9V))8x_=SD~k_6Lakpeq+rq z!Q&2oN^1BO)t#;=R53*h0@n+n#}Q@;td_v-Z*7f9zxaF+^JYiIF)lqs*tR$%?o)lBE zf;J#g7%S*n0w5~z7IvIk8yEDG;auJaENXS#5!c-e8{6gx3f<{3>Q#EQ9}eeBU@L2b z&{JU=3~0lT-J5cI(AocRUxhPjVho}Sns zN?ApFf2ALlD&aB^GOVrBxGQD5bh6YpFdf$NOc1uqRmgMPJmpvdA6zhy6(zStuj|&V zW|a5zId;zEFP(+P+UFzGJdlycg9c;48NI{oJ@m8gK2Y>1E{H(;}lD7QKz zo>P!sc&`q2fZ!g~_|5#ZMG-2pm_)L8BzR_3Z~ui?e_`F?w2TAXp>+oCg_FU!13eJH z_j(AiK>KN_V8Vi`Y%=T}>(0r!|Ks}8eZ)=@=5TRgn1c)cb~3Uex;rCvZLY=R*wF0g z{#aI?Hjvd%w>7bd(jbwST70hwU(&?(FBXtj?0hPSASnK>8aC6T)?rU`p~A$+$E%Jn z6}}|Jv=Y3GJh~z=UNAU5@CxVg?EOKB^bA%macgJ)Z*Bd|K&FU2dy=g-+p3o4zR-#> z8OPuw3>6XB0Z9bDo_;UW>g6px`dkq0@-j+ePbHcll~*@y~R1yTi>Rfu4m=Lm;GKNXZzz-m~{BR?tG}^Xh!w4WZqV6BVk2 zB}il#9D&STIVnfjg{&?#lNvQ0C&A#5PSW|8TQEPPDFWP7hieU)H~%+D4Upu&Kv;l7nEv6jIuE?jjU*RjiYO$i`?4eW zDt&3jzedKI^sdha7#Jsfw0k$bNBxsEO~XdmK-&6Cx+1dhuLycXqHe`w2wQH==KL>S zF&}Ke<>3Q|oRgc5W_++npeFJI8F-YAJf2nM1{EhDnVvCC&ueK*g=q<=a+A}|=zo5Y zODt7(DL`SvP&>^(%>xDEh1oNlo-&kIl42rNY???;)2rPIHM<|ya6o5>aEjU>+>)*U zkNE8`8JX!oAz^`;cNN?oMRm`~6LBn=3M}+NtSB&Y;goLjdJ+2UIqri$)LIdIQJ}7# zN`S94uQKkwxNW-yZ7sA{hY53bXM~6HJPf*my^P-{fWB4H`b@xpC)_xgcP>xyuEM9WQ`in3F>g7O=sF8Yq>+UnAX_g@RtBJS90+tz7;u`!NU zo3MTdcmO@}IEa4rJbQ5=H;Fb>>iy;TIr?|6f+&SQzS0cqc zW&$4Y)$rlk4uwTT)+DCi&Q#jYp=)9_q$P}Q>@;iXf<%{XbxFnf{4}un&_!^(iIN#$ z-`x!JYg1OH1Z+|!^Zj6iM*WB3YCGE+CF~2dG_4%bFP%e-Ajaj=V6Q|WFsz2%ovrZ^ zN|nfEAqD=hBFvzSlT4#`Hy`R067u!r^Mh}lC#Ur<9o&dPV8%<71Jng8BhyeQB~TxS z85ah2NtPfeWkSPi+f*W&hQDZx_{Ft9k!Lo)wwgBs_H$LN0%Mq{yZA2BEvsP@Kqsa& zlceie$hWXCZM%~Am#4*3dMrDcqxmv9O6dT!&g>cJ!Xs~V`R$W6Olmv+Q))jT_nB=P ze!u{_iy;FD)E-L&y2CI1{-uL>XE~_aDw?(}^{HHYyI-;46W2iV9H|fqF`3P_mVVL|5W^IRDtrO-bidHt4~;@gaU7BfSiah18gHirewvq-0`$0(uc}Bk zFff&5!B_d4QgcLFTi^Z_XrW2a*MEc-*6M<4hAoH&907gBI#mMxEm>#I1*9@s-il?? zYFAzxV=|nEM5X{eD%_t5>5B^mbo`bK_f)P;td$EpoP4nW)D15F&d~Y1;K};HT8d#X z8YK#a5gc46BaC(&haUN!G8iM$*5>ZiY64G^k{%dLZ!Xq#xsYP(2F$8th?J9wu9NB~ z4WSV)v-Nho3PdfIoUXlTJ<@sCKy~!`mdV6lKQ;vYMPslL7Vy5Pv9>c2u&S!A%(q<_ zNG6Wh{WidWfnf0KN)(!xPPw0_@anb7q)mGm$~f8fglk+d%g2QK!eA7Z9b`>f`(cFY z&UXCc%i>_Y&z{{+AveCe>FW0xhg*I0^m zpSIpR)s3IPtUp$gG%dMWxM^q01Aya{hRtBscF_sCeqRda0|wWE)939Mc5%eIBC-Lf zQ7z9*L-2R74RxzWx<0Qyc5ypTPi%k=`a(P+9k}5;fv4KPTw_HOxh!5Vt`V5qKNB&}*l=}54Zh1$Y@eF@s()k%#k z8a!ynv6(?(0vd}kEKgx$gptWyFfL>-9-<0aBA+s28fmG1KR_;kX96b-a^a`?VhRem zXw?KgX(L_wpC0I#Y|g<5cg_|XXS@>piS?qk9G zjJL1(M9mV^BxDidK-j@GXfxp0yZraG6*`hKQcgQ%%Z@1W$)0yp3z(J z03QWZ4Mj=w8lGJuhunpI%KK-#d)ysHFysn*j8gnpZ?7kyrJ2zAu5jCqnP==!U5Y&A zaGSE_lPrUskyydj+j`go)(N(sHz_dQCawj!O%@q-yr`!ZoMI{?IfQ?zDe#;W4)(l- z!kT6DK$QZ=88U?la!RU;{%U|6>P3MBCMCXKgg@5>OEK9#9M%qpyIUNBK%mt&|%@b z|AF%a4IP4tC0>skl(Lc@NYWI$$<^MaAu5u;p8FVv*og%3r_fFeR9pbj7(X+43bRW# z`RkOgC)j`ayQ)os=fFIXvpz1DP`m=_C@{&WA+JRKb?^5>312|29bm3VL^;V zFq%kKm^lTexR^@(jixF5_cf%~kNRsUUk)zl!}?oB^289ZfD&7{ejU1H;ARXPNkXnG zV69af2V9PLlaM~+Y#s}|e(^ft)oWgu6e5KglS_LFtV23%HoC9aR@$*d}z*TtX zN>Fvzj58w?+vyKaMAkgU&UXfp?)Ebq0Cb4q*v=DrW8we0YxVlTWvCBB@b7;{U=orT z;T(VqnL`^|uJ>;W@{pR8?_}JGq0*Z;xFj8m;oO;aaa4y{2x7 z@b(K(?oS+ffRd7uJPwjVgIgzPU6Xeba3pl2>?(8vToJTqytWy?vALXtw%F-nTyOVG5B zw-6~a95neR5%8$c`4VEBUC>zBXm?F;u!;MWpx99C$vC1cKNJ@0yNa{)gra)=&t zLL{XO*T9_96+OZfz}n!L30kUql{4U|U*ItJMkF|S07Cd6=ysBP!^ZJ|=?(Cd_{e2^ zW_n%&*e~M&57!{>6rf1<{y*O9fV_y99m$2^pUh%J=n7jG$pnXYWvOb#6G1hsaA z_$w7S+g$$a=WJMMxIL)89Q7CE>E|Jy@jQ`3hmhrV(3no!9Dn5snaFXpS87&%p-}4E%hL>ZHb^Jhr85a$1FrBFVT|vKPA*Q)2T!R174~9_eVohP z{^&N1lP5I*bQ2`JDfM#UD)i+^O^`6C4b!8nc{Sk6%9Q2j7rs)4&G%xjWSFNDJz?*! zCs0HG3j;Gut}_#xi&}ue^0+~L1W|$du$V9th|{qrmONlp87y>fV#H%@TbO7!FQVPv z`2D)ZM!5hH=GR}CEK@b1HDcL?SzWy9f!$By`}mmhILE%z495H0_yIi1X-$4MY=n{G7aqJKytF=Rx2 zi*kbgeUfkLoU%Rwi6bHdg9J6@Ng^U|{_eM4X7DX4*h^61FMn6e$AV)|uig|$y)XP* z=z=SCsV%Vd$kr;j{mrk-2ai!AL_=E6@5p_q$MU>^4sdMr=2{8N!f5JB(4nu9Kf9Vm~ zFe}8`VIR>TwADeEO{O8zk9~gK*(iWInGrDABe%c5m@VmUCr+vW-UT7r%9bcbL+KYp z=xOhcHe}SJg;9CTwkeo?#s=GOSQKr$Y;A4JH5~)a(V3jC=r(PN7%D-Di zZQvI<^v>_Z&w)`cqOgZ_DA+z%{b8s&*5;aW*sH56`^j_Rq?n`xzS)1+zgT^J!p8x% zrUw-~u1=)*%v9}TZ9E8p?Mu4oZWomB7|%Mz=F9>6L4;ud2ZHMTl!`NgT^QQWz>SOoCl-7&7iF^3vsVtL+=qnn>o|=)iLQ1;4DD7>4HdOXUo)VE;y+(row@s?71)#t zrj7hT#FYIP(cc<*Hm6uMHXfd z!|wqRqg(M8dfOlG?|4D5a+o?pg~1q%1N0yGbXR!$ye^}wJXaxdlp^s@CBae5iVDMA zpFLS#FAAPhM1F)5ZzX+0BDoenYtfSL4*t6)mR5Aqn{hYsP2c`8&8i2yU$u>MQJ?fo zr~Wd~HnT(y=I)K@+N;4EwW3^5A;m}V8jSfpdSUTmODeq3g&eRa1>ST~G+c2jo)|SZ zW4<^TgR&+%-xAS}6ST{CON2(=f2Y&?n|E_RE|07x`2eMJ(f66I5wn{zF}vmSGf5Lh znw=Y@pISjtes`tV1#BPJ*0tsGv+dM8*_}j9Ky@ND;{Ud1U%4gS;U~QjhEl!MjTzS`@Wu zA#g^0Fr;ZOfgvrB_}s=>`){KWgy7SY-Sx%@MUWBub42@|5TmPDhrd>BXt!I(#g7Yu zG^5d%#oDpAXk0FL1GG#O?Sy}+$%>K^eoTFmCg6u-S)eCrBSC~T!WGb{Qcf5e|Co!C=NHID$91w>5UU`q6_J1;mbrQlkN#A~0U>>F zBS{K=r#+j~0Vl6UYkAPdjxU+P>mtNEMKt%Mq>NO-(*#`Sv=OKYVaaR|w#K#VtttfZh1Ld-h-t12hqN+5Rz%pw@j~CawL*QM?jP zSb680EAlAl6_s1H4KYBch;etI$6tG6WWPH=aIb_O@XWb#D$hA|o^vV3t6dx#I5OADHUiqSu+OU)MHNBz=~UjwH}<;DNYEVG==S)^#_YdGBOqrO{mff#*u!z9g`@9ZI>Yo@Q`0up~CBF&;5A8aMbDr-lFJNToZ9B3hLPT;42mO7QUq)_pS{Vc4am zrI2x{`(eTkvfc858(F!JZ!v*)oQRsc!p7w!Eoe}Sa;|tkGa;>w=a+;auTfJ=eF-3m zTT4@s0nf^4i7uwX1+}#DOeC@HpVlYE67Tt3jCq!Qy;kK#TJe`6+_Qko0 zW`1tOTw$LKPx<5Y&?btfN%u+P(LKWRY)VY}5B9Y4#0OVnnz{<=%I+?7&CNXW&m5!! zR8D)Dy)Nqf<|UQ|j^#qo{Up*M<)+&rKwVCO2b!`}ugr7by)CCiyZ9N_j{EZf<5^|$9jw0Rta*1cXT4B^+ev)yup zd^r~}H{P63$JDu@ldfKr6s(acLF^SjI?u8n%a=nSqoWpwoYn zCCN~J&ld?`qDr-2VJkWvao_Cc)4o63)Vn@5fK{*KizJ%jArpwBo#52PWVU(PGh2cM zGAdv@{2Wz#vw*8%|K8&dKbipT&(*m7^Oy$cz+!jHFhPhk@B4@E!Iq$b$WKI|j1KGm ziN*4im}Q+avnt$kaEPD{_#DB?-X!q5>>NM~N7oBc6c5dhxj z*|!JUONgHR%(eVPH>S8`TYqzsyV{{MC%EI0{&?tlH^Fab-ByHbcVLlww)}P#pdre-kg@7mNscgpIe(54Vz(I^O$2%;Lv29UVksKNSpST#a()qlh@s)3+7<23s z(k!ub){pgE)+?PgJApO63rg0vS1laIc#pyHs?^s^DAd5*S@|!rXpVDduNt>Gzn$`2 z(WB+7{c-n>lYP(I*fv#I?L4_Jb_+xku0$OF<8*%Nmm#oaYeLVcODyYc>*2?PH}fgL zsjUq`+X&t4(;z-yNk10A6mk`q_jS-*?tE-u_&g`oQDW`IU111CzNZc3?IpK+g|G)~ z7k8RjWMsF0yNPp99M*03-@dbOGy;lVKqvY!RCMRa**Dsc+WHioai!t=r z>V2vm^?dlz+!g+f?u_;j&rg}HxUo{vN|IgP?dA50d?CK*ZcsYO!^f$062w)jYLXke zbbHIo@$BJ`N!?I^uf@+x@ptDtZiRt&SDXV|14qgb5G0eh3&b^l(j!Rn+nHqvT<4z4 z8!O)hZI!kFQjf1)J23?56e^{Qur_d23wSklt{}{{sB&IPxEj1(+1z&X?PuTNq+O27 z^1IHQB+Snq6kUU6E;y6Lf2@_$CVTq+#hy=UrL4}<)6*VumExDm&ZW~sWZ*_qpYF-a z`iBMUW-#I?*k_K`LeCfgxL8d5zW{F8*;NP?k)qxd-M@vbJ=^$NFLZ$$`Otfe^4``r z`O=tYLR;M71aCwQCrS@PQ=Bd((hLhbUni)}zEpuqPsO0GE7@iNDN)4Px+LUlr7_P( zLj~E)(+dh?27cfTKwh*rJ&xmHTm%8{z^$PGw#5{ZejkY>07>I`OFq#BUfH3~@9Sr6 zUjw5vlt@8sairL3(QLhY(buV!F^OCl!K0v7_HVDr=*%Hg9Yc)^T`N;DmENiDts8Ae z^Vb`LmF699(iBMKZgc37PZ`vf1u7wJ46PEJgTM$PhCj-uiRKxwql0KA8_L>pZwd$T zxYY&`OxNF%VkRvCHl6EIQeW(NM$^Z8H57^zoYp5RdoKFo3Z?d3u^i#};_pXQV3(>> zZ-^N(W+Ql&z~mFNa8C6Ke46o1EfZ=Z!=yN9;e2FS*cJw1W974ls+@eV&8}cTn0$F- zFA-&1aw`77pNU!76@^mAR-exZ_jpyGTadM$ywJ$zT3jtH;NQI7ea14YM+ey0 zLR{?uOL&9A@^Tcvvrh1bm%1U!4=pl|(iI}Cm$U}mqET01OR848c?gPo-k)KE2uR(J z1+VH(=DS(Bp?a-nER4l)fZxhX5F;h7L#UJTuRq{L3X%;1gESXqTt#3@&SBe~XHg^J zTlGTQvkOc`0~m}VISHK;d7U<0O-l>w066$nnb(fKWs&pOETct&D0LwBGK3AucVjUK zedGx9gLL{W-?@j!ov2qr{hHCgUT{bo?VqXdrFK0Nr9G_OBPpxn1ed>GR?p!nvF9yP zBp>pPYxnR9n{8!#iOwpbDs(UshTe?qE-6pa6fM2o_t;~hVzlzcE0(8RB}+z(9p1Yy zyy<^0-w@3Gc3+3kh10>hN29*N-d+T(X_AF=Py>9f%rCCv9a@=Vr;?7fGQ%Ie$L==S zglJShSCk3dk>B%q>8aqb6R`giVRpNmZE9#Eu(MrpA)N!Tp zP`zRM%s7~_WCq!?OeD#^6e6Y)vL{P~>=A!dim}ZiM6y(}H~QNvgd~xn&5$ih*+TZh z2xTAdGygB|@BQ%3r}=P}=Q-zj&VAq4eO(vV!@anNUNQLVtQ;qbY74W-tl7ez+0=&* zk9k?ikKXS>L1ok6q|OP-K7kE;9qKT_99R z2(<|RW%GedwNQ{_Z!wYooE+93nHUy9gx0&WNFXMujwq0nb?3Lf1P5(Q$*BU5m{rBj zY`cOCrX<_pLWuV#YM^Vd4Iq^Z9m*Hw>sbhy&_&ta1M}))?#7fJ0x4$zzqf8e$`PDHIBPv{n#46MqOx&W__FX8+FwW2x`END zHM;G$K2YmW!cHRf>EWz%m430&CjzG8yMfvcWbf8@uHiYDSq-~0E*0f5eUQV%U?ZWR zBPaLbPI-k@^;J8Xyz;BdH){c)Ee3*z`6;XSRV(G+rk+=U79pxW9YNOZgg*^t_8pK( z;%;T5rvS3`AFTWUJ4^2YDIu8Quk8KBk6oRl=l(hp;tHYgHAkEISYpm+gquI&T{s6n z>Wg*)Ns(*Fy5xU*W2u|rGdy^uZ&gLop74$vWWcpkj^+=Pc7HN9psaTe$ z20*>>p`>4u)pbGMUAu9o{uAmU7(*J$LSt-w}ByBOE z0Eh#_ihkLfw7E+md}bs)7%as?$j?uCmmIRCgajW7_U>)&Af<9tf;9!oCtm};Y`!hR z`EyF2LlDEHLF>`Ixa;md&AchgKu&OeKNv%ohI>)O;OqFE)q=9e?D)eneB8^A6!N2L zpG2p$%+DCIv`S1&zAT=qQZzTpv%Qsk^y3#agqSyTAl)KSw^bo2~?T zG^)5DY=j9u%>y+I%?rp$jeS5mf?&n!p&4?2@ows4Cy;ccRzM5faBQ-6#NU9GG6xwM znQ;de-v&%oJA6-O1F>eT`?I@oXN|g9EtD#@IB=~sw9>i$Z>png@IAXb5|#%>5X-Y> zhNQQaZ!}T&@uUYN{(NJ>0jH%I&uV=OL-m=^GEmcWbA8+SdZH&Y_~DCK@_%g~GM*iL zPlm6Ammht`pr;8(&nBO4Q#`8z6%LkI?zp*bdBzNl$Vro8DT4`1l1K~&fa1&DY=jPm znTkbJO{7`xg|S!&!$VxrDrxfnz&5Ytf{-#vDcTnIxkQUc9UA354*{bL9J2jdg5M@J zVy>uQE&bAo7qSsD5d3j*q=6Yu&=Fa2*CT!A#Nq^5Tz^Y&3rpz@;)Cej>%S;l-y>H# zsnZvo)MUeCp?7KxHx@RtPSnvvA~!N9C^}V57LS(!NlTThhSmcJf4!5Kfy9eX4TV8hB&G9*~gbMEo{; z?13=AmmUN!W6-ZKf~G#YJ1bT6@%=)0 zBF-+kLMHD!SCFpDQv}39vLN;uC<<65)_GcV)Rr>n(;!*cq{(9B+?rMlGkU1?1ToL{ z@P5cC21)Z5-?Em27N}G5l%U4nG1CP%v53Lf2|Gah1?D7bR`adfI7(vm>zP7+FkGb= zWalQtJzcJK8;IrtWo zDg`oa)@~u8W=NSikSX~Qz*6W=hzoUryoDeI2D&TO zCn5xBn&0hCckWxWbMLt*M>gexE;?`pgjVqIc(vr;kY@E`4PiwkCHA1#e}q(dSj+;e z^(XE5G|LhP8wdr93i>|a{(IF2KkJos@K8A-^!vuyVsxB!SSOY8=FJG>BEPhx4dN;1$&4aS?6%}6}^e67+;T`$FL&k7bvK~wyZz2jsF}<_SxY6$5 z1ff#f{0SW_^*WimezejIXxUa01@NGqU(8r`c zu&>X%|KuQt!GW*;^!sQ%LLo-AG-es=U<=>baB(a?%$5CF{68XGyqCIJ z!Wou=y~!bc6X?&d@T3^-D@)CE%Qkx6DQmHAJXNZ;tr#ffpI^B@M=s~&9PxBQ>i4|( z*ihFi8w^n8e4oRI+2H>)8CdNb^HwoIkrO#&XYR;Rr?ZxyAB&X?!Y`4rFG5nABos36*K;?F3mYWt42~aJ1}x z(7`mF0+v3=?K=6VWkKzx1XY;CyxX$mdt z*KXC}?mrB4>pUJZ>?zAeVFX#yb3GvCmM#VT7)*}|;Iz2%xJGa2idk5BX|&J`j>32; zBRfHa?u~gAtF9zBvShQb(DeL^^}i~6+ler-;hGS_t)(nc8vksVxJw>uCR?4yNTY#l zQyL*UyH*|~aqZLd;Q;CNp#pCq61#$<`nrtNz=lkpr@BwtaLxhs)3Y5}8l6`V%ONKK z=7#4)Wc9D5SLzAmYG1L5ZxMCUQSA{i2w$Bwk8=#q*^6xMtp!@C%}0((!7T?yg9x{T z+k}L>kElrRI~p+d`;BYZebaTIP1>OSt=+`{_m5EgDuz667)voHDJl`S&bIJLpWZ({|f~)W3GNxS=m%*Y|cP4&)o|@e!g)EMS?p3 zItL4Tvhn9?iX+M5Xxpkv8k<}TjqO&aF$~I3WxvPDNUu1Oxv{#G;SvfQTWhNU}_O?=#PnpzJ3#tQ2*E2PKf(w+=+hPR3U^tcHStSflK8>ICfeY ztvUF)66MZ_E(CFGOQ^FklS3CLY9xSHnMBFMvd70xKa;ox6a9F&TXkl&gCo&kRbYlOBz}L&MgJ5 z5`ceVzR&q~To5iekF?5=(!KF?d1w18Ia3SX1;M4s81nkK5+108#hrr{YD1Q;L&v}4 z;BeCTFH-^BQfMd*&1~(=+ugso-LP_IO9_cnYSC}aVUO_|7)#J^J6w0+6_$EfnCQke9`CvuGnYvMq8aEW;&zmutWE#<~2v z5NbPWgn1Lqy!bOG5iSGXA~xeS1}}e_ajwb4VrGqR?dW50OBV=fMN#FdMOHT-jg`wo`%oh3Pbg# zMw^uvgvGPLuSS<*>xcnkI-%wxseTHuTFplHPzHTFPAO#MUWX6QTva*Tp~ut?4Cn|L zeEwVCXtUM*frS%{KPoOT^@ax#5is6P2_5;~m)_c_8 zLOZw7rU(jvMnx2wMbprTxgnNHbO|)i#>e&KZygo8bLnFE-0ZlZW3cZBKn@dS>y*|N z6?VH{jYYP&32oRN;ma~TRE`Y6+Wz4&ab-M9xVZUus)DMdgYa9{`dacff8MjOdWpi_tt%SZKhq@ZW=|hT~E}>R3>k0 z$9v#kafhk9N9Ve2L)Bd1&R@0^2D$u~B=}dMbGn|E)tor@Mao{9IpW9ItL1 z4$JK)1%@PUS-#>iM1f|5sM=CXF)n`yw~u*MO9er6AOA;S-b#zjz+!XYnML;P;Xiyl zpC4+6uUb8{$mVPX4L*c*6Q9im)uTu4wNiwllUun0wvtQ)l_h$HuPOo|bUSx!u^c_FpYT`Tc^4Hg&^@kd;(Af|{M!^w$)yih3WFma# zU^(Z4C-2FYo~-wO7Zj9u^F~9r6ho)~Gkv?vH(Py8cBI`mg0dy%>>AnPLK6<0cSOT@ zE6vSN)pK|nUl{^!mu^PwR?~$Y0IyiPAE2Zl=FmQswrQ~cED}A@0#Zhy|241kR};|% zJhY5?)#P5ovCn1a3^YFu=@X~gzgW~dErewdwjE?u7-+1^3!7L|%gNmSW{@(RndeR@YzD?KdCqGP!4=BODh@Ky1cjuiQ zEtc*QhJzQgk4Y_EIgk2OymOi9q(2v!7$ zngaQZM)C|=@=K0_XOOxv6gJWBahQTR6sJ+dy2cqK(cI$z9|p>W6Hqvq-+cmy^0IKd z+e|&u`*SiLDow7uRwjQEC;Zfl3z$9~L~rk4s%XGs6>o5IzD}BidG^Lo8dWH(dS=Y( zcIw0_K&VZHE3+`ZXfj%ZeQw2PbIk2v)?G9}lJbEY55*8}h(s(DbSvzd9g6(|-oW)#R_auq94U=rNgxqh`_z?kfr|QbY2T>!2 zFgaJfo#p9uPv1M^WPYvS@6!6WTP~iY5MiDN9;ny{rp@cSjcRTm%)d@3(`>D*!vM1g z@=hypzJ#KGL)36R^4sq_f5d1%D)+bfi@4{Uks5YEac8#%mSwe~z>%Agaqo2mQ0(Na zzSl#7M=mpePN!H%kqMs5NppV*F{H|F!uebSu+W)F@+Wl2!8~L?S&^eMEo^Pm|Gl*FCGZtEQ~nzN6Gu z>iFj^%sRyjR#)OJ(M&+0UY|L4*_I#SCl9=P9{Wl7@~Eh&Fj8w#zDg#GNlO*q8?&$f z;S}QeSZ|RNnC%%7eYIE|4R8;Z*Jfip-V*-sK~gn_yOOu!xd^P=ArX*gA9HYiqaT=- z@(LAhGy$?_boeGcX`=&_wv#4+%q`W$7)HjQ0gp?TTyh@uP8L@q@F0VeW9sFL{+llXPJZh7 zn@;d|lHe%P_4rfwiCQ=?GJJ>1c=$71HE3}UV{qzibMrEx`0MqO4|M?7VWAH!68-=4 d_YkRhmoLj Date: Thu, 26 Apr 2018 17:57:31 +0100 Subject: [PATCH 24/35] Automatisation of setup creation. --- Scripts/kiwi_icon.png | Bin 0 -> 24099 bytes Scripts/setup-Win32.iss | 64 ++++++++++++++++++++++++++++++++++++++++ Scripts/setup-x64.iss | 64 ++++++++++++++++++++++++++++++++++++++++ appveyor.yml | 6 ++-- 4 files changed, 132 insertions(+), 2 deletions(-) create mode 100644 Scripts/kiwi_icon.png create mode 100644 Scripts/setup-Win32.iss create mode 100644 Scripts/setup-x64.iss diff --git a/Scripts/kiwi_icon.png b/Scripts/kiwi_icon.png new file mode 100644 index 0000000000000000000000000000000000000000..abf618831b038fcb58be937b99574df6176c4875 GIT binary patch literal 24099 zcmZ_02UJsC(=d7x0)!@^7YhMFdhgPL^xlyUQUnA+0Vz@vK%|L)NJrpNib(Grf=UrY z5TpoFR6yxSFCn=nKJWYe-~I2pu9Zc~oar-r_Uzfl8yjlTP_k1306?Rot!@ecQ1C4j zfRllL_JhBif`1_Xrdl_Es!x|z!4DMow5|OCfQo_mf&e*rtROg*r@2*tm4W_s7vH-g zw_JUl-9&=#-UFclKr#3_`1Y<_z%69(U2h-%>%mG~e<7}e?}=ZFav}eM1b8WNSs553 z)qMTjkkTSjB4S+1lt?5}(a-hvbyIcC|2z(UQsVLm2)K7$R5U0kNF+#7#MjSVR9s$O zUQ|p%R6;@+gb?-*@d>yUEbQZd^e|oK zMaL(=%?~8@pQr!J;Qv3we{d;^64mv;)c3D#{(cJ@N10Ml^nVPkOi8ODkOlxKKu2BG zJQ%Xs8T#b%RQNCJX8x{MElQm3m)uNU9|LL;pkxl6u6KW1gys~_G_&AC+Z9Cf$FO}vQX##rTx z;tkJ-H+pU*j&y}aH2bDD`!3iXeL2G!hEx9TO1}Q!({@ixwql_4vA}yu<6RhnI;*>UZ+v`wC7lL};7bIc zg+jZ}ZTX=tF0@aY<{G!fB5Qr3UY?j;{Fbzu?Y$?+_0MgGXwvbuQE!8+d}Rq2<$6^B zDo>9Bmf)EcnvAHuZ_R{I`SBle1 zalI!*k%ltAF(Ke2_+3B$rB1dAt%6QybFYkv4aG-QNfMG_ODIg$JL=NnMG&>`m15;^ zii-V(>RBV~cH-bVY%{9xb4y^}eV9Xg?%)GX4DcHoQ;p+79DWxSB@Z?5--$45Z*!C` zl3}CElATlTCnt+yc)~dl$M;pv0Dvqugo=sqM;^9^jTeck7SKRz;aSYkt7Lb0Jub(^ zB)w07BLPNvDzjG<+K%`}uOy?~)Wxx6l}j&jIuSLzPVcdK*$?IFee5?w$QWk)uNKdO z%Jn%TUq3~_qm>QL!cnyfdeGr2=zCO#_J?w6C>$g4+U&Lf6n1WYEGK6Rjf?aSd1f04 zK1KSrlQ4>8CxO0V{w~t=~E6=0*L_z050n#H7B=yd^&}s z{r33&>aTZMc6*#i7qXAQ+h4LicD~HqOJ7M(jIT{KfLJ{#{K8gXef|Bzm(Fuw;hNj- zhMClf*J>nk3;*CgztT!(v6op^MJ51HWWt3r%Bu*OKe==`hHE>t%$8!Ls)b0XCOl78 zlH%Gb7av@%cb^B;Z(BlHXXqqN#u4Uv^$#Ao00F(`Z0$hPqp_dfelHIEWDYIj%7os_gp`1?F z-+!cr?%9f)QLJ8B3>(MR5t5vIgD#pnt>zUxbvu02PKxgraOjgwnzVdbafTo6z!+szgiZLj4n_h5kn1?3)kI5*EIJv7$ZT8v*6 zova2Nug^|PdsR*l^5ko-oH<8)^V!|IF8CmSo2h`is>` z*S)wOgDHuPE=7w@_6Z^@e}qr1&O{f06n?pHoh5vZ+wKfn{bN&k&Fheux|p~|J*4vI zIzoOjP%~Dfj4QlJ0Dc3e>B;+hH+#pwFhDyg#FPtVa|Je30rQ@ryAKqDcNTYc{od)X zziREKq4MQ4z7I{xj*Oi7URGAtnh^ck{D2N%x-UC?&U9aD;t`4x8bDQqDcv!KVQ!T6 zN{57ng`r=Wr1gfa-B0EL)3vcYbPr7GJ4BzqS+&AcE(XQA#18$&Yr3FT_O_2&a?HWZ zJP?UtsNNO}+7b*p;K{bIs@2oe>%rloJl(9QKfO?3L0+I#D|mynAu;{#zv~3U zr1`|VGX|ai31&*SfwsX8#YTrhDe&H%6xvjganZ)C1EF-(-Xe5`(pVnfqFPc&%Hw>J ze!r=048s$O%^ruGO`g%_qv7^j#fE}K#i&P-PgGJSq3Wt95k=C4VH~cvAW$S#0?$&d zL^Wa8|H+Ohq>JA)s(pWIA#nEYaC_L+M&g0mwCTN-k8D>dKS{MSBs5~i9s!c10R`l6 zAO@dSdMM34v~c?o`u-;`+GG0T)^^dSod!B%y2u-Vs*{@Ftkf90aXHPmelxQAWgB%L zIEIVQ-KvjQMc!xSU~ea%IyG=uH)sE7gUxgPJHt*pm*447pz6-)di|5Dd|2DMghf5k z%Sv`A6UJ0JF#I)WTeJ5MFfVyirY7vU9qU5hDg?N5%&juOQs}$Tm$H}!n_n*Fw zjB*MLoa7nrsBtUSL&_;CDM_zt#3)w5px9f#22tIKETTi~c!mqPWit(D+bW1layt|g z53t8eFxP~C8Yq!u&m^D7`T32P(8OBn%0(G}XrD~CQ|>)NA`S4FqK;{i5l8#lZ>QK0 zDe|Y^*FxD`wU`It6^`9q@`*n`DX6f23*GKo%&_$lmwrv^K9X-?$-p~&xyx^PMyWk$ z`*dA)A#AVI(8lWiD+F*M9~fKe?znVGx~F@qFvKDI5wJ7(qD)}ifLfbMwfPrUk-+O4 z1)9pZ|urNF=G^8_kFCNSRjNm z;MT=yc|vrd4L}jhs`gzmkCUq__wjN6w$D?Rl;wCj=pk=pYhO6_303gG6RKm8pU{og z<#c*T3XAnnn5`MkK}Ll-2Pd5EmQ4*w;Tc|AVhW_I(C55N`Efh*fK+Hsbn5yz{m$s8 z7wycfEKU@{rLJ&H9(KmnD~jNMZ7$P$?AbLAFtEc~EcvHuEKq%v-g9k@Cp9kxZ&sO8 zsE)O5$#NC?sACIwhA}_K=$xog*CXPeI%F@PS7&dxefD@sEypJbeF7Pv=3#53le_=J z_1?yG!EVY+nQNU3GPh;!&IEJ(gg#^#^r968LQ*$Vx06oJ8y8knA5~Lvqo`1kHG<~m zomZ;F&=?EI76>1bde`c9@I+r|`W0*NChaOvI+Qhj&~CJvGYeR~bffa`X3a5X^7^n>-(CI7fzD+5T?Y|S`CTtEZ$g^KK+NXgW) z>FgYE?UsJ~o7(2;IY+!#_=|=|*KUW!~j_i73%8LSuG^dqF*j5Su(9(Q( zhw{Ow(?0g?4xie|R|*OX^6}aFk<%HL`Y--Qwg%yK zg|xfiX8w4%WAWmoKHTLE|uC5wvg&b!%M-`mq?*ASJ{Y;gJxpfwa>qy!~i?!zn*x?d*ye*BSsn6%*rwCOc5^)xOa(+fL*wBtiE$ljc%0pDs;42 zIJ!tD7QAV*lj&D^&{?H1k<5&t)@Hy-VysM=8-VAqeCJAvf#_J*wZ(j;t36-q-32?} z6w*O*Gcu#anW^iP!?_r^0Iom#3pzX7BLmBfa3HfY`tBx-jGR1I7$Tv(xW6iyzR8S& zH54$d&R+#gcP?^pEOd9+oi#}r6c0RB)8obfe00hhyj;kiB+B?d?YYp!%I109=dp*; zH|Ta!lQ(dm%gjn6UUw?HeN6_mwH-1JrH%H|Lh!ltw|j0~0R2a95vCt!fNCQR+@7Bc z>%#~M;#e6YS?tmtlpZG+v`V&9k=-MAFeHspB>II(8P5jFc=2dQnNt! z*MufA#i=$+h3`~TNhrW7Si9sj`!hbB3V*bKMjpRY!8xPGyL)wR(8J}_Q4#gKv*`=> zCS+PI>#b5=Owj@1au)aV2~RI8l$Ug@hb0zN$ zGtRBBK#EQIc(L>$;=30dg_4Av+#T|@i&(dqMnKLxp8&t#YF}9uq@>m z3jJVjC%fKIBN*wBQvvGO8MDif(Y_+#W7_8M&E?r0u2K2Xk)c6TemKgB26D1_vse!s zhqS^7XRmG-=I1S_m{coAyvX+{Z^v&w1f7x$BRP^xt2AqY8InOV&`o%GcOa*5u}@^Yp`zVp5b>t9Es6^ji(oo6-K8 ztBw-su_#TLK)~>8+_Ro^CgA%G6}I!+c^@^ubnI_h6zYuV;8{r_m9V$>A$~M}LedT# zY-FR9Z`Qld3Gf51Z3Xu`s89C-@5j}sRG0qx3IV$rg|v``ei|L>6f5HiX($LK;?S{w z_h+zZ=~+zl`J0BVpaL(}c1|FY5fuN&-XbcVl%By9X&UOW48yP;-#W#4y}F~se5(b9 zCOgvroLOMVlsJ@}+~~sA`?nmm^gN0aKIN(^Y#e43Tto$&`GeX%R<~0NC(lsO( zs!B=Okl}eYgkJJeUqQC#JQc<$!VkyBp@kcwHPT$E19uN##{^>+t;hsQ!(*LJe6^N6B3&WPRBC{6`Y7bGJ*S zr#p)SCZ zyHg%Qp?gB^3yk%&D)eh0OwrXv+r*OhmpJlS3LStf>D+>}uIzx)(u-OQxVaq?OOV7@ zh8-Q4_Q%xeG^Ju^e{*4=uOGcl_cQLimusk0Dx@w0hx$wISQk}wze`cW*g5$ z5a{dcTN@fm>X&{;dpFbFTLmZ9qq5W^2zJCoA+3`iq(@>6oKxO&RX#8g1fmL8G{(De zh%2ERiHc)4*G1t(kF|m=nY{HI-cyBD1gK1X2_${Z2nY^~G=8>ne-RzO9E-eTHk0-JW|7Ye{J2hS0kiNe@1gtzcNV=eZKL`p-kv83pt*2Gr4gI)D&7#K_9kXD&H z1#C!rNDedHloQln|IyG(Dz*aOnA^?aXNN0aGH*~7ixJzB3Gjh^RIBBkd2UOck7LH< zzeurzHiSlZDeQ*Zt0%|k{m<|8kJd@!wmCtWS)pBaf)|r!B-z`bc`N|9jn=U|EBC@b z5c}a+e^hfB42EYIUP+R*%4rMkwrMwcVc^0QMY)P|@$N2apZM_G_lZ5w$Vad+Rw3b9 zJ!h*Mu$W6L4S?8H0Snpl(3h@M@^t(#uvLmufNK0wev+IgMrWLXlbiA4 zcE9qcViNWw>{m#nAtk`3SXp*UC8`7Q8}zASKZA+3$_kp% zOCPuFnDQ8a-5QQz62g+J(!E87Px9>1e|?c zb@S_FdH}KCo4{SzZ9CC9z49Djy%_3bzK2yg=k-WcaUTTJ7}CiIMWD%`hCgTh^$CQ4 zN4Yfy5hNBI{Tb2~O1U%sa$|_9s%_&aS+RWLuL(4i=zeK$pWF1!-rjCP*IWQSAr`ZH z09g|;pbEGFcoZBS?Yt}a^J_}OfXJboA!<*03Um=eI0oFTsl0qJQ=o7384uU%N3Um* zgGzK_g0!yOdBM(CYv?@xhBAHsp8&{c+ZiED=fKE9$P91#{ihRAEAbQ_`RpDx5asQ+ z<4`>oK$Al0)t@a#%_8M}gaIKQ-FXQPVngykTFHhQt!7sSf1rvfF_UlM3^RGWhq`;? zhnus~IZua)I_W?nr<^+NAGrW_JH%r+;}8 z87na)a$B>Q0vHY=NS*g94ryP2BvWYD6udZhkOXv)2{Ub^{B%%1v)Z6-duqO?Q7pAa zRUZn@@)&-uaaC-zdA)uAmbav|^jG`V@X62^42AgJaaOvj@=NmB24~?T3~Vpc5pTG+ zC7JYL%o&M(mMP^qbh$DPk`zAcDOV&fvq5=0+5EKlLrIa#kQb@dP0gg6TX?TDx92ZP z^i9?Z&b|?zU89=l&zJYt^pv#q-SGRzO-RdEdBa){1trLK{TW`Iu2rG=l&{n-qnhBG zk&zK4JAbUYGbo6rv+I1=_*J7O;{23R-tw2Rr$%Z*yUN+gm*Mk2x->b_6dLzBcHSo5r>%5-*h|vjCWPwrC}k1> zqz=#Z9P=j2u4xn)KPQJQz_k}TV7FQYMZFjZc_4fFclg@3jb`Wuwgf}{Ld8X1=u!*Tq3{rTq<+z~ps27A|hl-F9YLw$J zDeC)zmB8mPSKnJuETi=2g-gw*HDa;0cq}`dQ5AW2hhusaE;CgP+iw49T62!Jqr`t8 zgnd6P2x~rQ79p3N>&SZ}zy-Bi&C#|kreCJx@pPSVV3l9!hNP0vK@4`iJ9%?mV^7vkp zHeOB5Eiv@fslBD)JJ2yoVvFYunNd?d70V^KGc_h>sjO-gf=^_ScgDDj_35~ zu20s}Z=;?M>hHa+%ysRDw}fy?6~@EaPxxlbj60{eWDrD5Ch*?dmeMPmT+N5{xVc^O zNfgousuR@>+jL|LuV!nhuQP}usL1>z{gD8yQl^m8*B)Fe+{tn9?fo>LKImk$1x1}o zO4QWX2xT4KWW7Tfg<6F@gQ3N3ppDckLk}5lrGm?(KgIMzhEX};nz-rg^1nIs%f37H zQD947!2;Jy(R(a|r0_+%))G-DnfVqI6X7PO0TZNZM zF;!(~O09U!g4K-}0A@)CZmD^8^u$CSruj8T3`Ep?UmY(^lrganp{zb=eNg<13urJn zPisfV?5R(j?})KN-H4C$-d;TuJ>61qZ9HhMdgOc7B_h-@Cu=alFwp4mmAUAAELw%J2lf*BjAi3NKDpI6F+j25I-3bJxq z0V_7#&5IL$miLaTd(EaPB9CEpaJ=c7X8k90cJ8Kbw4NTzpp==x*HatFomZ8S2iX#z z>;NftX$vaCZ?mZE(}Iu4Md8SbsBWqA%n2OF^oq{czD*)E-6Z7KtLklDU#=xu$Q*2!5`SZP zcVvjRYbbM5J+4amuIwlITP2=CRvEP*nVOEg5yf6bL%O@KRQ8-u`G}nuRDO?&t9cW= zW#90Gi`(`4&+?M26t{|DbzlIeJ}&jokJ@hAChyNpl+Tm9W!GSl`fx@%T<@r!yYJxp zdG73iIfBN}ZtUa7&lpWkTwIk{<7wDs;v20iDN^Er0hb78ho>z^^Wh) z@utO8Dh`fL!22Uy8kkvDheXc{Y!C(L8R6VfVXsob5axEjpHhMiIBg{RR zvY+GM5r!cPqfpj8j*HsJr{k9jNJk4syqi8fZby5WD>2+jptF8I{{@OHFNw>)^1*}L zj35EkkwNgqqq2KcD(Yaav-~07#dRDB_(p@C3CC&2m&9V))8x_=SD~k_6Lakpeq+rq z!Q&2oN^1BO)t#;=R53*h0@n+n#}Q@;td_v-Z*7f9zxaF+^JYiIF)lqs*tR$%?o)lBE zf;J#g7%S*n0w5~z7IvIk8yEDG;auJaENXS#5!c-e8{6gx3f<{3>Q#EQ9}eeBU@L2b z&{JU=3~0lT-J5cI(AocRUxhPjVho}Sns zN?ApFf2ALlD&aB^GOVrBxGQD5bh6YpFdf$NOc1uqRmgMPJmpvdA6zhy6(zStuj|&V zW|a5zId;zEFP(+P+UFzGJdlycg9c;48NI{oJ@m8gK2Y>1E{H(;}lD7QKz zo>P!sc&`q2fZ!g~_|5#ZMG-2pm_)L8BzR_3Z~ui?e_`F?w2TAXp>+oCg_FU!13eJH z_j(AiK>KN_V8Vi`Y%=T}>(0r!|Ks}8eZ)=@=5TRgn1c)cb~3Uex;rCvZLY=R*wF0g z{#aI?Hjvd%w>7bd(jbwST70hwU(&?(FBXtj?0hPSASnK>8aC6T)?rU`p~A$+$E%Jn z6}}|Jv=Y3GJh~z=UNAU5@CxVg?EOKB^bA%macgJ)Z*Bd|K&FU2dy=g-+p3o4zR-#> z8OPuw3>6XB0Z9bDo_;UW>g6px`dkq0@-j+ePbHcll~*@y~R1yTi>Rfu4m=Lm;GKNXZzz-m~{BR?tG}^Xh!w4WZqV6BVk2 zB}il#9D&STIVnfjg{&?#lNvQ0C&A#5PSW|8TQEPPDFWP7hieU)H~%+D4Upu&Kv;l7nEv6jIuE?jjU*RjiYO$i`?4eW zDt&3jzedKI^sdha7#Jsfw0k$bNBxsEO~XdmK-&6Cx+1dhuLycXqHe`w2wQH==KL>S zF&}Ke<>3Q|oRgc5W_++npeFJI8F-YAJf2nM1{EhDnVvCC&ueK*g=q<=a+A}|=zo5Y zODt7(DL`SvP&>^(%>xDEh1oNlo-&kIl42rNY???;)2rPIHM<|ya6o5>aEjU>+>)*U zkNE8`8JX!oAz^`;cNN?oMRm`~6LBn=3M}+NtSB&Y;goLjdJ+2UIqri$)LIdIQJ}7# zN`S94uQKkwxNW-yZ7sA{hY53bXM~6HJPf*my^P-{fWB4H`b@xpC)_xgcP>xyuEM9WQ`in3F>g7O=sF8Yq>+UnAX_g@RtBJS90+tz7;u`!NU zo3MTdcmO@}IEa4rJbQ5=H;Fb>>iy;TIr?|6f+&SQzS0cqc zW&$4Y)$rlk4uwTT)+DCi&Q#jYp=)9_q$P}Q>@;iXf<%{XbxFnf{4}un&_!^(iIN#$ z-`x!JYg1OH1Z+|!^Zj6iM*WB3YCGE+CF~2dG_4%bFP%e-Ajaj=V6Q|WFsz2%ovrZ^ zN|nfEAqD=hBFvzSlT4#`Hy`R067u!r^Mh}lC#Ur<9o&dPV8%<71Jng8BhyeQB~TxS z85ah2NtPfeWkSPi+f*W&hQDZx_{Ft9k!Lo)wwgBs_H$LN0%Mq{yZA2BEvsP@Kqsa& zlceie$hWXCZM%~Am#4*3dMrDcqxmv9O6dT!&g>cJ!Xs~V`R$W6Olmv+Q))jT_nB=P ze!u{_iy;FD)E-L&y2CI1{-uL>XE~_aDw?(}^{HHYyI-;46W2iV9H|fqF`3P_mVVL|5W^IRDtrO-bidHt4~;@gaU7BfSiah18gHirewvq-0`$0(uc}Bk zFff&5!B_d4QgcLFTi^Z_XrW2a*MEc-*6M<4hAoH&907gBI#mMxEm>#I1*9@s-il?? zYFAzxV=|nEM5X{eD%_t5>5B^mbo`bK_f)P;td$EpoP4nW)D15F&d~Y1;K};HT8d#X z8YK#a5gc46BaC(&haUN!G8iM$*5>ZiY64G^k{%dLZ!Xq#xsYP(2F$8th?J9wu9NB~ z4WSV)v-Nho3PdfIoUXlTJ<@sCKy~!`mdV6lKQ;vYMPslL7Vy5Pv9>c2u&S!A%(q<_ zNG6Wh{WidWfnf0KN)(!xPPw0_@anb7q)mGm$~f8fglk+d%g2QK!eA7Z9b`>f`(cFY z&UXCc%i>_Y&z{{+AveCe>FW0xhg*I0^m zpSIpR)s3IPtUp$gG%dMWxM^q01Aya{hRtBscF_sCeqRda0|wWE)939Mc5%eIBC-Lf zQ7z9*L-2R74RxzWx<0Qyc5ypTPi%k=`a(P+9k}5;fv4KPTw_HOxh!5Vt`V5qKNB&}*l=}54Zh1$Y@eF@s()k%#k z8a!ynv6(?(0vd}kEKgx$gptWyFfL>-9-<0aBA+s28fmG1KR_;kX96b-a^a`?VhRem zXw?KgX(L_wpC0I#Y|g<5cg_|XXS@>piS?qk9G zjJL1(M9mV^BxDidK-j@GXfxp0yZraG6*`hKQcgQ%%Z@1W$)0yp3z(J z03QWZ4Mj=w8lGJuhunpI%KK-#d)ysHFysn*j8gnpZ?7kyrJ2zAu5jCqnP==!U5Y&A zaGSE_lPrUskyydj+j`go)(N(sHz_dQCawj!O%@q-yr`!ZoMI{?IfQ?zDe#;W4)(l- z!kT6DK$QZ=88U?la!RU;{%U|6>P3MBCMCXKgg@5>OEK9#9M%qpyIUNBK%mt&|%@b z|AF%a4IP4tC0>skl(Lc@NYWI$$<^MaAu5u;p8FVv*og%3r_fFeR9pbj7(X+43bRW# z`RkOgC)j`ayQ)os=fFIXvpz1DP`m=_C@{&WA+JRKb?^5>312|29bm3VL^;V zFq%kKm^lTexR^@(jixF5_cf%~kNRsUUk)zl!}?oB^289ZfD&7{ejU1H;ARXPNkXnG zV69af2V9PLlaM~+Y#s}|e(^ft)oWgu6e5KglS_LFtV23%HoC9aR@$*d}z*TtX zN>Fvzj58w?+vyKaMAkgU&UXfp?)Ebq0Cb4q*v=DrW8we0YxVlTWvCBB@b7;{U=orT z;T(VqnL`^|uJ>;W@{pR8?_}JGq0*Z;xFj8m;oO;aaa4y{2x7 z@b(K(?oS+ffRd7uJPwjVgIgzPU6Xeba3pl2>?(8vToJTqytWy?vALXtw%F-nTyOVG5B zw-6~a95neR5%8$c`4VEBUC>zBXm?F;u!;MWpx99C$vC1cKNJ@0yNa{)gra)=&t zLL{XO*T9_96+OZfz}n!L30kUql{4U|U*ItJMkF|S07Cd6=ysBP!^ZJ|=?(Cd_{e2^ zW_n%&*e~M&57!{>6rf1<{y*O9fV_y99m$2^pUh%J=n7jG$pnXYWvOb#6G1hsaA z_$w7S+g$$a=WJMMxIL)89Q7CE>E|Jy@jQ`3hmhrV(3no!9Dn5snaFXpS87&%p-}4E%hL>ZHb^Jhr85a$1FrBFVT|vKPA*Q)2T!R174~9_eVohP z{^&N1lP5I*bQ2`JDfM#UD)i+^O^`6C4b!8nc{Sk6%9Q2j7rs)4&G%xjWSFNDJz?*! zCs0HG3j;Gut}_#xi&}ue^0+~L1W|$du$V9th|{qrmONlp87y>fV#H%@TbO7!FQVPv z`2D)ZM!5hH=GR}CEK@b1HDcL?SzWy9f!$By`}mmhILE%z495H0_yIi1X-$4MY=n{G7aqJKytF=Rx2 zi*kbgeUfkLoU%Rwi6bHdg9J6@Ng^U|{_eM4X7DX4*h^61FMn6e$AV)|uig|$y)XP* z=z=SCsV%Vd$kr;j{mrk-2ai!AL_=E6@5p_q$MU>^4sdMr=2{8N!f5JB(4nu9Kf9Vm~ zFe}8`VIR>TwADeEO{O8zk9~gK*(iWInGrDABe%c5m@VmUCr+vW-UT7r%9bcbL+KYp z=xOhcHe}SJg;9CTwkeo?#s=GOSQKr$Y;A4JH5~)a(V3jC=r(PN7%D-Di zZQvI<^v>_Z&w)`cqOgZ_DA+z%{b8s&*5;aW*sH56`^j_Rq?n`xzS)1+zgT^J!p8x% zrUw-~u1=)*%v9}TZ9E8p?Mu4oZWomB7|%Mz=F9>6L4;ud2ZHMTl!`NgT^QQWz>SOoCl-7&7iF^3vsVtL+=qnn>o|=)iLQ1;4DD7>4HdOXUo)VE;y+(row@s?71)#t zrj7hT#FYIP(cc<*Hm6uMHXfd z!|wqRqg(M8dfOlG?|4D5a+o?pg~1q%1N0yGbXR!$ye^}wJXaxdlp^s@CBae5iVDMA zpFLS#FAAPhM1F)5ZzX+0BDoenYtfSL4*t6)mR5Aqn{hYsP2c`8&8i2yU$u>MQJ?fo zr~Wd~HnT(y=I)K@+N;4EwW3^5A;m}V8jSfpdSUTmODeq3g&eRa1>ST~G+c2jo)|SZ zW4<^TgR&+%-xAS}6ST{CON2(=f2Y&?n|E_RE|07x`2eMJ(f66I5wn{zF}vmSGf5Lh znw=Y@pISjtes`tV1#BPJ*0tsGv+dM8*_}j9Ky@ND;{Ud1U%4gS;U~QjhEl!MjTzS`@Wu zA#g^0Fr;ZOfgvrB_}s=>`){KWgy7SY-Sx%@MUWBub42@|5TmPDhrd>BXt!I(#g7Yu zG^5d%#oDpAXk0FL1GG#O?Sy}+$%>K^eoTFmCg6u-S)eCrBSC~T!WGb{Qcf5e|Co!C=NHID$91w>5UU`q6_J1;mbrQlkN#A~0U>>F zBS{K=r#+j~0Vl6UYkAPdjxU+P>mtNEMKt%Mq>NO-(*#`Sv=OKYVaaR|w#K#VtttfZh1Ld-h-t12hqN+5Rz%pw@j~CawL*QM?jP zSb680EAlAl6_s1H4KYBch;etI$6tG6WWPH=aIb_O@XWb#D$hA|o^vV3t6dx#I5OADHUiqSu+OU)MHNBz=~UjwH}<;DNYEVG==S)^#_YdGBOqrO{mff#*u!z9g`@9ZI>Yo@Q`0up~CBF&;5A8aMbDr-lFJNToZ9B3hLPT;42mO7QUq)_pS{Vc4am zrI2x{`(eTkvfc858(F!JZ!v*)oQRsc!p7w!Eoe}Sa;|tkGa;>w=a+;auTfJ=eF-3m zTT4@s0nf^4i7uwX1+}#DOeC@HpVlYE67Tt3jCq!Qy;kK#TJe`6+_Qko0 zW`1tOTw$LKPx<5Y&?btfN%u+P(LKWRY)VY}5B9Y4#0OVnnz{<=%I+?7&CNXW&m5!! zR8D)Dy)Nqf<|UQ|j^#qo{Up*M<)+&rKwVCO2b!`}ugr7by)CCiyZ9N_j{EZf<5^|$9jw0Rta*1cXT4B^+ev)yup zd^r~}H{P63$JDu@ldfKr6s(acLF^SjI?u8n%a=nSqoWpwoYn zCCN~J&ld?`qDr-2VJkWvao_Cc)4o63)Vn@5fK{*KizJ%jArpwBo#52PWVU(PGh2cM zGAdv@{2Wz#vw*8%|K8&dKbipT&(*m7^Oy$cz+!jHFhPhk@B4@E!Iq$b$WKI|j1KGm ziN*4im}Q+avnt$kaEPD{_#DB?-X!q5>>NM~N7oBc6c5dhxj z*|!JUONgHR%(eVPH>S8`TYqzsyV{{MC%EI0{&?tlH^Fab-ByHbcVLlww)}P#pdre-kg@7mNscgpIe(54Vz(I^O$2%;Lv29UVksKNSpST#a()qlh@s)3+7<23s z(k!ub){pgE)+?PgJApO63rg0vS1laIc#pyHs?^s^DAd5*S@|!rXpVDduNt>Gzn$`2 z(WB+7{c-n>lYP(I*fv#I?L4_Jb_+xku0$OF<8*%Nmm#oaYeLVcODyYc>*2?PH}fgL zsjUq`+X&t4(;z-yNk10A6mk`q_jS-*?tE-u_&g`oQDW`IU111CzNZc3?IpK+g|G)~ z7k8RjWMsF0yNPp99M*03-@dbOGy;lVKqvY!RCMRa**Dsc+WHioai!t=r z>V2vm^?dlz+!g+f?u_;j&rg}HxUo{vN|IgP?dA50d?CK*ZcsYO!^f$062w)jYLXke zbbHIo@$BJ`N!?I^uf@+x@ptDtZiRt&SDXV|14qgb5G0eh3&b^l(j!Rn+nHqvT<4z4 z8!O)hZI!kFQjf1)J23?56e^{Qur_d23wSklt{}{{sB&IPxEj1(+1z&X?PuTNq+O27 z^1IHQB+Snq6kUU6E;y6Lf2@_$CVTq+#hy=UrL4}<)6*VumExDm&ZW~sWZ*_qpYF-a z`iBMUW-#I?*k_K`LeCfgxL8d5zW{F8*;NP?k)qxd-M@vbJ=^$NFLZ$$`Otfe^4``r z`O=tYLR;M71aCwQCrS@PQ=Bd((hLhbUni)}zEpuqPsO0GE7@iNDN)4Px+LUlr7_P( zLj~E)(+dh?27cfTKwh*rJ&xmHTm%8{z^$PGw#5{ZejkY>07>I`OFq#BUfH3~@9Sr6 zUjw5vlt@8sairL3(QLhY(buV!F^OCl!K0v7_HVDr=*%Hg9Yc)^T`N;DmENiDts8Ae z^Vb`LmF699(iBMKZgc37PZ`vf1u7wJ46PEJgTM$PhCj-uiRKxwql0KA8_L>pZwd$T zxYY&`OxNF%VkRvCHl6EIQeW(NM$^Z8H57^zoYp5RdoKFo3Z?d3u^i#};_pXQV3(>> zZ-^N(W+Ql&z~mFNa8C6Ke46o1EfZ=Z!=yN9;e2FS*cJw1W974ls+@eV&8}cTn0$F- zFA-&1aw`77pNU!76@^mAR-exZ_jpyGTadM$ywJ$zT3jtH;NQI7ea14YM+ey0 zLR{?uOL&9A@^Tcvvrh1bm%1U!4=pl|(iI}Cm$U}mqET01OR848c?gPo-k)KE2uR(J z1+VH(=DS(Bp?a-nER4l)fZxhX5F;h7L#UJTuRq{L3X%;1gESXqTt#3@&SBe~XHg^J zTlGTQvkOc`0~m}VISHK;d7U<0O-l>w066$nnb(fKWs&pOETct&D0LwBGK3AucVjUK zedGx9gLL{W-?@j!ov2qr{hHCgUT{bo?VqXdrFK0Nr9G_OBPpxn1ed>GR?p!nvF9yP zBp>pPYxnR9n{8!#iOwpbDs(UshTe?qE-6pa6fM2o_t;~hVzlzcE0(8RB}+z(9p1Yy zyy<^0-w@3Gc3+3kh10>hN29*N-d+T(X_AF=Py>9f%rCCv9a@=Vr;?7fGQ%Ie$L==S zglJShSCk3dk>B%q>8aqb6R`giVRpNmZE9#Eu(MrpA)N!Tp zP`zRM%s7~_WCq!?OeD#^6e6Y)vL{P~>=A!dim}ZiM6y(}H~QNvgd~xn&5$ih*+TZh z2xTAdGygB|@BQ%3r}=P}=Q-zj&VAq4eO(vV!@anNUNQLVtQ;qbY74W-tl7ez+0=&* zk9k?ikKXS>L1ok6q|OP-K7kE;9qKT_99R z2(<|RW%GedwNQ{_Z!wYooE+93nHUy9gx0&WNFXMujwq0nb?3Lf1P5(Q$*BU5m{rBj zY`cOCrX<_pLWuV#YM^Vd4Iq^Z9m*Hw>sbhy&_&ta1M}))?#7fJ0x4$zzqf8e$`PDHIBPv{n#46MqOx&W__FX8+FwW2x`END zHM;G$K2YmW!cHRf>EWz%m430&CjzG8yMfvcWbf8@uHiYDSq-~0E*0f5eUQV%U?ZWR zBPaLbPI-k@^;J8Xyz;BdH){c)Ee3*z`6;XSRV(G+rk+=U79pxW9YNOZgg*^t_8pK( z;%;T5rvS3`AFTWUJ4^2YDIu8Quk8KBk6oRl=l(hp;tHYgHAkEISYpm+gquI&T{s6n z>Wg*)Ns(*Fy5xU*W2u|rGdy^uZ&gLop74$vWWcpkj^+=Pc7HN9psaTe$ z20*>>p`>4u)pbGMUAu9o{uAmU7(*J$LSt-w}ByBOE z0Eh#_ihkLfw7E+md}bs)7%as?$j?uCmmIRCgajW7_U>)&Af<9tf;9!oCtm};Y`!hR z`EyF2LlDEHLF>`Ixa;md&AchgKu&OeKNv%ohI>)O;OqFE)q=9e?D)eneB8^A6!N2L zpG2p$%+DCIv`S1&zAT=qQZzTpv%Qsk^y3#agqSyTAl)KSw^bo2~?T zG^)5DY=j9u%>y+I%?rp$jeS5mf?&n!p&4?2@ows4Cy;ccRzM5faBQ-6#NU9GG6xwM znQ;de-v&%oJA6-O1F>eT`?I@oXN|g9EtD#@IB=~sw9>i$Z>png@IAXb5|#%>5X-Y> zhNQQaZ!}T&@uUYN{(NJ>0jH%I&uV=OL-m=^GEmcWbA8+SdZH&Y_~DCK@_%g~GM*iL zPlm6Ammht`pr;8(&nBO4Q#`8z6%LkI?zp*bdBzNl$Vro8DT4`1l1K~&fa1&DY=jPm znTkbJO{7`xg|S!&!$VxrDrxfnz&5Ytf{-#vDcTnIxkQUc9UA354*{bL9J2jdg5M@J zVy>uQE&bAo7qSsD5d3j*q=6Yu&=Fa2*CT!A#Nq^5Tz^Y&3rpz@;)Cej>%S;l-y>H# zsnZvo)MUeCp?7KxHx@RtPSnvvA~!N9C^}V57LS(!NlTThhSmcJf4!5Kfy9eX4TV8hB&G9*~gbMEo{; z?13=AmmUN!W6-ZKf~G#YJ1bT6@%=)0 zBF-+kLMHD!SCFpDQv}39vLN;uC<<65)_GcV)Rr>n(;!*cq{(9B+?rMlGkU1?1ToL{ z@P5cC21)Z5-?Em27N}G5l%U4nG1CP%v53Lf2|Gah1?D7bR`adfI7(vm>zP7+FkGb= zWalQtJzcJK8;IrtWo zDg`oa)@~u8W=NSikSX~Qz*6W=hzoUryoDeI2D&TO zCn5xBn&0hCckWxWbMLt*M>gexE;?`pgjVqIc(vr;kY@E`4PiwkCHA1#e}q(dSj+;e z^(XE5G|LhP8wdr93i>|a{(IF2KkJos@K8A-^!vuyVsxB!SSOY8=FJG>BEPhx4dN;1$&4aS?6%}6}^e67+;T`$FL&k7bvK~wyZz2jsF}<_SxY6$5 z1ff#f{0SW_^*WimezejIXxUa01@NGqU(8r`c zu&>X%|KuQt!GW*;^!sQ%LLo-AG-es=U<=>baB(a?%$5CF{68XGyqCIJ z!Wou=y~!bc6X?&d@T3^-D@)CE%Qkx6DQmHAJXNZ;tr#ffpI^B@M=s~&9PxBQ>i4|( z*ihFi8w^n8e4oRI+2H>)8CdNb^HwoIkrO#&XYR;Rr?ZxyAB&X?!Y`4rFG5nABos36*K;?F3mYWt42~aJ1}x z(7`mF0+v3=?K=6VWkKzx1XY;CyxX$mdt z*KXC}?mrB4>pUJZ>?zAeVFX#yb3GvCmM#VT7)*}|;Iz2%xJGa2idk5BX|&J`j>32; zBRfHa?u~gAtF9zBvShQb(DeL^^}i~6+ler-;hGS_t)(nc8vksVxJw>uCR?4yNTY#l zQyL*UyH*|~aqZLd;Q;CNp#pCq61#$<`nrtNz=lkpr@BwtaLxhs)3Y5}8l6`V%ONKK z=7#4)Wc9D5SLzAmYG1L5ZxMCUQSA{i2w$Bwk8=#q*^6xMtp!@C%}0((!7T?yg9x{T z+k}L>kElrRI~p+d`;BYZebaTIP1>OSt=+`{_m5EgDuz667)voHDJl`S&bIJLpWZ({|f~)W3GNxS=m%*Y|cP4&)o|@e!g)EMS?p3 zItL4Tvhn9?iX+M5Xxpkv8k<}TjqO&aF$~I3WxvPDNUu1Oxv{#G;SvfQTWhNU}_O?=#PnpzJ3#tQ2*E2PKf(w+=+hPR3U^tcHStSflK8>ICfeY ztvUF)66MZ_E(CFGOQ^FklS3CLY9xSHnMBFMvd70xKa;ox6a9F&TXkl&gCo&kRbYlOBz}L&MgJ5 z5`ceVzR&q~To5iekF?5=(!KF?d1w18Ia3SX1;M4s81nkK5+108#hrr{YD1Q;L&v}4 z;BeCTFH-^BQfMd*&1~(=+ugso-LP_IO9_cnYSC}aVUO_|7)#J^J6w0+6_$EfnCQke9`CvuGnYvMq8aEW;&zmutWE#<~2v z5NbPWgn1Lqy!bOG5iSGXA~xeS1}}e_ajwb4VrGqR?dW50OBV=fMN#FdMOHT-jg`wo`%oh3Pbg# zMw^uvgvGPLuSS<*>xcnkI-%wxseTHuTFplHPzHTFPAO#MUWX6QTva*Tp~ut?4Cn|L zeEwVCXtUM*frS%{KPoOT^@ax#5is6P2_5;~m)_c_8 zLOZw7rU(jvMnx2wMbprTxgnNHbO|)i#>e&KZygo8bLnFE-0ZlZW3cZBKn@dS>y*|N z6?VH{jYYP&32oRN;ma~TRE`Y6+Wz4&ab-M9xVZUus)DMdgYa9{`dacff8MjOdWpi_tt%SZKhq@ZW=|hT~E}>R3>k0 z$9v#kafhk9N9Ve2L)Bd1&R@0^2D$u~B=}dMbGn|E)tor@Mao{9IpW9ItL1 z4$JK)1%@PUS-#>iM1f|5sM=CXF)n`yw~u*MO9er6AOA;S-b#zjz+!XYnML;P;Xiyl zpC4+6uUb8{$mVPX4L*c*6Q9im)uTu4wNiwllUun0wvtQ)l_h$HuPOo|bUSx!u^c_FpYT`Tc^4Hg&^@kd;(Af|{M!^w$)yih3WFma# zU^(Z4C-2FYo~-wO7Zj9u^F~9r6ho)~Gkv?vH(Py8cBI`mg0dy%>>AnPLK6<0cSOT@ zE6vSN)pK|nUl{^!mu^PwR?~$Y0IyiPAE2Zl=FmQswrQ~cED}A@0#Zhy|241kR};|% zJhY5?)#P5ovCn1a3^YFu=@X~gzgW~dErewdwjE?u7-+1^3!7L|%gNmSW{@(RndeR@YzD?KdCqGP!4=BODh@Ky1cjuiQ zEtc*QhJzQgk4Y_EIgk2OymOi9q(2v!7$ zngaQZM)C|=@=K0_XOOxv6gJWBahQTR6sJ+dy2cqK(cI$z9|p>W6Hqvq-+cmy^0IKd z+e|&u`*SiLDow7uRwjQEC;Zfl3z$9~L~rk4s%XGs6>o5IzD}BidG^Lo8dWH(dS=Y( zcIw0_K&VZHE3+`ZXfj%ZeQw2PbIk2v)?G9}lJbEY55*8}h(s(DbSvzd9g6(|-oW)#R_auq94U=rNgxqh`_z?kfr|QbY2T>!2 zFgaJfo#p9uPv1M^WPYvS@6!6WTP~iY5MiDN9;ny{rp@cSjcRTm%)d@3(`>D*!vM1g z@=hypzJ#KGL)36R^4sq_f5d1%D)+bfi@4{Uks5YEac8#%mSwe~z>%Agaqo2mQ0(Na zzSl#7M=mpePN!H%kqMs5NppV*F{H|F!uebSu+W)F@+Wl2!8~L?S&^eMEo^Pm|Gl*FCGZtEQ~nzN6Gu z>iFj^%sRyjR#)OJ(M&+0UY|L4*_I#SCl9=P9{Wl7@~Eh&Fj8w#zDg#GNlO*q8?&$f z;S}QeSZ|RNnC%%7eYIE|4R8;Z*Jfip-V*-sK~gn_yOOu!xd^P=ArX*gA9HYiqaT=- z@(LAhGy$?_boeGcX`=&_wv#4+%q`W$7)HjQ0gp?TTyh@uP8L@q@F0VeW9sFL{+llXPJZh7 zn@;d|lHe%P_4rfwiCQ=?GJJ>1c=$71HE3}UV{qzibMrEx`0MqO4|M?7VWAH!68-=4 d_YkRhmoLj Date: Fri, 27 Apr 2018 11:52:23 +0100 Subject: [PATCH 25/35] Fixup target destination directory shall be {app} --- Scripts/setup-Win32.iss | 10 +++++----- Scripts/setup-x64.iss | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Scripts/setup-Win32.iss b/Scripts/setup-Win32.iss index 426c57c1..1578fb46 100644 --- a/Scripts/setup-Win32.iss +++ b/Scripts/setup-Win32.iss @@ -40,11 +40,11 @@ Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{ Name: mypAssociation; Description: "Associate ""kiwi"" extension"; GroupDescription: File extensions: [Files] -Source: "..\Build\Release\Win32\KiwiBuild\Release\Kiwi.exe"; DestDir: "{src}"; Flags: ignoreversion -Source: "..\Build\Release\Win32\KiwiBuild\Release\concrt140.dll"; DestDir: "{src}"; Flags: ignoreversion -Source: "..\Build\Release\Win32\KiwiBuild\Release\msvcp140.dll"; DestDir: "{src}"; Flags: ignoreversion -Source: "..\Build\Release\Win32\KiwiBuild\Release\vccorlib140.dll"; DestDir: "{src}"; Flags: ignoreversion -Source: "..\Build\Release\Win32\KiwiBuild\Release\vcruntime140.dll"; DestDir: "{src}"; Flags: ignoreversion +Source: "..\Build\Release\Win32\KiwiBuild\Release\Kiwi.exe"; DestDir: "{app}"; Flags: ignoreversion +Source: "..\Build\Release\Win32\KiwiBuild\Release\concrt140.dll"; DestDir: "{app}"; Flags: ignoreversion +Source: "..\Build\Release\Win32\KiwiBuild\Release\msvcp140.dll"; DestDir: "{app}"; Flags: ignoreversion +Source: "..\Build\Release\Win32\KiwiBuild\Release\vccorlib140.dll"; DestDir: "{app}"; Flags: ignoreversion +Source: "..\Build\Release\Win32\KiwiBuild\Release\vcruntime140.dll"; DestDir: "{app}"; Flags: ignoreversion ; NOTE: Don't use "Flags: ignoreversion" on any shared system files [Icons] diff --git a/Scripts/setup-x64.iss b/Scripts/setup-x64.iss index ce582509..092da3f3 100644 --- a/Scripts/setup-x64.iss +++ b/Scripts/setup-x64.iss @@ -40,11 +40,11 @@ Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{ Name: mypAssociation; Description: "Associate ""kiwi"" extension"; GroupDescription: File extensions: [Files] -Source: "..\Build\Release\x64\KiwiBuild\Release\Kiwi.exe"; DestDir: "{src}"; Flags: ignoreversion -Source: "..\Build\Release\x64\KiwiBuild\Release\concrt140.dll"; DestDir: "{src}"; Flags: ignoreversion -Source: "..\Build\Release\x64\KiwiBuild\Release\msvcp140.dll"; DestDir: "{src}"; Flags: ignoreversion -Source: "..\Build\Release\x64\KiwiBuild\Release\vccorlib140.dll"; DestDir: "{src}"; Flags: ignoreversion -Source: "..\Build\Release\x64\KiwiBuild\Release\vcruntime140.dll"; DestDir: "{src}"; Flags: ignoreversion +Source: "..\Build\Release\x64\KiwiBuild\Release\Kiwi.exe"; DestDir: "{app}"; Flags: ignoreversion +Source: "..\Build\Release\x64\KiwiBuild\Release\concrt140.dll"; DestDir: "{app}"; Flags: ignoreversion +Source: "..\Build\Release\x64\KiwiBuild\Release\msvcp140.dll"; DestDir: "{app}"; Flags: ignoreversion +Source: "..\Build\Release\x64\KiwiBuild\Release\vccorlib140.dll"; DestDir: "{app}"; Flags: ignoreversion +Source: "..\Build\Release\x64\KiwiBuild\Release\vcruntime140.dll"; DestDir: "{app}"; Flags: ignoreversion ; NOTE: Don't use "Flags: ignoreversion" on any shared system files [Icons] From 5ec346dfc48c7d8be4793a35e7bda8af534a9813 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 26 Apr 2018 14:45:40 +0200 Subject: [PATCH 26/35] Fixup dac~ crash. --- Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.cpp index b9b9b579..1904b19c 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.cpp +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.cpp @@ -67,7 +67,7 @@ namespace kiwi { namespace model { { if (arg.getInt() <= 0) { - throw std::runtime_error("null or negative channel"); + throw Error("null or negative channel"); } routes.push_back(arg.getInt() - 1); @@ -80,7 +80,7 @@ namespace kiwi { namespace model { if (sep_pos == std::string::npos) { - throw std::runtime_error("wrong symbol syntax"); + throw Error("wrong symbol syntax"); } int left_input = std::stoi(inputs.substr(0, sep_pos)) - 1; @@ -88,7 +88,7 @@ namespace kiwi { namespace model { if (left_input < 0 || right_input < 0) { - throw std::runtime_error("null or negative channel"); + throw Error("null or negative channel"); } const bool rev = left_input > right_input; From 90e70fe4f6906851e3de8485075eaf238ec1b633 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 26 Apr 2018 14:49:51 +0200 Subject: [PATCH 27/35] Add alias s for send object. --- Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Send.cpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Send.cpp b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Send.cpp index 21be2967..d785a4a9 100755 --- a/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Send.cpp +++ b/Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Send.cpp @@ -32,6 +32,8 @@ namespace kiwi { namespace model { { std::unique_ptr send_class(new ObjectClass("send", &Send::create)); + send_class->addAlias("s"); + flip::Class & send_model = DataModel::declare() .name(send_class->getModelName().c_str()) .inherit(); From e793e3a4d8cc12d2fd2937e08337f7c9b915c1b9 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 26 Apr 2018 14:54:24 +0200 Subject: [PATCH 28/35] Warning in delay inlet 1. --- Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.cpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.cpp b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.cpp index 5796680c..eb58e717 100644 --- a/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.cpp +++ b/Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.cpp @@ -77,6 +77,10 @@ namespace kiwi { getScheduler().unschedule(m_task); } + else + { + warning("delay inlet 1 only receives bang and stop"); + } } else if(index == 1) { From 8e266a4b1042fd27247d17b57cb79d5030553c29 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Wed, 2 May 2018 13:38:08 +0200 Subject: [PATCH 29/35] Fix object scheduling methods. --- .../KiwiApp_Objects/KiwiApp_BangView.cpp | 21 +--- .../KiwiApp_Objects/KiwiApp_ObjectView.cpp | 86 ++++--------- .../KiwiApp_Objects/KiwiApp_ObjectView.h | 27 +--- Modules/KiwiEngine/KiwiEngine_Object.cpp | 117 ++++++------------ Modules/KiwiEngine/KiwiEngine_Object.h | 30 +---- 5 files changed, 68 insertions(+), 213 deletions(-) diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.cpp index 843b1289..840fae94 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.cpp @@ -98,27 +98,18 @@ namespace kiwi { repaint(); } - Component::SafePointer form(this); - - getScheduler().schedule([form]() + schedule([this]() { - if (form) - { - form.getComponent()->m_active = false; - form.getComponent()->repaint(); - } - }, std::chrono::milliseconds(150)); - + m_active = false; + repaint(); + }, std::chrono::milliseconds(150)); } void BangView::signalTriggered() { - Component::SafePointer form(this); - - getScheduler().defer([form]() + defer([this]() { - if (form) - form.getComponent()->flash(); + flash(); }); } } diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp index 8ad24b9c..c6341f96 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp @@ -35,8 +35,8 @@ namespace kiwi ObjectView::ObjectView(model::Object & object_model): m_model(object_model), - m_border_size(1.5), - m_tasks() + m_border_size(1.5), + m_master(this, [](ObjectView*){}) { object_model.addListener(*this); @@ -50,11 +50,6 @@ namespace kiwi ObjectView::~ObjectView() { - for (auto task : m_tasks) - { - getScheduler().unschedule(task); - } - getModel().removeListener(*this); } @@ -115,65 +110,28 @@ namespace kiwi } void ObjectView::defer(std::function call_back) - { - removeTasks(m_tasks); - - std::shared_ptr task(new Task(call_back)); - - m_tasks.insert(task); - - getScheduler().defer(task); + { + std::weak_ptr object(m_master); + + getScheduler().defer([object, cb = std::move(call_back)]() + { + if (!object.expired()) + { + cb(); + } + }); } void ObjectView::schedule(std::function call_back, tool::Scheduler<>::duration_t delay) - { - removeTasks(m_tasks); - - std::shared_ptr task(new Task(call_back)); - - m_tasks.insert(task); - - getScheduler().schedule(task, delay); - } - - void ObjectView::removeTasks(std::set> & tasks) - { - for (auto task_it = m_tasks.begin(); task_it != m_tasks.end(); ) - { - if ((*task_it)->executed() == true) - { - task_it = m_tasks.erase(task_it); - } - else - { - ++task_it; - } - } - } - - // ================================================================================ // - // TASK // - // ================================================================================ // - - ObjectView::Task::Task(std::function callback): - m_callback(callback), - m_executed(false) - { - } - - ObjectView::Task::~Task() - { - } - - void ObjectView::Task::execute() - { - m_callback(); - - m_executed.store(true); - } - - bool ObjectView::Task::executed() const - { - return m_executed.load(); + { + std::weak_ptr object(m_master); + + getScheduler().schedule([object, cb = std::move(call_back)]() + { + if (!object.expired()) + { + cb(); + } + }, delay); } } diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h index 467b4914..d5962419 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h @@ -53,27 +53,6 @@ namespace kiwi Active = 0x1100009 }; - private: // classes - - //! @brief A generic task that call an std::function. - class Task : public tool::Scheduler<>::Task - { - public: // methods - - Task(std::function callback); - - ~Task(); - - void execute() override final; - - bool executed() const; - - private: // members - - std::function m_callback; - std::atomic m_executed; - }; - public: // methods //! @brief Constructor. @@ -115,8 +94,6 @@ namespace kiwi private: // methods - void removeTasks(std::set> & tasks); - //! @brief Override this function if you want it to have a customied outline. //! @details Used to draw the object's outline. Returns the object's bounds by default. //! @todo May make it return path instead. @@ -131,8 +108,8 @@ namespace kiwi private: // members model::Object& m_model; - int m_border_size; - std::set> m_tasks; + int m_border_size; + std::shared_ptr m_master; private: // deleted methods diff --git a/Modules/KiwiEngine/KiwiEngine_Object.cpp b/Modules/KiwiEngine/KiwiEngine_Object.cpp index 30bf8326..34582f98 100644 --- a/Modules/KiwiEngine/KiwiEngine_Object.cpp +++ b/Modules/KiwiEngine/KiwiEngine_Object.cpp @@ -40,20 +40,14 @@ namespace kiwi m_ref(model.ref()), m_inlets(model.getNumberOfInlets()), m_outlets(model.getNumberOfOutlets()), - m_tasks(), - m_main_tasks(), - m_stack_count(0ul) + m_stack_count(0ul), + m_master(this, [](engine::Object*){}) { getObjectModel().addListener(*this); } Object::~Object() noexcept { - for (auto task : m_tasks) - { - getScheduler().unschedule(task); - } - getObjectModel().removeListener(*this); } @@ -67,51 +61,10 @@ namespace kiwi m_outlets[outlet_index].erase(Link(receiver, inlet_index)); } - // ================================================================================ // - // TASK // - // ================================================================================ // - - Object::Task::Task(std::function callback): - m_callback(callback), - m_executed(false) - { - } - - Object::Task::~Task() - { - } - - void Object::Task::execute() - { - m_callback(); - - m_executed.store(true); - } - - bool Object::Task::executed() const - { - return m_executed.load(); - } - // ================================================================================ // // PARMETERS // // ================================================================================ // - void Object::removeTasks(std::set> & tasks) - { - for (auto task_it = tasks.begin(); task_it != tasks.end(); ) - { - if ((*task_it)->executed() == true) - { - task_it = tasks.erase(task_it); - } - else - { - ++task_it; - } - } - } - void Object::modelParameterChanged(std::string const& name, tool::Parameter const& parameter) { defer([this, name, parameter]() @@ -158,16 +111,10 @@ namespace kiwi void Object::setParameter(std::string const& name, tool::Parameter const& param) { - removeTasks(m_main_tasks); - - std::shared_ptr task(new Task([this, name, param]() + deferMain([this, name, param] { getObjectModel().setParameter(name, param); - })); - - m_main_tasks.insert(task); - - getMainScheduler().defer(task); + }); } // ================================================================================ // @@ -210,46 +157,54 @@ namespace kiwi void Object::defer(std::function call_back) { - removeTasks(m_tasks); - - std::shared_ptr task(new Task(call_back)); - - m_tasks.insert(task); + std::weak_ptr object(m_master); - getScheduler().defer(task); + getScheduler().defer([object, cb = std::move(call_back)]() + { + if (!object.expired()) + { + cb(); + } + }); } void Object::deferMain(std::function call_back) { - removeTasks(m_main_tasks); + std::weak_ptr object(m_master); - std::shared_ptr task(new Task(call_back)); - - m_main_tasks.insert(task); - - getMainScheduler().defer(task); + getMainScheduler().defer([object, cb = std::move(call_back)]() + { + if (!object.expired()) + { + cb(); + } + }); } void Object::schedule(std::function call_back, tool::Scheduler<>::duration_t delay) { - removeTasks(m_tasks); - - std::shared_ptr task(new Task(call_back)); + std::weak_ptr object(m_master); - m_tasks.insert(task); - - getScheduler().schedule(task, delay); + getScheduler().schedule([object, cb = std::move(call_back)]() + { + if (!object.expired()) + { + cb(); + } + }, delay); } void Object::scheduleMain(std::function call_back, tool::Scheduler<>::duration_t delay) { - removeTasks(m_main_tasks); - - std::shared_ptr task(new Task(call_back)); - - m_main_tasks.insert(task); + std::weak_ptr object(m_master); - getMainScheduler().schedule(task, delay); + getMainScheduler().schedule([object, cb = std::move(call_back)]() + { + if (!object.expired()) + { + cb(); + } + }, delay); } // ================================================================================ // diff --git a/Modules/KiwiEngine/KiwiEngine_Object.h b/Modules/KiwiEngine/KiwiEngine_Object.h index d1af4ff4..9eec2937 100644 --- a/Modules/KiwiEngine/KiwiEngine_Object.h +++ b/Modules/KiwiEngine/KiwiEngine_Object.h @@ -50,28 +50,6 @@ namespace kiwi //! @brief The Object reacts and interacts with other ones by sending and receiving messages via its inlets and outlets. class Object : public model::Object::Listener { - private: // classes - - //! @brief A generic task that call an std::function. - //! @details When executed - class Task : public tool::Scheduler<>::Task - { - public: // methods - - Task(std::function callback); - - ~Task(); - - void execute() override final; - - bool executed() const; - - private: // members - - std::function m_callback; - std::atomic m_executed; - }; - public: // methods //! @brief Constructor. @@ -181,9 +159,6 @@ namespace kiwi //! @brief Automatically called on the engine's thread. virtual void attributeChanged(std::string const& name, tool::Parameter const& attribute); - //! @brief Call this function to remove tasks already executed. - void removeTasks(std::set> & tasks); - private: // members using Outlet = std::set; @@ -192,9 +167,8 @@ namespace kiwi flip::Ref const m_ref; size_t m_inlets; std::vector m_outlets; - std::set> m_tasks; - std::set> m_main_tasks; - size_t m_stack_count; + size_t m_stack_count; + std::shared_ptr m_master; private: // deleted methods From 4905f6fbcc3519c43c1b58297eac00d586ebbc04 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Mon, 30 Apr 2018 15:20:06 +0200 Subject: [PATCH 30/35] Fixup crash open remote patcher. --- .../Source/KiwiApp_Application/KiwiApp_Instance.cpp | 12 ++---------- Client/Source/KiwiApp_Application/KiwiApp_Instance.h | 3 --- .../KiwiApp_Patcher/KiwiApp_PatcherManager.cpp | 3 +-- 3 files changed, 3 insertions(+), 15 deletions(-) diff --git a/Client/Source/KiwiApp_Application/KiwiApp_Instance.cpp b/Client/Source/KiwiApp_Application/KiwiApp_Instance.cpp index 33e04117..be5edcad 100644 --- a/Client/Source/KiwiApp_Application/KiwiApp_Instance.cpp +++ b/Client/Source/KiwiApp_Application/KiwiApp_Instance.cpp @@ -89,6 +89,7 @@ namespace kiwi if (!keep_patcher) { + (*manager)->forceCloseAllWindows(); manager = m_patcher_managers.erase(manager); } else @@ -129,6 +130,7 @@ namespace kiwi if (!keep_patcher) { + (*manager)->forceCloseAllWindows(); manager = m_patcher_managers.erase(manager); } else @@ -348,16 +350,6 @@ namespace kiwi } } - void Instance::removePatcher(PatcherManager const& patcher_manager) - { - const auto it = getPatcherManager(patcher_manager); - - if (it != m_patcher_managers.end()) - { - m_patcher_managers.erase(it); - } - } - Instance::PatcherManagers::iterator Instance::getPatcherManager(PatcherManager const& manager) { const auto find_fn = [&manager](std::unique_ptr const& other) diff --git a/Client/Source/KiwiApp_Application/KiwiApp_Instance.h b/Client/Source/KiwiApp_Application/KiwiApp_Instance.h index 3ca2fe70..e97319b9 100644 --- a/Client/Source/KiwiApp_Application/KiwiApp_Instance.h +++ b/Client/Source/KiwiApp_Application/KiwiApp_Instance.h @@ -103,9 +103,6 @@ namespace kiwi //! @brief Brings the Application settings window to front. void showAppSettingsWindow(); - //! @brief Removes a patcher from cach. - void removePatcher(PatcherManager const& patcher_manager); - //! @brief Opens a juce native audio setting pannel. void showAudioSettingsWindow(); diff --git a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherManager.cpp b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherManager.cpp index b3d73258..9b571f98 100644 --- a/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherManager.cpp +++ b/Client/Source/KiwiApp_Patcher/KiwiApp_PatcherManager.cpp @@ -66,8 +66,7 @@ namespace kiwi } PatcherManager::~PatcherManager() - { - forceCloseAllWindows(); + { disconnect(); } From 41bef1576f1d7dfcd4276aed19750648b59489bc Mon Sep 17 00:00:00 2001 From: unknown Date: Mon, 30 Apr 2018 13:56:52 +0100 Subject: [PATCH 31/35] Fix windows log in console when openning file. --- Client/Source/KiwiApp.cpp | 20 +++++++++++++++----- Client/Source/KiwiApp.h | 3 +++ 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/Client/Source/KiwiApp.cpp b/Client/Source/KiwiApp.cpp index 30c2b39b..0cb4b512 100644 --- a/Client/Source/KiwiApp.cpp +++ b/Client/Source/KiwiApp.cpp @@ -127,7 +127,7 @@ namespace kiwi startTimer(10); #if JUCE_WINDOWS - m_instance->openFile(juce::File(commandLine.unquoted())); + openCommandFile(commandLine); #endif #if JUCE_MAC @@ -141,10 +141,7 @@ namespace kiwi void KiwiApp::anotherInstanceStarted(juce::String const& command_line) { - if(m_instance) - { - m_instance->openFile(juce::File(command_line.unquoted())); - } + openCommandFile(command_line); } void KiwiApp::declareEngineObjects() @@ -386,6 +383,19 @@ namespace kiwi checkLatestRelease(); } } + + void KiwiApp::openCommandFile(juce::String const& command_line) + { + if (command_line.length() > 0) + { + juce::File file(command_line.unquoted()); + + if (file.hasFileExtension("kiwi") && m_instance) + { + m_instance->openFile(file); + } + } + } uint64_t KiwiApp::userID() { diff --git a/Client/Source/KiwiApp.h b/Client/Source/KiwiApp.h index d0ec2cff..53541442 100644 --- a/Client/Source/KiwiApp.h +++ b/Client/Source/KiwiApp.h @@ -236,6 +236,9 @@ namespace kiwi // @brief Handles changes of server address. void networkSettingsChanged(NetworkSettings const& settings, juce::Identifier const& ids) override final; + + //! @brief Parse startup command line and open file if exists. + void openCommandFile(juce::String const& command_line); private: // members From b59a026ca21a096237c74f9c8c5b0dd1e8f89a2b Mon Sep 17 00:00:00 2001 From: jean-millot Date: Wed, 2 May 2018 13:26:52 +0200 Subject: [PATCH 32/35] Fix and test dsp object with conditional process. --- Modules/KiwiDsp/KiwiDsp_Chain.cpp | 4 ---- Test/Dsp/Processors.h | 7 ++----- Test/Dsp/test_Chain.cpp | 35 +++++++++++++++++++++++++++++++ 3 files changed, 37 insertions(+), 9 deletions(-) diff --git a/Modules/KiwiDsp/KiwiDsp_Chain.cpp b/Modules/KiwiDsp/KiwiDsp_Chain.cpp index 5acdf2a9..5f81c58f 100755 --- a/Modules/KiwiDsp/KiwiDsp_Chain.cpp +++ b/Modules/KiwiDsp/KiwiDsp_Chain.cpp @@ -393,8 +393,6 @@ namespace kiwi Node::Pin& prev_pin = tie.m_pin; Node& prev_node = tie.m_pin.m_owner; - connect(*prev_node.m_processor, prev_pin.m_index, *node.m_processor, inlet.m_index); - std::function call_back = std::bind(&Chain::execConnect, this, prev_node.m_processor.get(), prev_pin.m_index, @@ -414,8 +412,6 @@ namespace kiwi Node::Pin& next_pin = tie.m_pin; Node& next_node = tie.m_pin.m_owner; - connect(*node.m_processor, outlet.m_index, *next_node.m_processor, next_pin.m_index); - std::function call_back = std::bind(&Chain::execConnect, this, node.m_processor.get(), outlet.m_index, diff --git a/Test/Dsp/Processors.h b/Test/Dsp/Processors.h index 983c2307..7504e827 100755 --- a/Test/Dsp/Processors.h +++ b/Test/Dsp/Processors.h @@ -234,7 +234,7 @@ class NullProcessor : public Processor class PlusScalarRemover : public Processor { public: - PlusScalarRemover() noexcept : Processor(1ul, 1ul) {} + PlusScalarRemover() noexcept : Processor(2ul, 1ul) {} ~PlusScalarRemover() = default; private: @@ -242,17 +242,14 @@ class PlusScalarRemover : public Processor { if (info.inputs[0]) { - m_signal_1.reset(new Signal(info.vector_size, 1.)); setPerformCallBack(this, &PlusScalarRemover::perform); } }; void perform(Buffer const& input, Buffer& output) noexcept { - Signal::add(output[0ul], input[0ul], *m_signal_1); + Signal::add(input[0ul], input[1ul], output[0ul]); } - - std::unique_ptr m_signal_1; }; // ==================================================================================== // diff --git a/Test/Dsp/test_Chain.cpp b/Test/Dsp/test_Chain.cpp index 0c9f7339..1a742e46 100755 --- a/Test/Dsp/test_Chain.cpp +++ b/Test/Dsp/test_Chain.cpp @@ -443,4 +443,39 @@ TEST_CASE("Dsp - Chain", "[Dsp, Chain]") chain.release(); } + + SECTION("Chain processor without perform") + { + Chain chain; + + std::shared_ptr sig1(new Sig(1)); + std::shared_ptr sig2(new Sig(2)); + std::shared_ptr plus_remove(new PlusScalarRemover()); + std::string result; + std::shared_ptr print(new Print(result)); + + chain.addProcessor(sig1); + chain.addProcessor(sig2); + chain.addProcessor(plus_remove); + chain.addProcessor(print); + + chain.connect(*sig2, 0, *plus_remove, 1); + chain.connect(*plus_remove, 0, *print, 0); + + REQUIRE_NOTHROW(chain.prepare(samplerate, 4ul)); + + chain.tick(); + + CHECK(result == "[0.000000, 0.000000, 0.000000, 0.000000]"); + + chain.connect(*sig1, 0, *plus_remove, 0); + + chain.update(); + + chain.tick(); + + CHECK(result == "[3.000000, 3.000000, 3.000000, 3.000000]"); + + chain.release(); + } } From d1cea3be96ff6157b0bec617a5679e95debf9cf0 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 3 May 2018 10:08:05 +0200 Subject: [PATCH 33/35] Update documentation. --- README.md | 34 +- docs/css/font-awesome.min.css | 4 + docs/css/navbar.css | 50 +- docs/developper/dev.html | 63 + docs/developper/dev.md | 58 +- docs/fr/developper/dev.html | 63 + docs/fr/developper/dev.md | 1 + docs/fr/index.html | 62 + docs/fr/software/getting-started.html | 63 + docs/fr/software/getting-started.md | 1 + docs/fr/software/objects.html | 63 + docs/fr/software/objects.md | 1 + docs/fr/software/tutorials.html | 63 + docs/fr/software/tutorials.md | 1 + docs/fr/software/versions.html | 63 + docs/fr/software/versions.md | 1 + docs/html/_kiwi_app_8h_source.html | 71 +- .../_kiwi_app___about_window_8h_source.html | 50 +- docs/html/_kiwi_app___api_8h_source.html | 75 +- .../_kiwi_app___api_controller_8h_source.html | 109 ++ .../_kiwi_app___auth_panel_8h_source.html | 108 ++ .../html/_kiwi_app___bang_view_8h_source.html | 105 ++ ...iwi_app___beacon_dispatcher_8h_source.html | 60 +- .../_kiwi_app___binary_data_8h_source.html | 52 +- .../_kiwi_app___carrier_socket_8h_source.html | 65 +- .../_kiwi_app___classic_view_8h_source.html | 106 ++ .../_kiwi_app___command_i_ds_8h_source.html | 103 +- .../_kiwi_app___comment_view_8h_source.html | 108 ++ docs/html/_kiwi_app___console_8h_source.html | 94 +- ..._kiwi_app___console_history_8h_source.html | 56 +- ...app___custom_toolbar_button_8h_source.html | 50 +- ...kiwi_app___document_browser_8h_source.html | 90 +- ...app___document_browser_view_8h_source.html | 75 +- ...wi_app___dsp_device_manager_8h_source.html | 54 +- ..._app___editable_object_view_8h_source.html | 117 ++ docs/html/_kiwi_app___factory_8h_source.html | 107 ++ .../_kiwi_app___form_component_8h_source.html | 114 ++ docs/html/_kiwi_app___i_ds_8h_source.html | 53 +- .../_kiwi_app___image_button_8h_source.html | 64 +- docs/html/_kiwi_app___instance_8h_source.html | 102 +- .../html/_kiwi_app___link_view_8h_source.html | 66 +- .../_kiwi_app___look_and_feel_8h_source.html | 50 +- .../_kiwi_app___message_view_8h_source.html | 108 ++ ...kiwi_app___meter_tilde_view_8h_source.html | 105 ++ ...iwi_app___number_tilde_view_8h_source.html | 108 ++ .../_kiwi_app___number_view_8h_source.html | 108 ++ ...kiwi_app___number_view_base_8h_source.html | 109 ++ .../_kiwi_app___object_frame_8h_source.html | 131 +++ .../_kiwi_app___object_view_8h_source.html | 84 +- docs/html/_kiwi_app___objects_8h_source.html | 101 ++ ...iwi_app___patcher_component_8h_source.html | 63 +- ..._kiwi_app___patcher_manager_8h_source.html | 117 +- .../_kiwi_app___patcher_view_8h_source.html | 101 +- ...p___patcher_view_hit_tester_8h_source.html | 88 +- ...cher_view_iolet_highlighter_8h_source.html | 68 +- ...wi_app___patcher_view_lasso_8h_source.html | 66 +- ..._patcher_view_mouse_handler_8h_source.html | 114 ++ ...kiwi_app___patcher_viewport_8h_source.html | 84 +- .../_kiwi_app___settings_panel_8h_source.html | 54 +- .../_kiwi_app___slider_view_8h_source.html | 106 ++ ..._kiwi_app___stored_settings_8h_source.html | 87 +- .../_kiwi_app___suggest_editor_8h_source.html | 75 +- .../_kiwi_app___suggest_list_8h_source.html | 58 +- .../_kiwi_app___toggle_view_8h_source.html | 106 ++ .../_kiwi_app___tooltip_window_8h_source.html | 50 +- docs/html/_kiwi_app___window_8h_source.html | 65 +- docs/html/_kiwi_dsp___chain_8h_source.html | 70 +- docs/html/_kiwi_dsp___def_8h_source.html | 50 +- docs/html/_kiwi_dsp___misc_8h_source.html | 50 +- .../html/_kiwi_dsp___processor_8h_source.html | 58 +- docs/html/_kiwi_dsp___signal_8h_source.html | 58 +- .../_kiwi_engine___adc_tilde_8h_source.html | 109 ++ ...wi_engine___audio_controler_8h_source.html | 54 +- ...wi_engine___audio_interface_8h_source.html | 108 ++ docs/html/_kiwi_engine___bang_8h_source.html | 107 ++ docs/html/_kiwi_engine___clip_8h_source.html | 107 ++ .../_kiwi_engine___clip_tilde_8h_source.html | 110 ++ .../_kiwi_engine___comment_8h_source.html | 107 ++ .../_kiwi_engine___console_8h_source.html | 54 +- .../_kiwi_engine___dac_tilde_8h_source.html | 109 ++ docs/html/_kiwi_engine___def_8h_source.html | 52 +- docs/html/_kiwi_engine___delay_8h_source.html | 108 ++ ...engine___delay_simple_tilde_8h_source.html | 113 ++ .../_kiwi_engine___different_8h_source.html | 106 ++ ...wi_engine___different_tilde_8h_source.html | 106 ++ .../html/_kiwi_engine___divide_8h_source.html | 106 ++ ..._kiwi_engine___divide_tilde_8h_source.html | 106 ++ docs/html/_kiwi_engine___equal_8h_source.html | 106 ++ .../_kiwi_engine___equal_tilde_8h_source.html | 106 ++ .../_kiwi_engine___error_box_8h_source.html | 109 ++ .../_kiwi_engine___factory_8h_source.html | 64 +- docs/html/_kiwi_engine___float_8h_source.html | 107 ++ docs/html/_kiwi_engine___gate_8h_source.html | 107 ++ .../_kiwi_engine___gate_tilde_8h_source.html | 110 ++ .../_kiwi_engine___greater_8h_source.html | 106 ++ ...kiwi_engine___greater_equal_8h_source.html | 106 ++ ...ngine___greater_equal_tilde_8h_source.html | 106 ++ ...kiwi_engine___greater_tilde_8h_source.html | 106 ++ docs/html/_kiwi_engine___hub_8h_source.html | 109 ++ .../_kiwi_engine___instance_8h_source.html | 73 +- docs/html/_kiwi_engine___less_8h_source.html | 106 ++ .../_kiwi_engine___less_equal_8h_source.html | 106 ++ ...i_engine___less_equal_tilde_8h_source.html | 106 ++ .../_kiwi_engine___less_tilde_8h_source.html | 106 ++ .../_kiwi_engine___line_tilde_8h_source.html | 118 ++ docs/html/_kiwi_engine___link_8h_source.html | 60 +- .../_kiwi_engine___loadmess_8h_source.html | 108 ++ .../_kiwi_engine___message_8h_source.html | 109 ++ .../_kiwi_engine___meter_tilde_8h_source.html | 113 ++ docs/html/_kiwi_engine___metro_8h_source.html | 107 ++ docs/html/_kiwi_engine___minus_8h_source.html | 106 ++ .../_kiwi_engine___minus_tilde_8h_source.html | 106 ++ .../html/_kiwi_engine___modulo_8h_source.html | 106 ++ docs/html/_kiwi_engine___mtof_8h_source.html | 107 ++ .../_kiwi_engine___new_box_8h_source.html | 107 ++ .../_kiwi_engine___noise_tilde_8h_source.html | 110 ++ .../html/_kiwi_engine___number_8h_source.html | 109 ++ ..._kiwi_engine___number_tilde_8h_source.html | 111 ++ .../html/_kiwi_engine___object_8h_source.html | 95 +- .../_kiwi_engine___objects_8h_source.html | 90 +- .../_kiwi_engine___operator_8h_source.html | 107 ++ ...iwi_engine___operator_tilde_8h_source.html | 110 ++ .../_kiwi_engine___osc_tilde_8h_source.html | 110 ++ docs/html/_kiwi_engine___pack_8h_source.html | 108 ++ .../_kiwi_engine___patcher_8h_source.html | 94 +- ..._kiwi_engine___phasor_tilde_8h_source.html | 110 ++ docs/html/_kiwi_engine___pipe_8h_source.html | 108 ++ docs/html/_kiwi_engine___plus_8h_source.html | 106 ++ .../_kiwi_engine___plus_tilde_8h_source.html | 106 ++ docs/html/_kiwi_engine___pow_8h_source.html | 106 ++ docs/html/_kiwi_engine___print_8h_source.html | 107 ++ .../html/_kiwi_engine___random_8h_source.html | 107 ++ .../_kiwi_engine___receive_8h_source.html | 108 ++ .../_kiwi_engine___sah_tilde_8h_source.html | 110 ++ docs/html/_kiwi_engine___scale_8h_source.html | 107 ++ .../html/_kiwi_engine___select_8h_source.html | 107 ++ docs/html/_kiwi_engine___send_8h_source.html | 108 ++ .../_kiwi_engine___sig_tilde_8h_source.html | 110 ++ .../html/_kiwi_engine___slider_8h_source.html | 109 ++ ...iwi_engine___snapshot_tilde_8h_source.html | 110 ++ .../html/_kiwi_engine___switch_8h_source.html | 107 ++ ..._kiwi_engine___switch_tilde_8h_source.html | 110 ++ docs/html/_kiwi_engine___times_8h_source.html | 106 ++ .../_kiwi_engine___times_tilde_8h_source.html | 106 ++ .../html/_kiwi_engine___toggle_8h_source.html | 109 ++ .../_kiwi_engine___trigger_8h_source.html | 107 ++ .../html/_kiwi_engine___unpack_8h_source.html | 107 ++ docs/html/_kiwi_http_8h_source.html | 104 ++ docs/html/_kiwi_http_8hpp_source.html | 109 ++ docs/html/_kiwi_http___session_8h_source.html | 110 ++ .../_kiwi_http___session_8hpp_source.html | 103 ++ docs/html/_kiwi_http___util_8h_source.html | 102 ++ .../_kiwi_model___adc_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___bang_8h_source.html | 105 ++ docs/html/_kiwi_model___clip_8h_source.html | 106 ++ .../_kiwi_model___clip_tilde_8h_source.html | 106 ++ .../html/_kiwi_model___comment_8h_source.html | 109 ++ .../_kiwi_model___converter_8h_source.html | 104 ++ .../_kiwi_model___dac_tilde_8h_source.html | 105 ++ .../_kiwi_model___data_model_8h_source.html | 57 +- docs/html/_kiwi_model___def_8h_source.html | 52 +- docs/html/_kiwi_model___delay_8h_source.html | 105 ++ ..._model___delay_simple_tilde_8h_source.html | 105 ++ .../_kiwi_model___different_8h_source.html | 104 ++ ...iwi_model___different_tilde_8h_source.html | 104 ++ docs/html/_kiwi_model___divide_8h_source.html | 104 ++ .../_kiwi_model___divide_tilde_8h_source.html | 104 ++ ...wi_model___document_manager_8h_source.html | 117 ++ docs/html/_kiwi_model___equal_8h_source.html | 104 ++ .../_kiwi_model___equal_tilde_8h_source.html | 104 ++ docs/html/_kiwi_model___error_8h_source.html | 106 ++ .../_kiwi_model___error_box_8h_source.html | 112 ++ .../html/_kiwi_model___factory_8h_source.html | 85 +- docs/html/_kiwi_model___float_8h_source.html | 106 ++ docs/html/_kiwi_model___gate_8h_source.html | 105 ++ .../_kiwi_model___gate_tilde_8h_source.html | 105 ++ .../html/_kiwi_model___greater_8h_source.html | 104 ++ ..._kiwi_model___greater_equal_8h_source.html | 104 ++ ...model___greater_equal_tilde_8h_source.html | 104 ++ ..._kiwi_model___greater_tilde_8h_source.html | 104 ++ docs/html/_kiwi_model___hub_8h_source.html | 109 ++ docs/html/_kiwi_model___less_8h_source.html | 104 ++ .../_kiwi_model___less_equal_8h_source.html | 104 ++ ...wi_model___less_equal_tilde_8h_source.html | 104 ++ .../_kiwi_model___less_tilde_8h_source.html | 104 ++ .../_kiwi_model___line_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___link_8h_source.html | 66 +- .../_kiwi_model___loadmess_8h_source.html | 105 ++ .../html/_kiwi_model___message_8h_source.html | 109 ++ .../_kiwi_model___meter_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___metro_8h_source.html | 105 ++ docs/html/_kiwi_model___minus_8h_source.html | 104 ++ .../_kiwi_model___minus_tilde_8h_source.html | 104 ++ docs/html/_kiwi_model___modulo_8h_source.html | 104 ++ docs/html/_kiwi_model___mtof_8h_source.html | 105 ++ .../html/_kiwi_model___new_box_8h_source.html | 109 ++ .../_kiwi_model___noise_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___number_8h_source.html | 105 ++ .../_kiwi_model___number_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___object_8h_source.html | 74 +- .../_kiwi_model___object_class_8h_source.html | 112 ++ .../html/_kiwi_model___objects_8h_source.html | 95 +- .../_kiwi_model___operator_8h_source.html | 105 ++ ...kiwi_model___operator_tilde_8h_source.html | 105 ++ .../_kiwi_model___osc_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___pack_8h_source.html | 106 ++ .../html/_kiwi_model___patcher_8h_source.html | 83 +- .../_kiwi_model___patcher_user_8h_source.html | 58 +- ...i_model___patcher_validator_8h_source.html | 52 +- .../_kiwi_model___patcher_view_8h_source.html | 64 +- .../_kiwi_model___phasor_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___pipe_8h_source.html | 105 ++ docs/html/_kiwi_model___plus_8h_source.html | 104 ++ .../_kiwi_model___plus_tilde_8h_source.html | 104 ++ docs/html/_kiwi_model___pow_8h_source.html | 104 ++ docs/html/_kiwi_model___print_8h_source.html | 105 ++ docs/html/_kiwi_model___random_8h_source.html | 105 ++ .../html/_kiwi_model___receive_8h_source.html | 105 ++ .../_kiwi_model___sah_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___scale_8h_source.html | 105 ++ docs/html/_kiwi_model___select_8h_source.html | 105 ++ docs/html/_kiwi_model___send_8h_source.html | 105 ++ .../_kiwi_model___sig_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___slider_8h_source.html | 105 ++ ...kiwi_model___snapshot_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___switch_8h_source.html | 105 ++ .../_kiwi_model___switch_tilde_8h_source.html | 105 ++ docs/html/_kiwi_model___times_8h_source.html | 104 ++ .../_kiwi_model___times_tilde_8h_source.html | 104 ++ docs/html/_kiwi_model___toggle_8h_source.html | 105 ++ .../html/_kiwi_model___trigger_8h_source.html | 106 ++ docs/html/_kiwi_model___unpack_8h_source.html | 105 ++ docs/html/_kiwi_network___http_8h_source.html | 101 ++ .../html/_kiwi_server___server_8h_source.html | 113 ++ docs/html/_kiwi_tool___atom_8h_source.html | 125 ++ docs/html/_kiwi_tool___beacon_8h_source.html | 110 ++ ...kiwi_tool___circular_buffer_8h_source.html | 103 ++ ...iwi_tool___concurrent_queue_8h_source.html | 109 ++ .../_kiwi_tool___listeners_8h_source.html | 114 ++ docs/html/_kiwi_tool___matrix_8h_source.html | 108 ++ .../html/_kiwi_tool___matrix_8hpp_source.html | 108 ++ .../_kiwi_tool___parameter_8h_source.html | 109 ++ .../_kiwi_tool___scheduler_8h_source.html | 120 ++ .../_kiwi_tool___scheduler_8hpp_source.html | 134 +++ docs/html/_the-example.html | 101 ++ docs/html/annotated.html | 475 +++++--- docs/html/arrowdown.png | Bin 0 -> 246 bytes docs/html/arrowright.png | Bin 0 -> 229 bytes docs/html/classes.html | 203 ++-- .../classkiwi_1_1_about_window-members.html | 78 +- docs/html/classkiwi_1_1_about_window.html | 87 +- ..._1_1_about_window_1_1_content-members.html | 55 +- ...lasskiwi_1_1_about_window_1_1_content.html | 61 +- .../html/classkiwi_1_1_alert_box-members.html | 110 ++ docs/html/classkiwi_1_1_alert_box.html | 140 +++ docs/html/classkiwi_1_1_alert_box.png | Bin 0 -> 682 bytes docs/html/classkiwi_1_1_api-members.html | 98 +- docs/html/classkiwi_1_1_api.html | 375 ++++-- ...asskiwi_1_1_api_1_1_auth_user-members.html | 125 ++ .../html/classkiwi_1_1_api_1_1_auth_user.html | 218 ++++ docs/html/classkiwi_1_1_api_1_1_auth_user.png | Bin 0 -> 551 bytes ...sskiwi_1_1_api_1_1_controller-members.html | 120 ++ .../classkiwi_1_1_api_1_1_controller.html | 255 ++++ .../html/classkiwi_1_1_api_1_1_controller.png | Bin 0 -> 566 bytes ...lasskiwi_1_1_api_1_1_document-members.html | 118 ++ docs/html/classkiwi_1_1_api_1_1_document.html | 150 +++ .../classkiwi_1_1_api_1_1_error-members.html | 113 ++ docs/html/classkiwi_1_1_api_1_1_error.html | 127 ++ .../classkiwi_1_1_api_1_1_user-members.html | 117 ++ docs/html/classkiwi_1_1_api_1_1_user.html | 181 +++ docs/html/classkiwi_1_1_api_1_1_user.png | Bin 0 -> 551 bytes .../classkiwi_1_1_api_controller-members.html | 124 ++ docs/html/classkiwi_1_1_api_controller.html | 242 ++++ docs/html/classkiwi_1_1_api_controller.png | Bin 0 -> 561 bytes .../classkiwi_1_1_auth_panel-members.html | 114 ++ docs/html/classkiwi_1_1_auth_panel.html | 136 +++ docs/html/classkiwi_1_1_auth_panel.png | Bin 0 -> 744 bytes .../html/classkiwi_1_1_bang_view-members.html | 130 +++ docs/html/classkiwi_1_1_bang_view.html | 197 ++++ docs/html/classkiwi_1_1_bang_view.png | Bin 0 -> 1332 bytes ...asskiwi_1_1_beacon_dispatcher-members.html | 55 +- .../html/classkiwi_1_1_beacon_dispatcher.html | 77 +- ...wi_1_1_beacon_dispatcher_elem-members.html | 55 +- .../classkiwi_1_1_beacon_dispatcher_elem.html | 71 +- ...on_dispatcher_toolbar_factory-members.html | 55 +- ...1_1_beacon_dispatcher_toolbar_factory.html | 65 +- .../classkiwi_1_1_carrier_socket-members.html | 72 +- docs/html/classkiwi_1_1_carrier_socket.html | 113 +- .../classkiwi_1_1_classic_view-members.html | 135 +++ docs/html/classkiwi_1_1_classic_view.html | 228 ++++ docs/html/classkiwi_1_1_classic_view.png | Bin 0 -> 2257 bytes .../classkiwi_1_1_comment_view-members.html | 137 +++ docs/html/classkiwi_1_1_comment_view.html | 239 ++++ docs/html/classkiwi_1_1_comment_view.png | Bin 0 -> 2259 bytes docs/html/classkiwi_1_1_console-members.html | 55 +- docs/html/classkiwi_1_1_console.html | 69 +- ...classkiwi_1_1_console_content-members.html | 57 +- docs/html/classkiwi_1_1_console_content.html | 121 +- ...classkiwi_1_1_console_history-members.html | 57 +- docs/html/classkiwi_1_1_console_history.html | 104 +- ..._console_history_1_1_listener-members.html | 55 +- ...kiwi_1_1_console_history_1_1_listener.html | 59 +- ...i_1_1_console_toolbar_factory-members.html | 55 +- ...classkiwi_1_1_console_toolbar_factory.html | 65 +- ...iwi_1_1_custom_toolbar_button-members.html | 55 +- .../classkiwi_1_1_custom_toolbar_button.html | 73 +- ...iwi_1_1_custom_tooltip_client-members.html | 55 +- .../classkiwi_1_1_custom_tooltip_client.html | 61 +- ...lasskiwi_1_1_document_browser-members.html | 66 +- docs/html/classkiwi_1_1_document_browser.html | 108 +- docs/html/classkiwi_1_1_document_browser.png | Bin 993 -> 531 bytes ..._1_document_browser_1_1_drive-members.html | 73 +- ...sskiwi_1_1_document_browser_1_1_drive.html | 158 ++- ..._1_drive_1_1_document_session-members.html | 84 +- ...rowser_1_1_drive_1_1_document_session.html | 170 ++- ...iwi_1_1_document_browser_view-members.html | 67 +- .../classkiwi_1_1_document_browser_view.html | 87 +- .../classkiwi_1_1_document_browser_view.png | Bin 1066 -> 606 bytes ...t_browser_view_1_1_drive_view-members.html | 77 +- ..._document_browser_view_1_1_drive_view.html | 129 ++- ...iew_1_1_drive_view_1_1_header-members.html | 60 +- ...rowser_view_1_1_drive_view_1_1_header.html | 75 +- ...w_1_1_drive_view_1_1_row_elem-members.html | 59 +- ...wser_view_1_1_drive_view_1_1_row_elem.html | 91 +- ...owser_view_1_1_drive_view_1_1_row_elem.png | Bin 1227 -> 1613 bytes ...sskiwi_1_1_dsp_device_manager-members.html | 57 +- .../classkiwi_1_1_dsp_device_manager.html | 89 +- ...kiwi_1_1_editable_object_view-members.html | 133 +++ .../classkiwi_1_1_editable_object_view.html | 281 +++++ .../classkiwi_1_1_editable_object_view.png | Bin 0 -> 3562 bytes docs/html/classkiwi_1_1_factory-members.html | 111 ++ docs/html/classkiwi_1_1_factory.html | 165 +++ .../classkiwi_1_1_form_component-members.html | 126 ++ docs/html/classkiwi_1_1_form_component.html | 338 ++++++ docs/html/classkiwi_1_1_form_component.png | Bin 0 -> 1282 bytes ..._1_1_form_component_1_1_field-members.html | 112 ++ ...lasskiwi_1_1_form_component_1_1_field.html | 154 +++ ...classkiwi_1_1_form_component_1_1_field.png | Bin 0 -> 2907 bytes ...onent_1_1_field_1_1_kiwi_logo-members.html | 115 ++ ...orm_component_1_1_field_1_1_kiwi_logo.html | 140 +++ ...form_component_1_1_field_1_1_kiwi_logo.png | Bin 0 -> 1019 bytes ...ponent_1_1_field_1_1_password-members.html | 118 ++ ...form_component_1_1_field_1_1_password.html | 155 +++ ..._form_component_1_1_field_1_1_password.png | Bin 0 -> 1460 bytes ..._1_field_1_1_single_line_text-members.html | 116 ++ ...ponent_1_1_field_1_1_single_line_text.html | 151 +++ ...mponent_1_1_field_1_1_single_line_text.png | Bin 0 -> 1466 bytes ...ent_1_1_field_1_1_text_button-members.html | 116 ++ ...m_component_1_1_field_1_1_text_button.html | 146 +++ ...rm_component_1_1_field_1_1_text_button.png | Bin 0 -> 1437 bytes ...t_1_1_field_1_1_toggle_button-members.html | 115 ++ ...component_1_1_field_1_1_toggle_button.html | 143 +++ ..._component_1_1_field_1_1_toggle_button.png | Bin 0 -> 1039 bytes ...rm_component_1_1_overlay_comp-members.html | 112 ++ ...i_1_1_form_component_1_1_overlay_comp.html | 134 +++ ...wi_1_1_form_component_1_1_overlay_comp.png | Bin 0 -> 656 bytes .../classkiwi_1_1_hit_tester-members.html | 85 +- docs/html/classkiwi_1_1_hit_tester.html | 219 ++-- .../classkiwi_1_1_image_button-members.html | 67 +- docs/html/classkiwi_1_1_image_button.html | 137 ++- docs/html/classkiwi_1_1_instance-members.html | 77 +- docs/html/classkiwi_1_1_instance.html | 145 ++- docs/html/classkiwi_1_1_instance.png | Bin 0 -> 387 bytes ...asskiwi_1_1_iolet_highlighter-members.html | 59 +- .../html/classkiwi_1_1_iolet_highlighter.html | 87 +- docs/html/classkiwi_1_1_kiwi_app-members.html | 112 +- docs/html/classkiwi_1_1_kiwi_app.html | 178 ++- docs/html/classkiwi_1_1_kiwi_app.png | Bin 503 -> 1315 bytes ...wi_app_1_1_async_quit_retrier-members.html | 55 +- ...i_1_1_kiwi_app_1_1_async_quit_retrier.html | 57 +- docs/html/classkiwi_1_1_lasso-members.html | 57 +- docs/html/classkiwi_1_1_lasso.html | 79 +- .../html/classkiwi_1_1_link_view-members.html | 63 +- docs/html/classkiwi_1_1_link_view.html | 113 +- .../classkiwi_1_1_link_view_base-members.html | 55 +- docs/html/classkiwi_1_1_link_view_base.html | 63 +- ...asskiwi_1_1_link_view_creator-members.html | 65 +- .../html/classkiwi_1_1_link_view_creator.html | 109 +- .../classkiwi_1_1_login_form-members.html | 125 ++ docs/html/classkiwi_1_1_login_form.html | 216 ++++ docs/html/classkiwi_1_1_login_form.png | Bin 0 -> 1145 bytes .../classkiwi_1_1_look_and_feel-members.html | 55 +- docs/html/classkiwi_1_1_look_and_feel.html | 77 +- .../classkiwi_1_1_message_view-members.html | 137 +++ docs/html/classkiwi_1_1_message_view.html | 239 ++++ docs/html/classkiwi_1_1_message_view.png | Bin 0 -> 2284 bytes ...lasskiwi_1_1_meter_tilde_view-members.html | 130 +++ docs/html/classkiwi_1_1_meter_tilde_view.html | 198 ++++ docs/html/classkiwi_1_1_meter_tilde_view.png | Bin 0 -> 1367 bytes .../classkiwi_1_1_mouse_handler-members.html | 122 ++ docs/html/classkiwi_1_1_mouse_handler.html | 187 +++ ...lasskiwi_1_1_network_settings-members.html | 73 +- docs/html/classkiwi_1_1_network_settings.html | 135 ++- ...asskiwi_1_1_number_tilde_view-members.html | 142 +++ .../html/classkiwi_1_1_number_tilde_view.html | 261 +++++ docs/html/classkiwi_1_1_number_tilde_view.png | Bin 0 -> 2426 bytes .../classkiwi_1_1_number_view-members.html | 142 +++ docs/html/classkiwi_1_1_number_view.html | 262 +++++ docs/html/classkiwi_1_1_number_view.png | Bin 0 -> 2390 bytes ...lasskiwi_1_1_number_view_base-members.html | 138 +++ docs/html/classkiwi_1_1_number_view_base.html | 273 +++++ docs/html/classkiwi_1_1_number_view_base.png | Bin 0 -> 2531 bytes .../classkiwi_1_1_object_frame-members.html | 132 +++ docs/html/classkiwi_1_1_object_frame.html | 264 +++++ docs/html/classkiwi_1_1_object_frame.png | Bin 0 -> 1046 bytes .../classkiwi_1_1_object_view-members.html | 93 +- docs/html/classkiwi_1_1_object_view.html | 267 +++-- docs/html/classkiwi_1_1_object_view.png | Bin 728 -> 4359 bytes ...asskiwi_1_1_patcher_component-members.html | 64 +- .../html/classkiwi_1_1_patcher_component.html | 79 +- ...classkiwi_1_1_patcher_manager-members.html | 91 +- docs/html/classkiwi_1_1_patcher_manager.html | 226 ++-- ...classkiwi_1_1_patcher_toolbar-members.html | 58 +- docs/html/classkiwi_1_1_patcher_toolbar.html | 65 +- ...lbar_1_1_users_item_component-members.html | 63 +- ...cher_toolbar_1_1_users_item_component.html | 79 +- .../classkiwi_1_1_patcher_view-members.html | 99 +- docs/html/classkiwi_1_1_patcher_view.html | 244 ++-- ...skiwi_1_1_patcher_view_window-members.html | 80 +- .../classkiwi_1_1_patcher_view_window.html | 99 +- ...lasskiwi_1_1_patcher_viewport-members.html | 69 +- docs/html/classkiwi_1_1_patcher_viewport.html | 131 ++- .../classkiwi_1_1_settings_panel-members.html | 55 +- docs/html/classkiwi_1_1_settings_panel.html | 59 +- docs/html/classkiwi_1_1_settings_panel.png | Bin 561 -> 730 bytes .../classkiwi_1_1_sign_up_form-members.html | 126 ++ docs/html/classkiwi_1_1_sign_up_form.html | 219 ++++ docs/html/classkiwi_1_1_sign_up_form.png | Bin 0 -> 1162 bytes .../classkiwi_1_1_slider_view-members.html | 130 +++ docs/html/classkiwi_1_1_slider_view.html | 197 ++++ docs/html/classkiwi_1_1_slider_view.png | Bin 0 -> 1506 bytes ...classkiwi_1_1_stored_settings-members.html | 55 +- docs/html/classkiwi_1_1_stored_settings.html | 67 +- .../classkiwi_1_1_suggest_editor-members.html | 67 +- docs/html/classkiwi_1_1_suggest_editor.html | 104 +- docs/html/classkiwi_1_1_suggest_editor.png | Bin 889 -> 732 bytes ...i_1_1_suggest_editor_1_1_menu-members.html | 78 +- ...classkiwi_1_1_suggest_editor_1_1_menu.html | 111 +- .../classkiwi_1_1_suggest_list-members.html | 65 +- docs/html/classkiwi_1_1_suggest_list.html | 121 +- .../classkiwi_1_1_toggle_view-members.html | 130 +++ docs/html/classkiwi_1_1_toggle_view.html | 197 ++++ docs/html/classkiwi_1_1_toggle_view.png | Bin 0 -> 1335 bytes .../classkiwi_1_1_tooltip_window-members.html | 55 +- docs/html/classkiwi_1_1_tooltip_window.html | 77 +- docs/html/classkiwi_1_1_window-members.html | 76 +- docs/html/classkiwi_1_1_window.html | 97 +- .../classkiwi_1_1dsp_1_1_buffer-members.html | 63 +- docs/html/classkiwi_1_1dsp_1_1_buffer.html | 121 +- .../classkiwi_1_1dsp_1_1_chain-members.html | 59 +- docs/html/classkiwi_1_1dsp_1_1_chain.html | 119 +- ...iwi_1_1dsp_1_1_chain_1_1_node-members.html | 55 +- .../classkiwi_1_1dsp_1_1_chain_1_1_node.html | 79 +- ...sp_1_1_chain_1_1_node_1_1_pin-members.html | 55 +- ...iwi_1_1dsp_1_1_chain_1_1_node_1_1_pin.html | 85 +- ...sp_1_1_chain_1_1_node_1_1_tie-members.html | 57 +- ...iwi_1_1dsp_1_1_chain_1_1_node_1_1_tie.html | 69 +- .../classkiwi_1_1dsp_1_1_error-members.html | 55 +- docs/html/classkiwi_1_1dsp_1_1_error.html | 65 +- ..._1dsp_1_1_i_perform_call_back-members.html | 55 +- ...sskiwi_1_1dsp_1_1_i_perform_call_back.html | 61 +- ...asskiwi_1_1dsp_1_1_loop_error-members.html | 55 +- .../html/classkiwi_1_1dsp_1_1_loop_error.html | 71 +- ..._1_1dsp_1_1_perform_call_back-members.html | 55 +- ...lasskiwi_1_1dsp_1_1_perform_call_back.html | 67 +- ...lasskiwi_1_1dsp_1_1_processor-members.html | 61 +- docs/html/classkiwi_1_1dsp_1_1_processor.html | 128 +- docs/html/classkiwi_1_1dsp_1_1_processor.png | Bin 4074 -> 8177 bytes .../classkiwi_1_1dsp_1_1_signal-members.html | 61 +- docs/html/classkiwi_1_1dsp_1_1_signal.html | 123 +- .../classkiwi_1_1dsp_1_1_timer-members.html | 55 +- docs/html/classkiwi_1_1dsp_1_1_timer.html | 75 +- ...skiwi_1_1engine_1_1_adc_tilde-members.html | 100 +- .../classkiwi_1_1engine_1_1_adc_tilde.html | 234 ++-- .../classkiwi_1_1engine_1_1_adc_tilde.png | Bin 1982 -> 2433 bytes ...1_1engine_1_1_audio_controler-members.html | 57 +- ...asskiwi_1_1engine_1_1_audio_controler.html | 79 +- ...ne_1_1_audio_interface_object-members.html | 96 +- ..._1_1engine_1_1_audio_interface_object.html | 224 ++-- ...i_1_1engine_1_1_audio_interface_object.png | Bin 2114 -> 2567 bytes ...wi_1_1engine_1_1_audio_object-members.html | 90 +- .../classkiwi_1_1engine_1_1_audio_object.html | 209 ++-- .../classkiwi_1_1engine_1_1_audio_object.png | Bin 4334 -> 9713 bytes .../classkiwi_1_1engine_1_1_bang-members.html | 135 +++ docs/html/classkiwi_1_1engine_1_1_bang.html | 264 +++++ docs/html/classkiwi_1_1engine_1_1_bang.png | Bin 0 -> 980 bytes .../classkiwi_1_1engine_1_1_clip-members.html | 133 +++ docs/html/classkiwi_1_1engine_1_1_clip.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_clip.png | Bin 0 -> 964 bytes ...kiwi_1_1engine_1_1_clip_tilde-members.html | 146 +++ .../classkiwi_1_1engine_1_1_clip_tilde.html | 344 ++++++ .../classkiwi_1_1engine_1_1_clip_tilde.png | Bin 0 -> 1837 bytes ...asskiwi_1_1engine_1_1_comment-members.html | 134 +++ .../html/classkiwi_1_1engine_1_1_comment.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_comment.png | Bin 0 -> 1001 bytes ...asskiwi_1_1engine_1_1_console-members.html | 57 +- .../html/classkiwi_1_1engine_1_1_console.html | 71 +- ...gine_1_1_console_1_1_listener-members.html | 55 +- ...wi_1_1engine_1_1_console_1_1_listener.html | 57 +- ...ngine_1_1_console_1_1_message-members.html | 55 +- ...iwi_1_1engine_1_1_console_1_1_message.html | 61 +- ...skiwi_1_1engine_1_1_dac_tilde-members.html | 100 +- .../classkiwi_1_1engine_1_1_dac_tilde.html | 234 ++-- .../classkiwi_1_1engine_1_1_dac_tilde.png | Bin 1993 -> 2444 bytes ...classkiwi_1_1engine_1_1_delay-members.html | 93 +- docs/html/classkiwi_1_1engine_1_1_delay.html | 188 ++- docs/html/classkiwi_1_1engine_1_1_delay.png | Bin 585 -> 990 bytes ...engine_1_1_delay_simple_tilde-members.html | 114 +- ...kiwi_1_1engine_1_1_delay_simple_tilde.html | 287 +++-- ...skiwi_1_1engine_1_1_delay_simple_tilde.png | Bin 1499 -> 2572 bytes ...skiwi_1_1engine_1_1_different-members.html | 138 +++ .../classkiwi_1_1engine_1_1_different.html | 239 ++++ .../classkiwi_1_1engine_1_1_different.png | Bin 0 -> 1316 bytes ...1_1engine_1_1_different_tilde-members.html | 147 +++ ...asskiwi_1_1engine_1_1_different_tilde.html | 275 +++++ ...lasskiwi_1_1engine_1_1_different_tilde.png | Bin 0 -> 2305 bytes ...lasskiwi_1_1engine_1_1_divide-members.html | 138 +++ docs/html/classkiwi_1_1engine_1_1_divide.html | 239 ++++ docs/html/classkiwi_1_1engine_1_1_divide.png | Bin 0 -> 1299 bytes ...wi_1_1engine_1_1_divide_tilde-members.html | 147 +++ .../classkiwi_1_1engine_1_1_divide_tilde.html | 275 +++++ .../classkiwi_1_1engine_1_1_divide_tilde.png | Bin 0 -> 2275 bytes ...classkiwi_1_1engine_1_1_equal-members.html | 138 +++ docs/html/classkiwi_1_1engine_1_1_equal.html | 239 ++++ docs/html/classkiwi_1_1engine_1_1_equal.png | Bin 0 -> 1303 bytes ...iwi_1_1engine_1_1_equal_tilde-members.html | 147 +++ .../classkiwi_1_1engine_1_1_equal_tilde.html | 275 +++++ .../classkiwi_1_1engine_1_1_equal_tilde.png | Bin 0 -> 2286 bytes ...skiwi_1_1engine_1_1_error_box-members.html | 94 +- .../classkiwi_1_1engine_1_1_error_box.html | 220 ++-- .../classkiwi_1_1engine_1_1_error_box.png | Bin 1382 -> 1828 bytes ...asskiwi_1_1engine_1_1_factory-members.html | 60 +- .../html/classkiwi_1_1engine_1_1_factory.html | 96 +- ...classkiwi_1_1engine_1_1_float-members.html | 133 +++ docs/html/classkiwi_1_1engine_1_1_float.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_float.png | Bin 0 -> 985 bytes .../classkiwi_1_1engine_1_1_gate-members.html | 133 +++ docs/html/classkiwi_1_1engine_1_1_gate.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_gate.png | Bin 0 -> 983 bytes ...kiwi_1_1engine_1_1_gate_tilde-members.html | 144 +++ .../classkiwi_1_1engine_1_1_gate_tilde.html | 338 ++++++ .../classkiwi_1_1engine_1_1_gate_tilde.png | Bin 0 -> 1847 bytes ...asskiwi_1_1engine_1_1_greater-members.html | 138 +++ .../html/classkiwi_1_1engine_1_1_greater.html | 239 ++++ docs/html/classkiwi_1_1engine_1_1_greater.png | Bin 0 -> 1323 bytes ...i_1_1engine_1_1_greater_equal-members.html | 138 +++ ...classkiwi_1_1engine_1_1_greater_equal.html | 239 ++++ .../classkiwi_1_1engine_1_1_greater_equal.png | Bin 0 -> 1356 bytes ...ngine_1_1_greater_equal_tilde-members.html | 147 +++ ...iwi_1_1engine_1_1_greater_equal_tilde.html | 275 +++++ ...kiwi_1_1engine_1_1_greater_equal_tilde.png | Bin 0 -> 2405 bytes ...i_1_1engine_1_1_greater_tilde-members.html | 147 +++ ...classkiwi_1_1engine_1_1_greater_tilde.html | 275 +++++ .../classkiwi_1_1engine_1_1_greater_tilde.png | Bin 0 -> 2307 bytes .../classkiwi_1_1engine_1_1_hub-members.html | 135 +++ docs/html/classkiwi_1_1engine_1_1_hub.html | 303 +++++ docs/html/classkiwi_1_1engine_1_1_hub.png | Bin 0 -> 975 bytes ...sskiwi_1_1engine_1_1_instance-members.html | 75 +- .../classkiwi_1_1engine_1_1_instance.html | 125 +- .../html/classkiwi_1_1engine_1_1_instance.png | Bin 717 -> 656 bytes .../classkiwi_1_1engine_1_1_less-members.html | 138 +++ docs/html/classkiwi_1_1engine_1_1_less.html | 239 ++++ docs/html/classkiwi_1_1engine_1_1_less.png | Bin 0 -> 1279 bytes ...kiwi_1_1engine_1_1_less_equal-members.html | 138 +++ .../classkiwi_1_1engine_1_1_less_equal.html | 239 ++++ .../classkiwi_1_1engine_1_1_less_equal.png | Bin 0 -> 1334 bytes ..._1engine_1_1_less_equal_tilde-members.html | 147 +++ ...sskiwi_1_1engine_1_1_less_equal_tilde.html | 275 +++++ ...asskiwi_1_1engine_1_1_less_equal_tilde.png | Bin 0 -> 2325 bytes ...kiwi_1_1engine_1_1_less_tilde-members.html | 147 +++ .../classkiwi_1_1engine_1_1_less_tilde.html | 275 +++++ .../classkiwi_1_1engine_1_1_less_tilde.png | Bin 0 -> 2282 bytes ...kiwi_1_1engine_1_1_line_tilde-members.html | 144 +++ .../classkiwi_1_1engine_1_1_line_tilde.html | 341 ++++++ .../classkiwi_1_1engine_1_1_line_tilde.png | Bin 0 -> 1833 bytes ..._1_1_line_tilde_1_1_bang_task-members.html | 112 ++ ..._1engine_1_1_line_tilde_1_1_bang_task.html | 137 +++ ...1_1engine_1_1_line_tilde_1_1_bang_task.png | Bin 0 -> 831 bytes .../classkiwi_1_1engine_1_1_link-members.html | 61 +- docs/html/classkiwi_1_1engine_1_1_link.html | 87 +- ...sskiwi_1_1engine_1_1_loadmess-members.html | 88 +- .../classkiwi_1_1engine_1_1_loadmess.html | 184 ++- .../html/classkiwi_1_1engine_1_1_loadmess.png | Bin 641 -> 1005 bytes ...asskiwi_1_1engine_1_1_message-members.html | 136 +++ .../html/classkiwi_1_1engine_1_1_message.html | 307 +++++ docs/html/classkiwi_1_1engine_1_1_message.png | Bin 0 -> 1015 bytes ...iwi_1_1engine_1_1_meter_tilde-members.html | 150 +++ .../classkiwi_1_1engine_1_1_meter_tilde.html | 385 ++++++ .../classkiwi_1_1engine_1_1_meter_tilde.png | Bin 0 -> 2527 bytes ...classkiwi_1_1engine_1_1_metro-members.html | 90 +- docs/html/classkiwi_1_1engine_1_1_metro.html | 192 ++- docs/html/classkiwi_1_1engine_1_1_metro.png | Bin 1120 -> 989 bytes ...classkiwi_1_1engine_1_1_minus-members.html | 138 +++ docs/html/classkiwi_1_1engine_1_1_minus.html | 239 ++++ docs/html/classkiwi_1_1engine_1_1_minus.png | Bin 0 -> 1298 bytes ...iwi_1_1engine_1_1_minus_tilde-members.html | 147 +++ .../classkiwi_1_1engine_1_1_minus_tilde.html | 275 +++++ .../classkiwi_1_1engine_1_1_minus_tilde.png | Bin 0 -> 2282 bytes ...lasskiwi_1_1engine_1_1_modulo-members.html | 138 +++ docs/html/classkiwi_1_1engine_1_1_modulo.html | 239 ++++ docs/html/classkiwi_1_1engine_1_1_modulo.png | Bin 0 -> 1301 bytes .../classkiwi_1_1engine_1_1_mtof-members.html | 134 +++ docs/html/classkiwi_1_1engine_1_1_mtof.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_mtof.png | Bin 0 -> 989 bytes ...asskiwi_1_1engine_1_1_new_box-members.html | 86 +- .../html/classkiwi_1_1engine_1_1_new_box.html | 184 ++- docs/html/classkiwi_1_1engine_1_1_new_box.png | Bin 591 -> 1005 bytes ...iwi_1_1engine_1_1_noise_tilde-members.html | 143 +++ .../classkiwi_1_1engine_1_1_noise_tilde.html | 335 ++++++ .../classkiwi_1_1engine_1_1_noise_tilde.png | Bin 0 -> 1848 bytes ...lasskiwi_1_1engine_1_1_number-members.html | 134 +++ docs/html/classkiwi_1_1engine_1_1_number.html | 303 +++++ docs/html/classkiwi_1_1engine_1_1_number.png | Bin 0 -> 995 bytes ...wi_1_1engine_1_1_number_tilde-members.html | 147 +++ .../classkiwi_1_1engine_1_1_number_tilde.html | 325 ++++++ .../classkiwi_1_1engine_1_1_number_tilde.png | Bin 0 -> 2533 bytes ...lasskiwi_1_1engine_1_1_object-members.html | 82 +- docs/html/classkiwi_1_1engine_1_1_object.html | 408 +++++-- docs/html/classkiwi_1_1engine_1_1_object.png | Bin 4265 -> 11917 bytes ...sskiwi_1_1engine_1_1_operator-members.html | 135 +++ .../classkiwi_1_1engine_1_1_operator.html | 279 +++++ .../html/classkiwi_1_1engine_1_1_operator.png | Bin 0 -> 6034 bytes ..._1_1engine_1_1_operator_tilde-members.html | 144 +++ ...lasskiwi_1_1engine_1_1_operator_tilde.html | 348 ++++++ ...classkiwi_1_1engine_1_1_operator_tilde.png | Bin 0 -> 7122 bytes ...skiwi_1_1engine_1_1_osc_tilde-members.html | 94 +- .../classkiwi_1_1engine_1_1_osc_tilde.html | 228 ++-- .../classkiwi_1_1engine_1_1_osc_tilde.png | Bin 1380 -> 1836 bytes .../classkiwi_1_1engine_1_1_pack-members.html | 135 +++ docs/html/classkiwi_1_1engine_1_1_pack.html | 264 +++++ docs/html/classkiwi_1_1engine_1_1_pack.png | Bin 0 -> 988 bytes ...asskiwi_1_1engine_1_1_patcher-members.html | 90 +- .../html/classkiwi_1_1engine_1_1_patcher.html | 177 +-- ...wi_1_1engine_1_1_phasor_tilde-members.html | 144 +++ .../classkiwi_1_1engine_1_1_phasor_tilde.html | 338 ++++++ .../classkiwi_1_1engine_1_1_phasor_tilde.png | Bin 0 -> 1856 bytes .../classkiwi_1_1engine_1_1_pipe-members.html | 88 +- docs/html/classkiwi_1_1engine_1_1_pipe.html | 190 ++- docs/html/classkiwi_1_1engine_1_1_pipe.png | Bin 575 -> 978 bytes .../classkiwi_1_1engine_1_1_plus-members.html | 96 +- docs/html/classkiwi_1_1engine_1_1_plus.html | 235 ++-- docs/html/classkiwi_1_1engine_1_1_plus.png | Bin 577 -> 1282 bytes ...kiwi_1_1engine_1_1_plus_tilde-members.html | 109 +- .../classkiwi_1_1engine_1_1_plus_tilde.html | 311 ++--- .../classkiwi_1_1engine_1_1_plus_tilde.png | Bin 1375 -> 2274 bytes .../classkiwi_1_1engine_1_1_pow-members.html | 138 +++ docs/html/classkiwi_1_1engine_1_1_pow.html | 239 ++++ docs/html/classkiwi_1_1engine_1_1_pow.png | Bin 0 -> 1290 bytes ...classkiwi_1_1engine_1_1_print-members.html | 86 +- docs/html/classkiwi_1_1engine_1_1_print.html | 184 ++- docs/html/classkiwi_1_1engine_1_1_print.png | Bin 570 -> 972 bytes .../classkiwi_1_1engine_1_1_ramp-members.html | 114 ++ docs/html/classkiwi_1_1engine_1_1_ramp.html | 284 +++++ ...lasskiwi_1_1engine_1_1_random-members.html | 133 +++ docs/html/classkiwi_1_1engine_1_1_random.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_random.png | Bin 0 -> 997 bytes ...asskiwi_1_1engine_1_1_receive-members.html | 91 +- .../html/classkiwi_1_1engine_1_1_receive.html | 236 ++-- docs/html/classkiwi_1_1engine_1_1_receive.png | Bin 1035 -> 1436 bytes ...skiwi_1_1engine_1_1_sah_tilde-members.html | 143 +++ .../classkiwi_1_1engine_1_1_sah_tilde.html | 335 ++++++ .../classkiwi_1_1engine_1_1_sah_tilde.png | Bin 0 -> 1843 bytes ...classkiwi_1_1engine_1_1_scale-members.html | 133 +++ docs/html/classkiwi_1_1engine_1_1_scale.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_scale.png | Bin 0 -> 986 bytes ...lasskiwi_1_1engine_1_1_select-members.html | 134 +++ docs/html/classkiwi_1_1engine_1_1_select.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_select.png | Bin 0 -> 986 bytes .../classkiwi_1_1engine_1_1_send-members.html | 134 +++ docs/html/classkiwi_1_1engine_1_1_send.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_send.png | Bin 0 -> 979 bytes ...skiwi_1_1engine_1_1_sig_tilde-members.html | 94 +- .../classkiwi_1_1engine_1_1_sig_tilde.html | 222 ++-- .../classkiwi_1_1engine_1_1_sig_tilde.png | Bin 1377 -> 1838 bytes ...lasskiwi_1_1engine_1_1_slider-members.html | 135 +++ docs/html/classkiwi_1_1engine_1_1_slider.html | 303 +++++ docs/html/classkiwi_1_1engine_1_1_slider.png | Bin 0 -> 987 bytes ..._1_1engine_1_1_snapshot_tilde-members.html | 143 +++ ...lasskiwi_1_1engine_1_1_snapshot_tilde.html | 335 ++++++ ...classkiwi_1_1engine_1_1_snapshot_tilde.png | Bin 0 -> 1861 bytes ...lasskiwi_1_1engine_1_1_switch-members.html | 133 +++ docs/html/classkiwi_1_1engine_1_1_switch.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_switch.png | Bin 0 -> 990 bytes ...wi_1_1engine_1_1_switch_tilde-members.html | 144 +++ .../classkiwi_1_1engine_1_1_switch_tilde.html | 338 ++++++ .../classkiwi_1_1engine_1_1_switch_tilde.png | Bin 0 -> 1851 bytes ...classkiwi_1_1engine_1_1_times-members.html | 96 +- docs/html/classkiwi_1_1engine_1_1_times.html | 235 ++-- docs/html/classkiwi_1_1engine_1_1_times.png | Bin 574 -> 1286 bytes ...iwi_1_1engine_1_1_times_tilde-members.html | 109 +- .../classkiwi_1_1engine_1_1_times_tilde.html | 311 ++--- .../classkiwi_1_1engine_1_1_times_tilde.png | Bin 1372 -> 2275 bytes ...lasskiwi_1_1engine_1_1_toggle-members.html | 135 +++ docs/html/classkiwi_1_1engine_1_1_toggle.html | 303 +++++ docs/html/classkiwi_1_1engine_1_1_toggle.png | Bin 0 -> 991 bytes ...asskiwi_1_1engine_1_1_trigger-members.html | 134 +++ .../html/classkiwi_1_1engine_1_1_trigger.html | 261 +++++ docs/html/classkiwi_1_1engine_1_1_trigger.png | Bin 0 -> 1004 bytes ...lasskiwi_1_1engine_1_1_unpack-members.html | 135 +++ docs/html/classkiwi_1_1engine_1_1_unpack.html | 264 +++++ docs/html/classkiwi_1_1engine_1_1_unpack.png | Bin 0 -> 997 bytes ...sskiwi_1_1model_1_1_adc_tilde-members.html | 125 +- .../classkiwi_1_1model_1_1_adc_tilde.html | 339 ++++-- .../classkiwi_1_1model_1_1_bang-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_bang.html | 347 ++++++ docs/html/classkiwi_1_1model_1_1_bang.png | Bin 0 -> 712 bytes .../classkiwi_1_1model_1_1_clip-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_clip.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_clip.png | Bin 0 -> 705 bytes ...skiwi_1_1model_1_1_clip_tilde-members.html | 161 +++ .../classkiwi_1_1model_1_1_clip_tilde.html | 340 ++++++ .../classkiwi_1_1model_1_1_clip_tilde.png | Bin 0 -> 721 bytes ...lasskiwi_1_1model_1_1_comment-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_comment.html | 448 +++++++ docs/html/classkiwi_1_1model_1_1_comment.png | Bin 0 -> 699 bytes ...sskiwi_1_1model_1_1_converter-members.html | 108 ++ .../classkiwi_1_1model_1_1_converter.html | 153 +++ ...sskiwi_1_1model_1_1_dac_tilde-members.html | 125 +- .../classkiwi_1_1model_1_1_dac_tilde.html | 339 ++++-- ...skiwi_1_1model_1_1_data_model-members.html | 60 +- .../classkiwi_1_1model_1_1_data_model.html | 76 +- .../classkiwi_1_1model_1_1_delay-members.html | 128 +- docs/html/classkiwi_1_1model_1_1_delay.html | 330 ++++-- ...1model_1_1_delay_simple_tilde-members.html | 128 +- ...skiwi_1_1model_1_1_delay_simple_tilde.html | 330 ++++-- ...sskiwi_1_1model_1_1_different-members.html | 163 +++ .../classkiwi_1_1model_1_1_different.html | 352 ++++++ .../html/classkiwi_1_1model_1_1_different.png | Bin 0 -> 943 bytes ..._1_1model_1_1_different_tilde-members.html | 163 +++ ...lasskiwi_1_1model_1_1_different_tilde.html | 352 ++++++ ...classkiwi_1_1model_1_1_different_tilde.png | Bin 0 -> 1176 bytes ...classkiwi_1_1model_1_1_divide-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_divide.html | 352 ++++++ docs/html/classkiwi_1_1model_1_1_divide.png | Bin 0 -> 923 bytes ...iwi_1_1model_1_1_divide_tilde-members.html | 163 +++ .../classkiwi_1_1model_1_1_divide_tilde.html | 352 ++++++ .../classkiwi_1_1model_1_1_divide_tilde.png | Bin 0 -> 1143 bytes ...1_1model_1_1_document_manager-members.html | 123 ++ ...asskiwi_1_1model_1_1_document_manager.html | 315 +++++ .../classkiwi_1_1model_1_1_equal-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_equal.html | 352 ++++++ docs/html/classkiwi_1_1model_1_1_equal.png | Bin 0 -> 936 bytes ...kiwi_1_1model_1_1_equal_tilde-members.html | 163 +++ .../classkiwi_1_1model_1_1_equal_tilde.html | 352 ++++++ .../classkiwi_1_1model_1_1_equal_tilde.png | Bin 0 -> 1164 bytes .../classkiwi_1_1model_1_1_error-members.html | 110 ++ docs/html/classkiwi_1_1model_1_1_error.html | 142 +++ docs/html/classkiwi_1_1model_1_1_error.png | Bin 0 -> 878 bytes ...sskiwi_1_1model_1_1_error_box-members.html | 136 ++- .../classkiwi_1_1model_1_1_error_box.html | 345 ++++-- ...lasskiwi_1_1model_1_1_factory-members.html | 68 +- docs/html/classkiwi_1_1model_1_1_factory.html | 155 +-- .../classkiwi_1_1model_1_1_float-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_float.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_float.png | Bin 0 -> 713 bytes .../classkiwi_1_1model_1_1_gate-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_gate.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_gate.png | Bin 0 -> 717 bytes ...skiwi_1_1model_1_1_gate_tilde-members.html | 161 +++ .../classkiwi_1_1model_1_1_gate_tilde.html | 340 ++++++ .../classkiwi_1_1model_1_1_gate_tilde.png | Bin 0 -> 734 bytes ...lasskiwi_1_1model_1_1_greater-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_greater.html | 352 ++++++ docs/html/classkiwi_1_1model_1_1_greater.png | Bin 0 -> 944 bytes ...wi_1_1model_1_1_greater_equal-members.html | 163 +++ .../classkiwi_1_1model_1_1_greater_equal.html | 352 ++++++ .../classkiwi_1_1model_1_1_greater_equal.png | Bin 0 -> 1157 bytes ...model_1_1_greater_equal_tilde-members.html | 163 +++ ...kiwi_1_1model_1_1_greater_equal_tilde.html | 352 ++++++ ...skiwi_1_1model_1_1_greater_equal_tilde.png | Bin 0 -> 1258 bytes ...wi_1_1model_1_1_greater_tilde-members.html | 163 +++ .../classkiwi_1_1model_1_1_greater_tilde.html | 352 ++++++ .../classkiwi_1_1model_1_1_greater_tilde.png | Bin 0 -> 1178 bytes .../classkiwi_1_1model_1_1_hub-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_hub.html | 448 +++++++ docs/html/classkiwi_1_1model_1_1_hub.png | Bin 0 -> 706 bytes .../classkiwi_1_1model_1_1_inlet-members.html | 57 +- docs/html/classkiwi_1_1model_1_1_inlet.html | 71 +- .../classkiwi_1_1model_1_1_less-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_less.html | 352 ++++++ docs/html/classkiwi_1_1model_1_1_less.png | Bin 0 -> 917 bytes ...skiwi_1_1model_1_1_less_equal-members.html | 163 +++ .../classkiwi_1_1model_1_1_less_equal.html | 352 ++++++ .../classkiwi_1_1model_1_1_less_equal.png | Bin 0 -> 1075 bytes ...1_1model_1_1_less_equal_tilde-members.html | 163 +++ ...asskiwi_1_1model_1_1_less_equal_tilde.html | 352 ++++++ ...lasskiwi_1_1model_1_1_less_equal_tilde.png | Bin 0 -> 1205 bytes ...skiwi_1_1model_1_1_less_tilde-members.html | 163 +++ .../classkiwi_1_1model_1_1_less_tilde.html | 352 ++++++ .../classkiwi_1_1model_1_1_less_tilde.png | Bin 0 -> 1147 bytes ...skiwi_1_1model_1_1_line_tilde-members.html | 161 +++ .../classkiwi_1_1model_1_1_line_tilde.html | 340 ++++++ .../classkiwi_1_1model_1_1_line_tilde.png | Bin 0 -> 705 bytes .../classkiwi_1_1model_1_1_link-members.html | 69 +- docs/html/classkiwi_1_1model_1_1_link.html | 121 +- ...asskiwi_1_1model_1_1_loadmess-members.html | 128 +- .../html/classkiwi_1_1model_1_1_loadmess.html | 330 ++++-- ...lasskiwi_1_1model_1_1_message-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_message.html | 452 ++++++++ docs/html/classkiwi_1_1model_1_1_message.png | Bin 0 -> 710 bytes ...kiwi_1_1model_1_1_meter_tilde-members.html | 163 +++ .../classkiwi_1_1model_1_1_meter_tilde.html | 347 ++++++ .../classkiwi_1_1model_1_1_meter_tilde.png | Bin 0 -> 816 bytes .../classkiwi_1_1model_1_1_metro-members.html | 128 +- docs/html/classkiwi_1_1model_1_1_metro.html | 330 ++++-- .../classkiwi_1_1model_1_1_minus-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_minus.html | 352 ++++++ docs/html/classkiwi_1_1model_1_1_minus.png | Bin 0 -> 927 bytes ...kiwi_1_1model_1_1_minus_tilde-members.html | 163 +++ .../classkiwi_1_1model_1_1_minus_tilde.html | 352 ++++++ .../classkiwi_1_1model_1_1_minus_tilde.png | Bin 0 -> 1158 bytes ...classkiwi_1_1model_1_1_modulo-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_modulo.html | 352 ++++++ docs/html/classkiwi_1_1model_1_1_modulo.png | Bin 0 -> 920 bytes .../classkiwi_1_1model_1_1_mtof-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_mtof.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_mtof.png | Bin 0 -> 714 bytes ...lasskiwi_1_1model_1_1_new_box-members.html | 128 +- docs/html/classkiwi_1_1model_1_1_new_box.html | 334 ++++-- ...kiwi_1_1model_1_1_noise_tilde-members.html | 161 +++ .../classkiwi_1_1model_1_1_noise_tilde.html | 340 ++++++ .../classkiwi_1_1model_1_1_noise_tilde.png | Bin 0 -> 797 bytes ...classkiwi_1_1model_1_1_number-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_number.html | 347 ++++++ docs/html/classkiwi_1_1model_1_1_number.png | Bin 0 -> 735 bytes ...iwi_1_1model_1_1_number_tilde-members.html | 161 +++ .../classkiwi_1_1model_1_1_number_tilde.html | 340 ++++++ .../classkiwi_1_1model_1_1_number_tilde.png | Bin 0 -> 837 bytes ...classkiwi_1_1model_1_1_object-members.html | 127 +- docs/html/classkiwi_1_1model_1_1_object.html | 658 +++++++++-- docs/html/classkiwi_1_1model_1_1_object.png | Bin 7305 -> 17825 bytes ...1_1model_1_1_object_1_1_error-members.html | 111 ++ ...asskiwi_1_1model_1_1_object_1_1_error.html | 148 +++ ...lasskiwi_1_1model_1_1_object_1_1_error.png | Bin 0 -> 874 bytes ...model_1_1_object_1_1_listener-members.html | 110 ++ ...kiwi_1_1model_1_1_object_1_1_listener.html | 165 +++ ...skiwi_1_1model_1_1_object_1_1_listener.png | Bin 0 -> 16987 bytes ...iwi_1_1model_1_1_object_class-members.html | 127 ++ .../classkiwi_1_1model_1_1_object_class.html | 313 +++++ ...asskiwi_1_1model_1_1_operator-members.html | 160 +++ .../html/classkiwi_1_1model_1_1_operator.html | 349 ++++++ docs/html/classkiwi_1_1model_1_1_operator.png | Bin 0 -> 5499 bytes ...i_1_1model_1_1_operator_tilde-members.html | 160 +++ ...classkiwi_1_1model_1_1_operator_tilde.html | 347 ++++++ .../classkiwi_1_1model_1_1_operator_tilde.png | Bin 0 -> 5367 bytes ...sskiwi_1_1model_1_1_osc_tilde-members.html | 128 +- .../classkiwi_1_1model_1_1_osc_tilde.html | 330 ++++-- ...classkiwi_1_1model_1_1_outlet-members.html | 57 +- docs/html/classkiwi_1_1model_1_1_outlet.html | 69 +- .../classkiwi_1_1model_1_1_pack-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_pack.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_pack.png | Bin 0 -> 719 bytes ..._1_1model_1_1_parameter_class-members.html | 113 ++ ...lasskiwi_1_1model_1_1_parameter_class.html | 154 +++ ...lasskiwi_1_1model_1_1_patcher-members.html | 106 +- docs/html/classkiwi_1_1model_1_1_patcher.html | 227 ++-- ...1_1model_1_1_patcher_1_1_user-members.html | 61 +- ...asskiwi_1_1model_1_1_patcher_1_1_user.html | 91 +- ...1_1model_1_1_patcher_1_1_view-members.html | 69 +- ...asskiwi_1_1model_1_1_patcher_1_1_view.html | 147 ++- ..._1model_1_1_patcher_validator-members.html | 55 +- ...sskiwi_1_1model_1_1_patcher_validator.html | 57 +- ...iwi_1_1model_1_1_phasor_tilde-members.html | 161 +++ .../classkiwi_1_1model_1_1_phasor_tilde.html | 340 ++++++ .../classkiwi_1_1model_1_1_phasor_tilde.png | Bin 0 -> 830 bytes ...asskiwi_1_1model_1_1_pin_type-members.html | 59 +- .../html/classkiwi_1_1model_1_1_pin_type.html | 79 +- .../classkiwi_1_1model_1_1_pipe-members.html | 128 +- docs/html/classkiwi_1_1model_1_1_pipe.html | 330 ++++-- .../classkiwi_1_1model_1_1_plus-members.html | 130 ++- docs/html/classkiwi_1_1model_1_1_plus.html | 344 ++++-- docs/html/classkiwi_1_1model_1_1_plus.png | Bin 710 -> 918 bytes ...skiwi_1_1model_1_1_plus_tilde-members.html | 130 ++- .../classkiwi_1_1model_1_1_plus_tilde.html | 344 ++++-- .../classkiwi_1_1model_1_1_plus_tilde.png | Bin 703 -> 1146 bytes .../classkiwi_1_1model_1_1_pow-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_pow.html | 352 ++++++ docs/html/classkiwi_1_1model_1_1_pow.png | Bin 0 -> 922 bytes .../classkiwi_1_1model_1_1_print-members.html | 128 +- docs/html/classkiwi_1_1model_1_1_print.html | 330 ++++-- ...classkiwi_1_1model_1_1_random-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_random.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_random.png | Bin 0 -> 721 bytes ...lasskiwi_1_1model_1_1_receive-members.html | 128 +- docs/html/classkiwi_1_1model_1_1_receive.html | 330 ++++-- ...sskiwi_1_1model_1_1_sah_tilde-members.html | 161 +++ .../classkiwi_1_1model_1_1_sah_tilde.html | 340 ++++++ .../html/classkiwi_1_1model_1_1_sah_tilde.png | Bin 0 -> 728 bytes .../classkiwi_1_1model_1_1_scale-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_scale.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_scale.png | Bin 0 -> 722 bytes ...classkiwi_1_1model_1_1_select-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_select.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_select.png | Bin 0 -> 721 bytes .../classkiwi_1_1model_1_1_send-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_send.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_send.png | Bin 0 -> 718 bytes ...sskiwi_1_1model_1_1_sig_tilde-members.html | 128 +- .../classkiwi_1_1model_1_1_sig_tilde.html | 330 ++++-- ...classkiwi_1_1model_1_1_slider-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_slider.html | 344 ++++++ docs/html/classkiwi_1_1model_1_1_slider.png | Bin 0 -> 721 bytes ...i_1_1model_1_1_snapshot_tilde-members.html | 161 +++ ...classkiwi_1_1model_1_1_snapshot_tilde.html | 340 ++++++ .../classkiwi_1_1model_1_1_snapshot_tilde.png | Bin 0 -> 862 bytes ...classkiwi_1_1model_1_1_switch-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_switch.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_switch.png | Bin 0 -> 728 bytes ...iwi_1_1model_1_1_switch_tilde-members.html | 161 +++ .../classkiwi_1_1model_1_1_switch_tilde.html | 340 ++++++ .../classkiwi_1_1model_1_1_switch_tilde.png | Bin 0 -> 820 bytes .../classkiwi_1_1model_1_1_times-members.html | 130 ++- docs/html/classkiwi_1_1model_1_1_times.html | 344 ++++-- docs/html/classkiwi_1_1model_1_1_times.png | Bin 698 -> 917 bytes ...kiwi_1_1model_1_1_times_tilde-members.html | 130 ++- .../classkiwi_1_1model_1_1_times_tilde.html | 344 ++++-- .../classkiwi_1_1model_1_1_times_tilde.png | Bin 786 -> 1142 bytes ...classkiwi_1_1model_1_1_toggle-members.html | 163 +++ docs/html/classkiwi_1_1model_1_1_toggle.html | 347 ++++++ docs/html/classkiwi_1_1model_1_1_toggle.png | Bin 0 -> 726 bytes ...lasskiwi_1_1model_1_1_trigger-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_trigger.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_trigger.png | Bin 0 -> 733 bytes ...classkiwi_1_1model_1_1_unpack-members.html | 161 +++ docs/html/classkiwi_1_1model_1_1_unpack.html | 340 ++++++ docs/html/classkiwi_1_1model_1_1_unpack.png | Bin 0 -> 726 bytes ...i_1_1network_1_1http_1_1_body-members.html | 110 ++ ...classkiwi_1_1network_1_1http_1_1_body.html | 125 ++ ...etwork_1_1http_1_1_parameters-members.html | 111 ++ ...iwi_1_1network_1_1http_1_1_parameters.html | 134 +++ ..._1network_1_1http_1_1_payload-members.html | 112 ++ ...sskiwi_1_1network_1_1http_1_1_payload.html | 139 +++ ..._1_1network_1_1http_1_1_query-members.html | 113 ++ ...lasskiwi_1_1network_1_1http_1_1_query.html | 229 ++++ ...1network_1_1http_1_1_response-members.html | 108 ++ ...skiwi_1_1network_1_1http_1_1_response.html | 125 ++ ...sskiwi_1_1network_1_1http_1_1_response.png | Bin 0 -> 879 bytes ..._1network_1_1http_1_1_session-members.html | 130 +++ ...sskiwi_1_1network_1_1http_1_1_session.html | 182 +++ ...lasskiwi_1_1server_1_1_server-members.html | 112 ++ docs/html/classkiwi_1_1server_1_1_server.html | 216 ++++ docs/html/classkiwi_1_1server_1_1_server.png | Bin 0 -> 729 bytes ...1server_1_1_server_1_1_logger-members.html | 110 ++ ...skiwi_1_1server_1_1_server_1_1_logger.html | 127 ++ ...server_1_1_server_1_1_session-members.html | 116 ++ ...kiwi_1_1server_1_1_server_1_1_session.html | 269 +++++ .../classkiwi_1_1tool_1_1_atom-members.html | 141 +++ docs/html/classkiwi_1_1tool_1_1_atom.html | 1028 +++++++++++++++++ .../classkiwi_1_1tool_1_1_beacon-members.html | 113 ++ docs/html/classkiwi_1_1tool_1_1_beacon.html | 162 +++ ...1tool_1_1_beacon_1_1_castaway-members.html | 109 ++ ...skiwi_1_1tool_1_1_beacon_1_1_castaway.html | 133 +++ ...sskiwi_1_1tool_1_1_beacon_1_1_castaway.png | Bin 0 -> 694 bytes ..._1tool_1_1_beacon_1_1_factory-members.html | 110 ++ ...sskiwi_1_1tool_1_1_beacon_1_1_factory.html | 134 +++ ...asskiwi_1_1tool_1_1_beacon_1_1_factory.png | Bin 0 -> 668 bytes ...i_1_1tool_1_1_circular_buffer-members.html | 117 ++ ...classkiwi_1_1tool_1_1_circular_buffer.html | 149 +++ ..._1_1tool_1_1_concurrent_queue-members.html | 113 ++ ...lasskiwi_1_1tool_1_1_concurrent_queue.html | 291 +++++ ...asskiwi_1_1tool_1_1_listeners-members.html | 121 ++ .../html/classkiwi_1_1tool_1_1_listeners.html | 304 +++++ .../classkiwi_1_1tool_1_1_matrix-members.html | 117 ++ docs/html/classkiwi_1_1tool_1_1_matrix.html | 298 +++++ ...asskiwi_1_1tool_1_1_parameter-members.html | 115 ++ .../html/classkiwi_1_1tool_1_1_parameter.html | 208 ++++ ...asskiwi_1_1tool_1_1_scheduler-members.html | 123 ++ .../html/classkiwi_1_1tool_1_1_scheduler.html | 439 +++++++ ...l_1_1_scheduler_1_1_call_back-members.html | 112 ++ ...i_1_1tool_1_1_scheduler_1_1_call_back.html | 153 +++ ...wi_1_1tool_1_1_scheduler_1_1_call_back.png | Bin 0 -> 841 bytes ...1tool_1_1_scheduler_1_1_event-members.html | 113 ++ ...skiwi_1_1tool_1_1_scheduler_1_1_event.html | 152 +++ ...1tool_1_1_scheduler_1_1_queue-members.html | 114 ++ ...skiwi_1_1tool_1_1_scheduler_1_1_queue.html | 163 +++ ..._1tool_1_1_scheduler_1_1_task-members.html | 110 ++ ...sskiwi_1_1tool_1_1_scheduler_1_1_task.html | 200 ++++ ...asskiwi_1_1tool_1_1_scheduler_1_1_task.png | Bin 0 -> 1574 bytes ...1tool_1_1_scheduler_1_1_timer-members.html | 111 ++ ...skiwi_1_1tool_1_1_scheduler_1_1_timer.html | 238 ++++ ...sskiwi_1_1tool_1_1_scheduler_1_1_timer.png | Bin 0 -> 1483 bytes ..._scheduler_1_1_timer_1_1_task-members.html | 111 ++ ...tool_1_1_scheduler_1_1_timer_1_1_task.html | 168 +++ ...1tool_1_1_scheduler_1_1_timer_1_1_task.png | Bin 0 -> 874 bytes .../dir_2d5e7e2f87b278ed04b40f15c3112bb4.html | 105 ++ .../dir_2e34f4a47a35755637d0fbb4263328e1.html | 54 +- .../dir_4c0a8d8567be4e932569bc111da90cf3.html | 54 +- .../dir_5075f496c9440eda045d61f24a275d29.html | 54 +- .../dir_5f1d664de9b91ef7031a8dbd2f639110.html | 105 ++ .../dir_6118710b0f789d12950652de74b0b43f.html | 105 ++ .../dir_6b2561cfb5818aa8d74e69e7233c5cf4.html | 105 ++ .../dir_6b9671ab685b5cc0f6f5237b1b62b425.html | 108 ++ .../dir_6d89ecf3c3819a96b23656210de5cf73.html | 57 +- .../dir_748e941d1d38e258f05b9c3c648f2b58.html | 105 ++ .../dir_759fc562c0ca6ee75e96b07025954477.html | 54 +- .../dir_805bb369f87809a94dc97d224c7ebf37.html | 105 ++ .../dir_8a1ab1ee7578188f7fa41649c125c353.html | 57 +- .../dir_8e58523ef7c47011151621d3e9128759.html | 54 +- .../dir_922c588100a187620fdc1533bc178f73.html | 50 +- .../dir_a532b13c1d10b688212f9315062e753c.html | 105 ++ .../dir_ade2beb0702b1b41c2be848c3a926ec2.html | 54 +- .../dir_b246c2914b5ffa4794c798ccb88bcf77.html | 54 +- .../dir_bf7bc16006a33accfcf4dfd969f1372c.html | 54 +- .../dir_c88bb91bae2cc3c847a1f325116b4926.html | 57 +- .../dir_d6938551291504e72153a19ce9826d2b.html | 105 ++ .../dir_e3601b28331a3cecdd3a50c0b81b6ca0.html | 53 +- .../dir_f2541a3b18981391fa76fac5599e978a.html | 50 +- docs/html/doxygen.css | 139 +-- docs/html/examples.html | 96 ++ docs/html/files.html | 377 ++++-- docs/html/functions.html | 153 ++- docs/html/functions_0x7e.html | 200 +++- docs/html/functions_b.html | 101 +- docs/html/functions_c.html | 186 ++- docs/html/functions_d.html | 170 ++- docs/html/functions_e.html | 153 ++- docs/html/functions_enum.html | 72 +- docs/html/functions_eval.html | 64 +- docs/html/functions_f.html | 112 +- docs/html/functions_func.html | 153 ++- docs/html/functions_func_0x7e.html | 200 +++- docs/html/functions_func_b.html | 101 +- docs/html/functions_func_c.html | 183 ++- docs/html/functions_func_d.html | 170 ++- docs/html/functions_func_e.html | 153 ++- docs/html/functions_func_f.html | 103 +- docs/html/functions_func_g.html | 537 ++++++--- docs/html/functions_func_h.html | 141 ++- docs/html/functions_func_i.html | 179 ++- docs/html/functions_func_j.html | 96 +- docs/html/functions_func_l.html | 158 ++- docs/html/functions_func_m.html | 124 +- docs/html/functions_func_n.html | 110 +- docs/html/functions_func_o.html | 163 ++- docs/html/functions_func_p.html | 170 ++- docs/html/functions_func_q.html | 99 +- docs/html/functions_func_r.html | 220 +++- docs/html/functions_func_s.html | 279 +++-- docs/html/functions_func_t.html | 126 +- docs/html/functions_func_u.html | 135 ++- docs/html/functions_func_v.html | 97 +- docs/html/functions_func_w.html | 112 +- docs/html/functions_func_z.html | 96 +- docs/html/functions_g.html | 537 ++++++--- docs/html/functions_h.html | 141 ++- docs/html/functions_i.html | 181 ++- docs/html/functions_j.html | 96 +- docs/html/functions_l.html | 158 ++- docs/html/functions_m.html | 124 +- docs/html/functions_n.html | 112 +- docs/html/functions_o.html | 163 ++- docs/html/functions_p.html | 170 ++- docs/html/functions_q.html | 99 +- docs/html/functions_r.html | 220 +++- docs/html/functions_rela.html | 113 ++ docs/html/functions_s.html | 283 +++-- docs/html/functions_t.html | 129 ++- docs/html/functions_type.html | 73 +- docs/html/functions_u.html | 135 ++- docs/html/functions_v.html | 97 +- docs/html/functions_vars.html | 64 +- docs/html/functions_w.html | 112 +- docs/html/functions_z.html | 96 +- docs/html/hierarchy.html | 638 ++++++---- docs/html/index.html | 45 +- docs/html/jquery.js | 21 +- docs/html/namespacekiwi.html | 592 ++++++++++ docs/html/namespacemembers.html | 353 ++++++ docs/html/namespacemembers_enum.html | 110 ++ docs/html/namespacemembers_eval.html | 331 ++++++ docs/html/namespacemembers_func.html | 110 ++ docs/html/namespaces.html | 103 ++ docs/html/pages.html | 45 +- docs/html/search/all_0.html | 2 +- docs/html/search/all_0.js | 44 +- docs/html/search/all_1.html | 2 +- docs/html/search/all_1.js | 23 +- docs/html/search/all_10.html | 2 +- docs/html/search/all_10.js | 5 +- docs/html/search/all_11.html | 2 +- docs/html/search/all_11.js | 48 +- docs/html/search/all_12.html | 2 +- docs/html/search/all_12.js | 142 ++- docs/html/search/all_13.html | 2 +- docs/html/search/all_13.js | 47 +- docs/html/search/all_14.html | 2 +- docs/html/search/all_14.js | 33 +- docs/html/search/all_15.html | 2 +- docs/html/search/all_15.js | 5 +- docs/html/search/all_16.html | 2 +- docs/html/search/all_16.js | 9 +- docs/html/search/all_17.html | 2 +- docs/html/search/all_17.js | 5 +- docs/html/search/all_18.html | 2 +- docs/html/search/all_18.js | 51 +- docs/html/search/all_2.html | 2 +- docs/html/search/all_2.js | 95 +- docs/html/search/all_3.html | 2 +- docs/html/search/all_3.js | 67 +- docs/html/search/all_4.html | 2 +- docs/html/search/all_4.js | 36 +- docs/html/search/all_5.html | 2 +- docs/html/search/all_5.js | 18 +- docs/html/search/all_6.html | 2 +- docs/html/search/all_6.js | 240 ++-- docs/html/search/all_7.html | 2 +- docs/html/search/all_7.js | 31 +- docs/html/search/all_8.html | 2 +- docs/html/search/all_8.js | 71 +- docs/html/search/all_9.html | 2 +- docs/html/search/all_9.js | 2 +- docs/html/search/all_a.html | 2 +- docs/html/search/all_a.js | 5 +- docs/html/search/all_b.html | 2 +- docs/html/search/all_b.js | 85 +- docs/html/search/all_c.html | 2 +- docs/html/search/all_c.js | 36 +- docs/html/search/all_d.html | 2 +- docs/html/search/all_d.js | 37 +- docs/html/search/all_e.html | 2 +- docs/html/search/all_e.js | 49 +- docs/html/search/all_f.html | 2 +- docs/html/search/all_f.js | 78 +- docs/html/search/classes_0.html | 2 +- docs/html/search/classes_0.js | 13 +- docs/html/search/classes_1.html | 2 +- docs/html/search/classes_1.js | 7 +- docs/html/search/classes_10.html | 2 +- docs/html/search/classes_10.js | 16 +- docs/html/search/classes_11.html | 2 +- docs/html/search/classes_11.js | 37 +- docs/html/search/classes_12.html | 2 +- docs/html/search/classes_12.js | 19 +- docs/html/search/classes_13.html | 2 +- docs/html/search/classes_13.js | 6 +- docs/html/search/classes_14.html | 2 +- docs/html/search/classes_14.js | 3 +- docs/html/search/classes_15.html | 26 + docs/html/search/classes_15.js | 4 + docs/html/search/classes_2.html | 2 +- docs/html/search/classes_2.js | 26 +- docs/html/search/classes_3.html | 2 +- docs/html/search/classes_3.js | 21 +- docs/html/search/classes_4.html | 2 +- docs/html/search/classes_4.js | 13 +- docs/html/search/classes_5.html | 2 +- docs/html/search/classes_5.js | 10 +- docs/html/search/classes_6.html | 2 +- docs/html/search/classes_6.js | 14 +- docs/html/search/classes_7.html | 2 +- docs/html/search/classes_7.js | 12 +- docs/html/search/classes_8.html | 2 +- docs/html/search/classes_8.js | 10 +- docs/html/search/classes_9.html | 2 +- docs/html/search/classes_9.js | 20 +- docs/html/search/classes_a.html | 2 +- docs/html/search/classes_a.js | 41 +- docs/html/search/classes_b.html | 2 +- docs/html/search/classes_b.js | 24 +- docs/html/search/classes_c.html | 2 +- docs/html/search/classes_c.js | 20 +- docs/html/search/classes_d.html | 2 +- docs/html/search/classes_d.js | 32 +- docs/html/search/classes_e.html | 2 +- docs/html/search/classes_e.js | 37 +- docs/html/search/classes_f.html | 2 +- docs/html/search/classes_f.js | 5 +- docs/html/search/enums_0.html | 2 +- docs/html/search/enums_1.html | 2 +- docs/html/search/enums_1.js | 2 +- docs/html/search/enums_2.html | 2 +- docs/html/search/enums_2.js | 3 +- docs/html/search/enums_3.html | 2 +- docs/html/search/enums_3.js | 2 +- docs/html/search/enums_4.html | 26 + docs/html/search/enums_4.js | 5 + docs/html/search/enums_5.html | 26 + docs/html/search/enums_5.js | 4 + docs/html/search/enums_6.html | 26 + docs/html/search/enums_6.js | 4 + docs/html/search/enumvalues_0.html | 2 +- docs/html/search/enumvalues_0.js | 4 +- docs/html/search/enumvalues_1.html | 26 + docs/html/search/enumvalues_1.js | 6 + docs/html/search/enumvalues_2.html | 26 + docs/html/search/enumvalues_2.js | 6 + docs/html/search/enumvalues_3.html | 26 + docs/html/search/enumvalues_3.js | 5 + docs/html/search/enumvalues_4.html | 26 + docs/html/search/enumvalues_4.js | 5 + docs/html/search/enumvalues_5.html | 26 + docs/html/search/enumvalues_5.js | 4 + docs/html/search/enumvalues_6.html | 26 + docs/html/search/enumvalues_6.js | 5 + docs/html/search/enumvalues_7.html | 26 + docs/html/search/enumvalues_7.js | 5 + docs/html/search/enumvalues_8.html | 26 + docs/html/search/enumvalues_8.js | 13 + docs/html/search/enumvalues_9.html | 26 + docs/html/search/enumvalues_9.js | 5 + docs/html/search/enumvalues_a.html | 26 + docs/html/search/enumvalues_a.js | 4 + docs/html/search/enumvalues_b.html | 26 + docs/html/search/enumvalues_b.js | 8 + docs/html/search/enumvalues_c.html | 26 + docs/html/search/enumvalues_c.js | 19 + docs/html/search/enumvalues_d.html | 26 + docs/html/search/enumvalues_d.js | 5 + docs/html/search/enumvalues_e.html | 26 + docs/html/search/enumvalues_e.js | 4 + docs/html/search/enumvalues_f.html | 26 + docs/html/search/enumvalues_f.js | 6 + docs/html/search/functions_0.html | 2 +- docs/html/search/functions_0.js | 24 +- docs/html/search/functions_1.html | 2 +- docs/html/search/functions_1.js | 4 +- docs/html/search/functions_10.html | 2 +- docs/html/search/functions_10.js | 35 +- docs/html/search/functions_11.html | 2 +- docs/html/search/functions_11.js | 133 ++- docs/html/search/functions_12.html | 2 +- docs/html/search/functions_12.js | 96 +- docs/html/search/functions_13.html | 2 +- docs/html/search/functions_13.js | 48 +- docs/html/search/functions_14.html | 2 +- docs/html/search/functions_14.js | 30 +- docs/html/search/functions_15.html | 2 +- docs/html/search/functions_15.js | 7 +- docs/html/search/functions_16.html | 2 +- docs/html/search/functions_16.js | 3 +- docs/html/search/functions_17.html | 2 +- docs/html/search/functions_17.js | 93 +- docs/html/search/functions_2.html | 2 +- docs/html/search/functions_2.js | 44 +- docs/html/search/functions_3.html | 2 +- docs/html/search/functions_3.js | 39 +- docs/html/search/functions_4.html | 2 +- docs/html/search/functions_4.js | 22 +- docs/html/search/functions_5.html | 2 +- docs/html/search/functions_5.js | 6 +- docs/html/search/functions_6.html | 2 +- docs/html/search/functions_6.js | 227 ++-- docs/html/search/functions_7.html | 2 +- docs/html/search/functions_7.js | 23 +- docs/html/search/functions_8.html | 2 +- docs/html/search/functions_8.js | 53 +- docs/html/search/functions_9.html | 2 +- docs/html/search/functions_9.js | 2 +- docs/html/search/functions_a.html | 2 +- docs/html/search/functions_a.js | 27 +- docs/html/search/functions_b.html | 2 +- docs/html/search/functions_b.js | 36 +- docs/html/search/functions_c.html | 2 +- docs/html/search/functions_c.js | 23 +- docs/html/search/functions_d.html | 2 +- docs/html/search/functions_d.js | 34 +- docs/html/search/functions_e.html | 2 +- docs/html/search/functions_e.js | 47 +- docs/html/search/functions_f.html | 2 +- docs/html/search/functions_f.js | 37 +- docs/html/search/namespaces_0.html | 26 + docs/html/search/namespaces_0.js | 4 + docs/html/search/pages_0.html | 2 +- docs/html/search/related_0.html | 26 + docs/html/search/related_0.js | 4 + docs/html/search/search.css | 12 +- docs/html/search/searchdata.js | 44 +- docs/html/search/typedefs_0.html | 2 +- docs/html/search/typedefs_0.js | 2 +- docs/html/search/typedefs_1.html | 2 +- docs/html/search/typedefs_1.js | 2 +- docs/html/search/typedefs_2.html | 2 +- docs/html/search/typedefs_2.js | 2 +- docs/html/search/typedefs_3.html | 2 +- docs/html/search/typedefs_3.js | 4 +- docs/html/search/typedefs_4.html | 2 +- docs/html/search/typedefs_4.js | 4 +- docs/html/search/typedefs_5.html | 2 +- docs/html/search/typedefs_5.js | 3 +- docs/html/search/typedefs_6.html | 26 + docs/html/search/typedefs_6.js | 5 + docs/html/search/variables_0.html | 2 +- docs/html/search/variables_1.html | 2 +- docs/html/search/variables_2.html | 2 +- ...rowser_1_1_drive_1_1_listener-members.html | 55 +- ...cument_browser_1_1_drive_1_1_listener.html | 65 +- ...able_object_view_1_1_listener-members.html | 111 ++ ...1_1_editable_object_view_1_1_listener.html | 139 +++ ..._1_1_editable_object_view_1_1_listener.png | Bin 0 -> 751 bytes ..._kiwi_app_1_1_main_menu_model-members.html | 55 +- ...kiwi_1_1_kiwi_app_1_1_main_menu_model.html | 61 +- ...network_settings_1_1_listener-members.html | 55 +- ...iwi_1_1_network_settings_1_1_listener.html | 63 +- ...kiwi_1_1_network_settings_1_1_listener.png | Bin 772 -> 701 bytes ..._1_1_object_frame_1_1_outline-members.html | 115 ++ ...ructkiwi_1_1_object_frame_1_1_outline.html | 192 +++ ...tructkiwi_1_1_object_frame_1_1_outline.png | Bin 0 -> 602 bytes ..._patcher_manager_1_1_listener-members.html | 55 +- ...kiwi_1_1_patcher_manager_1_1_listener.html | 57 +- docs/html/structkiwi_1_1_spinner-members.html | 110 ++ docs/html/structkiwi_1_1_spinner.html | 128 ++ docs/html/structkiwi_1_1_spinner.png | Bin 0 -> 615 bytes ..._1_1_suggest_list_1_1_options-members.html | 55 +- ...ructkiwi_1_1_suggest_list_1_1_options.html | 63 +- ...sp_1_1_chain_1_1compare__proc-members.html | 55 +- ...iwi_1_1dsp_1_1_chain_1_1compare__proc.html | 63 +- ...1dsp_1_1_chain_1_1index__node-members.html | 55 +- ...tkiwi_1_1dsp_1_1_chain_1_1index__node.html | 63 +- ..._1_processor_1_1_prepare_info-members.html | 55 +- ...1_1dsp_1_1_processor_1_1_prepare_info.html | 61 +- ..._1_1_ramp_1_1_value_time_pair-members.html | 110 ++ ..._1engine_1_1_ramp_1_1_value_time_pair.html | 127 ++ ..._1_factory_1_1is_valid_object-members.html | 56 +- ...1model_1_1_factory_1_1is_valid_object.html | 58 +- ..._1_1_parameters_1_1_parameter-members.html | 110 ++ ..._1_1http_1_1_parameters_1_1_parameter.html | 129 +++ ..._1_1http_1_1_payload_1_1_pair-members.html | 111 ++ ...1network_1_1http_1_1_payload_1_1_pair.html | 132 +++ ...tkiwi_1_1tool_1_1_atom_helper-members.html | 111 ++ .../structkiwi_1_1tool_1_1_atom_helper.html | 179 +++ ...atom_helper_1_1_parsing_flags-members.html | 110 ++ ...ool_1_1_atom_helper_1_1_parsing_flags.html | 118 ++ ..._1_1_listeners_1_1is__valid__listener.html | 115 ++ ...l_1_1_listeners_1_1is__valid__listener.png | Bin 0 -> 1588 bytes ...heduler_1_1_queue_1_1_command-members.html | 109 ++ ...l_1_1_scheduler_1_1_queue_1_1_command.html | 120 ++ docs/html/tabs.css | 61 +- docs/html/todo.html | 67 +- docs/index.html | 48 +- docs/javascript/jquery.min.js | 6 + docs/javascript/markdown.js | 19 + docs/javascript/showdown.min.js | 3 + .../img}/Kiwi-v0.1.0.png | Bin docs/ressources/img/about-kiwi.png | Bin 0 -> 104968 bytes docs/ressources/img/barreDesMenusMacOS.png | Bin 0 -> 18144 bytes docs/ressources/img/document-browser-full.png | Bin 0 -> 158413 bytes docs/ressources/img/dsp_off.png | Bin 0 -> 12813 bytes docs/ressources/img/emptyBeaconDispatcher.png | Bin 0 -> 86134 bytes docs/ressources/img/emptyDocumentBrowser.png | Bin 0 -> 134662 bytes docs/ressources/img/emptyKiwiConsole.png | Bin 0 -> 101818 bytes docs/ressources/img/first-patch.png | Bin 0 -> 317597 bytes .../ressources/img}/kiwi_icon.png | Bin docs/ressources/img/locked.png | Bin 0 -> 6215 bytes docs/ressources/img/loginWindow.png | Bin 0 -> 156361 bytes docs/ressources/img/online-document.png | Bin 0 -> 239765 bytes docs/ressources/img/registerWindow.png | Bin 0 -> 158020 bytes docs/ressources/kiwi_icon.png | Bin 24099 -> 0 bytes docs/ressources/pathces/first-patch.kiwi | Bin 0 -> 32472 bytes docs/ressources/pathces/help/help-adc~.kiwi | Bin 0 -> 5832 bytes docs/ressources/pathces/help/help-dac~.kiwi | Bin 0 -> 22415 bytes .../pathces/help/help-delaysimple~.kiwi | Bin 0 -> 13074 bytes docs/ressources/pathces/help/help-line~.kiwi | Bin 0 -> 6662 bytes docs/ressources/pathces/help/help-noise~.kiwi | Bin 0 -> 16849 bytes docs/ressources/pathces/help/help-osc~.kiwi | Bin 0 -> 15308 bytes docs/ressources/pathces/help/help-pack.kiwi | Bin 0 -> 9229 bytes .../ressources/pathces/help/help-phasor~.kiwi | Bin 0 -> 15789 bytes docs/ressources/pathces/help/help-sah~.kiwi | Bin 0 -> 12059 bytes docs/ressources/pathces/help/help-sig~.kiwi | Bin 0 -> 5754 bytes .../ressources/pathces/help/help-trigger.kiwi | Bin 0 -> 7749 bytes docs/ressources/pathces/help/help.zip | Bin 0 -> 33893 bytes .../ressources/pathces/tutorials/flanger.kiwi | Bin 0 -> 32305 bytes .../pathces/tutorials/fm-synthesis.kiwi | Bin 0 -> 23986 bytes .../tutorials/overlapped-pitchshifter.kiwi | Bin 0 -> 40980 bytes .../tutorials/simple-pitchshifter.kiwi | Bin 0 -> 22163 bytes .../pathces/tutorials/tutorials.zip | Bin 0 -> 24473 bytes docs/software/getting-started.html | 63 + docs/software/getting-started.md | 81 ++ docs/software/objects.html | 63 + docs/software/objects.md | 74 ++ docs/software/tutorials.html | 63 + docs/software/tutorials.md | 10 + docs/software/versions.html | 63 + docs/software/versions.md | 20 +- 1373 files changed, 126063 insertions(+), 14894 deletions(-) create mode 100644 docs/css/font-awesome.min.css create mode 100644 docs/developper/dev.html create mode 100644 docs/fr/developper/dev.html create mode 100644 docs/fr/developper/dev.md create mode 100644 docs/fr/index.html create mode 100644 docs/fr/software/getting-started.html create mode 100644 docs/fr/software/getting-started.md create mode 100644 docs/fr/software/objects.html create mode 100644 docs/fr/software/objects.md create mode 100644 docs/fr/software/tutorials.html create mode 100644 docs/fr/software/tutorials.md create mode 100644 docs/fr/software/versions.html create mode 100644 docs/fr/software/versions.md create mode 100644 docs/html/_kiwi_app___api_controller_8h_source.html create mode 100644 docs/html/_kiwi_app___auth_panel_8h_source.html create mode 100644 docs/html/_kiwi_app___bang_view_8h_source.html create mode 100644 docs/html/_kiwi_app___classic_view_8h_source.html create mode 100644 docs/html/_kiwi_app___comment_view_8h_source.html create mode 100644 docs/html/_kiwi_app___editable_object_view_8h_source.html create mode 100644 docs/html/_kiwi_app___factory_8h_source.html create mode 100644 docs/html/_kiwi_app___form_component_8h_source.html create mode 100644 docs/html/_kiwi_app___message_view_8h_source.html create mode 100644 docs/html/_kiwi_app___meter_tilde_view_8h_source.html create mode 100644 docs/html/_kiwi_app___number_tilde_view_8h_source.html create mode 100644 docs/html/_kiwi_app___number_view_8h_source.html create mode 100644 docs/html/_kiwi_app___number_view_base_8h_source.html create mode 100644 docs/html/_kiwi_app___object_frame_8h_source.html create mode 100644 docs/html/_kiwi_app___objects_8h_source.html create mode 100644 docs/html/_kiwi_app___patcher_view_mouse_handler_8h_source.html create mode 100644 docs/html/_kiwi_app___slider_view_8h_source.html create mode 100644 docs/html/_kiwi_app___toggle_view_8h_source.html create mode 100644 docs/html/_kiwi_engine___adc_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___audio_interface_8h_source.html create mode 100644 docs/html/_kiwi_engine___bang_8h_source.html create mode 100644 docs/html/_kiwi_engine___clip_8h_source.html create mode 100644 docs/html/_kiwi_engine___clip_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___comment_8h_source.html create mode 100644 docs/html/_kiwi_engine___dac_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___delay_8h_source.html create mode 100644 docs/html/_kiwi_engine___delay_simple_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___different_8h_source.html create mode 100644 docs/html/_kiwi_engine___different_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___divide_8h_source.html create mode 100644 docs/html/_kiwi_engine___divide_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___equal_8h_source.html create mode 100644 docs/html/_kiwi_engine___equal_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___error_box_8h_source.html create mode 100644 docs/html/_kiwi_engine___float_8h_source.html create mode 100644 docs/html/_kiwi_engine___gate_8h_source.html create mode 100644 docs/html/_kiwi_engine___gate_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___greater_8h_source.html create mode 100644 docs/html/_kiwi_engine___greater_equal_8h_source.html create mode 100644 docs/html/_kiwi_engine___greater_equal_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___greater_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___hub_8h_source.html create mode 100644 docs/html/_kiwi_engine___less_8h_source.html create mode 100644 docs/html/_kiwi_engine___less_equal_8h_source.html create mode 100644 docs/html/_kiwi_engine___less_equal_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___less_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___line_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___loadmess_8h_source.html create mode 100644 docs/html/_kiwi_engine___message_8h_source.html create mode 100644 docs/html/_kiwi_engine___meter_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___metro_8h_source.html create mode 100644 docs/html/_kiwi_engine___minus_8h_source.html create mode 100644 docs/html/_kiwi_engine___minus_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___modulo_8h_source.html create mode 100644 docs/html/_kiwi_engine___mtof_8h_source.html create mode 100644 docs/html/_kiwi_engine___new_box_8h_source.html create mode 100644 docs/html/_kiwi_engine___noise_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___number_8h_source.html create mode 100644 docs/html/_kiwi_engine___number_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___operator_8h_source.html create mode 100644 docs/html/_kiwi_engine___operator_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___osc_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___pack_8h_source.html create mode 100644 docs/html/_kiwi_engine___phasor_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___pipe_8h_source.html create mode 100644 docs/html/_kiwi_engine___plus_8h_source.html create mode 100644 docs/html/_kiwi_engine___plus_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___pow_8h_source.html create mode 100644 docs/html/_kiwi_engine___print_8h_source.html create mode 100644 docs/html/_kiwi_engine___random_8h_source.html create mode 100644 docs/html/_kiwi_engine___receive_8h_source.html create mode 100644 docs/html/_kiwi_engine___sah_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___scale_8h_source.html create mode 100644 docs/html/_kiwi_engine___select_8h_source.html create mode 100644 docs/html/_kiwi_engine___send_8h_source.html create mode 100644 docs/html/_kiwi_engine___sig_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___slider_8h_source.html create mode 100644 docs/html/_kiwi_engine___snapshot_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___switch_8h_source.html create mode 100644 docs/html/_kiwi_engine___switch_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___times_8h_source.html create mode 100644 docs/html/_kiwi_engine___times_tilde_8h_source.html create mode 100644 docs/html/_kiwi_engine___toggle_8h_source.html create mode 100644 docs/html/_kiwi_engine___trigger_8h_source.html create mode 100644 docs/html/_kiwi_engine___unpack_8h_source.html create mode 100644 docs/html/_kiwi_http_8h_source.html create mode 100644 docs/html/_kiwi_http_8hpp_source.html create mode 100644 docs/html/_kiwi_http___session_8h_source.html create mode 100644 docs/html/_kiwi_http___session_8hpp_source.html create mode 100644 docs/html/_kiwi_http___util_8h_source.html create mode 100644 docs/html/_kiwi_model___adc_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___bang_8h_source.html create mode 100644 docs/html/_kiwi_model___clip_8h_source.html create mode 100644 docs/html/_kiwi_model___clip_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___comment_8h_source.html create mode 100644 docs/html/_kiwi_model___converter_8h_source.html create mode 100644 docs/html/_kiwi_model___dac_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___delay_8h_source.html create mode 100644 docs/html/_kiwi_model___delay_simple_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___different_8h_source.html create mode 100644 docs/html/_kiwi_model___different_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___divide_8h_source.html create mode 100644 docs/html/_kiwi_model___divide_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___document_manager_8h_source.html create mode 100644 docs/html/_kiwi_model___equal_8h_source.html create mode 100644 docs/html/_kiwi_model___equal_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___error_8h_source.html create mode 100644 docs/html/_kiwi_model___error_box_8h_source.html create mode 100644 docs/html/_kiwi_model___float_8h_source.html create mode 100644 docs/html/_kiwi_model___gate_8h_source.html create mode 100644 docs/html/_kiwi_model___gate_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___greater_8h_source.html create mode 100644 docs/html/_kiwi_model___greater_equal_8h_source.html create mode 100644 docs/html/_kiwi_model___greater_equal_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___greater_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___hub_8h_source.html create mode 100644 docs/html/_kiwi_model___less_8h_source.html create mode 100644 docs/html/_kiwi_model___less_equal_8h_source.html create mode 100644 docs/html/_kiwi_model___less_equal_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___less_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___line_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___loadmess_8h_source.html create mode 100644 docs/html/_kiwi_model___message_8h_source.html create mode 100644 docs/html/_kiwi_model___meter_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___metro_8h_source.html create mode 100644 docs/html/_kiwi_model___minus_8h_source.html create mode 100644 docs/html/_kiwi_model___minus_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___modulo_8h_source.html create mode 100644 docs/html/_kiwi_model___mtof_8h_source.html create mode 100644 docs/html/_kiwi_model___new_box_8h_source.html create mode 100644 docs/html/_kiwi_model___noise_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___number_8h_source.html create mode 100644 docs/html/_kiwi_model___number_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___object_class_8h_source.html create mode 100644 docs/html/_kiwi_model___operator_8h_source.html create mode 100644 docs/html/_kiwi_model___operator_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___osc_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___pack_8h_source.html create mode 100644 docs/html/_kiwi_model___phasor_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___pipe_8h_source.html create mode 100644 docs/html/_kiwi_model___plus_8h_source.html create mode 100644 docs/html/_kiwi_model___plus_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___pow_8h_source.html create mode 100644 docs/html/_kiwi_model___print_8h_source.html create mode 100644 docs/html/_kiwi_model___random_8h_source.html create mode 100644 docs/html/_kiwi_model___receive_8h_source.html create mode 100644 docs/html/_kiwi_model___sah_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___scale_8h_source.html create mode 100644 docs/html/_kiwi_model___select_8h_source.html create mode 100644 docs/html/_kiwi_model___send_8h_source.html create mode 100644 docs/html/_kiwi_model___sig_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___slider_8h_source.html create mode 100644 docs/html/_kiwi_model___snapshot_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___switch_8h_source.html create mode 100644 docs/html/_kiwi_model___switch_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___times_8h_source.html create mode 100644 docs/html/_kiwi_model___times_tilde_8h_source.html create mode 100644 docs/html/_kiwi_model___toggle_8h_source.html create mode 100644 docs/html/_kiwi_model___trigger_8h_source.html create mode 100644 docs/html/_kiwi_model___unpack_8h_source.html create mode 100644 docs/html/_kiwi_network___http_8h_source.html create mode 100644 docs/html/_kiwi_server___server_8h_source.html create mode 100644 docs/html/_kiwi_tool___atom_8h_source.html create mode 100644 docs/html/_kiwi_tool___beacon_8h_source.html create mode 100644 docs/html/_kiwi_tool___circular_buffer_8h_source.html create mode 100644 docs/html/_kiwi_tool___concurrent_queue_8h_source.html create mode 100644 docs/html/_kiwi_tool___listeners_8h_source.html create mode 100644 docs/html/_kiwi_tool___matrix_8h_source.html create mode 100644 docs/html/_kiwi_tool___matrix_8hpp_source.html create mode 100644 docs/html/_kiwi_tool___parameter_8h_source.html create mode 100644 docs/html/_kiwi_tool___scheduler_8h_source.html create mode 100644 docs/html/_kiwi_tool___scheduler_8hpp_source.html create mode 100644 docs/html/_the-example.html create mode 100644 docs/html/arrowdown.png create mode 100644 docs/html/arrowright.png create mode 100644 docs/html/classkiwi_1_1_alert_box-members.html create mode 100644 docs/html/classkiwi_1_1_alert_box.html create mode 100644 docs/html/classkiwi_1_1_alert_box.png create mode 100644 docs/html/classkiwi_1_1_api_1_1_auth_user-members.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_auth_user.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_auth_user.png create mode 100644 docs/html/classkiwi_1_1_api_1_1_controller-members.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_controller.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_controller.png create mode 100644 docs/html/classkiwi_1_1_api_1_1_document-members.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_document.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_error-members.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_error.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_user-members.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_user.html create mode 100644 docs/html/classkiwi_1_1_api_1_1_user.png create mode 100644 docs/html/classkiwi_1_1_api_controller-members.html create mode 100644 docs/html/classkiwi_1_1_api_controller.html create mode 100644 docs/html/classkiwi_1_1_api_controller.png create mode 100644 docs/html/classkiwi_1_1_auth_panel-members.html create mode 100644 docs/html/classkiwi_1_1_auth_panel.html create mode 100644 docs/html/classkiwi_1_1_auth_panel.png create mode 100644 docs/html/classkiwi_1_1_bang_view-members.html create mode 100644 docs/html/classkiwi_1_1_bang_view.html create mode 100644 docs/html/classkiwi_1_1_bang_view.png create mode 100644 docs/html/classkiwi_1_1_classic_view-members.html create mode 100644 docs/html/classkiwi_1_1_classic_view.html create mode 100644 docs/html/classkiwi_1_1_classic_view.png create mode 100644 docs/html/classkiwi_1_1_comment_view-members.html create mode 100644 docs/html/classkiwi_1_1_comment_view.html create mode 100644 docs/html/classkiwi_1_1_comment_view.png create mode 100644 docs/html/classkiwi_1_1_editable_object_view-members.html create mode 100644 docs/html/classkiwi_1_1_editable_object_view.html create mode 100644 docs/html/classkiwi_1_1_editable_object_view.png create mode 100644 docs/html/classkiwi_1_1_factory-members.html create mode 100644 docs/html/classkiwi_1_1_factory.html create mode 100644 docs/html/classkiwi_1_1_form_component-members.html create mode 100644 docs/html/classkiwi_1_1_form_component.html create mode 100644 docs/html/classkiwi_1_1_form_component.png create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field-members.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field.png create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_kiwi_logo-members.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_kiwi_logo.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_kiwi_logo.png create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password-members.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password.png create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_single_line_text-members.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_single_line_text.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_single_line_text.png create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_text_button-members.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_text_button.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_text_button.png create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button-members.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button.png create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_overlay_comp-members.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_overlay_comp.html create mode 100644 docs/html/classkiwi_1_1_form_component_1_1_overlay_comp.png create mode 100644 docs/html/classkiwi_1_1_instance.png create mode 100644 docs/html/classkiwi_1_1_login_form-members.html create mode 100644 docs/html/classkiwi_1_1_login_form.html create mode 100644 docs/html/classkiwi_1_1_login_form.png create mode 100644 docs/html/classkiwi_1_1_message_view-members.html create mode 100644 docs/html/classkiwi_1_1_message_view.html create mode 100644 docs/html/classkiwi_1_1_message_view.png create mode 100644 docs/html/classkiwi_1_1_meter_tilde_view-members.html create mode 100644 docs/html/classkiwi_1_1_meter_tilde_view.html create mode 100644 docs/html/classkiwi_1_1_meter_tilde_view.png create mode 100644 docs/html/classkiwi_1_1_mouse_handler-members.html create mode 100644 docs/html/classkiwi_1_1_mouse_handler.html create mode 100644 docs/html/classkiwi_1_1_number_tilde_view-members.html create mode 100644 docs/html/classkiwi_1_1_number_tilde_view.html create mode 100644 docs/html/classkiwi_1_1_number_tilde_view.png create mode 100644 docs/html/classkiwi_1_1_number_view-members.html create mode 100644 docs/html/classkiwi_1_1_number_view.html create mode 100644 docs/html/classkiwi_1_1_number_view.png create mode 100644 docs/html/classkiwi_1_1_number_view_base-members.html create mode 100644 docs/html/classkiwi_1_1_number_view_base.html create mode 100644 docs/html/classkiwi_1_1_number_view_base.png create mode 100644 docs/html/classkiwi_1_1_object_frame-members.html create mode 100644 docs/html/classkiwi_1_1_object_frame.html create mode 100644 docs/html/classkiwi_1_1_object_frame.png create mode 100644 docs/html/classkiwi_1_1_sign_up_form-members.html create mode 100644 docs/html/classkiwi_1_1_sign_up_form.html create mode 100644 docs/html/classkiwi_1_1_sign_up_form.png create mode 100644 docs/html/classkiwi_1_1_slider_view-members.html create mode 100644 docs/html/classkiwi_1_1_slider_view.html create mode 100644 docs/html/classkiwi_1_1_slider_view.png create mode 100644 docs/html/classkiwi_1_1_toggle_view-members.html create mode 100644 docs/html/classkiwi_1_1_toggle_view.html create mode 100644 docs/html/classkiwi_1_1_toggle_view.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_bang-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_bang.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_bang.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_clip-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_clip.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_clip.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_clip_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_clip_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_clip_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_comment-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_comment.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_comment.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_different-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_different.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_different.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_different_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_different_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_different_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_divide-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_divide.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_divide.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_divide_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_divide_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_divide_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_equal-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_equal.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_equal.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_equal_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_equal_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_equal_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_float-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_float.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_float.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_gate-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_gate.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_gate.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_gate_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_gate_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_gate_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_equal-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_equal.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_equal.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_greater_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_hub-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_hub.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_hub.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_less-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_less.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_less.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_equal-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_equal.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_equal.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_equal_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_equal_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_equal_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_less_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_line_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_line_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_line_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_message-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_message.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_message.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_meter_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_meter_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_meter_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_minus-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_minus.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_minus.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_minus_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_minus_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_minus_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_modulo-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_modulo.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_modulo.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_mtof-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_mtof.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_mtof.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_noise_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_noise_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_noise_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_number-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_number.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_number.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_number_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_number_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_number_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_operator-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_operator.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_operator.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_operator_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_operator_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_operator_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_pack-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_pack.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_pack.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_phasor_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_phasor_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_phasor_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_pow-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_pow.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_pow.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_ramp-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_ramp.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_random-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_random.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_random.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_sah_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_sah_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_sah_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_scale-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_scale.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_scale.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_select-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_select.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_select.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_send-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_send.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_send.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_slider-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_slider.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_slider.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_snapshot_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_snapshot_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_snapshot_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_switch-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_switch.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_switch.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_switch_tilde-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_switch_tilde.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_switch_tilde.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_toggle-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_toggle.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_toggle.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_trigger-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_trigger.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_trigger.png create mode 100644 docs/html/classkiwi_1_1engine_1_1_unpack-members.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_unpack.html create mode 100644 docs/html/classkiwi_1_1engine_1_1_unpack.png create mode 100644 docs/html/classkiwi_1_1model_1_1_bang-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_bang.html create mode 100644 docs/html/classkiwi_1_1model_1_1_bang.png create mode 100644 docs/html/classkiwi_1_1model_1_1_clip-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_clip.html create mode 100644 docs/html/classkiwi_1_1model_1_1_clip.png create mode 100644 docs/html/classkiwi_1_1model_1_1_clip_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_clip_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_clip_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_comment-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_comment.html create mode 100644 docs/html/classkiwi_1_1model_1_1_comment.png create mode 100644 docs/html/classkiwi_1_1model_1_1_converter-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_converter.html create mode 100644 docs/html/classkiwi_1_1model_1_1_different-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_different.html create mode 100644 docs/html/classkiwi_1_1model_1_1_different.png create mode 100644 docs/html/classkiwi_1_1model_1_1_different_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_different_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_different_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_divide-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_divide.html create mode 100644 docs/html/classkiwi_1_1model_1_1_divide.png create mode 100644 docs/html/classkiwi_1_1model_1_1_divide_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_divide_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_divide_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_document_manager-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_document_manager.html create mode 100644 docs/html/classkiwi_1_1model_1_1_equal-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_equal.html create mode 100644 docs/html/classkiwi_1_1model_1_1_equal.png create mode 100644 docs/html/classkiwi_1_1model_1_1_equal_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_equal_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_equal_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_error-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_error.html create mode 100644 docs/html/classkiwi_1_1model_1_1_error.png create mode 100644 docs/html/classkiwi_1_1model_1_1_float-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_float.html create mode 100644 docs/html/classkiwi_1_1model_1_1_float.png create mode 100644 docs/html/classkiwi_1_1model_1_1_gate-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_gate.html create mode 100644 docs/html/classkiwi_1_1model_1_1_gate.png create mode 100644 docs/html/classkiwi_1_1model_1_1_gate_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_gate_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_gate_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_greater-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_greater.html create mode 100644 docs/html/classkiwi_1_1model_1_1_greater.png create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_equal-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_equal.html create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_equal.png create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_equal_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_equal_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_equal_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_greater_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_hub-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_hub.html create mode 100644 docs/html/classkiwi_1_1model_1_1_hub.png create mode 100644 docs/html/classkiwi_1_1model_1_1_less-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_less.html create mode 100644 docs/html/classkiwi_1_1model_1_1_less.png create mode 100644 docs/html/classkiwi_1_1model_1_1_less_equal-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_less_equal.html create mode 100644 docs/html/classkiwi_1_1model_1_1_less_equal.png create mode 100644 docs/html/classkiwi_1_1model_1_1_less_equal_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_less_equal_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_less_equal_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_less_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_less_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_less_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_line_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_line_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_line_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_message-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_message.html create mode 100644 docs/html/classkiwi_1_1model_1_1_message.png create mode 100644 docs/html/classkiwi_1_1model_1_1_meter_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_meter_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_meter_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_minus-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_minus.html create mode 100644 docs/html/classkiwi_1_1model_1_1_minus.png create mode 100644 docs/html/classkiwi_1_1model_1_1_minus_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_minus_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_minus_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_modulo-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_modulo.html create mode 100644 docs/html/classkiwi_1_1model_1_1_modulo.png create mode 100644 docs/html/classkiwi_1_1model_1_1_mtof-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_mtof.html create mode 100644 docs/html/classkiwi_1_1model_1_1_mtof.png create mode 100644 docs/html/classkiwi_1_1model_1_1_noise_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_noise_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_noise_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_number-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_number.html create mode 100644 docs/html/classkiwi_1_1model_1_1_number.png create mode 100644 docs/html/classkiwi_1_1model_1_1_number_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_number_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_number_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_object_1_1_error-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_object_1_1_error.html create mode 100644 docs/html/classkiwi_1_1model_1_1_object_1_1_error.png create mode 100644 docs/html/classkiwi_1_1model_1_1_object_1_1_listener-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_object_1_1_listener.html create mode 100644 docs/html/classkiwi_1_1model_1_1_object_1_1_listener.png create mode 100644 docs/html/classkiwi_1_1model_1_1_object_class-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_object_class.html create mode 100644 docs/html/classkiwi_1_1model_1_1_operator-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_operator.html create mode 100644 docs/html/classkiwi_1_1model_1_1_operator.png create mode 100644 docs/html/classkiwi_1_1model_1_1_operator_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_operator_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_operator_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_pack-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_pack.html create mode 100644 docs/html/classkiwi_1_1model_1_1_pack.png create mode 100644 docs/html/classkiwi_1_1model_1_1_parameter_class-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_parameter_class.html create mode 100644 docs/html/classkiwi_1_1model_1_1_phasor_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_phasor_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_phasor_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_pow-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_pow.html create mode 100644 docs/html/classkiwi_1_1model_1_1_pow.png create mode 100644 docs/html/classkiwi_1_1model_1_1_random-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_random.html create mode 100644 docs/html/classkiwi_1_1model_1_1_random.png create mode 100644 docs/html/classkiwi_1_1model_1_1_sah_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_sah_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_sah_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_scale-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_scale.html create mode 100644 docs/html/classkiwi_1_1model_1_1_scale.png create mode 100644 docs/html/classkiwi_1_1model_1_1_select-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_select.html create mode 100644 docs/html/classkiwi_1_1model_1_1_select.png create mode 100644 docs/html/classkiwi_1_1model_1_1_send-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_send.html create mode 100644 docs/html/classkiwi_1_1model_1_1_send.png create mode 100644 docs/html/classkiwi_1_1model_1_1_slider-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_slider.html create mode 100644 docs/html/classkiwi_1_1model_1_1_slider.png create mode 100644 docs/html/classkiwi_1_1model_1_1_snapshot_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_snapshot_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_snapshot_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_switch-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_switch.html create mode 100644 docs/html/classkiwi_1_1model_1_1_switch.png create mode 100644 docs/html/classkiwi_1_1model_1_1_switch_tilde-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_switch_tilde.html create mode 100644 docs/html/classkiwi_1_1model_1_1_switch_tilde.png create mode 100644 docs/html/classkiwi_1_1model_1_1_toggle-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_toggle.html create mode 100644 docs/html/classkiwi_1_1model_1_1_toggle.png create mode 100644 docs/html/classkiwi_1_1model_1_1_trigger-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_trigger.html create mode 100644 docs/html/classkiwi_1_1model_1_1_trigger.png create mode 100644 docs/html/classkiwi_1_1model_1_1_unpack-members.html create mode 100644 docs/html/classkiwi_1_1model_1_1_unpack.html create mode 100644 docs/html/classkiwi_1_1model_1_1_unpack.png create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_body-members.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_body.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_parameters-members.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_parameters.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_payload-members.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_payload.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_query-members.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_query.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_response-members.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_response.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_response.png create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_session-members.html create mode 100644 docs/html/classkiwi_1_1network_1_1http_1_1_session.html create mode 100644 docs/html/classkiwi_1_1server_1_1_server-members.html create mode 100644 docs/html/classkiwi_1_1server_1_1_server.html create mode 100644 docs/html/classkiwi_1_1server_1_1_server.png create mode 100644 docs/html/classkiwi_1_1server_1_1_server_1_1_logger-members.html create mode 100644 docs/html/classkiwi_1_1server_1_1_server_1_1_logger.html create mode 100644 docs/html/classkiwi_1_1server_1_1_server_1_1_session-members.html create mode 100644 docs/html/classkiwi_1_1server_1_1_server_1_1_session.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_atom-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_atom.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_beacon-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_beacon.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway.png create mode 100644 docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory.png create mode 100644 docs/html/classkiwi_1_1tool_1_1_circular_buffer-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_circular_buffer.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_concurrent_queue-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_concurrent_queue.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_listeners-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_listeners.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_matrix-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_matrix.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_parameter-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_parameter.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back.png create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_event-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_event.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_queue-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_queue.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task.png create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer.png create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task-members.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task.html create mode 100644 docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task.png create mode 100644 docs/html/dir_2d5e7e2f87b278ed04b40f15c3112bb4.html create mode 100644 docs/html/dir_5f1d664de9b91ef7031a8dbd2f639110.html create mode 100644 docs/html/dir_6118710b0f789d12950652de74b0b43f.html create mode 100644 docs/html/dir_6b2561cfb5818aa8d74e69e7233c5cf4.html create mode 100644 docs/html/dir_6b9671ab685b5cc0f6f5237b1b62b425.html create mode 100644 docs/html/dir_748e941d1d38e258f05b9c3c648f2b58.html create mode 100644 docs/html/dir_805bb369f87809a94dc97d224c7ebf37.html create mode 100644 docs/html/dir_a532b13c1d10b688212f9315062e753c.html create mode 100644 docs/html/dir_d6938551291504e72153a19ce9826d2b.html create mode 100644 docs/html/examples.html create mode 100644 docs/html/functions_rela.html create mode 100644 docs/html/namespacekiwi.html create mode 100644 docs/html/namespacemembers.html create mode 100644 docs/html/namespacemembers_enum.html create mode 100644 docs/html/namespacemembers_eval.html create mode 100644 docs/html/namespacemembers_func.html create mode 100644 docs/html/namespaces.html create mode 100644 docs/html/search/classes_15.html create mode 100644 docs/html/search/classes_15.js create mode 100644 docs/html/search/enums_4.html create mode 100644 docs/html/search/enums_4.js create mode 100644 docs/html/search/enums_5.html create mode 100644 docs/html/search/enums_5.js create mode 100644 docs/html/search/enums_6.html create mode 100644 docs/html/search/enums_6.js create mode 100644 docs/html/search/enumvalues_1.html create mode 100644 docs/html/search/enumvalues_1.js create mode 100644 docs/html/search/enumvalues_2.html create mode 100644 docs/html/search/enumvalues_2.js create mode 100644 docs/html/search/enumvalues_3.html create mode 100644 docs/html/search/enumvalues_3.js create mode 100644 docs/html/search/enumvalues_4.html create mode 100644 docs/html/search/enumvalues_4.js create mode 100644 docs/html/search/enumvalues_5.html create mode 100644 docs/html/search/enumvalues_5.js create mode 100644 docs/html/search/enumvalues_6.html create mode 100644 docs/html/search/enumvalues_6.js create mode 100644 docs/html/search/enumvalues_7.html create mode 100644 docs/html/search/enumvalues_7.js create mode 100644 docs/html/search/enumvalues_8.html create mode 100644 docs/html/search/enumvalues_8.js create mode 100644 docs/html/search/enumvalues_9.html create mode 100644 docs/html/search/enumvalues_9.js create mode 100644 docs/html/search/enumvalues_a.html create mode 100644 docs/html/search/enumvalues_a.js create mode 100644 docs/html/search/enumvalues_b.html create mode 100644 docs/html/search/enumvalues_b.js create mode 100644 docs/html/search/enumvalues_c.html create mode 100644 docs/html/search/enumvalues_c.js create mode 100644 docs/html/search/enumvalues_d.html create mode 100644 docs/html/search/enumvalues_d.js create mode 100644 docs/html/search/enumvalues_e.html create mode 100644 docs/html/search/enumvalues_e.js create mode 100644 docs/html/search/enumvalues_f.html create mode 100644 docs/html/search/enumvalues_f.js create mode 100644 docs/html/search/namespaces_0.html create mode 100644 docs/html/search/namespaces_0.js create mode 100644 docs/html/search/related_0.html create mode 100644 docs/html/search/related_0.js create mode 100644 docs/html/search/typedefs_6.html create mode 100644 docs/html/search/typedefs_6.js create mode 100644 docs/html/structkiwi_1_1_editable_object_view_1_1_listener-members.html create mode 100644 docs/html/structkiwi_1_1_editable_object_view_1_1_listener.html create mode 100644 docs/html/structkiwi_1_1_editable_object_view_1_1_listener.png create mode 100644 docs/html/structkiwi_1_1_object_frame_1_1_outline-members.html create mode 100644 docs/html/structkiwi_1_1_object_frame_1_1_outline.html create mode 100644 docs/html/structkiwi_1_1_object_frame_1_1_outline.png create mode 100644 docs/html/structkiwi_1_1_spinner-members.html create mode 100644 docs/html/structkiwi_1_1_spinner.html create mode 100644 docs/html/structkiwi_1_1_spinner.png create mode 100644 docs/html/structkiwi_1_1engine_1_1_ramp_1_1_value_time_pair-members.html create mode 100644 docs/html/structkiwi_1_1engine_1_1_ramp_1_1_value_time_pair.html create mode 100644 docs/html/structkiwi_1_1network_1_1http_1_1_parameters_1_1_parameter-members.html create mode 100644 docs/html/structkiwi_1_1network_1_1http_1_1_parameters_1_1_parameter.html create mode 100644 docs/html/structkiwi_1_1network_1_1http_1_1_payload_1_1_pair-members.html create mode 100644 docs/html/structkiwi_1_1network_1_1http_1_1_payload_1_1_pair.html create mode 100644 docs/html/structkiwi_1_1tool_1_1_atom_helper-members.html create mode 100644 docs/html/structkiwi_1_1tool_1_1_atom_helper.html create mode 100644 docs/html/structkiwi_1_1tool_1_1_atom_helper_1_1_parsing_flags-members.html create mode 100644 docs/html/structkiwi_1_1tool_1_1_atom_helper_1_1_parsing_flags.html create mode 100644 docs/html/structkiwi_1_1tool_1_1_listeners_1_1is__valid__listener.html create mode 100644 docs/html/structkiwi_1_1tool_1_1_listeners_1_1is__valid__listener.png create mode 100644 docs/html/structkiwi_1_1tool_1_1_scheduler_1_1_queue_1_1_command-members.html create mode 100644 docs/html/structkiwi_1_1tool_1_1_scheduler_1_1_queue_1_1_command.html create mode 100644 docs/javascript/jquery.min.js create mode 100644 docs/javascript/markdown.js create mode 100644 docs/javascript/showdown.min.js rename docs/{Ressources => ressources/img}/Kiwi-v0.1.0.png (100%) create mode 100644 docs/ressources/img/about-kiwi.png create mode 100755 docs/ressources/img/barreDesMenusMacOS.png create mode 100644 docs/ressources/img/document-browser-full.png create mode 100644 docs/ressources/img/dsp_off.png create mode 100755 docs/ressources/img/emptyBeaconDispatcher.png create mode 100755 docs/ressources/img/emptyDocumentBrowser.png create mode 100755 docs/ressources/img/emptyKiwiConsole.png create mode 100644 docs/ressources/img/first-patch.png rename {Scripts => docs/ressources/img}/kiwi_icon.png (100%) create mode 100644 docs/ressources/img/locked.png create mode 100755 docs/ressources/img/loginWindow.png create mode 100644 docs/ressources/img/online-document.png create mode 100755 docs/ressources/img/registerWindow.png delete mode 100644 docs/ressources/kiwi_icon.png create mode 100644 docs/ressources/pathces/first-patch.kiwi create mode 100755 docs/ressources/pathces/help/help-adc~.kiwi create mode 100755 docs/ressources/pathces/help/help-dac~.kiwi create mode 100755 docs/ressources/pathces/help/help-delaysimple~.kiwi create mode 100755 docs/ressources/pathces/help/help-line~.kiwi create mode 100755 docs/ressources/pathces/help/help-noise~.kiwi create mode 100755 docs/ressources/pathces/help/help-osc~.kiwi create mode 100755 docs/ressources/pathces/help/help-pack.kiwi create mode 100755 docs/ressources/pathces/help/help-phasor~.kiwi create mode 100755 docs/ressources/pathces/help/help-sah~.kiwi create mode 100755 docs/ressources/pathces/help/help-sig~.kiwi create mode 100755 docs/ressources/pathces/help/help-trigger.kiwi create mode 100644 docs/ressources/pathces/help/help.zip create mode 100755 docs/ressources/pathces/tutorials/flanger.kiwi create mode 100755 docs/ressources/pathces/tutorials/fm-synthesis.kiwi create mode 100755 docs/ressources/pathces/tutorials/overlapped-pitchshifter.kiwi create mode 100755 docs/ressources/pathces/tutorials/simple-pitchshifter.kiwi create mode 100644 docs/ressources/pathces/tutorials/tutorials.zip create mode 100644 docs/software/getting-started.html create mode 100644 docs/software/getting-started.md create mode 100644 docs/software/objects.html create mode 100644 docs/software/objects.md create mode 100644 docs/software/tutorials.html create mode 100644 docs/software/tutorials.md create mode 100644 docs/software/versions.html diff --git a/README.md b/README.md index da9b6631..23603ec2 100644 --- a/README.md +++ b/README.md @@ -9,42 +9,26 @@ It enables several creators to work simultaneously on a same patch hosted online [![Build Status](https://travis-ci.org/Musicoll/Kiwi.svg?branch=master)](https://travis-ci.org/Musicoll/Kiwi) [![Build status](https://ci.appveyor.com/api/projects/status/github/Musicoll/Kiwi?branch=master&svg=true)](https://ci.appveyor.com/project/CICM/kiwi) -[![Coverage Status](https://coveralls.io/repos/github/Musicoll/Kiwi/badge.svg?branch=master)](https://coveralls.io/github/Musicoll/Kiwi?branch=master) [![Documentation](https://img.shields.io/badge/docs-doxygen-blue.svg)](http://musicoll.github.io/Kiwi/html) [![Release](https://img.shields.io/github/release/Musicoll/Kiwi.svg)](https://github.com/Musicoll/Kiwi/releases) [![license](https://img.shields.io/github/license/Musicoll/Kiwi.svg?maxAge=2592000)](https://github.com/Musicoll/Kiwi/blob/master/Licence.md) [![Website](https://img.shields.io/website/http/shields.io.svg?maxAge=2592000)](http://musicoll.mshparisnord.org) + [![Documentation](https://img.shields.io/badge/docs-doxygen-blue.svg)](http://musicoll.github.io/Kiwi/html) [![Release](https://img.shields.io/github/release/Musicoll/Kiwi.svg)](https://github.com/Musicoll/Kiwi/releases) [![license](https://img.shields.io/github/license/Musicoll/Kiwi.svg?maxAge=2592000)](https://github.com/Musicoll/Kiwi/blob/master/Licence.md) [![Website](https://img.shields.io/website/http/shields.io.svg?maxAge=2592000)](http://kiwi.mshparisnord.fr/) > Warning: Kiwi is in a heavy development stage and everything is subject to change without notice. -You can take a look at the version changelog [here](https://github.com/Musicoll/Kiwi/wiki/Changelog). - ### Download If you want to test Kiwi, you can download a version on the [Release Page](https://github.com/Musicoll/Kiwi/releases). -### Build from sources - -You can also build Kiwi from sources. - -Kiwi scripts and build system uses python (v2.7 or higher) and cmake (v2.8.7 or higher). To build Kiwi from source: - -- clone this repository: - -```shell -$ git clone --recursive https://github.com/Musicoll/Kiwi.git -``` - -- Read these instructions to install dependencies for [Mac](https://github.com/Musicoll/Kiwi/wiki/Installation-%28Mac%29), [Windows](https://github.com/Musicoll/Kiwi/wiki/Installation-%28Windows%29) or [Linux](https://github.com/Musicoll/Kiwi/wiki/Installation-%28Linux%29) -- You should then be able to [compile Kiwi](). - -### Objects +### Documentation -A list of the kiwi objects can be found [here](https://github.com/Musicoll/Kiwi/wiki/List-of-Objects). +Kiwi's documentation can be found [here](http://musicoll.github.io/Kiwi/html). Kiwi's documentation includes: +- A start up guide for users +- The documentation for all objects +- Audio processing tutorials +- A developer guide for contributors ### Roadmap -- [ ] Authentication System. -- [ ] Private space. -- [ ] GUI Objects. -- [ ] Sub-Patchers. -- [ ] Add more objects. +- [ ] Integrate [faust](http://faust.grame.fr/) audio programming language +- [ ] Improve network security --- diff --git a/docs/css/font-awesome.min.css b/docs/css/font-awesome.min.css new file mode 100644 index 00000000..540440ce --- /dev/null +++ b/docs/css/font-awesome.min.css @@ -0,0 +1,4 @@ +/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url('../fonts/fontawesome-webfont.eot?v=4.7.0');src:url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'),url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'),url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'),url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'),url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg');font-weight:normal;font-style:normal}.fa{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571429em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14285714em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14285714em;width:2.14285714em;top:.14285714em;text-align:center}.fa-li.fa-lg{left:-1.85714286em}.fa-border{padding:.2em .25em .15em;border:solid .08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left{margin-right:.3em}.fa.fa-pull-right{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left{margin-right:.3em}.fa.pull-right{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:"\f000"}.fa-music:before{content:"\f001"}.fa-search:before{content:"\f002"}.fa-envelope-o:before{content:"\f003"}.fa-heart:before{content:"\f004"}.fa-star:before{content:"\f005"}.fa-star-o:before{content:"\f006"}.fa-user:before{content:"\f007"}.fa-film:before{content:"\f008"}.fa-th-large:before{content:"\f009"}.fa-th:before{content:"\f00a"}.fa-th-list:before{content:"\f00b"}.fa-check:before{content:"\f00c"}.fa-remove:before,.fa-close:before,.fa-times:before{content:"\f00d"}.fa-search-plus:before{content:"\f00e"}.fa-search-minus:before{content:"\f010"}.fa-power-off:before{content:"\f011"}.fa-signal:before{content:"\f012"}.fa-gear:before,.fa-cog:before{content:"\f013"}.fa-trash-o:before{content:"\f014"}.fa-home:before{content:"\f015"}.fa-file-o:before{content:"\f016"}.fa-clock-o:before{content:"\f017"}.fa-road:before{content:"\f018"}.fa-download:before{content:"\f019"}.fa-arrow-circle-o-down:before{content:"\f01a"}.fa-arrow-circle-o-up:before{content:"\f01b"}.fa-inbox:before{content:"\f01c"}.fa-play-circle-o:before{content:"\f01d"}.fa-rotate-right:before,.fa-repeat:before{content:"\f01e"}.fa-refresh:before{content:"\f021"}.fa-list-alt:before{content:"\f022"}.fa-lock:before{content:"\f023"}.fa-flag:before{content:"\f024"}.fa-headphones:before{content:"\f025"}.fa-volume-off:before{content:"\f026"}.fa-volume-down:before{content:"\f027"}.fa-volume-up:before{content:"\f028"}.fa-qrcode:before{content:"\f029"}.fa-barcode:before{content:"\f02a"}.fa-tag:before{content:"\f02b"}.fa-tags:before{content:"\f02c"}.fa-book:before{content:"\f02d"}.fa-bookmark:before{content:"\f02e"}.fa-print:before{content:"\f02f"}.fa-camera:before{content:"\f030"}.fa-font:before{content:"\f031"}.fa-bold:before{content:"\f032"}.fa-italic:before{content:"\f033"}.fa-text-height:before{content:"\f034"}.fa-text-width:before{content:"\f035"}.fa-align-left:before{content:"\f036"}.fa-align-center:before{content:"\f037"}.fa-align-right:before{content:"\f038"}.fa-align-justify:before{content:"\f039"}.fa-list:before{content:"\f03a"}.fa-dedent:before,.fa-outdent:before{content:"\f03b"}.fa-indent:before{content:"\f03c"}.fa-video-camera:before{content:"\f03d"}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:"\f03e"}.fa-pencil:before{content:"\f040"}.fa-map-marker:before{content:"\f041"}.fa-adjust:before{content:"\f042"}.fa-tint:before{content:"\f043"}.fa-edit:before,.fa-pencil-square-o:before{content:"\f044"}.fa-share-square-o:before{content:"\f045"}.fa-check-square-o:before{content:"\f046"}.fa-arrows:before{content:"\f047"}.fa-step-backward:before{content:"\f048"}.fa-fast-backward:before{content:"\f049"}.fa-backward:before{content:"\f04a"}.fa-play:before{content:"\f04b"}.fa-pause:before{content:"\f04c"}.fa-stop:before{content:"\f04d"}.fa-forward:before{content:"\f04e"}.fa-fast-forward:before{content:"\f050"}.fa-step-forward:before{content:"\f051"}.fa-eject:before{content:"\f052"}.fa-chevron-left:before{content:"\f053"}.fa-chevron-right:before{content:"\f054"}.fa-plus-circle:before{content:"\f055"}.fa-minus-circle:before{content:"\f056"}.fa-times-circle:before{content:"\f057"}.fa-check-circle:before{content:"\f058"}.fa-question-circle:before{content:"\f059"}.fa-info-circle:before{content:"\f05a"}.fa-crosshairs:before{content:"\f05b"}.fa-times-circle-o:before{content:"\f05c"}.fa-check-circle-o:before{content:"\f05d"}.fa-ban:before{content:"\f05e"}.fa-arrow-left:before{content:"\f060"}.fa-arrow-right:before{content:"\f061"}.fa-arrow-up:before{content:"\f062"}.fa-arrow-down:before{content:"\f063"}.fa-mail-forward:before,.fa-share:before{content:"\f064"}.fa-expand:before{content:"\f065"}.fa-compress:before{content:"\f066"}.fa-plus:before{content:"\f067"}.fa-minus:before{content:"\f068"}.fa-asterisk:before{content:"\f069"}.fa-exclamation-circle:before{content:"\f06a"}.fa-gift:before{content:"\f06b"}.fa-leaf:before{content:"\f06c"}.fa-fire:before{content:"\f06d"}.fa-eye:before{content:"\f06e"}.fa-eye-slash:before{content:"\f070"}.fa-warning:before,.fa-exclamation-triangle:before{content:"\f071"}.fa-plane:before{content:"\f072"}.fa-calendar:before{content:"\f073"}.fa-random:before{content:"\f074"}.fa-comment:before{content:"\f075"}.fa-magnet:before{content:"\f076"}.fa-chevron-up:before{content:"\f077"}.fa-chevron-down:before{content:"\f078"}.fa-retweet:before{content:"\f079"}.fa-shopping-cart:before{content:"\f07a"}.fa-folder:before{content:"\f07b"}.fa-folder-open:before{content:"\f07c"}.fa-arrows-v:before{content:"\f07d"}.fa-arrows-h:before{content:"\f07e"}.fa-bar-chart-o:before,.fa-bar-chart:before{content:"\f080"}.fa-twitter-square:before{content:"\f081"}.fa-facebook-square:before{content:"\f082"}.fa-camera-retro:before{content:"\f083"}.fa-key:before{content:"\f084"}.fa-gears:before,.fa-cogs:before{content:"\f085"}.fa-comments:before{content:"\f086"}.fa-thumbs-o-up:before{content:"\f087"}.fa-thumbs-o-down:before{content:"\f088"}.fa-star-half:before{content:"\f089"}.fa-heart-o:before{content:"\f08a"}.fa-sign-out:before{content:"\f08b"}.fa-linkedin-square:before{content:"\f08c"}.fa-thumb-tack:before{content:"\f08d"}.fa-external-link:before{content:"\f08e"}.fa-sign-in:before{content:"\f090"}.fa-trophy:before{content:"\f091"}.fa-github-square:before{content:"\f092"}.fa-upload:before{content:"\f093"}.fa-lemon-o:before{content:"\f094"}.fa-phone:before{content:"\f095"}.fa-square-o:before{content:"\f096"}.fa-bookmark-o:before{content:"\f097"}.fa-phone-square:before{content:"\f098"}.fa-twitter:before{content:"\f099"}.fa-facebook-f:before,.fa-facebook:before{content:"\f09a"}.fa-github:before{content:"\f09b"}.fa-unlock:before{content:"\f09c"}.fa-credit-card:before{content:"\f09d"}.fa-feed:before,.fa-rss:before{content:"\f09e"}.fa-hdd-o:before{content:"\f0a0"}.fa-bullhorn:before{content:"\f0a1"}.fa-bell:before{content:"\f0f3"}.fa-certificate:before{content:"\f0a3"}.fa-hand-o-right:before{content:"\f0a4"}.fa-hand-o-left:before{content:"\f0a5"}.fa-hand-o-up:before{content:"\f0a6"}.fa-hand-o-down:before{content:"\f0a7"}.fa-arrow-circle-left:before{content:"\f0a8"}.fa-arrow-circle-right:before{content:"\f0a9"}.fa-arrow-circle-up:before{content:"\f0aa"}.fa-arrow-circle-down:before{content:"\f0ab"}.fa-globe:before{content:"\f0ac"}.fa-wrench:before{content:"\f0ad"}.fa-tasks:before{content:"\f0ae"}.fa-filter:before{content:"\f0b0"}.fa-briefcase:before{content:"\f0b1"}.fa-arrows-alt:before{content:"\f0b2"}.fa-group:before,.fa-users:before{content:"\f0c0"}.fa-chain:before,.fa-link:before{content:"\f0c1"}.fa-cloud:before{content:"\f0c2"}.fa-flask:before{content:"\f0c3"}.fa-cut:before,.fa-scissors:before{content:"\f0c4"}.fa-copy:before,.fa-files-o:before{content:"\f0c5"}.fa-paperclip:before{content:"\f0c6"}.fa-save:before,.fa-floppy-o:before{content:"\f0c7"}.fa-square:before{content:"\f0c8"}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:"\f0c9"}.fa-list-ul:before{content:"\f0ca"}.fa-list-ol:before{content:"\f0cb"}.fa-strikethrough:before{content:"\f0cc"}.fa-underline:before{content:"\f0cd"}.fa-table:before{content:"\f0ce"}.fa-magic:before{content:"\f0d0"}.fa-truck:before{content:"\f0d1"}.fa-pinterest:before{content:"\f0d2"}.fa-pinterest-square:before{content:"\f0d3"}.fa-google-plus-square:before{content:"\f0d4"}.fa-google-plus:before{content:"\f0d5"}.fa-money:before{content:"\f0d6"}.fa-caret-down:before{content:"\f0d7"}.fa-caret-up:before{content:"\f0d8"}.fa-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.fa-columns:before{content:"\f0db"}.fa-unsorted:before,.fa-sort:before{content:"\f0dc"}.fa-sort-down:before,.fa-sort-desc:before{content:"\f0dd"}.fa-sort-up:before,.fa-sort-asc:before{content:"\f0de"}.fa-envelope:before{content:"\f0e0"}.fa-linkedin:before{content:"\f0e1"}.fa-rotate-left:before,.fa-undo:before{content:"\f0e2"}.fa-legal:before,.fa-gavel:before{content:"\f0e3"}.fa-dashboard:before,.fa-tachometer:before{content:"\f0e4"}.fa-comment-o:before{content:"\f0e5"}.fa-comments-o:before{content:"\f0e6"}.fa-flash:before,.fa-bolt:before{content:"\f0e7"}.fa-sitemap:before{content:"\f0e8"}.fa-umbrella:before{content:"\f0e9"}.fa-paste:before,.fa-clipboard:before{content:"\f0ea"}.fa-lightbulb-o:before{content:"\f0eb"}.fa-exchange:before{content:"\f0ec"}.fa-cloud-download:before{content:"\f0ed"}.fa-cloud-upload:before{content:"\f0ee"}.fa-user-md:before{content:"\f0f0"}.fa-stethoscope:before{content:"\f0f1"}.fa-suitcase:before{content:"\f0f2"}.fa-bell-o:before{content:"\f0a2"}.fa-coffee:before{content:"\f0f4"}.fa-cutlery:before{content:"\f0f5"}.fa-file-text-o:before{content:"\f0f6"}.fa-building-o:before{content:"\f0f7"}.fa-hospital-o:before{content:"\f0f8"}.fa-ambulance:before{content:"\f0f9"}.fa-medkit:before{content:"\f0fa"}.fa-fighter-jet:before{content:"\f0fb"}.fa-beer:before{content:"\f0fc"}.fa-h-square:before{content:"\f0fd"}.fa-plus-square:before{content:"\f0fe"}.fa-angle-double-left:before{content:"\f100"}.fa-angle-double-right:before{content:"\f101"}.fa-angle-double-up:before{content:"\f102"}.fa-angle-double-down:before{content:"\f103"}.fa-angle-left:before{content:"\f104"}.fa-angle-right:before{content:"\f105"}.fa-angle-up:before{content:"\f106"}.fa-angle-down:before{content:"\f107"}.fa-desktop:before{content:"\f108"}.fa-laptop:before{content:"\f109"}.fa-tablet:before{content:"\f10a"}.fa-mobile-phone:before,.fa-mobile:before{content:"\f10b"}.fa-circle-o:before{content:"\f10c"}.fa-quote-left:before{content:"\f10d"}.fa-quote-right:before{content:"\f10e"}.fa-spinner:before{content:"\f110"}.fa-circle:before{content:"\f111"}.fa-mail-reply:before,.fa-reply:before{content:"\f112"}.fa-github-alt:before{content:"\f113"}.fa-folder-o:before{content:"\f114"}.fa-folder-open-o:before{content:"\f115"}.fa-smile-o:before{content:"\f118"}.fa-frown-o:before{content:"\f119"}.fa-meh-o:before{content:"\f11a"}.fa-gamepad:before{content:"\f11b"}.fa-keyboard-o:before{content:"\f11c"}.fa-flag-o:before{content:"\f11d"}.fa-flag-checkered:before{content:"\f11e"}.fa-terminal:before{content:"\f120"}.fa-code:before{content:"\f121"}.fa-mail-reply-all:before,.fa-reply-all:before{content:"\f122"}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:"\f123"}.fa-location-arrow:before{content:"\f124"}.fa-crop:before{content:"\f125"}.fa-code-fork:before{content:"\f126"}.fa-unlink:before,.fa-chain-broken:before{content:"\f127"}.fa-question:before{content:"\f128"}.fa-info:before{content:"\f129"}.fa-exclamation:before{content:"\f12a"}.fa-superscript:before{content:"\f12b"}.fa-subscript:before{content:"\f12c"}.fa-eraser:before{content:"\f12d"}.fa-puzzle-piece:before{content:"\f12e"}.fa-microphone:before{content:"\f130"}.fa-microphone-slash:before{content:"\f131"}.fa-shield:before{content:"\f132"}.fa-calendar-o:before{content:"\f133"}.fa-fire-extinguisher:before{content:"\f134"}.fa-rocket:before{content:"\f135"}.fa-maxcdn:before{content:"\f136"}.fa-chevron-circle-left:before{content:"\f137"}.fa-chevron-circle-right:before{content:"\f138"}.fa-chevron-circle-up:before{content:"\f139"}.fa-chevron-circle-down:before{content:"\f13a"}.fa-html5:before{content:"\f13b"}.fa-css3:before{content:"\f13c"}.fa-anchor:before{content:"\f13d"}.fa-unlock-alt:before{content:"\f13e"}.fa-bullseye:before{content:"\f140"}.fa-ellipsis-h:before{content:"\f141"}.fa-ellipsis-v:before{content:"\f142"}.fa-rss-square:before{content:"\f143"}.fa-play-circle:before{content:"\f144"}.fa-ticket:before{content:"\f145"}.fa-minus-square:before{content:"\f146"}.fa-minus-square-o:before{content:"\f147"}.fa-level-up:before{content:"\f148"}.fa-level-down:before{content:"\f149"}.fa-check-square:before{content:"\f14a"}.fa-pencil-square:before{content:"\f14b"}.fa-external-link-square:before{content:"\f14c"}.fa-share-square:before{content:"\f14d"}.fa-compass:before{content:"\f14e"}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:"\f150"}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:"\f151"}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:"\f152"}.fa-euro:before,.fa-eur:before{content:"\f153"}.fa-gbp:before{content:"\f154"}.fa-dollar:before,.fa-usd:before{content:"\f155"}.fa-rupee:before,.fa-inr:before{content:"\f156"}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:"\f157"}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:"\f158"}.fa-won:before,.fa-krw:before{content:"\f159"}.fa-bitcoin:before,.fa-btc:before{content:"\f15a"}.fa-file:before{content:"\f15b"}.fa-file-text:before{content:"\f15c"}.fa-sort-alpha-asc:before{content:"\f15d"}.fa-sort-alpha-desc:before{content:"\f15e"}.fa-sort-amount-asc:before{content:"\f160"}.fa-sort-amount-desc:before{content:"\f161"}.fa-sort-numeric-asc:before{content:"\f162"}.fa-sort-numeric-desc:before{content:"\f163"}.fa-thumbs-up:before{content:"\f164"}.fa-thumbs-down:before{content:"\f165"}.fa-youtube-square:before{content:"\f166"}.fa-youtube:before{content:"\f167"}.fa-xing:before{content:"\f168"}.fa-xing-square:before{content:"\f169"}.fa-youtube-play:before{content:"\f16a"}.fa-dropbox:before{content:"\f16b"}.fa-stack-overflow:before{content:"\f16c"}.fa-instagram:before{content:"\f16d"}.fa-flickr:before{content:"\f16e"}.fa-adn:before{content:"\f170"}.fa-bitbucket:before{content:"\f171"}.fa-bitbucket-square:before{content:"\f172"}.fa-tumblr:before{content:"\f173"}.fa-tumblr-square:before{content:"\f174"}.fa-long-arrow-down:before{content:"\f175"}.fa-long-arrow-up:before{content:"\f176"}.fa-long-arrow-left:before{content:"\f177"}.fa-long-arrow-right:before{content:"\f178"}.fa-apple:before{content:"\f179"}.fa-windows:before{content:"\f17a"}.fa-android:before{content:"\f17b"}.fa-linux:before{content:"\f17c"}.fa-dribbble:before{content:"\f17d"}.fa-skype:before{content:"\f17e"}.fa-foursquare:before{content:"\f180"}.fa-trello:before{content:"\f181"}.fa-female:before{content:"\f182"}.fa-male:before{content:"\f183"}.fa-gittip:before,.fa-gratipay:before{content:"\f184"}.fa-sun-o:before{content:"\f185"}.fa-moon-o:before{content:"\f186"}.fa-archive:before{content:"\f187"}.fa-bug:before{content:"\f188"}.fa-vk:before{content:"\f189"}.fa-weibo:before{content:"\f18a"}.fa-renren:before{content:"\f18b"}.fa-pagelines:before{content:"\f18c"}.fa-stack-exchange:before{content:"\f18d"}.fa-arrow-circle-o-right:before{content:"\f18e"}.fa-arrow-circle-o-left:before{content:"\f190"}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:"\f191"}.fa-dot-circle-o:before{content:"\f192"}.fa-wheelchair:before{content:"\f193"}.fa-vimeo-square:before{content:"\f194"}.fa-turkish-lira:before,.fa-try:before{content:"\f195"}.fa-plus-square-o:before{content:"\f196"}.fa-space-shuttle:before{content:"\f197"}.fa-slack:before{content:"\f198"}.fa-envelope-square:before{content:"\f199"}.fa-wordpress:before{content:"\f19a"}.fa-openid:before{content:"\f19b"}.fa-institution:before,.fa-bank:before,.fa-university:before{content:"\f19c"}.fa-mortar-board:before,.fa-graduation-cap:before{content:"\f19d"}.fa-yahoo:before{content:"\f19e"}.fa-google:before{content:"\f1a0"}.fa-reddit:before{content:"\f1a1"}.fa-reddit-square:before{content:"\f1a2"}.fa-stumbleupon-circle:before{content:"\f1a3"}.fa-stumbleupon:before{content:"\f1a4"}.fa-delicious:before{content:"\f1a5"}.fa-digg:before{content:"\f1a6"}.fa-pied-piper-pp:before{content:"\f1a7"}.fa-pied-piper-alt:before{content:"\f1a8"}.fa-drupal:before{content:"\f1a9"}.fa-joomla:before{content:"\f1aa"}.fa-language:before{content:"\f1ab"}.fa-fax:before{content:"\f1ac"}.fa-building:before{content:"\f1ad"}.fa-child:before{content:"\f1ae"}.fa-paw:before{content:"\f1b0"}.fa-spoon:before{content:"\f1b1"}.fa-cube:before{content:"\f1b2"}.fa-cubes:before{content:"\f1b3"}.fa-behance:before{content:"\f1b4"}.fa-behance-square:before{content:"\f1b5"}.fa-steam:before{content:"\f1b6"}.fa-steam-square:before{content:"\f1b7"}.fa-recycle:before{content:"\f1b8"}.fa-automobile:before,.fa-car:before{content:"\f1b9"}.fa-cab:before,.fa-taxi:before{content:"\f1ba"}.fa-tree:before{content:"\f1bb"}.fa-spotify:before{content:"\f1bc"}.fa-deviantart:before{content:"\f1bd"}.fa-soundcloud:before{content:"\f1be"}.fa-database:before{content:"\f1c0"}.fa-file-pdf-o:before{content:"\f1c1"}.fa-file-word-o:before{content:"\f1c2"}.fa-file-excel-o:before{content:"\f1c3"}.fa-file-powerpoint-o:before{content:"\f1c4"}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:"\f1c5"}.fa-file-zip-o:before,.fa-file-archive-o:before{content:"\f1c6"}.fa-file-sound-o:before,.fa-file-audio-o:before{content:"\f1c7"}.fa-file-movie-o:before,.fa-file-video-o:before{content:"\f1c8"}.fa-file-code-o:before{content:"\f1c9"}.fa-vine:before{content:"\f1ca"}.fa-codepen:before{content:"\f1cb"}.fa-jsfiddle:before{content:"\f1cc"}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:"\f1cd"}.fa-circle-o-notch:before{content:"\f1ce"}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:"\f1d0"}.fa-ge:before,.fa-empire:before{content:"\f1d1"}.fa-git-square:before{content:"\f1d2"}.fa-git:before{content:"\f1d3"}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:"\f1d4"}.fa-tencent-weibo:before{content:"\f1d5"}.fa-qq:before{content:"\f1d6"}.fa-wechat:before,.fa-weixin:before{content:"\f1d7"}.fa-send:before,.fa-paper-plane:before{content:"\f1d8"}.fa-send-o:before,.fa-paper-plane-o:before{content:"\f1d9"}.fa-history:before{content:"\f1da"}.fa-circle-thin:before{content:"\f1db"}.fa-header:before{content:"\f1dc"}.fa-paragraph:before{content:"\f1dd"}.fa-sliders:before{content:"\f1de"}.fa-share-alt:before{content:"\f1e0"}.fa-share-alt-square:before{content:"\f1e1"}.fa-bomb:before{content:"\f1e2"}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:"\f1e3"}.fa-tty:before{content:"\f1e4"}.fa-binoculars:before{content:"\f1e5"}.fa-plug:before{content:"\f1e6"}.fa-slideshare:before{content:"\f1e7"}.fa-twitch:before{content:"\f1e8"}.fa-yelp:before{content:"\f1e9"}.fa-newspaper-o:before{content:"\f1ea"}.fa-wifi:before{content:"\f1eb"}.fa-calculator:before{content:"\f1ec"}.fa-paypal:before{content:"\f1ed"}.fa-google-wallet:before{content:"\f1ee"}.fa-cc-visa:before{content:"\f1f0"}.fa-cc-mastercard:before{content:"\f1f1"}.fa-cc-discover:before{content:"\f1f2"}.fa-cc-amex:before{content:"\f1f3"}.fa-cc-paypal:before{content:"\f1f4"}.fa-cc-stripe:before{content:"\f1f5"}.fa-bell-slash:before{content:"\f1f6"}.fa-bell-slash-o:before{content:"\f1f7"}.fa-trash:before{content:"\f1f8"}.fa-copyright:before{content:"\f1f9"}.fa-at:before{content:"\f1fa"}.fa-eyedropper:before{content:"\f1fb"}.fa-paint-brush:before{content:"\f1fc"}.fa-birthday-cake:before{content:"\f1fd"}.fa-area-chart:before{content:"\f1fe"}.fa-pie-chart:before{content:"\f200"}.fa-line-chart:before{content:"\f201"}.fa-lastfm:before{content:"\f202"}.fa-lastfm-square:before{content:"\f203"}.fa-toggle-off:before{content:"\f204"}.fa-toggle-on:before{content:"\f205"}.fa-bicycle:before{content:"\f206"}.fa-bus:before{content:"\f207"}.fa-ioxhost:before{content:"\f208"}.fa-angellist:before{content:"\f209"}.fa-cc:before{content:"\f20a"}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:"\f20b"}.fa-meanpath:before{content:"\f20c"}.fa-buysellads:before{content:"\f20d"}.fa-connectdevelop:before{content:"\f20e"}.fa-dashcube:before{content:"\f210"}.fa-forumbee:before{content:"\f211"}.fa-leanpub:before{content:"\f212"}.fa-sellsy:before{content:"\f213"}.fa-shirtsinbulk:before{content:"\f214"}.fa-simplybuilt:before{content:"\f215"}.fa-skyatlas:before{content:"\f216"}.fa-cart-plus:before{content:"\f217"}.fa-cart-arrow-down:before{content:"\f218"}.fa-diamond:before{content:"\f219"}.fa-ship:before{content:"\f21a"}.fa-user-secret:before{content:"\f21b"}.fa-motorcycle:before{content:"\f21c"}.fa-street-view:before{content:"\f21d"}.fa-heartbeat:before{content:"\f21e"}.fa-venus:before{content:"\f221"}.fa-mars:before{content:"\f222"}.fa-mercury:before{content:"\f223"}.fa-intersex:before,.fa-transgender:before{content:"\f224"}.fa-transgender-alt:before{content:"\f225"}.fa-venus-double:before{content:"\f226"}.fa-mars-double:before{content:"\f227"}.fa-venus-mars:before{content:"\f228"}.fa-mars-stroke:before{content:"\f229"}.fa-mars-stroke-v:before{content:"\f22a"}.fa-mars-stroke-h:before{content:"\f22b"}.fa-neuter:before{content:"\f22c"}.fa-genderless:before{content:"\f22d"}.fa-facebook-official:before{content:"\f230"}.fa-pinterest-p:before{content:"\f231"}.fa-whatsapp:before{content:"\f232"}.fa-server:before{content:"\f233"}.fa-user-plus:before{content:"\f234"}.fa-user-times:before{content:"\f235"}.fa-hotel:before,.fa-bed:before{content:"\f236"}.fa-viacoin:before{content:"\f237"}.fa-train:before{content:"\f238"}.fa-subway:before{content:"\f239"}.fa-medium:before{content:"\f23a"}.fa-yc:before,.fa-y-combinator:before{content:"\f23b"}.fa-optin-monster:before{content:"\f23c"}.fa-opencart:before{content:"\f23d"}.fa-expeditedssl:before{content:"\f23e"}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:"\f240"}.fa-battery-3:before,.fa-battery-three-quarters:before{content:"\f241"}.fa-battery-2:before,.fa-battery-half:before{content:"\f242"}.fa-battery-1:before,.fa-battery-quarter:before{content:"\f243"}.fa-battery-0:before,.fa-battery-empty:before{content:"\f244"}.fa-mouse-pointer:before{content:"\f245"}.fa-i-cursor:before{content:"\f246"}.fa-object-group:before{content:"\f247"}.fa-object-ungroup:before{content:"\f248"}.fa-sticky-note:before{content:"\f249"}.fa-sticky-note-o:before{content:"\f24a"}.fa-cc-jcb:before{content:"\f24b"}.fa-cc-diners-club:before{content:"\f24c"}.fa-clone:before{content:"\f24d"}.fa-balance-scale:before{content:"\f24e"}.fa-hourglass-o:before{content:"\f250"}.fa-hourglass-1:before,.fa-hourglass-start:before{content:"\f251"}.fa-hourglass-2:before,.fa-hourglass-half:before{content:"\f252"}.fa-hourglass-3:before,.fa-hourglass-end:before{content:"\f253"}.fa-hourglass:before{content:"\f254"}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:"\f255"}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:"\f256"}.fa-hand-scissors-o:before{content:"\f257"}.fa-hand-lizard-o:before{content:"\f258"}.fa-hand-spock-o:before{content:"\f259"}.fa-hand-pointer-o:before{content:"\f25a"}.fa-hand-peace-o:before{content:"\f25b"}.fa-trademark:before{content:"\f25c"}.fa-registered:before{content:"\f25d"}.fa-creative-commons:before{content:"\f25e"}.fa-gg:before{content:"\f260"}.fa-gg-circle:before{content:"\f261"}.fa-tripadvisor:before{content:"\f262"}.fa-odnoklassniki:before{content:"\f263"}.fa-odnoklassniki-square:before{content:"\f264"}.fa-get-pocket:before{content:"\f265"}.fa-wikipedia-w:before{content:"\f266"}.fa-safari:before{content:"\f267"}.fa-chrome:before{content:"\f268"}.fa-firefox:before{content:"\f269"}.fa-opera:before{content:"\f26a"}.fa-internet-explorer:before{content:"\f26b"}.fa-tv:before,.fa-television:before{content:"\f26c"}.fa-contao:before{content:"\f26d"}.fa-500px:before{content:"\f26e"}.fa-amazon:before{content:"\f270"}.fa-calendar-plus-o:before{content:"\f271"}.fa-calendar-minus-o:before{content:"\f272"}.fa-calendar-times-o:before{content:"\f273"}.fa-calendar-check-o:before{content:"\f274"}.fa-industry:before{content:"\f275"}.fa-map-pin:before{content:"\f276"}.fa-map-signs:before{content:"\f277"}.fa-map-o:before{content:"\f278"}.fa-map:before{content:"\f279"}.fa-commenting:before{content:"\f27a"}.fa-commenting-o:before{content:"\f27b"}.fa-houzz:before{content:"\f27c"}.fa-vimeo:before{content:"\f27d"}.fa-black-tie:before{content:"\f27e"}.fa-fonticons:before{content:"\f280"}.fa-reddit-alien:before{content:"\f281"}.fa-edge:before{content:"\f282"}.fa-credit-card-alt:before{content:"\f283"}.fa-codiepie:before{content:"\f284"}.fa-modx:before{content:"\f285"}.fa-fort-awesome:before{content:"\f286"}.fa-usb:before{content:"\f287"}.fa-product-hunt:before{content:"\f288"}.fa-mixcloud:before{content:"\f289"}.fa-scribd:before{content:"\f28a"}.fa-pause-circle:before{content:"\f28b"}.fa-pause-circle-o:before{content:"\f28c"}.fa-stop-circle:before{content:"\f28d"}.fa-stop-circle-o:before{content:"\f28e"}.fa-shopping-bag:before{content:"\f290"}.fa-shopping-basket:before{content:"\f291"}.fa-hashtag:before{content:"\f292"}.fa-bluetooth:before{content:"\f293"}.fa-bluetooth-b:before{content:"\f294"}.fa-percent:before{content:"\f295"}.fa-gitlab:before{content:"\f296"}.fa-wpbeginner:before{content:"\f297"}.fa-wpforms:before{content:"\f298"}.fa-envira:before{content:"\f299"}.fa-universal-access:before{content:"\f29a"}.fa-wheelchair-alt:before{content:"\f29b"}.fa-question-circle-o:before{content:"\f29c"}.fa-blind:before{content:"\f29d"}.fa-audio-description:before{content:"\f29e"}.fa-volume-control-phone:before{content:"\f2a0"}.fa-braille:before{content:"\f2a1"}.fa-assistive-listening-systems:before{content:"\f2a2"}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:"\f2a3"}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:"\f2a4"}.fa-glide:before{content:"\f2a5"}.fa-glide-g:before{content:"\f2a6"}.fa-signing:before,.fa-sign-language:before{content:"\f2a7"}.fa-low-vision:before{content:"\f2a8"}.fa-viadeo:before{content:"\f2a9"}.fa-viadeo-square:before{content:"\f2aa"}.fa-snapchat:before{content:"\f2ab"}.fa-snapchat-ghost:before{content:"\f2ac"}.fa-snapchat-square:before{content:"\f2ad"}.fa-pied-piper:before{content:"\f2ae"}.fa-first-order:before{content:"\f2b0"}.fa-yoast:before{content:"\f2b1"}.fa-themeisle:before{content:"\f2b2"}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:"\f2b3"}.fa-fa:before,.fa-font-awesome:before{content:"\f2b4"}.fa-handshake-o:before{content:"\f2b5"}.fa-envelope-open:before{content:"\f2b6"}.fa-envelope-open-o:before{content:"\f2b7"}.fa-linode:before{content:"\f2b8"}.fa-address-book:before{content:"\f2b9"}.fa-address-book-o:before{content:"\f2ba"}.fa-vcard:before,.fa-address-card:before{content:"\f2bb"}.fa-vcard-o:before,.fa-address-card-o:before{content:"\f2bc"}.fa-user-circle:before{content:"\f2bd"}.fa-user-circle-o:before{content:"\f2be"}.fa-user-o:before{content:"\f2c0"}.fa-id-badge:before{content:"\f2c1"}.fa-drivers-license:before,.fa-id-card:before{content:"\f2c2"}.fa-drivers-license-o:before,.fa-id-card-o:before{content:"\f2c3"}.fa-quora:before{content:"\f2c4"}.fa-free-code-camp:before{content:"\f2c5"}.fa-telegram:before{content:"\f2c6"}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:"\f2c7"}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:"\f2c8"}.fa-thermometer-2:before,.fa-thermometer-half:before{content:"\f2c9"}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:"\f2ca"}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:"\f2cb"}.fa-shower:before{content:"\f2cc"}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:"\f2cd"}.fa-podcast:before{content:"\f2ce"}.fa-window-maximize:before{content:"\f2d0"}.fa-window-minimize:before{content:"\f2d1"}.fa-window-restore:before{content:"\f2d2"}.fa-times-rectangle:before,.fa-window-close:before{content:"\f2d3"}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:"\f2d4"}.fa-bandcamp:before{content:"\f2d5"}.fa-grav:before{content:"\f2d6"}.fa-etsy:before{content:"\f2d7"}.fa-imdb:before{content:"\f2d8"}.fa-ravelry:before{content:"\f2d9"}.fa-eercast:before{content:"\f2da"}.fa-microchip:before{content:"\f2db"}.fa-snowflake-o:before{content:"\f2dc"}.fa-superpowers:before{content:"\f2dd"}.fa-wpexplorer:before{content:"\f2de"}.fa-meetup:before{content:"\f2e0"}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto} diff --git a/docs/css/navbar.css b/docs/css/navbar.css index 89d74149..58140f2f 100644 --- a/docs/css/navbar.css +++ b/docs/css/navbar.css @@ -16,7 +16,7 @@ body { } /* Style the sidenav links and the dropdown button */ -.sidenav a, .dropdown-btn { +.sidenav a, .dropdown-btn , .sidenav table{ padding: 6px 8px 6px 16px; text-decoration: none; font-size: 20px; @@ -30,6 +30,20 @@ body { outline: none; } +.sidenav table { + visibility: hidden; +} + +.sidenav img{ + padding: 6px 8px 6px 16px; +} + +.vertical-line { + margin-top: 10px; + margin-bottom: 10px; + border-top: 1px solid #818181; +} + /* On mouse-over */ .sidenav a:hover, .dropdown-btn:hover { color: #f1f1f1; @@ -54,6 +68,40 @@ body { padding-right: 8px; } +/* .ln-button { + -webkit-transition: all 200ms cubic-bezier(0.390, 0.500, 0.150, 1.360); + -moz-transition: all 200ms cubic-bezier(0.390, 0.500, 0.150, 1.360); + -ms-transition: all 200ms cubic-bezier(0.390, 0.500, 0.150, 1.360); + -o-transition: all 200ms cubic-bezier(0.390, 0.500, 0.150, 1.360); + transition: all 200ms cubic-bezier(0.390, 0.500, 0.150, 1.360); + display: block; + margin: 20px auto; + max-width: 180px; + text-decoration: none; + border-radius: 4px; + padding: 20px 30px; +} + +.ln-button { + color: rgba(30, 22, 54, 0.6); + box-shadow: rgba(30, 22, 54, 0.4) 0 0px 0px 2px inset; +} + +.ln-button:hover { + color: rgba(255, 255, 255, 0.85); + box-shadow: rgba(30, 22, 54, 0.7) 0 0px 0px 40px inset; +} */ + +/* a.button2 { + color: rgba(30, 22, 54, 0.6); + box-shadow: rgba(30, 22, 54, 0.4) 0 0px 0px 2px inset; +} + +a.button2:hover { + color: rgba(255, 255, 255, 0.85); + box-shadow: rgba(30, 22, 54, 0.7) 0 80px 0px 2px inset; +} */ + /* Some media queries for responsiveness */ @media screen and (max-height: 450px) { .sidenav {padding-top: 15px;} diff --git a/docs/developper/dev.html b/docs/developper/dev.html new file mode 100644 index 00000000..b00434d1 --- /dev/null +++ b/docs/developper/dev.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
+ +
+ Getting started + Objects + Tutorials + Versions + Developper guide +
+ + + + + +
+ En + + Fr +
+
+ + + +
+
+ + + + + diff --git a/docs/developper/dev.md b/docs/developper/dev.md index ec822107..592ed76a 100644 --- a/docs/developper/dev.md +++ b/docs/developper/dev.md @@ -33,9 +33,9 @@ python ./Script/configure.py To build Kiwi, you can either open your code editor and build the project or use our build script. Here is a list of tested compilers depending on your platform. -* MacOs: clang 7.3.1 -* Windows: msvc 19.0 -* Linus: gcc-4.9 +- MacOs: clang 7.3.1 +- Windows: msvc 19.0 +- Linus: gcc-4.9 ```shell python ./Script/build.py @@ -51,7 +51,7 @@ python ./Script/build.py -t Server -c Debug ##### Tests -Tests are ran as a post build command of target Tests. To run run tests +Tests are ran as a post build command of target Tests. To run tests. ```shell python ./Srcipts/build.py -t Tests -c Release @@ -60,9 +60,44 @@ python ./Srcipts/build.py -t Tests -c Release ### Code -The documentation of Kiwi's classes can be found [here](html/index.html). +The documentation of Kiwi's classes can be found [here](../html/index.html). ### Server + +The Kiwi client application needs running API and document session servers to work. The API server is used by Kiwi to give informations about document and users. The document session server + +#### Api Server + +To run the Node.js server, follow the instructions in the readme.md file of the [kiwi-node-server](https://github.com/Musicoll/kiwi-node-server) repository + +#### Document session server + +First create a `.json` config file somewhere (ie a `dev.json` file in a `/config` directory next to the server binary). + +The `.json` file must contain: +- A `session_port` entry to specify the session port to use to serve documents. +- A `backend_directory` entry to specify directory in which documents are saved. +- A `open_token` which is given by the API server and used by the document server to verify the users identity. (Shall be the same for API and document server). +- A `kiwi_version` that is the compatible kiwi version. Shall be the same as the app version of the binary that will communicate with the server. + +The api server also uses a json file for its settings. Its easier to use the same json file for both the API server and the document server for some informations are shared between the two servers. + +ex: +```json +{ + "session_port": 1000, + "backend_directory": "server_backend", + "open_token": "etienned@o", + "kiwi_version": "v1.0.0" +} +``` + +You can then launch the server by typing in a terminal. + +```shell +$ ./Server -f ./config/dev.json +``` + ### Scripts ##### Documentation @@ -91,3 +126,16 @@ This script takes 2 optional arguments: # or with custom paths $ python ./Scripts/ressource.py -i input/ressources/path -o output/binary/path ``` +##### Windows installer + +An installer for Kiwi's software is generated for windows operating system. [Inno setup](http://www.jrsoftware.org/isinfo.php) is used to generated the installer .exe file. + + +To manually generate the windows installer for 32 and 64 bit, first make sure that you have compiled Kiwi Win32 and 64x binaries in mode Release. Install inno setup on your machine and locate the folder containing "ISCC.exe" and invoke it the command line specifying either [Kiwi-Directory]/Scripts/setup-Win32.iss to generate the 32 bit installeror /Scripts/setup-x64.iss to generate the 64 bit insaller. + +ex: +```shell +$ "C:\Program Files (x86)\Inno Setup 5\ISCC.exe" Scripts\setup-x64.iss +``` + +The installer is generated in the respective build directories i.e [Kiwi-Directory]\Build\Release\[Platform]\KiwiBuild\[Config]. diff --git a/docs/fr/developper/dev.html b/docs/fr/developper/dev.html new file mode 100644 index 00000000..998be4d4 --- /dev/null +++ b/docs/fr/developper/dev.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
+ +
+ Premiers pas + Objets + Tutoriaux + Versions + Développement +
+ + + + + +
+ En + + Fr +
+
+ + + +
+
+ + + + + diff --git a/docs/fr/developper/dev.md b/docs/fr/developper/dev.md new file mode 100644 index 00000000..8c3a5e4d --- /dev/null +++ b/docs/fr/developper/dev.md @@ -0,0 +1 @@ +# Développement diff --git a/docs/fr/index.html b/docs/fr/index.html new file mode 100644 index 00000000..4c2c4706 --- /dev/null +++ b/docs/fr/index.html @@ -0,0 +1,62 @@ + + + + + Kiwi Wiki + + + + + + + + + +
+ +
+ Premiers pas + Objets + Tutoriaux + Versions + Développement +
+ + + + + +
+ En + + Fr +
+
+ + + +
+

Kiwi Wiki

+

Bienvenue dans notre wiki !

+

Vous trouverez ici toutes les informations concernant l'utilisation du logiciel Kiwi ainsi qu'une aide + aux codeurs souhaitant contribuer au projet Kiwi.

+
+ + + diff --git a/docs/fr/software/getting-started.html b/docs/fr/software/getting-started.html new file mode 100644 index 00000000..0f69dc2d --- /dev/null +++ b/docs/fr/software/getting-started.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
+ +
+ Premiers pas + Objets + Tutoriaux + Versions + Développement +
+ + + + + +
+ En + + Fr +
+
+ + + +
+
+ + + + + diff --git a/docs/fr/software/getting-started.md b/docs/fr/software/getting-started.md new file mode 100644 index 00000000..6ad04160 --- /dev/null +++ b/docs/fr/software/getting-started.md @@ -0,0 +1 @@ +# Premiers pas diff --git a/docs/fr/software/objects.html b/docs/fr/software/objects.html new file mode 100644 index 00000000..05a1922e --- /dev/null +++ b/docs/fr/software/objects.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
+ +
+ Premiers pas + Objets + Tutoriaux + Versions + Développement +
+ + + + + +
+ En + + Fr +
+
+ + + +
+
+ + + + + diff --git a/docs/fr/software/objects.md b/docs/fr/software/objects.md new file mode 100644 index 00000000..a3ad5406 --- /dev/null +++ b/docs/fr/software/objects.md @@ -0,0 +1 @@ +# Objets diff --git a/docs/fr/software/tutorials.html b/docs/fr/software/tutorials.html new file mode 100644 index 00000000..a4b17929 --- /dev/null +++ b/docs/fr/software/tutorials.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
+ +
+ Premiers pas + Objets + Tutoriaux + Versions + Développement +
+ + + + + +
+ En + + Fr +
+
+ + + +
+
+ + + + + diff --git a/docs/fr/software/tutorials.md b/docs/fr/software/tutorials.md new file mode 100644 index 00000000..d04048a0 --- /dev/null +++ b/docs/fr/software/tutorials.md @@ -0,0 +1 @@ +# Tutoriaux diff --git a/docs/fr/software/versions.html b/docs/fr/software/versions.html new file mode 100644 index 00000000..7c0fb6fb --- /dev/null +++ b/docs/fr/software/versions.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
+ +
+ Premiers pas + Objets + Tutoriaux + Versions + Développement +
+ + + + + +
+ En + + Fr +
+
+ + + +
+
+ + + + + diff --git a/docs/fr/software/versions.md b/docs/fr/software/versions.md new file mode 100644 index 00000000..0c8b1405 --- /dev/null +++ b/docs/fr/software/versions.md @@ -0,0 +1 @@ +# Versions diff --git a/docs/html/_kiwi_app_8h_source.html b/docs/html/_kiwi_app_8h_source.html index dadfc8aa..6ae86f62 100644 --- a/docs/html/_kiwi_app_8h_source.html +++ b/docs/html/_kiwi_app_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
KiwiApp.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <thread>
25 
26 #include <juce_gui_basics/juce_gui_basics.h>
27 
28 #include <KiwiEngine/KiwiEngine_Scheduler.h>
29 
30 #include "KiwiApp_Application/KiwiApp_Instance.h"
31 #include "KiwiApp_General/KiwiApp_StoredSettings.h"
32 #include "KiwiApp_General/KiwiApp_LookAndFeel.h"
33 
34 #include "KiwiApp_Components/KiwiApp_TooltipWindow.h"
35 
36 namespace ProjectInfo
37 {
38  const char* const projectName = "Kiwi";
39  const char* const versionString = "0.1.0";
40  const int versionNumber = 0x010;
41 }
42 
43 namespace kiwi
44 {
45  // ================================================================================ //
46  // KiWi APPLICATION //
47  // ================================================================================ //
48 
49  class KiwiApp : public juce::JUCEApplication
50  {
51  public: // methods
52 
53  // ================================================================================ //
54  // JUCEApplication //
55  // ================================================================================ //
56 
58  void initialise(juce::String const& commandLine) override;
59 
61  void anotherInstanceStarted(juce::String const& command_line) override;
62 
64  void shutdown() override;
65 
67  void systemRequestedQuit() override;
68 
70  const juce::String getApplicationName() override;
71 
73  const juce::String getApplicationVersion() override;
74 
76  bool moreThanOneInstanceAllowed() override;
77 
79  static bool isMacOSX();
80 
82  static bool isLinux();
83 
85  static bool isWindows();
86 
88  void processEngine();
89 
90  //==============================================================================
91 
93  static KiwiApp& use();
94 
96  static KiwiApp* getApp();
97 
99  static Instance& useInstance();
100 
102  static engine::Instance& useEngineInstance();
103 
105  static uint64_t userID();
106 
108  static StoredSettings& useSettings();
109 
111  static juce::MenuBarModel* getMenuBarModel();
112 
114  static LookAndFeel& useLookAndFeel();
115 
117  static TooltipWindow& useTooltipWindow();
118 
119  // ================================================================================ //
120  // CONSOLE //
121  // ================================================================================ //
122 
124  static void log(std::string const& text);
125 
127  static void post(std::string const& text);
128 
130  static void warning(std::string const& text);
131 
133  static void error(std::string const& text);
134 
135  //==============================================================================
136 
138  void closeWindow(Window& window);
139 
140  // ================================================================================ //
141  // APPLICATION MENU //
142  // ================================================================================ //
143 
145  struct MainMenuModel : public juce::MenuBarModel
146  {
147  MainMenuModel();
148  juce::StringArray getMenuBarNames();
149  juce::PopupMenu getMenuForIndex(int topLevelMenuIndex, const juce::String& menuName);
150  void menuItemSelected(int menuItemID, int topLevelMenuIndex);
151  };
152 
154  juce::StringArray getMenuNames();
155 
157  void createMenu (juce::PopupMenu& menu, const juce::String& menuName);
158 
160  void createOpenRecentPatchersMenu(juce::PopupMenu& menu);
161  void createFileMenu(juce::PopupMenu& menu);
162  void createEditMenu(juce::PopupMenu& menu);
163  void createViewMenu(juce::PopupMenu& menu);
164  void createOptionsMenu(juce::PopupMenu& menu);
165  void createWindowMenu(juce::PopupMenu& menu);
166  void createHelpMenu(juce::PopupMenu& menu);
167 
169  void handleMainMenuCommand(int menuItemID);
170 
171  // ================================================================================ //
172  // APPLICATION COMMAND //
173  // ================================================================================ //
174 
179  static void bindToCommandManager(ApplicationCommandTarget* target);
180 
182  static void bindToKeyMapping(juce::Component* target);
183 
185  static juce::ApplicationCommandManager& getCommandManager();
186 
188  static void commandStatusChanged();
189 
191  static juce::KeyPressMappingSet* getKeyMappings();
192 
194  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
195 
197  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
198 
200  bool perform(InvocationInfo const& info) override;
201 
202  public: // internal methods
203 
204  KiwiApp() = default;
205  ~KiwiApp() = default;
206 
207  private: // methods
208 
210  class AsyncQuitRetrier;
211 
212  private: // members
213 
214  std::unique_ptr<Instance> m_instance;
215  std::unique_ptr<juce::ApplicationCommandManager> m_command_manager;
216  std::unique_ptr<MainMenuModel> m_menu_model;
217  std::thread m_engine_thread;
218  std::atomic<bool> m_quit_requested;
219 
220  LookAndFeel m_looknfeel;
221  TooltipWindow m_tooltip_window;
222  std::unique_ptr<StoredSettings> m_settings;
223  };
224 }
kiwi::KiwiApp::AsyncQuitRetrier
Definition: KiwiApp.cpp:59
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_basics/juce_gui_basics.h>
25 
26 #include "KiwiApp_Application/KiwiApp_Instance.h"
27 #include "KiwiApp_General/KiwiApp_StoredSettings.h"
28 #include "KiwiApp_General/KiwiApp_LookAndFeel.h"
29 
30 #include "KiwiApp_Components/KiwiApp_TooltipWindow.h"
31 
32 #include "KiwiApp_Network/KiwiApp_ApiController.h"
33 
34 namespace ProjectInfo
35 {
36  const char* const projectName = "Kiwi";
37  const char* const versionString = "v1.0.0-beta";
38  const int versionNumber = 0x010;
39 }
40 
41 namespace kiwi
42 {
43  // ================================================================================ //
44  // KiWi APPLICATION //
45  // ================================================================================ //
46 
47  class KiwiApp : public juce::JUCEApplication,
48  public NetworkSettings::Listener,
49  public juce::Timer
50  {
51  public: // methods
52 
53  // ================================================================================ //
54  // JUCEApplication //
55  // ================================================================================ //
56 
58  void initialise(juce::String const& commandLine) override;
59 
61  void anotherInstanceStarted(juce::String const& command_line) override;
62 
64  void shutdown() override;
65 
67  void systemRequestedQuit() override;
68 
70  const juce::String getApplicationName() override;
71 
73  const juce::String getApplicationVersion() override;
74 
76  bool moreThanOneInstanceAllowed() override;
77 
79  void timerCallback() override final;
80 
82  static bool isMacOSX();
83 
85  static bool isLinux();
86 
88  static bool isWindows();
89 
90  //==============================================================================
91 
93  static KiwiApp& use();
94 
96  static KiwiApp* getApp();
97 
99  static Instance& useInstance();
100 
102  static Api& useApi();
103 
105  static tool::Scheduler<>& useScheduler();
106 
108  static void setAuthUser(Api::AuthUser const& auth_user);
109 
111  static Api::AuthUser const& getCurrentUser();
112 
114  static void logout();
115 
117  static engine::Instance& useEngineInstance();
118 
120  static uint64_t userID();
121 
123  static StoredSettings& useSettings();
124 
126  static juce::MenuBarModel* getMenuBarModel();
127 
129  static LookAndFeel& useLookAndFeel();
130 
132  static TooltipWindow& useTooltipWindow();
133 
134  // ================================================================================ //
135  // CONSOLE //
136  // ================================================================================ //
137 
139  static void log(std::string const& text);
140 
142  static void post(std::string const& text);
143 
145  static void warning(std::string const& text);
146 
148  static void error(std::string const& text);
149 
150  //==============================================================================
151 
153  void closeWindow(Window& window);
154 
155  // ================================================================================ //
156  // APPLICATION MENU //
157  // ================================================================================ //
158 
160  struct MainMenuModel : public juce::MenuBarModel
161  {
162  MainMenuModel();
163  juce::StringArray getMenuBarNames();
164  juce::PopupMenu getMenuForIndex(int topLevelMenuIndex, const juce::String& menuName);
165  void menuItemSelected(int menuItemID, int topLevelMenuIndex);
166  };
167 
169  juce::StringArray getMenuNames();
170 
172  void createMenu (juce::PopupMenu& menu, const juce::String& menuName);
173 
175  void createOpenRecentPatchersMenu(juce::PopupMenu& menu);
176  void createAccountMenu(juce::PopupMenu& menu);
177  void createFileMenu(juce::PopupMenu& menu);
178  void createEditMenu(juce::PopupMenu& menu);
179  void createViewMenu(juce::PopupMenu& menu);
180  void createOptionsMenu(juce::PopupMenu& menu);
181  void createWindowMenu(juce::PopupMenu& menu);
182  void createHelpMenu(juce::PopupMenu& menu);
183 
185  void handleMainMenuCommand(int menuItemID);
186 
187  // ================================================================================ //
188  // APPLICATION COMMAND //
189  // ================================================================================ //
190 
195  static void bindToCommandManager(ApplicationCommandTarget* target);
196 
198  static void bindToKeyMapping(juce::Component* target);
199 
201  static juce::ApplicationCommandManager& getCommandManager();
202 
204  static void commandStatusChanged();
205 
207  static juce::KeyPressMappingSet* getKeyMappings();
208 
210  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
211 
213  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
214 
216  bool perform(InvocationInfo const& info) override;
217 
218  public: // internal methods
219 
220  KiwiApp() = default;
221  ~KiwiApp() = default;
222 
223  private: // methods
224 
226  class AsyncQuitRetrier;
227 
229  void declareEngineObjects();
230 
232  void declareObjectViews();
233 
235  void checkLatestRelease();
236 
237  // @brief Handles changes of server address.
238  void networkSettingsChanged(NetworkSettings const& settings, juce::Identifier const& ids) override final;
239 
241  void openCommandFile(juce::String const& command_line);
242 
243  private: // members
244 
245  std::unique_ptr<ApiController> m_api_controller;
246  std::unique_ptr<Api> m_api;
247 
248  std::unique_ptr<Instance> m_instance;
249  std::unique_ptr<juce::ApplicationCommandManager> m_command_manager;
250  std::unique_ptr<MainMenuModel> m_menu_model;
251 
252  LookAndFeel m_looknfeel;
253  TooltipWindow m_tooltip_window;
254  std::unique_ptr<StoredSettings> m_settings;
255  std::unique_ptr<tool::Scheduler<>> m_scheduler;
256  };
257 }
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::NetworkSettings
Definition: KiwiApp_StoredSettings.h:38
+
kiwi::closeWindow
Close the current window.
Definition: KiwiApp_CommandIDs.h:41
+
kiwi::KiwiApp::AsyncQuitRetrier
Definition: KiwiApp.cpp:65
+
kiwi::Api::AuthUser
Definition: KiwiApp_Api.h:302
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::TooltipWindow
A custom TooltipWindow.
Definition: KiwiApp_TooltipWindow.h:61
-
kiwi::Instance
The Application Instance.
Definition: KiwiApp_Instance.h:46
-
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:42
+
kiwi::logout
Log-out the user.
Definition: KiwiApp_CommandIDs.h:94
+
kiwi::Instance
The Application Instance.
Definition: KiwiApp_Instance.h:50
+
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:46
kiwi::LookAndFeel
Definition: KiwiApp_LookAndFeel.h:28
-
ProjectInfo
Definition: KiwiApp.h:36
-
kiwi::KiwiApp::MainMenuModel
The Kiwi Application menu model class.
Definition: KiwiApp.h:145
-
kiwi::StoredSettings
Settings storage class utility.
Definition: KiwiApp_StoredSettings.h:115
-
kiwi::KiwiApp
Definition: KiwiApp.h:49
+
ProjectInfo
Definition: KiwiApp.h:34
+
kiwi::KiwiApp::MainMenuModel
The Kiwi Application menu model class.
Definition: KiwiApp.h:160
+
kiwi::StoredSettings
Settings storage class utility.
Definition: KiwiApp_StoredSettings.h:116
+
kiwi::NetworkSettings::Listener
NetworkSettings Listener.
Definition: KiwiApp_StoredSettings.h:77
+
kiwi::KiwiApp
Definition: KiwiApp.h:47
+
kiwi::Api
A remote API request handler.
Definition: KiwiApp_Api.h:43
kiwi::Window
Common interface for all windows held by the application.
Definition: KiwiApp_Window.h:33
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___about_window_8h_source.html b/docs/html/_kiwi_app___about_window_8h_source.html index 2d686647..7f89355f 100644 --- a/docs/html/_kiwi_app___about_window_8h_source.html +++ b/docs/html/_kiwi_app___about_window_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Application/KiwiApp_AboutWindow.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + + - + - - - - + +
KiwiApp_Api.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <cpr/cpr.h>
25 
26 #include <json.hpp>
27 using nlohmann::json;
28 
29 namespace kiwi
30 {
31  // ================================================================================ //
32  // API //
33  // ================================================================================ //
34 
36  class Api
37  {
38  public: // methods
39 
40  enum class Protocol : uint8_t { HTTP = 0, HTTPS = 1 };
41 
42  struct Document
43  {
44  std::string _id = "0";
45  std::string name = "";
46  uint64_t session_id = 0ul;
47 
49  bool operator==(Document const& other_doc) const;
50  };
51 
52  using Documents = std::vector<Api::Document>;
53 
54  class User;
55 
56  using Response = cpr::Response;
57 
59  Api(std::string const& host, uint16_t port = 80, Protocol protocol = Api::Protocol::HTTP);
60 
62  ~Api();
63 
65  std::string getProtocolStr() const;
66 
68  std::string getApiRootUrl() const;
69 
71  void setHost(std::string const& host);
72 
74  std::string const& getHost() const;
75 
77  void setPort(uint16_t port) noexcept;
78 
80  uint16_t getPort() const noexcept;
81 
83  void getDocuments(std::function<void(Api::Response res, Api::Documents)> callback);
84 
87  void createDocument(std::function<void(Api::Response res, Api::Document)> callback,
88  std::string const& document_name = "");
89 
92  void renameDocument(std::function<void(Api::Response res)> callback,
93  std::string document_id, std::string const& new_name);
94 
95  private: // methods
96 
98  void storeRequest(std::future<void> && future);
99 
101  static bool hasJsonHeader(Api::Response const& res);
102 
103  private: // variables
104 
105  Protocol m_protocol;
106  std::string m_host;
107  uint16_t m_port;
108 
109  std::vector<std::future<void>> m_pending_requests;
110  };
111 
113  void to_json(json& j, Api::Document const& doc);
114 
116  void from_json(json const& j, Api::Document& doc);
117 }
kiwi::Api::getApiRootUrl
std::string getApiRootUrl() const
Get the API root URL.
Definition: KiwiApp_Api.cpp:99
-
kiwi::Api::createDocument
void createDocument(std::function< void(Api::Response res, Api::Document)> callback, std::string const &document_name="")
Make an async API request to create a new document.
Definition: KiwiApp_Api.cpp:144
-
kiwi::Api::setPort
void setPort(uint16_t port) noexcept
Set the API port.
Definition: KiwiApp_Api.cpp:84
-
kiwi::Api::getPort
uint16_t getPort() const noexcept
Get the API port.
Definition: KiwiApp_Api.cpp:89
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <unordered_set>
25 #include <set>
26 
27 #include <KiwiNetwork/KiwiNetwork_Http.h>
28 
29 #include <json.hpp>
30 
31 namespace kiwi
32 {
33  using nlohmann::json;
34  using namespace network;
35 
36  // ================================================================================ //
37  // API //
38  // ================================================================================ //
39 
43  class Api
44  {
45  public: // methods
46 
47  class Controller;
48 
49  using Session = network::http::Session;
50  using Response = Session::Response;
51  class Error;
52 
53  template<class Type>
54  using CallbackFn = std::function<void(Type)>;
55 
56  using Callback = CallbackFn<Session::Response>;
57  using ErrorCallback = CallbackFn<Api::Error>;
58 
59  class User;
60  class AuthUser;
61  class Folder;
62  class Document;
63 
64  using Documents = std::vector<Api::Document>;
65  using Users = std::vector<Api::User>;
66 
67  public: // methods
68 
70  Api(Api::Controller& controller);
71 
73  ~Api();
74 
76  void cancelRequest(uint64_t request_id);
77 
79  bool isPending(uint64_t request_id);
80 
82  void cancelAll();
83 
84  public: // requests
85 
89  uint64_t login(std::string const& username_or_email,
90  std::string const& password,
91  CallbackFn<AuthUser> success_cb,
92  ErrorCallback error_cb);
93 
98  uint64_t signup(std::string const& username,
99  std::string const& email,
100  std::string const& password,
101  CallbackFn<std::string> success_cb,
102  ErrorCallback error_cb);
103 
105  uint64_t getUsers(std::unordered_set<uint64_t> const& user_ids, CallbackFn<Api::Users> sucess_cb, ErrorCallback error_cb);
106 
108  uint64_t getDocuments(std::function<void(Response, Api::Documents)> callback);
109 
112  uint64_t createDocument(std::string const& document_name,
113  std::function<void(Response, Api::Document)> callback);
114 
116  uint64_t uploadDocument(std::string const& name,
117  std::string const& data,
118  std::string const& kiwi_version,
119  std::function<void(Response, Api::Document)> callback);
120 
122  uint64_t duplicateDocument(std::string const& document_id, Callback callback);
123 
126  uint64_t renameDocument(std::string document_id,
127  std::string const& new_name,
128  Callback callback);
129 
131  uint64_t trashDocument(std::string document_id, Callback callback);
132 
134  uint64_t untrashDocument(std::string document_id, Callback callback);
135 
137  uint64_t getOpenToken(std::string document_id,
138  CallbackFn<std::string const&> success_cb,
139  ErrorCallback error_cb);
140 
142  uint64_t downloadDocument(std::string document_id, Callback success_cb);
143 
145  uint64_t getRelease(CallbackFn<std::string const&> success_cb, ErrorCallback error_cb);
146 
148  uint64_t requestPasswordToken(std::string const& user_mail, CallbackFn<std::string const&> success_cb, ErrorCallback error_cb);
149 
151  uint64_t resetPassword(std::string const& token,
152  std::string const& newpass,
153  CallbackFn<std::string const&> success_cb,
154  ErrorCallback error_cb);
155 
156  public: // helper methods
157 
158  template<class Type>
159  static Type getJsonValue(json const& json, std::string const& key, Type default_value = {})
160  {
161  return json.count(key) ? json.at(key).get<Type>() : default_value;
162  }
163 
166  static std::string convertDate(std::string const& date);
167 
168  private: // methods
169 
171  struct Endpoint
172  {
173  static const std::string root;
174  static const std::string login;
175  static const std::string documents;
176  static const std::string users;
177  static const std::string release;
178 
179  static std::string document(std::string const& document_id);
180  static std::string user(std::string const& user_id);
181  };
182 
184  std::unique_ptr<Session> makeSession(std::string const& endpoint, bool add_auth = true);
185 
187  uint64_t storeSession(std::unique_ptr<Session> session);
188 
190  static bool hasJsonHeader(Response const& res);
191 
192  private: // helper functions
193 
194  struct comp_session
195  {
196  bool operator() (std::unique_ptr<Session> const& lhs,
197  std::unique_ptr<Session> const& rhs)
198  {
199  return lhs->getId() < rhs->getId();
200  }
201  };
202 
203  private: // variables
204 
205  Api::Controller& m_controller;
206  std::set<std::unique_ptr<Session>, comp_session> m_requests;
207 
208  private: // deleted methods
209 
210  Api() = delete;
211  Api(Api const&) = delete;
212  Api(Api &&) = delete;
213  Api& operator=(Api const&) = delete;
214  Api& operator=(Api &&) = delete;
215  };
216 
217  // ================================================================================ //
218  // API ERROR //
219  // ================================================================================ //
220 
221  class Api::Error
222  {
223  public: // methods
224 
225  Error();
226 
227  Error(unsigned status_code, std::string const& message);
228 
229  Error(Api::Response const& response);
230 
231  ~Error() = default;
232 
233  unsigned getStatusCode() const;
234 
235  std::string const& getMessage() const;
236 
237  private: // members
238 
239  unsigned m_status_code;
240  std::string m_message {};
241  };
242 
243  // ================================================================================ //
244  // API USER //
245  // ================================================================================ //
246 
247  class Api::User
248  {
249  public: // methods
250 
252  User() = default;
253 
254  virtual ~User() = default;
255 
257  //User& operator = (User && user);
258 
260  std::string const& getName() const;
261 
263  std::string const& getEmail() const;
264 
266  std::string const& getIdAsString() const;
267 
269  uint64_t getIdAsInt() const;
270 
272  int getApiVersion() const;
273 
275  bool isValid() const noexcept;
276 
277  void resetWith(User const& other);
278 
279  private: // variables
280 
281  friend void from_json(json const&, Api::User&);
282 
283  int m_api_version = 0;
284  std::string m_id {};
285  std::string m_name {};
286  std::string m_email {};
287 
288  //uint64_t m_int_id = 0ull;
289  //bool m_int_id_need_update_flag = true;
290  };
291 
293  void to_json(json& j, Api::User const& user);
294 
296  void from_json(json const& j, Api::User& user);
297 
298  // ================================================================================ //
299  // API AUTH USER //
300  // ================================================================================ //
301 
302  class Api::AuthUser : public Api::User
303  {
304  public: // methods
305 
306  AuthUser() = default;
307 
308  AuthUser(User const& other);
309 
310  AuthUser(AuthUser const& other);
311 
312  AuthUser(AuthUser && other);
313 
314  ~AuthUser() = default;
315 
316  void resetWith(AuthUser const& other);
317 
320  bool isLoggedIn() const;
321 
324  std::string const& getToken() const;
325 
326  private: // variables
327 
328  friend void from_json(json const&, Api::AuthUser&);
329 
330  friend Api::Controller;
331 
332  std::string m_token {};
333  };
334 
336  void to_json(json& j, Api::AuthUser const& user);
337 
339  void from_json(json const& j, Api::AuthUser& user);
340 
341  // ================================================================================ //
342  // API DOCUMENT //
343  // ================================================================================ //
344 
345  class Api::Document
346  {
347  public:
348 
349  Document() = default;
350 
351  std::string _id = "0";
352  std::string name = "";
353  std::string author_name = "";
354  std::string creation_date = "";
355  bool trashed = false;
356  std::string trashed_date = "";
357  std::string opened_date = "";
358  std::string opened_user = "";
359  uint64_t session_id = 0ul;
360 
362  bool operator==(Document const& other_doc) const;
363  };
364 
366  void to_json(json& j, Api::Document const& doc);
367 
369  void from_json(json const& j, Api::Document& doc);
370 
371  // ================================================================================ //
372  // API CONTROLLER //
373  // ================================================================================ //
374 
375  class Api::Controller
376  {
377  public: // methods
378 
380  Controller();
381 
385  Controller(std::string const& remote_host, uint16_t remote_port);
386 
387  virtual ~Controller() = default;
388 
390  void setHost(std::string const& host);
391 
393  std::string const& getHost() const;
394 
396  void setPort(uint16_t port) noexcept;
397 
399  uint16_t getPort() const noexcept;
400 
403  bool isUserLoggedIn() const;
404 
406  Api::AuthUser const& getAuthUser() const;
407 
408  protected: // methods
409 
414  virtual void clearToken();
415 
416  protected: // variables
417 
418  std::string m_host;
419  uint16_t m_port;
420  Api::AuthUser m_auth_user;
421  };
422 }
kiwi::network::http::Session
Definition: KiwiHttp_Session.h:95
+
kiwi::signup
Register the user.
Definition: KiwiApp_CommandIDs.h:93
+
kiwi::to_json
void to_json(json &j, Api::User const &user)
Helper function to convert an Api::User into a json object.
Definition: KiwiApp_Api.cpp:669
+
kiwi::Api::Controller
Definition: KiwiApp_Api.h:375
+
kiwi::Api::AuthUser
Definition: KiwiApp_Api.h:302
+
kiwi::from_json
void from_json(json const &j, Api::User &user)
Helper function to convert a json object into an Api::User.
Definition: KiwiApp_Api.cpp:679
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::Api::getHost
std::string const & getHost() const
Get the API host.
Definition: KiwiApp_Api.cpp:79
-
kiwi::Api::setHost
void setHost(std::string const &host)
Set the API host.
Definition: KiwiApp_Api.cpp:74
-
kiwi::Api::getDocuments
void getDocuments(std::function< void(Api::Response res, Api::Documents)> callback)
Make an async API request to get a list of documents.
Definition: KiwiApp_Api.cpp:113
-
kiwi::Api::renameDocument
void renameDocument(std::function< void(Api::Response res)> callback, std::string document_id, std::string const &new_name)
Rename a document asynchronously.
Definition: KiwiApp_Api.cpp:184
-
kiwi::Api::Api
Api(std::string const &host, uint16_t port=80, Protocol protocol=Api::Protocol::HTTP)
Constructor.
Definition: KiwiApp_Api.cpp:60
-
kiwi::Api::Document
Definition: KiwiApp_Api.h:42
-
kiwi::Api::getProtocolStr
std::string getProtocolStr() const
Get the API protocol as a string.
Definition: KiwiApp_Api.cpp:94
-
kiwi::Api
An API request handler class.
Definition: KiwiApp_Api.h:36
-
kiwi::Api::~Api
~Api()
Destructor.
Definition: KiwiApp_Api.cpp:69
+
kiwi::network::http::Response
Definition: KiwiHttp.h:49
+
kiwi::Api::Error
Definition: KiwiApp_Api.h:221
+
kiwi::Api::Document
Definition: KiwiApp_Api.h:345
+
kiwi::Api::User
Definition: KiwiApp_Api.h:247
+
kiwi::login
Log-in the user.
Definition: KiwiApp_CommandIDs.h:92
+
kiwi::Api
A remote API request handler.
Definition: KiwiApp_Api.h:43
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___api_controller_8h_source.html b/docs/html/_kiwi_app___api_controller_8h_source.html new file mode 100644 index 00000000..feed39ef --- /dev/null +++ b/docs/html/_kiwi_app___api_controller_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Network/KiwiApp_ApiController.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_ApiController.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Listeners.h>
25 
26 #include "../KiwiApp_Network/KiwiApp_Api.h"
27 #include "../KiwiApp_General/KiwiApp_StoredSettings.h"
28 
29 namespace kiwi
30 {
31 
32  class ApiController
33  : public Api::Controller
34  {
35  public: // methods
36 
38  ApiController();
39 
43  ~ApiController();
44 
48  void setAuthUser(Api::AuthUser const& auth_user);
49 
52  void logout();
53 
54  private: // methods
55 
56  bool saveAuthUserProfile() const;
57  bool restoreAuthUserProfile();
58  };
59 }
kiwi::ApiController
Definition: KiwiApp_ApiController.h:32
+
kiwi::Api::Controller
Definition: KiwiApp_Api.h:375
+
kiwi::Api::AuthUser
Definition: KiwiApp_Api.h:302
+
kiwi::ApiController::~ApiController
~ApiController()
Destructor.
Definition: KiwiApp_ApiController.cpp:40
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::ApiController::logout
void logout()
Log-out the user.
Definition: KiwiApp_ApiController.cpp:74
+
kiwi::ApiController::ApiController
ApiController()
Constructor.
Definition: KiwiApp_ApiController.cpp:30
+
kiwi::ApiController::setAuthUser
void setAuthUser(Api::AuthUser const &auth_user)
Changes the API&#39;s authenticated user.
Definition: KiwiApp_ApiController.cpp:69
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___auth_panel_8h_source.html b/docs/html/_kiwi_app___auth_panel_8h_source.html new file mode 100644 index 00000000..76e29ae9 --- /dev/null +++ b/docs/html/_kiwi_app___auth_panel_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_AuthPanel.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiApp_Components/KiwiApp_FormComponent.h>
25 
26 #include <KiwiApp_Network/KiwiApp_Api.h>
27 
28 namespace kiwi
29 {
30  // ================================================================================ //
31  // LOGIN FORM //
32  // ================================================================================ //
33 
34  class LoginForm : public FormComponent
35  {
36  private: // classes
37 
38  enum class State
39  {
40  Login,
41  Request,
42  Reset
43  };
44 
45  public: // methods
46 
49  LoginForm();
50 
52  ~LoginForm() = default;
53 
54  private: // methods
55 
57  void performLogin();
58 
60  void performPassReset();
61 
63  void performPassRequest();
64 
66  void onUserSubmit() override;
67 
69  void onUserCancelled() override;
70 
72  void setState(State state);
73 
74  private: // members
75 
76  State m_state;
77 
78  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(LoginForm)
79  };
80 
81  // ================================================================================ //
82  // SIGNUP FORM //
83  // ================================================================================ //
84 
85  class SignUpForm : public FormComponent
86  {
87  public: // methods
88 
91  SignUpForm();
92 
94  ~SignUpForm() = default;
95 
96  private: // methods
97 
98  void onUserSubmit() override;
99 
100  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(SignUpForm)
101  };
102 
103  // ================================================================================ //
104  // AUTH PANEL //
105  // ================================================================================ //
106 
107  class AuthPanel
108  : public juce::TabbedComponent
109  , public juce::ComponentListener
110  {
111  public: // methods
112 
113  enum FormType
114  {
115  Login = 0,
116  SignUp,
117  UserProfile,
118  None,
119  };
120 
121  AuthPanel(FormType form_type = FormType::None);
122 
123  ~AuthPanel();
124 
125  private: // methods
126 
127  void updateSize(FormType type);
128 
130  void currentTabChanged(int new_tab_index, juce::String const& new_tab_name) override;
131 
132  void componentMovedOrResized(juce::Component& component,
133  bool wasMoved,
134  bool wasResized) override;
135 
136  private: // variables
137 
138  LoginForm m_login_form;
139  SignUpForm m_signup_form;
140  };
141 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::LoginForm::~LoginForm
~LoginForm()=default
Destructor.
+
kiwi::FormComponent
Definition: KiwiApp_FormComponent.h:75
+
kiwi::LoginForm::LoginForm
LoginForm()
Constructor.
Definition: KiwiApp_AuthPanel.cpp:33
+
kiwi::LoginForm
Definition: KiwiApp_AuthPanel.h:34
+
kiwi::SignUpForm
Definition: KiwiApp_AuthPanel.h:85
+
kiwi::AuthPanel
Definition: KiwiApp_AuthPanel.h:107
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___bang_view_8h_source.html b/docs/html/_kiwi_app___bang_view_8h_source.html new file mode 100644 index 00000000..68e0fc1a --- /dev/null +++ b/docs/html/_kiwi_app___bang_view_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_BangView.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <memory>
25 
26 #include <juce_graphics/juce_graphics.h>
27 
28 #include <KiwiModel/KiwiModel_Object.h>
29 
30 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h>
31 
32 namespace kiwi {
33 
34  // ================================================================================ //
35  // BANG VIEW //
36  // ================================================================================ //
37 
38  class BangView : public ObjectView
39  {
40  public: // methods
41 
42  static void declare();
43 
44  static std::unique_ptr<ObjectView> create(model::Object & model);
45 
46  BangView(model::Object & object_model);
47 
48  ~BangView();
49 
50  private: // methods
51 
52  void paint(juce::Graphics & g) override final;
53 
54  void mouseDown(juce::MouseEvent const& e) override final;
55 
56  void mouseUp(juce::MouseEvent const& e) override final;
57 
58  void flash();
59 
60  void signalTriggered();
61 
62  private: // members
63 
65  flip::Signal<>& m_signal;
66  flip::SignalConnection m_connection;
67  bool m_active;
68  bool m_mouse_down;
69 
70  private: // deleted methods
71 
72  BangView() = delete;
73  BangView(BangView const& other) = delete;
74  BangView(BangView && other) = delete;
75  BangView& operator=(BangView const& other) = delete;
76  BangView& operator=(BangView && other) = delete;
77  };
78 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::BangView
Definition: KiwiApp_BangView.h:38
+
kiwi::ObjectView
Abstract for objects graphical representation.
Definition: KiwiApp_ObjectView.h:42
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___beacon_dispatcher_8h_source.html b/docs/html/_kiwi_app___beacon_dispatcher_8h_source.html index abf8bfdb..c77e44c5 100644 --- a/docs/html/_kiwi_app___beacon_dispatcher_8h_source.html +++ b/docs/html/_kiwi_app___beacon_dispatcher_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Application/KiwiApp_BeaconDispatcher.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_BeaconDispatcher.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Instance.h>
25 
26 #include "../KiwiApp_Components/KiwiApp_Window.h"
27 
28 namespace kiwi
29 {
30  class BeaconDispatcher;
31 
32  // ================================================================================ //
33  // BEACON DISPATCHER //
34  // ================================================================================ //
35 
37  class BeaconDispatcherElem : public juce::Component, public juce::Button::Listener, juce::Slider::Listener
38  {
39  public: // methods
40 
42  BeaconDispatcherElem(engine::Instance& instance);
43 
45  ~BeaconDispatcherElem();
46 
48  void resized() override;
49 
51  void paint(juce::Graphics& g) override;
52 
54  void buttonClicked(juce::Button*) override;
55 
57  void setBackgroundColor(juce::Colour const& color);
58 
59  void restoreState(juce::XmlElement* saved_state);
60 
61  void saveState(juce::XmlElement* saved_state);
62 
63  private: // methods
64 
65  class TextValueComponent : public juce::Component, public juce::Button::Listener
66  {
67  public:
68  TextValueComponent(BeaconDispatcherElem& owner);
69  ~TextValueComponent();
70 
71  void buttonClicked(juce::Button*) override;
72  void resized() override;
73 
74  private:
75  BeaconDispatcherElem& m_owner;
76  juce::TextEditor m_message_editor;
77  juce::TextButton m_send_button;
78  };
79 
81  void sendValue(std::vector<Atom> const& args) const;
82 
84  void send(std::string const& name, std::vector<Atom> const& args) const;
85 
87  void sliderValueChanged(juce::Slider* slider) override;
88 
89  private: // members
90 
91  engine::Instance& m_instance;
92  juce::TextEditor m_beacon_name_editor;
93  TextValueComponent m_text_value;
94  juce::Slider m_message_slider;
95  juce::ToggleButton m_toggle_value;
96  juce::TabbedComponent m_message_tab;
97 
98  juce::Colour m_bgcolor;
99  };
100 
101  // ================================================================================ //
102  // CONSOLE TOOLBAR //
103  // ================================================================================ //
104 
105  class BeaconDispatcherToolbarFactory : public juce::ToolbarItemFactory
106  {
107  public: // methods
108 
110  BeaconDispatcherToolbarFactory();
111 
112  enum ItemIds
113  {
114  addItem = 1,
115  removeItem = 2,
116  };
117 
118  void getAllToolbarItemIds(juce::Array<int>& ids) override;
119  void getDefaultItemSet(juce::Array<int>& ids) override;
120 
121  juce::ToolbarItemComponent* createItem(int itemId) override;
122  };
123 
124  // ================================================================================ //
125  // BEACON DISPATCHER //
126  // ================================================================================ //
127 
128  class BeaconDispatcher : public juce::Component, public juce::ApplicationCommandTarget
129  {
130  public: // methods
131 
133  BeaconDispatcher(engine::Instance& instance);
134 
136  ~BeaconDispatcher();
137 
139  void resized() override;
140 
141  void addElem();
142 
143  void removeElem();
144 
145  bool restoreState();
146 
147  void saveState();
148 
149  // ================================================================================ //
150  // APPLICATION COMMAND TARGET //
151  // ================================================================================ //
152 
153  juce::ApplicationCommandTarget* getNextCommandTarget() override;
154  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
155  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
156  bool perform(const InvocationInfo& info) override;
157 
158  private: // variables
159 
160  void updateLayout();
161 
162  engine::Instance& m_instance;
163  std::vector<std::unique_ptr<BeaconDispatcherElem>> m_components;
164  juce::Toolbar m_toolbar;
165  BeaconDispatcherToolbarFactory m_toolbar_factory;
166  int m_elem_height = 100;
167  };
168 }
kiwi::BeaconDispatcherElem::resized
void resized() override
Called when resized.
Definition: KiwiApp_BeaconDispatcher.cpp:159
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Atom.h>
25 #include <KiwiEngine/KiwiEngine_Instance.h>
26 
27 #include "../KiwiApp_Components/KiwiApp_Window.h"
28 
29 namespace kiwi
30 {
31  class BeaconDispatcher;
32 
33  // ================================================================================ //
34  // BEACON DISPATCHER //
35  // ================================================================================ //
36 
38  class BeaconDispatcherElem : public juce::Component, public juce::Button::Listener, juce::Slider::Listener
39  {
40  public: // methods
41 
43  BeaconDispatcherElem(engine::Instance& instance);
44 
46  ~BeaconDispatcherElem();
47 
49  void resized() override;
50 
52  void paint(juce::Graphics& g) override;
53 
55  void buttonClicked(juce::Button*) override;
56 
58  void setBackgroundColor(juce::Colour const& color);
59 
60  void restoreState(juce::XmlElement* saved_state);
61 
62  void saveState(juce::XmlElement* saved_state);
63 
64  private: // methods
65 
66  class TextValueComponent : public juce::Component, public juce::Button::Listener
67  {
68  public:
69  TextValueComponent(BeaconDispatcherElem& owner);
70  ~TextValueComponent();
71 
72  void buttonClicked(juce::Button*) override;
73  void resized() override;
74 
75  private:
76  BeaconDispatcherElem& m_owner;
77  juce::TextEditor m_message_editor;
78  juce::TextButton m_send_button;
79  };
80 
82  void sendValue(std::vector<tool::Atom> const& args) const;
83 
85  void send(std::string const& name, std::vector<tool::Atom> const& args) const;
86 
88  void sliderValueChanged(juce::Slider* slider) override;
89 
90  private: // members
91 
92  engine::Instance& m_instance;
93  juce::TextEditor m_beacon_name_editor;
94  TextValueComponent m_text_value;
95  juce::Slider m_message_slider;
96  juce::ToggleButton m_toggle_value;
97  juce::TabbedComponent m_message_tab;
98 
99  juce::Colour m_bgcolor;
100  };
101 
102  // ================================================================================ //
103  // CONSOLE TOOLBAR //
104  // ================================================================================ //
105 
106  class BeaconDispatcherToolbarFactory : public juce::ToolbarItemFactory
107  {
108  public: // methods
109 
111  BeaconDispatcherToolbarFactory();
112 
113  enum ItemIds
114  {
115  addItem = 1,
116  removeItem = 2,
117  };
118 
119  void getAllToolbarItemIds(juce::Array<int>& ids) override;
120  void getDefaultItemSet(juce::Array<int>& ids) override;
121 
122  juce::ToolbarItemComponent* createItem(int itemId) override;
123  };
124 
125  // ================================================================================ //
126  // BEACON DISPATCHER //
127  // ================================================================================ //
128 
129  class BeaconDispatcher : public juce::Component, public juce::ApplicationCommandTarget
130  {
131  public: // methods
132 
134  BeaconDispatcher(engine::Instance& instance);
135 
137  ~BeaconDispatcher();
138 
140  void resized() override;
141 
142  void addElem();
143 
144  void removeElem();
145 
146  bool restoreState();
147 
148  void saveState();
149 
150  // ================================================================================ //
151  // APPLICATION COMMAND TARGET //
152  // ================================================================================ //
153 
154  juce::ApplicationCommandTarget* getNextCommandTarget() override;
155  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
156  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
157  bool perform(const InvocationInfo& info) override;
158 
159  private: // variables
160 
161  void updateLayout();
162 
163  engine::Instance& m_instance;
164  std::vector<std::unique_ptr<BeaconDispatcherElem>> m_components;
165  juce::Toolbar m_toolbar;
166  BeaconDispatcherToolbarFactory m_toolbar_factory;
167  int m_elem_height = 100;
168  };
169 }
kiwi::BeaconDispatcherElem::resized
void resized() override
Called when resized.
Definition: KiwiApp_BeaconDispatcher.cpp:159
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::BeaconDispatcher
Definition: KiwiApp_BeaconDispatcher.h:128
+
kiwi::BeaconDispatcher
Definition: KiwiApp_BeaconDispatcher.h:129
kiwi::BeaconDispatcherElem::setBackgroundColor
void setBackgroundColor(juce::Colour const &color)
Set the background colour.
Definition: KiwiApp_BeaconDispatcher.cpp:146
kiwi::BeaconDispatcherElem::paint
void paint(juce::Graphics &g) override
juce::Component.
Definition: KiwiApp_BeaconDispatcher.cpp:154
-
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:42
+
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:46
kiwi::BeaconDispatcherElem::~BeaconDispatcherElem
~BeaconDispatcherElem()
Destructor.
Definition: KiwiApp_BeaconDispatcher.cpp:115
-
kiwi::BeaconDispatcherElem
A Component that allows to dispatch messages to Beacon::Castaway objects.
Definition: KiwiApp_BeaconDispatcher.h:37
-
kiwi::BeaconDispatcherToolbarFactory
Definition: KiwiApp_BeaconDispatcher.h:105
+
kiwi::BeaconDispatcherElem
A Component that allows to dispatch messages to Beacon::Castaway objects.
Definition: KiwiApp_BeaconDispatcher.h:38
+
kiwi::BeaconDispatcherToolbarFactory
Definition: KiwiApp_BeaconDispatcher.h:106
kiwi::BeaconDispatcherElem::BeaconDispatcherElem
BeaconDispatcherElem(engine::Instance &instance)
Constructor.
Definition: KiwiApp_BeaconDispatcher.cpp:78
kiwi::BeaconDispatcherElem::buttonClicked
void buttonClicked(juce::Button *) override
Called when the button is clicked.
Definition: KiwiApp_BeaconDispatcher.cpp:180
@@ -82,7 +106,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___binary_data_8h_source.html b/docs/html/_kiwi_app___binary_data_8h_source.html index d6568ff0..d9be5274 100644 --- a/docs/html/_kiwi_app___binary_data_8h_source.html +++ b/docs/html/_kiwi_app___binary_data_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Ressources/KiwiApp_BinaryData.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_BinaryData.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 // ============================================================================
23 // This is an auto-generated file: Any edits you make may be overwritten!
24 // ============================================================================
25 
26 #pragma once
27 
28 namespace kiwi
29 {
30  namespace binary_data
31  {
32  namespace fonts
33  {
34  namespace open_sans
35  {
36  extern char const* OpenSans_Bold_ttf;
37  const int OpenSans_Bold_ttf_size = 224592;
38 
39  extern char const* OpenSans_BoldItalic_ttf;
40  const int OpenSans_BoldItalic_ttf_size = 213292;
41 
42  extern char const* OpenSans_ExtraBold_ttf;
43  const int OpenSans_ExtraBold_ttf_size = 222584;
44 
45  extern char const* OpenSans_ExtraBoldItalic_ttf;
46  const int OpenSans_ExtraBoldItalic_ttf_size = 213420;
47 
48  extern char const* OpenSans_Italic_ttf;
49  const int OpenSans_Italic_ttf_size = 212896;
50 
51  extern char const* OpenSans_Light_ttf;
52  const int OpenSans_Light_ttf_size = 222412;
53 
54  extern char const* OpenSans_LightItalic_ttf;
55  const int OpenSans_LightItalic_ttf_size = 213128;
56 
57  extern char const* OpenSans_Regular_ttf;
58  const int OpenSans_Regular_ttf_size = 217360;
59 
60  extern char const* OpenSans_Semibold_ttf;
61  const int OpenSans_Semibold_ttf_size = 221328;
62 
63  extern char const* OpenSans_SemiboldItalic_ttf;
64  const int OpenSans_SemiboldItalic_ttf_size = 212820;
65 
66  }
67  }
68  namespace images
69  {
70  extern char const* arrow_down_png;
71  const int arrow_down_png_size = 1647;
72 
73  extern char const* arrow_up_png;
74  const int arrow_up_png_size = 1635;
75 
76  extern char const* dsp_off_png;
77  const int dsp_off_png_size = 12813;
78 
79  extern char const* dsp_on_png;
80  const int dsp_on_png_size = 16455;
81 
82  extern char const* folder_png;
83  const int folder_png_size = 2557;
84 
85  extern char const* kiwi_filetype_png;
86  const int kiwi_filetype_png_size = 40975;
87 
88  extern char const* kiwi_icon_png;
89  const int kiwi_icon_png_size = 24099;
90 
91  extern char const* locked_png;
92  const int locked_png_size = 6215;
93 
94  extern char const* minus_png;
95  const int minus_png_size = 5162;
96 
97  extern char const* open_png;
98  const int open_png_size = 1100;
99 
100  extern char const* plus_png;
101  const int plus_png_size = 6336;
102 
103  extern char const* refresh_png;
104  const int refresh_png_size = 15500;
105 
106  extern char const* trash_png;
107  const int trash_png_size = 6810;
108 
109  extern char const* unlocked_png;
110  const int unlocked_png_size = 6499;
111 
112  extern char const* users_png;
113  const int users_png_size = 8538;
114 
115  extern char const* zoom_in_png;
116  const int zoom_in_png_size = 14970;
117 
118  extern char const* zoom_out_png;
119  const int zoom_out_png_size = 14388;
120 
121  }
122  namespace settings
123  {
124  extern char const* network_settings;
125  const int network_settings_size = 135;
126 
127  }
128  }
129 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 // ============================================================================
23 // This is an auto-generated file: Any edits you make may be overwritten!
24 // ============================================================================
25 
26 #pragma once
27 
28 namespace kiwi
29 {
30  namespace binary_data
31  {
32  namespace fonts
33  {
34  namespace open_sans
35  {
36  extern char const* OpenSans_Bold_ttf;
37  const int OpenSans_Bold_ttf_size = 224592;
38 
39  extern char const* OpenSans_BoldItalic_ttf;
40  const int OpenSans_BoldItalic_ttf_size = 213292;
41 
42  extern char const* OpenSans_ExtraBold_ttf;
43  const int OpenSans_ExtraBold_ttf_size = 222584;
44 
45  extern char const* OpenSans_ExtraBoldItalic_ttf;
46  const int OpenSans_ExtraBoldItalic_ttf_size = 213420;
47 
48  extern char const* OpenSans_Italic_ttf;
49  const int OpenSans_Italic_ttf_size = 212896;
50 
51  extern char const* OpenSans_Light_ttf;
52  const int OpenSans_Light_ttf_size = 222412;
53 
54  extern char const* OpenSans_LightItalic_ttf;
55  const int OpenSans_LightItalic_ttf_size = 213128;
56 
57  extern char const* OpenSans_Regular_ttf;
58  const int OpenSans_Regular_ttf_size = 217360;
59 
60  extern char const* OpenSans_Semibold_ttf;
61  const int OpenSans_Semibold_ttf_size = 221328;
62 
63  extern char const* OpenSans_SemiboldItalic_ttf;
64  const int OpenSans_SemiboldItalic_ttf_size = 212820;
65 
66  }
67  }
68  namespace images
69  {
70  extern char const* arrow_down_png;
71  const int arrow_down_png_size = 1647;
72 
73  extern char const* arrow_up_png;
74  const int arrow_up_png_size = 1635;
75 
76  extern char const* dsp_off_png;
77  const int dsp_off_png_size = 12813;
78 
79  extern char const* dsp_on_png;
80  const int dsp_on_png_size = 16455;
81 
82  extern char const* folder_png;
83  const int folder_png_size = 2557;
84 
85  extern char const* kiwi_filetype_png;
86  const int kiwi_filetype_png_size = 40975;
87 
88  extern char const* kiwi_icon_png;
89  const int kiwi_icon_png_size = 24099;
90 
91  extern char const* locked_png;
92  const int locked_png_size = 6215;
93 
94  extern char const* minus_png;
95  const int minus_png_size = 5162;
96 
97  extern char const* open_png;
98  const int open_png_size = 1100;
99 
100  extern char const* plus_png;
101  const int plus_png_size = 6336;
102 
103  extern char const* refresh_png;
104  const int refresh_png_size = 15500;
105 
106  extern char const* trash_png;
107  const int trash_png_size = 6810;
108 
109  extern char const* unlocked_png;
110  const int unlocked_png_size = 6499;
111 
112  extern char const* users_png;
113  const int users_png_size = 8538;
114 
115  extern char const* zoom_in_png;
116  const int zoom_in_png_size = 14970;
117 
118  extern char const* zoom_out_png;
119  const int zoom_out_png_size = 14388;
120 
121  }
122  namespace settings
123  {
124  extern char const* network_settings;
125  const int network_settings_size = 177;
126 
127  }
128  }
129 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___carrier_socket_8h_source.html b/docs/html/_kiwi_app___carrier_socket_8h_source.html index a99ab854..c8e51ae9 100644 --- a/docs/html/_kiwi_app___carrier_socket_8h_source.html +++ b/docs/html/_kiwi_app___carrier_socket_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Network/KiwiApp_CarrierSocket.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_CarrierSocket.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <functional>
25 
26 #include "flip/contrib/transport_tcp/CarrierTransportSocketTcp.h"
27 
28 namespace kiwi
29 {
30  // ================================================================================ //
31  // CARRIER SOCKET //
32  // ================================================================================ //
33 
35  class CarrierSocket
36  {
37  public: // methods
38 
40  CarrierSocket(flip::DocumentBase& document, std::string const& host, uint16_t port, uint64_t session_id);
41 
42  // @brief Connects the socket to a remote socket
43  void connect(std::string const& host, uint16_t port);
44 
46  void disconnect();
47 
49  bool isConnected() const;
50 
52  void process();
53 
55  void listenDisconnected(std::function<void ()> func);
56 
58  void listenConnected(std::function<void ()> func);
59 
61  void listenLoaded(std::function<void ()> func);
62 
64  ~CarrierSocket();
65 
66  private: // methods
67 
69  void bindCallBacks();
70 
72  void listenStateTransition(flip::CarrierBase::Transition state, flip::CarrierBase::Error error);
73 
75  void listenTransferBackEnd(size_t cur, size_t total);
76 
78  void listenTransferTransaction(size_t cur, size_t total);
79 
81  void listenTransferSignal(size_t cur, size_t total);
82 
83  private: // members
84 
85  flip::CarrierTransportSocketTcp m_transport_socket;
86 
87  std::function<void(void)> m_func_disonnected;
88  std::function<void(void)> m_func_connected;
89  std::function<void(void)> m_func_loaded;
90 
91  private: // deleted methods
92 
93  CarrierSocket(CarrierSocket const& other) = delete;
94  CarrierSocket(CarrierSocket && other) = delete;
95  CarrierSocket& operator=(CarrierSocket const& other) = delete;
96  CarrierSocket& operator=(CarrierSocket && other) = delete;
97  };
98 }
kiwi::CarrierSocket::CarrierSocket
CarrierSocket(flip::DocumentBase &document, std::string const &host, uint16_t port, uint64_t session_id)
Constructor.
Definition: KiwiApp_CarrierSocket.cpp:34
-
kiwi::CarrierSocket::listenConnected
void listenConnected(std::function< void()> func)
Add a callback to be called on connected.
Definition: KiwiApp_CarrierSocket.cpp:99
-
kiwi::CarrierSocket::listenLoaded
void listenLoaded(std::function< void()> func)
Add a callback to be called once first load terminated.
Definition: KiwiApp_CarrierSocket.cpp:104
-
kiwi::CarrierSocket::~CarrierSocket
~CarrierSocket()
Stops processing.
Definition: KiwiApp_CarrierSocket.cpp:129
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <functional>
25 
26 #include "flip/contrib/transport_tcp/CarrierTransportSocketTcp.h"
27 
28 namespace kiwi
29 {
30  // ================================================================================ //
31  // CARRIER SOCKET //
32  // ================================================================================ //
33 
35  class CarrierSocket
36  {
37  public: // classes
38 
39  using state_func_t = std::function <void (flip::CarrierBase::Transition, flip::CarrierBase::Error error)>;
40 
41  using transfer_func_t = std::function <void (size_t, size_t)>;
42 
43  private: // classes
44 
45  enum class State
46  {
47  Disconnected,
48  Connecting,
49  Connected
50  };
51 
52  public: // methods
53 
55  CarrierSocket(flip::DocumentBase& document);
56 
57  // @brief Connects the socket to a remote socket
58  void connect(std::string const& host, uint16_t port, uint64_t session_id, std::string & metadata);
59 
61  void disconnect();
62 
64  bool isConnected() const;
65 
67  void process();
68 
70  void listenStateTransition(state_func_t call_back);
71 
73  void listenTransferBackend(transfer_func_t call_back);
74 
76  ~CarrierSocket();
77 
78  private: // methods
79 
81  void onStateTransition(flip::CarrierBase::Transition transition,
82  flip::CarrierBase::Error error);
83 
87  void onTransferBackend(size_t cur, size_t total);
88 
89  private: // members
90 
91  std::unique_ptr<flip::CarrierTransportSocketTcp> m_transport_socket;
92  flip::DocumentBase & m_document;
93  State m_state;
94  state_func_t m_state_func;
95  transfer_func_t m_transfer_func;
96 
97 
98  private: // deleted methods
99 
100  CarrierSocket(CarrierSocket const& other) = delete;
101  CarrierSocket(CarrierSocket && other) = delete;
102  CarrierSocket& operator=(CarrierSocket const& other) = delete;
103  CarrierSocket& operator=(CarrierSocket && other) = delete;
104  };
105 }
kiwi::CarrierSocket::~CarrierSocket
~CarrierSocket()
Stops processing.
Definition: KiwiApp_CarrierSocket.cpp:121
kiwi::CarrierSocket
Class that encapsulate a TCP socket.
Definition: KiwiApp_CarrierSocket.h:35
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::CarrierSocket::process
void process()
Process the socket once.
Definition: KiwiApp_CarrierSocket.cpp:109
-
kiwi::CarrierSocket::isConnected
bool isConnected() const
Returns true if the socket is connected, false otherwise.
Definition: KiwiApp_CarrierSocket.cpp:119
-
kiwi::CarrierSocket::listenDisconnected
void listenDisconnected(std::function< void()> func)
Add a callback to be called once disconnected.
Definition: KiwiApp_CarrierSocket.cpp:94
-
kiwi::CarrierSocket::disconnect
void disconnect()
Stop the socket from processing and disconnect.
Definition: KiwiApp_CarrierSocket.cpp:114
+
kiwi::CarrierSocket::process
void process()
Process the socket once.
Definition: KiwiApp_CarrierSocket.cpp:85
+
kiwi::CarrierSocket::CarrierSocket
CarrierSocket(flip::DocumentBase &document)
Constructor.
Definition: KiwiApp_CarrierSocket.cpp:34
+
kiwi::CarrierSocket::listenTransferBackend
void listenTransferBackend(transfer_func_t call_back)
Callback called receiving backend informations.
Definition: KiwiApp_CarrierSocket.cpp:80
+
kiwi::CarrierSocket::isConnected
bool isConnected() const
Returns true if the socket is connected, false otherwise.
Definition: KiwiApp_CarrierSocket.cpp:98
+
kiwi::CarrierSocket::listenStateTransition
void listenStateTransition(state_func_t call_back)
Callback called when transition changes.
Definition: KiwiApp_CarrierSocket.cpp:73
+
kiwi::CarrierSocket::disconnect
void disconnect()
Stop the socket from processing and disconnect.
Definition: KiwiApp_CarrierSocket.cpp:93
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___classic_view_8h_source.html b/docs/html/_kiwi_app___classic_view_8h_source.html new file mode 100644 index 00000000..6797ca3e --- /dev/null +++ b/docs/html/_kiwi_app___classic_view_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ClassicView.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_ClassicView.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <functional>
25 
26 #include <juce_gui_basics/juce_gui_basics.h>
27 
28 #include <KiwiModel/KiwiModel_Object.h>
29 
30 #include <KiwiTool/KiwiTool_Listeners.h>
31 
32 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_EditableObjectView.h>
33 
34 namespace kiwi
35 {
36  // ================================================================================ //
37  // CLASSIC VIEW //
38  // ================================================================================ //
39 
41  class ClassicView : public EditableObjectView,
42  public juce::TextEditor::Listener
43  {
44  public: // methods
45 
47  ClassicView(model::Object & object_model);
48 
50  ~ClassicView();
51 
52  private: // methods
53 
56  juce::TextEditor* createdTextEditor() override final;
57 
60  void textChanged() override final;
61 
63  void resized() override final;
64 
67  void textEditorTextChanged(juce::TextEditor& editor) override final;
68 
70  void paintOverChildren (juce::Graphics& g) override final;
71 
72  private: // deleted methods
73 
74  ClassicView() = delete;
75  ClassicView(ClassicView const& other) = delete;
76  ClassicView(ClassicView && other) = delete;
77  ClassicView& operator=(ClassicView const& other) = delete;
78  ClassicView& operator=(ClassicView && other) = delete;
79  };
80 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::EditableObjectView
Abstract class for object&#39;s views that can be edited in mode unlock.
Definition: KiwiApp_EditableObjectView.h:35
+
kiwi::ClassicView::~ClassicView
~ClassicView()
Destructor.
Definition: KiwiApp_ClassicView.cpp:54
+
kiwi::ClassicView
The view of any textual kiwi object.
Definition: KiwiApp_ClassicView.h:41
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___command_i_ds_8h_source.html b/docs/html/_kiwi_app___command_i_ds_8h_source.html index 86a43b6f..514fa9c4 100644 --- a/docs/html/_kiwi_app___command_i_ds_8h_source.html +++ b/docs/html/_kiwi_app___command_i_ds_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_General/KiwiApp_CommandIDs.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_CommandIDs.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 namespace kiwi
25 {
26  // ================================================================================ //
27  // COMMAND IDs //
28  // ================================================================================ //
29 
30  enum CommandIDs
31  {
32  newPatcher = 0x200010,
33  newPatcherView = 0x200020,
34  openFile = 0x200030,
35  closePatcher = 0x200051,
36  save = 0x200060,
37  saveAs = 0x200061,
38 
39  minimizeWindow = 0x201010,
40  maximizeWindow = 0x201020,
41  closeWindow = 0x201031,
42 
43  showConsoleWindow = 0x202000,
44  showAudioStatusWindow = 0x202010,
45  showAboutAppWindow = 0x202020,
46  showAppSettingsWindow = 0x202030,
47  showDocumentBrowserWindow = 0x202040,
48  showBeaconDispatcherWindow = 0x202050,
49  addBeaconDispatcher = 0x202051,
50  removeBeaconDispatcher = 0x202052,
51 
52  undo = 0xf1000a,
53  redo = 0xf1000b,
54  duplicate = 0xf1000c,
55  pasteReplace = 0xf1000d,
56 
57  toFront = 0xf2000a,
58  toBack = 0xf2000b,
59 
60  zoomIn = 0xf20013,
61  zoomOut = 0xf20014,
62  zoomNormal = 0xf20015,
63 
64  editModeSwitch = 0xf20100,
65 
66  gridModeSwitch = 0xf20200,
67  enableSnapToGrid = 0xf20201,
68 
69  newBox = 0xf30300,
70  newMessage = 0xf30301,
71  newFlonum = 0xf30302,
72  newNumber = 0xf30303,
73  newComment = 0xf30304,
74  newBang = 0xf30305,
75  newToggle = 0xf30306,
76 
77  showPatcherInspector = 0xf20400,
78 
79  showObjectInspector = 0xf20410,
80  openObjectHelp = 0xf20411,
81 
82  switchDsp = 0xf20420,
83  startDsp = 0xf20421,
84  stopDsp = 0xf20422,
85 
86  scrollToTop = 0xf30001,
87  scrollToBottom = 0xf30002,
88 
89  clearAll = 0xf40001
90  };
91 
92  // ================================================================================ //
93  // COMMAND CATEGORIES //
94  // ================================================================================ //
95 
96  namespace CommandCategories
97  {
98  static const char* const general = "General";
99  static const char* const editing = "Editing";
100  static const char* const view = "View";
101  static const char* const windows = "Windows";
102  }
103 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 namespace kiwi
25 {
26  // ================================================================================ //
27  // COMMAND IDs //
28  // ================================================================================ //
29 
30  enum CommandIDs
31  {
32  newPatcher = 0x200010,
33  newPatcherView = 0x200020,
34  openFile = 0x200030,
35  closePatcher = 0x200051,
36  save = 0x200060,
37  saveAs = 0x200061,
38 
39  minimizeWindow = 0x201010,
40  maximizeWindow = 0x201020,
41  closeWindow = 0x201031,
42 
43  showConsoleWindow = 0x202000,
44  showAudioStatusWindow = 0x202010,
45  showAboutAppWindow = 0x202020,
46  showAppSettingsWindow = 0x202030,
47  showDocumentBrowserWindow = 0x202040,
48  showBeaconDispatcherWindow = 0x202050,
49  addBeaconDispatcher = 0x202051,
50  removeBeaconDispatcher = 0x202052,
51 
52  undo = 0xf1000a,
53  redo = 0xf1000b,
54  duplicate = 0xf1000c,
55  pasteReplace = 0xf1000d,
56 
57  toFront = 0xf2000a,
58  toBack = 0xf2000b,
59 
60  zoomIn = 0xf20013,
61  zoomOut = 0xf20014,
62  zoomNormal = 0xf20015,
63 
64  editModeSwitch = 0xf20100,
65 
66  gridModeSwitch = 0xf20200,
67  enableSnapToGrid = 0xf20201,
68 
69  newBox = 0xf30300,
70  newMessage = 0xf30301,
71  newFlonum = 0xf30302,
72  newNumber = 0xf30303,
73  newComment = 0xf30304,
74  newBang = 0xf30305,
75  newToggle = 0xf30306,
76  newSlider = 0xf30307,
77 
78  showPatcherInspector = 0xf20400,
79 
80  showObjectInspector = 0xf20410,
81  openObjectHelp = 0xf20411,
82 
83  switchDsp = 0xf20420,
84  startDsp = 0xf20421,
85  stopDsp = 0xf20422,
86 
87  scrollToTop = 0xf30001,
88  scrollToBottom = 0xf30002,
89 
90  clearAll = 0xf40001,
91 
92  login = 0xf50000,
93  signup = 0xf50010,
94  logout = 0xf50020,
95  remember_me = 0xf50030,
96  };
97 
98  // ================================================================================ //
99  // COMMAND CATEGORIES //
100  // ================================================================================ //
101 
102  namespace CommandCategories
103  {
104  static const char* const general = "General";
105  static const char* const editing = "Editing";
106  static const char* const view = "View";
107  static const char* const windows = "Windows";
108  }
109 }
kiwi::zoomIn
Magnify the patcher view of almost 10%.
Definition: KiwiApp_CommandIDs.h:60
+
kiwi::remember_me
Toggle the "remember me" option to save user profile.
Definition: KiwiApp_CommandIDs.h:95
+
kiwi::pasteReplace
Replace an objects by the one in the clipboard.
Definition: KiwiApp_CommandIDs.h:55
+
kiwi::signup
Register the user.
Definition: KiwiApp_CommandIDs.h:93
+
kiwi::newNumber
Add a new "number" object box to the patcher.
Definition: KiwiApp_CommandIDs.h:72
+
kiwi::removeBeaconDispatcher
Remove a "beacon dispatcher" element.
Definition: KiwiApp_CommandIDs.h:50
+
kiwi::newComment
Add a new "comment" object box to the patcher.
Definition: KiwiApp_CommandIDs.h:73
+
kiwi::gridModeSwitch
Toggle grid patcher mode.
Definition: KiwiApp_CommandIDs.h:66
+
kiwi::closeWindow
Close the current window.
Definition: KiwiApp_CommandIDs.h:41
+
kiwi::openFile
Open a file in a new window.
Definition: KiwiApp_CommandIDs.h:34
+
kiwi::stopDsp
Stops the dsp.
Definition: KiwiApp_CommandIDs.h:85
+
kiwi::showObjectInspector
Shows the selected objects properties inspector.
Definition: KiwiApp_CommandIDs.h:80
+
kiwi::newToggle
Add a new "toggle" object box to the patcher.
Definition: KiwiApp_CommandIDs.h:75
+
kiwi::duplicate
Duplicate selected objects and paste them on patcher.
Definition: KiwiApp_CommandIDs.h:54
+
kiwi::toFront
Move selected object ahead of all other objects.
Definition: KiwiApp_CommandIDs.h:57
+
kiwi::scrollToTop
Scroll to the top.
Definition: KiwiApp_CommandIDs.h:87
+
kiwi::save
Save the current patcher document.
Definition: KiwiApp_CommandIDs.h:36
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::toBack
Move selected object behind all other objects.
Definition: KiwiApp_CommandIDs.h:58
+
kiwi::enableSnapToGrid
Toggle snap to grid patcher mode.
Definition: KiwiApp_CommandIDs.h:67
+
kiwi::showAboutAppWindow
Make visible the "about app" window.
Definition: KiwiApp_CommandIDs.h:45
+
kiwi::newPatcherView
Create a new patcher view.
Definition: KiwiApp_CommandIDs.h:33
+
kiwi::showBeaconDispatcherWindow
Make visible the "beacon dispatcher" window.
Definition: KiwiApp_CommandIDs.h:48
+
kiwi::redo
Redo last action.
Definition: KiwiApp_CommandIDs.h:53
+
kiwi::showConsoleWindow
Make visible the "console" window.
Definition: KiwiApp_CommandIDs.h:43
+
kiwi::CommandIDs
CommandIDs
Definition: KiwiApp_CommandIDs.h:30
+
kiwi::openObjectHelp
Open selected object help patcher.
Definition: KiwiApp_CommandIDs.h:81
+
kiwi::clearAll
Clear all content.
Definition: KiwiApp_CommandIDs.h:90
+
kiwi::showAudioStatusWindow
Make visible the "audio status" window.
Definition: KiwiApp_CommandIDs.h:44
+
kiwi::zoomOut
Reduce the patcher view of almost 10%.
Definition: KiwiApp_CommandIDs.h:61
+
kiwi::closePatcher
Close the current patcher.
Definition: KiwiApp_CommandIDs.h:35
+
kiwi::newMessage
Add a new "message" object box to the patcher.
Definition: KiwiApp_CommandIDs.h:70
+
kiwi::logout
Log-out the user.
Definition: KiwiApp_CommandIDs.h:94
+
kiwi::zoomNormal
Restore the patcher view zoom to 100%.
Definition: KiwiApp_CommandIDs.h:62
+
kiwi::newPatcher
Create a new blank patcher window.
Definition: KiwiApp_CommandIDs.h:32
+
kiwi::editModeSwitch
Toggle Lock/Unlock patcher view.
Definition: KiwiApp_CommandIDs.h:64
+
kiwi::startDsp
Starts the dsp.
Definition: KiwiApp_CommandIDs.h:84
+
kiwi::undo
Undo last action.
Definition: KiwiApp_CommandIDs.h:52
+
kiwi::addBeaconDispatcher
Add a new "beacon dispatcher" element.
Definition: KiwiApp_CommandIDs.h:49
+
kiwi::maximizeWindow
Maximise the current window.
Definition: KiwiApp_CommandIDs.h:40
+
kiwi::newFlonum
Add a new "flonum" object box to the patcher.
Definition: KiwiApp_CommandIDs.h:71
+
kiwi::newSlider
Add a new "slider" object box to the patcher.
Definition: KiwiApp_CommandIDs.h:76
+
kiwi::switchDsp
Toggle DSP state.
Definition: KiwiApp_CommandIDs.h:83
+
kiwi::showPatcherInspector
Shows the patcher properties inspector.
Definition: KiwiApp_CommandIDs.h:78
+
kiwi::showDocumentBrowserWindow
Make visible the "document browser" window.
Definition: KiwiApp_CommandIDs.h:47
+
kiwi::scrollToBottom
Scroll to the bottom.
Definition: KiwiApp_CommandIDs.h:88
+
kiwi::showAppSettingsWindow
Make visible the "application settings" window.
Definition: KiwiApp_CommandIDs.h:46
+
kiwi::saveAs
Save the current patcher document as.
Definition: KiwiApp_CommandIDs.h:37
+
kiwi::login
Log-in the user.
Definition: KiwiApp_CommandIDs.h:92
+
kiwi::newBang
Add a new "button" object box to the patcher.
Definition: KiwiApp_CommandIDs.h:74
+
kiwi::minimizeWindow
Reduce the current window.
Definition: KiwiApp_CommandIDs.h:39
+
kiwi::newBox
Add a new "box" to the patcher.
Definition: KiwiApp_CommandIDs.h:69
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___comment_view_8h_source.html b/docs/html/_kiwi_app___comment_view_8h_source.html new file mode 100644 index 00000000..dcc890d5 --- /dev/null +++ b/docs/html/_kiwi_app___comment_view_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_CommentView.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_CommentView.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_basics/juce_gui_basics.h>
25 
26 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Message.h>
27 
28 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_EditableObjectView.h>
29 
30 namespace kiwi {
31 
32  // ================================================================================ //
33  // COMMENT VIEW //
34  // ================================================================================ //
35 
37  class CommentView : public EditableObjectView,
38  public juce::TextEditor::Listener
39  {
40  public: // methods
41 
42  // @brief The declaration method.
43  static void declare();
44 
46  static std::unique_ptr<ObjectView> create(model::Object & object_model);
47 
49  CommentView(model::Object & object_model);
50 
52  ~CommentView();
53 
54  private: // methods
55 
57  void resized() override final;
58 
61  void textEditorTextChanged(juce::TextEditor& editor) override final;
62 
64  void paintOverChildren (juce::Graphics& g) override final;
65 
67  void attributeChanged(std::string const& name, tool::Parameter const& param) override final;
68 
71  void textChanged() override final;
72 
75  juce::TextEditor* createdTextEditor() override final;
76 
77  private: // deleted methods
78 
79  CommentView() = delete;
80  CommentView(CommentView const& other) = delete;
81  CommentView(CommentView && other) = delete;
82  CommentView& operator=(CommentView const& other) = delete;
83  CommentView& operator=(CommentView && other) = delete;
84  };
85 }
kiwi::CommentView::create
static std::unique_ptr< ObjectView > create(model::Object &object_model)
Creation method.
Definition: KiwiApp_CommentView.cpp:38
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi::CommentView::~CommentView
~CommentView()
Destructor.
Definition: KiwiApp_CommentView.cpp:64
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::CommentView
The view of any textual kiwi object.
Definition: KiwiApp_CommentView.h:37
+
kiwi::EditableObjectView
Abstract class for object&#39;s views that can be edited in mode unlock.
Definition: KiwiApp_EditableObjectView.h:35
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___console_8h_source.html b/docs/html/_kiwi_app___console_8h_source.html index 7dc46960..ad41ee56 100644 --- a/docs/html/_kiwi_app___console_8h_source.html +++ b/docs/html/_kiwi_app___console_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Application/KiwiApp_Console.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_Console.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_basics/juce_gui_basics.h>
25 
26 #include "../KiwiApp_Components/KiwiApp_Window.h"
27 #include "KiwiApp_ConsoleHistory.h"
28 
29 namespace kiwi
30 {
31  class Console;
32 
33  // ================================================================================ //
34  // CONSOLE CONTENT COMPONENT //
35  // ================================================================================ //
36 
40  class ConsoleContent :
41  public ConsoleHistory::Listener,
42  public juce::Component,
43  public juce::TableListBoxModel,
44  public juce::TableHeaderComponent::Listener
45  {
46  public:
47 
49  ConsoleContent(sConsoleHistory history);
50 
52  ~ConsoleContent();
53 
55  sConsoleHistory getHistory();
56 
59  void consoleHistoryChanged(ConsoleHistory const& history) final override;
60 
61  // ================================================================================ //
62  // COMPONENT //
63  // ================================================================================ //
64 
65  void resized() override;
66  void paint(juce::Graphics& g) override;
67 
68  // ================================================================================ //
69  // TABLE LIST BOX MODEL //
70  // ================================================================================ //
71 
73  void selectedRowsChanged(int row) override;
74 
76  void deleteKeyPressed(int lastRowSelected) override;
77 
79  int getNumRows() override;
80 
82  int getNumSelectedRows() const;
83 
85  void paintRowBackground(juce::Graphics& g,
86  int rowNumber, int width, int height,
87  bool rowIsSelected) override;
88 
90  void paintOverChildren(juce::Graphics &g) override;
91 
93  void backgroundClicked(const juce::MouseEvent& mouse) override;
94 
96  void paintCell(juce::Graphics& g,
97  int rowNumber, int columnId,
98  int width, int height,
99  bool rowIsSelected) override;
100 
103  void sortOrderChanged(int newSortColumnId, bool isForwards) override;
104 
106  void cellDoubleClicked(int rowNumber, int columnId, const juce::MouseEvent& mouse) override;
107 
110  Component* refreshComponentForCell(int rowNumber,
111  int columnId,
112  bool isRowSelected,
113  juce::Component* existingComponentToUpdate) override;
114 
117  int getColumnAutoSizeWidth(int columnId) override;
118 
120  void scrollToTop();
121 
123  void scrollToBottom();
124 
126  void clearAll();
127 
128  // ================================================================================ //
129  // TABLE HEADER COMPONENT LISTENER //
130  // ================================================================================ //
131 
133  void tableColumnsResized(juce::TableHeaderComponent* tableHeader) override;
134 
136  void tableColumnsChanged(juce::TableHeaderComponent* tableHeader) override {};
137 
139  void tableSortOrderChanged(juce::TableHeaderComponent* tableHeader) override {};
140 
142  void updateRighmostColumnWidth(juce::TableHeaderComponent* header);
143 
144  private:
145 
147  enum Column
148  {
149  Id = 1,
150  Type = 2,
151  Object = 3,
152  Message = 4
153  };
154 
156  void copy();
157 
159  void erase();
160 
161  private:
162 
163  wConsoleHistory m_history;
164  juce::Font m_font;
165  juce::TableListBox m_table;
166 
167  friend class Console;
168  };
169 
170  // ================================================================================ //
171  // CONSOLE TOOLBAR //
172  // ================================================================================ //
173 
174  class ConsoleToolbarFactory : public juce::ToolbarItemFactory
175  {
176  public: // methods
177 
179  ConsoleToolbarFactory();
180 
181  enum ItemIds
182  {
183  clear = 1,
184  scroll_to_top = 2,
185  scroll_to_bottom = 3,
186  };
187 
188  void getAllToolbarItemIds(juce::Array<int>& ids) override;
189 
190  void getDefaultItemSet(juce::Array<int>& ids) override;
191 
192  juce::ToolbarItemComponent* createItem(int itemId) override;
193 
194  private: // variables
195 
196  };
197 
198  // ================================================================================ //
199  // CONSOLE COMPONENT //
200  // ================================================================================ //
201 
202  class Console : public juce::Component, public juce::ApplicationCommandTarget
203  {
204  public: // methods
205 
207  Console(sConsoleHistory history);
208 
210  void resized() override;
211 
213  void paint(juce::Graphics& g) override;
214 
215  // ================================================================================ //
216  // APPLICATION COMMAND TARGET //
217  // ================================================================================ //
218 
219  juce::ApplicationCommandTarget* getNextCommandTarget() override;
220  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
221  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
222  bool perform(const InvocationInfo& info) override;
223 
224  private: // variables
225 
226  ConsoleContent m_console;
227  juce::Toolbar m_toolbar;
228  ConsoleToolbarFactory m_toolbar_factory;
229  };
230 }
kiwi::ConsoleContent::sortOrderChanged
void sortOrderChanged(int newSortColumnId, bool isForwards) override
This is overloaded from TableListBoxModel,.
Definition: KiwiApp_Console.cpp:321
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_basics/juce_gui_basics.h>
25 
26 #include "../KiwiApp_Components/KiwiApp_Window.h"
27 #include "KiwiApp_ConsoleHistory.h"
28 
29 namespace kiwi
30 {
31  class Console;
32 
33  // ================================================================================ //
34  // CONSOLE CONTENT COMPONENT //
35  // ================================================================================ //
36 
40  class ConsoleContent :
41  public ConsoleHistory::Listener,
42  public juce::Component,
43  public juce::TableListBoxModel,
44  public juce::TableHeaderComponent::Listener
45  {
46  public:
47 
49  ConsoleContent(sConsoleHistory history);
50 
52  ~ConsoleContent();
53 
55  sConsoleHistory getHistory();
56 
59  void consoleHistoryChanged(ConsoleHistory const& history) final override;
60 
61  // ================================================================================ //
62  // COMPONENT //
63  // ================================================================================ //
64 
65  void resized() override;
66  void paint(juce::Graphics& g) override;
67 
68  // ================================================================================ //
69  // TABLE LIST BOX MODEL //
70  // ================================================================================ //
71 
73  void selectedRowsChanged(int row) override;
74 
76  void deleteKeyPressed(int lastRowSelected) override;
77 
79  int getNumRows() override;
80 
82  int getNumSelectedRows() const;
83 
85  void paintRowBackground(juce::Graphics& g,
86  int rowNumber, int width, int height,
87  bool rowIsSelected) override;
88 
90  void paintOverChildren(juce::Graphics &g) override;
91 
93  void backgroundClicked(const juce::MouseEvent& mouse) override;
94 
96  void paintCell(juce::Graphics& g,
97  int rowNumber, int columnId,
98  int width, int height,
99  bool rowIsSelected) override;
100 
103  void sortOrderChanged(int newSortColumnId, bool isForwards) override;
104 
106  void cellDoubleClicked(int rowNumber, int columnId, const juce::MouseEvent& mouse) override;
107 
110  Component* refreshComponentForCell(int rowNumber,
111  int columnId,
112  bool isRowSelected,
113  juce::Component* existingComponentToUpdate) override;
114 
117  int getColumnAutoSizeWidth(int columnId) override;
118 
120  void scrollToTop();
121 
123  void scrollToBottom();
124 
126  void clearAll();
127 
128  // ================================================================================ //
129  // TABLE HEADER COMPONENT LISTENER //
130  // ================================================================================ //
131 
133  void tableColumnsResized(juce::TableHeaderComponent* tableHeader) override;
134 
136  void tableColumnsChanged(juce::TableHeaderComponent* tableHeader) override {};
137 
139  void tableSortOrderChanged(juce::TableHeaderComponent* tableHeader) override {};
140 
142  void updateRighmostColumnWidth(juce::TableHeaderComponent* header);
143 
144  private:
145 
147  enum Column
148  {
149  Message = 1
150  };
151 
153  void copy();
154 
156  void erase();
157 
158  private:
159 
160  wConsoleHistory m_history;
161  juce::Font m_font;
162  juce::TableListBox m_table;
163 
164  friend class Console;
165  };
166 
167  // ================================================================================ //
168  // CONSOLE TOOLBAR //
169  // ================================================================================ //
170 
171  class ConsoleToolbarFactory : public juce::ToolbarItemFactory
172  {
173  public: // methods
174 
176  ConsoleToolbarFactory();
177 
178  enum ItemIds
179  {
180  clear = 1,
181  scroll_to_top = 2,
182  scroll_to_bottom = 3,
183  };
184 
185  void getAllToolbarItemIds(juce::Array<int>& ids) override;
186 
187  void getDefaultItemSet(juce::Array<int>& ids) override;
188 
189  juce::ToolbarItemComponent* createItem(int itemId) override;
190 
191  private: // variables
192 
193  };
194 
195  // ================================================================================ //
196  // CONSOLE COMPONENT //
197  // ================================================================================ //
198 
199  class Console : public juce::Component, public juce::ApplicationCommandTarget
200  {
201  public: // methods
202 
204  Console(sConsoleHistory history);
205 
207  void resized() override;
208 
210  void paint(juce::Graphics& g) override;
211 
212  // ================================================================================ //
213  // APPLICATION COMMAND TARGET //
214  // ================================================================================ //
215 
216  juce::ApplicationCommandTarget* getNextCommandTarget() override;
217  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
218  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
219  bool perform(const InvocationInfo& info) override;
220 
221  private: // variables
222 
223  ConsoleContent m_console;
224  juce::Toolbar m_toolbar;
225  ConsoleToolbarFactory m_toolbar_factory;
226  };
227 }
kiwi::ConsoleContent::sortOrderChanged
void sortOrderChanged(int newSortColumnId, bool isForwards) override
This is overloaded from TableListBoxModel,.
Definition: KiwiApp_Console.cpp:303
kiwi::ConsoleContent::tableColumnsChanged
void tableColumnsChanged(juce::TableHeaderComponent *tableHeader) override
This is called when some of the table&#39;s columns are added, removed, hidden, or rearranged.
Definition: KiwiApp_Console.h:136
kiwi::ConsoleHistory::Listener
The Console History Listener is a is a virtual class you can inherit from to receive console history ...
Definition: KiwiApp_ConsoleHistory.h:118
-
kiwi::ConsoleContent::getNumSelectedRows
int getNumSelectedRows() const
Get the number of selected rows.
Definition: KiwiApp_Console.cpp:215
-
kiwi::ConsoleContent::getColumnAutoSizeWidth
int getColumnAutoSizeWidth(int columnId) override
This is overloaded from TableListBoxModel.
Definition: KiwiApp_Console.cpp:345
-
kiwi::ConsoleToolbarFactory
Definition: KiwiApp_Console.h:174
-
kiwi::ConsoleContent::paintOverChildren
void paintOverChildren(juce::Graphics &g) override
Paint over cells.
Definition: KiwiApp_Console.cpp:258
-
kiwi::ConsoleContent::deleteKeyPressed
void deleteKeyPressed(int lastRowSelected) override
Called when the delete key has been pressed.
Definition: KiwiApp_Console.cpp:199
-
kiwi::ConsoleContent::getHistory
sConsoleHistory getHistory()
Gets the ConsoleHistory.
Definition: KiwiApp_Console.cpp:89
+
kiwi::ConsoleContent::getColumnAutoSizeWidth
int getColumnAutoSizeWidth(int columnId) override
This is overloaded from TableListBoxModel.
Definition: KiwiApp_Console.cpp:327
+
kiwi::ConsoleToolbarFactory
Definition: KiwiApp_Console.h:171
+
kiwi::ConsoleContent::paintOverChildren
void paintOverChildren(juce::Graphics &g) override
Paint over cells.
Definition: KiwiApp_Console.cpp:246
+
kiwi::ConsoleContent::getNumSelectedRows
int getNumSelectedRows() const
Get the number of selected rows.
Definition: KiwiApp_Console.cpp:203
+
kiwi::ConsoleContent::deleteKeyPressed
void deleteKeyPressed(int lastRowSelected) override
Called when the delete key has been pressed.
Definition: KiwiApp_Console.cpp:187
+
kiwi::ConsoleContent::getHistory
sConsoleHistory getHistory()
Gets the ConsoleHistory.
Definition: KiwiApp_Console.cpp:76
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::ConsoleContent::~ConsoleContent
~ConsoleContent()
Destructor.
Definition: KiwiApp_Console.cpp:80
-
kiwi::Console
Definition: KiwiApp_Console.h:202
+
kiwi::ConsoleContent::~ConsoleContent
~ConsoleContent()
Destructor.
Definition: KiwiApp_Console.cpp:67
+
kiwi::Console
Definition: KiwiApp_Console.h:199
kiwi::ConsoleContent
The juce ConsoleContent Component.
Definition: KiwiApp_Console.h:40
-
kiwi::ConsoleContent::scrollToTop
void scrollToTop()
Scroll the list to the top.
Definition: KiwiApp_Console.cpp:174
-
kiwi::ConsoleContent::updateRighmostColumnWidth
void updateRighmostColumnWidth(juce::TableHeaderComponent *header)
This is called when the rightmost column width need to be updated.
Definition: KiwiApp_Console.cpp:376
-
kiwi::ConsoleContent::paintRowBackground
void paintRowBackground(juce::Graphics &g, int rowNumber, int width, int height, bool rowIsSelected) override
This is overloaded from TableListBoxModel, and should fill in the background of the whole row...
Definition: KiwiApp_Console.cpp:220
+
kiwi::ConsoleContent::scrollToTop
void scrollToTop()
Scroll the list to the top.
Definition: KiwiApp_Console.cpp:162
+
kiwi::ConsoleContent::updateRighmostColumnWidth
void updateRighmostColumnWidth(juce::TableHeaderComponent *header)
This is called when the rightmost column width need to be updated.
Definition: KiwiApp_Console.cpp:355
+
kiwi::ConsoleContent::paintRowBackground
void paintRowBackground(juce::Graphics &g, int rowNumber, int width, int height, bool rowIsSelected) override
This is overloaded from TableListBoxModel, and should fill in the background of the whole row...
Definition: KiwiApp_Console.cpp:208
kiwi::ConsoleContent::ConsoleContent
ConsoleContent(sConsoleHistory history)
Constructor.
Definition: KiwiApp_Console.cpp:35
-
kiwi::ConsoleContent::tableColumnsResized
void tableColumnsResized(juce::TableHeaderComponent *tableHeader) override
This is called when one or more of the table&#39;s columns are resized.
Definition: KiwiApp_Console.cpp:368
+
kiwi::ConsoleContent::tableColumnsResized
void tableColumnsResized(juce::TableHeaderComponent *tableHeader) override
This is called when one or more of the table&#39;s columns are resized.
Definition: KiwiApp_Console.cpp:347
kiwi::ConsoleContent::tableSortOrderChanged
void tableSortOrderChanged(juce::TableHeaderComponent *tableHeader) override
This is called when the column by which the table should be sorted is changed.
Definition: KiwiApp_Console.h:139
-
kiwi::ConsoleContent::paintCell
void paintCell(juce::Graphics &g, int rowNumber, int columnId, int width, int height, bool rowIsSelected) override
This must paint any cells that aren&#39;t using custom components.
Definition: KiwiApp_Console.cpp:277
+
kiwi::ConsoleContent::paintCell
void paintCell(juce::Graphics &g, int rowNumber, int columnId, int width, int height, bool rowIsSelected) override
This must paint any cells that aren&#39;t using custom components.
Definition: KiwiApp_Console.cpp:265
kiwi::ConsoleHistory
The Console History listen to the Console and keep an history of the messages.
Definition: KiwiApp_ConsoleHistory.h:34
-
kiwi::ConsoleContent::getNumRows
int getNumRows() override
Get the number of rows currently displayed by the console.
Definition: KiwiApp_Console.cpp:209
-
kiwi::ConsoleContent::backgroundClicked
void backgroundClicked(const juce::MouseEvent &mouse) override
Called when the console background has been clicked (clear row selection).
Definition: KiwiApp_Console.cpp:204
-
kiwi::ConsoleContent::selectedRowsChanged
void selectedRowsChanged(int row) override
Called when selected rows changed.
Definition: KiwiApp_Console.cpp:194
-
kiwi::ConsoleContent::clearAll
void clearAll()
Clear all the console content.
Definition: KiwiApp_Console.cpp:184
-
kiwi::ConsoleContent::scrollToBottom
void scrollToBottom()
Scroll the list to the bottom.
Definition: KiwiApp_Console.cpp:179
-
kiwi::ConsoleContent::consoleHistoryChanged
void consoleHistoryChanged(ConsoleHistory const &history) final override
The function is called by an hisotry when it has changed.
Definition: KiwiApp_Console.cpp:141
-
kiwi::ConsoleContent::refreshComponentForCell
Component * refreshComponentForCell(int rowNumber, int columnId, bool isRowSelected, juce::Component *existingComponentToUpdate) override
This is overloaded from TableListBoxModel.
Definition: KiwiApp_Console.cpp:335
-
kiwi::ConsoleContent::cellDoubleClicked
void cellDoubleClicked(int rowNumber, int columnId, const juce::MouseEvent &mouse) override
Called when a cell is double-clicked,.
Definition: KiwiApp_Console.cpp:330
+
kiwi::ConsoleContent::getNumRows
int getNumRows() override
Get the number of rows currently displayed by the console.
Definition: KiwiApp_Console.cpp:197
+
kiwi::ConsoleContent::backgroundClicked
void backgroundClicked(const juce::MouseEvent &mouse) override
Called when the console background has been clicked (clear row selection).
Definition: KiwiApp_Console.cpp:192
+
kiwi::ConsoleContent::selectedRowsChanged
void selectedRowsChanged(int row) override
Called when selected rows changed.
Definition: KiwiApp_Console.cpp:182
+
kiwi::ConsoleContent::clearAll
void clearAll()
Clear all the console content.
Definition: KiwiApp_Console.cpp:172
+
kiwi::ConsoleContent::scrollToBottom
void scrollToBottom()
Scroll the list to the bottom.
Definition: KiwiApp_Console.cpp:167
+
kiwi::ConsoleContent::consoleHistoryChanged
void consoleHistoryChanged(ConsoleHistory const &history) final override
The function is called by an hisotry when it has changed.
Definition: KiwiApp_Console.cpp:128
+
kiwi::ConsoleContent::refreshComponentForCell
Component * refreshComponentForCell(int rowNumber, int columnId, bool isRowSelected, juce::Component *existingComponentToUpdate) override
This is overloaded from TableListBoxModel.
Definition: KiwiApp_Console.cpp:317
+
kiwi::ConsoleContent::cellDoubleClicked
void cellDoubleClicked(int rowNumber, int columnId, const juce::MouseEvent &mouse) override
Called when a cell is double-clicked,.
Definition: KiwiApp_Console.cpp:312
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___console_history_8h_source.html b/docs/html/_kiwi_app___console_history_8h_source.html index 4ff42498..ea50fab7 100644 --- a/docs/html/_kiwi_app___console_history_8h_source.html +++ b/docs/html/_kiwi_app___console_history_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Application/KiwiApp_ConsoleHistory.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_ConsoleHistory.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Instance.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // CONSOLE HISTORY //
30  // ================================================================================ //
31 
34  class ConsoleHistory : public engine::Console::Listener
35  {
36  public:
37  class Listener;
38 
40  enum Sort
41  {
42  ByIndex = 0,
43  ByType,
44  ByText
45  };
46 
47  public:
48 
50  ConsoleHistory(engine::Instance& instance);
51 
53  ~ConsoleHistory();
54 
56  void clear();
57 
59  size_t size();
60 
62  std::pair<engine::Console::Message const*, size_t> get(size_t index);
63 
66  void erase(size_t index);
67 
71  void erase(size_t begin, size_t last);
72 
75  void erase(std::vector<size_t>& indices);
76 
80  void sort(Sort type = ByIndex);
81 
83  void addListener(Listener& listener);
84 
86  void removeListener(Listener& listener);
87 
88  private:
89 
90  struct MessageHolder
91  {
92  engine::Console::Message m_message;
93  size_t m_index;
94  size_t m_repeat_times;
95  };
96 
97  static bool compareIndex(MessageHolder const& i, MessageHolder const& j);
98  static bool compareText(MessageHolder const& i, MessageHolder const& j);
99  static bool compareType(MessageHolder const& i, MessageHolder const& j);
100 
102  void newConsoleMessage(engine::Console::Message const& message) final override;
103 
104  private:
105 
106  engine::Instance& m_instance;
107  std::mutex m_message_mutex;
108  std::vector<MessageHolder> m_messages;
109  Sort m_sort;
110  engine::Listeners<Listener> m_listeners;
111  };
112 
113  // ================================================================================ //
114  // INSTANCE LISTENER //
115  // ================================================================================ //
116 
118  class ConsoleHistory::Listener
119  {
120  public:
121 
122  virtual ~Listener() = default;
123 
126  virtual void consoleHistoryChanged(ConsoleHistory const& history) = 0;
127  };
128 
129  typedef std::shared_ptr<ConsoleHistory> sConsoleHistory;
130  typedef std::weak_ptr<ConsoleHistory> wConsoleHistory;
131 }
kiwi::ConsoleHistory::Listener
The Console History Listener is a is a virtual class you can inherit from to receive console history ...
Definition: KiwiApp_ConsoleHistory.h:118
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Instance.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // CONSOLE HISTORY //
30  // ================================================================================ //
31 
34  class ConsoleHistory : public engine::Console::Listener
35  {
36  public:
37  class Listener;
38 
40  enum Sort
41  {
42  ByIndex = 0,
43  ByType,
44  ByText
45  };
46 
47  public:
48 
50  ConsoleHistory(engine::Instance& instance);
51 
53  ~ConsoleHistory();
54 
56  void clear();
57 
59  size_t size();
60 
62  std::pair<engine::Console::Message const*, size_t> get(size_t index);
63 
66  void erase(size_t index);
67 
71  void erase(size_t begin, size_t last);
72 
75  void erase(std::vector<size_t>& indices);
76 
80  void sort(Sort type = ByIndex);
81 
83  void addListener(Listener& listener);
84 
86  void removeListener(Listener& listener);
87 
88  private:
89 
90  struct MessageHolder
91  {
92  engine::Console::Message m_message;
93  size_t m_index;
94  size_t m_repeat_times;
95  };
96 
97  static bool compareIndex(MessageHolder const& i, MessageHolder const& j);
98  static bool compareText(MessageHolder const& i, MessageHolder const& j);
99  static bool compareType(MessageHolder const& i, MessageHolder const& j);
100 
102  void newConsoleMessage(engine::Console::Message const& message) final override;
103 
104  private:
105 
106  engine::Instance& m_instance;
107  std::mutex m_message_mutex;
108  std::vector<MessageHolder> m_messages;
109  Sort m_sort;
110  tool::Listeners<Listener> m_listeners;
111  };
112 
113  // ================================================================================ //
114  // INSTANCE LISTENER //
115  // ================================================================================ //
116 
118  class ConsoleHistory::Listener
119  {
120  public:
121 
122  virtual ~Listener() = default;
123 
126  virtual void consoleHistoryChanged(ConsoleHistory const& history) = 0;
127  };
128 
129  typedef std::shared_ptr<ConsoleHistory> sConsoleHistory;
130  typedef std::weak_ptr<ConsoleHistory> wConsoleHistory;
131 }
kiwi::ConsoleHistory::Listener
The Console History Listener is a is a virtual class you can inherit from to receive console history ...
Definition: KiwiApp_ConsoleHistory.h:118
kiwi::ConsoleHistory::erase
void erase(size_t index)
Erase a message from the history.
Definition: KiwiApp_ConsoleHistory.cpp:105
kiwi::ConsoleHistory::clear
void clear()
Clear the messages.
Definition: KiwiApp_ConsoleHistory.cpp:78
kiwi::ConsoleHistory::~ConsoleHistory
~ConsoleHistory()
Destructor.
Definition: KiwiApp_ConsoleHistory.cpp:38
kiwi::ConsoleHistory::ConsoleHistory
ConsoleHistory(engine::Instance &instance)
Constructor.
Definition: KiwiApp_ConsoleHistory.cpp:31
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiTool_Listeners.h:38
kiwi::ConsoleHistory::sort
void sort(Sort type=ByIndex)
Sort the messages by index, type or text.
Definition: KiwiApp_ConsoleHistory.cpp:196
-
kiwi::engine::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiEngine_Listeners.h:40
kiwi::ConsoleHistory::addListener
void addListener(Listener &listener)
Add an history listener.
Definition: KiwiApp_ConsoleHistory.cpp:212
kiwi::ConsoleHistory::ByType
Sort message by type.
Definition: KiwiApp_ConsoleHistory.h:43
kiwi::ConsoleHistory::ByIndex
Sort messages by Index.
Definition: KiwiApp_ConsoleHistory.h:42
-
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:42
+
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:46
kiwi::ConsoleHistory::Sort
Sort
Sorting method types.
Definition: KiwiApp_ConsoleHistory.h:40
kiwi::ConsoleHistory
The Console History listen to the Console and keep an history of the messages.
Definition: KiwiApp_ConsoleHistory.h:34
kiwi::engine::Console::Message
The Console Message owns the informations of a message posted via a console.
Definition: KiwiEngine_Console.h:47
@@ -90,7 +114,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___custom_toolbar_button_8h_source.html b/docs/html/_kiwi_app___custom_toolbar_button_8h_source.html index f5b882d6..c10182e0 100644 --- a/docs/html/_kiwi_app___custom_toolbar_button_8h_source.html +++ b/docs/html/_kiwi_app___custom_toolbar_button_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Components/KiwiApp_CustomToolbarButton.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + + - + - - - - + +
KiwiApp_DocumentBrowser.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Listeners.h>
25 
26 #include <juce_data_structures/juce_data_structures.h>
27 #include <juce_events/juce_events.h>
28 
29 #include "KiwiApp_Api.h"
30 
31 #include "../KiwiApp_General/KiwiApp_StoredSettings.h"
32 
33 namespace kiwi
34 {
35  // ================================================================================ //
36  // DOCUMENT BROWSER //
37  // ================================================================================ //
38 
40  class DocumentBrowser : public juce::Timer, public NetworkSettings::Listener
41  {
42  public: // nested classes
43 
44  struct Listener;
45  class Drive;
46 
47  public: // methods
48 
50  DocumentBrowser();
51 
53  ~DocumentBrowser();
54 
56  void start(const int interval = 5000);
57 
59  void stop();
60 
62  void process();
63 
65  void timerCallback() override;
66 
68  std::vector<Drive*> getDrives() const;
69 
71  void addListener(Listener& listener);
72 
74  void removeListener(Listener& listener);
75 
76  private: // methods
77 
78  void networkSettingsChanged(NetworkSettings const&, const juce::Identifier& id) override;
79 
80  private: // variables
81 
82  std::unique_ptr<Drive> m_distant_drive;
83  engine::Listeners<Listener> m_listeners = {};
84  };
85 
86  // ================================================================================ //
87  // DOCUMENT BROWSER LISTENER //
88  // ================================================================================ //
89 
91  struct DocumentBrowser::Listener
92  {
94  virtual ~Listener() = default;
95 
97  virtual void driveAdded(DocumentBrowser::Drive& drive) = 0;
98 
100  virtual void driveChanged(DocumentBrowser::Drive const& drive) = 0;
101 
103  virtual void driveRemoved(DocumentBrowser::Drive const& drive) = 0;
104  };
105 
106  // ================================================================================ //
107  // DOCUMENT BROWSER DRIVE //
108  // ================================================================================ //
109 
110  class DocumentBrowser::Drive
111  {
112  public: // nested classes
113 
114  struct Listener;
115  class DocumentSession;
116 
117  using DocumentSessions = std::vector<std::unique_ptr<DocumentSession>>;
118 
119  public: // methods
120 
121  Drive(std::string const& name,
122  std::string const& host,
123  uint16_t api_port,
124  uint16_t session_port);
125 
126  ~Drive() = default;
127 
129  void addListener(Listener& listener);
130 
132  void removeListener(Listener& listener);
133 
135  Api& useApi();
136 
138  void setApiPort(uint16_t port);
139 
141  uint16_t getApiPort() const;
142 
144  void setSessionPort(uint16_t port);
145 
147  uint16_t getSessionPort() const;
148 
150  void setHost(std::string const& host);
151 
153  std::string const& getHost() const;
154 
156  void setName(std::string const& host);
157 
159  std::string const& getName() const;
160 
162  void createNewDocument();
163 
165  DocumentSessions const& getDocuments() const;
166 
168  DocumentSessions& getDocuments();
169 
172  bool operator==(Drive const& drive) const;
173 
175  void refresh();
176 
177  private: // members
178 
180  void updateDocumentList(Api::Documents docs);
181 
182  Api m_api;
183  uint16_t m_session_port = 9090;
184  std::string m_name = "Drive";
185  DocumentSessions m_documents;
186  engine::Listeners<Listener> m_listeners;
187 
188  friend class DocumentBrowser;
189  };
190 
191  // ================================================================================ //
192  // DOCUMENT BROWSER LISTENER //
193  // ================================================================================ //
194 
196  struct DocumentBrowser::Drive::Listener
197  {
199  virtual ~Listener() = default;
200 
202  virtual void documentAdded(DocumentBrowser::Drive::DocumentSession& doc) {};
203 
205  virtual void documentChanged(DocumentBrowser::Drive::DocumentSession& doc) {};
206 
208  virtual void documentRemoved(DocumentBrowser::Drive::DocumentSession& doc) {};
209 
211  virtual void driveChanged() {};
212  };
213 
214  // ================================================================================ //
215  // DRIVE DOCUMENT //
216  // ================================================================================ //
217 
218  class DocumentBrowser::Drive::DocumentSession
219  {
220  public: // methods
221 
223  DocumentSession(DocumentBrowser::Drive& parent, Api::Document document);
224 
226  ~DocumentSession();
227 
229  Drive& useDrive();
230 
232  void open();
233 
235  std::string getName() const;
236 
238  std::string getHost() const;
239 
241  uint64_t getSessionId() const;
242 
244  uint16_t getSessionPort() const;
245 
247  DocumentBrowser::Drive const& useDrive() const;
248 
250  void rename(std::string const& new_name);
251 
254  bool operator==(DocumentSession const& other_doc) const;
255 
256  private: // members
257 
258  DocumentBrowser::Drive& m_drive;
259  Api::Document m_document;
260 
261  friend class DocumentBrowser::Drive;
262  };
263 }
kiwi::DocumentBrowser::timerCallback
void timerCallback() override
juce::Timer callback.
Definition: KiwiApp_DocumentBrowser.cpp:118
-
kiwi::DocumentBrowser::start
void start(const int interval=5000)
start processing
Definition: KiwiApp_DocumentBrowser.cpp:64
-
kiwi::DocumentBrowser::Drive::Listener::driveChanged
virtual void driveChanged()
Called when one or more documents has been added, removed or changed.
Definition: KiwiApp_DocumentBrowser.h:211
-
kiwi::NetworkSettings
Definition: KiwiApp_StoredSettings.h:35
-
kiwi::DocumentBrowser::Drive
Definition: KiwiApp_DocumentBrowser.h:110
-
kiwi::DocumentBrowser::stop
void stop()
stop processing
Definition: KiwiApp_DocumentBrowser.cpp:69
-
kiwi::DocumentBrowser::addListener
void addListener(Listener &listener)
Add a listener.
Definition: KiwiApp_DocumentBrowser.cpp:108
-
kiwi::NetworkSettings::Listener::~Listener
virtual ~Listener()=default
Destructor.
-
kiwi::DocumentBrowser::Listener
Listen to document explorer changes.
Definition: KiwiApp_DocumentBrowser.h:91
-
kiwi::DocumentBrowser::process
void process()
Scan the LAN to find a service provider.
Definition: KiwiApp_DocumentBrowser.cpp:123
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Listeners.h>
25 
26 #include <juce_data_structures/juce_data_structures.h>
27 #include <juce_events/juce_events.h>
28 
29 #include "../KiwiApp_Network/KiwiApp_Api.h"
30 
31 #include "../KiwiApp_General/KiwiApp_StoredSettings.h"
32 
33 #include "KiwiApp_ApiController.h"
34 
35 namespace kiwi
36 {
37  // ================================================================================ //
38  // DOCUMENT BROWSER //
39  // ================================================================================ //
40 
42  class DocumentBrowser : public juce::Timer
43  {
44  public: // nested classes
45 
46  class Drive;
47 
48  public: // methods
49 
51  DocumentBrowser(std::string const& drive_name, int refresh_time);
52 
54  ~DocumentBrowser();
55 
57  void setDriveName(std::string const& name);
58 
60  void timerCallback() override;
61 
63  Drive* getDrive() const;
64 
65  private: // methods
66 
68  static void handleDeniedRequest();
69 
70  private: // variables
71 
72  std::unique_ptr<Drive> m_distant_drive;
73  int m_refresh_time;
74  };
75 
76  // ================================================================================ //
77  // DOCUMENT BROWSER DRIVE //
78  // ================================================================================ //
79 
80  class DocumentBrowser::Drive
81  {
82  public: // nested classes
83 
84  struct Listener;
85  class DocumentSession;
86 
87  using DocumentSessions = std::vector<std::unique_ptr<DocumentSession>>;
88 
89  private:
90 
91  using Comp = std::function<bool(DocumentSession const& l_hs, DocumentSession const& r_hs)>;
92 
93  public: // methods
94 
95  Drive(std::string const& name);
96 
97  ~Drive() = default;
98 
100  void addListener(Listener& listener);
101 
103  void removeListener(Listener& listener);
104 
106  void setName(std::string const& host);
107 
109  std::string const& getName() const;
110 
113  void uploadDocument(std::string const& name, std::string const& data);
114 
116  void createNewDocument();
117 
119  void setSort(Comp comp);
120 
122  DocumentSessions const& getDocuments() const;
123 
125  DocumentSessions& getDocuments();
126 
128  void refresh();
129 
130  private: // methods
131 
133  void refresh_internal();
134 
135  private: // members
136 
138  void updateDocumentList(Api::Documents docs);
139 
140  std::string m_name;
141  DocumentSessions m_documents;
142  tool::Listeners<Listener> m_listeners;
143  Comp m_sort;
144  std::shared_ptr<Drive> m_drive;
145 
146  friend class DocumentBrowser;
147  };
148 
149  // ================================================================================ //
150  // DOCUMENT BROWSER LISTENER //
151  // ================================================================================ //
152 
154  struct DocumentBrowser::Drive::Listener
155  {
157  virtual ~Listener() = default;
158 
160  virtual void documentAdded(DocumentBrowser::Drive::DocumentSession& doc) {};
161 
163  virtual void documentChanged(DocumentBrowser::Drive::DocumentSession& doc) {};
164 
166  virtual void documentRemoved(DocumentBrowser::Drive::DocumentSession& doc) {};
167 
169  virtual void driveChanged() {};
170  };
171 
172  // ================================================================================ //
173  // DRIVE DOCUMENT //
174  // ================================================================================ //
175 
176  class DocumentBrowser::Drive::DocumentSession
177  {
178  public: // methods
179 
181  DocumentSession(DocumentBrowser::Drive& parent, Api::Document document);
182 
184  ~DocumentSession();
185 
187  Drive& useDrive();
188 
190  void open();
191 
193  std::string getName() const;
194 
196  uint64_t getSessionId() const;
197 
199  std::string const& getOpenToken() const;
200 
202  DocumentBrowser::Drive const& useDrive() const;
203 
205  void rename(std::string const& new_name);
206 
208  void duplicate();
209 
211  void trash();
212 
213  // @brief Moves document out of the trash.
214  void untrash();
215 
219  void download(std::function<void(std::string const&)> callback);
220 
222  std::string const& getCreationDate() const;
223 
225  std::string const& getAuthor() const;
226 
228  bool isTrashed() const;
229 
231  std::string const& getTrashedDate() const;
232 
234  std::string const& getOpenedDate() const;
235 
237  std::string const& getOpenedUser() const;
238 
241  bool operator==(DocumentSession const& other_doc) const;
242 
243  private: // members
244 
245  DocumentBrowser::Drive& m_drive;
246  Api::Document m_document;
247  std::string m_open_token;
248  std::shared_ptr<DocumentSession> m_session;
249 
250  friend class DocumentBrowser::Drive;
251  };
252 }
kiwi::DocumentBrowser::timerCallback
void timerCallback() override
juce::Timer callback.
Definition: KiwiApp_DocumentBrowser.cpp:62
+
kiwi::DocumentBrowser::Drive::Listener::driveChanged
virtual void driveChanged()
Called when one or more documents has been added, removed or changed.
Definition: KiwiApp_DocumentBrowser.h:169
+
kiwi::DocumentBrowser::Drive
Definition: KiwiApp_DocumentBrowser.h:80
+
kiwi::duplicate
Duplicate selected objects and paste them on patcher.
Definition: KiwiApp_CommandIDs.h:54
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::DocumentBrowser::getDrives
std::vector< Drive * > getDrives() const
Returns a list of drives.
Definition: KiwiApp_DocumentBrowser.cpp:74
-
kiwi::engine::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiEngine_Listeners.h:40
-
kiwi::DocumentBrowser::Drive::DocumentSession
Definition: KiwiApp_DocumentBrowser.h:218
-
kiwi::DocumentBrowser::~DocumentBrowser
~DocumentBrowser()
Destructor.
Definition: KiwiApp_DocumentBrowser.cpp:58
-
kiwi::DocumentBrowser::Drive::Listener::documentChanged
virtual void documentChanged(DocumentBrowser::Drive::DocumentSession &doc)
Called when a document session changed.
Definition: KiwiApp_DocumentBrowser.h:205
-
kiwi::DocumentBrowser::Drive::Listener
Listen to document browser changes.
Definition: KiwiApp_DocumentBrowser.h:196
-
kiwi::DocumentBrowser::Drive::Listener::documentAdded
virtual void documentAdded(DocumentBrowser::Drive::DocumentSession &doc)
Called when a document session has been added.
Definition: KiwiApp_DocumentBrowser.h:202
-
kiwi::Api::Document
Definition: KiwiApp_Api.h:42
-
kiwi::NetworkSettings::Listener
NetworkSettings Listener.
Definition: KiwiApp_StoredSettings.h:76
-
kiwi::DocumentBrowser
Request Patcher document informations through a Kiwi API.
Definition: KiwiApp_DocumentBrowser.h:40
-
kiwi::Api
An API request handler class.
Definition: KiwiApp_Api.h:36
-
kiwi::DocumentBrowser::removeListener
void removeListener(Listener &listener)
remove a listener.
Definition: KiwiApp_DocumentBrowser.cpp:113
-
kiwi::DocumentBrowser::DocumentBrowser
DocumentBrowser()
Constructor.
Definition: KiwiApp_DocumentBrowser.cpp:39
-
kiwi::DocumentBrowser::Drive::Listener::documentRemoved
virtual void documentRemoved(DocumentBrowser::Drive::DocumentSession &doc)
Called when a document session has been removed.
Definition: KiwiApp_DocumentBrowser.h:208
+
kiwi::DocumentBrowser::DocumentBrowser
DocumentBrowser(std::string const &drive_name, int refresh_time)
Constructor.
Definition: KiwiApp_DocumentBrowser.cpp:37
+
kiwi::tool::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiTool_Listeners.h:38
+
kiwi::DocumentBrowser::Drive::DocumentSession
Definition: KiwiApp_DocumentBrowser.h:176
+
kiwi::DocumentBrowser::~DocumentBrowser
~DocumentBrowser()
Destructor.
Definition: KiwiApp_DocumentBrowser.cpp:47
+
kiwi::DocumentBrowser::Drive::Listener::documentChanged
virtual void documentChanged(DocumentBrowser::Drive::DocumentSession &doc)
Called when a document session changed.
Definition: KiwiApp_DocumentBrowser.h:163
+
kiwi::DocumentBrowser::Drive::Listener
Listen to document browser changes.
Definition: KiwiApp_DocumentBrowser.h:154
+
kiwi::Api::Document
Definition: KiwiApp_Api.h:345
+
kiwi::DocumentBrowser::Drive::Listener::documentAdded
virtual void documentAdded(DocumentBrowser::Drive::DocumentSession &doc)
Called when a document session has been added.
Definition: KiwiApp_DocumentBrowser.h:160
+
kiwi::DocumentBrowser::setDriveName
void setDriveName(std::string const &name)
Sets the drive&#39;s name.
Definition: KiwiApp_DocumentBrowser.cpp:52
+
kiwi::DocumentBrowser::getDrive
Drive * getDrive() const
Returns a list of drives.
Definition: KiwiApp_DocumentBrowser.cpp:57
+
kiwi::DocumentBrowser
Request Patcher document informations through a Kiwi API.
Definition: KiwiApp_DocumentBrowser.h:42
+
kiwi::DocumentBrowser::Drive::Listener::documentRemoved
virtual void documentRemoved(DocumentBrowser::Drive::DocumentSession &doc)
Called when a document session has been removed.
Definition: KiwiApp_DocumentBrowser.h:166
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___document_browser_view_8h_source.html b/docs/html/_kiwi_app___document_browser_view_8h_source.html index 07249a94..701f555f 100644 --- a/docs/html/_kiwi_app___document_browser_view_8h_source.html +++ b/docs/html/_kiwi_app___document_browser_view_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Application/KiwiApp_DocumentBrowserView.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_DocumentBrowserView.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Listeners.h>
25 
26 #include "../KiwiApp_Network/KiwiApp_DocumentBrowser.h"
27 #include "../KiwiApp_Components/KiwiApp_ImageButton.h"
28 
29 namespace kiwi
30 {
31  // ================================================================================ //
32  // DOCUMENT BROWSER VIEW //
33  // ================================================================================ //
34 
35  class DocumentBrowserView : public juce::Component, public DocumentBrowser::Listener
36  {
37  public: // methods
38 
40  DocumentBrowserView(DocumentBrowser& browser);
41 
43  ~DocumentBrowserView();
44 
46  void driveAdded(DocumentBrowser::Drive& drive) override;
47 
49  void driveChanged(DocumentBrowser::Drive const& drive) override;
50 
52  void driveRemoved(DocumentBrowser::Drive const& drive) override;
53 
55  void resized() override;
56 
58  void paint(juce::Graphics& g) override;
59 
60  private: // nested classes
61 
62  class DriveView;
63 
64  private: // members
65 
66  DocumentBrowser& m_browser;
67  std::vector<std::unique_ptr<DriveView>> m_drives;
68  };
69 
70  // ================================================================================ //
71  // BROWSER DRIVE VIEW //
72  // ================================================================================ //
73 
75  class DocumentBrowserView::DriveView :
76  public juce::ListBox,
77  public juce::ListBoxModel,
78  public DocumentBrowser::Drive::Listener
79  {
80  public:
81 
83  DriveView(DocumentBrowser::Drive& drive);
84 
86  ~DriveView();
87 
89  std::string getHostName() const;
90 
93  void driveChanged() override;
94 
96  int getNumRows() override;
97 
101  void paintListBoxItem(int rowNumber, juce::Graphics& g, int width, int height, bool selected) override;
102 
104  juce::Component* refreshComponentForRow(int row, bool selected,
105  juce::Component* component_to_update) override;
106 
108  void backgroundClicked(juce::MouseEvent const& e) override;
109 
111  void returnKeyPressed(int last_row_selected) override;
112 
114  void listBoxItemDoubleClicked(int row, juce::MouseEvent const& e) override;
115 
117  bool operator==(DocumentBrowser::Drive const& other_drive) const;
118 
120  void openDocument(int row);
121 
123  void renameDocumentForRow(int row, std::string const& new_name);
124 
125  private: // classes
126 
127  class Header;
128  class RowElem;
129 
130  private: // members
131 
132  DocumentBrowser::Drive& m_drive;
133  };
134 
135  // ================================================================================ //
136  // BROWSER DRIVE VIEW HEADER //
137  // ================================================================================ //
138 
139  class DocumentBrowserView::DriveView::Header : public juce::Component
140  {
141  public: // methods
142 
144  Header(juce::ListBox& listbox, DocumentBrowser::Drive& drive);
145 
147  ~Header() = default;
148 
150  void paint(juce::Graphics& g) override;
151 
153  void resized() override;
154 
156  void mouseDown(juce::MouseEvent const& event) override;
157 
158  private: // members
159 
160  juce::ListBox& m_listbox;
161  DocumentBrowser::Drive& m_drive;
162  ImageButton m_refresh_btn;
163  ImageButton m_create_document_btn;
164  const juce::Image m_folder_img;
165  };
166 
167  // ================================================================================ //
168  // BROWSER DRIVE VIEW ROW ELEM //
169  // ================================================================================ //
170 
171  class DocumentBrowserView::DriveView::RowElem : public juce::Component, juce::Label::Listener
172  {
173  public: // methods
174 
176  RowElem(DriveView& drive_view, std::string const& name);
177 
179  ~RowElem();
180 
182  void showEditor();
183 
185  void paint(juce::Graphics& g) override;
186 
188  void resized() override;
189 
191  void mouseEnter(juce::MouseEvent const& event) override;
192 
194  void mouseExit(juce::MouseEvent const& event) override;
195 
197  void mouseDown(juce::MouseEvent const& event) override;
198 
200  void mouseUp(juce::MouseEvent const& event) override;
201 
203  void mouseDoubleClick(juce::MouseEvent const& event) override;
204 
206  void labelTextChanged(juce::Label* label_text_that_has_changed) override;
207 
209  void update(std::string const& name, int row, bool now_selected);
210 
211  private: // variables
212 
213  DriveView& m_drive_view;
214  std::string m_name;
215  ImageButton m_open_btn;
216  juce::Label m_name_label;
217 
218  const juce::Image m_kiwi_filetype_img;
219 
220  int m_row;
221  bool m_selected;
222  bool m_mouseover = false;
223  bool m_select_row_on_mouse_up = false;
224  };
225 }
kiwi::DocumentBrowser::Drive
Definition: KiwiApp_DocumentBrowser.h:110
-
kiwi::DocumentBrowserView::driveChanged
void driveChanged(DocumentBrowser::Drive const &drive) override
Called when a drive changed.
Definition: KiwiApp_DocumentBrowserView.cpp:76
-
kiwi::DocumentBrowserView::DocumentBrowserView
DocumentBrowserView(DocumentBrowser &browser)
Constructor.
Definition: KiwiApp_DocumentBrowserView.cpp:36
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Listeners.h>
25 
26 #include "../KiwiApp_Network/KiwiApp_DocumentBrowser.h"
27 #include "../KiwiApp_Components/KiwiApp_ImageButton.h"
28 
29 namespace kiwi
30 {
31  // ================================================================================ //
32  // DOCUMENT BROWSER VIEW //
33  // ================================================================================ //
34 
35  class DocumentBrowserView : public juce::Component
36  {
37  public: // methods
38 
40  DocumentBrowserView(DocumentBrowser& browser, bool enabled);
41 
43  ~DocumentBrowserView();
44 
46  void resized() override;
47 
49  void paint(juce::Graphics& g) override;
50 
51  private: // methods
52 
53  void enablementChanged() override final;
54 
55  private: // nested classes
56 
57  class DriveView;
58 
59  private: // members
60 
61  DocumentBrowser& m_browser;
62  std::vector<std::unique_ptr<DriveView>> m_drives;
63  };
64 
65  // ================================================================================ //
66  // BROWSER DRIVE VIEW //
67  // ================================================================================ //
68 
70  class DocumentBrowserView::DriveView :
71  public juce::ListBox,
72  public juce::ListBoxModel,
73  public DocumentBrowser::Drive::Listener
74  {
75  private: // classes
76 
77  enum class DataType
78  {
79  name,
80  author,
81  creationDate,
82  openedDate,
83  openedUser
84  };
85 
86  struct Comp
87  {
88  bool compare(DocumentBrowser::Drive::DocumentSession const& l_hs,
89  DocumentBrowser::Drive::DocumentSession const& r_hs) const;
90 
91  DataType m_type = DataType::creationDate;
92  bool m_trashed_first = false;
93  };
94 
95  public: // methods
96 
98  DriveView(DocumentBrowser::Drive& drive);
99 
101  ~DriveView();
102 
104  std::string getHostName() const;
105 
108  void driveChanged() override;
109 
111  void disable();
112 
114  void enable();
115 
117  int getNumRows() override;
118 
122  void paintListBoxItem(int rowNumber, juce::Graphics& g, int width, int height, bool selected) override;
123 
125  juce::Component* refreshComponentForRow(int row, bool selected,
126  juce::Component* component_to_update) override;
127 
129  void backgroundClicked(juce::MouseEvent const& e) override;
130 
132  void returnKeyPressed(int last_row_selected) override;
133 
135  void listBoxItemDoubleClicked(int row, juce::MouseEvent const& e) override;
136 
138  void openDocument(int row);
139 
141  void duplicateDocumentForRow(int row);
142 
144  void renameDocumentForRow(int row, std::string const& new_name);
145 
147  void uploadDocument();
148 
150  void downloadDocumentForRow(int row);
151 
153  void deleteDocumentForRow(int row);
154 
156  void restoreDocumentForRow(int row);
157 
158  private: // methods
159 
161  void enablementChanged() override final;
162 
164  void update();
165 
167  std::string const& getDriveName() const;
168 
170  void refresh();
171 
173  void createDocument();
174 
176  DataType getSortType() const;
177 
179  void setSortType(DataType sort_type);
180 
181  // @brief Set the trash mode.
182  void setTrashMode(bool trash_mode);
183 
185  bool getTrashMode() const;
186 
188  std::string createDocumentToolTip(DocumentBrowser::Drive::DocumentSession const& doc);
189 
190  private: // classes
191 
192  class Header;
193  class RowElem;
194 
195  private: // members
196 
197  DocumentBrowser::Drive& m_drive;
198  std::string m_name;
199  bool m_trash_mode;
200  bool m_enabled;
201  Comp m_sorter;
202  };
203 
204  // ================================================================================ //
205  // BROWSER DRIVE VIEW HEADER //
206  // ================================================================================ //
207 
208  class DocumentBrowserView::DriveView::Header : public juce::Component
209  {
210  public: // methods
211 
213  Header(DocumentBrowserView::DriveView& drive_view);
214 
216  ~Header() = default;
217 
219  void paint(juce::Graphics& g) override;
220 
222  void resized() override;
223 
225  void mouseDown(juce::MouseEvent const& event) override;
226 
228  void setText(std::string const& text);
229 
230  private: // methods
231 
232  void enablementChanged() override final;
233 
234  private: // members
235 
236  DocumentBrowserView::DriveView& m_drive_view;
237  ImageButton m_refresh_btn;
238  ImageButton m_create_document_btn;
239  ImageButton m_trash_btn;
240  juce::Rectangle<int> m_folder_bounds;
241  juce::Label m_label;
242  juce::Image m_folder_img;
243  juce::Image m_disable_folder_img;
244  };
245 
246  // ================================================================================ //
247  // BROWSER DRIVE VIEW ROW ELEM //
248  // ================================================================================ //
249 
250  class DocumentBrowserView::DriveView::RowElem : public juce::Component,
251  public juce::SettableTooltipClient,
252  public juce::Label::Listener
253  {
254  public: // methods
255 
257  RowElem(DriveView& drive_view, std::string const& name, std::string const& tooltip);
258 
260  ~RowElem();
261 
263  void showEditor();
264 
266  void paint(juce::Graphics& g) override;
267 
269  void resized() override;
270 
272  void mouseEnter(juce::MouseEvent const& event) override;
273 
275  void mouseExit(juce::MouseEvent const& event) override;
276 
278  void mouseDown(juce::MouseEvent const& event) override;
279 
281  void mouseUp(juce::MouseEvent const& event) override;
282 
284  void mouseDoubleClick(juce::MouseEvent const& event) override;
285 
287  void labelTextChanged(juce::Label* label_text_that_has_changed) override;
288 
290  void update(std::string const& name, std::string const& tooltip, int row, bool now_selected);
291 
292  private: // methods
293 
294  void showPopup();
295 
296  private: // variables
297 
298  DriveView& m_drive_view;
299  std::string m_name;
300  ImageButton m_open_btn;
301  juce::Label m_name_label;
302 
303  const juce::Image m_kiwi_filetype_img;
304 
305  int m_row;
306  bool m_selected;
307  bool m_mouseover = false;
308  };
309 }
kiwi::DocumentBrowser::Drive
Definition: KiwiApp_DocumentBrowser.h:80
kiwi::ImageButton
A button that displays a Drawable.
Definition: KiwiApp_ImageButton.h:33
-
kiwi::DocumentBrowserView::DriveView::Header
Definition: KiwiApp_DocumentBrowserView.h:139
-
kiwi::DocumentBrowserView::~DocumentBrowserView
~DocumentBrowserView()
Destructor.
Definition: KiwiApp_DocumentBrowserView.cpp:49
-
kiwi::DocumentBrowserView::DriveView
Listen to document browser changes.
Definition: KiwiApp_DocumentBrowserView.h:75
-
kiwi::DocumentBrowser::Listener
Listen to document explorer changes.
Definition: KiwiApp_DocumentBrowser.h:91
+
kiwi::DocumentBrowserView::DriveView::Header
Definition: KiwiApp_DocumentBrowserView.h:208
+
kiwi::DocumentBrowserView::~DocumentBrowserView
~DocumentBrowserView()
Destructor.
Definition: KiwiApp_DocumentBrowserView.cpp:61
+
kiwi::DocumentBrowserView::DriveView
Listen to document browser changes.
Definition: KiwiApp_DocumentBrowserView.h:70
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::DocumentBrowserView::DriveView::RowElem
Definition: KiwiApp_DocumentBrowserView.h:171
-
kiwi::DocumentBrowserView::resized
void resized() override
Called when resized.
Definition: KiwiApp_DocumentBrowserView.cpp:81
+
kiwi::DocumentBrowserView::DriveView::RowElem
Definition: KiwiApp_DocumentBrowserView.h:250
+
kiwi::DocumentBrowserView::resized
void resized() override
Called when resized.
Definition: KiwiApp_DocumentBrowserView.cpp:65
+
kiwi::DocumentBrowser::Drive::DocumentSession
Definition: KiwiApp_DocumentBrowser.h:176
kiwi::DocumentBrowserView
Definition: KiwiApp_DocumentBrowserView.h:35
-
kiwi::DocumentBrowser::Drive::Listener
Listen to document browser changes.
Definition: KiwiApp_DocumentBrowser.h:196
-
kiwi::DocumentBrowserView::driveAdded
void driveAdded(DocumentBrowser::Drive &drive) override
Called when the document list changed.
Definition: KiwiApp_DocumentBrowserView.cpp:54
-
kiwi::DocumentBrowser
Request Patcher document informations through a Kiwi API.
Definition: KiwiApp_DocumentBrowser.h:40
-
kiwi::DocumentBrowserView::driveRemoved
void driveRemoved(DocumentBrowser::Drive const &drive) override
Called when the document list changed.
Definition: KiwiApp_DocumentBrowserView.cpp:63
-
kiwi::DocumentBrowserView::paint
void paint(juce::Graphics &g) override
juce::Component::paint
Definition: KiwiApp_DocumentBrowserView.cpp:93
+
kiwi::DocumentBrowserView::DocumentBrowserView
DocumentBrowserView(DocumentBrowser &browser, bool enabled)
Constructor.
Definition: KiwiApp_DocumentBrowserView.cpp:42
+
kiwi::DocumentBrowser::Drive::Listener
Listen to document browser changes.
Definition: KiwiApp_DocumentBrowser.h:154
+
kiwi::DocumentBrowser
Request Patcher document informations through a Kiwi API.
Definition: KiwiApp_DocumentBrowser.h:42
+
kiwi::DocumentBrowserView::paint
void paint(juce::Graphics &g) override
juce::Component::paint
Definition: KiwiApp_DocumentBrowserView.cpp:77
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___dsp_device_manager_8h_source.html b/docs/html/_kiwi_app___dsp_device_manager_8h_source.html index 56874546..44a871e8 100644 --- a/docs/html/_kiwi_app___dsp_device_manager_8h_source.html +++ b/docs/html/_kiwi_app___dsp_device_manager_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Audio/KiwiApp_DspDeviceManager.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_DspDeviceManager.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiDsp/KiwiDsp_Signal.h>
25 #include <KiwiDsp/KiwiDsp_Chain.h>
26 #include <KiwiEngine/KiwiEngine_AudioControler.h>
27 
28 #include <juce_audio_devices/juce_audio_devices.h>
29 
30 #include "../KiwiApp_Components/KiwiApp_Window.h"
31 
32 namespace kiwi
33 {
34  // ================================================================================ //
35  // DSP DEVICE MANAGER //
36  // ================================================================================ //
37 
38  class DspDeviceManager : public juce::AudioIODeviceCallback,
39  public juce::AudioDeviceManager,
40  public engine::AudioControler
41  {
42  public: // methods
43 
47  DspDeviceManager();
48 
50  ~DspDeviceManager();
51 
52  // ================================================================================ //
53  // AudioControler //
54  // ================================================================================ //
55 
58  void add(dsp::Chain& chain) override;
59 
62  void remove(dsp::Chain& chain) override;
63 
65  void startAudio() override;
66 
68  void stopAudio() override;
69 
71  bool isAudioOn() const override;
72 
74  void addToChannel(size_t const channel, dsp::Signal const& output_buffer) override;
75 
77  void getFromChannel(size_t const channel, dsp::Signal & input_signal) override;
78 
79  private: // methods
80 
81  // ================================================================================ //
82  // AudioIODeviceCallback //
83  // ================================================================================ //
84 
86  void audioDeviceIOCallback(const float** inputChannelData,
87  int numInputChannels,
88  float** outputChannelData,
89  int numOutputChannels,
90  int numSamples) override;
91 
93  void audioDeviceAboutToStart(juce::AudioIODevice* device) override;
94 
96  void audioDeviceStopped() override;
97 
98  // ================================================================================ //
99  // DSP DEVICE //
100  // ================================================================================ //
101 
104  void tick() const noexcept;
105 
106  private: // members
107 
108  std::unique_ptr<dsp::Buffer> m_input_matrix;
109  std::unique_ptr<dsp::Buffer> m_output_matrix;
110  std::vector<dsp::Chain*> m_chains;
111  bool m_is_playing;
112  mutable std::mutex m_mutex;
113  };
114 }
kiwi::DspDeviceManager::addToChannel
void addToChannel(size_t const channel, dsp::Signal const &output_buffer) override
Adds a buffer to the output matrix of signal.
Definition: KiwiApp_DspDeviceManager.cpp:114
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiDsp/KiwiDsp_Signal.h>
25 #include <KiwiDsp/KiwiDsp_Chain.h>
26 #include <KiwiEngine/KiwiEngine_AudioControler.h>
27 
28 #include <juce_audio_devices/juce_audio_devices.h>
29 
30 #include "../KiwiApp_Components/KiwiApp_Window.h"
31 
32 namespace kiwi
33 {
34  // ================================================================================ //
35  // DSP DEVICE MANAGER //
36  // ================================================================================ //
37 
38  class DspDeviceManager : public juce::AudioIODeviceCallback,
39  public juce::AudioDeviceManager,
40  public engine::AudioControler
41  {
42  public: // methods
43 
47  DspDeviceManager();
48 
50  ~DspDeviceManager();
51 
52  // ================================================================================ //
53  // AudioControler //
54  // ================================================================================ //
55 
58  void add(dsp::Chain& chain) override;
59 
62  void remove(dsp::Chain& chain) override;
63 
65  void startAudio() override;
66 
68  void stopAudio() override;
69 
71  bool isAudioOn() const override;
72 
74  void addToChannel(size_t const channel, dsp::Signal const& output_buffer) override;
75 
77  void getFromChannel(size_t const channel, dsp::Signal & input_signal) override;
78 
79  private: // methods
80 
81  // ================================================================================ //
82  // AudioIODeviceCallback //
83  // ================================================================================ //
84 
86  void audioDeviceIOCallback(const float** inputChannelData,
87  int numInputChannels,
88  float** outputChannelData,
89  int numOutputChannels,
90  int numSamples) override;
91 
93  void audioDeviceAboutToStart(juce::AudioIODevice* device) override;
94 
96  void audioDeviceStopped() override;
97 
98  // ================================================================================ //
99  // DSP DEVICE //
100  // ================================================================================ //
101 
104  void tick() const noexcept;
105 
106  private: // members
107 
108  std::unique_ptr<dsp::Buffer> m_input_matrix;
109  std::unique_ptr<dsp::Buffer> m_output_matrix;
110  std::vector<dsp::Chain*> m_chains;
111  bool m_is_playing;
112  mutable std::mutex m_mutex;
113  };
114 }
kiwi::DspDeviceManager::addToChannel
void addToChannel(size_t const channel, dsp::Signal const &output_buffer) override
Adds a buffer to the output matrix of signal.
Definition: KiwiApp_DspDeviceManager.cpp:114
kiwi::dsp::Chain
An audio rendering class that manages processors in a graph structure.
Definition: KiwiDsp_Chain.h:45
kiwi::DspDeviceManager::DspDeviceManager
DspDeviceManager()
Constructor.
Definition: KiwiApp_DspDeviceManager.cpp:36
kiwi::engine::AudioControler
AudioControler is a pure interface that enable controling audio in kiwi.
Definition: KiwiEngine_AudioControler.h:35
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::DspDeviceManager::isAudioOn
bool isAudioOn() const override
Returns true if the audio is on.
Definition: KiwiApp_DspDeviceManager.cpp:109
kiwi::DspDeviceManager::stopAudio
void stopAudio() override
Stops the device.
Definition: KiwiApp_DspDeviceManager.cpp:102
kiwi::DspDeviceManager::startAudio
void startAudio() override
Starts the device.
Definition: KiwiApp_DspDeviceManager.cpp:95
kiwi::DspDeviceManager
Definition: KiwiApp_DspDeviceManager.h:38
kiwi::DspDeviceManager::getFromChannel
void getFromChannel(size_t const channel, dsp::Signal &input_signal) override
Gets a buffer from the input matrix signal.
Definition: KiwiApp_DspDeviceManager.cpp:122
kiwi::DspDeviceManager::add
void add(dsp::Chain &chain) override
Adds a chain to the dsp device manager.
Definition: KiwiApp_DspDeviceManager.cpp:63
kiwi::DspDeviceManager::~DspDeviceManager
~DspDeviceManager()
Destructor.
Definition: KiwiApp_DspDeviceManager.cpp:55
+
kiwi::DspDeviceManager::isAudioOn
bool isAudioOn() const override
Returns true if the audio is on.
Definition: KiwiApp_DspDeviceManager.cpp:109
kiwi::dsp::Signal
A class that wraps a vector of sample_t.
Definition: KiwiDsp_Signal.h:39
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___editable_object_view_8h_source.html b/docs/html/_kiwi_app___editable_object_view_8h_source.html new file mode 100644 index 00000000..2b19f4e6 --- /dev/null +++ b/docs/html/_kiwi_app___editable_object_view_8h_source.html @@ -0,0 +1,117 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_EditableObjectView.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_EditableObjectView.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Listeners.h>
25 
26 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h>
27 
28 namespace kiwi
29 {
30  // ================================================================================ //
31  // EDITABLE OBJECT VIEW //
32  // ================================================================================ //
33 
35  class EditableObjectView : public ObjectView, public juce::Label::Listener
36  {
37  public: // classes
38 
39  struct Listener
40  {
42  virtual ~Listener() = default;
43 
45  virtual void textChanged(std::string const& new_text) = 0;
46 
48  virtual void editorHidden() = 0;
49 
51  virtual void editorShown() = 0;
52  };
53 
54  private: // classes
55 
56  class Label : public juce::Label
57  {
58  public: // methods
59 
61  Label(EditableObjectView & object_view);
62 
64  ~Label();
65 
67  juce::TextEditor* createEditorComponent() override final;
68 
69  private: // members
70 
71  EditableObjectView & m_object_view;
72  };
73 
74  public: // methods
75 
78  EditableObjectView(model::Object & object_model);
79 
81  ~EditableObjectView();
82 
84  void addListener(Listener& listener);
85 
87  void removeListener(Listener& listener);
88 
90  void edit();
91 
92  protected: // methods
93 
95  juce::Label & getLabel();
96 
99  void setEditable(bool editable);
100 
101  private: // methods
102 
104  virtual juce::TextEditor* createdTextEditor() = 0;
105 
107  virtual void textChanged() = 0;
108 
111  void labelTextChanged (juce::Label* label) override final;
112 
115  void editorHidden (juce::Label* label, juce::TextEditor& text_editor) override final;
116 
119  void editorShown(juce::Label* label, juce::TextEditor& text_editor) override final;
120 
121  private: // members
122 
123  Label m_label;
124  bool m_editable;
125  tool::Listeners<Listener> m_listeners;
126 
127  private: // deleted methods
128 
129  EditableObjectView() = delete;
130  EditableObjectView(EditableObjectView const& other) = delete;
131  EditableObjectView(EditableObjectView && other) = delete;
132  EditableObjectView& operator=(EditableObjectView const& other) = delete;
133  EditableObjectView& operator=(EditableObjectView && other) = delete;
134  };
135 }
kiwi::EditableObjectView::Listener::editorShown
virtual void editorShown()=0
Called when the classic view enters its edition mode.
+
kiwi::EditableObjectView::~EditableObjectView
~EditableObjectView()
Destructor.
Definition: KiwiApp_EditableObjectView.cpp:38
+
kiwi::EditableObjectView::Listener
Definition: KiwiApp_EditableObjectView.h:39
+
kiwi::EditableObjectView::edit
void edit()
Edits the label.
Definition: KiwiApp_EditableObjectView.cpp:47
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiTool_Listeners.h:38
+
kiwi::EditableObjectView
Abstract class for object&#39;s views that can be edited in mode unlock.
Definition: KiwiApp_EditableObjectView.h:35
+
kiwi::EditableObjectView::Listener::~Listener
virtual ~Listener()=default
Destructor.
+
kiwi::EditableObjectView::Listener::textChanged
virtual void textChanged(std::string const &new_text)=0
Called when the text has been edited and return key was pressed.
+
kiwi::ObjectView
Abstract for objects graphical representation.
Definition: KiwiApp_ObjectView.h:42
+
kiwi::EditableObjectView::getLabel
juce::Label & getLabel()
Returns the label created by the editable object.
Definition: KiwiApp_EditableObjectView.cpp:62
+
kiwi::EditableObjectView::removeListener
void removeListener(Listener &listener)
Remove a listener.
Definition: KiwiApp_EditableObjectView.cpp:86
+
kiwi::EditableObjectView::Listener::editorHidden
virtual void editorHidden()=0
Called when the classic view ends its edition.
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::EditableObjectView::addListener
void addListener(Listener &listener)
Add a listener.
Definition: KiwiApp_EditableObjectView.cpp:81
+
kiwi::EditableObjectView::setEditable
void setEditable(bool editable)
Sets the editable object view as editable or not.
Definition: KiwiApp_EditableObjectView.cpp:42
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___factory_8h_source.html b/docs/html/_kiwi_app___factory_8h_source.html new file mode 100644 index 00000000..438e57b4 --- /dev/null +++ b/docs/html/_kiwi_app___factory_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_Factory.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_Factory.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #include <functional>
23 #include <memory>
24 #include <map>
25 
26 #include <KiwiModel/KiwiModel_Object.h>
27 
28 #include <KiwiModel/KiwiModel_Factory.h>
29 
30 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h>
31 
32 #pragma once
33 
34 namespace kiwi
35 {
36  // ================================================================================ //
37  // FACTORY //
38  // ================================================================================ //
39 
40  class Factory
41  {
42  public: // definitions
43 
44  using ctor_fn_t = std::function<std::unique_ptr<ObjectView>(model::Object & model)>;
45 
46  public: // methods
47 
50  static std::unique_ptr<ObjectView> createObjectView(model::Object & object_model);
51 
53  template<class TObject>
54  static void add(std::string const& name, ctor_fn_t create_method)
55  {
56  static_assert(std::is_base_of<ObjectView, TObject>::value,
57  "object's view doesn't inherit from class ObjectView");
58 
59  static_assert(!std::is_abstract<TObject>::value,
60  "The object's view must not be abstract.");
61 
62  assert(model::Factory::has(name) && "Adding an engine object that has no corresponding model");
63  assert(m_creators.count(name) == 0 && "The object already exists");
64 
65  m_creators[name] = create_method;
66  };
67 
68  static std::map<std::string, ctor_fn_t> m_creators;
69 
70  private: // deleted methods
71 
72  Factory() = delete;
73  ~Factory() = delete;
74  Factory(Factory const& other) = delete;
75  Factory(Factory && other) = delete;
76  Factory& operator=(Factory const& other) = delete;
77  Factory& operator=(Factory && other) = delete;
78  };
79 }
kiwi::Factory::add
static void add(std::string const &name, ctor_fn_t create_method)
Adds a object to the factory.
Definition: KiwiApp_Factory.h:54
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::Factory
Definition: KiwiApp_Factory.h:40
+
kiwi::model::Factory::has
static bool has(std::string const &name)
Returns true if a given string match a registered object class name.
Definition: KiwiModel_Factory.cpp:100
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::Factory::createObjectView
static std::unique_ptr< ObjectView > createObjectView(model::Object &object_model)
The construction methods.
Definition: KiwiApp_Factory.cpp:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___form_component_8h_source.html b/docs/html/_kiwi_app___form_component_8h_source.html new file mode 100644 index 00000000..ce0bb60b --- /dev/null +++ b/docs/html/_kiwi_app___form_component_8h_source.html @@ -0,0 +1,114 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_FormComponent.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // ALERT BOX //
30  // ================================================================================ //
31 
32  class AlertBox : public juce::Component, private juce::ButtonListener
33  {
34  public: // methods
35 
36  enum class Type : uint8_t
37  {
38  Info = 0,
39  Success = 1,
40  Error = 2
41  };
42 
44  AlertBox(std::string const& message,
45  Type type = Type::Info,
46  bool can_cancel = true,
47  std::function<void(void)> on_close = nullptr);
48 
50  ~AlertBox();
51 
52  private: // methods
53 
55  void paint(juce::Graphics&) override;
56 
58  void resized() override;
59 
61  void buttonClicked(juce::Button*) override;
62 
63  private: // variables
64 
65  std::string m_message;
66  Type m_type = Type::Info;
67  std::unique_ptr<juce::TextButton> m_close_btn;
68  std::function<void(void)> m_close_fn;
69  };
70 
71  // ================================================================================ //
72  // FORM COMPONENT //
73  // ================================================================================ //
74 
75  class FormComponent : public juce::Component, private juce::ButtonListener
76  {
77  public: // methods
78 
79  class Field;
80 
83  FormComponent(std::string const& submit_button_text,
84  std::string const& overlay_text = "");
85 
87  virtual ~FormComponent();
88 
91  virtual void dismiss();
92 
95  int getBestHeight();
96 
97  protected: // methods
98 
100  template<class FieldType, class... Args>
101  FieldType& addField(Args&&... args);
102 
104  juce::Value getFieldValue(std::string const& name);
105 
107  void removeField(std::string const& name);
108 
110  void clearFields();
111 
113  void showAlert(std::string const& message,
114  AlertBox::Type type = AlertBox::Type::Error);
115 
117  void showOverlay();
118 
120  void showSuccessOverlay(juce::String const& message);
121 
123  void hideOverlay();
124 
126  void setSubmitText(std::string const& submit_text);
127 
129  bool hasOverlay();
130 
133  virtual void onUserSubmit() = 0;
134 
138  virtual void onUserCancelled();
139 
141  void resized() override;
142 
144  int getFieldsHeight();
145 
146  private: // methods
147 
149  void paint(juce::Graphics&) override final;
150 
151  void buttonClicked(juce::Button*) override;
152 
153  juce::Rectangle<int> getButtonArea() const;
154 
155  private: // variables
156 
157  std::string m_overlay_text;
158 
159  juce::TextButton m_submit_btn, m_cancel_btn;
160 
161  std::unique_ptr<AlertBox> m_alert_box;
162 
163  std::vector<std::unique_ptr<Field>> m_fields;
164 
165  int m_alert_height;
166 
167  class OverlayComp;
168  friend class OverlayComp;
169  Component::SafePointer<OverlayComp> m_overlay;
170 
171  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(FormComponent)
172  };
173 
174  // ================================================================================ //
175  // FORM COMPONENT FIELD //
176  // ================================================================================ //
177 
178  class FormComponent::Field : public juce::Component
179  {
180  public: // methods
181 
182  class SingleLineText;
183  class Password;
184  class ToggleButton;
185  class KiwiLogo;
186  class TextButton;
187 
188  Field(std::string name);
189 
190  virtual ~Field() = default;
191 
192  std::string const& getName() const;
193 
194  virtual juce::Value& getValue() = 0;
195 
196  virtual int getPreferedHeight();
197 
198  private: // variables
199 
200  std::string m_name;
201  };
202 
203  // ================================================================================ //
204  // SINGLE LINE FIELD //
205  // ================================================================================ //
206 
207  class FormComponent::Field::SingleLineText : public Field
208  {
209  public: // methods
210 
211  SingleLineText(std::string name, std::string text, std::string placeholder_text);
212 
213  virtual ~SingleLineText() = default;
214 
215  juce::Value& getValue() override;
216 
217  void resized() override;
218 
219  protected: // variables
220 
221  juce::TextEditor m_text_editor;
222  };
223 
224  // ================================================================================ //
225  // PASWWORD FIELD //
226  // ================================================================================ //
227 
228  class FormComponent::Field::Password : public SingleLineText
229  {
230  public: // methods
231 
232  Password(std::string name, std::string text, std::string placeholder_text);
233  ~Password() = default;
234  };
235 
236  // ================================================================================ //
237  // TOGGLE BUTTON FIELD //
238  // ================================================================================ //
239 
240  class FormComponent::Field::ToggleButton : public Field
241  {
242  public: // methods
243 
244  ToggleButton(std::string name, std::string text, bool _default = false);
245 
246  ~ToggleButton() = default;
247 
248  juce::Value& getValue() override;
249 
250  void resized() override;
251 
252  int getPreferedHeight() override;
253 
254  private: // variables
255 
256  juce::ToggleButton m_button;
257  };
258 
259  // ================================================================================ //
260  // TEXT BUTTON FIELD //
261  // ================================================================================ //
262 
263  class FormComponent::Field::TextButton : public Field, public juce::Button::Listener
264  {
265  public:
266 
267  TextButton(std::string const& name,
268  std::string const& buton_text,
269  std::function<void()> call_back);
270 
271  ~TextButton();
272 
273  juce::Value& getValue() override final;
274 
275  int getPreferedHeight() override final;
276 
277  void resized() override;
278 
279  void buttonClicked(juce::Button *) override final;
280 
281  private:
282 
283  juce::TextButton m_button;
284  juce::Value m_value;
285  std::function<void()> m_call_back;
286  };
287 
288  // ================================================================================ //
289  // KIWI LOGO FIELD //
290  // ================================================================================ //
291 
292  class FormComponent::Field::KiwiLogo : public Field
293  {
294  public: // methods
295 
296  KiwiLogo();
297 
298  ~KiwiLogo() = default;
299 
300  void paint(juce::Graphics& g) override;
301 
302  juce::Value& getValue() override;
303 
304  int getPreferedHeight() override;
305 
306  private: // variables
307 
308  juce::Image m_kiwi_app_image;
309  juce::Value m_useless_value;
310  };
311 
312 
313  // ================================================================================ //
314  // FORM COMPONENT - template definitions //
315  // ================================================================================ //
316 
317  template<class FieldType, class... Args>
318  FieldType& FormComponent::addField(Args&&... args)
319  {
320  auto field = std::make_unique<FieldType>(std::forward<Args>(args)...);
321  addAndMakeVisible(*field);
322  auto it = m_fields.emplace(m_fields.end(), std::move(field));
323  return dynamic_cast<FieldType&>(*(it->get()));
324  }
325 }
kiwi::FormComponent::Field::SingleLineText
Definition: KiwiApp_FormComponent.h:207
+
kiwi::FormComponent::Field::Password
Definition: KiwiApp_FormComponent.h:228
+
kiwi::FormComponent::Field
Definition: KiwiApp_FormComponent.h:178
+
kiwi::FormComponent::Field::ToggleButton
Definition: KiwiApp_FormComponent.h:240
+
kiwi::AlertBox
Definition: KiwiApp_FormComponent.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::FormComponent::addField
FieldType & addField(Args &&...args)
Add a new field.
Definition: KiwiApp_FormComponent.h:318
+
kiwi::FormComponent::OverlayComp
Definition: KiwiApp_FormComponent.cpp:121
+
kiwi::FormComponent
Definition: KiwiApp_FormComponent.h:75
+
kiwi::AlertBox::AlertBox
AlertBox(std::string const &message, Type type=Type::Info, bool can_cancel=true, std::function< void(void)> on_close=nullptr)
Constructor.
Definition: KiwiApp_FormComponent.cpp:33
+
kiwi::FormComponent::Field::KiwiLogo
Definition: KiwiApp_FormComponent.h:292
+
kiwi::AlertBox::~AlertBox
~AlertBox()
Destructor.
Definition: KiwiApp_FormComponent.cpp:50
+
kiwi::FormComponent::Field::TextButton
Definition: KiwiApp_FormComponent.h:263
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___i_ds_8h_source.html b/docs/html/_kiwi_app___i_ds_8h_source.html index f6f835dd..9afcbcb3 100644 --- a/docs/html/_kiwi_app___i_ds_8h_source.html +++ b/docs/html/_kiwi_app___i_ds_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_General/KiwiApp_IDs.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_IDs.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_core/juce_core.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // Ids //
30  // ================================================================================ //
31 
32  namespace Ids
33  {
34  #define DECLARE_ID(name) const juce::Identifier name(#name)
35 
36  DECLARE_ID(name);
37  DECLARE_ID(host);
38  DECLARE_ID(api_port);
39  DECLARE_ID(session_port);
40  DECLARE_ID(refresh_interval);
41 
42  DECLARE_ID(NETWORK_CONFIG);
43 
44  #undef DECLARE_ID
45  };
46 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_core/juce_core.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // Ids //
30  // ================================================================================ //
31 
32  namespace Ids
33  {
34  #define DECLARE_ID(name) const juce::Identifier name(#name)
35 
36  DECLARE_ID(name);
37  DECLARE_ID(host);
38  DECLARE_ID(api_port);
39  DECLARE_ID(session_port);
40  DECLARE_ID(remember_me);
41  DECLARE_ID(server_address);
42 
43  DECLARE_ID(NETWORK_CONFIG);
44 
45  #undef DECLARE_ID
46  };
47 }
kiwi::remember_me
Toggle the "remember me" option to save user profile.
Definition: KiwiApp_CommandIDs.h:95
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___image_button_8h_source.html b/docs/html/_kiwi_app___image_button_8h_source.html index 2009845a..ed0b13ff 100644 --- a/docs/html/_kiwi_app___image_button_8h_source.html +++ b/docs/html/_kiwi_app___image_button_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Components/KiwiApp_ImageButton.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_ImageButton.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // IMAGE BUTTON //
30  // ================================================================================ //
31 
33  class ImageButton : public juce::Button
34  {
35  public: // methods
36 
37  using ButtonStyle = juce::DrawableButton::ButtonStyle;
38  using ColourIds = juce::DrawableButton::ColourIds;
39 
41  ImageButton(juce::String const& button_name,
42  std::unique_ptr<juce::Drawable> drawable,
43  ButtonStyle style = ButtonStyle::ImageAboveTextLabel);
44 
46  ~ImageButton();
47 
50  void setImages(juce::Drawable const* normal_image,
51  juce::Drawable const* over_image = nullptr,
52  juce::Drawable const* down_image = nullptr,
53  juce::Drawable const* disabled_image = nullptr,
54  juce::Drawable const* normal_image_on = nullptr,
55  juce::Drawable const* over_image_on = nullptr,
56  juce::Drawable const* down_image_on = nullptr,
57  juce::Drawable const* disabled_image_on = nullptr);
58 
60  void setCommand(std::function<void(void)> fn);
61 
64  void setButtonStyle(ButtonStyle new_style);
65 
67  ButtonStyle getStyle() const noexcept;
68 
71  void setEdgeIndent(int num_pixels_indent);
72 
74  juce::Drawable* getCurrentImage() const noexcept;
75 
77  juce::Drawable* getNormalImage() const noexcept;
78 
80  juce::Drawable* getOverImage() const noexcept;
81 
83  juce::Drawable* getDownImage() const noexcept;
84 
86  virtual juce::Rectangle<float> getImageBounds() const;
87 
88  protected: // methods
89 
91  void paintButton(juce::Graphics&, bool isMouseOverButton, bool isButtonDown) override;
92 
94  void buttonStateChanged() override;
95 
97  void resized() override;
98 
100  void enablementChanged() override;
101 
103  void colourChanged() override;
104 
106  void clicked(juce::ModifierKeys const& modifiers) override;
107 
108  private: // members
109 
110  ButtonStyle m_style;
111  std::unique_ptr<juce::Drawable> m_normal_image, m_over_image, m_down_image, m_disabled_image,
112  m_normal_image_on, m_over_image_on, m_down_image_on, m_disabled_image_on;
113  juce::Drawable* m_current_image;
114 
115  int m_edge_indent;
116 
117  std::function<void(void)> m_command;
118 
119  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(ImageButton)
120  };
121 }
kiwi::ImageButton::clicked
void clicked(juce::ModifierKeys const &modifiers) override
This method is called when the button has been clicked.
Definition: KiwiApp_ImageButton.cpp:81
-
kiwi::ImageButton::getStyle
ButtonStyle getStyle() const noexcept
Returns the current style.
Definition: KiwiApp_ImageButton.cpp:87
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // IMAGE BUTTON //
30  // ================================================================================ //
31 
33  class ImageButton : public juce::Button
34  {
35  public: // methods
36 
37  using ButtonStyle = juce::DrawableButton::ButtonStyle;
38  using ColourIds = juce::DrawableButton::ColourIds;
39 
41  ImageButton(juce::String const& button_name,
42  std::unique_ptr<juce::Drawable> drawable,
43  ButtonStyle style = ButtonStyle::ImageAboveTextLabel);
44 
46  ~ImageButton();
47 
50  void setImages(juce::Drawable const* normal_image,
51  juce::Drawable const* over_image = nullptr,
52  juce::Drawable const* down_image = nullptr,
53  juce::Drawable const* disabled_image = nullptr,
54  juce::Drawable const* normal_image_on = nullptr,
55  juce::Drawable const* over_image_on = nullptr,
56  juce::Drawable const* down_image_on = nullptr,
57  juce::Drawable const* disabled_image_on = nullptr);
58 
60  void setCommand(std::function<void(void)> fn);
61 
64  void setButtonStyle(ButtonStyle new_style);
65 
67  ButtonStyle getStyle() const noexcept;
68 
71  void setEdgeIndent(int num_pixels_indent);
72 
74  juce::Drawable* getCurrentImage() const noexcept;
75 
77  juce::Drawable* getNormalImage() const noexcept;
78 
80  juce::Drawable* getOverImage() const noexcept;
81 
83  juce::Drawable* getDownImage() const noexcept;
84 
86  virtual juce::Rectangle<float> getImageBounds() const;
87 
88  protected: // methods
89 
91  void paintButton(juce::Graphics&, bool isMouseOverButton, bool isButtonDown) override;
92 
94  void buttonStateChanged() override;
95 
97  void resized() override;
98 
100  void enablementChanged() override;
101 
103  void colourChanged() override;
104 
106  void clicked(juce::ModifierKeys const& modifiers) override;
107 
108  private: // members
109 
110  ButtonStyle m_style;
111  std::unique_ptr<juce::Drawable> m_normal_image, m_over_image, m_down_image, m_disabled_image,
112  m_normal_image_on, m_over_image_on, m_down_image_on, m_disabled_image_on;
113  juce::Drawable* m_current_image;
114 
115  int m_edge_indent;
116 
117  std::function<void(void)> m_command;
118 
119  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(ImageButton)
120  };
121 }
kiwi::ImageButton::clicked
void clicked(juce::ModifierKeys const &modifiers) override
This method is called when the button has been clicked.
Definition: KiwiApp_ImageButton.cpp:81
+
kiwi::ImageButton::getImageBounds
virtual juce::Rectangle< float > getImageBounds() const
Can be overridden to specify a custom position for the image within the button.
Definition: KiwiApp_ImageButton.cpp:108
kiwi::ImageButton
A button that displays a Drawable.
Definition: KiwiApp_ImageButton.h:33
+
kiwi::ImageButton::getNormalImage
juce::Drawable * getNormalImage() const noexcept
Returns the image that the button will use for its normal state.
Definition: KiwiApp_ImageButton.cpp:226
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::ImageButton::setImages
void setImages(juce::Drawable const *normal_image, juce::Drawable const *over_image=nullptr, juce::Drawable const *down_image=nullptr, juce::Drawable const *disabled_image=nullptr, juce::Drawable const *normal_image_on=nullptr, juce::Drawable const *over_image_on=nullptr, juce::Drawable const *down_image_on=nullptr, juce::Drawable const *disabled_image_on=nullptr)
Sets up the images to draw for the various button states.
Definition: KiwiApp_ImageButton.cpp:52
-
kiwi::ImageButton::getOverImage
juce::Drawable * getOverImage() const noexcept
Returns the image that the button will use when the mouse is over it.
Definition: KiwiApp_ImageButton.cpp:232
kiwi::ImageButton::ImageButton
ImageButton(juce::String const &button_name, std::unique_ptr< juce::Drawable > drawable, ButtonStyle style=ButtonStyle::ImageAboveTextLabel)
Constructor.
Definition: KiwiApp_ImageButton.cpp:31
+
kiwi::ImageButton::getOverImage
juce::Drawable * getOverImage() const noexcept
Returns the image that the button will use when the mouse is over it.
Definition: KiwiApp_ImageButton.cpp:232
kiwi::ImageButton::setEdgeIndent
void setEdgeIndent(int num_pixels_indent)
Gives the button an optional amount of space around the edge of the drawable.
Definition: KiwiApp_ImageButton.cpp:101
-
kiwi::ImageButton::getCurrentImage
juce::Drawable * getCurrentImage() const noexcept
Returns the image that the button is currently displaying.
Definition: KiwiApp_ImageButton.cpp:221
-
kiwi::ImageButton::getImageBounds
virtual juce::Rectangle< float > getImageBounds() const
Can be overridden to specify a custom position for the image within the button.
Definition: KiwiApp_ImageButton.cpp:108
+
kiwi::ImageButton::getDownImage
juce::Drawable * getDownImage() const noexcept
Returns the image that the button will use when the mouse is held down on it.
Definition: KiwiApp_ImageButton.cpp:243
+
kiwi::ImageButton::getStyle
ButtonStyle getStyle() const noexcept
Returns the current style.
Definition: KiwiApp_ImageButton.cpp:87
kiwi::ImageButton::setCommand
void setCommand(std::function< void(void)> fn)
Set the command to execute when the button has been clicked.
Definition: KiwiApp_ImageButton.cpp:76
+
kiwi::ImageButton::getCurrentImage
juce::Drawable * getCurrentImage() const noexcept
Returns the image that the button is currently displaying.
Definition: KiwiApp_ImageButton.cpp:221
kiwi::ImageButton::~ImageButton
~ImageButton()
Destructor.
Definition: KiwiApp_ImageButton.cpp:42
-
kiwi::ImageButton::getNormalImage
juce::Drawable * getNormalImage() const noexcept
Returns the image that the button will use for its normal state.
Definition: KiwiApp_ImageButton.cpp:226
-
kiwi::ImageButton::getDownImage
juce::Drawable * getDownImage() const noexcept
Returns the image that the button will use when the mouse is held down on it.
Definition: KiwiApp_ImageButton.cpp:243
kiwi::ImageButton::setButtonStyle
void setButtonStyle(ButtonStyle new_style)
Changes the button&#39;s style.
Definition: KiwiApp_ImageButton.cpp:92
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___instance_8h_source.html b/docs/html/_kiwi_app___instance_8h_source.html index 77e71b74..1275029e 100644 --- a/docs/html/_kiwi_app___instance_8h_source.html +++ b/docs/html/_kiwi_app___instance_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Application/KiwiApp_Instance.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_Instance.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Instance.h>
25 
26 #include "flip/Document.h"
27 
28 #include "KiwiApp_Console.h"
29 #include "KiwiApp_SettingsPanel.h"
30 #include "KiwiApp_DocumentBrowserView.h"
31 #include "KiwiApp_BeaconDispatcher.h"
32 
33 #include "../KiwiApp_Patcher/KiwiApp_PatcherManager.h"
34 #include "../KiwiApp_General/KiwiApp_StoredSettings.h"
35 #include "../KiwiApp_Audio/KiwiApp_DspDeviceManager.h"
36 
37 namespace kiwi
38 {
39  class PatcherViewWindow;
40 
41  // ================================================================================ //
42  // INSTANCE //
43  // ================================================================================ //
44 
46  class Instance
47  {
48  public:
49 
51  Instance();
52 
54  ~Instance();
55 
57  uint64_t getUserId() const noexcept;
58 
60  void newPatcher();
61 
63  engine::Instance& useEngineInstance();
64 
66  engine::Instance const& getEngineInstance() const;
67 
69  bool openFile(juce::File const& file);
70 
72  void askUserToOpenPatcherDocument();
73 
75  void removePatcherWindow(PatcherViewWindow& patcher_window);
76 
78  void closeWindow(Window& window);
79 
82  bool closeAllPatcherWindows();
83 
85  PatcherManager* openRemotePatcher(DocumentBrowser::Drive::DocumentSession& session);
86 
88  void showAppSettingsWindow();
89 
91  void removePatcher(PatcherManager const& patcher_manager);
92 
94  void showAudioSettingsWindow();
95 
97  void showConsoleWindow();
98 
100  void showAboutKiwiWindow();
101 
103  void showDocumentBrowserWindow();
104 
106  void showBeaconDispatcherWindow();
107 
109  std::vector<uint8_t>& getPatcherClipboardData();
110 
111  private: // methods
112 
113  using PatcherManagers = std::vector<std::unique_ptr<PatcherManager>>;
114 
116  PatcherManagers::iterator getPatcherManager(PatcherManager const& manager);
117 
119  PatcherManagers::iterator getPatcherManagerForSession(DocumentBrowser::Drive::DocumentSession& session);
120 
122  size_t getNextUntitledNumberAndIncrement();
123 
126  void showWindowWithId(WindowId id, std::function<std::unique_ptr<Window>()> create_fn);
127 
128  private: // variables
129 
130  engine::Instance m_instance;
131 
132  uint64_t m_user_id;
133 
134  DocumentBrowser m_browser;
135 
136  PatcherManagers m_patcher_managers;
137 
138  sConsoleHistory m_console_history;
139 
140  std::vector<std::unique_ptr<Window>> m_windows;
141 
142  std::vector<uint8_t> m_patcher_clipboard;
143 
144  static size_t m_untitled_patcher_index;
145  juce::File m_last_opened_file;
146  };
147 }
kiwi::PatcherManager
The main DocumentObserver.
Definition: KiwiApp_PatcherManager.h:47
-
kiwi::Instance::removePatcher
void removePatcher(PatcherManager const &patcher_manager)
Removes a patcher from cach.
Definition: KiwiApp_Instance.cpp:261
-
kiwi::Instance::showDocumentBrowserWindow
void showDocumentBrowserWindow()
Brings the DocumentBrowserWindow to front.
Definition: KiwiApp_Instance.cpp:310
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Instance.h>
25 #include <KiwiTool/KiwiTool_Scheduler.h>
26 
27 #include <juce_events/timers/juce_Timer.h>
28 
29 #include "flip/Document.h"
30 
31 #include "KiwiApp_Console.h"
32 #include "KiwiApp_SettingsPanel.h"
33 #include "KiwiApp_DocumentBrowserView.h"
34 #include "KiwiApp_BeaconDispatcher.h"
35 
36 #include "../KiwiApp_Patcher/KiwiApp_PatcherManager.h"
37 #include "../KiwiApp_Audio/KiwiApp_DspDeviceManager.h"
38 
39 #include "../KiwiApp_Auth/KiwiApp_AuthPanel.h"
40 
41 namespace kiwi
42 {
43  class PatcherViewWindow;
44 
45  // ================================================================================ //
46  // INSTANCE //
47  // ================================================================================ //
48 
50  class Instance : public juce::Timer
51  {
52  public:
53 
55  Instance();
56 
58  ~Instance();
59 
61  void timerCallback() override final;
62 
64  uint64_t getUserId() const noexcept;
65 
67  void login();
68 
70  void logout();
71 
73  void newPatcher();
74 
76  engine::Instance& useEngineInstance();
77 
79  engine::Instance const& useEngineInstance() const;
80 
82  bool openFile(juce::File const& file);
83 
85  void askUserToOpenPatcherDocument();
86 
88  void removePatcherWindow(PatcherViewWindow& patcher_window);
89 
91  void closeWindow(Window& window);
92 
94  void closeWindowWithId(WindowId window_id);
95 
98  bool closeAllPatcherWindows();
99 
101  void openRemotePatcher(DocumentBrowser::Drive::DocumentSession& session);
102 
104  void showAppSettingsWindow();
105 
107  void showAudioSettingsWindow();
108 
110  void showConsoleWindow();
111 
113  void showAuthWindow(AuthPanel::FormType type);
114 
116  void showAboutKiwiWindow();
117 
119  void showDocumentBrowserWindow();
120 
122  void showBeaconDispatcherWindow();
123 
125  std::vector<uint8_t>& getPatcherClipboardData();
126 
127  private: // methods
128 
129  using PatcherManagers = std::vector<std::unique_ptr<PatcherManager>>;
130 
132  PatcherManagers::iterator getPatcherManager(PatcherManager const& manager);
133 
135  PatcherManagers::iterator getPatcherManagerForSession(DocumentBrowser::Drive::DocumentSession& session);
136 
138  Instance::PatcherManagers::iterator getPatcherManagerForFile(juce::File const& file);
139 
141  size_t getNextUntitledNumberAndIncrement();
142 
145  void showWindowWithId(WindowId id, std::function<std::unique_ptr<Window>()> create_fn);
146 
147  private: // variables
148 
149  engine::Instance m_instance;
150 
151  DocumentBrowser m_browser;
152 
153  PatcherManagers m_patcher_managers;
154 
155  sConsoleHistory m_console_history;
156 
157  std::vector<std::unique_ptr<Window>> m_windows;
158 
159  std::vector<uint8_t> m_patcher_clipboard;
160 
161  static size_t m_untitled_patcher_index;
162  juce::File m_last_opened_file;
163  };
164 }
kiwi::Instance::login
void login()
Enables the document browser view.
Definition: KiwiApp_Instance.cpp:108
+
kiwi::PatcherManager
The main DocumentObserver.
Definition: KiwiApp_PatcherManager.h:50
+
kiwi::Instance::showDocumentBrowserWindow
void showDocumentBrowserWindow()
Brings the DocumentBrowserWindow to front.
Definition: KiwiApp_Instance.cpp:416
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::Instance::logout
void logout()
Close all remote patchers and disable document browser view.
Definition: KiwiApp_Instance.cpp:115
kiwi::Instance::~Instance
~Instance()
Destructor.
Definition: KiwiApp_Instance.cpp:62
kiwi::Instance::Instance
Instance()
Constructor.
Definition: KiwiApp_Instance.cpp:44
-
kiwi::Instance::useEngineInstance
engine::Instance & useEngineInstance()
Returns the engine::Instance.
Definition: KiwiApp_Instance.cpp:72
-
kiwi::Instance::closeWindow
void closeWindow(Window &window)
Attempt to close the given window asking user to save file if needed.
Definition: KiwiApp_Instance.cpp:172
-
kiwi::PatcherViewWindow
Definition: KiwiApp_PatcherComponent.h:181
-
kiwi::Instance::openRemotePatcher
PatcherManager * openRemotePatcher(DocumentBrowser::Drive::DocumentSession &session)
Attempt to create a new patcher with document Session informations.
Definition: KiwiApp_Instance.cpp:228
-
kiwi::Instance::newPatcher
void newPatcher()
create a new patcher window.
Definition: KiwiApp_Instance.cpp:82
-
kiwi::DocumentBrowser::Drive::DocumentSession
Definition: KiwiApp_DocumentBrowser.h:218
-
kiwi::Instance
The Application Instance.
Definition: KiwiApp_Instance.h:46
-
kiwi::Instance::showAboutKiwiWindow
void showAboutKiwiWindow()
Brings the "About Kiwi" window to front.
Definition: KiwiApp_Instance.cpp:305
-
kiwi::Instance::showBeaconDispatcherWindow
void showBeaconDispatcherWindow()
Brings the BeaconDispatcherWindow to front.
Definition: KiwiApp_Instance.cpp:319
-
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:42
-
kiwi::Instance::openFile
bool openFile(juce::File const &file)
Open a File.
Definition: KiwiApp_Instance.cpp:107
-
kiwi::Instance::showConsoleWindow
void showConsoleWindow()
Brings the Console to front.
Definition: KiwiApp_Instance.cpp:295
-
kiwi::Instance::getUserId
uint64_t getUserId() const noexcept
Get the user ID of the Instance.
Definition: KiwiApp_Instance.cpp:67
-
kiwi::Instance::getEngineInstance
engine::Instance const & getEngineInstance() const
Returns the engine::Instance.
Definition: KiwiApp_Instance.cpp:77
-
kiwi::Instance::showAppSettingsWindow
void showAppSettingsWindow()
Brings the Application settings window to front.
Definition: KiwiApp_Instance.cpp:328
-
kiwi::Instance::showAudioSettingsWindow
void showAudioSettingsWindow()
Opens a juce native audio setting pannel.
Definition: KiwiApp_Instance.cpp:337
-
kiwi::Instance::askUserToOpenPatcherDocument
void askUserToOpenPatcherDocument()
Open a patcher from file.
Definition: KiwiApp_Instance.cpp:133
-
kiwi::DocumentBrowser
Request Patcher document informations through a Kiwi API.
Definition: KiwiApp_DocumentBrowser.h:40
-
kiwi::Instance::closeAllPatcherWindows
bool closeAllPatcherWindows()
Attempt to close all document, after asking user to save them if needed.
Definition: KiwiApp_Instance.cpp:209
+
kiwi::Instance::useEngineInstance
engine::Instance & useEngineInstance()
Returns the engine::Instance.
Definition: KiwiApp_Instance.cpp:147
+
kiwi::Instance::closeWindow
void closeWindow(Window &window)
Attempt to close the given window asking user to save file if needed.
Definition: KiwiApp_Instance.cpp:256
+
kiwi::PatcherViewWindow
Definition: KiwiApp_PatcherComponent.h:194
+
kiwi::WindowId
WindowId
Singleton application window&#39;s ids.
Definition: KiwiApp_Window.h:97
+
kiwi::Instance::newPatcher
void newPatcher()
create a new patcher window.
Definition: KiwiApp_Instance.cpp:157
+
kiwi::DocumentBrowser::Drive::DocumentSession
Definition: KiwiApp_DocumentBrowser.h:176
+
kiwi::Instance::timerCallback
void timerCallback() override final
Timer call back, processes the scheduler events list.
Definition: KiwiApp_Instance.cpp:68
+
kiwi::Instance
The Application Instance.
Definition: KiwiApp_Instance.h:50
+
kiwi::Instance::showAboutKiwiWindow
void showAboutKiwiWindow()
Brings the "About Kiwi" window to front.
Definition: KiwiApp_Instance.cpp:411
+
kiwi::Instance::showBeaconDispatcherWindow
void showBeaconDispatcherWindow()
Brings the BeaconDispatcherWindow to front.
Definition: KiwiApp_Instance.cpp:426
+
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:46
+
kiwi::Instance::openFile
bool openFile(juce::File const &file)
Open a File.
Definition: KiwiApp_Instance.cpp:173
+
kiwi::Instance::showConsoleWindow
void showConsoleWindow()
Brings the Console to front.
Definition: KiwiApp_Instance.cpp:387
+
kiwi::Instance::showAppSettingsWindow
void showAppSettingsWindow()
Brings the Application settings window to front.
Definition: KiwiApp_Instance.cpp:435
+
kiwi::Instance::showAudioSettingsWindow
void showAudioSettingsWindow()
Opens a juce native audio setting pannel.
Definition: KiwiApp_Instance.cpp:444
+
kiwi::Instance::openRemotePatcher
void openRemotePatcher(DocumentBrowser::Drive::DocumentSession &session)
Attempt to create a new patcher with document Session informations.
Definition: KiwiApp_Instance.cpp:321
+
kiwi::Instance::showAuthWindow
void showAuthWindow(AuthPanel::FormType type)
Brings the Auth form window to front.
Definition: KiwiApp_Instance.cpp:397
+
kiwi::Instance::getUserId
uint64_t getUserId() const noexcept
Get the user ID of the Instance.
Definition: KiwiApp_Instance.cpp:102
+
kiwi::Instance::askUserToOpenPatcherDocument
void askUserToOpenPatcherDocument()
Open a patcher from file.
Definition: KiwiApp_Instance.cpp:217
+
kiwi::DocumentBrowser
Request Patcher document informations through a Kiwi API.
Definition: KiwiApp_DocumentBrowser.h:42
+
kiwi::Instance::closeAllPatcherWindows
bool closeAllPatcherWindows()
Attempt to close all document, after asking user to save them if needed.
Definition: KiwiApp_Instance.cpp:302
kiwi::Window
Common interface for all windows held by the application.
Definition: KiwiApp_Window.h:33
-
kiwi::Instance::removePatcherWindow
void removePatcherWindow(PatcherViewWindow &patcher_window)
Removes the view of a certain patcher.
Definition: KiwiApp_Instance.cpp:150
-
kiwi::Instance::getPatcherClipboardData
std::vector< uint8_t > & getPatcherClipboardData()
Get Patcher clipboard data.
Definition: KiwiApp_Instance.cpp:355
+
kiwi::Instance::removePatcherWindow
void removePatcherWindow(PatcherViewWindow &patcher_window)
Removes the view of a certain patcher.
Definition: KiwiApp_Instance.cpp:234
+
kiwi::Instance::closeWindowWithId
void closeWindowWithId(WindowId window_id)
Attempt to close the window with the given id, asking user to save file if needed.
Definition: KiwiApp_Instance.cpp:293
+
kiwi::Instance::getPatcherClipboardData
std::vector< uint8_t > & getPatcherClipboardData()
Get Patcher clipboard data.
Definition: KiwiApp_Instance.cpp:462
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___link_view_8h_source.html b/docs/html/_kiwi_app___link_view_8h_source.html index b01d4ede..ed6e9736 100644 --- a/docs/html/_kiwi_app___link_view_8h_source.html +++ b/docs/html/_kiwi_app___link_view_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_LinkView.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_LinkView.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Link.h>
25 
26 #include "KiwiApp_ObjectView.h"
27 
28 namespace kiwi
29 {
30  class PatcherView;
31  class LinkView;
32 
33  // ================================================================================ //
34  // LINK VIEW BASE //
35  // ================================================================================ //
36 
38  class LinkViewBase : public juce::Component
39  {
40  public:
41  LinkViewBase() = default;
42  virtual ~LinkViewBase() = default;
43 
44  protected:
45  void updateBounds();
46 
47  protected: // members
48  juce::Point<int> m_last_outlet_pos;
49  juce::Point<int> m_last_inlet_pos;
50  juce::Path m_path;
51  };
52 
53  // ================================================================================ //
54  // LINK VIEW //
55  // ================================================================================ //
56 
58  class LinkView : public LinkViewBase, public juce::ComponentListener
59  {
60  public:
61 
63  LinkView(PatcherView& patcherview, model::Link& link_m);
64 
66  ~LinkView();
67 
69  model::Link& getModel() const {return *m_model;};
70 
72  bool isSelected() const noexcept;
73 
74  void linkChanged(model::Link& link);
75  void objectChanged(model::Object& object);
76  void localSelectionChanged(bool selected_for_view);
77  void distantSelectionChanged(std::set<uint64_t> distant_user_id_selection);
78 
79  // ! @brief Returns true if this link reprensent a signal connection.
80  bool isSignal() const;
81 
82  // juce::Component
83  void paint(juce::Graphics& g) override;
84 
86  bool hitTest(juce::Point<int> const& pt, HitTester& result) const;
87 
89  bool hitTest(juce::Rectangle<float> const& rect);
90 
95  void componentMovedOrResized(Component& component, bool was_moved, bool was_resized) override;
96 
97  private: // members
98 
99  PatcherView& m_patcherview;
100  model::Link* m_model;
101  bool m_is_selected = 0;
102  std::set<uint64_t> m_distant_selection;
103  };
104 
105  // ================================================================================ //
106  // LINK VIEW CREATOR //
107  // ================================================================================ //
108 
110  class LinkViewCreator : public LinkViewBase
111  {
112  public:
113 
115  LinkViewCreator(ObjectView& binded_object,
116  const size_t index,
117  bool is_sender,
118  juce::Point<int> dragged_pos);
119 
121  ~LinkViewCreator() = default;
122 
124  ObjectView& getBindedObject() const {return m_binded_object;};
125 
127  size_t getBindedIndex() const {return m_index;};
128 
130  size_t isBindedToSender() const {return m_is_sender;};
131 
133  void setEndPosition(juce::Point<int> const& pos);
134 
136  juce::Point<int> getEndPosition() const noexcept;
137 
138  // juce::Component
139  void paint(juce::Graphics& g) override;
140 
141  private: // members
142 
143  ObjectView& m_binded_object;
144  const size_t m_index;
145  const bool m_is_sender;
146  };
147 }
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Link.h>
25 
26 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectFrame.h>
27 
28 namespace kiwi
29 {
30  class PatcherView;
31  class LinkView;
32 
33  // ================================================================================ //
34  // LINK VIEW BASE //
35  // ================================================================================ //
36 
38  class LinkViewBase : public juce::Component
39  {
40  public:
41  LinkViewBase() = default;
42  virtual ~LinkViewBase() = default;
43 
44  protected:
45  void updateBounds();
46 
47  protected: // members
48  juce::Point<int> m_last_outlet_pos;
49  juce::Point<int> m_last_inlet_pos;
50  juce::Path m_path;
51  };
52 
53  // ================================================================================ //
54  // LINK VIEW //
55  // ================================================================================ //
56 
58  class LinkView : public LinkViewBase, public juce::ComponentListener
59  {
60  public:
61 
63  LinkView(PatcherView& patcherview, model::Link& link_m);
64 
66  ~LinkView();
67 
69  model::Link& getModel() const {return *m_model;};
70 
72  bool isSelected() const noexcept;
73 
74  void linkChanged(model::Link& link);
75  void objectChanged(model::Object& object);
76  void localSelectionChanged(bool selected_for_view);
77  void distantSelectionChanged(std::set<uint64_t> distant_user_id_selection);
78 
79  // ! @brief Returns true if this link reprensent a signal connection.
80  bool isSignal() const;
81 
82  // juce::Component
83  void paint(juce::Graphics& g) override;
84 
86  bool hitTest(juce::Point<int> const& pt, HitTester& result) const;
87 
89  bool hitTest(juce::Rectangle<float> const& rect);
90 
95  void componentMovedOrResized(Component& component, bool was_moved, bool was_resized) override;
96 
97  private: // members
98 
99  PatcherView& m_patcherview;
100  model::Link* m_model;
101  bool m_is_selected = 0;
102  std::set<uint64_t> m_distant_selection;
103  };
104 
105  // ================================================================================ //
106  // LINK VIEW CREATOR //
107  // ================================================================================ //
108 
110  class LinkViewCreator : public LinkViewBase
111  {
112  public:
113 
115  LinkViewCreator(ObjectFrame& binded_object,
116  const size_t index,
117  bool is_sender,
118  juce::Point<int> dragged_pos);
119 
121  ~LinkViewCreator() = default;
122 
124  ObjectFrame& getBindedObject() const {return m_binded_object;};
125 
127  size_t getBindedIndex() const {return m_index;};
128 
130  size_t isBindedToSender() const {return m_is_sender;};
131 
133  void setEndPosition(juce::Point<int> const& pos);
134 
136  juce::Point<int> getEndPosition() const noexcept;
137 
138  // juce::Component
139  void paint(juce::Graphics& g) override;
140 
141  private: // members
142 
143  ObjectFrame& m_binded_object;
144  const size_t m_index;
145  const bool m_is_sender;
146  };
147 }
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::HitTester
The HitTester class...
Definition: KiwiApp_PatcherViewHitTester.h:37
-
kiwi::ObjectView
The juce object Component.
Definition: KiwiApp_ObjectView.h:41
- - -
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
- + + +
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
- -
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:48
+
kiwi::ObjectFrame
A juce component holding the object&#39;s graphical representation.
Definition: KiwiApp_ObjectFrame.h:43
+ +
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:49
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___look_and_feel_8h_source.html b/docs/html/_kiwi_app___look_and_feel_8h_source.html index 1ef7a573..18776a1e 100644 --- a/docs/html/_kiwi_app___look_and_feel_8h_source.html +++ b/docs/html/_kiwi_app___look_and_feel_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_General/KiwiApp_LookAndFeel.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + + - + - - - - + +
@@ -66,28 +90,28 @@
KiwiApp_ObjectView.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_PatcherUser.h>
25 
26 #include <juce_gui_basics/juce_gui_basics.h>
27 
28 #include "../KiwiApp_Components/KiwiApp_SuggestEditor.h"
29 
30 namespace kiwi
31 {
32  class HitTester;
33  class PatcherView;
34  class ClassicBox;
35 
36  // ================================================================================ //
37  // OBJECT VIEW //
38  // ================================================================================ //
39 
41  class ObjectView : public juce::Component
42  {
43  public:
44 
45  ObjectView(PatcherView& patcher_view, model::Object& object_m);
46  ~ObjectView();
47 
48  void objectChanged(model::Patcher::View& view, model::Object& object);
49  void localSelectionChanged(bool selected_for_view);
50  void distantSelectionChanged(std::set<uint64_t> distant_user_id_selection);
51  void lockStatusChanged(bool locked);
52  void patcherViewOriginPositionChanged();
53 
54  // juce::Component
55  void paint(juce::Graphics& g) override;
56  void mouseDown(juce::MouseEvent const& event) override;
57  void mouseDrag(juce::MouseEvent const& event) override;
58 
60  juce::Rectangle<int> getBoxBounds() const;
61 
63  juce::Point<int> getInletPatcherPosition(const size_t index) const;
64 
66  juce::Point<int> getOutletPatcherPosition(const size_t index) const;
67 
69  model::Object& getModel() const {return *m_model;};
70 
72  bool hitTest(int x, int y) override;
73 
75  bool hitTest(juce::Point<int> const& pt, HitTester& result) const;
76 
78  bool hitTest(juce::Rectangle<int> const& rect);
79 
81  bool isSelected();
82 
84  bool isEditing();
85 
86  private:
87 
88  void updateBounds(const bool animate);
89  void drawInletsOutlets(juce::Graphics & g);
90 
92  juce::Rectangle<int> getInletLocalBounds(const size_t index,
93  juce::Rectangle<int> const& object_bounds) const;
94 
96  juce::Rectangle<int> getOutletLocalBounds(const size_t index,
97  juce::Rectangle<int> const& object_bounds) const;
98 
99  private: // members
100 
101  PatcherView& m_patcher_view;
102  model::Object* m_model = nullptr;
103  const unsigned int m_io_width = 6;
104  const unsigned int m_io_height = 3;
105  size_t m_inlets = 0;
106  size_t m_outlets = 0;
107  const juce::Colour m_io_color;
108  float m_selection_width = 3.;
109  juce::Rectangle<int> m_local_box_bounds;
110 
111  bool m_is_locked = 0;
112 
113  bool m_is_selected = 0;
114  std::set<uint64_t> m_distant_selection;
115  bool m_is_editing;
116  bool m_is_errorbox;
117 
118  friend ClassicBox;
119  };
120 
121  // ================================================================================ //
122  // CLASSIC BOX //
123  // ================================================================================ //
124 
126  class ClassicBox : public ObjectView, public SuggestEditor::Listener
127  {
128  public:
129 
131  ClassicBox(PatcherView& patcher_view, model::Object& object_m);
132 
134  ~ClassicBox();
135 
137  void edit();
138 
140  void removeTextEditor();
141 
143  void resized() override;
144 
145  void suggestEditorTextChanged(SuggestEditor& ed) override;
146  void suggestEditorReturnKeyPressed(SuggestEditor& ed) override;
147  void suggestEditorEscapeKeyPressed(SuggestEditor& ed) override;
148  void suggestEditorFocusLost(SuggestEditor& ed) override;
149 
150  private: // members
151 
152  std::unique_ptr<SuggestEditor> m_editor;
153  };
154 }
kiwi::ObjectView::isSelected
bool isSelected()
Returns true if the object is selected.
Definition: KiwiApp_ObjectView.cpp:283
-
kiwi::SuggestEditor::Listener
Receives callbacks from a SuggestEditor component.
Definition: KiwiApp_SuggestEditor.h:122
-
kiwi::ClassicBox
The ClassicBox let the user change the text of the box.
Definition: KiwiApp_ObjectView.h:126
-
kiwi::ObjectView::getOutletPatcherPosition
juce::Point< int > getOutletPatcherPosition(const size_t index) const
Returns the outlet position relative to the parent PatcherView component for a given index...
Definition: KiwiApp_ObjectView.cpp:352
-
kiwi::model::Patcher::View
The Patcher::View class holds the informations about a view of a Patcher.
Definition: KiwiModel_PatcherView.h:35
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <set>
25 
26 #include <juce_gui_basics/juce_gui_basics.h>
27 
28 #include <KiwiTool/KiwiTool_Parameter.h>
29 #include <KiwiTool/KiwiTool_Scheduler.h>
30 
31 #include <KiwiModel/KiwiModel_Object.h>
32 
33 namespace kiwi
34 {
35  class ObjectFrame;
36 
37  // ================================================================================ //
38  // OBJECT VIEW //
39  // ================================================================================ //
40 
42  class ObjectView : public juce::Component, public model::Object::Listener
43  {
44  public: // classes
45 
46  enum ColourIds
47  {
48  Background = 0x1100004,
49  Error = 0x1100005,
50  Text = 0x1100006,
51  Outline = 0x1100007,
52  Highlight = 0x1100008,
53  Active = 0x1100009
54  };
55 
56  public: // methods
57 
59  ObjectView(model::Object& object_model);
60 
62  virtual ~ObjectView();
63 
65  model::Object& getModel() const;
66 
68  void modelAttributeChanged(std::string const& name, tool::Parameter const& param) override final;
69 
71  void modelParameterChanged(std::string const& name, tool::Parameter const& param) override final;
72 
73  protected: // methods
74 
76  tool::Scheduler<> & getScheduler() const;
77 
80  void defer(std::function<void()> call_back);
81 
84  void schedule(std::function<void()> call_back, tool::Scheduler<>::duration_t delay);
85 
87  void drawOutline(juce::Graphics & g);
88 
90  void setAttribute(std::string const& name, tool::Parameter const& param);
91 
93  void setParameter(std::string const& name, tool::Parameter const& param);
94 
95  private: // methods
96 
100  virtual juce::Rectangle<int> getOutline() const;
101 
103  virtual void attributeChanged(std::string const& name, tool::Parameter const& param);
104 
106  virtual void parameterChanged(std::string const& name, tool::Parameter const& param);
107 
108  private: // members
109 
110  model::Object& m_model;
111  int m_border_size;
112  std::shared_ptr<ObjectView> m_master;
113 
114  private: // deleted methods
115 
116  ObjectView() = delete;
117  ObjectView(ObjectView const& other) = delete;
118  ObjectView(ObjectView && other) = delete;
119  ObjectView& operator=(ObjectView const& other) = delete;
120  ObjectView& operator=(ObjectView && other) = delete;
121  };
122 }
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::ObjectView::getModel
model::Object & getModel() const
Returns the model represented by the graphical object.
Definition: KiwiApp_ObjectView.cpp:88
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi::ObjectView::drawOutline
void drawOutline(juce::Graphics &g)
Draws the outlines of the object.
Definition: KiwiApp_ObjectView.cpp:98
+
kiwi::ObjectView::~ObjectView
virtual ~ObjectView()
Destructor.
Definition: KiwiApp_ObjectView.cpp:51
+
kiwi::ObjectView::schedule
void schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
Schedules a task on the main thread.
Definition: KiwiApp_ObjectView.cpp:125
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::HitTester
The HitTester class...
Definition: KiwiApp_PatcherViewHitTester.h:37
-
kiwi::ObjectView::getModel
model::Object & getModel() const
Get the Object model.
Definition: KiwiApp_ObjectView.h:69
-
kiwi::ObjectView
The juce object Component.
Definition: KiwiApp_ObjectView.h:41
-
kiwi::ObjectView::getBoxBounds
juce::Rectangle< int > getBoxBounds() const
Returns The box bounds relative to the parent Component.
Definition: KiwiApp_ObjectView.cpp:176
-
kiwi::SuggestEditor
A text editor with auto-completion.
Definition: KiwiApp_SuggestEditor.h:38
-
kiwi::ObjectView::getInletPatcherPosition
juce::Point< int > getInletPatcherPosition(const size_t index) const
Returns the inlet position relative to the parent PatcherView component for a given index...
Definition: KiwiApp_ObjectView.cpp:347
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:48
-
kiwi::ObjectView::isEditing
bool isEditing()
Returns true if the object is currently being editing.
Definition: KiwiApp_ObjectView.cpp:288
-
kiwi::ObjectView::hitTest
bool hitTest(int x, int y) override
overloaded from Component to exclude border size.
Definition: KiwiApp_ObjectView.cpp:181
+
kiwi::ObjectView::defer
void defer(std::function< void()> call_back)
Defers a task on the main thread.
Definition: KiwiApp_ObjectView.cpp:112
+
kiwi::model::Object::Listener
Definition: KiwiModel_Object.h:166
+
kiwi::ObjectView::setParameter
void setParameter(std::string const &name, tool::Parameter const &param)
Changes one of the data model&#39;s parameter.
Definition: KiwiApp_ObjectView.cpp:65
+
kiwi::ObjectView
Abstract for objects graphical representation.
Definition: KiwiApp_ObjectView.h:42
+
kiwi::ObjectView::getScheduler
tool::Scheduler & getScheduler() const
Returns the main scheduler.
Definition: KiwiApp_ObjectView.cpp:107
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::ObjectView::modelAttributeChanged
void modelAttributeChanged(std::string const &name, tool::Parameter const &param) override final
Called when one of the model&#39;s attributes has changed.
Definition: KiwiApp_ObjectView.cpp:70
+
kiwi::ObjectView::modelParameterChanged
void modelParameterChanged(std::string const &name, tool::Parameter const &param) override final
Called when a parameter has changed.
Definition: KiwiApp_ObjectView.cpp:75
+
kiwi::ObjectView::setAttribute
void setAttribute(std::string const &name, tool::Parameter const &param)
Changes one of the data model&#39;s attribute.
Definition: KiwiApp_ObjectView.cpp:56
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___objects_8h_source.html b/docs/html/_kiwi_app___objects_8h_source.html new file mode 100644 index 00000000..322ee18f --- /dev/null +++ b/docs/html/_kiwi_app___objects_8h_source.html @@ -0,0 +1,101 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_Objects.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_Objects.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ClassicView.h>
25 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_SliderView.h>
26 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_BangView.h>
27 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ToggleView.h>
28 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_MeterTildeView.h>
29 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_MessageView.h>
30 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_CommentView.h>
31 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_NumberView.h>
32 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_NumberTildeView.h>
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___patcher_component_8h_source.html b/docs/html/_kiwi_app___patcher_component_8h_source.html index ac67c1cb..a0ba4494 100644 --- a/docs/html/_kiwi_app___patcher_component_8h_source.html +++ b/docs/html/_kiwi_app___patcher_component_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_PatcherComponent.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_PatcherComponent.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "../KiwiApp_Components/KiwiApp_Window.h"
25 #include "KiwiApp_PatcherManager.h"
26 
27 namespace kiwi
28 {
29  // ================================================================================ //
30  // PATCHER COMPONENT TOOLBAR //
31  // ================================================================================ //
32 
33  class PatcherToolbar : public juce::Component
34  {
35  public: // methods
36 
38  PatcherToolbar(PatcherManager& patcher_manager);
39 
41  void resized() override;
42 
44  void paint(juce::Graphics& g) override;
45 
46  private: // classes
47 
49  struct Factory : public juce::ToolbarItemFactory
50  {
51  Factory(PatcherManager& patcher_manager);
52 
53  enum ItemIds
54  {
55  lock_unlock = 1,
56  zoom_in = 2,
57  zoom_out = 3,
58  dsp_on_off = 4,
59  users = 5,
60  };
61 
62  void getAllToolbarItemIds(juce::Array<int>& ids) override;
63 
64  void getDefaultItemSet(juce::Array<int>& ids) override;
65 
66  juce::ToolbarItemComponent* createItem(int itemId) override;
67 
68  PatcherManager& m_patcher_manager;
69  };
70 
71  class UsersItemComponent;
72 
73  private: // variables
74 
75  PatcherManager& m_patcher_manager;
76 
77  juce::Toolbar m_toolbar;
78  Factory m_factory;
79  };
80 
81  // ================================================================================ //
82  // TOOLBAR USER COMPONENT //
83  // ================================================================================ //
84 
86  class PatcherToolbar::UsersItemComponent
87  : public juce::ToolbarItemComponent
88  , public PatcherManager::Listener
89  , private juce::Timer
90  {
91  public: // methods
92 
94  UsersItemComponent(const int toolbarItemId, PatcherManager& patcher_manager);
95 
97  ~UsersItemComponent();
98 
100  void connectedUserChanged(PatcherManager& manager) override;
101 
103  bool getToolbarItemSizes(int toolbarDepth, bool isVertical,
104  int& preferredSize, int& minSize, int& maxSize) override;
105 
107  void paintButtonArea(juce::Graphics&, int width, int height,
108  bool isMouseOver, bool isMouseDown) override;
109 
111  void contentAreaChanged(const juce::Rectangle<int>& newArea) override;
112 
114  void startFlashing();
115 
117  void stopFlashing();
118 
119  private: // methods
120 
122  void timerCallback() override;
123 
124  private: // variables
125 
126  PatcherManager& m_patcher_manager;
127  size_t m_users;
128  const juce::Image m_users_img;
129  float m_flash_alpha = 0.f;
130  };
131 
132  // ================================================================================ //
133  // PATCHER COMPONENT //
134  // ================================================================================ //
135 
137  class PatcherComponent :
138  public juce::Component,
139  public juce::ApplicationCommandTarget
140  {
141  public: // methods
142 
144  PatcherComponent(PatcherView& patcherview);
145 
147  ~PatcherComponent();
148 
150  void resized() override;
151 
153  PatcherView& usePatcherView();
154 
156  PatcherManager& usePatcherManager();
157 
159  void paint(juce::Graphics& g) override;
160 
161  // -------------------------------------------------------------------------------- //
162  // APPLICATION COMMAND TARGET //
163  // -------------------------------------------------------------------------------- //
164 
165  juce::ApplicationCommandTarget* getNextCommandTarget() override;
166  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
167  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
168  bool perform(const InvocationInfo& info) override;
169 
170  private: // members
171 
172  PatcherManager& m_patcher_manager;
173  PatcherView& m_patcherview;
174  PatcherToolbar m_toolbar;
175  };
176 
177  // ================================================================================ //
178  // PATCHER VIEW WINDOW //
179  // ================================================================================ //
180 
181  class PatcherViewWindow : public Window
182  {
183  public: // methods
184 
185  PatcherViewWindow(PatcherManager& manager, PatcherView& patcherview);
186 
187  void closeButtonPressed() override;
188 
190  PatcherManager& getPatcherManager();
191 
193  PatcherView& getPatcherView();
194 
195  private: // variables
196 
197  PatcherComponent m_patcher_component;
198  };
199 }
kiwi::PatcherToolbar::UsersItemComponent
A toolbar component that displays informations about the users of the patch.
Definition: KiwiApp_PatcherComponent.h:86
-
kiwi::PatcherManager
The main DocumentObserver.
Definition: KiwiApp_PatcherManager.h:47
-
kiwi::PatcherManager::Listener
Definition: KiwiApp_PatcherManager.h:183
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "../KiwiApp_Components/KiwiApp_Window.h"
25 #include "KiwiApp_PatcherManager.h"
26 
27 namespace kiwi
28 {
29  // ================================================================================ //
30  // PATCHER COMPONENT TOOLBAR //
31  // ================================================================================ //
32 
33  class PatcherToolbar : public juce::Component
34  {
35  public: // methods
36 
38  PatcherToolbar(PatcherManager& patcher_manager);
39 
41  void resized() override;
42 
44  void paint(juce::Graphics& g) override;
45 
47  void removeUsersIcon();
48 
49  private: // classes
50 
52  struct Factory : public juce::ToolbarItemFactory
53  {
54  Factory(PatcherManager& patcher_manager);
55 
56  enum ItemIds
57  {
58  lock_unlock = 1,
59  zoom_in = 2,
60  zoom_out = 3,
61  dsp_on_off = 4,
62  users = 5,
63  };
64 
65  void getAllToolbarItemIds(juce::Array<int>& ids) override;
66 
67  void getDefaultItemSet(juce::Array<int>& ids) override;
68 
69  juce::ToolbarItemComponent* createItem(int itemId) override;
70 
71  PatcherManager& m_patcher_manager;
72  };
73 
74  class UsersItemComponent;
75 
76  private: // variables
77 
78  PatcherManager& m_patcher_manager;
79 
80  juce::Toolbar m_toolbar;
81  Factory m_factory;
82  };
83 
84  // ================================================================================ //
85  // TOOLBAR USER COMPONENT //
86  // ================================================================================ //
87 
89  class PatcherToolbar::UsersItemComponent
90  : public juce::ToolbarItemComponent
91  , public PatcherManager::Listener
92  , private juce::Timer
93  {
94  public: // methods
95 
97  UsersItemComponent(const int toolbarItemId, PatcherManager& patcher_manager);
98 
100  ~UsersItemComponent();
101 
103  void connectedUserChanged(PatcherManager& manager) override;
104 
106  void updateUsers();
107 
109  bool getToolbarItemSizes(int toolbarDepth, bool isVertical,
110  int& preferredSize, int& minSize, int& maxSize) override;
111 
113  void paintButtonArea(juce::Graphics&, int width, int height,
114  bool isMouseOver, bool isMouseDown) override;
115 
117  void contentAreaChanged(const juce::Rectangle<int>& newArea) override;
118 
120  void startFlashing();
121 
123  void stopFlashing();
124 
126  void mouseDown(juce::MouseEvent const& e) override final;
127 
128  private: // methods
129 
131  void timerCallback() override;
132 
133  private: // variables
134 
135  PatcherManager& m_patcher_manager;
136  std::vector<std::string> m_users;
137  size_t m_user_nb;
138  const juce::Image m_users_img;
139  float m_flash_alpha = 0.f;
140  };
141 
142  // ================================================================================ //
143  // PATCHER COMPONENT //
144  // ================================================================================ //
145 
147  class PatcherComponent :
148  public juce::Component,
149  public juce::ApplicationCommandTarget
150  {
151  public: // methods
152 
154  PatcherComponent(PatcherView& patcherview);
155 
157  ~PatcherComponent();
158 
160  void resized() override;
161 
163  PatcherView& usePatcherView();
164 
166  PatcherManager& usePatcherManager();
167 
169  void paint(juce::Graphics& g) override;
170 
172  void removeUsersIcon();
173 
174  // -------------------------------------------------------------------------------- //
175  // APPLICATION COMMAND TARGET //
176  // -------------------------------------------------------------------------------- //
177 
178  juce::ApplicationCommandTarget* getNextCommandTarget() override;
179  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
180  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
181  bool perform(const InvocationInfo& info) override;
182 
183  private: // members
184 
185  PatcherManager& m_patcher_manager;
186  PatcherView& m_patcherview;
187  PatcherToolbar m_toolbar;
188  };
189 
190  // ================================================================================ //
191  // PATCHER VIEW WINDOW //
192  // ================================================================================ //
193 
194  class PatcherViewWindow : public Window
195  {
196  public: // methods
197 
198  PatcherViewWindow(PatcherManager& manager, PatcherView& patcherview);
199 
201  bool showOkCancelBox(juce::AlertWindow::AlertIconType icon_type,
202  std::string const& title,
203  std::string const& message,
204  std::string const& button_1,
205  std::string const& button_2);
206 
207  void closeButtonPressed() override;
208 
210  PatcherManager& getPatcherManager();
211 
213  PatcherView& getPatcherView();
214 
216  void removeUsersIcon();
217 
218  private: // variables
219 
220  PatcherComponent m_patcher_component;
221  };
222 }
kiwi::PatcherToolbar::UsersItemComponent
A toolbar component that displays informations about the users of the patch.
Definition: KiwiApp_PatcherComponent.h:89
+
kiwi::PatcherManager
The main DocumentObserver.
Definition: KiwiApp_PatcherManager.h:50
+
kiwi::PatcherManager::Listener
Definition: KiwiApp_PatcherManager.h:221
kiwi::PatcherToolbar
Definition: KiwiApp_PatcherComponent.h:33
kiwi::PatcherToolbar::PatcherToolbar
PatcherToolbar(PatcherManager &patcher_manager)
Constructor.
Definition: KiwiApp_PatcherComponent.cpp:36
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::PatcherToolbar::paint
void paint(juce::Graphics &g) override
juce::Component::paint
Definition: KiwiApp_PatcherComponent.cpp:61
kiwi::PatcherToolbar::resized
void resized() override
juce::Component::resized
Definition: KiwiApp_PatcherComponent.cpp:56
-
kiwi::PatcherViewWindow
Definition: KiwiApp_PatcherComponent.h:181
-
kiwi::PatcherComponent
The PatcherComponent holds a patcher view and a patcher toolbar.
Definition: KiwiApp_PatcherComponent.h:137
-
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:48
+
kiwi::PatcherViewWindow
Definition: KiwiApp_PatcherComponent.h:194
+
kiwi::PatcherToolbar::removeUsersIcon
void removeUsersIcon()
Removes users icon.
Definition: KiwiApp_PatcherComponent.cpp:66
+
kiwi::PatcherComponent
The PatcherComponent holds a patcher view and a patcher toolbar.
Definition: KiwiApp_PatcherComponent.h:147
+
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:49
kiwi::Window
Common interface for all windows held by the application.
Definition: KiwiApp_Window.h:33
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___patcher_manager_8h_source.html b/docs/html/_kiwi_app___patcher_manager_8h_source.html index 702954c1..9c32045a 100644 --- a/docs/html/_kiwi_app___patcher_manager_8h_source.html +++ b/docs/html/_kiwi_app___patcher_manager_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_PatcherManager.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_PatcherManager.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "flip/Document.h"
25 #include "flip/DocumentObserver.h"
26 
27 #include <KiwiModel/KiwiModel_PatcherUser.h>
28 #include <KiwiModel/KiwiModel_PatcherValidator.h>
29 
30 #include <juce_gui_extra/juce_gui_extra.h>
31 
32 #include "../KiwiApp_Network/KiwiApp_DocumentBrowser.h"
33 
34 #include <unordered_set>
35 
36 namespace kiwi
37 {
38  class Instance;
39  class PatcherView;
40 
41  // ================================================================================ //
42  // PATCHER MANAGER //
43  // ================================================================================ //
44 
47  class PatcherManager : public flip::DocumentObserver<model::Patcher>,
48  public DocumentBrowser::Drive::Listener
49  {
50  public: // nested classes
51 
52  struct Listener;
53 
54  public: // methods
55 
57  PatcherManager(Instance& instance);
58 
60  ~PatcherManager();
61 
63  void connect(DocumentBrowser::Drive::DocumentSession& session);
64 
66  void loadFromFile(juce::File const& file);
67 
69  model::Patcher& getPatcher();
70 
72  model::Patcher const& getPatcher() const;
73 
75  bool isRemote() const noexcept;
76 
80  uint64_t getSessionId() const noexcept;
81 
85  std::string getDocumentName() const;
86 
88  size_t getNumberOfUsers();
89 
91  std::unordered_set<uint64_t> getConnectedUsers();
92 
94  size_t getNumberOfView();
95 
97  void newView();
98 
100  void bringsFirstViewToFront();
101 
103  void forceCloseAllWindows();
104 
107  bool askAllWindowsToClose();
108 
111  bool closePatcherViewWindow(PatcherView& patcherview);
112 
114  bool saveDocument();
115 
117  bool needsSaving() const noexcept;
118 
120  void addListener(Listener& listener);
121 
123  void removeListener(Listener& listener);
124 
126  void documentAdded(DocumentBrowser::Drive::DocumentSession& doc) override;
127 
129  void documentChanged(DocumentBrowser::Drive::DocumentSession& doc) override;
130 
132  void documentRemoved(DocumentBrowser::Drive::DocumentSession& doc) override;
133 
134  private:
135 
137  void document_changed(model::Patcher& patcher) override final;
138 
140  void notifyPatcherViews(model::Patcher& patcher);
141 
144  void createPatcherWindow(model::Patcher& patcher,
145  model::Patcher::User const& user,
146  model::Patcher::View& view);
147 
149  void notifyPatcherView(model::Patcher& patcher,
150  model::Patcher::User const& user,
151  model::Patcher::View& view);
152 
154  void removePatcherWindow(model::Patcher& patcher,
155  model::Patcher::User const& user,
156  model::Patcher::View& view);
157 
159  juce::FileBasedDocument::SaveResult saveIfNeededAndUserAgrees();
160 
161  private: // members
162 
163  Instance& m_instance;
164  model::PatcherValidator m_validator;
165  flip::Document m_document;
166  bool m_need_saving_flag;
167  bool m_is_remote;
168  DocumentBrowser::Drive::DocumentSession* m_session {nullptr};
169 
170  flip::SignalConnection m_user_connected_signal_cnx;
171  flip::SignalConnection m_user_disconnected_signal_cnx;
172  flip::SignalConnection m_receive_connected_users_signal_cnx;
173 
174  std::unordered_set<uint64_t> m_connected_users;
175 
176  engine::Listeners<Listener> m_listeners;
177  };
178 
179  // ================================================================================ //
180  // PATCHER MANAGER LISTENER //
181  // ================================================================================ //
182 
183  struct PatcherManager::Listener
184  {
185  virtual ~Listener() {};
186 
188  virtual void connectedUserChanged(PatcherManager& manager) {};
189  };
190 }
kiwi::PatcherManager::getNumberOfView
size_t getNumberOfView()
Returns the number of patcher views.
Definition: KiwiApp_PatcherManager.cpp:180
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <unordered_set>
25 #include <memory>
26 
27 #include <juce_gui_extra/juce_gui_extra.h>
28 
29 #include <flip/Document.h>
30 #include <flip/DocumentObserver.h>
31 
32 #include <KiwiModel/KiwiModel_PatcherUser.h>
33 #include <KiwiModel/KiwiModel_PatcherValidator.h>
34 
35 #include <KiwiApp_Network/KiwiApp_DocumentBrowser.h>
36 #include <KiwiApp_Network/KiwiApp_CarrierSocket.h>
37 
38 namespace kiwi
39 {
40  class Instance;
41  class PatcherView;
42  class PatcherViewWindow;
43 
44  // ================================================================================ //
45  // PATCHER MANAGER //
46  // ================================================================================ //
47 
50  class PatcherManager : public flip::DocumentObserver<model::Patcher>,
51  public DocumentBrowser::Drive::Listener
52  {
53  public: // nested classes
54 
55  struct Listener;
56 
57  public: // methods
58 
60  PatcherManager(Instance& instance, std::string const& name);
61 
63  ~PatcherManager();
64 
66  bool connect(std::string const& host, uint16_t port, DocumentBrowser::Drive::DocumentSession& session);
67 
69  void disconnect();
70 
72  void pull();
73 
75  bool loadFromFile(juce::File const& file);
76 
79  bool saveDocument();
80 
82  bool needsSaving() const noexcept;
83 
85  juce::File const& getSelectedFile() const;
86 
88  model::Patcher& getPatcher();
89 
91  model::Patcher const& getPatcher() const;
92 
94  bool isRemote() const noexcept;
95 
99  uint64_t getSessionId() const noexcept;
100 
104  std::string getDocumentName() const;
105 
107  size_t getNumberOfUsers();
108 
110  std::unordered_set<uint64_t> getConnectedUsers();
111 
113  size_t getNumberOfView();
114 
116  void newView();
117 
119  void bringsFirstViewToFront();
120 
123  bool askAllWindowsToClose();
124 
126  PatcherViewWindow & getFirstWindow();
127 
130  void closePatcherViewWindow(PatcherView& patcherview);
131 
133  void addListener(Listener& listener);
134 
136  void removeListener(Listener& listener);
137 
139  void documentAdded(DocumentBrowser::Drive::DocumentSession& doc) override;
140 
142  void documentChanged(DocumentBrowser::Drive::DocumentSession& doc) override;
143 
145  void forceCloseAllWindows();
146 
147  private:
148 
150  void onStateTransition(flip::CarrierBase::Transition transition, flip::CarrierBase::Error error);
151 
153  void writeDocument();
154 
156  bool readDocument();
157 
159  void document_changed(model::Patcher& patcher) override final;
160 
162  void notifyPatcherViews(model::Patcher& patcher);
163 
166  void createPatcherWindow(model::Patcher& patcher,
167  model::Patcher::User const& user,
168  model::Patcher::View& view);
169 
171  void notifyPatcherView(model::Patcher& patcher,
172  model::Patcher::User const& user,
173  model::Patcher::View& view);
174 
176  void removePatcherWindow(model::Patcher& patcher,
177  model::Patcher::User const& user,
178  model::Patcher::View& view);
179 
182  bool saveIfNeededAndUserAgrees();
183 
185  void updateTitleBar(model::Patcher::View & view);
186 
189  void updateTitleBars();
190 
192  void setNeedSaving(bool need_saving);
193 
195  void setName(std::string const& name);
196 
197  private: // members
198 
199  std::string m_name;
200  Instance& m_instance;
201  model::PatcherValidator m_validator;
202  flip::Document m_document;
203  juce::File m_file;
204  CarrierSocket m_socket;
205  bool m_need_saving_flag;
206  DocumentBrowser::Drive::DocumentSession* m_session;
207 
208  flip::SignalConnection m_user_connected_signal_cnx;
209  flip::SignalConnection m_user_disconnected_signal_cnx;
210  flip::SignalConnection m_receive_connected_users_signal_cnx;
211 
212  std::unordered_set<uint64_t> m_connected_users;
213 
214  tool::Listeners<Listener> m_listeners;
215  };
216 
217  // ================================================================================ //
218  // PATCHER MANAGER LISTENER //
219  // ================================================================================ //
220 
221  struct PatcherManager::Listener
222  {
223  virtual ~Listener() {};
224 
226  virtual void connectedUserChanged(PatcherManager& manager) {};
227  };
228 }
kiwi::PatcherManager::getNumberOfView
size_t getNumberOfView()
Returns the number of patcher views.
Definition: KiwiApp_PatcherManager.cpp:330
+
kiwi::PatcherManager::disconnect
void disconnect()
Disconnects the patcher manager.
Definition: KiwiApp_PatcherManager.cpp:117
kiwi::model::PatcherValidator
Definition: KiwiModel_PatcherValidator.h:36
-
kiwi::PatcherManager::removeListener
void removeListener(Listener &listener)
remove a listener.
Definition: KiwiApp_PatcherManager.cpp:65
-
kiwi::PatcherManager::getNumberOfUsers
size_t getNumberOfUsers()
Returns the number of users connected to the patcher document.
Definition: KiwiApp_PatcherManager.cpp:170
-
kiwi::PatcherManager::Listener::connectedUserChanged
virtual void connectedUserChanged(PatcherManager &manager)
Called when one or more users are connecting or disconnecting to the Patcher Document.
Definition: KiwiApp_PatcherManager.h:188
-
kiwi::PatcherManager
The main DocumentObserver.
Definition: KiwiApp_PatcherManager.h:47
-
kiwi::PatcherManager::connect
void connect(DocumentBrowser::Drive::DocumentSession &session)
Try to connect this patcher to a remote server.
Definition: KiwiApp_PatcherManager.cpp:70
-
kiwi::PatcherManager::saveDocument
bool saveDocument()
Save the document.
Definition: KiwiApp_PatcherManager.cpp:196
-
kiwi::PatcherManager::Listener
Definition: KiwiApp_PatcherManager.h:183
+
kiwi::PatcherManager::removeListener
void removeListener(Listener &listener)
remove a listener.
Definition: KiwiApp_PatcherManager.cpp:78
+
kiwi::PatcherManager::getNumberOfUsers
size_t getNumberOfUsers()
Returns the number of users connected to the patcher document.
Definition: KiwiApp_PatcherManager.cpp:320
+
kiwi::PatcherManager::Listener::connectedUserChanged
virtual void connectedUserChanged(PatcherManager &manager)
Called when one or more users are connecting or disconnecting to the Patcher Document.
Definition: KiwiApp_PatcherManager.h:226
+
kiwi::PatcherManager
The main DocumentObserver.
Definition: KiwiApp_PatcherManager.h:50
+
kiwi::PatcherManager::needsSaving
bool needsSaving() const noexcept
Returns true if the patcher needs to be saved.
Definition: KiwiApp_PatcherManager.cpp:346
+
kiwi::PatcherManager::getSelectedFile
juce::File const & getSelectedFile() const
Returns the file currently used to save document.
Definition: KiwiApp_PatcherManager.cpp:341
+
kiwi::PatcherManager::saveDocument
bool saveDocument()
Save the document.
Definition: KiwiApp_PatcherManager.cpp:358
+
kiwi::PatcherManager::connect
bool connect(std::string const &host, uint16_t port, DocumentBrowser::Drive::DocumentSession &session)
Try to connect this patcher to a remote server.
Definition: KiwiApp_PatcherManager.cpp:126
+
kiwi::PatcherManager::Listener
Definition: KiwiApp_PatcherManager.h:221
kiwi::model::Patcher::User
Represents and stores informations about a user of a patcher document.
Definition: KiwiModel_PatcherUser.h:36
+
kiwi::PatcherManager::getFirstWindow
PatcherViewWindow & getFirstWindow()
Returns the first window of the patcher manager.
Definition: KiwiApp_PatcherManager.cpp:494
kiwi::DocumentBrowser::Drive::Listener::~Listener
virtual ~Listener()=default
Destructor.
-
kiwi::PatcherManager::getConnectedUsers
std::unordered_set< uint64_t > getConnectedUsers()
Returns the list of users connected to the patcher document.
Definition: KiwiApp_PatcherManager.cpp:175
+
kiwi::PatcherManager::getDocumentName
std::string getDocumentName() const
Returns the name of the document.
Definition: KiwiApp_PatcherManager.cpp:305
+
kiwi::PatcherManager::getConnectedUsers
std::unordered_set< uint64_t > getConnectedUsers()
Returns the list of users connected to the patcher document.
Definition: KiwiApp_PatcherManager.cpp:325
kiwi::model::Patcher::View
The Patcher::View class holds the informations about a view of a Patcher.
Definition: KiwiModel_PatcherView.h:35
+
kiwi::CarrierSocket
Class that encapsulate a TCP socket.
Definition: KiwiApp_CarrierSocket.h:35
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::PatcherManager::closePatcherViewWindow
bool closePatcherViewWindow(PatcherView &patcherview)
Close the window that contains a given patcherview.
Definition: KiwiApp_PatcherManager.cpp:314
-
kiwi::PatcherManager::askAllWindowsToClose
bool askAllWindowsToClose()
Attempt to close all document windows, after asking user to save them if needed.
Definition: KiwiApp_PatcherManager.cpp:282
-
kiwi::PatcherManager::documentChanged
void documentChanged(DocumentBrowser::Drive::DocumentSession &doc) override
Called when a document session changed.
Definition: KiwiApp_PatcherManager.cpp:368
-
kiwi::PatcherManager::PatcherManager
PatcherManager(Instance &instance)
Constructor.
Definition: KiwiApp_PatcherManager.cpp:41
-
kiwi::PatcherManager::~PatcherManager
~PatcherManager()
Destructor.
Definition: KiwiApp_PatcherManager.cpp:52
+
kiwi::PatcherManager::askAllWindowsToClose
bool askAllWindowsToClose()
Attempt to close all document windows, after asking user to save them if needed.
Definition: KiwiApp_PatcherManager.cpp:441
+
kiwi::tool::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiTool_Listeners.h:38
+
kiwi::PatcherManager::loadFromFile
bool loadFromFile(juce::File const &file)
Load patcher datas from file.
Definition: KiwiApp_PatcherManager.cpp:248
+
kiwi::PatcherManager::documentChanged
void documentChanged(DocumentBrowser::Drive::DocumentSession &doc) override
Called when a document session changed.
Definition: KiwiApp_PatcherManager.cpp:524
+
kiwi::PatcherViewWindow
Definition: KiwiApp_PatcherComponent.h:194
+
kiwi::PatcherManager::~PatcherManager
~PatcherManager()
Destructor.
Definition: KiwiApp_PatcherManager.cpp:68
kiwi::model::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiModel_Patcher.h:35
-
kiwi::PatcherManager::needsSaving
bool needsSaving() const noexcept
Returns true if the patcher needs to be saved.
Definition: KiwiApp_PatcherManager.cpp:191
-
kiwi::engine::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiEngine_Listeners.h:40
-
kiwi::PatcherManager::loadFromFile
void loadFromFile(juce::File const &file)
Load patcher datas from file.
Definition: KiwiApp_PatcherManager.cpp:122
-
kiwi::PatcherManager::getPatcher
model::Patcher & getPatcher()
Returns the Patcher model.
Definition: KiwiApp_PatcherManager.cpp:135
-
kiwi::DocumentBrowser::Drive::DocumentSession
Definition: KiwiApp_DocumentBrowser.h:218
-
kiwi::PatcherManager::documentAdded
void documentAdded(DocumentBrowser::Drive::DocumentSession &doc) override
Called when a document session has been added.
Definition: KiwiApp_PatcherManager.cpp:363
-
kiwi::Instance
The Application Instance.
Definition: KiwiApp_Instance.h:46
-
kiwi::PatcherManager::documentRemoved
void documentRemoved(DocumentBrowser::Drive::DocumentSession &doc) override
Called when a document session has been removed.
Definition: KiwiApp_PatcherManager.cpp:380
-
kiwi::PatcherManager::addListener
void addListener(Listener &listener)
Add a listener.
Definition: KiwiApp_PatcherManager.cpp:60
-
kiwi::DocumentBrowser::Drive::Listener
Listen to document browser changes.
Definition: KiwiApp_DocumentBrowser.h:196
-
kiwi::PatcherManager::getDocumentName
std::string getDocumentName() const
Returns the name of the document.
Definition: KiwiApp_PatcherManager.cpp:155
-
kiwi::PatcherManager::bringsFirstViewToFront
void bringsFirstViewToFront()
Brings the first patcher view to front.
Definition: KiwiApp_PatcherManager.cpp:344
-
kiwi::PatcherManager::getSessionId
uint64_t getSessionId() const noexcept
Returns the session ID of the document.
Definition: KiwiApp_PatcherManager.cpp:150
-
kiwi::PatcherManager::newView
void newView()
create a new patcher view window.
Definition: KiwiApp_PatcherManager.cpp:160
-
kiwi::PatcherManager::isRemote
bool isRemote() const noexcept
Returns true if the this is a remotely connected document.
Definition: KiwiApp_PatcherManager.cpp:145
-
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:48
-
kiwi::PatcherManager::forceCloseAllWindows
void forceCloseAllWindows()
Force all windows to close without asking user to save document.
Definition: KiwiApp_PatcherManager.cpp:262
+
kiwi::PatcherManager::getPatcher
model::Patcher & getPatcher()
Returns the Patcher model.
Definition: KiwiApp_PatcherManager.cpp:285
+
kiwi::DocumentBrowser::Drive::DocumentSession
Definition: KiwiApp_DocumentBrowser.h:176
+
kiwi::PatcherManager::documentAdded
void documentAdded(DocumentBrowser::Drive::DocumentSession &doc) override
Called when a document session has been added.
Definition: KiwiApp_PatcherManager.cpp:519
+
kiwi::Instance
The Application Instance.
Definition: KiwiApp_Instance.h:50
+
kiwi::PatcherManager::addListener
void addListener(Listener &listener)
Add a listener.
Definition: KiwiApp_PatcherManager.cpp:73
+
kiwi::PatcherManager::closePatcherViewWindow
void closePatcherViewWindow(PatcherView &patcherview)
Close the window that contains a given patcherview.
Definition: KiwiApp_PatcherManager.cpp:473
+
kiwi::DocumentBrowser::Drive::Listener
Listen to document browser changes.
Definition: KiwiApp_DocumentBrowser.h:154
+
kiwi::PatcherManager::bringsFirstViewToFront
void bringsFirstViewToFront()
Brings the first patcher view to front.
Definition: KiwiApp_PatcherManager.cpp:500
+
kiwi::PatcherManager::newView
void newView()
create a new patcher view window.
Definition: KiwiApp_PatcherManager.cpp:310
+
kiwi::PatcherManager::PatcherManager
PatcherManager(Instance &instance, std::string const &name)
Constructor.
Definition: KiwiApp_PatcherManager.cpp:54
+
kiwi::PatcherManager::getSessionId
uint64_t getSessionId() const noexcept
Returns the session ID of the document.
Definition: KiwiApp_PatcherManager.cpp:300
+
kiwi::PatcherManager::pull
void pull()
Pull changes from server if it is remote.
Definition: KiwiApp_PatcherManager.cpp:83
+
kiwi::PatcherManager::isRemote
bool isRemote() const noexcept
Returns true if the this is a remotely connected document.
Definition: KiwiApp_PatcherManager.cpp:295
+
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:49
+
kiwi::PatcherManager::forceCloseAllWindows
void forceCloseAllWindows()
Force all windows to close without asking user to save document.
Definition: KiwiApp_PatcherManager.cpp:427
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___patcher_view_8h_source.html b/docs/html/_kiwi_app___patcher_view_8h_source.html index 6eab4b6b..936757f8 100644 --- a/docs/html/_kiwi_app___patcher_view_8h_source.html +++ b/docs/html/_kiwi_app___patcher_view_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_PatcherView.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_PatcherView.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_basics/juce_gui_basics.h>
25 
26 #include <KiwiModel/KiwiModel_Patcher.h>
27 
28 #include "KiwiApp_PatcherViewport.h"
29 #include "KiwiApp_PatcherViewHitTester.h"
30 #include "KiwiApp_PatcherManager.h"
31 #include "KiwiApp_PatcherViewLasso.h"
32 #include "KiwiApp_PatcherViewIoletHighlighter.h"
33 
34 namespace kiwi
35 {
36  class PatcherManager;
37  class ObjectView;
38  class ClassicBox;
39  class LinkView;
40  class LinkViewCreator;
41  class Instance;
42 
43  // ================================================================================ //
44  // PATCHER VIEW //
45  // ================================================================================ //
46 
48  class PatcherView
49  : public juce::Component
50  , public juce::ApplicationCommandTarget
51  , public PatcherManager::Listener
52  {
53  public:
54 
56  PatcherView(PatcherManager& manager,
57  Instance& instance,
58  model::Patcher& patcher,
59  model::Patcher::View& view);
60 
62  ~PatcherView();
63 
64  using ObjectViews = std::vector<std::unique_ptr<ObjectView>>;
65  using LinkViews = std::vector<std::unique_ptr<LinkView>>;
66 
68  PatcherManager& usePatcherManager();
69 
71  void patcherChanged(model::Patcher& patcher, model::Patcher::View& view);
72 
74  model::Patcher::View& getPatcherViewModel();
75 
77  ObjectViews const& getObjects() const;
78 
80  LinkViews const& getLinks() const;
81 
83  ObjectView* getObject(model::Object const& object);
84 
86  LinkView* getLink(model::Link const& link);
87 
89  void setLock(bool locked);
90 
92  bool isLocked() const;
93 
95  bool isSelected(ObjectView const& object) const;
96 
98  bool isSelected(LinkView const& link) const;
99 
102  PatcherViewport& getViewport() { return m_viewport; }
103 
105  juce::Point<int> getOriginPosition() const;
106 
108  model::Object& createObjectModel(std::string const& text);
109 
112  bool startEditBox(ClassicBox* box);
113 
116  void endEditBox(ClassicBox& box, std::string new_text);
117 
119  void updateWindowTitle() const;
120 
121  // ================================================================================ //
122  // COMPONENT //
123  // ================================================================================ //
124 
125  void paint(juce::Graphics& g) override;
126  void mouseDown(juce::MouseEvent const& event) override;
127  void mouseDrag(juce::MouseEvent const& e) override;
128  void mouseUp(juce::MouseEvent const& e) override;
129  void mouseMove(juce::MouseEvent const& event) override;
130  void mouseDoubleClick(const juce::MouseEvent& event) override;
131  bool keyPressed(const juce::KeyPress& key) override;
132 
133  // ================================================================================ //
134  // APPLICATION COMMAND TARGET //
135  // ================================================================================ //
136 
137  juce::ApplicationCommandTarget* getNextCommandTarget() override;
138  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
139  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
140  bool perform(const InvocationInfo& info) override;
141 
142  private: // methods
143 
145  void originPositionChanged();
146 
147  // ================================================================================ //
148  // PATCHER MANAGER LISTENER //
149  // ================================================================================ //
150 
152  void connectedUserChanged(PatcherManager& manager) override;
153 
154  // ================================================================================ //
155  // MODEL OBSERVER //
156  // ================================================================================ //
157 
159  void selectionChanged();
160 
162  void loadPatcher();
163 
165  void checkViewInfos(model::Patcher::View& view);
166 
168  void checkObjectsSelectionChanges(model::Patcher& patcher);
169 
171  void checkLinksSelectionChanges(model::Patcher& patcher);
172 
174  void addObjectView(model::Object& object, int zorder = -1);
175 
177  void objectChanged(model::Patcher::View& view, model::Object& object);
178 
180  void removeObjectView(model::Object& object);
181 
183  void addLinkView(model::Link& link);
184 
186  void linkChanged(model::Link& link);
187 
189  void removeLinkView(model::Link& link);
190 
192  void createNewBoxModel(bool give_focus);
193 
194  // ================================================================================ //
195  // UNDO/REDO //
196  // ================================================================================ //
197 
199  void undo();
200 
202  bool canUndo();
203 
205  std::string getUndoLabel();
206 
208  void redo();
209 
211  bool canRedo();
212 
214  std::string getRedoLabel();
215 
216  // ================================================================================ //
217  // SELECTION //
218  // ================================================================================ //
219 
221  std::set<flip::Ref> const& getSelectedObjects() const;
222 
224  std::set<flip::Ref> const& getSelectedLinks() const;
225 
226  void addToSelectionBasedOnModifiers(ObjectView& object, bool select_only);
227 
228  void addToSelectionBasedOnModifiers(LinkView& link, bool select_only);
229 
230  bool selectOnMouseDown(ObjectView& object, bool select_only);
231 
232  bool selectOnMouseDown(LinkView& link, bool select_only);
233 
234  void selectOnMouseUp(ObjectView& box, bool select_only,
235  const bool box_was_dragged,
236  const bool result_of_mouse_down_select_method);
237 
238  void selectOnMouseUp(LinkView& link, bool select_only,
239  const bool box_was_dragged,
240  const bool result_of_mouse_down_select_method);
241 
243  bool isAnythingSelected();
244 
246  bool isAnyObjectSelected();
247 
249  bool isAnyLinksSelected();
250 
252  void selectObject(ObjectView& object);
253 
255  void selectObjects(std::vector<ObjectView*> const& objects);
256 
258  void selectObjectOnly(ObjectView& object);
259 
261  void selectLink(LinkView& link);
262 
264  void selectLinks(std::vector<LinkView*> const& links);
265 
267  void selectLinkOnly(LinkView& link);
268 
270  void unselectObject(ObjectView& object);
271 
273  void unselectLink(LinkView& link);
274 
276  void selectAllObjects();
277 
279  void unselectAll();
280 
282  void deleteSelection();
283 
285  void startMoveOrResizeObjects();
286 
288  void endMoveOrResizeObjects();
289 
294  void resizeSelectedObjects(juce::Point<int> const& delta,
295  const long border_flag, const bool preserve_ratio);
296 
301  void moveSelectedObjects(juce::Point<int> const& delta,
302  bool commit = true, bool gesture = false);
303 
305  void copySelectionToClipboard();
306 
308  void pasteFromClipboard(juce::Point<int> const& delta);
309 
311  void duplicateSelection();
312 
314  void cut();
315 
317  void pasteReplace();
318 
320  model::Object& replaceObjectWith(model::Object& object_to_remove, model::Object& new_object);
321 
322  // ================================================================================ //
323  // MISC //
324  // ================================================================================ //
325 
327  ObjectViews::iterator findObject(model::Object const& object);
328 
330  LinkViews::iterator findLink(model::Link const& link);
331 
333  bool canConnect(model::Object const& from, const size_t outlet,
334  model::Object const& to, const size_t inlet) const;
335 
337  juce::Rectangle<int> getCurrentObjectsArea();
338 
340  juce::Rectangle<int> getSelectionBounds();
341 
343  std::pair<ObjectView*, size_t> getLinkCreatorNearestEndingIolet();
344 
346  void zoomIn();
347 
349  void zoomOut();
350 
352  void zoomNormal();
353 
355  void showPatcherPopupMenu(juce::Point<int> const& position);
356 
359  void showObjectPopupMenu(ObjectView const& object_view, juce::Point<int> const& position);
360 
363  void showLinkPopupMenu(LinkView const& link_view, juce::Point<int> const& position);
364 
366  void bringsLinksToFront();
367 
369  void bringsObjectsToFront();
370 
372  juce::MouseCursor::StandardCursorType getMouseCursorForBorder(int border_flag) const;
373 
374  private: // members
375 
376  PatcherManager& m_manager;
377  Instance& m_instance;
378  model::Patcher& m_patcher_model;
379  model::Patcher::View& m_view_model;
380 
381  ObjectViews m_objects;
382  LinkViews m_links;
383 
384  std::set<flip::Ref> m_local_objects_selection;
385  std::set<flip::Ref> m_local_links_selection;
386 
387  std::map<flip::Ref, std::set<uint64_t>> m_distant_objects_selection;
388  std::map<flip::Ref, std::set<uint64_t>> m_distant_links_selection;
389 
390  PatcherViewport m_viewport;
391  HitTester m_hittester;
392  IoletHighlighter m_io_highlighter;
393  Lasso m_lasso;
394  std::unique_ptr<LinkViewCreator> m_link_creator;
395 
396  bool m_is_locked;
397  int m_grid_size;
398 
399  // mouse interactions flags
400  juce::Point<int> m_last_drag;
401  bool m_object_received_down_event = false;
402  bool m_copy_on_drag = false;
403  bool m_is_dragging = false;
404  bool m_is_dragging_links = false;
405  bool m_mouse_has_just_been_clicked = false;
406  bool m_select_on_mouse_down_status = false;
407  bool m_link_downstatus = false;
408  bool m_is_in_move_or_resize_gesture = false;
409  ObjectView* m_box_being_edited = nullptr;
410  long m_object_border_down_status;
411 
412  friend PatcherViewport;
413  friend Lasso;
414  };
415 }
kiwi::PatcherView::isLocked
bool isLocked() const
Get the lock status of the patcher view.
Definition: KiwiApp_PatcherView.cpp:1137
-
kiwi::PatcherView::getObject
ObjectView * getObject(model::Object const &object)
Returns the ObjectView corresponding to a given Object model.
Definition: KiwiApp_PatcherView.cpp:1910
-
kiwi::Lasso
Definition: KiwiApp_PatcherViewLasso.h:41
-
kiwi::PatcherManager
The main DocumentObserver.
Definition: KiwiApp_PatcherManager.h:47
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_basics/juce_gui_basics.h>
25 
26 #include <KiwiModel/KiwiModel_Patcher.h>
27 
28 #include <KiwiApp_Patcher/KiwiApp_PatcherViewMouseHandler.h>
29 
30 #include "KiwiApp_PatcherViewport.h"
31 #include "KiwiApp_PatcherViewHitTester.h"
32 #include "KiwiApp_PatcherManager.h"
33 #include "KiwiApp_PatcherViewLasso.h"
34 #include "KiwiApp_PatcherViewIoletHighlighter.h"
35 
36 namespace kiwi
37 {
38  class PatcherManager;
39  class ObjectFrame;
40  class LinkView;
41  class LinkViewCreator;
42  class Instance;
43 
44  // ================================================================================ //
45  // PATCHER VIEW //
46  // ================================================================================ //
47 
49  class PatcherView
50  : public juce::Component
51  , public juce::ApplicationCommandTarget
52  , public PatcherManager::Listener
53  {
54  public:
55 
57  PatcherView(PatcherManager& manager,
58  Instance& instance,
59  model::Patcher& patcher,
60  model::Patcher::View& view);
61 
63  ~PatcherView();
64 
65  using ObjectFrames = std::vector<std::unique_ptr<ObjectFrame>>;
66  using LinkViews = std::vector<std::unique_ptr<LinkView>>;
67 
69  PatcherManager& usePatcherManager();
70 
72  void patcherChanged(model::Patcher& patcher, model::Patcher::View& view);
73 
75  model::Patcher::View& getPatcherViewModel();
76 
78  ObjectFrames const& getObjects() const;
79 
81  LinkViews const& getLinks() const;
82 
84  ObjectFrame* getObject(model::Object const& object);
85 
87  LinkView* getLink(model::Link const& link);
88 
90  void setLock(bool locked);
91 
93  bool isLocked() const;
94 
96  std::set<uint64_t> getDistantSelection(ObjectFrame const& object) const;
97 
99  bool isSelected(ObjectFrame const& object) const;
100 
102  bool isSelected(LinkView const& link) const;
103 
106  PatcherViewport& getViewport() { return m_viewport; }
107 
109  juce::Point<int> getOriginPosition() const;
110 
113  void editObject(ObjectFrame & object_frame);
114 
116  void objectEditorShown(ObjectFrame const& object_frame);
117 
119  void objectTextChanged(ObjectFrame const& object_frame, std::string const& new_text);
120 
122  void objectEditorHidden(ObjectFrame const& object_frame);
123 
125  bool isEditingObject() const;
126 
127  // ================================================================================ //
128  // COMPONENT //
129  // ================================================================================ //
130 
131  void paint(juce::Graphics& g) override;
132  void mouseDown(juce::MouseEvent const& event) override;
133  void mouseDrag(juce::MouseEvent const& e) override;
134  void mouseUp(juce::MouseEvent const& e) override;
135  void mouseMove(juce::MouseEvent const& event) override;
136  void mouseDoubleClick(const juce::MouseEvent& event) override;
137  bool keyPressed(const juce::KeyPress& key) override;
138 
139  // ================================================================================ //
140  // APPLICATION COMMAND TARGET //
141  // ================================================================================ //
142 
143  juce::ApplicationCommandTarget* getNextCommandTarget() override;
144  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
145  void getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
146  bool perform(const InvocationInfo& info) override;
147 
148  private: // methods
149 
151  void originPositionChanged();
152 
153  // ================================================================================ //
154  // PATCHER MANAGER LISTENER //
155  // ================================================================================ //
156 
158  void connectedUserChanged(PatcherManager& manager) override;
159 
160  // ================================================================================ //
161  // MODEL OBSERVER //
162  // ================================================================================ //
163 
165  void selectionChanged();
166 
168  void loadPatcher();
169 
171  void checkViewInfos(model::Patcher::View& view);
172 
174  void checkObjectsSelectionChanges(model::Patcher& patcher);
175 
177  void checkLinksSelectionChanges(model::Patcher& patcher);
178 
180  void addObjectView(model::Object& object, int zorder = -1);
181 
183  void objectChanged(model::Patcher::View& view, model::Object& object);
184 
186  void updateParameters(model::Patcher const& patcher);
187 
189  void removeObjectView(model::Object& object);
190 
192  void addLinkView(model::Link& link);
193 
195  void linkChanged(model::Link& link);
196 
198  void removeLinkView(model::Link& link);
199 
201  void createObjectModel(std::string const& text, bool give_focus);
202 
203  // ================================================================================ //
204  // UNDO/REDO //
205  // ================================================================================ //
206 
208  void undo();
209 
211  bool canUndo();
212 
214  std::string getUndoLabel();
215 
217  void redo();
218 
220  bool canRedo();
221 
223  std::string getRedoLabel();
224 
225  // ================================================================================ //
226  // SELECTION //
227  // ================================================================================ //
228 
230  std::set<flip::Ref> const& getSelectedObjects() const;
231 
233  std::set<flip::Ref> const& getSelectedLinks() const;
234 
235  void addToSelectionBasedOnModifiers(ObjectFrame& object, bool select_only);
236 
237  void addToSelectionBasedOnModifiers(LinkView& link, bool select_only);
238 
239  bool selectOnMouseDown(ObjectFrame& object, bool select_only);
240 
241  bool selectOnMouseDown(LinkView& link, bool select_only);
242 
243  void selectOnMouseUp(ObjectFrame& box, bool select_only,
244  const bool box_was_dragged,
245  const bool result_of_mouse_down_select_method);
246 
247  void selectOnMouseUp(LinkView& link, bool select_only,
248  const bool box_was_dragged,
249  const bool result_of_mouse_down_select_method);
250 
252  bool isAnythingSelected();
253 
255  bool isAnyObjectSelected();
256 
258  bool isAnyLinksSelected();
259 
261  void selectObject(ObjectFrame& object);
262 
264  void selectObjects(std::vector<ObjectFrame*> const& objects);
265 
267  void selectObjectOnly(ObjectFrame& object);
268 
270  void selectLink(LinkView& link);
271 
273  void selectLinks(std::vector<LinkView*> const& links);
274 
276  void selectLinkOnly(LinkView& link);
277 
279  void unselectObject(ObjectFrame& object);
280 
282  void unselectLink(LinkView& link);
283 
285  void selectAllObjects();
286 
288  void unselectAll();
289 
291  void deleteSelection();
292 
297  void moveSelectedObjects(juce::Point<int> const& delta,
298  bool commit = true, bool gesture = false);
299 
301  void copySelectionToClipboard();
302 
304  void pasteFromClipboard(juce::Point<int> const& delta);
305 
307  void duplicateSelection();
308 
310  void cut();
311 
313  void pasteReplace();
314 
316  model::Object& replaceObjectWith(model::Object& object_to_remove, model::Object& new_object);
317 
318  // ================================================================================ //
319  // MISC //
320  // ================================================================================ //
321 
323  ObjectFrames::iterator findObject(model::Object const& object);
324 
326  LinkViews::iterator findLink(model::Link const& link);
327 
329  bool canConnect(model::Object const& from, const size_t outlet,
330  model::Object const& to, const size_t inlet) const;
331 
333  juce::Rectangle<int> getCurrentObjectsArea();
334 
336  juce::Rectangle<int> getSelectionBounds();
337 
339  std::pair<ObjectFrame*, size_t> getLinkCreatorNearestEndingIolet();
340 
342  void zoomIn();
343 
345  void zoomOut();
346 
348  void zoomNormal();
349 
351  void showPatcherPopupMenu(juce::Point<int> const& position);
352 
355  void showObjectPopupMenu(ObjectFrame const& object_view, juce::Point<int> const& position);
356 
359  void showLinkPopupMenu(LinkView const& link_view, juce::Point<int> const& position);
360 
362  void bringsLinksToFront();
363 
365  void bringsObjectsToFront();
366 
367  private: // members
368 
369  PatcherManager& m_manager;
370  Instance& m_instance;
371  model::Patcher& m_patcher_model;
372  model::Patcher::View& m_view_model;
373 
374  ObjectFrames m_objects;
375  LinkViews m_links;
376 
377  std::set<flip::Ref> m_local_objects_selection;
378  std::set<flip::Ref> m_local_links_selection;
379 
380  std::map<flip::Ref, std::set<uint64_t>> m_distant_objects_selection;
381  std::map<flip::Ref, std::set<uint64_t>> m_distant_links_selection;
382 
383  PatcherViewport m_viewport;
384  HitTester m_hittester;
385  MouseHandler m_mouse_handler;
386  IoletHighlighter m_io_highlighter;
387  Lasso m_lasso;
388  std::unique_ptr<LinkViewCreator> m_link_creator;
389 
390  ObjectFrame const* m_box_being_edited = nullptr;
391 
392  bool m_is_locked;
393  int m_grid_size;
394 
395  friend MouseHandler;
396  friend PatcherViewport;
397  friend Lasso;
398  };
399 }
kiwi::Lasso
Definition: KiwiApp_PatcherViewLasso.h:41
+
kiwi::PatcherManager
The main DocumentObserver.
Definition: KiwiApp_PatcherManager.h:50
kiwi::PatcherViewport
The PatcherView Viewport.
Definition: KiwiApp_PatcherViewport.h:36
-
kiwi::ClassicBox
The ClassicBox let the user change the text of the box.
Definition: KiwiApp_ObjectView.h:126
-
kiwi::PatcherManager::Listener
Definition: KiwiApp_PatcherManager.h:183
-
kiwi::PatcherView::getObjects
ObjectViews const & getObjects() const
Returns the ObjectViews.
Definition: KiwiApp_PatcherView.cpp:1900
+
kiwi::PatcherView::isEditingObject
bool isEditingObject() const
Returns true if an object if being edited.
Definition: KiwiApp_PatcherView.cpp:1497
+
kiwi::PatcherView::getObjects
ObjectFrames const & getObjects() const
Returns the Objects&#39; frames.
Definition: KiwiApp_PatcherView.cpp:1471
+
kiwi::PatcherView::objectTextChanged
void objectTextChanged(ObjectFrame const &object_frame, std::string const &new_text)
Called once an object&#39;s text has changed.
Definition: KiwiApp_PatcherView.cpp:1525
+
kiwi::PatcherManager::Listener
Definition: KiwiApp_PatcherManager.h:221
kiwi::model::Patcher::View
The Patcher::View class holds the informations about a view of a Patcher.
Definition: KiwiModel_PatcherView.h:35
-
kiwi::PatcherView::getOriginPosition
juce::Point< int > getOriginPosition() const
Returns the position of the patcher origin relative to the component position.
Definition: KiwiApp_PatcherView.cpp:1310
+
kiwi::PatcherView::objectEditorShown
void objectEditorShown(ObjectFrame const &object_frame)
Called when the object has entered edition mode.
Definition: KiwiApp_PatcherView.cpp:1509
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::PatcherView::isLocked
bool isLocked() const
Get the lock status of the patcher view.
Definition: KiwiApp_PatcherView.cpp:734
kiwi::HitTester
The HitTester class...
Definition: KiwiApp_PatcherViewHitTester.h:37
-
kiwi::PatcherView::~PatcherView
~PatcherView()
Destructor.
Definition: KiwiApp_PatcherView.cpp:67
-
kiwi::PatcherView::PatcherView
PatcherView(PatcherManager &manager, Instance &instance, model::Patcher &patcher, model::Patcher::View &view)
Constructor.
Definition: KiwiApp_PatcherView.cpp:39
-
kiwi::PatcherView::startEditBox
bool startEditBox(ClassicBox *box)
Call this to switch the box to edit mode.
Definition: KiwiApp_PatcherView.cpp:1947
+
kiwi::PatcherView::~PatcherView
~PatcherView()
Destructor.
Definition: KiwiApp_PatcherView.cpp:71
+
kiwi::PatcherView::PatcherView
PatcherView(PatcherManager &manager, Instance &instance, model::Patcher &patcher, model::Patcher::View &view)
Constructor.
Definition: KiwiApp_PatcherView.cpp:43
kiwi::model::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiModel_Patcher.h:35
kiwi::IoletHighlighter
Definition: KiwiApp_PatcherViewIoletHighlighter.h:35
-
kiwi::PatcherView::usePatcherManager
PatcherManager & usePatcherManager()
Returns the PatcherManager.
Definition: KiwiApp_PatcherView.cpp:83
-
kiwi::PatcherView::getLinks
LinkViews const & getLinks() const
Returns the LinkViews.
Definition: KiwiApp_PatcherView.cpp:1905
-
kiwi::PatcherView::getPatcherViewModel
model::Patcher::View & getPatcherViewModel()
Returns the patcher view model.
Definition: KiwiApp_PatcherView.cpp:1895
-
kiwi::ObjectView
The juce object Component.
Definition: KiwiApp_ObjectView.h:41
-
kiwi::PatcherView::createObjectModel
model::Object & createObjectModel(std::string const &text)
Create an object model.
Definition: KiwiApp_PatcherView.cpp:1926
-
kiwi::PatcherView::setLock
void setLock(bool locked)
Set the lock status of the patcher view.
Definition: KiwiApp_PatcherView.cpp:1125
-
kiwi::Instance
The Application Instance.
Definition: KiwiApp_Instance.h:46
-
kiwi::PatcherView::getLink
LinkView * getLink(model::Link const &link)
Returns the LinkView corresponding to a given Link model.
Definition: KiwiApp_PatcherView.cpp:1916
-
kiwi::PatcherView::getViewport
PatcherViewport & getViewport()
Returns the Viewport that contains this patcher view.
Definition: KiwiApp_PatcherView.h:102
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
+
kiwi::PatcherView::objectEditorHidden
void objectEditorHidden(ObjectFrame const &object_frame)
Called when the object is quitting edition mode.
Definition: KiwiApp_PatcherView.cpp:1516
+
kiwi::PatcherView::usePatcherManager
PatcherManager & usePatcherManager()
Returns the PatcherManager.
Definition: KiwiApp_PatcherView.cpp:87
+
kiwi::PatcherView::getPatcherViewModel
model::Patcher::View & getPatcherViewModel()
Returns the patcher view model.
Definition: KiwiApp_PatcherView.cpp:1466
+
kiwi::PatcherView::editObject
void editObject(ObjectFrame &object_frame)
Call this to switch the box to edit mode.
Definition: KiwiApp_PatcherView.cpp:1502
+
kiwi::PatcherView::setLock
void setLock(bool locked)
Set the lock status of the patcher view.
Definition: KiwiApp_PatcherView.cpp:721
+
kiwi::Instance
The Application Instance.
Definition: KiwiApp_Instance.h:50
+
kiwi::PatcherView::getDistantSelection
std::set< uint64_t > getDistantSelection(ObjectFrame const &object) const
Returns a list of Users that selected an object.
Definition: KiwiApp_PatcherView.cpp:541
+
kiwi::PatcherView::getOriginPosition
juce::Point< int > getOriginPosition() const
Returns the position of the patcher origin relative to the component position.
Definition: KiwiApp_PatcherView.cpp:907
+
kiwi::PatcherView::getLink
LinkView * getLink(model::Link const &link)
Returns the LinkView corresponding to a given Link model.
Definition: KiwiApp_PatcherView.cpp:1487
+
kiwi::MouseHandler
The mouse handler is used to make the patcher view react to the mouse interactions.
Definition: KiwiApp_PatcherViewMouseHandler.h:47
+
kiwi::PatcherView::getViewport
PatcherViewport & getViewport()
Returns the Viewport that contains this patcher view.
Definition: KiwiApp_PatcherView.h:106
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
-
kiwi::PatcherView::isSelected
bool isSelected(ObjectView const &object) const
Returns true if the object is selected.
Definition: KiwiApp_PatcherView.cpp:951
-
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:48
-
kiwi::PatcherView::endEditBox
void endEditBox(ClassicBox &box, std::string new_text)
called by ClassicBox when hmmm.. the text has been edited.
Definition: KiwiApp_PatcherView.cpp:1962
+
kiwi::ObjectFrame
A juce component holding the object&#39;s graphical representation.
Definition: KiwiApp_ObjectFrame.h:43
+
kiwi::PatcherView::isSelected
bool isSelected(ObjectFrame const &object) const
Returns true if the object is selected.
Definition: KiwiApp_PatcherView.cpp:536
+
kiwi::PatcherView::getLinks
LinkViews const & getLinks() const
Returns the LinkViews.
Definition: KiwiApp_PatcherView.cpp:1476
+
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:49
+
kiwi::PatcherView::getObject
ObjectFrame * getObject(model::Object const &object)
Returns the Object&#39;s frame corresponding to a given Object model.
Definition: KiwiApp_PatcherView.cpp:1481
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___patcher_view_hit_tester_8h_source.html b/docs/html/_kiwi_app___patcher_view_hit_tester_8h_source.html index 89dff2e2..919b22c9 100644 --- a/docs/html/_kiwi_app___patcher_view_hit_tester_8h_source.html +++ b/docs/html/_kiwi_app___patcher_view_hit_tester_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewHitTester.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_PatcherViewHitTester.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  class PatcherView;
29  class ObjectView;
30  class LinkView;
31 
32  // ================================================================================ //
33  // HITTESTER //
34  // ================================================================================ //
35 
37  class HitTester
38  {
39  public:
40 
42  enum class Target : int
43  {
44  Nothing = 0,
45  Patcher = 1,
46  Box = 2,
47  Link = 3
48  };
49 
51  enum class Zone : int
52  {
53  Outside = 1<<0,
54  Inside = 1<<1,
55  Inlet = 1<<2,
56  Outlet = 1<<3,
57  Border = 1<<4
58  };
59 
61  enum Border
62  {
63  None = 1<<0,
64  Left = 1<<1,
65  Right = 1<<2,
66  Top = 1<<3,
67  Bottom = 1<<4,
68  };
69 
71  HitTester(PatcherView const& patcher);
72 
74  ~HitTester();
75 
78  void reset();
79 
84  void test(juce::Point<int> const& point) noexcept;
85 
90  bool testObjects(juce::Point<int> const& point) noexcept;
91 
96  bool testLinks(juce::Point<int> const& point) noexcept;
97 
103  void test(juce::Rectangle<int> const& rect,
104  std::vector<ObjectView*>& objects,
105  std::vector<LinkView*>& links);
106 
111  void testObjects(juce::Rectangle<int> const& rect, std::vector<ObjectView*>& objects);
112 
117  void testLinks(juce::Rectangle<int> const& rect, std::vector<LinkView*>& links);
118 
120  inline Target getTarget() const noexcept { return m_target; }
121 
123  inline bool nothingTouched() const noexcept { return m_target == Target::Nothing; }
124 
126  inline bool patcherTouched() const noexcept { return m_target == Target::Patcher; }
127 
129  inline bool objectTouched() const noexcept { return m_target == Target::Box; }
130 
132  inline bool linkTouched() const noexcept { return m_target == Target::Link; }
133 
135  PatcherView const& getPatcher() const noexcept;
136 
138  ObjectView* getObject() const noexcept;
139 
141  LinkView* getLink() const noexcept;
142 
150  Zone getZone() const noexcept;
151 
153  int getBorder() const noexcept;
154 
160  size_t getIndex() const noexcept;
161 
162  private: // members
163 
164  PatcherView const& m_patcher;
165  ObjectView* m_object = nullptr;
166  LinkView* m_link = nullptr;
167  Target m_target = Target::Nothing;
168  Zone m_zone = Zone::Outside;
169  int m_border = Border::None;
170  size_t m_index = 0;
171 
172  friend class LinkView;
173  friend class ObjectView;
174  };
175 }
kiwi::HitTester::HitTester
HitTester(PatcherView const &patcher)
Contructor.
Definition: KiwiApp_PatcherViewHitTester.cpp:33
-
kiwi::HitTester::getIndex
size_t getIndex() const noexcept
Returns the index of the Zone of the object box.
Definition: KiwiApp_PatcherViewHitTester.cpp:218
-
kiwi::HitTester::~HitTester
~HitTester()
Destructor.
Definition: KiwiApp_PatcherViewHitTester.cpp:45
-
kiwi::HitTester::getBorder
int getBorder() const noexcept
Returns the type of border (if a border of an object box has hit).
Definition: KiwiApp_PatcherViewHitTester.cpp:209
-
kiwi::HitTester::nothingTouched
bool nothingTouched() const noexcept
Returns true if nothing has been hit by the test, otherwise returns false.
Definition: KiwiApp_PatcherViewHitTester.h:123
-
kiwi::HitTester::getObject
ObjectView * getObject() const noexcept
Get the object box that has been touched by the last hit-test.
Definition: KiwiApp_PatcherViewHitTester.cpp:172
-
kiwi::HitTester::getPatcher
PatcherView const & getPatcher() const noexcept
Get the patcher.
Definition: KiwiApp_PatcherViewHitTester.cpp:167
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  class PatcherView;
29  class ObjectFrame;
30  class LinkView;
31 
32  // ================================================================================ //
33  // HITTESTER //
34  // ================================================================================ //
35 
37  class HitTester
38  {
39  public:
40 
42  enum class Target : int
43  {
44  Nothing = 0,
45  Patcher = 1,
46  Box = 2,
47  Link = 3
48  };
49 
51  enum class Zone : int
52  {
53  Outside = 1<<0,
54  Inside = 1<<1,
55  Inlet = 1<<2,
56  Outlet = 1<<3,
57  Border = 1<<4
58  };
59 
61  enum Border
62  {
63  None = 1<<0,
64  Left = 1<<1,
65  Right = 1<<2,
66  Top = 1<<3,
67  Bottom = 1<<4,
68  };
69 
71  HitTester(PatcherView const& patcher);
72 
74  ~HitTester();
75 
78  void reset();
79 
84  void test(juce::Point<int> const& point) noexcept;
85 
90  bool testObjects(juce::Point<int> const& point) noexcept;
91 
96  bool testLinks(juce::Point<int> const& point) noexcept;
97 
103  void test(juce::Rectangle<int> const& rect,
104  std::vector<ObjectFrame*>& objects,
105  std::vector<LinkView*>& links);
106 
111  void testObjects(juce::Rectangle<int> const& rect, std::vector<ObjectFrame*>& objects);
112 
117  void testLinks(juce::Rectangle<int> const& rect, std::vector<LinkView*>& links);
118 
120  inline Target getTarget() const noexcept { return m_target; }
121 
123  inline bool nothingTouched() const noexcept { return m_target == Target::Nothing; }
124 
126  inline bool patcherTouched() const noexcept { return m_target == Target::Patcher; }
127 
129  inline bool objectTouched() const noexcept { return m_target == Target::Box; }
130 
132  inline bool linkTouched() const noexcept { return m_target == Target::Link; }
133 
135  PatcherView const& getPatcher() const noexcept;
136 
138  ObjectFrame* getObject() const noexcept;
139 
141  LinkView* getLink() const noexcept;
142 
150  Zone getZone() const noexcept;
151 
153  int getBorder() const noexcept;
154 
160  size_t getIndex() const noexcept;
161 
162  private: // members
163 
164  PatcherView const& m_patcher;
165  ObjectFrame* m_object = nullptr;
166  LinkView* m_link = nullptr;
167  Target m_target = Target::Nothing;
168  Zone m_zone = Zone::Outside;
169  int m_border = Border::None;
170  size_t m_index = 0;
171 
172  friend class LinkView;
173  friend class ObjectFrame;
174  };
175 }
kiwi::HitTester::objectTouched
bool objectTouched() const noexcept
Returns true if the test hit an object, otherwise return false.
Definition: KiwiApp_PatcherViewHitTester.h:129
+
kiwi::HitTester::getIndex
size_t getIndex() const noexcept
Returns the index of the Zone of the object box.
Definition: KiwiApp_PatcherViewHitTester.cpp:219
+
kiwi::HitTester::HitTester
HitTester(PatcherView const &patcher)
Contructor.
Definition: KiwiApp_PatcherViewHitTester.cpp:34
+
kiwi::HitTester::getObject
ObjectFrame * getObject() const noexcept
Get the object box that has been touched by the last hit-test.
Definition: KiwiApp_PatcherViewHitTester.cpp:173
+
kiwi::HitTester::~HitTester
~HitTester()
Destructor.
Definition: KiwiApp_PatcherViewHitTester.cpp:46
+
kiwi::HitTester::nothingTouched
bool nothingTouched() const noexcept
Returns true if nothing has been hit by the test, otherwise returns false.
Definition: KiwiApp_PatcherViewHitTester.h:123
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::HitTester::patcherTouched
bool patcherTouched() const noexcept
Returns true if the test hit the patcher, otherwise return false.
Definition: KiwiApp_PatcherViewHitTester.h:126
kiwi::HitTester::Zone
Zone
The Zone.
Definition: KiwiApp_PatcherViewHitTester.h:51
kiwi::HitTester
The HitTester class...
Definition: KiwiApp_PatcherViewHitTester.h:37
-
kiwi::HitTester::getLink
LinkView * getLink() const noexcept
Get the link that has been touched by the last hit-test.
Definition: KiwiApp_PatcherViewHitTester.cpp:182
kiwi::HitTester::Target
Target
The target type.
Definition: KiwiApp_PatcherViewHitTester.h:42
-
kiwi::HitTester::testObjects
bool testObjects(juce::Point< int > const &point) noexcept
Test a point.
Definition: KiwiApp_PatcherViewHitTester.cpp:78
-
kiwi::ObjectView
The juce object Component.
Definition: KiwiApp_ObjectView.h:41
-
kiwi::HitTester::getZone
Zone getZone() const noexcept
Get the Zone of the Target that result of the hit-test.
Definition: KiwiApp_PatcherViewHitTester.cpp:191
+
kiwi::HitTester::testObjects
bool testObjects(juce::Point< int > const &point) noexcept
Test a point.
Definition: KiwiApp_PatcherViewHitTester.cpp:79
+
kiwi::HitTester::patcherTouched
bool patcherTouched() const noexcept
Returns true if the test hit the patcher, otherwise return false.
Definition: KiwiApp_PatcherViewHitTester.h:126
kiwi::HitTester::Border
Border
The Border type.
Definition: KiwiApp_PatcherViewHitTester.h:61
-
kiwi::HitTester::getTarget
Target getTarget() const noexcept
Get the last touched Target.
Definition: KiwiApp_PatcherViewHitTester.h:120
-
kiwi::HitTester::objectTouched
bool objectTouched() const noexcept
Returns true if the test hit an object, otherwise return false.
Definition: KiwiApp_PatcherViewHitTester.h:129
-
kiwi::HitTester::testLinks
bool testLinks(juce::Point< int > const &point) noexcept
Test a point.
Definition: KiwiApp_PatcherViewHitTester.cpp:105
-
kiwi::HitTester::reset
void reset()
Reset the hit test.
Definition: KiwiApp_PatcherViewHitTester.cpp:50
-
kiwi::HitTester::linkTouched
bool linkTouched() const noexcept
Returns true if the test hit a link, otherwise return false.
Definition: KiwiApp_PatcherViewHitTester.h:132
-
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:48
-
kiwi::HitTester::test
void test(juce::Point< int > const &point) noexcept
Run a hit test on object and links for a given point.
Definition: KiwiApp_PatcherViewHitTester.cpp:60
+
kiwi::HitTester::getLink
LinkView * getLink() const noexcept
Get the link that has been touched by the last hit-test.
Definition: KiwiApp_PatcherViewHitTester.cpp:183
+
kiwi::HitTester::getTarget
Target getTarget() const noexcept
Get the last touched Target.
Definition: KiwiApp_PatcherViewHitTester.h:120
+
kiwi::HitTester::linkTouched
bool linkTouched() const noexcept
Returns true if the test hit a link, otherwise return false.
Definition: KiwiApp_PatcherViewHitTester.h:132
+
kiwi::HitTester::getZone
Zone getZone() const noexcept
Get the Zone of the Target that result of the hit-test.
Definition: KiwiApp_PatcherViewHitTester.cpp:192
+
kiwi::ObjectFrame
A juce component holding the object&#39;s graphical representation.
Definition: KiwiApp_ObjectFrame.h:43
+
kiwi::HitTester::getPatcher
PatcherView const & getPatcher() const noexcept
Get the patcher.
Definition: KiwiApp_PatcherViewHitTester.cpp:168
+
kiwi::HitTester::testLinks
bool testLinks(juce::Point< int > const &point) noexcept
Test a point.
Definition: KiwiApp_PatcherViewHitTester.cpp:106
+
kiwi::HitTester::getBorder
int getBorder() const noexcept
Returns the type of border (if a border of an object box has hit).
Definition: KiwiApp_PatcherViewHitTester.cpp:210
+
kiwi::HitTester::reset
void reset()
Reset the hit test.
Definition: KiwiApp_PatcherViewHitTester.cpp:51
+
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:49
+
kiwi::HitTester::test
void test(juce::Point< int > const &point) noexcept
Run a hit test on object and links for a given point.
Definition: KiwiApp_PatcherViewHitTester.cpp:61
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___patcher_view_iolet_highlighter_8h_source.html b/docs/html/_kiwi_app___patcher_view_iolet_highlighter_8h_source.html index 53f2a334..b1516001 100644 --- a/docs/html/_kiwi_app___patcher_view_iolet_highlighter_8h_source.html +++ b/docs/html/_kiwi_app___patcher_view_iolet_highlighter_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewIoletHighlighter.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_PatcherViewIoletHighlighter.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 #include "../KiwiApp_Components/KiwiApp_TooltipWindow.h"
26 
27 namespace kiwi
28 {
29  class ObjectView;
30 
31  // ================================================================================ //
32  // IOLET HILIGHTER //
33  // ================================================================================ //
34 
35  class IoletHighlighter
36  : public juce::Component
37  , public CustomTooltipClient
38  {
39  public:
40 
42  IoletHighlighter();
43 
45  ~IoletHighlighter() = default;
46 
48  void paint(juce::Graphics& g) override;
49 
51  void hide();
52 
54  void highlightInlet(ObjectView const& object, const size_t index);
55 
57  void highlightOutlet(ObjectView const& object, const size_t index);
58 
60  juce::String getTooltip() override;
61 
63  juce::Rectangle<int> getTooltipBounds(juce::String const& tip,
64  juce::Point<int>,
65  juce::Rectangle<int> parent_area,
66  int width,
67  int height) override;
68 
70  bool drawTooltip(juce::Graphics& g,
71  juce::String const& text,
72  int width, int height) override;
73 
74  private: // methods
75 
76  void highlight(ObjectView const& object, const size_t index);
77 
78  private: // members
79 
80  bool m_is_inlet;
81  std::string m_text;
82  std::string m_object_name;
83  bool m_show_tooltip_on_left;
84  size_t m_last_index;
85  };
86 }
kiwi::IoletHighlighter::getTooltip
juce::String getTooltip() override
Returns the string that this object wants to show as its tooltip.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:98
-
kiwi::IoletHighlighter::getTooltipBounds
juce::Rectangle< int > getTooltipBounds(juce::String const &tip, juce::Point< int >, juce::Rectangle< int > parent_area, int width, int height) override
Returns the bounds of the tooltip to show.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:103
-
kiwi::IoletHighlighter::highlightOutlet
void highlightOutlet(ObjectView const &object, const size_t index)
Highlight outlet.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:68
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 #include "../KiwiApp_Components/KiwiApp_TooltipWindow.h"
26 
27 namespace kiwi
28 {
29  class ObjectFrame;
30 
31  // ================================================================================ //
32  // IOLET HILIGHTER //
33  // ================================================================================ //
34 
35  class IoletHighlighter
36  : public juce::Component
37  , public CustomTooltipClient
38  {
39  public:
40 
42  IoletHighlighter();
43 
45  ~IoletHighlighter() = default;
46 
48  void paint(juce::Graphics& g) override;
49 
51  void hide();
52 
54  void highlightInlet(ObjectFrame const& object, const size_t index);
55 
57  void highlightOutlet(ObjectFrame const& object, const size_t index);
58 
60  juce::String getTooltip() override;
61 
63  juce::Rectangle<int> getTooltipBounds(juce::String const& tip,
64  juce::Point<int>,
65  juce::Rectangle<int> parent_area,
66  int width,
67  int height) override;
68 
70  bool drawTooltip(juce::Graphics& g,
71  juce::String const& text,
72  int width, int height) override;
73 
74  private: // methods
75 
76  void highlight(ObjectFrame const& object, const size_t index, bool is_inlet);
77 
78  private: // members
79 
80  bool m_is_inlet;
81  std::string m_text;
82  std::string m_object_name;
83  bool m_show_tooltip_on_left;
84  size_t m_last_index;
85  flip::Ref m_object_ref;
86  };
87 }
kiwi::IoletHighlighter::highlightOutlet
void highlightOutlet(ObjectFrame const &object, const size_t index)
Highlight outlet.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:73
+
kiwi::IoletHighlighter::getTooltip
juce::String getTooltip() override
Returns the string that this object wants to show as its tooltip.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:107
+
kiwi::IoletHighlighter::getTooltipBounds
juce::Rectangle< int > getTooltipBounds(juce::String const &tip, juce::Point< int >, juce::Rectangle< int > parent_area, int width, int height) override
Returns the bounds of the tooltip to show.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:112
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::IoletHighlighter
Definition: KiwiApp_PatcherViewIoletHighlighter.h:35
-
kiwi::IoletHighlighter::IoletHighlighter
IoletHighlighter()
Constructor.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:32
+
kiwi::IoletHighlighter::IoletHighlighter
IoletHighlighter()
Constructor.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:33
kiwi::CustomTooltipClient
A custom tooltip client that provides the bounds of the tooltip to show.
Definition: KiwiApp_TooltipWindow.h:33
kiwi::IoletHighlighter::~IoletHighlighter
~IoletHighlighter()=default
Destructor.
-
kiwi::ObjectView
The juce object Component.
Definition: KiwiApp_ObjectView.h:41
-
kiwi::IoletHighlighter::highlightInlet
void highlightInlet(ObjectView const &object, const size_t index)
Highlight inlet.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:62
-
kiwi::IoletHighlighter::paint
void paint(juce::Graphics &g) override
The paint method.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:48
-
kiwi::IoletHighlighter::hide
void hide()
Stop highlighting.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:41
-
kiwi::IoletHighlighter::drawTooltip
bool drawTooltip(juce::Graphics &g, juce::String const &text, int width, int height) override
Overriden to provide a custom drawing method.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:129
+
kiwi::ObjectFrame
A juce component holding the object&#39;s graphical representation.
Definition: KiwiApp_ObjectFrame.h:43
+
kiwi::IoletHighlighter::highlightInlet
void highlightInlet(ObjectFrame const &object, const size_t index)
Highlight inlet.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:68
+
kiwi::IoletHighlighter::paint
void paint(juce::Graphics &g) override
The paint method.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:54
+
kiwi::IoletHighlighter::hide
void hide()
Stop highlighting.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:47
+
kiwi::IoletHighlighter::drawTooltip
bool drawTooltip(juce::Graphics &g, juce::String const &text, int width, int height) override
Overriden to provide a custom drawing method.
Definition: KiwiApp_PatcherViewIoletHighlighter.cpp:138
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___patcher_view_lasso_8h_source.html b/docs/html/_kiwi_app___patcher_view_lasso_8h_source.html index 181e6dd4..7fc6dace 100644 --- a/docs/html/_kiwi_app___patcher_view_lasso_8h_source.html +++ b/docs/html/_kiwi_app___patcher_view_lasso_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewLasso.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_PatcherViewLasso.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "flip/Ref.h"
25 
26 #include <juce_gui_extra/juce_gui_extra.h>
27 
28 #include <set>
29 
30 #include "../KiwiApp_Components/KiwiApp_TooltipWindow.h"
31 
32 namespace kiwi
33 {
34  class PatcherView;
35  class ObjectView;
36 
37  // ================================================================================ //
38  // LASSO //
39  // ================================================================================ //
40 
41  class Lasso : public juce::Component
42  {
43  public:
44 
46  Lasso(PatcherView& patcher);
47 
49  ~Lasso();
50 
52  void paint(juce::Graphics& g) override;
53 
57  void begin(juce::Point<int> const& point, const bool preserve_selection);
58 
64  void perform(juce::Point<int> const& point, bool objects, bool links, const bool preserve);
65 
67  void end();
68 
70  bool isPerforming() const noexcept;
71 
72  private: // members
73 
74  PatcherView& m_patcher;
75 
76  std::set<flip::Ref> m_objects;
77  std::set<flip::Ref> m_links;
78 
79  juce::Point<int> m_start;
80  bool m_dragging;
81  };
82 }
kiwi::Lasso::perform
void perform(juce::Point< int > const &point, bool objects, bool links, const bool preserve)
Perform the selection of the links and the boxes.
Definition: KiwiApp_PatcherViewLasso.cpp:82
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "flip/Ref.h"
25 
26 #include <juce_gui_extra/juce_gui_extra.h>
27 
28 #include <set>
29 
30 #include "../KiwiApp_Components/KiwiApp_TooltipWindow.h"
31 
32 namespace kiwi
33 {
34  class PatcherView;
35  class ObjectFrame;
36 
37  // ================================================================================ //
38  // LASSO //
39  // ================================================================================ //
40 
41  class Lasso : public juce::Component
42  {
43  public:
44 
46  Lasso(PatcherView& patcher);
47 
49  ~Lasso();
50 
52  void paint(juce::Graphics& g) override;
53 
57  void begin(juce::Point<int> const& point, const bool preserve_selection);
58 
64  void perform(juce::Point<int> const& point, bool objects, bool links, const bool preserve);
65 
67  void end();
68 
70  bool isPerforming() const noexcept;
71 
72  private: // members
73 
74  PatcherView& m_patcher;
75 
76  std::set<flip::Ref> m_objects;
77  std::set<flip::Ref> m_links;
78 
79  juce::Point<int> m_start;
80  bool m_dragging;
81  };
82 }
kiwi::Lasso::perform
void perform(juce::Point< int > const &point, bool objects, bool links, const bool preserve)
Perform the selection of the links and the boxes.
Definition: KiwiApp_PatcherViewLasso.cpp:83
kiwi::Lasso
Definition: KiwiApp_PatcherViewLasso.h:41
-
kiwi::Lasso::isPerforming
bool isPerforming() const noexcept
Retrieve Returns true if the Lasso is performing the selection.
Definition: KiwiApp_PatcherViewLasso.cpp:48
-
kiwi::Lasso::end
void end()
Ends the selection of the links and the boxes.
Definition: KiwiApp_PatcherViewLasso.cpp:198
+
kiwi::Lasso::end
void end()
Ends the selection of the links and the boxes.
Definition: KiwiApp_PatcherViewLasso.cpp:199
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::Lasso::paint
void paint(juce::Graphics &g) override
The paint method.
Definition: KiwiApp_PatcherViewLasso.cpp:53
-
kiwi::Lasso::begin
void begin(juce::Point< int > const &point, const bool preserve_selection)
Begins the selection of the links and the boxes.
Definition: KiwiApp_PatcherViewLasso.cpp:64
-
kiwi::Lasso::~Lasso
~Lasso()
Destructor.
Definition: KiwiApp_PatcherViewLasso.cpp:43
-
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:48
-
kiwi::Lasso::Lasso
Lasso(PatcherView &patcher)
Contructor.
Definition: KiwiApp_PatcherViewLasso.cpp:34
+
kiwi::Lasso::paint
void paint(juce::Graphics &g) override
The paint method.
Definition: KiwiApp_PatcherViewLasso.cpp:54
+
kiwi::Lasso::begin
void begin(juce::Point< int > const &point, const bool preserve_selection)
Begins the selection of the links and the boxes.
Definition: KiwiApp_PatcherViewLasso.cpp:65
+
kiwi::Lasso::~Lasso
~Lasso()
Destructor.
Definition: KiwiApp_PatcherViewLasso.cpp:44
+
kiwi::Lasso::isPerforming
bool isPerforming() const noexcept
Retrieve Returns true if the Lasso is performing the selection.
Definition: KiwiApp_PatcherViewLasso.cpp:49
+
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:49
+
kiwi::Lasso::Lasso
Lasso(PatcherView &patcher)
Contructor.
Definition: KiwiApp_PatcherViewLasso.cpp:35
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___patcher_view_mouse_handler_8h_source.html b/docs/html/_kiwi_app___patcher_view_mouse_handler_8h_source.html new file mode 100644 index 00000000..1e161c1e --- /dev/null +++ b/docs/html/_kiwi_app___patcher_view_mouse_handler_8h_source.html @@ -0,0 +1,114 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewMouseHandler.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_PatcherViewMouseHandler.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <map>
25 
26 #include <memory>
27 
28 #include <juce_gui_basics/juce_gui_basics.h>
29 
30 #include <flip/Ref.h>
31 
32 #include <KiwiModel/KiwiModel_Object.h>
33 
34 
35 
36 namespace kiwi
37 {
38  class PatcherView;
39  class ObjectFrame;
40  class HitTester;
41 
42  // ================================================================================ //
43  // MOUSEHANDLER //
44  // ================================================================================ //
45 
47  class MouseHandler
48  {
49  public: // enums
50 
51  enum class Action
52  {
53  None = 0,
54  CopyOnDrag = 1,
55  Object = 2,
56  CreateLink = 3,
57  Lasso = 4,
58  MoveObject = 5,
59  PopupMenu = 6,
60  ObjectEdition = 7,
61  SwitchSelection = 8,
62  Selection = 9,
63  SwitchLock = 10,
64  ResizeObject = 11
65  };
66 
67  enum Direction : int
68  {
69  None = 0,
70  Up = 1 << 0,
71  Down = 1 << 1,
72  Left = 1 << 2,
73  Right = 1 << 3
74  };
75 
76  public: // methods
77 
79  Action getCurrentAction();
80 
82  MouseHandler(PatcherView & patcher_view);
83 
85  ~MouseHandler();
86 
88  void handleMouseDown(juce::MouseEvent const& e);
89 
91  void handleMouseDrag(juce::MouseEvent const& e);
92 
94  void handleMouseUp(juce::MouseEvent const& e);
95 
97  void handleMouseDoubleClick(juce::MouseEvent const& e);
98 
100  void handleMouseMove(juce::MouseEvent const& e);
101 
102  private: // methods
103 
105  void startAction(Action action, juce::MouseEvent const& e);
106 
108  void continueAction(juce::MouseEvent const& e);
109 
111  void endAction(juce::MouseEvent const& e);
112 
114  int getResizeDirection(HitTester const& hit_tester) const;
115 
118  void applyNewBounds(model::Object & object_model, juce::Rectangle<int> new_bounds, double ratio = 0.) const;
119 
121  juce::MouseCursor::StandardCursorType getMouseCursorForBorder(HitTester const& hit_tester) const;
122 
123  private: // members
124 
125  PatcherView & m_patcher_view;
126  Action m_current_action;
127  juce::Point<int> m_last_drag;
128  std::map<flip::Ref, juce::Rectangle<int>> m_mousedown_bounds;
129  int m_direction;
130 
131  private: // deleted methods
132 
133  MouseHandler() = delete;
134  MouseHandler(MouseHandler const& other) = delete;
135  MouseHandler(MouseHandler && other) = delete;
136  MouseHandler& operator=(MouseHandler const& other) = delete;
137  MouseHandler& operator=(MouseHandler && other) = delete;
138  };
139 }
kiwi::Lasso
Definition: KiwiApp_PatcherViewLasso.h:41
+
kiwi::MouseHandler::handleMouseDrag
void handleMouseDrag(juce::MouseEvent const &e)
Handles patcher view&#39;s mouse drag event.
Definition: KiwiApp_PatcherViewMouseHandler.cpp:639
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::HitTester
The HitTester class...
Definition: KiwiApp_PatcherViewHitTester.h:37
+
kiwi::MouseHandler::handleMouseDoubleClick
void handleMouseDoubleClick(juce::MouseEvent const &e)
Handles patcher view&#39;s mouse double click events.
Definition: KiwiApp_PatcherViewMouseHandler.cpp:651
+
kiwi::MouseHandler::getCurrentAction
Action getCurrentAction()
Returns the current action.
Definition: KiwiApp_PatcherViewMouseHandler.cpp:52
+
kiwi::MouseHandler::handleMouseUp
void handleMouseUp(juce::MouseEvent const &e)
Handles patcher view&#39;s mouse up event.
Definition: KiwiApp_PatcherViewMouseHandler.cpp:646
+
kiwi::MouseHandler
The mouse handler is used to make the patcher view react to the mouse interactions.
Definition: KiwiApp_PatcherViewMouseHandler.h:47
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::MouseHandler::handleMouseMove
void handleMouseMove(juce::MouseEvent const &e)
Handles patcher view&#39;s mouse move events.
Definition: KiwiApp_PatcherViewMouseHandler.cpp:757
+
kiwi::MouseHandler::~MouseHandler
~MouseHandler()
Destructor.
Definition: KiwiApp_PatcherViewMouseHandler.cpp:48
+
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:49
+
kiwi::MouseHandler::handleMouseDown
void handleMouseDown(juce::MouseEvent const &e)
Handles patcher view&#39;s mouse down event.
Definition: KiwiApp_PatcherViewMouseHandler.cpp:535
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___patcher_viewport_8h_source.html b/docs/html/_kiwi_app___patcher_viewport_8h_source.html index 18118280..5b64c011 100644 --- a/docs/html/_kiwi_app___patcher_viewport_8h_source.html +++ b/docs/html/_kiwi_app___patcher_viewport_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_PatcherViewport.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_PatcherViewport.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  class PatcherView;
29  class ObjectView;
30 
31  // ================================================================================ //
32  // PATCHER VIEWPORT //
33  // ================================================================================ //
34 
36  class PatcherViewport : public juce::Viewport
37  {
38  public:
39 
41  PatcherViewport(PatcherView& patcher);
42 
44  ~PatcherViewport() = default;
45 
47  void visibleAreaChanged(juce::Rectangle<int> const& new_visible_area) override;
48 
50  void resized() override;
51 
53  void jumpViewToObject(ObjectView const&);
54 
56  void bringRectToCentre(juce::Rectangle<int> bounds);
57 
59  juce::Point<int> getRelativePosition(juce::Point<int> point) const noexcept;
60 
62  juce::Rectangle<int> getRelativeViewArea() const noexcept;
63 
65  juce::Point<int> getRelativeViewPosition() const noexcept;
66 
68  void setRelativeViewPosition(juce::Point<int> position);
69 
72  void setZoomFactor(double zoom_factor);
73 
75  double getZoomFactor() const noexcept;
76 
78  juce::Point<int> getOriginPosition() const noexcept;
79 
81  void resetObjectsArea();
82 
84  juce::Rectangle<int> getObjectsArea() const noexcept;
85 
87  void updatePatcherArea(bool keep_same_view_position);
88 
89  private: // members
90 
92  void viewportResized(juce::Rectangle<int> const& last_bounds,
93  juce::Rectangle<int> const& new_bounds);
94 
95  private: // members
96 
97  PatcherView& m_patcher;
98  juce::Viewport m_viewport;
99  Component m_magnifier;
100  juce::Rectangle<int> m_last_bounds;
101  juce::Rectangle<int> m_patching_area;
102  double m_zoom_factor;
103  bool m_can_hook_resized;
104  };
105 }
kiwi::PatcherViewport::resetObjectsArea
void resetObjectsArea()
Reset the objects area.
Definition: KiwiApp_PatcherViewport.cpp:161
-
kiwi::PatcherViewport::updatePatcherArea
void updatePatcherArea(bool keep_same_view_position)
Update patcher size.
Definition: KiwiApp_PatcherViewport.cpp:301
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  class PatcherView;
29  class ObjectFrame;
30 
31  // ================================================================================ //
32  // PATCHER VIEWPORT //
33  // ================================================================================ //
34 
36  class PatcherViewport : public juce::Viewport
37  {
38  public:
39 
41  PatcherViewport(PatcherView& patcher);
42 
44  ~PatcherViewport() = default;
45 
47  void visibleAreaChanged(juce::Rectangle<int> const& new_visible_area) override;
48 
50  void resized() override;
51 
53  void jumpViewToObject(ObjectFrame const&);
54 
56  void bringRectToCentre(juce::Rectangle<int> bounds);
57 
59  juce::Point<int> getRelativePosition(juce::Point<int> point) const noexcept;
60 
62  juce::Rectangle<int> getRelativeViewArea() const noexcept;
63 
65  juce::Point<int> getRelativeViewPosition() const noexcept;
66 
68  void setRelativeViewPosition(juce::Point<int> position);
69 
72  void setZoomFactor(double zoom_factor);
73 
75  double getZoomFactor() const noexcept;
76 
78  juce::Point<int> getOriginPosition() const noexcept;
79 
81  void resetObjectsArea();
82 
84  juce::Rectangle<int> getObjectsArea() const noexcept;
85 
87  void updatePatcherArea(bool keep_same_view_position);
88 
89  private: // members
90 
92  void viewportResized(juce::Rectangle<int> const& last_bounds,
93  juce::Rectangle<int> const& new_bounds);
94 
95  private: // members
96 
97  PatcherView& m_patcher;
98  juce::Viewport m_viewport;
99  Component m_magnifier;
100  juce::Rectangle<int> m_last_bounds;
101  juce::Rectangle<int> m_patching_area;
102  double m_zoom_factor;
103  bool m_can_hook_resized;
104  };
105 }
kiwi::PatcherViewport::resetObjectsArea
void resetObjectsArea()
Reset the objects area.
Definition: KiwiApp_PatcherViewport.cpp:162
+
kiwi::PatcherViewport::updatePatcherArea
void updatePatcherArea(bool keep_same_view_position)
Update patcher size.
Definition: KiwiApp_PatcherViewport.cpp:302
kiwi::PatcherViewport
The PatcherView Viewport.
Definition: KiwiApp_PatcherViewport.h:36
-
kiwi::PatcherViewport::jumpViewToObject
void jumpViewToObject(ObjectView const &)
Make the object visible in the viewport area.
Definition: KiwiApp_PatcherViewport.cpp:113
kiwi::PatcherViewport::~PatcherViewport
~PatcherViewport()=default
Destructor.
+
kiwi::PatcherViewport::getZoomFactor
double getZoomFactor() const noexcept
Returns the current zoom factor.
Definition: KiwiApp_PatcherViewport.cpp:81
+
kiwi::PatcherViewport::getRelativePosition
juce::Point< int > getRelativePosition(juce::Point< int > point) const noexcept
Transforms a given point into a point relative to the patcher origin position.
Definition: KiwiApp_PatcherViewport.cpp:99
+
kiwi::PatcherViewport::getObjectsArea
juce::Rectangle< int > getObjectsArea() const noexcept
Returns the current objects area.
Definition: KiwiApp_PatcherViewport.cpp:168
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::ObjectView
The juce object Component.
Definition: KiwiApp_ObjectView.h:41
-
kiwi::PatcherViewport::getRelativePosition
juce::Point< int > getRelativePosition(juce::Point< int > point) const noexcept
Transforms a given point into a point relative to the patcher origin position.
Definition: KiwiApp_PatcherViewport.cpp:98
-
kiwi::PatcherViewport::getRelativeViewArea
juce::Rectangle< int > getRelativeViewArea() const noexcept
Returns the current patcher area relative to the patcher origin position.
Definition: KiwiApp_PatcherViewport.cpp:85
-
kiwi::PatcherViewport::setZoomFactor
void setZoomFactor(double zoom_factor)
Set the zoom factor.
Definition: KiwiApp_PatcherViewport.cpp:68
-
kiwi::PatcherViewport::getOriginPosition
juce::Point< int > getOriginPosition() const noexcept
Returns the position of the patcher origin relative to the component position.
Definition: KiwiApp_PatcherViewport.cpp:172
-
kiwi::PatcherViewport::getZoomFactor
double getZoomFactor() const noexcept
Returns the current zoom factor.
Definition: KiwiApp_PatcherViewport.cpp:80
-
kiwi::PatcherViewport::setRelativeViewPosition
void setRelativeViewPosition(juce::Point< int > position)
Set the new view position relative to the patcher origin position.
Definition: KiwiApp_PatcherViewport.cpp:108
-
kiwi::PatcherViewport::resized
void resized() override
Overriden from juce::Viewport to update patcher area on viewport resize.
Definition: KiwiApp_PatcherViewport.cpp:50
-
kiwi::PatcherViewport::visibleAreaChanged
void visibleAreaChanged(juce::Rectangle< int > const &new_visible_area) override
Called by juce::Viewport when the visible area changed.
Definition: KiwiApp_PatcherViewport.cpp:45
-
kiwi::PatcherViewport::bringRectToCentre
void bringRectToCentre(juce::Rectangle< int > bounds)
Attempts to brings the center of the given bounds to the center of the viewport view area...
Definition: KiwiApp_PatcherViewport.cpp:147
-
kiwi::PatcherViewport::PatcherViewport
PatcherViewport(PatcherView &patcher)
Constructor.
Definition: KiwiApp_PatcherViewport.cpp:32
-
kiwi::PatcherViewport::getObjectsArea
juce::Rectangle< int > getObjectsArea() const noexcept
Returns the current objects area.
Definition: KiwiApp_PatcherViewport.cpp:167
-
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:48
-
kiwi::PatcherViewport::getRelativeViewPosition
juce::Point< int > getRelativeViewPosition() const noexcept
Get the view position relative to the patcher origin position.
Definition: KiwiApp_PatcherViewport.cpp:103
+
kiwi::PatcherViewport::getRelativeViewPosition
juce::Point< int > getRelativeViewPosition() const noexcept
Get the view position relative to the patcher origin position.
Definition: KiwiApp_PatcherViewport.cpp:104
+
kiwi::PatcherViewport::jumpViewToObject
void jumpViewToObject(ObjectFrame const &)
Make the object visible in the viewport area.
Definition: KiwiApp_PatcherViewport.cpp:114
+
kiwi::PatcherViewport::setZoomFactor
void setZoomFactor(double zoom_factor)
Set the zoom factor.
Definition: KiwiApp_PatcherViewport.cpp:69
+
kiwi::ObjectFrame
A juce component holding the object&#39;s graphical representation.
Definition: KiwiApp_ObjectFrame.h:43
+
kiwi::PatcherViewport::setRelativeViewPosition
void setRelativeViewPosition(juce::Point< int > position)
Set the new view position relative to the patcher origin position.
Definition: KiwiApp_PatcherViewport.cpp:109
+
kiwi::PatcherViewport::resized
void resized() override
Overriden from juce::Viewport to update patcher area on viewport resize.
Definition: KiwiApp_PatcherViewport.cpp:51
+
kiwi::PatcherViewport::visibleAreaChanged
void visibleAreaChanged(juce::Rectangle< int > const &new_visible_area) override
Called by juce::Viewport when the visible area changed.
Definition: KiwiApp_PatcherViewport.cpp:46
+
kiwi::PatcherViewport::bringRectToCentre
void bringRectToCentre(juce::Rectangle< int > bounds)
Attempts to brings the center of the given bounds to the center of the viewport view area...
Definition: KiwiApp_PatcherViewport.cpp:148
+
kiwi::PatcherViewport::PatcherViewport
PatcherViewport(PatcherView &patcher)
Constructor.
Definition: KiwiApp_PatcherViewport.cpp:33
+
kiwi::PatcherView
The juce Patcher Component.
Definition: KiwiApp_PatcherView.h:49
+
kiwi::PatcherViewport::getRelativeViewArea
juce::Rectangle< int > getRelativeViewArea() const noexcept
Returns the current patcher area relative to the patcher origin position.
Definition: KiwiApp_PatcherViewport.cpp:86
+
kiwi::PatcherViewport::getOriginPosition
juce::Point< int > getOriginPosition() const noexcept
Returns the position of the patcher origin relative to the component position.
Definition: KiwiApp_PatcherViewport.cpp:173
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___settings_panel_8h_source.html b/docs/html/_kiwi_app___settings_panel_8h_source.html index 879ca487..eeb2bd7a 100644 --- a/docs/html/_kiwi_app___settings_panel_8h_source.html +++ b/docs/html/_kiwi_app___settings_panel_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Application/KiwiApp_SettingsPanel.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_SettingsPanel.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // SETTINGS PANEL //
30  // ================================================================================ //
31 
33  class SettingsPanel : public juce::PropertyPanel
34  {
35  public: // classes
36 
38  SettingsPanel();
39 
41  ~SettingsPanel();
42  };
43 }
kiwi::SettingsPanel::~SettingsPanel
~SettingsPanel()
Destructor.
Definition: KiwiApp_SettingsPanel.cpp:49
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_extra/juce_gui_extra.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // SETTINGS PANEL //
30  // ================================================================================ //
31 
33  class SettingsPanel : public juce::Component,
34  public juce::Button::Listener
35  {
36  public: // classes
37 
39  SettingsPanel();
40 
42  ~SettingsPanel();
43 
44  private: // methods
45 
47  void resized() override final;
48 
50  void buttonClicked(juce::Button * button) override final;
51 
52  private: // members
53 
54  juce::ValueTree m_settings;
55  juce::PropertyPanel m_pannel;
56  juce::TextButton m_apply_button;
57  juce::TextButton m_reset_button;
58  };
59 }
kiwi::SettingsPanel::~SettingsPanel
~SettingsPanel()
Destructor.
Definition: KiwiApp_SettingsPanel.cpp:66
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::SettingsPanel::SettingsPanel
SettingsPanel()
Constructor.
Definition: KiwiApp_SettingsPanel.cpp:31
+
kiwi::SettingsPanel::SettingsPanel
SettingsPanel()
Constructor.
Definition: KiwiApp_SettingsPanel.cpp:33
kiwi::SettingsPanel
A Panel Component that shows application&#39;s settings.
Definition: KiwiApp_SettingsPanel.h:33
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___slider_view_8h_source.html b/docs/html/_kiwi_app___slider_view_8h_source.html new file mode 100644 index 00000000..fcc80d47 --- /dev/null +++ b/docs/html/_kiwi_app___slider_view_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_SliderView.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_SliderView.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <memory>
25 
26 #include <juce_gui_basics/juce_gui_basics.h>
27 
28 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h>
29 
30 namespace kiwi
31 {
32  // ================================================================================ //
33  // SLIDER VIEW //
34  // ================================================================================ //
35 
36  class SliderView : public ObjectView, juce::Slider::Listener
37  {
38  private: // classes
39 
40  class Task;
41 
42  public: // methods
43 
44  SliderView(model::Object & object_model);
45 
46  ~SliderView();
47 
48  static void declare();
49 
50  static std::unique_ptr<ObjectView> create(model::Object & object);
51 
52  private: // methods
53 
54  void sliderValueChanged(juce::Slider * slider) override final;
55 
56  void paint(juce::Graphics & g) override final;
57 
58  void mouseDown(juce::MouseEvent const& e) override final;
59 
60  void mouseUp(juce::MouseEvent const& e) override final;
61 
62  void mouseDrag(juce::MouseEvent const& e) override final;
63 
64  void resized() override final;
65 
66  void parameterChanged(std::string const& name, tool::Parameter const& parameter) override final;
67 
68  void valueChanged(double new_value);
69 
70  private: // members
71 
72  juce::Slider m_slider;
73  flip::Signal<> & m_output_value;
74 
75  private: // delted methods
76 
77  SliderView() = delete;
78  SliderView(SliderView const& other) = delete;
79  SliderView(SliderView && other) = delete;
80  SliderView& operator=(SliderView const& other) = delete;
81  SliderView& operator=(SliderView && other) = delete;
82  };
83 }
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::ObjectView
Abstract for objects graphical representation.
Definition: KiwiApp_ObjectView.h:42
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::SliderView
Definition: KiwiApp_SliderView.h:36
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___stored_settings_8h_source.html b/docs/html/_kiwi_app___stored_settings_8h_source.html index 135d5309..dcb3354b 100644 --- a/docs/html/_kiwi_app___stored_settings_8h_source.html +++ b/docs/html/_kiwi_app___stored_settings_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_General/KiwiApp_StoredSettings.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_StoredSettings.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_data_structures/juce_data_structures.h>
25 #include <KiwiEngine/KiwiEngine_Listeners.h>
26 
27 namespace kiwi
28 {
29  // ================================================================================ //
30  // NETWORK SETTINGS //
31  // ================================================================================ //
32 
33  class StoredSettings;
34 
35  class NetworkSettings : juce::ValueTree::Listener
36  {
37  public: // methods
38 
40  NetworkSettings();
41 
43  ~NetworkSettings();
44 
46  void resetToDefault();
47 
49  bool readFromXml(juce::XmlElement const& xml);
50 
52  std::string getHost() const;
53 
55  juce::Value getHostValue();
56 
58  uint16_t getApiPort() const;
59 
61  juce::Value getApiPortValue();
62 
64  uint16_t getSessionPort() const;
65 
67  juce::Value getSessionPortValue();
68 
70  uint16_t getRefreshInterval() const;
71 
73  juce::Value getRefreshIntervalValue();
74 
76  struct Listener
77  {
79  virtual ~Listener() = default;
80 
82  virtual void networkSettingsChanged(NetworkSettings const&, juce::Identifier const&) = 0;
83  };
84 
86  void addListener(Listener& listener);
87 
89  void removeListener(Listener& listener);
90 
91  private: // methods
92 
94  juce::ValueTree& use();
95 
96  void valueTreePropertyChanged(juce::ValueTree&, juce::Identifier const&) override;
97  void valueTreeChildAdded(juce::ValueTree&, juce::ValueTree&) override {}
98  void valueTreeChildRemoved(juce::ValueTree&, juce::ValueTree&, int) override {}
99  void valueTreeChildOrderChanged(juce::ValueTree&, int, int) override {}
100  void valueTreeParentChanged(juce::ValueTree&) override {}
101 
102  private: // variables
103 
104  juce::ValueTree m_settings;
105  engine::Listeners<Listener> m_listeners;
106 
107  friend StoredSettings;
108  };
109 
110  // ================================================================================ //
111  // STORED SETTINGS //
112  // ================================================================================ //
113 
115  class StoredSettings : public juce::ValueTree::Listener
116  {
117  public: // methods
118 
120  StoredSettings();
121 
123  ~StoredSettings();
124 
126  juce::PropertiesFile& getGlobalProperties();
127 
129  void flush();
130 
132  void reload();
133 
135  NetworkSettings& network();
136 
137  private: // methods
138 
139  void saveValueTree(juce::ValueTree const& vt, std::string const& key_name);
140  void changed();
141 
142  void valueTreePropertyChanged(juce::ValueTree&, const juce::Identifier&) override { changed(); }
143  void valueTreeChildAdded(juce::ValueTree&, juce::ValueTree&) override { changed(); }
144  void valueTreeChildRemoved(juce::ValueTree&, juce::ValueTree&, int) override { changed(); }
145  void valueTreeChildOrderChanged(juce::ValueTree&, int, int) override { changed(); }
146  void valueTreeParentChanged(juce::ValueTree&) override { changed(); }
147 
148  private: // members
149 
150  std::vector<std::unique_ptr<juce::PropertiesFile>> m_property_files;
151  NetworkSettings m_network;
152 
153  private: // deleted methods
154 
155  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(StoredSettings)
156  };
157 
158  StoredSettings& getAppSettings();
159  juce::PropertiesFile& getGlobalProperties();
160 };
kiwi::NetworkSettings::removeListener
void removeListener(Listener &listener)
remove a listener.
Definition: KiwiApp_StoredSettings.cpp:170
-
kiwi::NetworkSettings::Listener::networkSettingsChanged
virtual void networkSettingsChanged(NetworkSettings const &, juce::Identifier const &)=0
Called when a document session has been added.
-
kiwi::NetworkSettings::resetToDefault
void resetToDefault()
Reset to default settings values.
Definition: KiwiApp_StoredSettings.cpp:79
-
kiwi::NetworkSettings
Definition: KiwiApp_StoredSettings.h:35
-
kiwi::NetworkSettings::NetworkSettings
NetworkSettings()
Constructor.
Definition: KiwiApp_StoredSettings.cpp:68
-
kiwi::NetworkSettings::addListener
void addListener(Listener &listener)
Add a listener.
Definition: KiwiApp_StoredSettings.cpp:165
-
kiwi::NetworkSettings::getApiPortValue
juce::Value getApiPortValue()
Returns the api port as a juce::Value.
Definition: KiwiApp_StoredSettings.cpp:138
-
kiwi::NetworkSettings::readFromXml
bool readFromXml(juce::XmlElement const &xml)
Restore settings with an xml.
Definition: KiwiApp_StoredSettings.cpp:96
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_data_structures/juce_data_structures.h>
25 #include <KiwiTool/KiwiTool_Listeners.h>
26 #include <json.hpp>
27 
28 namespace kiwi
29 {
30  using nlohmann::json;
31 
32  // ================================================================================ //
33  // NETWORK SETTINGS //
34  // ================================================================================ //
35 
36  class StoredSettings;
37 
38  class NetworkSettings : juce::ValueTree::Listener
39  {
40  public: // methods
41 
43  NetworkSettings();
44 
46  ~NetworkSettings();
47 
49  void resetToDefault();
50 
52  void setServerAddress(std::string const& host, uint16_t api_port, uint16_t session_port);
53 
55  juce::ValueTree getServerAddress();
56 
58  void readFromXml(juce::XmlElement const& xml);
59 
61  std::string getHost() const;
62 
64  uint16_t getApiPort() const;
65 
67  uint16_t getSessionPort() const;
68 
70  uint16_t getRefreshInterval() const;
71 
72  void setRememberUserFlag(bool remember_me);
73 
74  bool getRememberUserFlag() const;
75 
77  struct Listener
78  {
80  virtual ~Listener() = default;
81 
83  virtual void networkSettingsChanged(NetworkSettings const&, juce::Identifier const&) = 0;
84  };
85 
87  void addListener(Listener& listener);
88 
90  void removeListener(Listener& listener);
91 
92  private: // methods
93 
95  juce::ValueTree& use();
96 
97  void valueTreePropertyChanged(juce::ValueTree&, juce::Identifier const&) override;
98  void valueTreeChildAdded(juce::ValueTree& parent, juce::ValueTree& child) override;
99  void valueTreeChildRemoved(juce::ValueTree&, juce::ValueTree&, int) override {}
100  void valueTreeChildOrderChanged(juce::ValueTree&, int, int) override {}
101  void valueTreeParentChanged(juce::ValueTree&) override {}
102 
103  private: // variables
104 
105  juce::ValueTree m_settings;
106  tool::Listeners<Listener> m_listeners;
107 
108  friend StoredSettings;
109  };
110 
111  // ================================================================================ //
112  // STORED SETTINGS //
113  // ================================================================================ //
114 
116  class StoredSettings : public juce::ValueTree::Listener
117  {
118  public: // methods
119 
121  StoredSettings();
122 
124  ~StoredSettings();
125 
127  juce::PropertiesFile& getGlobalProperties();
128 
130  void flush();
131 
133  void reload();
134 
136  NetworkSettings& network();
137 
138  private: // methods
139 
140  void saveValueTree(juce::ValueTree const& vt, std::string const& key_name);
141  void changed();
142 
143  void valueTreePropertyChanged(juce::ValueTree&, const juce::Identifier&) override { changed(); }
144  void valueTreeChildAdded(juce::ValueTree&, juce::ValueTree&) override { changed(); }
145  void valueTreeChildRemoved(juce::ValueTree&, juce::ValueTree&, int) override { changed(); }
146  void valueTreeChildOrderChanged(juce::ValueTree&, int, int) override { changed(); }
147  void valueTreeParentChanged(juce::ValueTree&) override { changed(); }
148 
149  private: // members
150 
151  std::vector<std::unique_ptr<juce::PropertiesFile>> m_property_files;
152  NetworkSettings m_network;
153 
154  private: // deleted methods
155 
156  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(StoredSettings)
157  };
158 
159  StoredSettings& getAppSettings();
160  juce::PropertiesFile& getGlobalProperties();
161  juce::PropertiesFile::Options getPropertyFileOptionsFor(juce::String const& filename,
162  juce::String const& suffix = "settings");
163 
164  bool saveJsonToFile(juce::String const& filename, json const& j);
165  json getJsonFromFile(juce::String const& filename);
166 };
kiwi::NetworkSettings::removeListener
void removeListener(Listener &listener)
remove a listener.
Definition: KiwiApp_StoredSettings.cpp:222
+
kiwi::NetworkSettings::Listener::networkSettingsChanged
virtual void networkSettingsChanged(NetworkSettings const &, juce::Identifier const &)=0
Called when the network settings has changed.
+
kiwi::remember_me
Toggle the "remember me" option to save user profile.
Definition: KiwiApp_CommandIDs.h:95
+
kiwi::NetworkSettings::resetToDefault
void resetToDefault()
Reset to default settings values.
Definition: KiwiApp_StoredSettings.cpp:117
+
kiwi::NetworkSettings
Definition: KiwiApp_StoredSettings.h:38
+
kiwi::NetworkSettings::NetworkSettings
NetworkSettings()
Constructor.
Definition: KiwiApp_StoredSettings.cpp:106
+
kiwi::NetworkSettings::addListener
void addListener(Listener &listener)
Add a listener.
Definition: KiwiApp_StoredSettings.cpp:217
+
kiwi::NetworkSettings::setServerAddress
void setServerAddress(std::string const &host, uint16_t api_port, uint16_t session_port)
Sets the server adress.
Definition: KiwiApp_StoredSettings.cpp:151
kiwi::NetworkSettings::Listener::~Listener
virtual ~Listener()=default
Destructor.
-
kiwi::NetworkSettings::getRefreshIntervalValue
juce::Value getRefreshIntervalValue()
Returns the session port as a juce::Value.
Definition: KiwiApp_StoredSettings.cpp:160
+
kiwi::NetworkSettings::getHost
std::string getHost() const
Returns the Host as a string.
Definition: KiwiApp_StoredSettings.cpp:190
+
kiwi::NetworkSettings::readFromXml
void readFromXml(juce::XmlElement const &xml)
Restore settings with an xml.
Definition: KiwiApp_StoredSettings.cpp:162
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::NetworkSettings::~NetworkSettings
~NetworkSettings()
Destructor.
Definition: KiwiApp_StoredSettings.cpp:74
-
kiwi::NetworkSettings::getHostValue
juce::Value getHostValue()
Returns the Host as a juce::Value.
Definition: KiwiApp_StoredSettings.cpp:127
-
kiwi::engine::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiEngine_Listeners.h:40
-
kiwi::StoredSettings
Settings storage class utility.
Definition: KiwiApp_StoredSettings.h:115
-
kiwi::NetworkSettings::getRefreshInterval
uint16_t getRefreshInterval() const
Returns the session port as an integer.
Definition: KiwiApp_StoredSettings.cpp:154
-
kiwi::NetworkSettings::getHost
std::string getHost() const
Returns the Host as a string.
Definition: KiwiApp_StoredSettings.cpp:122
-
kiwi::NetworkSettings::Listener
NetworkSettings Listener.
Definition: KiwiApp_StoredSettings.h:76
-
kiwi::NetworkSettings::getSessionPort
uint16_t getSessionPort() const
Returns the session port as an integer.
Definition: KiwiApp_StoredSettings.cpp:143
-
kiwi::NetworkSettings::getSessionPortValue
juce::Value getSessionPortValue()
Returns the session port as a juce::Value.
Definition: KiwiApp_StoredSettings.cpp:149
-
kiwi::NetworkSettings::getApiPort
uint16_t getApiPort() const
Returns the api port as an integer.
Definition: KiwiApp_StoredSettings.cpp:132
+
kiwi::tool::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiTool_Listeners.h:38
+
kiwi::NetworkSettings::~NetworkSettings
~NetworkSettings()
Destructor.
Definition: KiwiApp_StoredSettings.cpp:112
+
kiwi::NetworkSettings::getRefreshInterval
uint16_t getRefreshInterval() const
Returns the session port as an integer.
+
kiwi::NetworkSettings::getServerAddress
juce::ValueTree getServerAddress()
Retrieves a copy of the server adress info.
Definition: KiwiApp_StoredSettings.cpp:146
+
kiwi::StoredSettings
Settings storage class utility.
Definition: KiwiApp_StoredSettings.h:116
+
kiwi::NetworkSettings::getApiPort
uint16_t getApiPort() const
Returns the api port as an integer.
Definition: KiwiApp_StoredSettings.cpp:195
+
kiwi::NetworkSettings::getSessionPort
uint16_t getSessionPort() const
Returns the session port as an integer.
Definition: KiwiApp_StoredSettings.cpp:201
+
kiwi::NetworkSettings::Listener
NetworkSettings Listener.
Definition: KiwiApp_StoredSettings.h:77
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___suggest_editor_8h_source.html b/docs/html/_kiwi_app___suggest_editor_8h_source.html index 5d490baf..3691bd39 100644 --- a/docs/html/_kiwi_app___suggest_editor_8h_source.html +++ b/docs/html/_kiwi_app___suggest_editor_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Components/KiwiApp_SuggestEditor.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_SuggestEditor.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Listeners.h>
25 
26 #include <juce_gui_basics/juce_gui_basics.h>
27 
28 #include "../KiwiApp_Utils/KiwiApp_SuggestList.h"
29 
30 namespace kiwi
31 {
32  // ================================================================================ //
33  // SUGGEST EDITOR //
34  // ================================================================================ //
35 
38  class SuggestEditor
39  : public juce::TextEditor,
40  public juce::TextEditor::Listener,
41  public juce::Timer
42  {
43  public: // classes
44 
45  struct Listener;
46 
47  public: // methods
48 
51  SuggestEditor(SuggestList::entries_t entries);
52 
54  ~SuggestEditor();
55 
57  void addListener(SuggestEditor::Listener& listener);
58 
60  void removeListener(SuggestEditor::Listener& listener);
61 
63  void showMenu();
64 
66  bool isMenuOpened() const noexcept;
67 
69  void closeMenu();
70 
72  void textEditorTextChanged(juce::TextEditor& ed) override;
73 
75  void returnPressed() override;
76 
78  void escapePressed() override;
79 
81  void focusLost(juce::Component::FocusChangeType focus_change) override;
82 
84  bool keyPressed(juce::KeyPress const& key) override;
85 
86  private: // methods
87 
91  void timerCallback() override;
92 
94  void menuSelectionChanged(juce::String const& text);
95 
97  void menuItemClicked(juce::String const& text);
98 
100  void menuItemDoubleClicked(juce::String const& text);
101 
102  private: // classes
103 
104  class Menu;
105 
106  private: // members
107 
108  SuggestList m_suggest_list;
109  std::unique_ptr<Menu> m_menu = nullptr;
110  juce::String m_typed_text;
111  engine::Listeners<Listener> m_listeners;
112 
113  bool m_need_complete = true;
114  };
115 
116  // ================================================================================ //
117  // SUGGEST EDITOR LISTENER //
118  // ================================================================================ //
119 
122  struct SuggestEditor::Listener
123  {
125  virtual ~Listener() {}
126 
128  virtual void suggestEditorTextChanged(SuggestEditor& editor) {}
129 
131  virtual void suggestEditorReturnKeyPressed(SuggestEditor& editor) {}
132 
134  virtual void suggestEditorEscapeKeyPressed(SuggestEditor& editor) {}
135 
137  virtual void suggestEditorFocusLost(SuggestEditor& editor) {}
138  };
139 
140  // ================================================================================ //
141  // MENU //
142  // ================================================================================ //
143 
145  class SuggestEditor::Menu : public juce::Component, public juce::ListBoxModel
146  {
147  public: // methods
148 
149  using action_method_t = std::function<void(juce::String)>;
150 
152  Menu(SuggestList& list);
153 
155  ~Menu();
156 
158  void setItemClickedAction(action_method_t function);
159 
161  void setItemDoubleClickedAction(action_method_t function);
162 
164  void setSelectedItemAction(action_method_t function);
165 
167  void selectRow(int idx);
168 
170  void selectFirstRow();
171 
173  void selectPreviousRow();
174 
176  void selectNextRow();
177 
179  void update();
180 
181  // juce::Component
182  void paint(juce::Graphics& g) override;
183 
184  // juce::Component
185  void resized() override;
186 
187  private: // methods
188 
189  // ================================================================================ //
190  // SUGGEST LISTBOX MODEL //
191  // ================================================================================ //
192 
194  int getNumRows() override;
195 
197  void paintListBoxItem(int row_number, juce::Graphics& g,
198  int width, int height, bool selected) override;
199 
201  void listBoxItemClicked(int row, juce::MouseEvent const& e) override;
202 
204  void listBoxItemDoubleClicked(int row, juce::MouseEvent const& e) override;
205 
207  void selectedRowsChanged(int last_row_selected) override;
208 
209  private: // members
210 
211  SuggestList& m_suggest_list;
212  juce::ListBox m_suggest_list_box;
213  juce::ResizableCornerComponent m_resizable_corner;
214  juce::ComponentBoundsConstrainer m_constrainer;
215 
216  action_method_t m_clicked_action;
217  action_method_t m_double_clicked_action;
218  action_method_t m_selected_action;
219  };
220 }
kiwi::SuggestEditor::Listener
Receives callbacks from a SuggestEditor component.
Definition: KiwiApp_SuggestEditor.h:122
-
kiwi::SuggestEditor::addListener
void addListener(SuggestEditor::Listener &listener)
Adds a SuggestEditor::Listener.
Definition: KiwiApp_SuggestEditor.cpp:206
-
kiwi::SuggestEditor::keyPressed
bool keyPressed(juce::KeyPress const &key) override
juce::TextEditor.
Definition: KiwiApp_SuggestEditor.cpp:358
-
kiwi::SuggestEditor::focusLost
void focusLost(juce::Component::FocusChangeType focus_change) override
Called when the text editor loses focus.
Definition: KiwiApp_SuggestEditor.cpp:300
-
kiwi::SuggestEditor::Listener::suggestEditorTextChanged
virtual void suggestEditorTextChanged(SuggestEditor &editor)
Called when the user changes the text in some way.
Definition: KiwiApp_SuggestEditor.h:128
-
kiwi::SuggestEditor::~SuggestEditor
~SuggestEditor()
Destructor.
Definition: KiwiApp_SuggestEditor.cpp:201
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Listeners.h>
25 
26 #include <juce_core/juce_core.h>
27 #include <juce_gui_basics/juce_gui_basics.h>
28 
29 #include <KiwiApp_Utils/KiwiApp_SuggestList.h>
30 
31 namespace kiwi
32 {
33  // ================================================================================ //
34  // SUGGEST EDITOR //
35  // ================================================================================ //
36 
39  class SuggestEditor
40  : public juce::TextEditor,
41  public juce::TextEditor::Listener
42  {
43  public: // methods
44 
47  SuggestEditor(SuggestList::entries_t entries);
48 
50  ~SuggestEditor();
51 
52  private: // methods
53 
55  void showMenu();
56 
58  bool isMenuOpened() const noexcept;
59 
61  void closeMenu();
62 
64  bool keyPressed(juce::KeyPress const& key) override;
65 
67  bool keyStateChanged(bool isKeyDown) override;
68 
70  void textEditorTextChanged(juce::TextEditor& ed) override;
71 
74  void textEditorFocusLost(juce::TextEditor & editor) override;
75 
77  void menuItemSelected(juce::String const& text);
78 
80  void menuItemValidated(juce::String const& text);
81 
84  void menuItemUnselected();
85 
87  void disableUpdate();
88 
90  void enableUpdate();
91 
92  private: // classes
93 
94  class Menu;
95 
96  private: // members
97 
98  SuggestList m_suggest_list;
99  juce::StringArray m_split_text;
100  std::unique_ptr<Menu> m_menu = nullptr;
101  bool m_update_enabled;
102  };
103 
104  // ================================================================================ //
105  // MENU //
106  // ================================================================================ //
107 
109  class SuggestEditor::Menu : public juce::Component, public juce::ListBoxModel
110  {
111  public: // methods
112 
113  using action_method_t = std::function<void(juce::String)>;
114 
116  Menu(SuggestList& list, SuggestEditor & creator);
117 
119  ~Menu();
120 
122  void setItemValidatedAction(action_method_t function);
123 
125  void setSelectedItemAction(action_method_t function);
126 
128  void setUnselectedItemAction(std::function<void(void)> function);
129 
131  void unselectRow();
132 
134  void selectRow(int idx);
135 
137  void selectFirstRow();
138 
140  void selectPreviousRow();
141 
143  void selectNextRow();
144 
146  void validateSelectedRow();
147 
149  void update();
150 
151  // juce::Component
152  void paint(juce::Graphics& g) override;
153 
154  // juce::Component
155  void resized() override;
156 
158  int getSelectedRow() const;
159 
160  private: // methods
161 
164  bool canModalEventBeSentToComponent(juce::Component const* target_component) override final;
165 
169  void inputAttemptWhenModal() override final;
170 
171  // ================================================================================ //
172  // SUGGEST LISTBOX MODEL //
173  // ================================================================================ //
174 
176  int getNumRows() override;
177 
179  void paintListBoxItem(int row_number, juce::Graphics& g,
180  int width, int height, bool selected) override;
181 
183  void listBoxItemClicked(int row, juce::MouseEvent const& e) override;
184 
186  void listBoxItemDoubleClicked(int row, juce::MouseEvent const& e) override;
187 
189  void selectedRowsChanged(int last_row_selected) override;
190 
191  private: // members
192 
193  SuggestList& m_suggest_list;
194  juce::ListBox m_suggest_list_box;
195  SuggestEditor & m_creator;
196  juce::ComponentBoundsConstrainer m_constrainer;
197  juce::ResizableCornerComponent m_resizable_corner;
198 
199  action_method_t m_validated_action;
200  action_method_t m_selected_action;
201  std::function<void(void)> m_unselected_action;
202  };
203 }
kiwi::SuggestEditor::~SuggestEditor
~SuggestEditor()
Destructor.
Definition: KiwiApp_SuggestEditor.cpp:252
kiwi::SuggestList
A string container that provide suggestion list based on given patterns.
Definition: KiwiApp_SuggestList.h:37
-
kiwi::SuggestEditor::closeMenu
void closeMenu()
Close the menu.
Definition: KiwiApp_SuggestEditor.cpp:243
-
kiwi::SuggestEditor::escapePressed
void escapePressed() override
Called when the user presses the escape key.
Definition: KiwiApp_SuggestEditor.cpp:295
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::SuggestEditor::Menu
Suggestion menu.
Definition: KiwiApp_SuggestEditor.h:145
-
kiwi::SuggestEditor::SuggestEditor
SuggestEditor(SuggestList::entries_t entries)
Constructor.
Definition: KiwiApp_SuggestEditor.cpp:191
-
kiwi::SuggestEditor::Listener::~Listener
virtual ~Listener()
Destructor.
Definition: KiwiApp_SuggestEditor.h:125
-
kiwi::engine::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiEngine_Listeners.h:40
-
kiwi::SuggestEditor::isMenuOpened
bool isMenuOpened() const noexcept
Returns true if the menu is currently opened.
Definition: KiwiApp_SuggestEditor.cpp:238
-
kiwi::SuggestEditor::textEditorTextChanged
void textEditorTextChanged(juce::TextEditor &ed) override
juce::TextEditor::Listener
Definition: KiwiApp_SuggestEditor.cpp:252
-
kiwi::SuggestEditor
A text editor with auto-completion.
Definition: KiwiApp_SuggestEditor.h:38
-
kiwi::SuggestEditor::returnPressed
void returnPressed() override
Called when the user presses the return key.
Definition: KiwiApp_SuggestEditor.cpp:289
-
kiwi::SuggestEditor::Listener::suggestEditorEscapeKeyPressed
virtual void suggestEditorEscapeKeyPressed(SuggestEditor &editor)
Called when the user presses the escape key.
Definition: KiwiApp_SuggestEditor.h:134
-
kiwi::SuggestEditor::removeListener
void removeListener(SuggestEditor::Listener &listener)
Removes a SuggestEditor::Listener.
Definition: KiwiApp_SuggestEditor.cpp:211
-
kiwi::SuggestEditor::Listener::suggestEditorReturnKeyPressed
virtual void suggestEditorReturnKeyPressed(SuggestEditor &editor)
Called when the user presses the return key.
Definition: KiwiApp_SuggestEditor.h:131
-
kiwi::SuggestEditor::Listener::suggestEditorFocusLost
virtual void suggestEditorFocusLost(SuggestEditor &editor)
Called when the text editor loses focus.
Definition: KiwiApp_SuggestEditor.h:137
-
kiwi::SuggestEditor::showMenu
void showMenu()
Shows the menu.
Definition: KiwiApp_SuggestEditor.cpp:216
+
kiwi::SuggestEditor::Menu
Suggestion menu.
Definition: KiwiApp_SuggestEditor.h:109
+
kiwi::SuggestEditor::SuggestEditor
SuggestEditor(SuggestList::entries_t entries)
Constructor.
Definition: KiwiApp_SuggestEditor.cpp:239
+
kiwi::SuggestEditor
A text editor with auto-completion.
Definition: KiwiApp_SuggestEditor.h:39
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___suggest_list_8h_source.html b/docs/html/_kiwi_app___suggest_list_8h_source.html index b9aaba7b..27271e93 100644 --- a/docs/html/_kiwi_app___suggest_list_8h_source.html +++ b/docs/html/_kiwi_app___suggest_list_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Utils/KiwiApp_SuggestList.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiApp_SuggestList.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <string>
25 #include <algorithm>
26 #include <cctype> // ::tolower, ::toupper
27 #include <vector>
28 
29 namespace kiwi
30 {
31  // ================================================================================ //
32  // SUGGEST LIST //
33  // ================================================================================ //
34 
37  class SuggestList
38  {
39  public: // methods
40 
41  using entries_t = std::vector<std::string>;
42 
44  SuggestList() = default;
45 
47  SuggestList(entries_t entries) :
48  m_options(),
49  m_entries(entries.begin(), entries.end()),
50  m_last_filter_pattern(""),
51  m_need_update(true)
52  {
53  updateFilteredEntries();
54  }
55 
57  ~SuggestList() = default;
58 
60  struct Options
61  {
62  // Score bonuses
63  int adjacency_bonus = 5;
64 
65  // Score penalties
66  int leading_letter_penalty = -9;
67  int max_leading_letter_penalty = -9;
68  int unmatched_letter_penalty = -1;
69  };
70 
71  // iterators
72  using iterator = entries_t::iterator;
73  using const_iterator = entries_t::const_iterator;
74 
75  iterator begin() { return m_filtered_entries.begin(); }
76  iterator end() { return m_filtered_entries.end(); }
77  const_iterator begin() const { return m_filtered_entries.cbegin(); }
78  const_iterator end() const { return m_filtered_entries.cend(); }
79 
81  void setOptions(Options options) { m_options = options; }
82 
86  void addEntry(std::string const& entry)
87  {
88  m_entries.emplace_back(entry);
89  updateFilteredEntries();
90  }
91 
95  void addEntries(std::vector<std::string> const& entries)
96  {
97  m_entries.insert(m_entries.end(), entries.begin(), entries.end());
98  updateFilteredEntries();
99  }
100 
102  entries_t::size_type size() const noexcept { return m_filtered_entries.size(); }
103 
105  bool empty() const noexcept { return m_filtered_entries.empty(); }
106 
108  void clear() { m_entries.clear(); m_filtered_entries.clear(); }
109 
111  std::string const& getCurrentFilter() const { return m_last_filter_pattern; }
112 
114  void applyFilter(std::string const& pattern)
115  {
116  if(m_need_update || (m_last_filter_pattern != pattern))
117  {
118  m_last_filter_pattern = pattern;
119  if(m_last_filter_pattern == "")
120  {
121  m_filtered_entries = m_entries;
122  return;
123  }
124 
125  char const* pattern_cstr = m_last_filter_pattern.c_str();
126 
127  struct ScoredEntry
128  {
129  ScoredEntry(std::string const& _str, int _score) : string(_str), score(_score) {}
130  bool operator<(ScoredEntry const& entry) const { return (score >= entry.score); }
131 
132  std::string string = "";
133  int score = 0;
134  };
135 
136  std::set<ScoredEntry> scored_entries;
137 
138  for(auto const& str : m_entries)
139  {
140  const auto r = computeScore(pattern_cstr, str.c_str(), m_options);
141  if(r.first)
142  {
143  scored_entries.insert({str, r.second});
144  }
145  }
146 
147  m_filtered_entries.clear();
148 
149  for(auto const& scored_entry : scored_entries)
150  {
151  m_filtered_entries.emplace_back(std::move(scored_entry.string));
152  }
153 
154  m_need_update = false;
155  }
156  }
157 
158  private: // methods
159 
166  static std::pair<bool, int> computeScore(char const* pattern, char const* str,
167  Options const& options)
168  {
169  int score = 0;
170  char const* pattern_iter = pattern;
171  char const* str_iter = str;
172  bool prev_matched = false;
173 
174  // Use "best" matched letter if multiple string letters match the pattern
175  char const* best_letter = nullptr;
176  int best_letter_score = 0;
177 
178  // Loop over chars
179  while(*str_iter != end_char)
180  {
181  const char pattern_letter = *pattern_iter;
182  const char str_letter = *str_iter;
183  const char pattern_letter_lower = std::tolower(pattern_letter);
184  const char str_letter_lower = std::tolower(str_letter);
185 
186  const bool pattern_valid_char = (pattern_letter != end_char);
187  const bool next_match = pattern_valid_char && (pattern_letter_lower == str_letter_lower);
188  const bool rematch = best_letter && (std::tolower(*best_letter) == str_letter_lower);
189  const bool advanced = (next_match && best_letter);
190  const bool pattern_repeat = best_letter && pattern_valid_char && (std::tolower(*best_letter) == pattern_letter_lower);
191 
192  if(advanced || pattern_repeat)
193  {
194  score += best_letter_score;
195  best_letter = nullptr;
196  best_letter_score = 0;
197  }
198 
199  if(next_match || rematch)
200  {
201  int new_score = 0;
202 
203  // Apply penalty for each letter before the first pattern match
204  if(pattern_iter == pattern)
205  {
206  const int count = static_cast<int>(str_iter - str);
207  int penalty = options.leading_letter_penalty * count;
208  if(penalty < options.max_leading_letter_penalty)
209  penalty = options.max_leading_letter_penalty;
210 
211  score += penalty;
212  }
213 
214  // Apply bonus for consecutive bonuses
215  if (prev_matched)
216  new_score += options.adjacency_bonus;
217 
218  // Update pattern iter if the next pattern letter was matched
219  if (next_match)
220  ++pattern_iter;
221 
222  // Update best letter in str which may be for a "next" letter or a rematch
223  if (new_score >= best_letter_score)
224  {
225  // Apply penalty for now skipped letter
226  if (best_letter != nullptr)
227  score += options.unmatched_letter_penalty;
228 
229  best_letter = str_iter;
230  best_letter_score = new_score;
231  }
232 
233  prev_matched = true;
234  }
235  else
236  {
237  score += options.unmatched_letter_penalty;
238  prev_matched = false;
239  }
240 
241  ++str_iter;
242  }
243 
244  // Apply score for last match
245  if(best_letter)
246  {
247  score += best_letter_score;
248  }
249 
250  // Did not match full pattern
251  if(*pattern_iter != end_char)
252  {
253  return {false, 0};
254  }
255 
256  return {true, score};
257  }
258 
259  void updateFilteredEntries()
260  {
261  m_need_update = true;
262  applyFilter(m_last_filter_pattern);
263  }
264 
265  private: // members
266 
267  static constexpr char end_char = '\0';
268 
269  Options m_options = {};
270  entries_t m_entries = {};
271  entries_t m_filtered_entries = {};
272  std::string m_last_filter_pattern = "";
273  bool m_need_update = true;
274  };
275 }
kiwi::SuggestList::~SuggestList
~SuggestList()=default
Destructor.
-
kiwi::SuggestList::size
entries_t::size_type size() const noexcept
Returns the size of the current filtered selection.
Definition: KiwiApp_SuggestList.h:102
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <string>
25 #include <algorithm>
26 #include <cctype> // ::tolower, ::toupper
27 #include <vector>
28 
29 namespace kiwi
30 {
31  // ================================================================================ //
32  // SUGGEST LIST //
33  // ================================================================================ //
34 
37  class SuggestList
38  {
39  public: // methods
40 
41  using entries_t = std::vector<std::string>;
42 
44  SuggestList() = default;
45 
47  SuggestList(entries_t entries) :
48  m_options(),
49  m_entries(entries.begin(), entries.end()),
50  m_last_filter_pattern(""),
51  m_need_update(true)
52  {
53  updateFilteredEntries();
54  }
55 
57  ~SuggestList() = default;
58 
60  struct Options
61  {
62  // Score bonuses
63  int adjacency_bonus = 5;
64 
65  // Score penalties
66  int leading_letter_penalty = -9;
67  int max_leading_letter_penalty = -9;
68  int unmatched_letter_penalty = -1;
69  };
70 
71  // iterators
72  using iterator = entries_t::iterator;
73  using const_iterator = entries_t::const_iterator;
74 
75  iterator begin() { return m_filtered_entries.begin(); }
76  iterator end() { return m_filtered_entries.end(); }
77  const_iterator begin() const { return m_filtered_entries.cbegin(); }
78  const_iterator end() const { return m_filtered_entries.cend(); }
79 
81  void setOptions(Options options) { m_options = options; }
82 
86  void addEntry(std::string const& entry)
87  {
88  m_entries.emplace_back(entry);
89  updateFilteredEntries();
90  }
91 
95  void addEntries(std::vector<std::string> const& entries)
96  {
97  m_entries.insert(m_entries.end(), entries.begin(), entries.end());
98  updateFilteredEntries();
99  }
100 
102  entries_t::size_type size() const noexcept { return m_filtered_entries.size(); }
103 
105  bool empty() const noexcept { return m_filtered_entries.empty(); }
106 
108  void clear() { m_entries.clear(); m_filtered_entries.clear(); }
109 
111  std::string const& getCurrentFilter() const { return m_last_filter_pattern; }
112 
114  void applyFilter(std::string const& pattern)
115  {
116  if(m_need_update || (m_last_filter_pattern != pattern))
117  {
118  m_last_filter_pattern = pattern;
119  if(m_last_filter_pattern == "")
120  {
121  m_filtered_entries = m_entries;
122  return;
123  }
124 
125  char const* pattern_cstr = m_last_filter_pattern.c_str();
126 
127  struct ScoredEntry
128  {
129  ScoredEntry(std::string const& _str, int _score) : string(_str), score(_score) {}
130  bool operator<(ScoredEntry const& entry) const { return (score >= entry.score); }
131 
132  std::string string = "";
133  int score = 0;
134  };
135 
136  std::set<ScoredEntry> scored_entries;
137 
138  for(auto const& str : m_entries)
139  {
140  const auto r = computeScore(pattern_cstr, str.c_str(), m_options);
141  if(r.first)
142  {
143  scored_entries.insert({str, r.second});
144  }
145  }
146 
147  m_filtered_entries.clear();
148 
149  for(auto const& scored_entry : scored_entries)
150  {
151  m_filtered_entries.emplace_back(std::move(scored_entry.string));
152  }
153 
154  m_need_update = false;
155  }
156  }
157 
158  private: // methods
159 
166  static std::pair<bool, int> computeScore(char const* pattern, char const* str,
167  Options const& options)
168  {
169  int score = 0;
170  char const* pattern_iter = pattern;
171  char const* str_iter = str;
172  bool prev_matched = false;
173 
174  // Use "best" matched letter if multiple string letters match the pattern
175  char const* best_letter = nullptr;
176  int best_letter_score = 0;
177 
178  // Loop over chars
179  while(*str_iter != end_char)
180  {
181  const char pattern_letter = *pattern_iter;
182  const char str_letter = *str_iter;
183  const char pattern_letter_lower = std::tolower(pattern_letter);
184  const char str_letter_lower = std::tolower(str_letter);
185 
186  const bool pattern_valid_char = (pattern_letter != end_char);
187  const bool next_match = pattern_valid_char && (pattern_letter_lower == str_letter_lower);
188  const bool rematch = best_letter && (std::tolower(*best_letter) == str_letter_lower);
189  const bool advanced = (next_match && best_letter);
190  const bool pattern_repeat = best_letter && pattern_valid_char && (std::tolower(*best_letter) == pattern_letter_lower);
191 
192  if(advanced || pattern_repeat)
193  {
194  score += best_letter_score;
195  best_letter = nullptr;
196  best_letter_score = 0;
197  }
198 
199  if(next_match || rematch)
200  {
201  int new_score = 0;
202 
203  // Apply penalty for each letter before the first pattern match
204  if(pattern_iter == pattern)
205  {
206  const int count = static_cast<int>(str_iter - str);
207  int penalty = options.leading_letter_penalty * count;
208  if(penalty < options.max_leading_letter_penalty)
209  penalty = options.max_leading_letter_penalty;
210 
211  score += penalty;
212  }
213 
214  // Apply bonus for consecutive bonuses
215  if (prev_matched)
216  new_score += options.adjacency_bonus;
217 
218  // Update pattern iter if the next pattern letter was matched
219  if (next_match)
220  ++pattern_iter;
221 
222  // Update best letter in str which may be for a "next" letter or a rematch
223  if (new_score >= best_letter_score)
224  {
225  // Apply penalty for now skipped letter
226  if (best_letter != nullptr)
227  score += options.unmatched_letter_penalty;
228 
229  best_letter = str_iter;
230  best_letter_score = new_score;
231  }
232 
233  prev_matched = true;
234  }
235  else
236  {
237  score += options.unmatched_letter_penalty;
238  prev_matched = false;
239  }
240 
241  ++str_iter;
242  }
243 
244  // Apply score for last match
245  if(best_letter)
246  {
247  score += best_letter_score;
248  }
249 
250  // Did not match full pattern
251  if(*pattern_iter != end_char)
252  {
253  return {false, 0};
254  }
255 
256  return {true, score};
257  }
258 
259  void updateFilteredEntries()
260  {
261  m_need_update = true;
262  applyFilter(m_last_filter_pattern);
263  }
264 
265  private: // members
266 
267  static constexpr char end_char = '\0';
268 
269  Options m_options = {};
270  entries_t m_entries = {};
271  entries_t m_filtered_entries = {};
272  std::string m_last_filter_pattern = "";
273  bool m_need_update = true;
274  };
275 }
kiwi::SuggestList::~SuggestList
~SuggestList()=default
Destructor.
kiwi::SuggestList::addEntry
void addEntry(std::string const &entry)
Add a suggestion entry to the list.
Definition: KiwiApp_SuggestList.h:86
+
kiwi::SuggestList::getCurrentFilter
std::string const & getCurrentFilter() const
Returns the current filter pattern applied to the list.
Definition: KiwiApp_SuggestList.h:111
kiwi::SuggestList::setOptions
void setOptions(Options options)
Set the sorting options.
Definition: KiwiApp_SuggestList.h:81
kiwi::SuggestList::Options::unmatched_letter_penalty
int unmatched_letter_penalty
Maximum penalty for leading letters.
Definition: KiwiApp_SuggestList.h:68
kiwi::SuggestList::applyFilter
void applyFilter(std::string const &pattern)
Apply a pattern matching filter to the entries.
Definition: KiwiApp_SuggestList.h:114
kiwi::SuggestList
A string container that provide suggestion list based on given patterns.
Definition: KiwiApp_SuggestList.h:37
kiwi::SuggestList::SuggestList
SuggestList(entries_t entries)
Constructor.
Definition: KiwiApp_SuggestList.h:47
-
kiwi::SuggestList::getCurrentFilter
std::string const & getCurrentFilter() const
Returns the current filter pattern applied to the list.
Definition: KiwiApp_SuggestList.h:111
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::SuggestList::Options::max_leading_letter_penalty
int max_leading_letter_penalty
For every letter in str before the first match.
Definition: KiwiApp_SuggestList.h:67
kiwi::SuggestList::Options
Score bonuses and penalties to sort entries.
Definition: KiwiApp_SuggestList.h:60
kiwi::SuggestList::SuggestList
SuggestList()=default
Constructor.
kiwi::SuggestList::Options::leading_letter_penalty
int leading_letter_penalty
For adjacent matches.
Definition: KiwiApp_SuggestList.h:66
-
kiwi::SuggestList::empty
bool empty() const noexcept
Returns true if there is no suggestion entry.
Definition: KiwiApp_SuggestList.h:105
+
kiwi::SuggestList::size
entries_t::size_type size() const noexcept
Returns the size of the current filtered selection.
Definition: KiwiApp_SuggestList.h:102
kiwi::SuggestList::clear
void clear()
Clear all entries.
Definition: KiwiApp_SuggestList.h:108
+
kiwi::SuggestList::empty
bool empty() const noexcept
Returns true if there is no suggestion entry.
Definition: KiwiApp_SuggestList.h:105
kiwi::SuggestList::addEntries
void addEntries(std::vector< std::string > const &entries)
Add suggestion entries to the list.
Definition: KiwiApp_SuggestList.h:95
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_app___toggle_view_8h_source.html b/docs/html/_kiwi_app___toggle_view_8h_source.html new file mode 100644 index 00000000..da2b0284 --- /dev/null +++ b/docs/html/_kiwi_app___toggle_view_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ToggleView.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiApp_ToggleView.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h>
25 
26 namespace kiwi {
27 
28  // ================================================================================ //
29  // TOGGLE VIEW //
30  // ================================================================================ //
31 
32  class ToggleView : public ObjectView
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<ObjectView> create(model::Object & model);
39 
40  ToggleView(model::Object & object_model);
41 
42  ~ToggleView();
43 
44  private: // methods
45 
46  void paint(juce::Graphics & g) override final;
47 
48  void mouseDown(juce::MouseEvent const& e) override final;
49 
50  void parameterChanged(std::string const& name, tool::Parameter const& param) override final;
51 
52  private: // members
53 
54  flip::Signal<> & m_signal;
55  bool m_is_on;
56 
57  private: // deleted methods
58 
59  ToggleView() = delete;
60  ToggleView(ToggleView const& other) = delete;
61  ToggleView(ToggleView && other) = delete;
62  ToggleView& operator=(ToggleView const& other) = delete;
63  ToggleView& operator=(ToggleView && other) = delete;
64  };
65 }
kiwi::ToggleView
Definition: KiwiApp_ToggleView.h:32
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::ObjectView
Abstract for objects graphical representation.
Definition: KiwiApp_ObjectView.h:42
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_app___tooltip_window_8h_source.html b/docs/html/_kiwi_app___tooltip_window_8h_source.html index b9b1b098..4b80f7d6 100644 --- a/docs/html/_kiwi_app___tooltip_window_8h_source.html +++ b/docs/html/_kiwi_app___tooltip_window_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Components/KiwiApp_TooltipWindow.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + + - + - - - - + +
KiwiApp_Window.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_basics/juce_gui_basics.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // WINDOW //
30  // ================================================================================ //
31 
33  class Window : public juce::DocumentWindow, public juce::ApplicationCommandTarget
34  {
35  public: // methods
36 
45  Window(std::string const& name,
46  std::unique_ptr<juce::Component> content,
47  bool resizable = false,
48  bool is_main_window = true,
49  juce::String settings_name = juce::String::empty,
50  bool add_menubar = false);
51 
54  virtual ~Window();
55 
58  bool isMainWindow() const;
59 
64  void restoreWindowState();
65 
70  void saveWindowState();
71 
72  // ================================================================================ //
73  // APPLICATION COMMAND TARGET //
74  // ================================================================================ //
75 
76  ApplicationCommandTarget* getNextCommandTarget() override;
77  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
78  void getCommandInfo(const juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
79  bool perform(InvocationInfo const& info) override;
80 
81  protected: // methods
82 
84  void closeButtonPressed() override;
85 
86  private: // variables
87 
88  juce::String m_settings_name {};
89  bool m_is_main_window {false};
90  };
91 
94  enum class WindowId : std::size_t
95  {
96  Console = 0,
97  AboutKiwi,
98  DocumentBrowser,
99  ApplicationSettings,
100  AudioSettings,
101  BeaconDispatcher,
102  count // Number of WindowIds
103  };
104 }
kiwi::Window::restoreWindowState
void restoreWindowState()
Restore the window state.
Definition: KiwiApp_Window.cpp:80
-
kiwi::Window::closeButtonPressed
void closeButtonPressed() override
Called when close button is pressed. Request instance to close the window.
Definition: KiwiApp_Window.cpp:115
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <juce_gui_basics/juce_gui_basics.h>
25 
26 namespace kiwi
27 {
28  // ================================================================================ //
29  // WINDOW //
30  // ================================================================================ //
31 
33  class Window : public juce::DocumentWindow, public juce::ApplicationCommandTarget
34  {
35  public: // methods
36 
45  Window(std::string const& name,
46  std::unique_ptr<juce::Component> content,
47  bool resizable = false,
48  bool is_main_window = true,
49  juce::String settings_name = juce::String::empty,
50  bool add_menubar = false);
51 
54  virtual ~Window();
55 
58  bool isMainWindow() const;
59 
64  void restoreWindowState();
65 
70  void saveWindowState();
71 
73  void close();
74 
75  // ================================================================================ //
76  // APPLICATION COMMAND TARGET //
77  // ================================================================================ //
78 
79  ApplicationCommandTarget* getNextCommandTarget() override;
80  void getAllCommands(juce::Array<juce::CommandID>& commands) override;
81  void getCommandInfo(const juce::CommandID commandID, juce::ApplicationCommandInfo& result) override;
82  bool perform(InvocationInfo const& info) override;
83 
84  protected: // methods
85 
87  void closeButtonPressed() override;
88 
89  private: // variables
90 
91  juce::String m_settings_name {};
92  bool m_is_main_window {false};
93  };
94 
97  enum class WindowId : std::size_t
98  {
99  Console = 0,
100  FormComponent,
101  AboutKiwi,
102  DocumentBrowser,
103  ApplicationSettings,
104  AudioSettings,
105  BeaconDispatcher,
106  count // Number of WindowIds
107  };
108 }
kiwi::Window::restoreWindowState
void restoreWindowState()
Restore the window state.
Definition: KiwiApp_Window.cpp:80
+
kiwi::Window::closeButtonPressed
void closeButtonPressed() override
Called when close button is pressed. Request instance to close the window.
Definition: KiwiApp_Window.cpp:120
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::Console
Definition: KiwiApp_Console.h:202
-
kiwi::BeaconDispatcher
Definition: KiwiApp_BeaconDispatcher.h:128
+
kiwi::Console
Definition: KiwiApp_Console.h:199
+
kiwi::BeaconDispatcher
Definition: KiwiApp_BeaconDispatcher.h:129
kiwi::Window::Window
Window(std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)
Constructor.
Definition: KiwiApp_Window.cpp:34
-
kiwi::Window::isMainWindow
bool isMainWindow() const
Return true if window shall be a main window of kiwi.
Definition: KiwiApp_Window.cpp:110
+
kiwi::Window::isMainWindow
bool isMainWindow() const
Return true if window shall be a main window of kiwi.
Definition: KiwiApp_Window.cpp:110
+
kiwi::WindowId
WindowId
Singleton application window&#39;s ids.
Definition: KiwiApp_Window.h:97
+
kiwi::FormComponent
Definition: KiwiApp_FormComponent.h:75
+
kiwi::Window::close
void close()
Close the window.
Definition: KiwiApp_Window.cpp:115
kiwi::Window::~Window
virtual ~Window()
Window destructor. Called whenever buttonPressed is called.
Definition: KiwiApp_Window.cpp:75
-
kiwi::DocumentBrowser
Request Patcher document informations through a Kiwi API.
Definition: KiwiApp_DocumentBrowser.h:40
+
kiwi::DocumentBrowser
Request Patcher document informations through a Kiwi API.
Definition: KiwiApp_DocumentBrowser.h:42
kiwi::Window
Common interface for all windows held by the application.
Definition: KiwiApp_Window.h:33
kiwi::Window::saveWindowState
void saveWindowState()
Save the window state.
Definition: KiwiApp_Window.cpp:102
@@ -82,7 +109,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_dsp___chain_8h_source.html b/docs/html/_kiwi_dsp___chain_8h_source.html index d46d9134..d7ba7c84 100644 --- a/docs/html/_kiwi_dsp___chain_8h_source.html +++ b/docs/html/_kiwi_dsp___chain_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiDsp/KiwiDsp_Chain.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiDsp_Chain.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <map>
25 #include <queue>
26 
27 #include "KiwiDsp_Processor.h"
28 #include "KiwiDsp_Misc.h"
29 
30 namespace kiwi
31 {
32  namespace dsp
33  {
34  // ==================================================================================== //
35  // CHAIN //
36  // ==================================================================================== //
37 
44 
45  class Chain final
46  {
47  public: // methods
48 
53  Chain();
54 
60  ~Chain();
61 
67  void update();
68 
75  void prepare(size_t const samplerate, size_t const vectorsize);
76 
82  void release();
83 
86  size_t getSampleRate() const noexcept;
87 
90  size_t getVectorSize() const noexcept;
91 
97  void addProcessor(std::shared_ptr<Processor> processor);
98 
103  void removeProcessor(Processor& proc);
104 
109  void connect(Processor& source, size_t outlet_index,
110  Processor& dest, size_t inlet_index);
111 
115  void disconnect(Processor& source, size_t outlet_index,
116  Processor& destination, size_t inlet_index);
117 
122  void tick() noexcept;
123 
124  private: // classes
125 
128  enum class State : uint8_t
129  {
130  NotPrepared = 0,
131  Preparing = 1,
132  Prepared = 2,
133  };
134 
135  class Node;
136 
137  private: // methods
138 
142  struct index_node;
143 
146  struct compare_proc;
147 
149  std::vector<std::unique_ptr<Node>>::iterator findNode(Processor& proc);
150 
152  std::vector<std::unique_ptr<Node>>::const_iterator findNode(Processor& proc) const;
153 
157  void indexNodes();
158 
162  void sortNodes();
163 
164  private: // commands
165 
167  void execAddProcessor(std::shared_ptr<Processor> proc);
168 
170  void execRemoveProcessor(Processor* proc);
171 
173  void execConnect(Processor* source, size_t outlet_index,
174  Processor* dest, size_t inlet_index);
175 
177  void execDisconnect(Processor* source, size_t outlet_index,
178  Processor* dest, size_t inlet_index);
179 
184  void restackNode(Node & node);
185 
189  std::shared_ptr<Signal> getSignalIn();
190 
194  std::shared_ptr<Signal> getSignalOutlet(size_t outlet_index);
195 
199  std::shared_ptr<Signal> getSignalInlet(size_t inlet_index);
200 
201  private: // members
202 
203  std::vector<std::unique_ptr<Node>> m_nodes;
204  size_t m_sample_rate;
205  size_t m_vector_size;
206  State m_state;
207  std::deque<std::function<void(void)>> m_commands;
208  std::mutex m_tick_mutex;
209 
210  std::weak_ptr<Signal> m_signal_in;
211  std::map<size_t, std::weak_ptr<Signal>> m_signal_outlet;
212  std::map<size_t, std::weak_ptr<Signal>> m_signal_inlet;
213  };
214 
215  // ================================================================================ //
216  // NODE //
217  // ================================================================================ //
218 
223  class Chain::Node final
224  {
225  public: // typedefs
226 
227  using uPtr = std::unique_ptr<Node>;
228 
229  public: // methods
230 
232  Node(std::shared_ptr<Processor> processor);
233 
234  // @brief Destructor.
235  ~Node();
236 
239  bool connectInput(const size_t input_index, Node& other_node, const size_t output_index);
240 
243  bool disconnectInput(const size_t input_index, Node& other_node, const size_t output_index);
244 
247  bool prepare(Chain& chain);
248 
251  void perform() noexcept;
252 
254  void release();
255 
256  private: // nested classes
257 
258  class Pin;
259  class Tie;
260 
261  private: // members
262 
263  std::shared_ptr<Processor> m_processor;
264  std::vector<Pin> m_inlets;
265  std::vector<Pin> m_outlets;
266  Buffer m_inputs;
267  Buffer m_outputs;
268  std::vector<Buffer> m_buffer_copy;
269  size_t m_index;
270 
271  private: // deleted methods
272 
273  Node(Node const& other) = delete;
274  Node(Node && other) = delete;
275  Node& operator=(Node const& other) = delete;
276  Node& operator=(Node && other) = delete;
277 
278  friend class Chain;
279  };
280 
281  // ================================================================================ //
282  // NODE::PIN //
283  // ================================================================================ //
284 
286  class Chain::Node::Pin
287  {
288  public: // methods
289 
293  Pin(Node& owner, const size_t index);
294 
297  Pin(Pin && other);
298 
300  virtual ~Pin();
301 
304  bool connect(Pin& other_pin);
305 
308  bool disconnect(Pin& other_pin);
309 
311  void disconnect();
312 
313  public: // members
314 
315  Node& m_owner;
316  const size_t m_index;
317  Signal::sPtr m_signal;
318  std::set<Node::Tie> m_ties;
319 
320  private: // deleted methods
321 
322  Pin(Pin const& other) = delete;
323  Pin& operator=(Pin const& other) = delete;
324 
325  friend class Node;
326  };
327 
328  // ==================================================================================== //
329  // NODE::CONNECTION //
330  // ==================================================================================== //
331 
333  class Chain::Node::Tie final
334  {
335  public: // methods
336 
338  Tie(Pin& pin);
339 
341  Tie(Tie const& other) = default;
342 
344  bool operator<(Tie const& other) const noexcept;
345 
346  ~Tie() = default;
347 
348  public: // members
349 
350  Pin & m_pin;
351 
352  private: // deleted methods
353 
354  Tie() = delete;
355  };
356 
357  // ==================================================================================== //
358  // LOOPERROR //
359  // ==================================================================================== //
363  class LoopError : public Error
364  {
365  public:
368  explicit LoopError(const std::string& message) :
369  Error("looperror: " + message)
370  {}
371 
374  explicit LoopError(const char* message) :
375  Error(std::string("looperror: ") + std::string(message)) {}
376 
378  ~LoopError() noexcept override = default;
379  };
380  }
381 }
kiwi::dsp::Chain::tick
void tick() noexcept
Ticks once all the Processor objects. Not recursive.
Definition: KiwiDsp_Chain.cpp:463
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <map>
25 #include <queue>
26 
27 #include "KiwiDsp_Processor.h"
28 #include "KiwiDsp_Misc.h"
29 
30 namespace kiwi
31 {
32  namespace dsp
33  {
34  // ==================================================================================== //
35  // CHAIN //
36  // ==================================================================================== //
37 
44 
45  class Chain final
46  {
47  public: // methods
48 
53  Chain();
54 
60  ~Chain();
61 
67  void update();
68 
75  void prepare(size_t const samplerate, size_t const vectorsize);
76 
82  void release();
83 
86  size_t getSampleRate() const noexcept;
87 
90  size_t getVectorSize() const noexcept;
91 
97  void addProcessor(std::shared_ptr<Processor> processor);
98 
103  void removeProcessor(Processor& proc);
104 
109  void connect(Processor& source, size_t outlet_index,
110  Processor& dest, size_t inlet_index);
111 
115  void disconnect(Processor& source, size_t outlet_index,
116  Processor& destination, size_t inlet_index);
117 
122  void tick() noexcept;
123 
124  private: // classes
125 
128  enum class State : uint8_t
129  {
130  NotPrepared = 0,
131  Preparing = 1,
132  Prepared = 2,
133  };
134 
135  class Node;
136 
137  private: // methods
138 
142  struct index_node;
143 
146  struct compare_proc;
147 
149  std::vector<std::unique_ptr<Node>>::iterator findNode(Processor& proc);
150 
152  std::vector<std::unique_ptr<Node>>::const_iterator findNode(Processor& proc) const;
153 
157  void indexNodes();
158 
162  void sortNodes();
163 
164  private: // commands
165 
167  void execAddProcessor(std::shared_ptr<Processor> proc);
168 
170  void execRemoveProcessor(Processor* proc);
171 
173  void execConnect(Processor* source, size_t outlet_index,
174  Processor* dest, size_t inlet_index);
175 
177  void execDisconnect(Processor* source, size_t outlet_index,
178  Processor* dest, size_t inlet_index);
179 
184  void restackNode(Node & node);
185 
189  std::shared_ptr<Signal> getSignalIn();
190 
194  std::shared_ptr<Signal> getSignalOutlet(size_t outlet_index);
195 
199  std::shared_ptr<Signal> getSignalInlet(size_t inlet_index);
200 
201  private: // members
202 
203  std::vector<std::unique_ptr<Node>> m_nodes;
204  size_t m_sample_rate;
205  size_t m_vector_size;
206  State m_state;
207  std::deque<std::function<void(void)>> m_commands;
208  std::mutex m_tick_mutex;
209 
210  std::weak_ptr<Signal> m_signal_in;
211  std::map<size_t, std::weak_ptr<Signal>> m_signal_outlet;
212  std::map<size_t, std::weak_ptr<Signal>> m_signal_inlet;
213  };
214 
215  // ================================================================================ //
216  // NODE //
217  // ================================================================================ //
218 
223  class Chain::Node final
224  {
225  public: // typedefs
226 
227  using uPtr = std::unique_ptr<Node>;
228 
229  public: // methods
230 
232  Node(std::shared_ptr<Processor> processor);
233 
234  // @brief Destructor.
235  ~Node();
236 
239  bool connectInput(const size_t input_index, Node& other_node, const size_t output_index);
240 
243  bool disconnectInput(const size_t input_index, Node& other_node, const size_t output_index);
244 
247  bool prepare(Chain& chain);
248 
251  void perform() noexcept;
252 
254  void release();
255 
256  private: // nested classes
257 
258  class Pin;
259  class Tie;
260 
261  private: // members
262 
263  std::shared_ptr<Processor> m_processor;
264  std::vector<Pin> m_inlets;
265  std::vector<Pin> m_outlets;
266  Buffer m_inputs;
267  Buffer m_outputs;
268  std::vector<Buffer> m_buffer_copy;
269  size_t m_index;
270 
271  private: // deleted methods
272 
273  Node(Node const& other) = delete;
274  Node(Node && other) = delete;
275  Node& operator=(Node const& other) = delete;
276  Node& operator=(Node && other) = delete;
277 
278  friend class Chain;
279  };
280 
281  // ================================================================================ //
282  // NODE::PIN //
283  // ================================================================================ //
284 
286  class Chain::Node::Pin
287  {
288  public: // methods
289 
293  Pin(Node& owner, const size_t index);
294 
297  Pin(Pin && other);
298 
300  virtual ~Pin();
301 
304  bool connect(Pin& other_pin);
305 
308  bool disconnect(Pin& other_pin);
309 
311  void disconnect();
312 
313  public: // members
314 
315  Node& m_owner;
316  const size_t m_index;
317  Signal::sPtr m_signal;
318  std::set<Node::Tie> m_ties;
319 
320  private: // deleted methods
321 
322  Pin(Pin const& other) = delete;
323  Pin& operator=(Pin const& other) = delete;
324 
325  friend class Node;
326  };
327 
328  // ==================================================================================== //
329  // NODE::CONNECTION //
330  // ==================================================================================== //
331 
333  class Chain::Node::Tie final
334  {
335  public: // methods
336 
338  Tie(Pin& pin);
339 
341  Tie(Tie const& other) = default;
342 
344  bool operator<(Tie const& other) const noexcept;
345 
346  ~Tie() = default;
347 
348  public: // members
349 
350  Pin & m_pin;
351 
352  private: // deleted methods
353 
354  Tie() = delete;
355  };
356 
357  // ==================================================================================== //
358  // LOOPERROR //
359  // ==================================================================================== //
363  class LoopError : public Error
364  {
365  public:
368  explicit LoopError(const std::string& message) :
369  Error("looperror: " + message)
370  {}
371 
374  explicit LoopError(const char* message) :
375  Error(std::string("looperror: ") + std::string(message)) {}
376 
378  ~LoopError() noexcept override = default;
379  };
380  }
381 }
kiwi::dsp::Chain::tick
void tick() noexcept
Ticks once all the Processor objects. Not recursive.
Definition: KiwiDsp_Chain.cpp:459
kiwi::dsp::Chain::Chain
Chain()
The default constructor.
Definition: KiwiDsp_Chain.cpp:309
kiwi::dsp::Chain::Node
The Node object wraps and manages a Processor object inside a Chain object.
Definition: KiwiDsp_Chain.h:223
kiwi::dsp::Chain
An audio rendering class that manages processors in a graph structure.
Definition: KiwiDsp_Chain.h:45
-
kiwi::dsp::Chain::getVectorSize
size_t getVectorSize() const noexcept
Gets the current vector size.
Definition: KiwiDsp_Chain.cpp:458
-
kiwi::dsp::Chain::index_node
Definition: KiwiDsp_Chain.cpp:506
-
kiwi::dsp::Chain::getSampleRate
size_t getSampleRate() const noexcept
Gets the current sample rate.
Definition: KiwiDsp_Chain.cpp:453
-
kiwi::dsp::Chain::disconnect
void disconnect(Processor &source, size_t outlet_index, Processor &destination, size_t inlet_index)
Disconnect two processors.
Definition: KiwiDsp_Chain.cpp:594
+
kiwi::dsp::Chain::index_node
Definition: KiwiDsp_Chain.cpp:502
+
kiwi::dsp::Chain::disconnect
void disconnect(Processor &source, size_t outlet_index, Processor &destination, size_t inlet_index)
Disconnect two processors.
Definition: KiwiDsp_Chain.cpp:590
kiwi::dsp::Processor
The pure virtual class that processes digital signal in a Chain object.
Definition: KiwiDsp_Processor.h:94
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::dsp::Chain::prepare
void prepare(size_t const samplerate, size_t const vectorsize)
Allocates memory needed for chain execution.
Definition: KiwiDsp_Chain.cpp:352
kiwi::dsp::Chain::update
void update()
Updates the chain making changes effective.
Definition: KiwiDsp_Chain.cpp:328
-
kiwi::dsp::Chain::removeProcessor
void removeProcessor(Processor &proc)
Removes processors from the chain.
Definition: KiwiDsp_Chain.cpp:578
-
kiwi::dsp::Chain::addProcessor
void addProcessor(std::shared_ptr< Processor > processor)
Adds a processor to the chain.
Definition: KiwiDsp_Chain.cpp:572
+
kiwi::dsp::Chain::removeProcessor
void removeProcessor(Processor &proc)
Removes processors from the chain.
Definition: KiwiDsp_Chain.cpp:574
+
kiwi::dsp::Chain::addProcessor
void addProcessor(std::shared_ptr< Processor > processor)
Adds a processor to the chain.
Definition: KiwiDsp_Chain.cpp:568
kiwi::dsp::LoopError
An exception to detect loops.
Definition: KiwiDsp_Chain.h:363
-
kiwi::dsp::Chain::release
void release()
Deallocate memory needed to perform tick method.
Definition: KiwiDsp_Chain.cpp:438
+
kiwi::dsp::Chain::release
void release()
Deallocate memory needed to perform tick method.
Definition: KiwiDsp_Chain.cpp:434
kiwi::dsp::Chain::Node::Tie
A tie is a reference held by a pin to another pin.
Definition: KiwiDsp_Chain.h:333
kiwi::dsp::LoopError::LoopError
LoopError(const std::string &message)
The std::string constructor.
Definition: KiwiDsp_Chain.h:368
kiwi::dsp::Chain::Node::Pin
The pin helds a set of tie that points to other pins.
Definition: KiwiDsp_Chain.h:286
+
kiwi::dsp::Chain::getVectorSize
size_t getVectorSize() const noexcept
Gets the current vector size.
Definition: KiwiDsp_Chain.cpp:454
kiwi::dsp::LoopError::LoopError
LoopError(const char *message)
The const char* constructor.
Definition: KiwiDsp_Chain.h:374
kiwi::dsp::Error
The exception.
Definition: KiwiDsp_Misc.h:51
-
kiwi::dsp::Chain::compare_proc
Definition: KiwiDsp_Chain.cpp:484
-
kiwi::dsp::Chain::connect
void connect(Processor &source, size_t outlet_index, Processor &dest, size_t inlet_index)
Connects two processors.
Definition: KiwiDsp_Chain.cpp:584
+
kiwi::dsp::Chain::getSampleRate
size_t getSampleRate() const noexcept
Gets the current sample rate.
Definition: KiwiDsp_Chain.cpp:449
+
kiwi::dsp::Chain::compare_proc
Definition: KiwiDsp_Chain.cpp:480
+
kiwi::dsp::Chain::connect
void connect(Processor &source, size_t outlet_index, Processor &dest, size_t inlet_index)
Connects two processors.
Definition: KiwiDsp_Chain.cpp:580
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
kiwi::dsp::Chain::~Chain
~Chain()
The destructor.
Definition: KiwiDsp_Chain.cpp:319
@@ -96,7 +120,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_dsp___def_8h_source.html b/docs/html/_kiwi_dsp___def_8h_source.html index 541cfa23..5116582d 100644 --- a/docs/html/_kiwi_dsp___def_8h_source.html +++ b/docs/html/_kiwi_dsp___def_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiDsp/KiwiDsp_Def.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + + - + - - - - + + - + - - - - + +
KiwiDsp_Processor.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiDsp_Signal.h"
25 
26 namespace kiwi
27 {
28  namespace dsp
29  {
30  class Chain;
31 
32  // ==================================================================================== //
33  // PERFORM CALL BACKC //
34  // ==================================================================================== //
35 
40  class IPerformCallBack
41  {
42  public:
44  IPerformCallBack() = default;
45 
47  virtual ~IPerformCallBack() = default;
48 
50  virtual void perform(Buffer const& intput, Buffer& output) = 0;
51  };
52 
56  template<class TProc>
57  class PerformCallBack : public IPerformCallBack
58  {
59  public:
60 
62  PerformCallBack(TProc & processor, void (TProc::*call_back)(Buffer const& input, Buffer &output)):
63  m_processor(processor),
64  m_call_back(call_back)
65  {
66  }
67 
69  void perform(Buffer const& input, Buffer& output) override final
70  {
71  (m_processor.*m_call_back)(input, output);
72  }
73 
77  ~PerformCallBack() = default;
78 
79  private:
80 
81  TProc& m_processor;
82 
83  void (TProc::*m_call_back)(Buffer const& input, Buffer &output);
84  };
85 
86  // ==================================================================================== //
87  // PROCESSOR //
88  // ==================================================================================== //
89 
94  class Processor
95  {
96  public: // classes
97 
98  struct PrepareInfo
99  {
100  const size_t sample_rate;
101  const size_t vector_size;
102  const std::vector<bool> &inputs;
103  };
104 
105  public: // methods
106 
111  Processor(const size_t ninputs, const size_t noutputs) noexcept :
112  m_ninputs(ninputs), m_noutputs(noutputs) {}
113 
115  virtual ~Processor() = default;
116 
120  inline size_t getNumberOfInputs() const noexcept {return m_ninputs;}
121 
125  inline size_t getNumberOfOutputs() const noexcept {return m_noutputs;}
126 
129  bool shouldPerform() const noexcept
130  {
131  return m_call_back != nullptr;
132  }
133 
134  protected: // methods
135 
140  template<class TProc>
141  void setPerformCallBack(TProc* processor,
142  void (TProc::*call_back)(Buffer const& input, Buffer &output))
143  {
144  m_call_back.reset(new PerformCallBack<TProc>(*processor, call_back));
145  }
146 
147  private: // methods
148 
156  virtual void prepare(PrepareInfo const& infos) = 0;
157 
163  inline void perform(Buffer const& input, Buffer& output) noexcept
164  {
165  m_call_back->perform(input, output);
166  };
167 
172  virtual void release() {};
173 
174  private: // members
175 
176  const size_t m_ninputs;
177  const size_t m_noutputs;
178 
179  std::unique_ptr<IPerformCallBack> m_call_back;
180 
181  friend class Chain;
182  };
183  }
184 }
kiwi::dsp::Chain
An audio rendering class that manages processors in a graph structure.
Definition: KiwiDsp_Chain.h:45
-
kiwi::dsp::Processor::getNumberOfOutputs
size_t getNumberOfOutputs() const noexcept
Gets the current number of outputs.
Definition: KiwiDsp_Processor.h:125
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiDsp_Signal.h"
25 
26 namespace kiwi
27 {
28  namespace dsp
29  {
30  class Chain;
31 
32  // ==================================================================================== //
33  // PERFORM CALL BACKC //
34  // ==================================================================================== //
35 
40  class IPerformCallBack
41  {
42  public:
44  IPerformCallBack() = default;
45 
47  virtual ~IPerformCallBack() = default;
48 
50  virtual void perform(Buffer const& intput, Buffer& output) = 0;
51  };
52 
56  template<class TProc>
57  class PerformCallBack : public IPerformCallBack
58  {
59  public:
60 
62  PerformCallBack(TProc & processor, void (TProc::*call_back)(Buffer const& input, Buffer &output)):
63  m_processor(processor),
64  m_call_back(call_back)
65  {
66  }
67 
69  void perform(Buffer const& input, Buffer& output) override final
70  {
71  (m_processor.*m_call_back)(input, output);
72  }
73 
77  ~PerformCallBack() = default;
78 
79  private:
80 
81  TProc& m_processor;
82 
83  void (TProc::*m_call_back)(Buffer const& input, Buffer &output);
84  };
85 
86  // ==================================================================================== //
87  // PROCESSOR //
88  // ==================================================================================== //
89 
94  class Processor
95  {
96  public: // classes
97 
98  struct PrepareInfo
99  {
100  const size_t sample_rate;
101  const size_t vector_size;
102  const std::vector<bool> &inputs;
103  };
104 
105  public: // methods
106 
111  Processor(const size_t ninputs, const size_t noutputs) noexcept :
112  m_ninputs(ninputs), m_noutputs(noutputs) {}
113 
115  virtual ~Processor() = default;
116 
120  inline size_t getNumberOfInputs() const noexcept {return m_ninputs;}
121 
125  inline size_t getNumberOfOutputs() const noexcept {return m_noutputs;}
126 
129  bool shouldPerform() const noexcept
130  {
131  return m_call_back != nullptr;
132  }
133 
134  protected: // methods
135 
140  template<class TProc>
141  void setPerformCallBack(TProc* processor,
142  void (TProc::*call_back)(Buffer const& input, Buffer &output))
143  {
144  m_call_back.reset(new PerformCallBack<TProc>(*processor, call_back));
145  }
146 
147  private: // methods
148 
156  virtual void prepare(PrepareInfo const& infos) = 0;
157 
163  inline void perform(Buffer const& input, Buffer& output) noexcept
164  {
165  m_call_back->perform(input, output);
166  };
167 
172  virtual void release() {};
173 
174  private: // members
175 
176  const size_t m_ninputs;
177  const size_t m_noutputs;
178 
179  std::unique_ptr<IPerformCallBack> m_call_back;
180 
181  friend class Chain;
182  };
183  }
184 }
kiwi::dsp::Chain
An audio rendering class that manages processors in a graph structure.
Definition: KiwiDsp_Chain.h:45
kiwi::dsp::PerformCallBack::PerformCallBack
PerformCallBack(TProc &processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
Constructor, get a pointer to the processor and its call back to be called later. ...
Definition: KiwiDsp_Processor.h:62
-
kiwi::dsp::Processor::shouldPerform
bool shouldPerform() const noexcept
Returns true if the processor shall be performed by the chain.
Definition: KiwiDsp_Processor.h:129
+
kiwi::dsp::Processor::getNumberOfOutputs
size_t getNumberOfOutputs() const noexcept
Gets the current number of outputs.
Definition: KiwiDsp_Processor.h:125
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
kiwi::dsp::IPerformCallBack::IPerformCallBack
IPerformCallBack()=default
The default contrustor.
kiwi::dsp::Processor::Processor
Processor(const size_t ninputs, const size_t noutputs) noexcept
The constructor.
Definition: KiwiDsp_Processor.h:111
@@ -77,18 +100,19 @@
kiwi::dsp::PerformCallBack::perform
void perform(Buffer const &input, Buffer &output) override final
Implementation of perform that binds a processor and its method.
Definition: KiwiDsp_Processor.h:69
kiwi::dsp::IPerformCallBack
Pure virtual interface that defines a perform function to be implemented by child classes...
Definition: KiwiDsp_Processor.h:40
kiwi::dsp::IPerformCallBack::perform
virtual void perform(Buffer const &intput, Buffer &output)=0
pure virtual method that perform input and output buffers.
+
kiwi::dsp::Processor::shouldPerform
bool shouldPerform() const noexcept
Returns true if the processor shall be performed by the chain.
Definition: KiwiDsp_Processor.h:129
kiwi::dsp::Processor::setPerformCallBack
void setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
Constructs a callback that will bind a processor and its perform method.
Definition: KiwiDsp_Processor.h:141
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::dsp::IPerformCallBack::~IPerformCallBack
virtual ~IPerformCallBack()=default
Destructor.
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
kiwi::dsp::PerformCallBack
Templated implementation of IPerformCallBack. Templated on type of processor.
Definition: KiwiDsp_Processor.h:57
-
kiwi::dsp::Processor::getNumberOfInputs
size_t getNumberOfInputs() const noexcept
Gets the current number of inputs.
Definition: KiwiDsp_Processor.h:120
+
kiwi::dsp::Processor::getNumberOfInputs
size_t getNumberOfInputs() const noexcept
Gets the current number of inputs.
Definition: KiwiDsp_Processor.h:120
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_dsp___signal_8h_source.html b/docs/html/_kiwi_dsp___signal_8h_source.html index c83a7c8f..6a6d8135 100644 --- a/docs/html/_kiwi_dsp___signal_8h_source.html +++ b/docs/html/_kiwi_dsp___signal_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiDsp/KiwiDsp_Signal.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiDsp_Signal.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <memory>
25 
26 #include "KiwiDsp_Def.h"
27 
28 namespace kiwi
29 {
30  namespace dsp
31  {
32  // ==================================================================================== //
33  // SIGNAL //
34  // ==================================================================================== //
39  class Signal
40  {
41  public: // methods
42 
43  typedef std::shared_ptr<Signal> sPtr;
44  typedef std::shared_ptr<const Signal> scPtr;
45  typedef std::unique_ptr<Signal> uPtr;
46 
51  Signal(const size_t size, const sample_t val = sample_t(0.));
52 
57  Signal(Signal&& other) noexcept;
58 
63  Signal& operator=(Signal&& other) noexcept;
64 
67  ~Signal();
68 
70  size_t size() const noexcept;
71 
73  sample_t const* data() const noexcept;
74 
76  sample_t* data() noexcept;
77 
80  sample_t const& operator[](const size_t index) const;
81 
84  sample_t& operator[](const size_t index);
85 
88  void fill(sample_t const& value) noexcept;
89 
91  void copy(Signal const& other_signal) noexcept;
92 
94  void add(Signal const& other_signal) noexcept;
95 
97  static void add(Signal const& signal_1, Signal const& signal_2, Signal& result);
98 
99  private: // members
100 
101  size_t m_size;
102  sample_t* m_samples;
103 
104  private: // deleted methods
105 
106  Signal() = delete;
107  Signal(Signal const& other) = delete;
108  Signal& operator=(Signal& other) = delete;
109  };
110 
111  // ==================================================================================== //
112  // BUFFER //
113  // ==================================================================================== //
114 
118  class Buffer
119  {
120  public: // methods
121 
124  Buffer();
125 
131  Buffer(std::vector<Signal::sPtr> signals);
132 
140  Buffer(const size_t nchannels, const size_t nsamples, const sample_t val = 0.);
141 
146  Buffer(Buffer&& other) noexcept;
147 
152  Buffer& operator=(Buffer&& other) noexcept;
153 
156  ~Buffer();
157 
164  void setChannels(std::vector<Signal::sPtr> signals);
165 
168  void clear();
169 
171  size_t getVectorSize() const noexcept;
172 
174  size_t getNumberOfChannels() const noexcept;
175 
177  bool empty() const noexcept;
178 
180  Signal const& operator[](const size_t index) const;
181 
183  Signal& operator[](const size_t index);
184 
185  private: // members
186 
187  size_t m_vectorsize;
188  std::vector<Signal::sPtr> m_signals;
189 
190  private: // deleted methods
191 
192  Buffer(Buffer const& other) = delete;
193  Buffer& operator=(Buffer const& other) = delete;
194  };
195  }
196 }
kiwi::dsp::Signal::copy
void copy(Signal const &other_signal) noexcept
Copies the samples of another signal into it.
Definition: KiwiDsp_Signal.cpp:104
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <memory>
25 
26 #include "KiwiDsp_Def.h"
27 
28 namespace kiwi
29 {
30  namespace dsp
31  {
32  // ==================================================================================== //
33  // SIGNAL //
34  // ==================================================================================== //
39  class Signal
40  {
41  public: // methods
42 
43  typedef std::shared_ptr<Signal> sPtr;
44  typedef std::shared_ptr<const Signal> scPtr;
45  typedef std::unique_ptr<Signal> uPtr;
46 
51  Signal(const size_t size, const sample_t val = sample_t(0.));
52 
57  Signal(Signal&& other) noexcept;
58 
63  Signal& operator=(Signal&& other) noexcept;
64 
67  ~Signal();
68 
70  size_t size() const noexcept;
71 
73  sample_t const* data() const noexcept;
74 
76  sample_t* data() noexcept;
77 
80  sample_t const& operator[](const size_t index) const;
81 
84  sample_t& operator[](const size_t index);
85 
88  void fill(sample_t const& value) noexcept;
89 
91  void copy(Signal const& other_signal) noexcept;
92 
94  void add(Signal const& other_signal) noexcept;
95 
97  static void add(Signal const& signal_1, Signal const& signal_2, Signal& result);
98 
99  private: // members
100 
101  size_t m_size;
102  sample_t* m_samples;
103 
104  private: // deleted methods
105 
106  Signal() = delete;
107  Signal(Signal const& other) = delete;
108  Signal& operator=(Signal& other) = delete;
109  };
110 
111  // ==================================================================================== //
112  // BUFFER //
113  // ==================================================================================== //
114 
118  class Buffer
119  {
120  public: // methods
121 
124  Buffer();
125 
131  Buffer(std::vector<Signal::sPtr> signals);
132 
140  Buffer(const size_t nchannels, const size_t nsamples, const sample_t val = 0.);
141 
146  Buffer(Buffer&& other) noexcept;
147 
152  Buffer& operator=(Buffer&& other) noexcept;
153 
156  ~Buffer();
157 
164  void setChannels(std::vector<Signal::sPtr> signals);
165 
168  void clear();
169 
171  size_t getVectorSize() const noexcept;
172 
174  size_t getNumberOfChannels() const noexcept;
175 
177  bool empty() const noexcept;
178 
180  Signal const& operator[](const size_t index) const;
181 
183  Signal& operator[](const size_t index);
184 
185  private: // members
186 
187  size_t m_vectorsize;
188  std::vector<Signal::sPtr> m_signals;
189 
190  private: // deleted methods
191 
192  Buffer(Buffer const& other) = delete;
193  Buffer& operator=(Buffer const& other) = delete;
194  };
195  }
196 }
kiwi::dsp::Signal::size
size_t size() const noexcept
Gets the number of samples that the Signal object currently holds.
Definition: KiwiDsp_Signal.cpp:70
+
kiwi::dsp::Signal::copy
void copy(Signal const &other_signal) noexcept
Copies the samples of another signal into it.
Definition: KiwiDsp_Signal.cpp:104
kiwi::dsp::Signal::add
void add(Signal const &other_signal) noexcept
Adds a Signal to this one.
Definition: KiwiDsp_Signal.cpp:122
-
kiwi::dsp::Signal::data
sample_t const * data() const noexcept
Returns a read pointer to the samples data.
Definition: KiwiDsp_Signal.cpp:75
-
kiwi::dsp::Signal::operator[]
sample_t const & operator[](const size_t index) const
Gets a read sample_t for a given index.
Definition: KiwiDsp_Signal.cpp:85
kiwi::dsp::Signal::~Signal
~Signal()
The destructor.
Definition: KiwiDsp_Signal.cpp:60
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::dsp::Signal::fill
void fill(sample_t const &value) noexcept
Fill this Signal with a new value.
Definition: KiwiDsp_Signal.cpp:99
+
kiwi::dsp::Signal::operator[]
sample_t const & operator[](const size_t index) const
Gets a read sample_t for a given index.
Definition: KiwiDsp_Signal.cpp:85
kiwi::dsp::Signal::operator=
Signal & operator=(Signal &&other) noexcept
Move assignment operator.
Definition: KiwiDsp_Signal.cpp:50
-
kiwi::dsp::Signal::size
size_t size() const noexcept
Gets the number of samples that the Signal object currently holds.
Definition: KiwiDsp_Signal.cpp:70
+
kiwi::dsp::Signal::data
sample_t const * data() const noexcept
Returns a read pointer to the samples data.
Definition: KiwiDsp_Signal.cpp:75
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
kiwi::dsp::Signal
A class that wraps a vector of sample_t.
Definition: KiwiDsp_Signal.h:39
@@ -82,7 +106,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___adc_tilde_8h_source.html b/docs/html/_kiwi_engine___adc_tilde_8h_source.html new file mode 100644 index 00000000..ff7ae086 --- /dev/null +++ b/docs/html/_kiwi_engine___adc_tilde_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_AdcTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_AdcTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_AudioInterface.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // ADC~ //
30  // ================================================================================ //
31 
32  class AdcTilde : public AudioInterfaceObject
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  AdcTilde(model::Object const& model, Patcher& patcher);
41 
42  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
43 
44  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
45  };
46 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::AdcTilde
Definition: KiwiEngine_AdcTilde.h:32
+
kiwi::engine::AudioInterfaceObject
Definition: KiwiEngine_AudioInterface.h:33
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::AdcTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_AdcTilde.cpp:54
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___audio_controler_8h_source.html b/docs/html/_kiwi_engine___audio_controler_8h_source.html index 2a401d90..a6c85b7a 100644 --- a/docs/html/_kiwi_engine___audio_controler_8h_source.html +++ b/docs/html/_kiwi_engine___audio_controler_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine/KiwiEngine_AudioControler.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiEngine_AudioControler.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiDsp/KiwiDsp_Chain.h>
25 #include <KiwiDsp/KiwiDsp_Signal.h>
26 
27 namespace kiwi
28 {
29  namespace engine
30  {
35  class AudioControler
36  {
37  public: // methods
38 
40  AudioControler() = default;
41 
43  virtual ~AudioControler() = default;
44 
46  virtual void startAudio() = 0;
47 
49  virtual void stopAudio() = 0;
50 
52  virtual bool isAudioOn() const = 0;
53 
55  virtual void add(dsp::Chain& chain) = 0;
56 
58  virtual void remove(dsp::Chain& chain) = 0;
59 
61  virtual void addToChannel(size_t const channel, dsp::Signal const& output_signal) = 0;
62 
64  virtual void getFromChannel(size_t const channel, dsp::Signal & input_signal) = 0;
65 
66  private: // deleted methods
67 
68  AudioControler(AudioControler const& other) = delete;
69  AudioControler(AudioControler && other) = delete;
70  AudioControler& operator=(AudioControler const& other) = delete;
71  AudioControler& operator=(AudioControler && other) = delete;
72  };
73  }
74 }
kiwi::engine::AudioControler::getFromChannel
virtual void getFromChannel(size_t const channel, dsp::Signal &input_signal)=0
Gets a signal from one of the input channels of the AudioControler.
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiDsp/KiwiDsp_Chain.h>
25 #include <KiwiDsp/KiwiDsp_Signal.h>
26 
27 namespace kiwi
28 {
29  namespace engine
30  {
35  class AudioControler
36  {
37  public: // methods
38 
40  AudioControler() = default;
41 
43  virtual ~AudioControler() = default;
44 
46  virtual void startAudio() = 0;
47 
49  virtual void stopAudio() = 0;
50 
52  virtual bool isAudioOn() const = 0;
53 
55  virtual void add(dsp::Chain& chain) = 0;
56 
58  virtual void remove(dsp::Chain& chain) = 0;
59 
61  virtual void addToChannel(size_t const channel, dsp::Signal const& output_signal) = 0;
62 
64  virtual void getFromChannel(size_t const channel, dsp::Signal & input_signal) = 0;
65 
66  private: // deleted methods
67 
68  AudioControler(AudioControler const& other) = delete;
69  AudioControler(AudioControler && other) = delete;
70  AudioControler& operator=(AudioControler const& other) = delete;
71  AudioControler& operator=(AudioControler && other) = delete;
72  };
73  }
74 }
kiwi::engine::AudioControler::getFromChannel
virtual void getFromChannel(size_t const channel, dsp::Signal &input_signal)=0
Gets a signal from one of the input channels of the AudioControler.
kiwi::dsp::Chain
An audio rendering class that manages processors in a graph structure.
Definition: KiwiDsp_Chain.h:45
kiwi::engine::AudioControler::startAudio
virtual void startAudio()=0
Starts the audio thread.
kiwi::engine::AudioControler::stopAudio
virtual void stopAudio()=0
Stops the audio thread.
kiwi::engine::AudioControler::add
virtual void add(dsp::Chain &chain)=0
Adds a chain to be ticked by the audio thread.
-
kiwi::engine::AudioControler::isAudioOn
virtual bool isAudioOn() const =0
Returns true if the audio is on.
+
kiwi::engine::AudioControler::isAudioOn
virtual bool isAudioOn() const =0
Returns true if the audio is on.
kiwi::engine::AudioControler::~AudioControler
virtual ~AudioControler()=default
The destuctor.
kiwi::engine::AudioControler
AudioControler is a pure interface that enable controling audio in kiwi.
Definition: KiwiEngine_AudioControler.h:35
kiwi
Definition: KiwiDsp_Chain.cpp:25
@@ -83,7 +107,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___audio_interface_8h_source.html b/docs/html/_kiwi_engine___audio_interface_8h_source.html new file mode 100644 index 00000000..bd9ac202 --- /dev/null +++ b/docs/html/_kiwi_engine___audio_interface_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_AudioInterface.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_AudioInterface.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_AudioControler.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // AUDIO_INTERFACE //
31  // ================================================================================ //
32 
33  class AudioInterfaceObject : public AudioObject
34  {
35  public: // methods
36 
37  AudioInterfaceObject(model::Object const& model, Patcher& patcher);
38 
39  void receive(size_t index, std::vector<tool::Atom> const & args) override final;
40 
41  std::vector<size_t> parseArgs(std::vector<tool::Atom> const& args) const;
42 
43  virtual ~AudioInterfaceObject() = default;
44 
45  protected: // members
46 
47  engine::AudioControler& m_audio_controler;
48  std::vector<size_t> m_routes;
49  };
50 
51 }}
kiwi::engine::AudioControler
AudioControler is a pure interface that enable controling audio in kiwi.
Definition: KiwiEngine_AudioControler.h:35
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::AudioInterfaceObject
Definition: KiwiEngine_AudioInterface.h:33
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::AudioInterfaceObject::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_AudioInterface.cpp:72
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___bang_8h_source.html b/docs/html/_kiwi_engine___bang_8h_source.html new file mode 100644 index 00000000..43d5cc16 --- /dev/null +++ b/docs/html/_kiwi_engine___bang_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Bang.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Bang.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT BANG //
30  // ================================================================================ //
31 
32  class Bang : public engine::Object
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& object, Patcher & patcher);
39 
40  Bang(model::Object const& model, Patcher& patcher);
41 
42  ~Bang();
43 
44  void signalTriggered();
45 
46  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
47 
48  private: // members
49 
50  flip::Signal<> & m_signal;
51  flip::SignalConnection m_connection;
52  };
53 
54 }}
kiwi::engine::Bang
Definition: KiwiEngine_Bang.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Bang::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Bang.cpp:62
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___clip_8h_source.html b/docs/html/_kiwi_engine___clip_8h_source.html new file mode 100644 index 00000000..6d4740e7 --- /dev/null +++ b/docs/html/_kiwi_engine___clip_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Clip.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <atomic>
25 
26 #include <KiwiEngine/KiwiEngine_Object.h>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // CLIP //
32  // ================================================================================ //
33 
34  class Clip : public Object
35  {
36  public: // methods
37 
38  static void declare();
39 
40  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
41 
42  Clip(model::Object const& model, Patcher& patcher);
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
45 
46  private: // methods
47 
48  double m_minimum;
49  double m_maximum;
50  };
51 
52 }}
kiwi::engine::Clip
Definition: KiwiEngine_Clip.h:34
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Clip::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Clip.cpp:59
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___clip_tilde_8h_source.html b/docs/html/_kiwi_engine___clip_tilde_8h_source.html new file mode 100644 index 00000000..d277df2b --- /dev/null +++ b/docs/html/_kiwi_engine___clip_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_ClipTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <atomic>
25 
26 #include <KiwiEngine/KiwiEngine_Object.h>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // CLIP~ //
32  // ================================================================================ //
33 
34  class ClipTilde : public AudioObject
35  {
36  public: // methods
37 
38  static void declare();
39 
40  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
41 
42  ClipTilde(model::Object const& model, Patcher& patcher);
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
45 
46  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
47 
48  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
49 
50  void performMinMax(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
51 
52  void performMin(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
53 
54  void performMax(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
55 
56  private: // methods
57 
58  std::atomic<float> m_minimum;
59  std::atomic<float> m_maximum;
60  };
61 
62 }}
kiwi::engine::ClipTilde
Definition: KiwiEngine_ClipTilde.h:34
+
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::ClipTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_ClipTilde.cpp:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::ClipTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_ClipTilde.cpp:59
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___comment_8h_source.html b/docs/html/_kiwi_engine___comment_8h_source.html new file mode 100644 index 00000000..5ef18910 --- /dev/null +++ b/docs/html/_kiwi_engine___comment_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Comment.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Comment.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT COMMENT //
30  // ================================================================================ //
31 
32  class Comment : public engine::Object
33  {
34  public: // methods
35 
36  Comment(model::Object const& model, Patcher& patcher);
37 
38  ~Comment();
39 
40  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
41 
42  static void declare();
43 
44  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
45  };
46 
47 }}
kiwi::engine::Comment::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Comment.cpp:51
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Comment
Definition: KiwiEngine_Comment.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___console_8h_source.html b/docs/html/_kiwi_engine___console_8h_source.html index b4475292..3f8b1442 100644 --- a/docs/html/_kiwi_engine___console_8h_source.html +++ b/docs/html/_kiwi_engine___console_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine/KiwiEngine_Console.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiEngine_Console.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Atom.h>
25 #include "KiwiEngine_Listeners.h"
26 
27 namespace kiwi
28 {
29  namespace engine
30  {
31  // ================================================================================ //
32  // CONSOLE //
33  // ================================================================================ //
34 
36  class Console
37  {
38  public: // methods
39 
41  Console() = default;
42 
44  ~Console() = default;
45 
47  class Message
48  {
49  public:
50 
52  enum class Type
53  {
54  Log = 0,
55  Normal,
56  Warning,
57  Error
58  };
59 
60  std::string text;
61  Type type;
62  };
63 
65  void post(Message const& mess) const;
66 
67  // ================================================================================ //
68  // CONSOLE LISTENER //
69  // ================================================================================ //
70 
72  class Listener
73  {
74  public:
75  virtual ~Listener() = default;
76 
78  virtual void newConsoleMessage(Console::Message const& message) = 0;
79  };
80 
82  void addListener(Listener& listener);
83 
85  void removeListener(Listener& listener);
86 
87  private: // members
88 
89  Listeners<Listener> m_listeners;
90  };
91  }
92 }
kiwi::engine::Console::post
void post(Message const &mess) const
Print a post-type message in the console.
Definition: KiwiEngine_Console.cpp:32
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Atom.h>
25 #include <KiwiTool/KiwiTool_Listeners.h>
26 
27 namespace kiwi
28 {
29  namespace engine
30  {
31  // ================================================================================ //
32  // CONSOLE //
33  // ================================================================================ //
34 
36  class Console
37  {
38  public: // methods
39 
41  Console() = default;
42 
44  ~Console() = default;
45 
47  class Message
48  {
49  public:
50 
52  enum class Type
53  {
54  Log = 0,
55  Normal,
56  Warning,
57  Error
58  };
59 
60  std::string text;
61  Type type;
62  };
63 
65  void post(Message const& mess) const;
66 
67  // ================================================================================ //
68  // CONSOLE LISTENER //
69  // ================================================================================ //
70 
72  class Listener
73  {
74  public:
75  virtual ~Listener() = default;
76 
78  virtual void newConsoleMessage(Console::Message const& message) = 0;
79  };
80 
82  void addListener(Listener& listener);
83 
85  void removeListener(Listener& listener);
86 
87  private: // members
88 
89  tool::Listeners<Listener> m_listeners;
90  };
91  }
92 }
kiwi::engine::Console::post
void post(Message const &mess) const
Print a post-type message in the console.
Definition: KiwiEngine_Console.cpp:32
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::engine::Console
The console is an interface that let you print messages.
Definition: KiwiEngine_Console.h:36
kiwi::engine::Console::addListener
void addListener(Listener &listener)
Adds a Console listener.
Definition: KiwiEngine_Console.cpp:37
-
kiwi::engine::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiEngine_Listeners.h:40
+
kiwi::tool::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiTool_Listeners.h:38
kiwi::engine::Console::Message::Type
Type
Type of message.
Definition: KiwiEngine_Console.h:52
kiwi::engine::Console::Message
The Console Message owns the informations of a message posted via a console.
Definition: KiwiEngine_Console.h:47
kiwi::engine::Console::Listener
You can inherit from this class to receive console changes.
Definition: KiwiEngine_Console.h:72
@@ -82,7 +106,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___dac_tilde_8h_source.html b/docs/html/_kiwi_engine___dac_tilde_8h_source.html new file mode 100644 index 00000000..825a20e3 --- /dev/null +++ b/docs/html/_kiwi_engine___dac_tilde_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DacTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_DacTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_AudioInterface.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // DAC~ //
30  // ================================================================================ //
31 
32  class DacTilde : public AudioInterfaceObject
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  DacTilde(model::Object const& model, Patcher& patcher);
41 
42  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
43 
44  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
45  };
46 }}
kiwi::engine::DacTilde
Definition: KiwiEngine_DacTilde.h:32
+
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::AudioInterfaceObject
Definition: KiwiEngine_AudioInterface.h:33
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::DacTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_DacTilde.cpp:54
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___def_8h_source.html b/docs/html/_kiwi_engine___def_8h_source.html index 99083981..8cfbfa88 100644 --- a/docs/html/_kiwi_engine___def_8h_source.html +++ b/docs/html/_kiwi_engine___def_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine/KiwiEngine_Def.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiEngine_Def.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <cstddef>
25 #include <vector>
26 #include <set>
27 #include <map>
28 #include <queue>
29 #include <exception>
30 #include <functional>
31 
32 #include <KiwiModel/KiwiModel_Atom.h>
33 
34 #include "KiwiEngine_Scheduler.h"
35 
36 namespace kiwi
37 {
38  namespace model
39  {
40  class Link;
41  class Object;
42  class Patcher;
43  }
44 
45  namespace engine
46  {
47  class Beacon;
48  class Link;
49  class Object;
50  class Patcher;
51  class Instance;
52  }
53 
54  enum Thread : engine::thread_token
55  {
56  Gui = 0,
57  Engine = 1,
58  Dsp = 2,
59  };
60 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <cstddef>
25 #include <vector>
26 #include <set>
27 #include <map>
28 #include <queue>
29 #include <exception>
30 #include <functional>
31 
32 #include <KiwiTool/KiwiTool_Atom.h>
33 
34 #include <KiwiTool/KiwiTool_Scheduler.h>
35 
36 namespace kiwi
37 {
38  namespace model
39  {
40  class Link;
41  class Object;
42  class Patcher;
43  }
44 
45  namespace engine
46  {
47  class Link;
48  class Object;
49  class Patcher;
50  class Instance;
51  }
52 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___delay_8h_source.html b/docs/html/_kiwi_engine___delay_8h_source.html new file mode 100644 index 00000000..d03d2ed8 --- /dev/null +++ b/docs/html/_kiwi_engine___delay_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Delay.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT DELAY //
30  // ================================================================================ //
31 
32  class Delay final : public engine::Object
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& object, Patcher & patcher);
39 
40  Delay(model::Object const& model, Patcher& patcher);
41 
42  ~Delay();
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override;
45 
46  void bang();
47 
48  private: // members
49 
50  std::shared_ptr<tool::Scheduler<>::CallBack> m_task;
51  tool::Scheduler<>::clock_t::duration m_delay;
52  };
53 
54 }}
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Delay
Definition: KiwiEngine_Delay.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Delay::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Delay.cpp:66
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___delay_simple_tilde_8h_source.html b/docs/html/_kiwi_engine___delay_simple_tilde_8h_source.html new file mode 100644 index 00000000..28fc0637 --- /dev/null +++ b/docs/html/_kiwi_engine___delay_simple_tilde_8h_source.html @@ -0,0 +1,113 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DelaySimpleTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_DelaySimpleTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <atomic>
25 #include <vector>
26 
27 #include <KiwiTool/KiwiTool_Scheduler.h>
28 #include <KiwiTool/KiwiTool_CircularBuffer.h>
29 
30 #include <KiwiEngine/KiwiEngine_Object.h>
31 
32 namespace kiwi { namespace engine {
33 
34  // ================================================================================ //
35  // DELAYSIMPLETILDE //
36  // ================================================================================ //
37 
38  class DelaySimpleTilde : public AudioObject, public tool::Scheduler<>::Timer
39  {
40  private: //classes
41 
42  using CircularBuffer = tool::CircularBuffer<dsp::sample_t>;
43 
44  class ReleasePool
45  {
46  public: // methods
47 
48  ReleasePool();
49 
50  ~ReleasePool();
51 
52  void add(std::shared_ptr<CircularBuffer> & buffer);
53 
54  void clear();
55 
56  private: // members
57 
58  std::vector<std::shared_ptr<CircularBuffer>> m_pool;
59  mutable std::mutex m_mutex;
60  };
61 
62  public: // methods
63 
64  static void declare();
65 
66  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
67 
68  DelaySimpleTilde(model::Object const& model, Patcher& patcher);
69 
70  ~DelaySimpleTilde();
71 
72  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
73 
74  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
75 
76  void performDelay(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
77 
78  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
79 
80  void timerCallBack() override final;
81 
82  void store(std::shared_ptr<CircularBuffer> new_buffer);
83 
84  std::shared_ptr<CircularBuffer> load();
85 
86  private: // methods
87 
88  dsp::sample_t cubicInterpolate(float const& x,
89  float const& y0,
90  float const& y1,
91  float const& y2,
92  float const& y3);
93 
94  private: // members
95 
96  std::shared_ptr<CircularBuffer> m_circular_buffer;
97  std::unique_ptr<dsp::Signal> m_reinject_signal;
98  float m_max_delay;
99  std::atomic<float> m_delay;
100  std::atomic<float> m_reinject_level;
101  dsp::sample_t m_sr;
102  ReleasePool m_pool;
103  mutable std::mutex m_mutex;
104  };
105 
106 }}
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::DelaySimpleTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_DelaySimpleTilde.cpp:103
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::DelaySimpleTilde
Definition: KiwiEngine_DelaySimpleTilde.h:38
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::tool::CircularBuffer
Definition: KiwiTool_CircularBuffer.h:37
+
kiwi::engine::DelaySimpleTilde::timerCallBack
void timerCallBack() override final
The pure virtual call back function.
Definition: KiwiEngine_DelaySimpleTilde.cpp:80
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
kiwi::engine::DelaySimpleTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_DelaySimpleTilde.cpp:210
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___different_8h_source.html b/docs/html/_kiwi_engine___different_8h_source.html new file mode 100644 index 00000000..d0be7877 --- /dev/null +++ b/docs/html/_kiwi_engine___different_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Different.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Different.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT DIFERRENT //
31  // ================================================================================ //
32 
33  class Different : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Different(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi::engine::Different
Definition: KiwiEngine_Different.h:33
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___different_tilde_8h_source.html b/docs/html/_kiwi_engine___different_tilde_8h_source.html new file mode 100644 index 00000000..9897db5e --- /dev/null +++ b/docs/html/_kiwi_engine___different_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DifferentTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_DifferentTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // !=~ //
30  // ================================================================================ //
31 
32  class DifferentTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  DifferentTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::DifferentTilde
Definition: KiwiEngine_DifferentTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___divide_8h_source.html b/docs/html/_kiwi_engine___divide_8h_source.html new file mode 100644 index 00000000..93927a40 --- /dev/null +++ b/docs/html/_kiwi_engine___divide_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Divide.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Divide.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT DIVIDE //
31  // ================================================================================ //
32 
33  class Divide : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Divide(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Divide
Definition: KiwiEngine_Divide.h:33
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___divide_tilde_8h_source.html b/docs/html/_kiwi_engine___divide_tilde_8h_source.html new file mode 100644 index 00000000..ead0b124 --- /dev/null +++ b/docs/html/_kiwi_engine___divide_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DivideTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_DivideTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // /~ //
30  // ================================================================================ //
31 
32  class DivideTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  DivideTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::DivideTilde
Definition: KiwiEngine_DivideTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___equal_8h_source.html b/docs/html/_kiwi_engine___equal_8h_source.html new file mode 100644 index 00000000..71182d88 --- /dev/null +++ b/docs/html/_kiwi_engine___equal_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Equal.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Equal.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT EQUAL //
31  // ================================================================================ //
32 
33  class Equal : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Equal(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Equal
Definition: KiwiEngine_Equal.h:33
+
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___equal_tilde_8h_source.html b/docs/html/_kiwi_engine___equal_tilde_8h_source.html new file mode 100644 index 00000000..1daf93d0 --- /dev/null +++ b/docs/html/_kiwi_engine___equal_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_EqualTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_EqualTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // ==~ //
30  // ================================================================================ //
31 
32  class EqualTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  EqualTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::EqualTilde
Definition: KiwiEngine_EqualTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___error_box_8h_source.html b/docs/html/_kiwi_engine___error_box_8h_source.html new file mode 100644 index 00000000..bb530a00 --- /dev/null +++ b/docs/html/_kiwi_engine___error_box_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ErrorBox.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_ErrorBox.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // ERRORBOX //
30  // ================================================================================ //
31 
32  class ErrorBox : public AudioObject
33  {
34  public:
35 
36  ErrorBox(model::Object const& model, Patcher& patcher);
37 
38  void receive(size_t index, std::vector<tool::Atom> const& args) override;
39 
40  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
41 
42  static void declare();
43 
44  static std::unique_ptr<Object> create(model::Object const& object, Patcher& patcher);
45  };
46 
47 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::ErrorBox::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_ErrorBox.cpp:48
+
kiwi::engine::ErrorBox::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_ErrorBox.cpp:53
+
kiwi::engine::ErrorBox
Definition: KiwiEngine_ErrorBox.h:32
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___factory_8h_source.html b/docs/html/_kiwi_engine___factory_8h_source.html index 555cdb75..18da513c 100644 --- a/docs/html/_kiwi_engine___factory_8h_source.html +++ b/docs/html/_kiwi_engine___factory_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine/KiwiEngine_Factory.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiEngine_Factory.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiEngine_Def.h"
25 
26 namespace kiwi
27 {
28  namespace engine
29  {
30  // ================================================================================ //
31  // OBJECT FACTORY //
32  // ================================================================================ //
33 
35  class Factory
36  {
37  public: // methods
38 
44  template <class TEngine,
45  typename std::enable_if<std::is_base_of<Object, TEngine>::value,
46  Object>::type* = nullptr>
47  static void add(std::string const& name)
48  {
49  static_assert(!std::is_abstract<TEngine>::value,
50  "The engine object must not be abstract.");
51 
52  static_assert(std::is_constructible<TEngine,
53  model::Object const&, Patcher&, std::vector<Atom> const&>::value,
54  "The engine object must have a valid constructor.");
55 
56  assert(!name.empty());
57  assert(modelHasObject(name) && "The model counterpart does not exist");
58 
59  auto& creators = getCreators();
60  assert(creators.count(name) == 0 && "The object already exists");
61 
62  creators[name] = [](model::Object const& model,
63  Patcher& patcher,
64  std::vector<Atom> const& args) -> TEngine*
65  {
66  return new TEngine(model, patcher, args);
67  };
68  }
69 
73  static std::unique_ptr<Object> create(Patcher& patcher, model::Object const& model);
74 
78  static bool has(std::string const& name);
79 
80  private: // methods
81 
82  static bool modelHasObject(std::string const& name);
83 
84  using ctor_fn_t = std::function<Object*(model::Object const& model,
85  Patcher& patcher,
86  std::vector<Atom> const&)>;
87 
88  using creator_map_t = std::map<std::string, ctor_fn_t>;
89 
91  static creator_map_t& getCreators();
92 
93  private: // deleted methods
94 
95  Factory() = delete;
96  ~Factory() = delete;
97  };
98  }
99 }
kiwi::engine::Factory::has
static bool has(std::string const &name)
Returns true if a given string match a registered Object name.
Definition: KiwiEngine_Factory.cpp:45
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <functional>
25 #include <map>
26 #include <string>
27 #include <memory>
28 
29 #include <KiwiEngine/KiwiEngine_Object.h>
30 
31 namespace kiwi
32 {
33  namespace engine
34  {
35  // ================================================================================ //
36  // OBJECT FACTORY //
37  // ================================================================================ //
38 
40  class Factory
41  {
42  public: // classes
43 
44  using ctor_fn_t = std::function<std::unique_ptr<Object>(model::Object const& model, Patcher& patcher)>;
45 
46  public: // methods
47 
53  template <class TEngine,
54  typename std::enable_if<std::is_base_of<Object, TEngine>::value,
55  Object>::type* = nullptr>
56  static void add(std::string const& name, ctor_fn_t create_method)
57  {
58  static_assert(!std::is_abstract<TEngine>::value,
59  "The engine object must not be abstract.");
60 
61  static_assert(std::is_constructible<TEngine,
62  model::Object const&, Patcher&>::value,
63  "The engine object must have a valid constructor.");
64 
65  assert(!name.empty());
66  assert(modelHasObject(name) && "The model counterpart does not exist");
67 
68  assert(m_creators.count(name) == 0 && "The object already exists");
69 
70  m_creators[name] = create_method;
71  }
72 
76  static std::unique_ptr<Object> create(Patcher& patcher, model::Object const& model);
77 
81  static bool has(std::string const& name);
82 
83  private: // methods
84 
85  static bool modelHasObject(std::string const& name);
86 
87  static std::map<std::string, ctor_fn_t> m_creators;
88 
89  private: // deleted methods
90 
91  Factory() = delete;
92  ~Factory() = delete;
93  };
94  }
95 }
kiwi::engine::Factory::has
static bool has(std::string const &name)
Returns true if a given string match a registered Object name.
Definition: KiwiEngine_Factory.cpp:43
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::engine::Factory::create
static std::unique_ptr< Object > create(Patcher &patcher, model::Object const &model)
Creates a new engine Object.
Definition: KiwiEngine_Factory.cpp:35
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::engine::Factory::add
static void add(std::string const &name)
Adds an object engine into the Factory.
Definition: KiwiEngine_Factory.h:47
-
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:37
-
kiwi::engine::Factory
The engine Object&#39;s factory.
Definition: KiwiEngine_Factory.h:35
-
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:42
+
kiwi::engine::Factory::add
static void add(std::string const &name, ctor_fn_t create_method)
Adds an object engine into the Factory.
Definition: KiwiEngine_Factory.h:56
+
kiwi::engine::Factory::create
static std::unique_ptr< Object > create(Patcher &patcher, model::Object const &model)
Creates a new engine Object.
Definition: KiwiEngine_Factory.cpp:37
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Factory
The engine Object&#39;s factory.
Definition: KiwiEngine_Factory.h:40
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___float_8h_source.html b/docs/html/_kiwi_engine___float_8h_source.html new file mode 100644 index 00000000..b763f875 --- /dev/null +++ b/docs/html/_kiwi_engine___float_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Float.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // FLOAT //
30  // ================================================================================ //
31 
32  class Float : public Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
39 
40  Float(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
43 
44  private:
45 
46  double m_stored_value;
47  };
48 }}
kiwi::engine::Float
Definition: KiwiEngine_Float.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Float::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Float.cpp:54
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___gate_8h_source.html b/docs/html/_kiwi_engine___gate_8h_source.html new file mode 100644 index 00000000..8fe60b18 --- /dev/null +++ b/docs/html/_kiwi_engine___gate_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Gate.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // GATE //
30  // ================================================================================ //
31 
32  class Gate : public engine::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Gate(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override;
43 
44  private:
45 
46  void openOutput(int output);
47 
48  private:
49 
50  size_t m_opened_output;
51  size_t m_num_outputs;
52  };
53 
54 }}
kiwi::engine::Gate
Definition: KiwiEngine_Gate.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Gate::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Gate.cpp:59
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___gate_tilde_8h_source.html b/docs/html/_kiwi_engine___gate_tilde_8h_source.html new file mode 100644 index 00000000..cc634b06 --- /dev/null +++ b/docs/html/_kiwi_engine___gate_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_GateTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiDsp/KiwiDsp_Signal.h>
25 
26 #include <KiwiEngine/KiwiEngine_Object.h>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // GATE~ //
32  // ================================================================================ //
33 
34  class GateTilde : public AudioObject
35  {
36  public:
37 
38  static void declare();
39 
40  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
41 
42  GateTilde(model::Object const& model, Patcher& patcher);
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
45 
46  void prepare(PrepareInfo const& infos) override final;
47 
48  void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
49 
50  void performSig(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
51 
52  private:
53 
54  void openOutput(int output);
55 
56  private:
57 
58  size_t m_opened_output;
59  size_t m_num_outputs;
60  };
61 
62 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::GateTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_GateTilde.cpp:60
+
kiwi::engine::GateTilde::prepare
void prepare(PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_GateTilde.cpp:78
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::GateTilde
Definition: KiwiEngine_GateTilde.h:34
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___greater_8h_source.html b/docs/html/_kiwi_engine___greater_8h_source.html new file mode 100644 index 00000000..62fbcce6 --- /dev/null +++ b/docs/html/_kiwi_engine___greater_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Greater.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Greater.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT GREATER //
31  // ================================================================================ //
32 
33  class Greater : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Greater(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Greater
Definition: KiwiEngine_Greater.h:33
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___greater_equal_8h_source.html b/docs/html/_kiwi_engine___greater_equal_8h_source.html new file mode 100644 index 00000000..53e07949 --- /dev/null +++ b/docs/html/_kiwi_engine___greater_equal_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterEqual.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_GreaterEqual.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT GREATEREQUAL //
31  // ================================================================================ //
32 
33  class GreaterEqual : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  GreaterEqual(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::GreaterEqual
Definition: KiwiEngine_GreaterEqual.h:33
+
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___greater_equal_tilde_8h_source.html b/docs/html/_kiwi_engine___greater_equal_tilde_8h_source.html new file mode 100644 index 00000000..3ccde760 --- /dev/null +++ b/docs/html/_kiwi_engine___greater_equal_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterEqualTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_GreaterEqualTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // >=~ //
30  // ================================================================================ //
31 
32  class GreaterEqualTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  GreaterEqualTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::GreaterEqualTilde
Definition: KiwiEngine_GreaterEqualTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___greater_tilde_8h_source.html b/docs/html/_kiwi_engine___greater_tilde_8h_source.html new file mode 100644 index 00000000..5e65a95b --- /dev/null +++ b/docs/html/_kiwi_engine___greater_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_GreaterTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // >~ //
30  // ================================================================================ //
31 
32  class GreaterTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  GreaterTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::GreaterTilde
Definition: KiwiEngine_GreaterTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___hub_8h_source.html b/docs/html/_kiwi_engine___hub_8h_source.html new file mode 100644 index 00000000..5607cb0a --- /dev/null +++ b/docs/html/_kiwi_engine___hub_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Hub.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Hub.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT HUB //
30  // ================================================================================ //
31 
32  class Hub : public engine::Object
33  {
34  public: // methods
35 
36  Hub(model::Object const& model, Patcher& patcher);
37 
38  ~Hub();
39 
40  void attributeChanged(std::string const& name, tool::Parameter const& param) override final;
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
43 
44  static void declare();
45 
46  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
47  };
48 
49 }}
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Hub::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Hub.cpp:61
+
kiwi::engine::Hub::attributeChanged
void attributeChanged(std::string const &name, tool::Parameter const &param) override final
Called once one of the data model&#39;s attributes has changed.
Definition: KiwiEngine_Hub.cpp:53
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Hub
Definition: KiwiEngine_Hub.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___instance_8h_source.html b/docs/html/_kiwi_engine___instance_8h_source.html index ca56217e..39324567 100644 --- a/docs/html/_kiwi_engine___instance_8h_source.html +++ b/docs/html/_kiwi_engine___instance_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine/KiwiEngine_Instance.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiEngine_Instance.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "flip/Document.h"
25 
26 #include "KiwiEngine_Console.h"
27 #include "KiwiEngine_Patcher.h"
28 #include "KiwiEngine_Beacon.h"
29 #include "KiwiEngine_AudioControler.h"
30 
31 namespace kiwi
32 {
33  namespace engine
34  {
35  // ================================================================================ //
36  // INSTANCE //
37  // ================================================================================ //
38 
42  class Instance : public Beacon::Factory
43  {
44  public: // methods
45 
47  Instance(std::unique_ptr<AudioControler> audio_controler);
48 
50  ~Instance();
51 
52  // ================================================================================ //
53  // CONSOLE //
54  // ================================================================================ //
55 
57  void log(std::string const& text) const;
58 
60  void post(std::string const& text) const;
61 
63  void warning(std::string const& text) const;
64 
66  void error(std::string const& text) const;
67 
69  void addConsoleListener(Console::Listener& listener);
70 
72  void removeConsoleListener(Console::Listener& listener);
73 
74  // ================================================================================ //
75  // AUDIO CONTROLER //
76  // ================================================================================ //
77 
78  AudioControler& getAudioControler() const;
79 
80  private: // methods
81 
83  void addObjectsToFactory();
84 
85  private: // members
86 
87  Console m_console;
88 
89  std::unique_ptr<AudioControler> m_audio_controler;
90 
91  private: // deleted methods
92 
93  Instance(Instance const&) = delete;
94  Instance(Instance&&) = delete;
95  Instance& operator=(Instance const&) = delete;
96  Instance& operator=(Instance&&) = delete;
97  };
98  }
99 }
kiwi::engine::Instance::post
void post(std::string const &text) const
post a message in the Console.
Definition: KiwiEngine_Instance.cpp:54
-
kiwi::engine::Instance::warning
void warning(std::string const &text) const
post a warning message in the Console.
Definition: KiwiEngine_Instance.cpp:59
-
kiwi::engine::Instance::log
void log(std::string const &text) const
post a log message in the Console.
Definition: KiwiEngine_Instance.cpp:49
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <thread>
25 #include <atomic>
26 
27 #include "flip/Document.h"
28 
29 #include <KiwiTool/KiwiTool_Beacon.h>
30 
31 #include "KiwiEngine_Console.h"
32 #include "KiwiEngine_Patcher.h"
33 #include "KiwiEngine_AudioControler.h"
34 
35 namespace kiwi
36 {
37  namespace engine
38  {
39  // ================================================================================ //
40  // INSTANCE //
41  // ================================================================================ //
42 
46  class Instance : public tool::Beacon::Factory
47  {
48  public: // methods
49 
51  Instance(std::unique_ptr<AudioControler> audio_controler, tool::Scheduler<> & main_scheduler);
52 
54  ~Instance();
55 
56  // ================================================================================ //
57  // CONSOLE //
58  // ================================================================================ //
59 
61  void log(std::string const& text) const;
62 
64  void post(std::string const& text) const;
65 
67  void warning(std::string const& text) const;
68 
70  void error(std::string const& text) const;
71 
73  void addConsoleListener(Console::Listener& listener);
74 
76  void removeConsoleListener(Console::Listener& listener);
77 
78  // ================================================================================ //
79  // AUDIO CONTROLER //
80  // ================================================================================ //
81 
82  AudioControler& getAudioControler() const;
83 
84  // ================================================================================ //
85  // SCHEDULER //
86  // ================================================================================ //
87 
89  tool::Scheduler<> & getScheduler();
90 
92  tool::Scheduler<> & getMainScheduler();
93 
94  private: // methods
95 
97  void processScheduler();
98 
99  private: // members
100 
101  Console m_console;
102 
103  std::unique_ptr<AudioControler> m_audio_controler;
104  tool::Scheduler<> m_scheduler;
105  tool::Scheduler<>& m_main_scheduler;
106  std::atomic<bool> m_quit;
107  std::thread m_engine_thread;
108 
109  private: // deleted methods
110 
111  Instance(Instance const&) = delete;
112  Instance(Instance&&) = delete;
113  Instance& operator=(Instance const&) = delete;
114  Instance& operator=(Instance&&) = delete;
115  };
116  }
117 }
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::engine::Instance::log
void log(std::string const &text) const
post a log message in the Console.
Definition: KiwiEngine_Instance.cpp:52
kiwi::engine::AudioControler
AudioControler is a pure interface that enable controling audio in kiwi.
Definition: KiwiEngine_AudioControler.h:35
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::engine::Console
The console is an interface that let you print messages.
Definition: KiwiEngine_Console.h:36
-
kiwi::engine::Instance::addConsoleListener
void addConsoleListener(Console::Listener &listener)
Adds a console listener.
Definition: KiwiEngine_Instance.cpp:69
-
kiwi::engine::Instance::removeConsoleListener
void removeConsoleListener(Console::Listener &listener)
Removes a console listener.
Definition: KiwiEngine_Instance.cpp:74
-
kiwi::engine::Instance::error
void error(std::string const &text) const
post an error message in the Console.
Definition: KiwiEngine_Instance.cpp:64
-
kiwi::engine::Beacon::Factory
The beacon factory is used to create beacons.
Definition: KiwiEngine_Beacon.h:83
-
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:42
-
kiwi::engine::Instance::Instance
Instance(std::unique_ptr< AudioControler > audio_controler)
Constructs an Instance and adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.cpp:34
+
kiwi::engine::Instance::warning
void warning(std::string const &text) const
post a warning message in the Console.
Definition: KiwiEngine_Instance.cpp:62
+
kiwi::engine::Instance::addConsoleListener
void addConsoleListener(Console::Listener &listener)
Adds a console listener.
Definition: KiwiEngine_Instance.cpp:72
+
kiwi::engine::Instance::removeConsoleListener
void removeConsoleListener(Console::Listener &listener)
Removes a console listener.
Definition: KiwiEngine_Instance.cpp:77
+
kiwi::engine::Instance::getScheduler
tool::Scheduler & getScheduler()
Returns the engine&#39;s scheduler.
Definition: KiwiEngine_Instance.cpp:95
+
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:46
+
kiwi::engine::Instance::error
void error(std::string const &text) const
post an error message in the Console.
Definition: KiwiEngine_Instance.cpp:67
+
kiwi::engine::Instance::Instance
Instance(std::unique_ptr< AudioControler > audio_controler, tool::Scheduler<> &main_scheduler)
Constructs an Instance and adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.cpp:33
+
kiwi::engine::Instance::getMainScheduler
tool::Scheduler & getMainScheduler()
Returns the main&#39;s scheduler.
Definition: KiwiEngine_Instance.cpp:100
+
kiwi::engine::Instance::post
void post(std::string const &text) const
post a message in the Console.
Definition: KiwiEngine_Instance.cpp:57
kiwi::engine::Console::Listener
You can inherit from this class to receive console changes.
Definition: KiwiEngine_Console.h:72
-
kiwi::engine::Instance::~Instance
~Instance()
Destructor.
Definition: KiwiEngine_Instance.cpp:40
+
kiwi::tool::Beacon::Factory
The beacon factory is used to create beacons.
Definition: KiwiTool_Beacon.h:85
+
kiwi::engine::Instance::~Instance
~Instance()
Destructor.
Definition: KiwiEngine_Instance.cpp:42
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___less_8h_source.html b/docs/html/_kiwi_engine___less_8h_source.html new file mode 100644 index 00000000..b5a34790 --- /dev/null +++ b/docs/html/_kiwi_engine___less_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Less.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Less.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT LESS //
31  // ================================================================================ //
32 
33  class Less : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Less(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Less
Definition: KiwiEngine_Less.h:33
+
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___less_equal_8h_source.html b/docs/html/_kiwi_engine___less_equal_8h_source.html new file mode 100644 index 00000000..eabf89f2 --- /dev/null +++ b/docs/html/_kiwi_engine___less_equal_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessEqual.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_LessEqual.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT LESSEQUAL //
31  // ================================================================================ //
32 
33  class LessEqual : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  LessEqual(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi::engine::LessEqual
Definition: KiwiEngine_LessEqual.h:33
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___less_equal_tilde_8h_source.html b/docs/html/_kiwi_engine___less_equal_tilde_8h_source.html new file mode 100644 index 00000000..b8a04e36 --- /dev/null +++ b/docs/html/_kiwi_engine___less_equal_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessEqualTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_LessEqualTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // <=~ //
30  // ================================================================================ //
31 
32  class LessEqualTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  LessEqualTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::LessEqualTilde
Definition: KiwiEngine_LessEqualTilde.h:32
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___less_tilde_8h_source.html b/docs/html/_kiwi_engine___less_tilde_8h_source.html new file mode 100644 index 00000000..55f6f289 --- /dev/null +++ b/docs/html/_kiwi_engine___less_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_LessTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // <~ //
30  // ================================================================================ //
31 
32  class LessTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  LessTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::LessTilde
Definition: KiwiEngine_LessTilde.h:32
+
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___line_tilde_8h_source.html b/docs/html/_kiwi_engine___line_tilde_8h_source.html new file mode 100644 index 00000000..d8780d41 --- /dev/null +++ b/docs/html/_kiwi_engine___line_tilde_8h_source.html @@ -0,0 +1,118 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LineTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_LineTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 #include <queue>
27 
28 namespace kiwi { namespace engine {
29 
30  class Ramp
31  {
32  public: // classes
33 
34  struct ValueTimePair
35  {
36  ValueTimePair(dsp::sample_t value_,
37  dsp::sample_t time_ms_)
38  : value(value_)
39  , time_ms(time_ms_)
40  {
41  assert(time_ms_ >= 0.);
42  }
43 
44  dsp::sample_t value;
45  dsp::sample_t time_ms;
46  };
47 
48  public: // methods
49 
51  Ramp(dsp::sample_t start = 0) noexcept;
52 
56  void setSampleRate(double sample_rate) noexcept;
57 
61  void setEndOfRampCallback(std::function<void()> callback);
62 
65  void setValueDirect(dsp::sample_t new_value) noexcept;
66 
69  void setValueTimePairs(std::vector<ValueTimePair> value_time_pairs);
70 
73  dsp::sample_t getNextValue() noexcept;
74 
76  dsp::sample_t getValue() noexcept;
77 
78  private: // methods
79 
80  void reset();
81  void setNextValueTime(ValueTimePair const& value_time_pair) noexcept;
82  void triggerNextRamp();
83 
84  private: // variables
85 
86  std::mutex m_lock;
87  double m_sr = 0.;
88  dsp::sample_t m_current_value = 0, m_destination_value = 0, m_step = 0;
89  int m_countdown = 0, m_steps_to_destination = 0;
90 
91  std::vector<ValueTimePair> m_value_time_pairs {};
92  size_t m_valuetime_pairs_countdown = 0;
93 
94  std::function<void()> m_ramp_ended_callback = nullptr;
95  bool m_should_notify_end {false};
96  };
97 
98  // ================================================================================ //
99  // LINE~ //
100  // ================================================================================ //
101 
102  class LineTilde : public AudioObject
103  {
104  public: // methods
105 
106  static void declare();
107 
108  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
109 
110  LineTilde(model::Object const& model, Patcher& patcher);
111 
112  ~LineTilde();
113 
114  void receive(size_t index, std::vector<tool::Atom> const& args) override;
115 
116  void prepare(dsp::Processor::PrepareInfo const& infos) override;
117 
118  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
119 
120  private: // methods
121 
122  std::vector<Ramp::ValueTimePair> parseAtomsAsValueTimePairs(std::vector<tool::Atom> const& atoms) const;
123 
124  private: // variables
125 
126  class BangTask;
127  std::shared_ptr<BangTask> m_bang_task;
128 
129  double m_next_ramp_time_ms;
130  bool m_next_ramp_time_consumed;
131 
132  Ramp m_ramp;
133  };
134 
135 }}
kiwi::engine::LineTilde
Definition: KiwiEngine_LineTilde.h:102
+
kiwi::engine::Ramp::setEndOfRampCallback
void setEndOfRampCallback(std::function< void()> callback)
Set the function to call when the ramp reached its final destination.
Definition: KiwiEngine_LineTilde.cpp:43
+
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::Ramp::getValue
dsp::sample_t getValue() noexcept
Returns the current value.
Definition: KiwiEngine_LineTilde.cpp:81
+
kiwi::engine::Ramp
Definition: KiwiEngine_LineTilde.h:30
+
kiwi::engine::Ramp::getNextValue
dsp::sample_t getNextValue() noexcept
Compute and returns the next value.
Definition: KiwiEngine_LineTilde.cpp:65
+
kiwi::engine::Ramp::setSampleRate
void setSampleRate(double sample_rate) noexcept
Set sample rate.
Definition: KiwiEngine_LineTilde.cpp:37
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Ramp::setValueDirect
void setValueDirect(dsp::sample_t new_value) noexcept
Set a new value directly.
Definition: KiwiEngine_LineTilde.cpp:48
+
kiwi::engine::LineTilde::BangTask
Definition: KiwiEngine_LineTilde.cpp:133
+
kiwi::engine::Ramp::ValueTimePair
Definition: KiwiEngine_LineTilde.h:34
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Ramp::Ramp
Ramp(dsp::sample_t start=0) noexcept
Constructor.
Definition: KiwiEngine_LineTilde.cpp:31
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Ramp::setValueTimePairs
void setValueTimePairs(std::vector< ValueTimePair > value_time_pairs)
Resets the value-time pairs of the ramp.
Definition: KiwiEngine_LineTilde.cpp:57
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___link_8h_source.html b/docs/html/_kiwi_engine___link_8h_source.html index 5396778a..1ee376ca 100644 --- a/docs/html/_kiwi_engine___link_8h_source.html +++ b/docs/html/_kiwi_engine___link_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine/KiwiEngine_Link.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiEngine_Link.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiEngine_Def.h"
25 
26 namespace kiwi
27 {
28  namespace engine
29  {
30  // ================================================================================ //
31  // LINK //
32  // ================================================================================ //
33 
35  class Link
36  {
37  public: // methods
38 
40  Link(Object & receiver, size_t index);
41 
43  Link(Link const& other) = default;
44 
46  Link(Link && other) = default;
47 
49  ~Link() = default;
50 
52  bool operator<(Link const& other) const;
53 
55  Object & getReceiver() const;
56 
58  size_t getReceiverIndex() const;
59 
60  private: // members
61 
62  engine::Object & m_receiver;
63  size_t m_index;
64 
65  private: // deleted methods
66 
67  Link& operator=(Link const&) = delete;
68  Link& operator=(Link&&) = delete;
69  };
70  }
71 }
- - - +
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiEngine_Def.h"
25 
26 namespace kiwi
27 {
28  namespace engine
29  {
30  // ================================================================================ //
31  // LINK //
32  // ================================================================================ //
33 
35  class Link
36  {
37  public: // methods
38 
40  Link(Object & receiver, size_t index);
41 
43  Link(Link const& other) = default;
44 
46  Link(Link && other) = default;
47 
49  ~Link() = default;
50 
52  bool operator<(Link const& other) const;
53 
55  Object & getReceiver() const;
56 
58  size_t getReceiverIndex() const;
59 
60  private: // members
61 
62  engine::Object & m_receiver;
63  size_t m_index;
64 
65  private: // deleted methods
66 
67  Link& operator=(Link const&) = delete;
68  Link& operator=(Link&&) = delete;
69  };
70  }
71 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:37
+ + +
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___loadmess_8h_source.html b/docs/html/_kiwi_engine___loadmess_8h_source.html new file mode 100644 index 00000000..a8cccdc1 --- /dev/null +++ b/docs/html/_kiwi_engine___loadmess_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Loadmess.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Loadmess.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT LOADMESS //
30  // ================================================================================ //
31 
32  class Loadmess : public engine::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Loadmess(model::Object const& model, Patcher& patcher);
41 
42  ~Loadmess() = default;
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override;
45 
46  void loadbang() override;
47 
48  private:
49 
50  const std::vector<tool::Atom> m_args;
51  };
52 
53 }}
kiwi::engine::Loadmess
Definition: KiwiEngine_Loadmess.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Loadmess::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Loadmess.cpp:47
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Loadmess::loadbang
void loadbang() override
Called when the Patcher is loaded.
Definition: KiwiEngine_Loadmess.cpp:59
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___message_8h_source.html b/docs/html/_kiwi_engine___message_8h_source.html new file mode 100644 index 00000000..48e95b8a --- /dev/null +++ b/docs/html/_kiwi_engine___message_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Message.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Message.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 #include <array>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // OBJECT MESSAGE //
32  // ================================================================================ //
33 
34  class Message : public engine::Object
35  {
36  public: // methods
37 
38  Message(model::Object const& model, Patcher& patcher);
39 
40  ~Message();
41 
42  void attributeChanged(std::string const& name, tool::Parameter const& param) override final;
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
45 
46  void outputMessage();
47 
48  static void declare();
49 
50  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
51 
52  private: // members
53 
54  void sendMessages();
55  void prepareMessagesForText(std::string const& text);
56 
57  flip::SignalConnection m_connection;
58  std::array<tool::Atom, 10> m_input_args {};
59 
60  struct Sequence
61  {
62  Sequence(std::vector<tool::Atom>&& _atoms, bool _has_dollar)
63  : atoms(_atoms), has_dollar(_has_dollar)
64  {}
65 
66  ~Sequence() = default;
67 
68  const std::vector<tool::Atom> atoms {};
69  const bool has_dollar = false;
70  };
71 
72  std::vector<Sequence> m_messages {};
73  };
74 
75 }}
kiwi::engine::Message::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Message.cpp:78
+
kiwi::engine::Message
Definition: KiwiEngine_Message.h:34
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi::engine::Message::attributeChanged
void attributeChanged(std::string const &name, tool::Parameter const &param) override final
Called once one of the data model&#39;s attributes has changed.
Definition: KiwiEngine_Message.cpp:64
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___meter_tilde_8h_source.html b/docs/html/_kiwi_engine___meter_tilde_8h_source.html new file mode 100644 index 00000000..a6342566 --- /dev/null +++ b/docs/html/_kiwi_engine___meter_tilde_8h_source.html @@ -0,0 +1,113 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_MeterTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_MeterTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <atomic>
25 #include <chrono>
26 
27 #include <KiwiTool/KiwiTool_Scheduler.h>
28 
29 #include <KiwiEngine/KiwiEngine_Object.h>
30 
31 namespace kiwi { namespace engine {
32 
34  // METER~ //
35  // ================================================================================ //
36 
37  class MeterTilde : public engine::AudioObject, tool::Scheduler<>::Timer
38  {
39  public: // usings
40 
41  using clock_t = std::chrono::high_resolution_clock;
42 
43  public: // methods
44 
45  static void declare();
46 
47  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
48 
49  MeterTilde(model::Object const& model, Patcher& patcher);
50 
51  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
52 
53  void perform(dsp::Buffer const& intput, dsp::Buffer& output);
54 
55  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
56 
57  void release() override final;
58 
59  void timerCallBack() override final;
60 
61  private: // members
62 
63  size_t m_interval;
64  dsp::sample_t m_current_peak;
65  size_t m_sample_index;
66  size_t m_target_sample_index;
67  std::atomic<float> m_last_peak;
68  std::atomic<bool> m_uptodate;
69  flip::Signal<float> & m_signal;
70  };
71 }
72 }
kiwi::engine::MeterTilde
================================================================================ // ...
Definition: KiwiEngine_MeterTilde.h:37
+
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::MeterTilde::timerCallBack
void timerCallBack() override final
The pure virtual call back function.
Definition: KiwiEngine_MeterTilde.cpp:79
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::MeterTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_MeterTilde.cpp:56
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::MeterTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_MeterTilde.cpp:96
+
kiwi::engine::MeterTilde::release
void release() override final
Releases everything after the digital signal processing.
Definition: KiwiEngine_MeterTilde.cpp:91
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___metro_8h_source.html b/docs/html/_kiwi_engine___metro_8h_source.html new file mode 100644 index 00000000..be3bf232 --- /dev/null +++ b/docs/html/_kiwi_engine___metro_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Metro.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Metro.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT METRO //
30  // ================================================================================ //
31 
32  class Metro final : public engine::Object
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Metro(model::Object const& model, Patcher& patcher);
41 
42  ~Metro();
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override;
45 
46  void timerCallBack();
47 
48  private: // members
49 
50  tool::Scheduler<>::duration_t m_period;
51  std::shared_ptr<tool::Scheduler<>::CallBack> m_task;
52  };
53 
54 }}
kiwi::engine::Metro
Definition: KiwiEngine_Metro.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Metro::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Metro.cpp:59
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___minus_8h_source.html b/docs/html/_kiwi_engine___minus_8h_source.html new file mode 100644 index 00000000..f4ff9c5f --- /dev/null +++ b/docs/html/_kiwi_engine___minus_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Minus.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Minus.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT MINUS //
31  // ================================================================================ //
32 
33  class Minus : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Minus(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Minus
Definition: KiwiEngine_Minus.h:33
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___minus_tilde_8h_source.html b/docs/html/_kiwi_engine___minus_tilde_8h_source.html new file mode 100644 index 00000000..d5f9b09e --- /dev/null +++ b/docs/html/_kiwi_engine___minus_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_MinusTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_MinusTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // -~ //
30  // ================================================================================ //
31 
32  class MinusTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  MinusTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::MinusTilde
Definition: KiwiEngine_MinusTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___modulo_8h_source.html b/docs/html/_kiwi_engine___modulo_8h_source.html new file mode 100644 index 00000000..66d96f90 --- /dev/null +++ b/docs/html/_kiwi_engine___modulo_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Modulo.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Modulo.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT MODULO //
31  // ================================================================================ //
32 
33  class Modulo : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Modulo(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi::engine::Modulo
Definition: KiwiEngine_Modulo.h:33
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___mtof_8h_source.html b/docs/html/_kiwi_engine___mtof_8h_source.html new file mode 100644 index 00000000..7e3cd02a --- /dev/null +++ b/docs/html/_kiwi_engine___mtof_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Mtof.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Mtof.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // MTOF //
30  // ================================================================================ //
31 
32  class Mtof : public engine::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Mtof(model::Object const& model, Patcher& patcher);
41 
42  Mtof() = default;
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override;
45  };
46 
47 }}
kiwi::engine::Mtof::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Mtof.cpp:48
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Mtof
Definition: KiwiEngine_Mtof.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___new_box_8h_source.html b/docs/html/_kiwi_engine___new_box_8h_source.html new file mode 100644 index 00000000..9878828a --- /dev/null +++ b/docs/html/_kiwi_engine___new_box_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NewBox.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_NewBox.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // NEWBOX //
30  // ================================================================================ //
31 
32  class NewBox : public engine::Object
33  {
34  public: // methods
35 
36  NewBox(model::Object const& model, Patcher& patcher);
37 
38  void receive(size_t index, std::vector<tool::Atom> const& args) override;
39 
40  static void declare();
41 
42  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::NewBox::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_NewBox.cpp:48
+
kiwi::engine::NewBox
Definition: KiwiEngine_NewBox.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___noise_tilde_8h_source.html b/docs/html/_kiwi_engine___noise_tilde_8h_source.html new file mode 100644 index 00000000..e84669fb --- /dev/null +++ b/docs/html/_kiwi_engine___noise_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NoiseTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_NoiseTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 #include <random>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // NOISE~ //
32  // ================================================================================ //
33 
34  class NoiseTilde : public AudioObject
35  {
36  public: // methods
37 
38  static void declare();
39 
40  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
41 
42  NoiseTilde(model::Object const& model, Patcher& patcher);
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
45 
46  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
47 
48  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
49 
50  private: // members
51 
52  std::random_device m_random_devive;
53  std::mt19937 m_random_generator;
54  std::uniform_real_distribution<dsp::sample_t> m_random_distribution;
55  };
56 
57 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::NoiseTilde
Definition: KiwiEngine_NoiseTilde.h:34
+
kiwi::engine::NoiseTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_NoiseTilde.cpp:69
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
kiwi::engine::NoiseTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_NoiseTilde.cpp:53
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___number_8h_source.html b/docs/html/_kiwi_engine___number_8h_source.html new file mode 100644 index 00000000..ed81bdf2 --- /dev/null +++ b/docs/html/_kiwi_engine___number_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Number.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Number.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT NUMBER //
30  // ================================================================================ //
31 
32  class Number : public engine::Object
33  {
34  public: // methods
35 
36  Number(model::Object const& model, Patcher& patcher);
37 
38  void parameterChanged(std::string const& name, tool::Parameter const& param) override final;
39 
40  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
41 
42  static void declare();
43 
44  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
45 
46  private: // methods
47 
48  void outputValue();
49 
50  private: // members
51 
52  double m_value;
53  flip::SignalConnection m_connection;
54  };
55 
56 }}
kiwi::engine::Number::parameterChanged
void parameterChanged(std::string const &name, tool::Parameter const &param) override final
Called once the data model&#39;s parameters has changed.
Definition: KiwiEngine_Number.cpp:51
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Number
Definition: KiwiEngine_Number.h:32
+
kiwi::engine::Number::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Number.cpp:68
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___number_tilde_8h_source.html b/docs/html/_kiwi_engine___number_tilde_8h_source.html new file mode 100644 index 00000000..eeb205be --- /dev/null +++ b/docs/html/_kiwi_engine___number_tilde_8h_source.html @@ -0,0 +1,111 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NumberTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_NumberTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Scheduler.h>
25 
26 #include <KiwiEngine/KiwiEngine_Object.h>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // OBJECT NUMBER TILDE //
32  // ================================================================================ //
33 
34  class NumberTilde : public engine::AudioObject, tool::Scheduler<>::Timer
35  {
36  public: // methods
37 
38  NumberTilde(model::Object const& model, Patcher& patcher);
39 
40  void perform(dsp::Buffer const& intput, dsp::Buffer& output);
41 
42  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
43 
44  void release() override final;
45 
46  static void declare();
47 
48  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
49 
50  private: // methods
51 
52  void timerCallBack() override final;
53 
54  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
55 
56  private: // members
57 
58  std::atomic<dsp::sample_t> m_value;
59  size_t m_interval;
60  };
61 
62 }}
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::NumberTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_NumberTilde.cpp:56
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::NumberTilde
Definition: KiwiEngine_NumberTilde.h:34
+
kiwi::engine::NumberTilde::release
void release() override final
Releases everything after the digital signal processing.
Definition: KiwiEngine_NumberTilde.cpp:66
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___object_8h_source.html b/docs/html/_kiwi_engine___object_8h_source.html index 8a585458..1ad0fdde 100644 --- a/docs/html/_kiwi_engine___object_8h_source.html +++ b/docs/html/_kiwi_engine___object_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine/KiwiEngine_Object.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiEngine_Object.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiEngine_Def.h"
25 
26 #include <KiwiDsp/KiwiDsp_Processor.h>
27 
28 namespace kiwi
29 {
30  namespace engine
31  {
32  // ================================================================================ //
33  // OBJECT //
34  // ================================================================================ //
35 
37  class Object
38  {
39  public: // methods
40 
42  Object(model::Object const& model, Patcher& patcher) noexcept;
43 
45  virtual ~Object() noexcept;
46 
50  virtual void receive(size_t index, std::vector<Atom> const& args) = 0;
51 
53  virtual void loadbang() {};
54 
56  void addOutputLink(size_t outlet_index, Object & receiver, size_t inlet_index);
57 
59  void removeOutputLink(size_t outlet_index, Object & receiver, size_t inlet_index);
60 
61  protected: // methods
62 
63  // ================================================================================ //
64  // CONSOLE //
65  // ================================================================================ //
66 
68  void log(std::string const& text) const;
69 
71  void post(std::string const& text) const;
72 
74  void warning(std::string const& text) const;
75 
77  void error(std::string const& text) const;
78 
79  // ================================================================================ //
80  // BEACON //
81  // ================================================================================ //
82 
84  Beacon& getBeacon(std::string const& name) const;
85 
86  // ================================================================================ //
87  // SEND //
88  // ================================================================================ //
89 
93  void send(const size_t index, std::vector<Atom> const& args);
94 
95  private: // members
96 
97  using Outlet = std::set<Link>;
98 
99  Patcher& m_patcher;
100  size_t m_inlets;
101  std::vector<Outlet> m_outlets;
102  size_t m_stack_count = 0ul;
103 
104  private: // deleted methods
105 
106  Object(Object const&) = delete;
107  Object(Object&&) = delete;
108  Object& operator=(Object const&) = delete;
109  Object& operator=(Object&&) = delete;
110  };
111 
112  typedef std::shared_ptr<Object> sObject;
113 
114  // ================================================================================ //
115  // AUDIOOBJECT //
116  // ================================================================================ //
117 
120  class AudioObject : public engine::Object, public dsp::Processor
121  {
122  public: // methods
123 
125  AudioObject(model::Object const& model, Patcher& patcher) noexcept;
126 
128  virtual ~AudioObject() = default;
129  };
130  }
131 }
kiwi::dsp::Processor
The pure virtual class that processes digital signal in a Chain object.
Definition: KiwiDsp_Processor.h:94
-
kiwi::engine::Object::log
void log(std::string const &text) const
post a log message in the Console.
Definition: KiwiEngine_Object.cpp:64
-
kiwi::engine::Object::warning
void warning(std::string const &text) const
post a warning message in the Console.
Definition: KiwiEngine_Object.cpp:74
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <functional>
25 #include <set>
26 #include <string>
27 #include <atomic>
28 
29 #include <flip/Ref.h>
30 
31 #include <KiwiEngine/KiwiEngine_Def.h>
32 
33 #include <KiwiTool/KiwiTool_Scheduler.h>
34 #include <KiwiTool/KiwiTool_ConcurrentQueue.h>
35 
36 #include <KiwiEngine/KiwiEngine_Patcher.h>
37 
38 #include <KiwiDsp/KiwiDsp_Processor.h>
39 
40 #include <KiwiModel/KiwiModel_Object.h>
41 
42 namespace kiwi
43 {
44  namespace engine
45  {
46  // ================================================================================ //
47  // OBJECT //
48  // ================================================================================ //
49 
51  class Object : public model::Object::Listener
52  {
53  public: // methods
54 
56  Object(model::Object const& model, Patcher& patcher) noexcept;
57 
59  virtual ~Object() noexcept;
60 
64  virtual void receive(size_t index, std::vector<tool::Atom> const& args) = 0;
65 
67  virtual void loadbang() {};
68 
70  void addOutputLink(size_t outlet_index, Object & receiver, size_t inlet_index);
71 
73  void removeOutputLink(size_t outlet_index, Object & receiver, size_t inlet_index);
74 
76  void modelParameterChanged(std::string const& name, tool::Parameter const& parameter) override final;
77 
79  void modelAttributeChanged(std::string const& name, tool::Parameter const& parameter) override final;
80 
81  protected: // methods
82 
83  // ================================================================================ //
84  // CONSOLE //
85  // ================================================================================ //
86 
88  void log(std::string const& text) const;
89 
91  void post(std::string const& text) const;
92 
94  void warning(std::string const& text) const;
95 
97  void error(std::string const& text) const;
98 
99  // ================================================================================ //
100  // SCHEDULER //
101  // ================================================================================ //
102 
104  tool::Scheduler<> & getScheduler() const;
105 
107  tool::Scheduler<> & getMainScheduler() const;
108 
111  void defer(std::function<void()> call_back);
112 
115  void deferMain(std::function<void()> call_back);
116 
119  void schedule(std::function<void()> call_back, tool::Scheduler<>::duration_t delay);
120 
123  void scheduleMain(std::function<void()> call_back, tool::Scheduler<>::duration_t delay);
124 
125  // ================================================================================ //
126  // BEACON //
127  // ================================================================================ //
128 
130  tool::Beacon& getBeacon(std::string const& name) const;
131 
132  // ================================================================================ //
133  // SEND //
134  // ================================================================================ //
135 
139  void send(const size_t index, std::vector<tool::Atom> const& args);
140 
143  void setAttribute(std::string const& name, tool::Parameter const& parameter);
144 
147  void setParameter(std::string const& name, tool::Parameter const& parameter);
148 
149  private: // methods
150 
152  model::Object & getObjectModel();
153 
156  virtual void parameterChanged(std::string const& param_name, tool::Parameter const& param);
157 
160  virtual void attributeChanged(std::string const& name, tool::Parameter const& attribute);
161 
162  private: // members
163 
164  using Outlet = std::set<Link>;
165 
166  Patcher& m_patcher;
167  flip::Ref const m_ref;
168  size_t m_inlets;
169  std::vector<Outlet> m_outlets;
170  size_t m_stack_count;
171  std::shared_ptr<Object> m_master;
172 
173  private: // deleted methods
174 
175  Object(Object const&) = delete;
176  Object(Object&&) = delete;
177  Object& operator=(Object const&) = delete;
178  Object& operator=(Object&&) = delete;
179  };
180 
181  typedef std::shared_ptr<Object> sObject;
182 
183  // ================================================================================ //
184  // AUDIOOBJECT //
185  // ================================================================================ //
186 
189  class AudioObject : public engine::Object, public dsp::Processor
190  {
191  public: // methods
192 
194  AudioObject(model::Object const& model, Patcher& patcher) noexcept;
195 
197  virtual ~AudioObject() = default;
198  };
199  }
200 }
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::engine::Object::warning
void warning(std::string const &text) const
post a warning message in the Console.
Definition: KiwiEngine_Object.cpp:134
+
kiwi::engine::Object::setParameter
void setParameter(std::string const &name, tool::Parameter const &parameter)
Changes one of the data model&#39;s parameter.
Definition: KiwiEngine_Object.cpp:112
+
kiwi::engine::Object::post
void post(std::string const &text) const
post a message in the Console.
Definition: KiwiEngine_Object.cpp:129
+
kiwi::dsp::Processor
The pure virtual class that processes digital signal in a Chain object.
Definition: KiwiDsp_Processor.h:94
+
kiwi::engine::Object::setAttribute
void setAttribute(std::string const &name, tool::Parameter const &parameter)
Changes one of the data model&#39;s attributes.
Definition: KiwiEngine_Object.cpp:102
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi::engine::Object::modelAttributeChanged
void modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override final
Called when an attribute has changed.
Definition: KiwiEngine_Object.cpp:76
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::engine::Object::receive
virtual void receive(size_t index, std::vector< Atom > const &args)=0
Receives a set of arguments via an inlet.
-
kiwi::engine::Object::error
void error(std::string const &text) const
post an error message in the Console.
Definition: KiwiEngine_Object.cpp:79
-
kiwi::engine::Object::~Object
virtual ~Object() noexcept
Destructor.
Definition: KiwiEngine_Object.cpp:45
-
kiwi::engine::Beacon
The beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used...
Definition: KiwiEngine_Beacon.h:43
-
kiwi::engine::Object::Object
Object(model::Object const &model, Patcher &patcher) noexcept
Constructor.
Definition: KiwiEngine_Object.cpp:36
-
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:120
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:37
-
kiwi::engine::Object::getBeacon
Beacon & getBeacon(std::string const &name) const
Gets or creates a Beacon with a given name.
Definition: KiwiEngine_Object.cpp:88
-
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:42
-
kiwi::engine::Object::post
void post(std::string const &text) const
post a message in the Console.
Definition: KiwiEngine_Object.cpp:69
-
kiwi::engine::Object::send
void send(const size_t index, std::vector< Atom > const &args)
Sends a vector of Atom via an outlet.
Definition: KiwiEngine_Object.cpp:95
-
kiwi::engine::Object::loadbang
virtual void loadbang()
Called when the Patcher is loaded.
Definition: KiwiEngine_Object.h:53
+
kiwi::model::Object::Listener
Definition: KiwiModel_Object.h:166
+
kiwi::tool::Beacon
The beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used...
Definition: KiwiTool_Beacon.h:45
+
kiwi::engine::Object::~Object
virtual ~Object() noexcept
Destructor.
Definition: KiwiEngine_Object.cpp:49
+
kiwi::engine::Object::modelParameterChanged
void modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override final
Called when a parameter has changed.
Definition: KiwiEngine_Object.cpp:68
+
kiwi::engine::Object::getScheduler
tool::Scheduler & getScheduler() const
Returns the engine&#39;s scheduler.
Definition: KiwiEngine_Object.cpp:148
+
kiwi::engine::Object::defer
void defer(std::function< void()> call_back)
Defers a task on the engine thread.
Definition: KiwiEngine_Object.cpp:158
+
kiwi::engine::Object::getBeacon
tool::Beacon & getBeacon(std::string const &name) const
Gets or creates a Beacon with a given name.
Definition: KiwiEngine_Object.cpp:214
+
kiwi::engine::Object::Object
Object(model::Object const &model, Patcher &patcher) noexcept
Constructor.
Definition: KiwiEngine_Object.cpp:38
+
kiwi::engine::Object::log
void log(std::string const &text) const
post a log message in the Console.
Definition: KiwiEngine_Object.cpp:124
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::engine::Object::scheduleMain
void scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
Schedules a task on the main thread.
Definition: KiwiEngine_Object.cpp:197
+
kiwi::engine::Object::error
void error(std::string const &text) const
post an error message in the Console.
Definition: KiwiEngine_Object.cpp:139
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object::send
void send(const size_t index, std::vector< tool::Atom > const &args)
Sends a vector of Atom via an outlet.
Definition: KiwiEngine_Object.cpp:221
+
kiwi::engine::Object::schedule
void schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
Schedules a task on the engine thread.
Definition: KiwiEngine_Object.cpp:184
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Object::receive
virtual void receive(size_t index, std::vector< tool::Atom > const &args)=0
Receives a set of arguments via an inlet.
+
kiwi::engine::Object::loadbang
virtual void loadbang()
Called when the Patcher is loaded.
Definition: KiwiEngine_Object.h:67
+
kiwi::engine::Object::deferMain
void deferMain(std::function< void()> call_back)
Defers a task on the main thread.
Definition: KiwiEngine_Object.cpp:171
+
kiwi::engine::Object::getMainScheduler
tool::Scheduler & getMainScheduler() const
Returns the main scheduler.
Definition: KiwiEngine_Object.cpp:153
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___objects_8h_source.html b/docs/html/_kiwi_engine___objects_8h_source.html index 663b306a..ed5dfebd 100644 --- a/docs/html/_kiwi_engine___objects_8h_source.html +++ b/docs/html/_kiwi_engine___objects_8h_source.html @@ -3,15 +3,17 @@ - - -Kiwi: Modules/KiwiEngine/KiwiEngine_Objects.h Source File + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Objects.h Source File + @@ -29,19 +31,41 @@
- + - - - - + +
@@ -66,46 +90,12 @@
KiwiEngine_Objects.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <vector>
25 #include <memory>
26 #include <set>
27 
28 #include "KiwiEngine_Object.h"
29 #include "KiwiEngine_Beacon.h"
30 #include "KiwiEngine_CircularBuffer.h"
31 #include "KiwiEngine_AudioControler.h"
32 #include "KiwiEngine_Scheduler.h"
33 
34 namespace kiwi
35 {
36  namespace engine
37  {
38  // ================================================================================ //
39  // NEWBOX //
40  // ================================================================================ //
41 
42  class NewBox : public engine::Object
43  {
44  public:
45  NewBox(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
46 
47  void receive(size_t index, std::vector<Atom> const& args) override;
48  };
49 
50  // ================================================================================ //
51  // ERRORBOX //
52  // ================================================================================ //
53 
54  class ErrorBox : public AudioObject
55  {
56  public:
57  ErrorBox(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
58 
59  void receive(size_t index, std::vector<Atom> const& args) override;
60 
61  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
62  };
63 
64  // ================================================================================ //
65  // OBJECT PLUS //
66  // ================================================================================ //
67 
68  class Plus : public engine::Object
69  {
70  public:
71 
72  Plus(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
73 
74  void receive(size_t index, std::vector<Atom> const& args) override;
75 
76  void bang();
77 
78  private:
79  double m_lhs = 0.0;
80  double m_rhs = 0.0;
81  };
82 
83  // ================================================================================ //
84  // OBJECT TIMES //
85  // ================================================================================ //
86 
87  class Times : public engine::Object
88  {
89  public:
90 
91  Times(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
92 
93  void receive(size_t index, std::vector<Atom> const& args) override;
94 
95  void bang();
96 
97  private:
98  double m_lhs = 0.0;
99  double m_rhs = 0.0;
100  };
101 
102  // ================================================================================ //
103  // OBJECT PRINT //
104  // ================================================================================ //
105 
106  class Print : public engine::Object
107  {
108  public:
109 
110  Print(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
111 
112  void receive(size_t, std::vector<Atom> const& args) override;
113 
114  private:
115  std::string m_name;
116  };
117 
118  // ================================================================================ //
119  // OBJECT RECEIVE //
120  // ================================================================================ //
121 
122  class Receive : public engine::Object, public Beacon::Castaway
123  {
124  private: // classes
125 
126  class Task;
127 
128  public: // methods
129 
130  Receive(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
131 
132  ~Receive();
133 
134  void receive(size_t, std::vector<Atom> const& args) override;
135 
136  void receive(std::vector<Atom> const& args) override;
137 
138  private: // members
139 
140  std::string m_name;
141  std::set<std::unique_ptr<Task>> m_tasks;
142  };
143 
144  // ================================================================================ //
145  // OBJECT LOADMESS //
146  // ================================================================================ //
147 
148  class Loadmess : public engine::Object
149  {
150  public:
151 
152  Loadmess(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
153 
154  ~Loadmess() = default;
155 
156  void receive(size_t, std::vector<Atom> const& args) override;
157 
158  void loadbang() override;
159 
160  private:
161 
162  const std::vector<Atom> m_args;
163  };
164 
165  // ================================================================================ //
166  // OBJECT DELAY //
167  // ================================================================================ //
168 
169  class Delay final : public engine::Object
170  {
171  public: // methods
172 
173  Delay(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
174 
175  ~Delay();
176 
177  void receive(size_t index, std::vector<Atom> const& args) override;
178 
179  private: // members
180 
181  struct Task final : public Scheduler<>::Task
182  {
183  Task(Delay & object);
184  ~Task() = default;
185  void execute() override;
186 
187  private:
188  Delay& m_object;
189  };
190 
191  Task m_task;
192  Scheduler<>::clock_t::duration m_delay;
193  };
194 
195  // ================================================================================ //
196  // OBJECT PIPE //
197  // ================================================================================ //
198 
199  class Pipe final : public engine::Object
200  {
201  public: // classes
202 
203  class Task;
204 
205  public: // methods
206 
207  Pipe(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
208 
209  ~Pipe();
210 
211  void receive(size_t index, std::vector<Atom> const& args) override;
212 
213  private: // members
214 
215  std::set<std::unique_ptr<Task>> m_tasks;
216  Scheduler<>::clock_t::duration m_delay;
217  };
218 
219  // ================================================================================ //
220  // OBJECT METRO //
221  // ================================================================================ //
222 
223  class Metro final : public engine::Object, Scheduler<>::Timer
224  {
225  public: // methods
226 
227  Metro(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
228 
229  ~Metro();
230 
231  void receive(size_t index, std::vector<Atom> const& oargs) override;
232 
233  void timerCallBack() override;
234 
235  private: // members
236 
237  Scheduler<>::duration_t m_period;
238  };
239 
240 
241  // ================================================================================ //
242  // ROUTER //
243  // ================================================================================ //
244 
245  class Router
246  {
247  public: // classes
248 
249  struct Cnx
250  {
251  Cnx(size_t input, size_t output);
252 
253  bool operator<(Cnx const& other) const;
254 
255  size_t m_input = 0;
256  size_t m_output = 0;
257  };
258 
259  public: // method
260 
261  Router() = default;
262 
263  void connect(size_t input_index, size_t output_index);
264 
265  void disconnect(size_t intput_index, size_t output_index);
266 
267  size_t getNumberOfConnections() const;
268 
269  std::set<Cnx> const& getConnections() const;
270 
271  ~Router() = default;
272 
273  private: // memebers
274 
275  std::set<Cnx> m_cnx;
276  };
277 
278  // ================================================================================ //
279  // AUDIO_INTERFACE //
280  // ================================================================================ //
281 
282  class AudioInterfaceObject : public AudioObject
283  {
284  public: // methods
285 
286  AudioInterfaceObject(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
287 
288  void receive(size_t index, std::vector<Atom> const & args) override final;
289 
290  std::vector<size_t> parseArgs(std::vector<Atom> const& args) const;
291 
292  virtual ~AudioInterfaceObject() = default;
293 
294  protected: // members
295 
296  Router m_router;
297  engine::AudioControler& m_audio_controler;
298  };
299 
300  // ================================================================================ //
301  // ADC~ //
302  // ================================================================================ //
303 
304  class AdcTilde : public AudioInterfaceObject
305  {
306  public: // methods
307 
308  AdcTilde(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
309 
310  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
311 
312  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
313  };
314 
315  // ================================================================================ //
316  // DAC~ //
317  // ================================================================================ //
318 
319  class DacTilde : public AudioInterfaceObject
320  {
321  public: // methods
322 
323  DacTilde(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
324 
325  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
326 
327  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
328  };
329 
330  // ================================================================================ //
331  // OSC~ //
332  // ================================================================================ //
333 
334  class OscTilde : public AudioObject
335  {
336  public: // methods
337 
338  OscTilde(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
339 
340  void receive(size_t index, std::vector<Atom> const& args) override;
341 
342  void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
343 
344  void performFreq(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
345 
346  void performPhase(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
347 
348  void performPhaseAndFreq(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
349 
350  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
351 
352  private: // methods
353 
354  void setFrequency(dsp::sample_t const& freq) noexcept;
355 
356  void setOffset(dsp::sample_t const& offset) noexcept;
357 
358  void setSampleRate(dsp::sample_t const& sample_rate);
359 
360  private: // members
361 
362  dsp::sample_t m_sr = 0.f;
363  dsp::sample_t m_time = 0.f;
364  std::atomic<dsp::sample_t> m_freq{0.f};
365  std::atomic<dsp::sample_t> m_offset{0.f};
366  };
367 
368  // ================================================================================ //
369  // TIMES~ //
370  // ================================================================================ //
371 
372  class TimesTilde : public AudioObject
373  {
374  public: // methods
375 
376  TimesTilde(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
377 
378  void receive(size_t index, std::vector<Atom> const& args) override;
379 
380  void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
381 
382  void performVec(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
383 
384  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
385 
386  private: // members
387 
388  std::atomic<dsp::sample_t> m_value{0.f};
389  };
390 
391  // ================================================================================ //
392  // PLUS~ //
393  // ================================================================================ //
394 
395  class PlusTilde : public AudioObject
396  {
397  public: // methods
398 
399  PlusTilde(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
400 
401  void receive(size_t index, std::vector<Atom> const& args) override;
402 
403  void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
404 
405  void performVec(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
406 
407  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
408 
409  private: // members
410 
411  std::atomic<dsp::sample_t> m_value{0.f};
412  };
413 
414  // ================================================================================ //
415  // SIG~ //
416  // ================================================================================ //
417 
418  class SigTilde : public AudioObject
419  {
420  public: // methods
421 
422  SigTilde(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
423 
424  void receive(size_t index, std::vector<Atom> const& args) override final;
425 
426  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
427 
428  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
429 
430  private: // members
431 
432  std::atomic<float> m_value{0.f};
433  };
434 
435  // ================================================================================ //
436  // DELAYSIMPLETILDE //
437  // ================================================================================ //
438 
439  class DelaySimpleTilde : public AudioObject
440  {
441  public: // methods
442 
443  DelaySimpleTilde(model::Object const& model, Patcher& patcher, std::vector<Atom> const& args);
444 
445  void receive(size_t index, std::vector<Atom> const& args) override final;
446 
447  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
448 
449  void performDelay(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
450 
451  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
452 
453  private: // methods
454 
455  dsp::sample_t cubicInterpolate(float const& x,
456  float const& y0,
457  float const& y1,
458  float const& y2,
459  float const& y3);
460 
461  private: // members
462 
463  std::unique_ptr<CircularBuffer<dsp::sample_t>> m_circular_buffer;
464  std::unique_ptr<dsp::Signal> m_reinject_signal;
465  float m_max_delay;
466  std::atomic<float> m_delay;
467  std::atomic<float> m_reinject_level;
468  dsp::sample_t m_sr;
469  size_t m_vector_size;
470  mutable std::mutex m_mutex;
471  };
472  }
473 }
kiwi::engine::Router
Definition: KiwiEngine_Objects.h:245
-
kiwi::engine::Metro
Definition: KiwiEngine_Objects.h:223
-
kiwi::engine::DacTilde
Definition: KiwiEngine_Objects.h:319
-
kiwi::engine::Router::Cnx
Definition: KiwiEngine_Objects.h:249
-
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
-
kiwi::engine::SigTilde
Definition: KiwiEngine_Objects.h:418
-
kiwi::engine::Loadmess
Definition: KiwiEngine_Objects.h:148
-
kiwi::engine::Beacon::Castaway
The beacon castaway can be binded to a beacon.
Definition: KiwiEngine_Beacon.h:71
-
kiwi::engine::AudioControler
AudioControler is a pure interface that enable controling audio in kiwi.
Definition: KiwiEngine_AudioControler.h:35
-
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::engine::Times
Definition: KiwiEngine_Objects.h:87
-
kiwi::engine::AdcTilde
Definition: KiwiEngine_Objects.h:304
-
kiwi::engine::ErrorBox
Definition: KiwiEngine_Objects.h:54
-
kiwi::engine::NewBox::receive
void receive(size_t index, std::vector< Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Objects.cpp:46
-
kiwi::engine::Delay
Definition: KiwiEngine_Objects.h:169
-
kiwi::engine::TimesTilde
Definition: KiwiEngine_Objects.h:372
-
kiwi::engine::AudioInterfaceObject
Definition: KiwiEngine_Objects.h:282
-
kiwi::engine::PlusTilde
Definition: KiwiEngine_Objects.h:395
-
kiwi::engine::Receive::Task
Definition: KiwiEngine_Objects.cpp:177
-
kiwi::engine::NewBox
Definition: KiwiEngine_Objects.h:42
-
kiwi::engine::DelaySimpleTilde
Definition: KiwiEngine_Objects.h:439
-
kiwi::engine::Pipe
Definition: KiwiEngine_Objects.h:199
-
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:120
-
kiwi::engine::Plus
Definition: KiwiEngine_Objects.h:68
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::engine::OscTilde
Definition: KiwiEngine_Objects.h:334
-
kiwi::engine::Pipe::Task
Definition: KiwiEngine_Objects.cpp:328
-
kiwi::engine::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiEngine_Scheduler.h:49
-
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:37
-
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:42
-
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
-
kiwi::engine::Object::loadbang
virtual void loadbang()
Called when the Patcher is loaded.
Definition: KiwiEngine_Object.h:53
-
kiwi::engine::Print
Definition: KiwiEngine_Objects.h:106
-
kiwi::engine::Receive
Definition: KiwiEngine_Objects.h:122
-
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_NewBox.h>
25 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_ErrorBox.h>
26 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Print.h>
27 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Receive.h>
28 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Slider.h>
29 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Plus.h>
30 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Times.h>
31 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.h>
32 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Metro.h>
33 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pipe.h>
34 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Bang.h>
35 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Toggle.h>
36 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_AdcTilde.h>
37 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_DacTilde.h>
38 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.h>
39 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Loadmess.h>
40 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_TimesTilde.h>
41 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_PlusTilde.h>
42 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_SigTilde.h>
43 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_MeterTilde.h>
44 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_DelaySimpleTilde.h>
45 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Message.h>
46 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_NoiseTilde.h>
47 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_PhasorTilde.h>
48 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_SahTilde.h>
49 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_SnapshotTilde.h>
50 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Trigger.h>
51 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_LineTilde.h>
52 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Minus.h>
53 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Divide.h>
54 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Equal.h>
55 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Less.h>
56 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Greater.h>
57 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Different.h>
58 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pow.h>
59 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Modulo.h>
60 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_MinusTilde.h>
61 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_DivideTilde.h>
62 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessTilde.h>
63 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterTilde.h>
64 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_EqualTilde.h>
65 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_DifferentTilde.h>
66 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessEqual.h>
67 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessEqualTilde.h>
68 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterEqual.h>
69 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterEqualTilde.h>
70 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Comment.h>
71 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.h>
72 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Unpack.h>
73 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Random.h>
74 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Scale.h>
75 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Select.h>
76 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Number.h>
77 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_NumberTilde.h>
78 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Hub.h>
79 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Mtof.h>
80 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Send.h>
81 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.h>
82 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.h>
83 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.h>
84 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.h>
85 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.h>
86 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.h>
87 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.h>
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___operator_8h_source.html b/docs/html/_kiwi_engine___operator_8h_source.html new file mode 100644 index 00000000..1a0ea0c5 --- /dev/null +++ b/docs/html/_kiwi_engine___operator_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Operator.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT OPERATOR //
30  // ================================================================================ //
31 
32  class Operator : public engine::Object
33  {
34  public:
35 
36  Operator(model::Object const& model, Patcher& patcher);
37 
38  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
39 
40  void bang();
41 
42  virtual double compute(double lhs, double rhs) const = 0;
43 
44  protected:
45 
46  double m_lhs;
47  double m_rhs;
48  };
49 
50 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Operator::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Operator.cpp:46
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___operator_tilde_8h_source.html b/docs/html/_kiwi_engine___operator_tilde_8h_source.html new file mode 100644 index 00000000..0ea8e3da --- /dev/null +++ b/docs/html/_kiwi_engine___operator_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_OperatorTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OPERATOR TILDE //
30  // ================================================================================ //
31 
32  class OperatorTilde : public engine::AudioObject
33  {
34  public:
35 
36  OperatorTilde(model::Object const& model, Patcher& patcher);
37 
38  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
39 
40  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
41 
42  void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
43 
44  void performVec(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
45 
46  virtual void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs) = 0;
47 
48  protected:
49 
50  std::atomic<dsp::sample_t> m_rhs{0.f};
51  };
52 
53 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::OperatorTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_OperatorTilde.cpp:105
+
kiwi::engine::OperatorTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_OperatorTilde.cpp:42
+
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___osc_tilde_8h_source.html b/docs/html/_kiwi_engine___osc_tilde_8h_source.html new file mode 100644 index 00000000..b4d06162 --- /dev/null +++ b/docs/html/_kiwi_engine___osc_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_OscTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OSC~ //
30  // ================================================================================ //
31 
32  class OscTilde : public AudioObject
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  OscTilde(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override;
43 
44  void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
45 
46  void performFreq(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
47 
48  void performPhase(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
49 
50  void performPhaseAndFreq(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
51 
52  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
53 
54  private: // methods
55 
56  void setFrequency(dsp::sample_t const& freq) noexcept;
57 
58  void setOffset(dsp::sample_t const& offset) noexcept;
59 
60  void setSampleRate(dsp::sample_t const& sample_rate);
61 
62  private: // members
63 
64  dsp::sample_t m_sr = 0.f;
65  dsp::sample_t m_time = 0.f;
66  std::atomic<dsp::sample_t> m_freq{0.f};
67  std::atomic<dsp::sample_t> m_offset{0.f};
68  };
69 
70 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::OscTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_OscTilde.cpp:67
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::OscTilde
Definition: KiwiEngine_OscTilde.h:32
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
kiwi::engine::OscTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_OscTilde.cpp:93
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___pack_8h_source.html b/docs/html/_kiwi_engine___pack_8h_source.html new file mode 100644 index 00000000..3d7b8591 --- /dev/null +++ b/docs/html/_kiwi_engine___pack_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Pack.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // PACK //
30  // ================================================================================ //
31 
32  class Pack : public engine::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Pack(model::Object const& model, Patcher& patcher);
41 
42  ~Pack() = default;
43 
44  void setElement(size_t index, tool::Atom const& atom);
45 
46  void receive(size_t index, std::vector<tool::Atom> const& args) override;
47 
48  private:
49 
50  void output_list();
51 
52  private:
53 
54  std::vector<tool::Atom> m_list;
55  };
56 
57 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Pack::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Pack.cpp:76
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::tool::Atom
The Atom can dynamically hold different types of value.
Definition: KiwiTool_Atom.h:39
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Pack
Definition: KiwiEngine_Pack.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___patcher_8h_source.html b/docs/html/_kiwi_engine___patcher_8h_source.html index 09cbfbb4..f95ad39d 100644 --- a/docs/html/_kiwi_engine___patcher_8h_source.html +++ b/docs/html/_kiwi_engine___patcher_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine/KiwiEngine_Patcher.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
KiwiEngine_Patcher.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <map>
25 #include <set>
26 
27 #include "KiwiEngine_Def.h"
28 #include "KiwiEngine_Beacon.h"
29 #include "KiwiEngine_AudioControler.h"
30 
31 #include <KiwiDsp/KiwiDsp_Chain.h>
32 
33 namespace kiwi
34 {
35  namespace engine
36  {
37  // ================================================================================ //
38  // PATCHER //
39  // ================================================================================ //
40 
42  class Patcher
43  {
44  private: // classes
45 
46  class CallBack;
47 
48  public: // methods
49 
51  Patcher(Instance& instance) noexcept;
52 
54  ~Patcher();
55 
57  void addObject(uint64_t object_id, std::shared_ptr<Object> object);
58 
60  void removeObject(uint64_t object_id);
61 
63  void addLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal);
64 
66  void removeLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal);
67 
69  void updateChain();
70 
72  void modelChanged(model::Patcher const& model);
73 
76  void addStackOverflow(Link const& link);
77 
80  void endStackOverflow();
81 
83  std::vector<std::queue<Link const*>> getStackOverflow() const;
84 
86  void clearStackOverflow();
87 
89  AudioControler& getAudioControler() const;
90 
92  void sendLoadbang();
93 
94  // ================================================================================ //
95  // CONSOLE //
96  // ================================================================================ //
97 
99  void log(std::string const& text) const;
100 
102  void post(std::string const& text) const;
103 
105  void warning(std::string const& text) const;
106 
108  void error(std::string const& text) const;
109 
110  // ================================================================================ //
111  // BEACON //
112  // ================================================================================ //
113 
115  Beacon& getBeacon(std::string const& name) const;
116 
117  private: // methods
118 
120  void objectAdded(model::Object const& object);
121 
123  void objectChanged(model::Object const& object);
124 
126  void objectRemoved(model::Object const& object);
127 
129  void linkAdded(model::Link const& link);
130 
132  void linkChanged(model::Link const& link_m);
133 
135  void linkRemoved(model::Link const& link_m);
136 
137  private: // members
138 
139  using SoLinks = std::queue<Link const*>;
140 
141  Instance& m_instance;
142  std::map<uint64_t, std::shared_ptr<Object>> m_objects;
143  mutable std::mutex m_mutex;
144  std::vector<SoLinks> m_so_links;
145  dsp::Chain m_chain;
146 
147  private: // deleted methods
148 
149  Patcher(Patcher const&) = delete;
150  Patcher(Patcher&&) = delete;
151  Patcher& operator=(Patcher const&) = delete;
152  Patcher& operator=(Patcher&&) = delete;
153  };
154  }
155 }
kiwi::engine::Patcher::warning
void warning(std::string const &text) const
post a warning message in the Console.
Definition: KiwiEngine_Patcher.cpp:180
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <map>
25 #include <set>
26 #include <flip/Ref.h>
27 
28 #include <KiwiTool/KiwiTool_Beacon.h>
29 
30 #include "KiwiEngine_Def.h"
31 #include "KiwiEngine_AudioControler.h"
32 
33 #include <KiwiDsp/KiwiDsp_Chain.h>
34 
35 #include <KiwiModel/KiwiModel_PatcherUser.h>
36 
37 namespace kiwi
38 {
39  namespace engine
40  {
41  // ================================================================================ //
42  // PATCHER //
43  // ================================================================================ //
44 
46  class Patcher
47  {
48  private: // classes
49 
50  class CallBack;
51 
52  public: // methods
53 
55  Patcher(Instance& instance, model::Patcher & patcher_model) noexcept;
56 
58  ~Patcher();
59 
61  void addObject(flip::Ref object_id, std::shared_ptr<Object> object);
62 
64  void removeObject(flip::Ref object_id);
65 
67  void addLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal);
68 
70  void removeLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal);
71 
73  void updateChain();
74 
76  void modelChanged(model::Patcher const& model);
77 
80  void addStackOverflow(Link const& link);
81 
84  void endStackOverflow();
85 
87  std::vector<std::queue<Link const*>> getStackOverflow() const;
88 
90  void clearStackOverflow();
91 
93  AudioControler& getAudioControler() const;
94 
96  void sendLoadbang();
97 
99  model::Patcher & getPatcherModel();
100 
101  // ================================================================================ //
102  // CONSOLE //
103  // ================================================================================ //
104 
106  void log(std::string const& text) const;
107 
109  void post(std::string const& text) const;
110 
112  void warning(std::string const& text) const;
113 
115  void error(std::string const& text) const;
116 
117  // ================================================================================ //
118  // SCHEDULER //
119  // ================================================================================ //
120 
122  tool::Scheduler<> & getScheduler() const;
123 
125  tool::Scheduler<> & getMainScheduler() const;
126 
127  // ================================================================================ //
128  // BEACON //
129  // ================================================================================ //
130 
132  tool::Beacon& getBeacon(std::string const& name) const;
133 
134  private: // methods
135 
137  void updateGraph(model::Patcher const& patcher_model);
138 
140  void updateAttributes(model::Patcher const& patcher_model);
141 
143  void objectAdded(model::Object const& object);
144 
146  void objectChanged(model::Object const& object);
147 
149  void objectRemoved(model::Object const& object);
150 
152  void linkAdded(model::Link const& link);
153 
155  void linkChanged(model::Link const& link_m);
156 
158  void linkRemoved(model::Link const& link_m);
159 
160  private: // members
161 
162  using SoLinks = std::queue<Link const*>;
163 
164  Instance& m_instance;
165  std::map<flip::Ref, std::shared_ptr<Object>> m_objects;
166  std::vector<SoLinks> m_so_links;
167  dsp::Chain m_chain;
168  model::Patcher & m_patcher_model;
169 
170  private: // deleted methods
171 
172  Patcher(Patcher const&) = delete;
173  Patcher(Patcher&&) = delete;
174  Patcher& operator=(Patcher const&) = delete;
175  Patcher& operator=(Patcher&&) = delete;
176  };
177  }
178 }
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
kiwi::dsp::Chain
An audio rendering class that manages processors in a graph structure.
Definition: KiwiDsp_Chain.h:45
-
kiwi::engine::Patcher::removeObject
void removeObject(uint64_t object_id)
Removes an object from the patcher.
Definition: KiwiEngine_Patcher.cpp:66
-
kiwi::engine::Patcher::getAudioControler
AudioControler & getAudioControler() const
Returns the audio controler held by the patcher&#39;s instance.
Definition: KiwiEngine_Patcher.cpp:131
-
kiwi::engine::Patcher::Patcher
Patcher(Instance &instance) noexcept
Constructor.
Definition: KiwiEngine_Patcher.cpp:39
-
kiwi::engine::Patcher::getStackOverflow
std::vector< std::queue< Link const * > > getStackOverflow() const
Gets the lists of stack overflow.
Definition: KiwiEngine_Patcher.cpp:147
-
kiwi::engine::Patcher::log
void log(std::string const &text) const
post a log message in the Console.
Definition: KiwiEngine_Patcher.cpp:170
+
kiwi::engine::Patcher::warning
void warning(std::string const &text) const
post a warning message in the Console.
Definition: KiwiEngine_Patcher.cpp:185
+
kiwi::engine::Patcher::addLink
void addLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal)
Adds a link between to object of the patcher.
Definition: KiwiEngine_Patcher.cpp:83
+
kiwi::engine::Patcher::addObject
void addObject(flip::Ref object_id, std::shared_ptr< Object > object)
Adds an object to the patcher.
Definition: KiwiEngine_Patcher.cpp:59
+
kiwi::engine::Patcher::getBeacon
tool::Beacon & getBeacon(std::string const &name) const
Gets or creates a Beacon with a given name.
Definition: KiwiEngine_Patcher.cpp:213
+
kiwi::engine::Patcher::log
void log(std::string const &text) const
post a log message in the Console.
Definition: KiwiEngine_Patcher.cpp:175
+
kiwi::engine::Patcher::removeLink
void removeLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal)
Removes a link between two objects.
Definition: KiwiEngine_Patcher.cpp:105
kiwi::engine::AudioControler
AudioControler is a pure interface that enable controling audio in kiwi.
Definition: KiwiEngine_AudioControler.h:35
+
kiwi::engine::Patcher::Patcher
Patcher(Instance &instance, model::Patcher &patcher_model) noexcept
Constructor.
Definition: KiwiEngine_Patcher.cpp:39
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Beacon
The beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used...
Definition: KiwiTool_Beacon.h:45
kiwi::model::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiModel_Patcher.h:35
-
kiwi::engine::Patcher::endStackOverflow
void endStackOverflow()
Ends a list of stack overflow.
Definition: KiwiEngine_Patcher.cpp:142
-
kiwi::engine::Patcher::updateChain
void updateChain()
Updates the dsp chain held by the engine patcher.
Definition: KiwiEngine_Patcher.cpp:119
-
kiwi::engine::Beacon
The beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used...
Definition: KiwiEngine_Beacon.h:43
-
kiwi::engine::Patcher::removeLink
void removeLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal)
Removes a link between two objects.
Definition: KiwiEngine_Patcher.cpp:100
-
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:42
-
kiwi::engine::Patcher::addStackOverflow
void addStackOverflow(Link const &link)
Adds a link to the current stack overflow list (or create a new list if there is no).
Definition: KiwiEngine_Patcher.cpp:137
-
kiwi::engine::Patcher::post
void post(std::string const &text) const
post a message in the Console.
Definition: KiwiEngine_Patcher.cpp:175
-
kiwi::engine::Patcher::clearStackOverflow
void clearStackOverflow()
Clears the lists of stack overflow.
Definition: KiwiEngine_Patcher.cpp:152
+
kiwi::engine::Patcher::endStackOverflow
void endStackOverflow()
Ends a list of stack overflow.
Definition: KiwiEngine_Patcher.cpp:147
+
kiwi::engine::Patcher::updateChain
void updateChain()
Updates the dsp chain held by the engine patcher.
Definition: KiwiEngine_Patcher.cpp:124
+
kiwi::engine::Patcher::post
void post(std::string const &text) const
post a message in the Console.
Definition: KiwiEngine_Patcher.cpp:180
+
kiwi::engine::Instance
The Instance adds the engine objects to the engine::Factory.
Definition: KiwiEngine_Instance.h:46
+
kiwi::engine::Patcher::addStackOverflow
void addStackOverflow(Link const &link)
Adds a link to the current stack overflow list (or create a new list if there is no).
Definition: KiwiEngine_Patcher.cpp:142
+
kiwi::engine::Patcher::removeObject
void removeObject(flip::Ref object_id)
Removes an object from the patcher.
Definition: KiwiEngine_Patcher.cpp:71
+
kiwi::engine::Patcher::getScheduler
tool::Scheduler & getScheduler() const
Returns the engine&#39;s scheduler.
Definition: KiwiEngine_Patcher.cpp:199
+
kiwi::engine::Patcher::clearStackOverflow
void clearStackOverflow()
Clears the lists of stack overflow.
Definition: KiwiEngine_Patcher.cpp:157
kiwi::engine::Patcher::~Patcher
~Patcher()
Destructor.
Definition: KiwiEngine_Patcher.cpp:49
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::engine::Patcher::error
void error(std::string const &text) const
post an error message in the Console.
Definition: KiwiEngine_Patcher.cpp:185
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
-
kiwi::engine::Patcher::addLink
void addLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal)
Adds a link between to object of the patcher.
Definition: KiwiEngine_Patcher.cpp:78
+
kiwi::engine::Patcher::getMainScheduler
tool::Scheduler & getMainScheduler() const
Returns the main scheduler.
Definition: KiwiEngine_Patcher.cpp:204
+
kiwi::engine::Patcher::getAudioControler
AudioControler & getAudioControler() const
Returns the audio controler held by the patcher&#39;s instance.
Definition: KiwiEngine_Patcher.cpp:136
+
kiwi::engine::Patcher::getStackOverflow
std::vector< std::queue< Link const * > > getStackOverflow() const
Gets the lists of stack overflow.
Definition: KiwiEngine_Patcher.cpp:152
-
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:42
-
kiwi::engine::Patcher::addObject
void addObject(uint64_t object_id, std::shared_ptr< Object > object)
Adds an object to the patcher.
Definition: KiwiEngine_Patcher.cpp:54
-
kiwi::engine::Patcher::getBeacon
Beacon & getBeacon(std::string const &name) const
Gets or creates a Beacon with a given name.
Definition: KiwiEngine_Patcher.cpp:194
+
kiwi::engine::Patcher::getPatcherModel
model::Patcher & getPatcherModel()
Returns the patcher&#39;s data model.
Definition: KiwiEngine_Patcher.cpp:54
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Patcher::error
void error(std::string const &text) const
post an error message in the Console.
Definition: KiwiEngine_Patcher.cpp:190
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_engine___phasor_tilde_8h_source.html b/docs/html/_kiwi_engine___phasor_tilde_8h_source.html new file mode 100644 index 00000000..c284ce1a --- /dev/null +++ b/docs/html/_kiwi_engine___phasor_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_PhasorTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_PhasorTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // PHASOR~ //
30  // ================================================================================ //
31 
32  class PhasorTilde : public AudioObject
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  PhasorTilde(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
43 
44  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
45 
46  void performSignal(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
47 
48  void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
49 
50  private: // methods
51 
52  void setFrequency(dsp::sample_t const& freq) noexcept;
53 
54  void setPhase(dsp::sample_t const& phase) noexcept;
55 
56  void setSampleRate(dsp::sample_t const& sample_rate);
57 
58  dsp::sample_t getAndIncrementPhase(const dsp::sample_t inc);
59 
60  private: // members
61 
62  dsp::sample_t m_sr {0.f};
63  dsp::sample_t m_freq {0.f};
64  std::atomic<dsp::sample_t> m_phase {0.f};
65  std::atomic<dsp::sample_t> m_phase_inc {0.f};
66  };
67 
68 }}
kiwi::engine::PhasorTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_PhasorTilde.cpp:98
+
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::PhasorTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_PhasorTilde.cpp:72
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
kiwi::engine::PhasorTilde
Definition: KiwiEngine_PhasorTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___pipe_8h_source.html b/docs/html/_kiwi_engine___pipe_8h_source.html new file mode 100644 index 00000000..bb109054 --- /dev/null +++ b/docs/html/_kiwi_engine___pipe_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pipe.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Pipe.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT PIPE //
30  // ================================================================================ //
31 
32  class Pipe final : public engine::Object
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Pipe(model::Object const& model, Patcher& patcher);
41 
42  ~Pipe();
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override;
45 
46  private: // members
47 
48  tool::Scheduler<>::clock_t::duration m_delay;
49  };
50 
51 }}
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Pipe
Definition: KiwiEngine_Pipe.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Pipe::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Pipe.cpp:57
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___plus_8h_source.html b/docs/html/_kiwi_engine___plus_8h_source.html new file mode 100644 index 00000000..83362c80 --- /dev/null +++ b/docs/html/_kiwi_engine___plus_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Plus.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Plus.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT PLUS //
31  // ================================================================================ //
32 
33  class Plus : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Plus(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Plus
Definition: KiwiEngine_Plus.h:33
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___plus_tilde_8h_source.html b/docs/html/_kiwi_engine___plus_tilde_8h_source.html new file mode 100644 index 00000000..bac0a33f --- /dev/null +++ b/docs/html/_kiwi_engine___plus_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_PlusTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_PlusTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // PLUS~ //
30  // ================================================================================ //
31 
32  class PlusTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  PlusTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs);
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::PlusTilde
Definition: KiwiEngine_PlusTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___pow_8h_source.html b/docs/html/_kiwi_engine___pow_8h_source.html new file mode 100644 index 00000000..fb829173 --- /dev/null +++ b/docs/html/_kiwi_engine___pow_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pow.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Pow.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT POW //
31  // ================================================================================ //
32 
33  class Pow : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Pow(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 }}
kiwi::engine::Pow
Definition: KiwiEngine_Pow.h:33
+
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___print_8h_source.html b/docs/html/_kiwi_engine___print_8h_source.html new file mode 100644 index 00000000..1198fcf0 --- /dev/null +++ b/docs/html/_kiwi_engine___print_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Print.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Print.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT PRINT //
30  // ================================================================================ //
31 
32  class Print : public engine::Object
33  {
34  public:
35 
36  Print(model::Object const& model, Patcher& patcher);
37 
38  void receive(size_t, std::vector<tool::Atom> const& args) override;
39 
40  static void declare();
41 
42  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
43 
44  private:
45 
46  std::string m_name;
47  };
48 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Print::receive
void receive(size_t, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Print.cpp:70
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Print
Definition: KiwiEngine_Print.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___random_8h_source.html b/docs/html/_kiwi_engine___random_8h_source.html new file mode 100644 index 00000000..10aefe5c --- /dev/null +++ b/docs/html/_kiwi_engine___random_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Random.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Random.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 #include <random>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // RANDOM //
32  // ================================================================================ //
33 
34  class Random : public Object
35  {
36  public: // methods
37 
38  static void declare();
39 
40  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
41 
42  Random(model::Object const& model, Patcher& patcher);
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
45 
46  private: // methods
47 
48  void setRange(int range);
49 
50  void setSeed(int new_seed);
51 
52  private: // members
53 
54  std::mt19937 m_random_generator;
55  std::uniform_int_distribution<int> m_random_distribution;
56  };
57 
58 }}
kiwi::engine::Random::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Random.cpp:64
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Random
Definition: KiwiEngine_Random.h:34
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___receive_8h_source.html b/docs/html/_kiwi_engine___receive_8h_source.html new file mode 100644 index 00000000..6cf36eda --- /dev/null +++ b/docs/html/_kiwi_engine___receive_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Receive.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Receive.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Beacon.h>
25 
26 #include <KiwiEngine/KiwiEngine_Object.h>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // OBJECT RECEIVE //
32  // ================================================================================ //
33 
34  class Receive : public engine::Object, public tool::Beacon::Castaway
35  {
36  public: // methods
37 
38  static void declare();
39 
40  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
41 
42  Receive(model::Object const& model, Patcher& patcher);
43 
44  ~Receive();
45 
47  void receive(size_t, std::vector<tool::Atom> const& args) override;
48 
50  void receive(std::vector<tool::Atom> const& args) override;
51 
52  private: // members
53 
54  std::string m_name;
55  };
56 
57 }}
kiwi::tool::Beacon::Castaway
The beacon castaway can be binded to a beacon.
Definition: KiwiTool_Beacon.h:73
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Receive::receive
void receive(size_t, std::vector< tool::Atom > const &args) override
inlets receive.
Definition: KiwiEngine_Receive.cpp:68
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Receive
Definition: KiwiEngine_Receive.h:34
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___sah_tilde_8h_source.html b/docs/html/_kiwi_engine___sah_tilde_8h_source.html new file mode 100644 index 00000000..b20f71e7 --- /dev/null +++ b/docs/html/_kiwi_engine___sah_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SahTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_SahTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // SAH~ //
30  // ================================================================================ //
31 
32  class SahTilde : public AudioObject
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  SahTilde(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override;
43 
44  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
45 
46  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
47 
48  private: // methods
49 
50  void setThreshold(dsp::sample_t const& value) noexcept;
51 
52  private: // members
53 
54  std::atomic<dsp::sample_t> m_threshold {0.f};
55  dsp::sample_t m_hold_value {0.f};
56  dsp::sample_t m_last_ctrl_sample {0.f};
57  };
58 
59 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::SahTilde
Definition: KiwiEngine_SahTilde.h:32
+
kiwi::engine::SahTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_SahTilde.cpp:72
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::SahTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_SahTilde.cpp:57
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___scale_8h_source.html b/docs/html/_kiwi_engine___scale_8h_source.html new file mode 100644 index 00000000..1cdd34df --- /dev/null +++ b/docs/html/_kiwi_engine___scale_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Scale.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Scale.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // SCALE //
30  // ================================================================================ //
31 
32  class Scale : public Object
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Scale(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
43 
44  private:
45 
46  float scaleValue();
47 
48  private: // members
49 
50  double m_value {0.};
51  double m_input_low {0.};
52  double m_input_high {1.};
53  double m_output_low {0.};
54  double m_output_high {1.};
55  };
56 
57 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Scale::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Scale.cpp:67
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::engine::Scale
Definition: KiwiEngine_Scale.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___select_8h_source.html b/docs/html/_kiwi_engine___select_8h_source.html new file mode 100644 index 00000000..60ed10df --- /dev/null +++ b/docs/html/_kiwi_engine___select_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Select.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Select.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <vector>
25 
26 #include <KiwiEngine/KiwiEngine_Object.h>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // SELECT //
32  // ================================================================================ //
33 
34  class Select : public engine::Object
35  {
36  public:
37 
38  static void declare();
39 
40  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
41 
42  Select(model::Object const& model, Patcher& patcher);
43 
44  ~Select() = default;
45 
46  void receive(size_t index, std::vector<tool::Atom> const& args) override;
47 
48  private:
49 
50  std::vector<tool::Atom> m_list;
51  };
52 
53 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Select::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Select.cpp:47
+
kiwi::engine::Select
Definition: KiwiEngine_Select.h:34
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___send_8h_source.html b/docs/html/_kiwi_engine___send_8h_source.html new file mode 100644 index 00000000..d9ad6911 --- /dev/null +++ b/docs/html/_kiwi_engine___send_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Send.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Send.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Beacon.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // SEND //
31  // ================================================================================ //
32 
33  class Send : public engine::Object
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
40 
41  Send(model::Object const& model, Patcher& patcher);
42 
43  Send() = default;
44 
45  void receive(size_t index, std::vector<tool::Atom> const& args) override;
46 
47  private:
48 
49  tool::Beacon& m_beacon;
50  };
51 
52 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Beacon
The beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used...
Definition: KiwiTool_Beacon.h:45
+
kiwi::engine::Send::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Send.cpp:47
+
kiwi::engine::Send
Definition: KiwiEngine_Send.h:33
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___sig_tilde_8h_source.html b/docs/html/_kiwi_engine___sig_tilde_8h_source.html new file mode 100644 index 00000000..d5d197e9 --- /dev/null +++ b/docs/html/_kiwi_engine___sig_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SigTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_SigTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // SIG~ //
30  // ================================================================================ //
31 
32  class SigTilde : public AudioObject
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  SigTilde(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
43 
44  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
45 
46  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
47 
48  private: // members
49 
50  std::atomic<float> m_value{0.f};
51  };
52 
53 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::SigTilde
Definition: KiwiEngine_SigTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::SigTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_SigTilde.cpp:79
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::SigTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_SigTilde.cpp:52
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___slider_8h_source.html b/docs/html/_kiwi_engine___slider_8h_source.html new file mode 100644 index 00000000..f2c3e0dd --- /dev/null +++ b/docs/html/_kiwi_engine___slider_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Slider.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Slider.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <vector>
25 #include <memory>
26 
27 #include <KiwiTool/KiwiTool_Atom.h>
28 #include <KiwiTool/KiwiTool_Parameter.h>
29 
30 #include <KiwiModel/KiwiModel_Object.h>
31 
32 #include <KiwiEngine/KiwiEngine_Object.h>
33 
34 namespace kiwi { namespace engine {
35 
36  // ================================================================================ //
37  // OBJECT SLIDER //
38  // ================================================================================ //
39 
40  class Slider : public engine::Object
41  {
42  public: // methods
43 
44  Slider(model::Object const& model, Patcher& patcher);
45 
46  ~Slider();
47 
48  void parameterChanged(std::string const& name, tool::Parameter const& param) override final;
49 
50  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
51 
52  static void declare();
53 
54  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
55 
56  private: // methods
57 
58  void outputValue();
59 
60  private: // members
61 
62  double m_value;
63  flip::SignalConnection m_connection;
64  };
65 
66 }}
kiwi::engine::Slider
Definition: KiwiEngine_Slider.h:40
+
kiwi::engine::Slider::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Slider.cpp:75
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Slider::parameterChanged
void parameterChanged(std::string const &name, tool::Parameter const &param) override final
Called once the data model&#39;s parameters has changed.
Definition: KiwiEngine_Slider.cpp:59
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___snapshot_tilde_8h_source.html b/docs/html/_kiwi_engine___snapshot_tilde_8h_source.html new file mode 100644 index 00000000..02afaf77 --- /dev/null +++ b/docs/html/_kiwi_engine___snapshot_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SnapshotTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_SnapshotTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // SNAPSHOT~ //
30  // ================================================================================ //
31 
32  class SnapshotTilde : public AudioObject
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  SnapshotTilde(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
43 
44  void perform(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
45 
46  void prepare(dsp::Processor::PrepareInfo const& infos) override final;
47 
48  private: // members
49 
50  std::atomic<dsp::sample_t> m_value {0.f};
51  };
52 
53 }}
54 
kiwi::engine::SnapshotTilde::prepare
void prepare(dsp::Processor::PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_SnapshotTilde.cpp:73
+
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::SnapshotTilde
Definition: KiwiEngine_SnapshotTilde.h:32
+
kiwi::engine::SnapshotTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_SnapshotTilde.cpp:47
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___switch_8h_source.html b/docs/html/_kiwi_engine___switch_8h_source.html new file mode 100644 index 00000000..0307bb81 --- /dev/null +++ b/docs/html/_kiwi_engine___switch_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Switch.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // SWITCH //
30  // ================================================================================ //
31 
32  class Switch : public engine::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Switch(model::Object const& model, Patcher& patcher);
41 
42  void receive(size_t index, std::vector<tool::Atom> const& args) override;
43 
44  private:
45 
46  void openInput(int input);
47 
48  private:
49 
50  size_t m_opened_input;
51  size_t m_num_inputs;
52  };
53 
54 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Switch::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Switch.cpp:60
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Switch
Definition: KiwiEngine_Switch.h:32
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___switch_tilde_8h_source.html b/docs/html/_kiwi_engine___switch_tilde_8h_source.html new file mode 100644 index 00000000..613c693f --- /dev/null +++ b/docs/html/_kiwi_engine___switch_tilde_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_SwitchTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiDsp/KiwiDsp_Signal.h>
25 
26 #include <KiwiEngine/KiwiEngine_Object.h>
27 
28 namespace kiwi { namespace engine {
29 
30  // ================================================================================ //
31  // SWITCH~ //
32  // ================================================================================ //
33 
34  class SwitchTilde : public AudioObject
35  {
36  public:
37 
38  static void declare();
39 
40  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
41 
42  SwitchTilde(model::Object const& model, Patcher& patcher);
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
45 
46  void prepare(PrepareInfo const& infos) override final;
47 
48  void performValue(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
49 
50  void performSig(dsp::Buffer const& input, dsp::Buffer& output) noexcept;
51 
52  private:
53 
54  void openInput(int input);
55 
56  private:
57 
58  size_t m_opened_input;
59  size_t m_num_inputs;
60  };
61 
62 }}
kiwi::dsp::Processor::PrepareInfo
Definition: KiwiDsp_Processor.h:98
+
kiwi::engine::SwitchTilde
Definition: KiwiEngine_SwitchTilde.h:34
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::SwitchTilde::prepare
void prepare(PrepareInfo const &infos) override final
Prepares everything for the perform method.
Definition: KiwiEngine_SwitchTilde.cpp:78
+
kiwi::engine::AudioObject
A pure interface that audio object must implement.
Definition: KiwiEngine_Object.h:189
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::SwitchTilde::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_SwitchTilde.cpp:60
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
kiwi::dsp::Buffer
A class that wraps a vector of Signal objects.
Definition: KiwiDsp_Signal.h:118
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___times_8h_source.html b/docs/html/_kiwi_engine___times_8h_source.html new file mode 100644 index 00000000..fab50da1 --- /dev/null +++ b/docs/html/_kiwi_engine___times_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Times.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Times.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h>
25 #include <KiwiEngine/KiwiEngine_Object.h>
26 
27 namespace kiwi { namespace engine {
28 
29  // ================================================================================ //
30  // OBJECT TIMES //
31  // ================================================================================ //
32 
33  class Times : public Operator
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(model::Object const& model, Patcher& patcher);
40 
41  Times(model::Object const& model, Patcher& patcher);
42 
43  double compute(double lhs, double rhs) const override final;
44  };
45 
46 }}
kiwi::engine::Operator
Definition: KiwiEngine_Operator.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::Times
Definition: KiwiEngine_Times.h:33
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___times_tilde_8h_source.html b/docs/html/_kiwi_engine___times_tilde_8h_source.html new file mode 100644 index 00000000..ba9ce053 --- /dev/null +++ b/docs/html/_kiwi_engine___times_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_TimesTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_TimesTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // TIMES~ //
30  // ================================================================================ //
31 
32  class TimesTilde : public OperatorTilde
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  TimesTilde(model::Object const& model, Patcher& patcher);
41 
42  void compute(dsp::sample_t & result, dsp::sample_t const& lhs, dsp::sample_t const& rhs) override final;
43  };
44 
45 }}
kiwi::engine::OperatorTilde
Definition: KiwiEngine_OperatorTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::engine::TimesTilde
Definition: KiwiEngine_TimesTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___toggle_8h_source.html b/docs/html/_kiwi_engine___toggle_8h_source.html new file mode 100644 index 00000000..27360241 --- /dev/null +++ b/docs/html/_kiwi_engine___toggle_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Toggle.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Toggle.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // OBJECT TOGGLE //
30  // ================================================================================ //
31 
32  class Toggle : public engine::Object
33  {
34  private: // classes
35 
36  class Task;
37 
38  public: // methods
39 
40  static void declare();
41 
42  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
43 
44  Toggle(model::Object const& model, Patcher& patcher);
45 
46  ~Toggle();
47 
48  void parameterChanged(std::string const& name, tool::Parameter const& param) override final;
49 
50  void receive(size_t index, std::vector<tool::Atom> const& args) override final;
51 
52  private: // methods
53 
54  void outputValue();
55 
56  private: // members
57 
58  flip::SignalConnection m_connection;
59  bool m_is_on;
60  };
61 }}
kiwi::engine::Toggle::parameterChanged
void parameterChanged(std::string const &name, tool::Parameter const &param) override final
Called once the data model&#39;s parameters has changed.
Definition: KiwiEngine_Toggle.cpp:55
+
kiwi::engine::Toggle
Definition: KiwiEngine_Toggle.h:32
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi::engine::Toggle::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override final
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Toggle.cpp:71
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___trigger_8h_source.html b/docs/html/_kiwi_engine___trigger_8h_source.html new file mode 100644 index 00000000..97b86b78 --- /dev/null +++ b/docs/html/_kiwi_engine___trigger_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Trigger.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Trigger.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // TRIGGER //
30  // ================================================================================ //
31 
32  class Trigger : public engine::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Trigger(model::Object const& model, Patcher& patcher);
41 
42  ~Trigger() = default;
43 
44  void receive(size_t, std::vector<tool::Atom> const& args) override;
45 
46  private:
47 
48  using trigger_fn_t = std::function<std::vector<tool::Atom>(std::vector<tool::Atom> const&)>;
49  static std::vector<trigger_fn_t> initializeTriggers(std::vector<tool::Atom> const&);
50  const std::vector<trigger_fn_t> m_triggers;
51  };
52 
53 }}
kiwi::engine::Trigger
Definition: KiwiEngine_Trigger.h:32
+
kiwi::engine::Trigger::receive
void receive(size_t, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Trigger.cpp:108
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_engine___unpack_8h_source.html b/docs/html/_kiwi_engine___unpack_8h_source.html new file mode 100644 index 00000000..6e65acf3 --- /dev/null +++ b/docs/html/_kiwi_engine___unpack_8h_source.html @@ -0,0 +1,107 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Unpack.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiEngine_Unpack.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiEngine/KiwiEngine_Object.h>
25 
26 namespace kiwi { namespace engine {
27 
28  // ================================================================================ //
29  // UNPACK //
30  // ================================================================================ //
31 
32  class Unpack : public engine::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(model::Object const& model, Patcher & patcher);
39 
40  Unpack(model::Object const& model, Patcher& patcher);
41 
42  ~Unpack() = default;
43 
44  void receive(size_t index, std::vector<tool::Atom> const& args) override;
45 
46  void output_list();
47 
48  private:
49 
50  std::vector<tool::Atom> m_list;
51  };
52 
53 }}
kiwi::engine::Unpack::receive
void receive(size_t index, std::vector< tool::Atom > const &args) override
Receives a set of arguments via an inlet.
Definition: KiwiEngine_Unpack.cpp:55
+
kiwi::engine::Unpack
Definition: KiwiEngine_Unpack.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::engine::Object
The Object reacts and interacts with other ones by sending and receiving messages via its inlets and ...
Definition: KiwiEngine_Object.h:51
+
kiwi::engine::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiEngine_Patcher.h:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_http_8h_source.html b/docs/html/_kiwi_http_8h_source.html new file mode 100644 index 00000000..087f0ff7 --- /dev/null +++ b/docs/html/_kiwi_http_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiNetwork/KiwiHttp/KiwiHttp.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiHttp.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <memory>
25 #include <chrono>
26 #include <functional>
27 #include <thread>
28 #include <atomic>
29 #include <iostream>
30 
31 #include <boost/asio.hpp>
32 #include <boost/asio/steady_timer.hpp>
33 
34 #include <boost/beast/core.hpp>
35 #include <boost/beast/http.hpp>
36 
37 namespace beast = boost::beast;
38 
39 namespace kiwi { namespace network { namespace http {
40 
41  using Timeout = std::chrono::milliseconds;
42  using Error = beast::error_code;
43 
44  // ================================================================================ //
45  // RESPONSE //
46  // ================================================================================ //
47 
48  template<class BodyType>
49  class Response : public beast::http::response<BodyType>
50  {
51  public:
52  Error error;
53  };
54 
55  template<class BodyType>
56  using Request = beast::http::request<BodyType>;
57 
58  // ================================================================================ //
59  // QUERY //
60  // ================================================================================ //
61 
62  template<class ReqType, class ResType>
63  class Query
64  {
65  private: // classes
66 
67  using Callback = std::function<void(Response<ResType> const&)>;
68 
69  public: // methods
70 
72  Query(std::unique_ptr<Request<ReqType>> request,
73  std::string port);
74 
77  ~Query();
78 
82  Response<ResType> writeQuery(Timeout timeout = Timeout(0));
83 
86  void writeQueryAsync(std::function<void(Response<ResType> const& res)> && callback, Timeout timeout = Timeout(0));
87 
91  void cancel();
92 
94  bool executed();
95 
96  private: // methods
97 
98  using tcp = boost::asio::ip::tcp;
99 
101  void init(Timeout timeout);
102 
104  void handleTimeout(beast::error_code const& error);
105 
107  void connect(tcp::resolver::iterator iterator);
108 
110  void write();
111 
113  void read();
114 
116  void shutdown(beast::error_code const& error);
117 
118  private: // members
119 
120  std::unique_ptr<Request<ReqType>> m_request;
121  Response<ResType> m_response;
122 
123  std::string m_port;
124  boost::asio::io_service m_io_service;
125  tcp::socket m_socket;
126  boost::asio::steady_timer m_timer;
127  tcp::resolver m_resolver;
128  beast::flat_buffer m_buffer;
129  std::thread m_thread;
130  std::atomic<bool> m_executed;
131  Callback m_callback;
132 
133  private: // deleted methods
134 
135  Query() = delete;
136  Query(Query const& other) = delete;
137  Query(Query && other) = delete;
138  Query& operator=(Query const& other) = delete;
139  Query& operator=(Query && other) = delete;
140  };
141 
142 }}} // namespace kiwi::network::http
143 
144 #include "KiwiHttp.hpp"
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::network::http::Response
Definition: KiwiHttp.h:49
+
kiwi::network::http::Query
Definition: KiwiHttp.h:63
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_http_8hpp_source.html b/docs/html/_kiwi_http_8hpp_source.html new file mode 100644 index 00000000..c8ebaf4f --- /dev/null +++ b/docs/html/_kiwi_http_8hpp_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiNetwork/KiwiHttp/KiwiHttp.hpp Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiHttp.hpp
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 namespace kiwi { namespace network { namespace http {
25 
26  // ================================================================================ //
27  // HTTP QUERY //
28  // ================================================================================ //
29 
30  template<class ReqType, class ResType>
31  Query<ReqType, ResType>::Query(std::unique_ptr<beast::http::request<ReqType>> request,
32  std::string port)
33  : m_request(std::move(request))
34  , m_response()
35  , m_port(port)
36  , m_io_service()
37  , m_socket(m_io_service)
38  , m_timer(m_socket.get_io_service())
39  , m_resolver(m_socket.get_io_service())
40  , m_buffer()
41  , m_thread()
42  , m_executed(false)
43  , m_callback()
44  {
45  }
46 
47  template<class ReqType, class ResType>
48  Query<ReqType, ResType>::~Query()
49  {
50  if (m_thread.joinable())
51  {
52  m_thread.join();
53  }
54  }
55 
56  template<class ReqType, class ResType>
57  Response<ResType> Query<ReqType, ResType>::writeQuery(Timeout timeout)
58  {
59  if (m_thread.joinable())
60  {
61  m_thread.join();
62  }
63 
64  if (!executed())
65  {
66  init(timeout);
67 
68  while(!executed())
69  {
70  m_socket.get_io_service().poll_one();
71  }
72  }
73 
74  return m_response;
75  }
76 
77  template<class ReqType, class ResType>
78  void Query<ReqType, ResType>::writeQueryAsync(std::function<void(Response<ResType> const& res)> && callback, Timeout timeout)
79  {
80  if (!executed() && !m_thread.joinable())
81  {
82  init(timeout);
83 
84  m_callback = std::move(callback);
85 
86  m_thread = std::thread([this]()
87  {
88  while(!executed())
89  {
90  m_socket.get_io_service().poll_one();
91  }
92  });
93  }
94  }
95 
96  template<class ReqType, class ResType>
97  void Query<ReqType, ResType>::cancel()
98  {
99  if (m_timer.cancel() != 0)
100  {
101  if (m_thread.joinable())
102  {
103  m_thread.join();
104  }
105  }
106 
107  if (!m_executed)
108  {
109  shutdown(boost::asio::error::basic_errors::timed_out);
110  }
111  }
112 
113  template<class ReqType, class ResType>
114  bool Query<ReqType, ResType>::executed()
115  {
116  return m_executed.load();
117  }
118 
119  template<class ReqType, class ResType>
120  void Query<ReqType, ResType>::init(Timeout timeout)
121  {
122  if (timeout > Timeout(0))
123  {
124  m_timer.expires_from_now(timeout);
125 
126  m_timer.async_wait([this](Error const& error)
127  {
128  handleTimeout(error);
129  });
130  }
131 
132  m_request->prepare_payload();
133 
134  const std::string host = m_request->at(beast::http::field::host).to_string();
135 
136  m_resolver.async_resolve({host, m_port}, [this](Error const& error,
137  tcp::resolver::iterator iterator)
138  {
139  if (error)
140  {
141  shutdown(error);
142  }
143  else
144  {
145  connect(iterator);
146  }
147  });
148  }
149 
150  template<class ReqType, class ResType>
151  void Query<ReqType, ResType>::handleTimeout(Error const& error)
152  {
153  shutdown(boost::asio::error::basic_errors::timed_out);
154  }
155 
156  template<class ReqType, class ResType>
157  void Query<ReqType, ResType>::connect(tcp::resolver::iterator iterator)
158  {
159  boost::asio::async_connect(m_socket, iterator, [this](Error const& error,
160  tcp::resolver::iterator i){
161  if (error)
162  {
163  shutdown(error);
164  }
165  else
166  {
167  write();
168  }
169  });
170  }
171 
172  template<class ReqType, class ResType>
173  void Query<ReqType, ResType>::write()
174  {
175  beast::http::async_write(m_socket, *m_request, [this](Error const& error)
176  {
177  if (error)
178  {
179  shutdown(error);
180  }
181  else
182  {
183  read();
184  }
185  });
186  }
187 
188  template<class ReqType, class ResType>
189  void Query<ReqType, ResType>::read()
190  {
191  beast::http::async_read(m_socket, m_buffer, m_response, [this](Error const& error)
192  {
193  shutdown(error);
194  });
195  }
196 
197  template<class ReqType, class ResType>
198  void Query<ReqType, ResType>::shutdown(Error const& error)
199  {
200  if (error)
201  {
202  m_response.error = error;
203  }
204 
205  boost::system::error_code ec;
206  m_socket.shutdown(tcp::socket::shutdown_both, ec);
207 
208  if (m_callback)
209  {
210  m_callback(m_response);
211  }
212 
213  m_executed.store(true);
214  }
215 
216 }}} // namespace kiwi::network::http
kiwi::network::http::Query::~Query
~Query()
Destructor.
Definition: KiwiHttp.hpp:48
+
kiwi::network::http::Query::cancel
void cancel()
Cancels the request.
Definition: KiwiHttp.hpp:97
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+ +
kiwi::network::http::Query::writeQueryAsync
void writeQueryAsync(std::function< void(Response< ResType > const &res)> &&callback, Timeout timeout=Timeout(0))
Calls the request on a specific thread.
Definition: KiwiHttp.hpp:78
+
kiwi::network::http::Query
Definition: KiwiHttp.h:63
+
kiwi::network::http::Query::executed
bool executed()
Returns true if the query was executed or cancelled.
Definition: KiwiHttp.hpp:114
+
kiwi::network::http::Query::writeQuery
Response< ResType > writeQuery(Timeout timeout=Timeout(0))
Call request on the network.
Definition: KiwiHttp.hpp:57
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_http___session_8h_source.html b/docs/html/_kiwi_http___session_8h_source.html new file mode 100644 index 00000000..0fe62b7b --- /dev/null +++ b/docs/html/_kiwi_http___session_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiHttp_Session.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiHttp.h"
25 
26 namespace kiwi { namespace network { namespace http {
27 
28  // ================================================================================ //
29  // PAYLOAD //
30  // ================================================================================ //
31 
32  class Payload
33  {
34  public:
35 
36  struct Pair;
37 
38  Payload() = default;
39 
40  template <class It>
41  Payload(const It begin, const It end);
42 
43  Payload(std::initializer_list<Pair> const& pairs);
44 
45  void AddPair(Pair const& pair);
46 
47  std::string content;
48  };
49 
50  // ================================================================================ //
51  // PARAMETERS //
52  // ================================================================================ //
53 
54  class Parameters
55  {
56  public:
57 
58  struct Parameter;
59 
60  Parameters() = default;
61  Parameters(const std::initializer_list<Parameter>& parameters);
62 
63  void AddParameter(Parameter const& parameter);
64 
65  std::string content;
66  };
67 
68  struct Parameters::Parameter
69  {
70  template <typename KeyType, typename ValueType>
71  Parameter(KeyType&& key, ValueType&& value);
72 
73  std::string key;
74  std::string value;
75  };
76 
77  // ================================================================================ //
78  // BODY //
79  // ================================================================================ //
80 
81  class Body
82  {
83  public:
84 
85  Body() = default;
86  Body(std::string const& body);
87 
88  std::string content;
89  };
90 
91  // ================================================================================ //
92  // SESSION //
93  // ================================================================================ //
94 
95  class Session
96  {
97  private: // classes
98 
99  using HttpQuery = Query<beast::http::string_body, beast::http::string_body>;
100 
101  public: // methods
102 
103  using Response = http::Response<beast::http::string_body>;
104  using Callback = std::function<void(Response)>;
105 
106  Session();
107  ~Session() = default;
108 
109  uint64_t getId() const;
110 
111  void setHost(std::string const& host);
112  void setPort(std::string const& port);
113  void setTarget(std::string const& endpoint);
114  void setTimeout(Timeout timeout);
115  void setAuthorization(std::string const& auth);
116 
117  void setParameters(Parameters && parameters);
118  void setPayload(Payload && payload);
119  void setBody(std::string const& content);
120 
121  bool executed();
122  void cancel();
123 
124  Response Get();
125  void GetAsync(Callback callback);
126 
127  Response Post();
128  void PostAsync(Callback callback);
129 
130  Response Put();
131  void PutAsync(Callback callback);
132 
133  Response Delete();
134  void DeleteAsync(Callback callback);
135 
136  private: // methods
137 
138  void initQuery();
139 
140  Response makeResponse(beast::http::verb verb);
141  void makeResponse(beast::http::verb verb, Callback && callback);
142 
143  private: // members
144 
145  std::string m_port;
146  std::string m_target;
147  Parameters m_parameters;
148  Payload m_payload;
149  Body m_body;
150  Timeout m_timeout;
151  uint64_t m_id;
152 
153  std::unique_ptr<HttpQuery> m_query;
154  beast::http::request_header<> m_req_header;
155  };
156 
157 }}} // namespace kiwi::network::http
158 
159 #include "KiwiHttp_Session.hpp"
kiwi::network::http::Session
Definition: KiwiHttp_Session.h:95
+
kiwi::network::http::Payload
Definition: KiwiHttp_Session.h:32
+
kiwi::network::http::Payload::Pair
Definition: KiwiHttp_Session.hpp:39
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::network::http::Response
Definition: KiwiHttp.h:49
+
kiwi::network::http::Parameters::Parameter
Definition: KiwiHttp_Session.h:68
+
kiwi::network::http::Query
Definition: KiwiHttp.h:63
+
kiwi::network::http::Parameters
Definition: KiwiHttp_Session.h:54
+
kiwi::network::http::Body
Definition: KiwiHttp_Session.h:81
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_http___session_8hpp_source.html b/docs/html/_kiwi_http___session_8hpp_source.html new file mode 100644 index 00000000..6a2add4e --- /dev/null +++ b/docs/html/_kiwi_http___session_8hpp_source.html @@ -0,0 +1,103 @@ + + + + + + +Kiwi: Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.hpp Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiHttp_Session.hpp
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 namespace kiwi { namespace network { namespace http {
25 
26  // ================================================================================ //
27  // HTTP PAYLOAD //
28  // ================================================================================ //
29 
30  template <class It>
31  Payload::Payload(const It begin, const It end)
32  {
33  for (It pair = begin; pair != end; ++pair)
34  {
35  AddPair(*pair);
36  }
37  }
38 
39  struct Payload::Pair
40  {
41  template <typename KeyType, typename ValueType,
42  typename std::enable_if<!std::is_integral<ValueType>::value, bool>::type = true>
43  Pair(KeyType&& p_key, ValueType&& p_value)
44  : key{std::forward<KeyType>(p_key)}
45  , value{std::forward<ValueType>(p_value)}
46  {
47  ;
48  }
49 
50  template <typename KeyType>
51  Pair(KeyType&& p_key, const std::int32_t& p_value)
52  : key{std::forward<KeyType>(p_key)}
53  , value{std::to_string(p_value)}
54  {
55  ;
56  }
57 
58  std::string key;
59  std::string value;
60  };
61 
62  // ================================================================================ //
63  // HTTP PARAMETERS //
64  // ================================================================================ //
65 
66  template <typename KeyType, typename ValueType>
67  Parameters::Parameter::Parameter(KeyType&& key, ValueType&& value)
68  : key{std::forward<KeyType>(key)}
69  , value{std::forward<ValueType>(value)}
70  {
71  ;
72  }
73 
74 }}} // namespace kiwi::network::http
kiwi::network::http::Payload::Pair
Definition: KiwiHttp_Session.hpp:39
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_http___util_8h_source.html b/docs/html/_kiwi_http___util_8h_source.html new file mode 100644 index 00000000..2dc96d0b --- /dev/null +++ b/docs/html/_kiwi_http___util_8h_source.html @@ -0,0 +1,102 @@ + + + + + + +Kiwi: Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Util.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiHttp_Util.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <string>
25 
26 namespace kiwi { namespace network { namespace http { namespace util {
27 
28  std::string urlEncode(std::string const& response);
29 
30 }}}} // namespace kiwi::network::http::util
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___adc_tilde_8h_source.html b/docs/html/_kiwi_model___adc_tilde_8h_source.html new file mode 100644 index 00000000..0b1c33c0 --- /dev/null +++ b/docs/html/_kiwi_model___adc_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_AdcTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_AdcTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT ADC~ //
30  // ================================================================================ //
31 
33  class AdcTilde : public model::Object
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
40 
41  AdcTilde(flip::Default& d): model::Object(d){}
42 
43  AdcTilde(std::vector<tool::Atom> const& args);
44 
45  std::vector<size_t> parseArgsAsChannelRoutes(std::vector<tool::Atom> const& args) const;
46 
47  std::string getIODescription(bool is_inlet, size_t index) const override;
48  };
49 
50 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::AdcTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_AdcTilde.cpp:113
+
kiwi::model::AdcTilde
Definition: KiwiModel_AdcTilde.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___bang_8h_source.html b/docs/html/_kiwi_model___bang_8h_source.html new file mode 100644 index 00000000..8f84ec24 --- /dev/null +++ b/docs/html/_kiwi_model___bang_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Bang.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Bang.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT BANG //
30  // ================================================================================ //
31 
32  class Bang : public model::Object
33  {
34  public: // enum
35 
36  enum Signal : SignalKey
37  {
38  TriggerBang
39  };
40 
41  public: // methods
42 
43  static void declare();
44 
45  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
46 
47  Bang(flip::Default& d);
48 
49  Bang(std::vector<tool::Atom> const& args);
50 
51  std::string getIODescription(bool is_inlet, size_t index) const override;
52  };
53 
54 }}
kiwi::model::Bang
Definition: KiwiModel_Bang.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Bang::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Bang.cpp:72
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___clip_8h_source.html b/docs/html/_kiwi_model___clip_8h_source.html new file mode 100644 index 00000000..6c7ac2a2 --- /dev/null +++ b/docs/html/_kiwi_model___clip_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Clip.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // CLIP //
30  // ================================================================================ //
31 
32  class Clip : public Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Clip(flip::Default& d): Object(d){};
41 
42  Clip(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::Clip::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Clip.cpp:66
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object::Object
Object()
Constructor.
Definition: KiwiModel_Object.cpp:163
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Clip
Definition: KiwiModel_Clip.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___clip_tilde_8h_source.html b/docs/html/_kiwi_model___clip_tilde_8h_source.html new file mode 100644 index 00000000..f8da6ce9 --- /dev/null +++ b/docs/html/_kiwi_model___clip_tilde_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_ClipTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // CLIP~ //
30  // ================================================================================ //
31 
32  class ClipTilde : public Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  ClipTilde(flip::Default& d): Object(d){};
41 
42  ClipTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::ClipTilde
Definition: KiwiModel_ClipTilde.h:32
+
kiwi::model::Object::Object
Object()
Constructor.
Definition: KiwiModel_Object.cpp:163
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::ClipTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_ClipTilde.cpp:66
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___comment_8h_source.html b/docs/html/_kiwi_model___comment_8h_source.html new file mode 100644 index 00000000..b5e6a2a6 --- /dev/null +++ b/docs/html/_kiwi_model___comment_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Comment.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Comment.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <flip/String.h>
25 
26 #include <KiwiModel/KiwiModel_Object.h>
27 
28 namespace kiwi { namespace model {
29 
30  // ================================================================================ //
31  // OBJECT COMMENT //
32  // ================================================================================ //
33 
34  class Comment : public model::Object
35  {
36  public: // methods
37 
38  Comment(flip::Default& d);
39 
40  Comment(std::vector<tool::Atom> const& args);
41 
42  std::string getIODescription(bool is_inlet, size_t index) const override;
43 
44  void writeAttribute(std::string const& name, tool::Parameter const& parameter) override final;
45 
46  void readAttribute(std::string const& name, tool::Parameter & parameter) const override final;
47 
48  bool attributeChanged(std::string const& name) const override final;
49 
50  static void declare();
51 
52  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
53 
54  private: // members
55 
56  flip::String m_comment_text;
57  };
58 }}
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi::model::Comment::attributeChanged
bool attributeChanged(std::string const &name) const override final
Checks the data model to see if a parameter has changed.
Definition: KiwiModel_Comment.cpp:92
+
kiwi::model::Comment::readAttribute
void readAttribute(std::string const &name, tool::Parameter &parameter) const override final
Reads the model to initialize a parameter.
Definition: KiwiModel_Comment.cpp:85
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Comment::writeAttribute
void writeAttribute(std::string const &name, tool::Parameter const &parameter) override final
Writes the parameter into data model.
Definition: KiwiModel_Comment.cpp:77
+
kiwi::model::Comment
Definition: KiwiModel_Comment.h:34
+
kiwi::model::Comment::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Comment.cpp:104
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___converter_8h_source.html b/docs/html/_kiwi_model___converter_8h_source.html new file mode 100644 index 00000000..57428f19 --- /dev/null +++ b/docs/html/_kiwi_model___converter_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Converters/KiwiModel_Converter.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Converter.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <flip/BackEndIR.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // CONVERTER //
30  // ================================================================================ //
31 
33  class Converter
34  {
35  public: // methods
36 
40  static bool process(flip::BackEndIR & backend);
41 
42  private: // methods
43 
45  static void convert_v1_v2(flip::BackEndIR & backend);
46 
48  static void process_rollback(flip::BackEndIR & backend);
49  };
50 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Converter
Converts a document&#39;s backend representation to meet current version representation.
Definition: KiwiModel_Converter.h:33
+
kiwi::model::Converter::process
static bool process(flip::BackEndIR &backend)
Tries converting current data model version.
Definition: KiwiModel_Converter.cpp:46
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___dac_tilde_8h_source.html b/docs/html/_kiwi_model___dac_tilde_8h_source.html new file mode 100644 index 00000000..154ea8d6 --- /dev/null +++ b/docs/html/_kiwi_model___dac_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_DacTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT DAC~ //
30  // ================================================================================ //
31 
33  class DacTilde : public model::Object
34  {
35  public:
36 
37  static void declare();
38 
39  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& arsg);
40 
41  DacTilde(std::vector<tool::Atom> const& args);
42 
43  DacTilde(flip::Default& d): model::Object(d){}
44 
45  std::vector<size_t> parseArgsAsChannelRoutes(std::vector<tool::Atom> const& args) const;
46 
47  std::string getIODescription(bool is_inlet, size_t index) const override;
48  };
49 
50 }}
kiwi::model::DacTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_DacTilde.cpp:113
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::DacTilde
Definition: KiwiModel_DacTilde.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___data_model_8h_source.html b/docs/html/_kiwi_model___data_model_8h_source.html index 396bc314..dfafe50c 100644 --- a/docs/html/_kiwi_model___data_model_8h_source.html +++ b/docs/html/_kiwi_model___data_model_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_DataModel.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiModel_DataModel.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "flip/DataModel.h"
25 
26 namespace kiwi
27 {
28  namespace model
29  {
31  class DataModel : public flip::DataModel<DataModel>
32  {
33  public: // methods
34 
37  static void init();
38 
39  private: // methods
40 
42  static void declareObjects();
43 
44  public: // members
45 
46  static bool initialised;
47  };
48  }
49 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::model::DataModel::init
static void init()
Initializes the model.
Definition: KiwiModel_DataModel.cpp:35
-
kiwi::model::DataModel
The Patcher data model.
Definition: KiwiModel_DataModel.h:31
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <functional>
25 
26 #include <flip/DataModel.h>
27 
28 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h>
29 
30 namespace kiwi
31 {
32  namespace model
33  {
35  class DataModel : public flip::DataModel<DataModel>
36  {
37  public: // methods
38 
40  static void declareObjects();
41 
45  static void init(std::function<void(void)> declare_object = &DataModel::declareObjects);
46 
47  public: // members
48 
49  static bool initialised;
50  };
51  }
52 }
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::DataModel::init
static void init(std::function< void(void)> declare_object=&DataModel::declareObjects)
Initializes the model.
Definition: KiwiModel_DataModel.cpp:102
+
kiwi::model::DataModel::declareObjects
static void declareObjects()
Declare objects.
Definition: KiwiModel_DataModel.cpp:34
+
kiwi::model::DataModel
The Patcher data model.
Definition: KiwiModel_DataModel.h:35
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___def_8h_source.html b/docs/html/_kiwi_model___def_8h_source.html index 64317214..869ea489 100644 --- a/docs/html/_kiwi_model___def_8h_source.html +++ b/docs/html/_kiwi_model___def_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_Def.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiModel_Def.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #define KIWI_MODEL_VERSION_STRING "v0.1.0"
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #define KIWI_MODEL_VERSION_STRING "v3"
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___delay_8h_source.html b/docs/html/_kiwi_model___delay_8h_source.html new file mode 100644 index 00000000..a71be7b1 --- /dev/null +++ b/docs/html/_kiwi_model___delay_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Delay.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Delay.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT DELAY //
30  // ================================================================================ //
31 
32  class Delay : public model::Object
33  {
34  public: // methods
35 
36  Delay(flip::Default& d) : model::Object(d) {};
37 
38  Delay(std::vector<tool::Atom> const& args);
39 
40  std::string getIODescription(bool is_inlet, size_t index) const override;
41 
42  static void declare();
43 
44  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Delay
Definition: KiwiModel_Delay.h:32
+
kiwi::model::Delay::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Delay.cpp:70
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___delay_simple_tilde_8h_source.html b/docs/html/_kiwi_model___delay_simple_tilde_8h_source.html new file mode 100644 index 00000000..3e881d25 --- /dev/null +++ b/docs/html/_kiwi_model___delay_simple_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DelaySimpleTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_DelaySimpleTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT DELAYSIMPLETILDE~ //
30  // ================================================================================ //
31 
32  class DelaySimpleTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  DelaySimpleTilde(flip::Default& d): model::Object(d){};
41 
42  DelaySimpleTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::DelaySimpleTilde
Definition: KiwiModel_DelaySimpleTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::DelaySimpleTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_DelaySimpleTilde.cpp:73
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___different_8h_source.html b/docs/html/_kiwi_model___different_8h_source.html new file mode 100644 index 00000000..05d56b5a --- /dev/null +++ b/docs/html/_kiwi_model___different_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Different.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Different.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT DIFFERENT //
31  // ================================================================================ //
32 
33  class Different : public Operator
34  {
35  public:
36 
37  Different(flip::Default& d) : Operator(d) {}
38 
39  Different(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Different
Definition: KiwiModel_Different.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___different_tilde_8h_source.html b/docs/html/_kiwi_model___different_tilde_8h_source.html new file mode 100644 index 00000000..caf2db3b --- /dev/null +++ b/docs/html/_kiwi_model___different_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DifferentTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_DifferentTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT !=~ //
30  // ================================================================================ //
31 
32  class DifferentTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  DifferentTilde(flip::Default& d): OperatorTilde(d){};
41 
42  DifferentTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
kiwi::model::DifferentTilde
Definition: KiwiModel_DifferentTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___divide_8h_source.html b/docs/html/_kiwi_model___divide_8h_source.html new file mode 100644 index 00000000..ac935710 --- /dev/null +++ b/docs/html/_kiwi_model___divide_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Divide.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Divide.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT DIVIDE //
31  // ================================================================================ //
32 
33  class Divide : public Operator
34  {
35  public:
36 
37  Divide(flip::Default& d) : Operator(d) {}
38 
39  Divide(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Divide
Definition: KiwiModel_Divide.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___divide_tilde_8h_source.html b/docs/html/_kiwi_model___divide_tilde_8h_source.html new file mode 100644 index 00000000..3e2a23b6 --- /dev/null +++ b/docs/html/_kiwi_model___divide_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DivideTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_DivideTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT /~ //
30  // ================================================================================ //
31 
32  class DivideTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  DivideTilde(flip::Default& d): OperatorTilde(d){};
41 
42  DivideTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
kiwi::model::DivideTilde
Definition: KiwiModel_DivideTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___document_manager_8h_source.html b/docs/html/_kiwi_model___document_manager_8h_source.html new file mode 100644 index 00000000..269094e7 --- /dev/null +++ b/docs/html/_kiwi_model___document_manager_8h_source.html @@ -0,0 +1,117 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_DocumentManager.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_DocumentManager.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <flip/History.h>
25 #include <flip/HistoryStoreMemory.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // DOCUMENT MANAGER //
31  // ================================================================================ //
32 
33  class DocumentManager
34  {
35  public:
36 
38  DocumentManager(flip::DocumentBase & document);
39 
41  ~DocumentManager();
42 
45  static void commit(flip::Type& type, std::string action = std::string());
46 
48  static void connect(flip::Type& type, const std::string host, uint16_t port, uint64_t session_id);
49 
51  static void pull(flip::Type& type);
52 
56  static void startCommitGesture(flip::Type& type);
57 
61  static void commitGesture(flip::Type& type, std::string label);
62 
66  static void endCommitGesture(flip::Type& type);
67 
69  static bool isInCommitGesture(flip::Type& type);
70 
72  bool canUndo();
73 
75  std::string getUndoLabel();
76 
78  void undo();
79 
81  bool canRedo();
82 
84  std::string getRedoLabel();
85 
87  void redo();
88 
90  template<class T> T* get(flip::Ref const& ref)
91  {
92  return m_document.object_ptr<T>(ref);
93  }
94 
95  private:
96 
98  void commit(std::string action);
99 
101  void pull();
102 
104  void push();
105 
107  void startCommitGesture();
108 
110  void commitGesture(std::string action);
111 
113  void endCommitGesture();
114 
115  private:
116 
117  flip::DocumentBase& m_document;
118  flip::History<flip::HistoryStoreMemory> m_history;
119  bool m_gesture_flag;
120  size_t m_gesture_cnt;
121 
122  private:
123 
124  DocumentManager() = delete;
125  DocumentManager(const DocumentManager& rhs) = delete;
126  DocumentManager(DocumentManager&& rhs) = delete;
127  DocumentManager& operator =(const DocumentManager& rhs) = delete;
128  DocumentManager& operator =(DocumentManager&& rhs) = delete;
129  bool operator ==(DocumentManager const& rhs) const = delete;
130  bool operator !=(DocumentManager const& rhs) const = delete;
131  };
132 }}
kiwi::model::DocumentManager::getUndoLabel
std::string getUndoLabel()
Returns the label of the last undo action.
Definition: KiwiModel_DocumentManager.cpp:85
+
kiwi::model::DocumentManager
Definition: KiwiModel_DocumentManager.h:33
+
kiwi::model::DocumentManager::canRedo
bool canRedo()
Returns true if there is an action to redo.
Definition: KiwiModel_DocumentManager.cpp:99
+
kiwi::model::DocumentManager::getRedoLabel
std::string getRedoLabel()
Returns the label of the next redo action.
Definition: KiwiModel_DocumentManager.cpp:104
+
kiwi::model::DocumentManager::connect
static void connect(flip::Type &type, const std::string host, uint16_t port, uint64_t session_id)
Connect the DocumentManager to a remote server.
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::DocumentManager::endCommitGesture
static void endCommitGesture(flip::Type &type)
Ends a commit gesture.
Definition: KiwiModel_DocumentManager.cpp:68
+
kiwi::model::DocumentManager::canUndo
bool canUndo()
Returns true if there is an action to undo.
Definition: KiwiModel_DocumentManager.cpp:80
+
kiwi::model::DocumentManager::~DocumentManager
~DocumentManager()
Destructor.
Definition: KiwiModel_DocumentManager.cpp:40
+
kiwi::model::DocumentManager::isInCommitGesture
static bool isInCommitGesture(flip::Type &type)
Returns true if the document is currently commiting a gesture.
Definition: KiwiModel_DocumentManager.cpp:74
+
kiwi::model::DocumentManager::redo
void redo()
Redo the next action.
Definition: KiwiModel_DocumentManager.cpp:111
+
kiwi::model::DocumentManager::commitGesture
static void commitGesture(flip::Type &type, std::string label)
Commit a gesture.
Definition: KiwiModel_DocumentManager.cpp:62
+
kiwi::model::DocumentManager::startCommitGesture
static void startCommitGesture(flip::Type &type)
Starts a commit gesture.
Definition: KiwiModel_DocumentManager.cpp:56
+
kiwi::model::DocumentManager::pull
static void pull(flip::Type &type)
Pull changes from remote server.
Definition: KiwiModel_DocumentManager.cpp:50
+
kiwi::model::DocumentManager::undo
void undo()
Undo the last action.
Definition: KiwiModel_DocumentManager.cpp:92
+
kiwi::model::DocumentManager::commit
static void commit(flip::Type &type, std::string action=std::string())
Commit and push.
Definition: KiwiModel_DocumentManager.cpp:44
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___equal_8h_source.html b/docs/html/_kiwi_model___equal_8h_source.html new file mode 100644 index 00000000..d078a6b4 --- /dev/null +++ b/docs/html/_kiwi_model___equal_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Equal.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Equal.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT EQUAL //
31  // ================================================================================ //
32 
33  class Equal : public Operator
34  {
35  public:
36 
37  Equal(flip::Default& d) : Operator(d) {}
38 
39  Equal(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Equal
Definition: KiwiModel_Equal.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___equal_tilde_8h_source.html b/docs/html/_kiwi_model___equal_tilde_8h_source.html new file mode 100644 index 00000000..d0865575 --- /dev/null +++ b/docs/html/_kiwi_model___equal_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_EqualTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_EqualTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT ==~ //
30  // ================================================================================ //
31 
32  class EqualTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  EqualTilde(flip::Default& d): OperatorTilde(d){};
41 
42  EqualTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::EqualTilde
Definition: KiwiModel_EqualTilde.h:32
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___error_8h_source.html b/docs/html/_kiwi_model___error_8h_source.html new file mode 100644 index 00000000..dee457ba --- /dev/null +++ b/docs/html/_kiwi_model___error_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Error.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Error.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 namespace kiwi { namespace model {
25 
26  // ==================================================================================== //
27  // ERROR //
28  // ==================================================================================== //
29 
31  class Error : public std::runtime_error
32  {
33  public:
34 
36  explicit Error(const std::string& message) :
37  std::runtime_error(std::string("kiwi::model ") + message) {}
38 
40  explicit Error(const char* message) :
41  std::runtime_error(std::string("kiwi::model ") + std::string(message)) {}
42 
44  virtual inline ~Error() noexcept = default;
45  };
46 
47 }}
kiwi::model::Error
A generic exception for engine failures.
Definition: KiwiModel_Error.h:31
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Error::Error
Error(const char *message)
The const char* constructor.
Definition: KiwiModel_Error.h:40
+
kiwi::model::Error::~Error
virtual ~Error() noexcept=default
The destructor.
+
kiwi::model::Error::Error
Error(const std::string &message)
The std::string constructor.
Definition: KiwiModel_Error.h:36
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___error_box_8h_source.html b/docs/html/_kiwi_model___error_box_8h_source.html new file mode 100644 index 00000000..81ee94df --- /dev/null +++ b/docs/html/_kiwi_model___error_box_8h_source.html @@ -0,0 +1,112 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ErrorBox.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_ErrorBox.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // ERRORBOX //
30  // ================================================================================ //
31 
32  class ErrorBox : public model::Object
33  {
34  public:
35 
37  ErrorBox(flip::Default& d) : model::Object(d) {}
38 
40  ErrorBox();
41 
44  void setInlets(flip::Array<Inlet> const& inlets);
45 
48  void setOutlets(flip::Array<Outlet> const& outlets);
49 
51  void setError(std::string const& error);
52 
54  std::string getError() const;
55 
56  std::string getIODescription(bool is_inlet, size_t index) const override;
57 
59  static void declare();
60 
62  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
63 
64  private: // members
65 
66  std::string m_error;
67  };
68 
69 }}
kiwi::model::ErrorBox::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_ErrorBox.cpp:69
+
kiwi::model::ErrorBox::setError
void setError(std::string const &error)
Sets the message error that caused the errorbox construction.
Definition: KiwiModel_ErrorBox.cpp:74
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::ErrorBox::setOutlets
void setOutlets(flip::Array< Outlet > const &outlets)
Set the number of inlets.
Definition: KiwiModel_ErrorBox.cpp:64
+
kiwi::model::ErrorBox::create
static std::unique_ptr< Object > create(std::vector< tool::Atom > const &args)
The error box construction method.
Definition: KiwiModel_ErrorBox.cpp:49
+
kiwi::model::ErrorBox
Definition: KiwiModel_ErrorBox.h:32
+
kiwi::model::ErrorBox::getError
std::string getError() const
Returns the error that caused the errorbox construction.
Definition: KiwiModel_ErrorBox.cpp:79
+
kiwi::model::ErrorBox::ErrorBox
ErrorBox()
Constructor.
Definition: KiwiModel_ErrorBox.cpp:54
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::ErrorBox::ErrorBox
ErrorBox(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_ErrorBox.h:37
+
kiwi::model::ErrorBox::setInlets
void setInlets(flip::Array< Inlet > const &inlets)
Set the number of inlets.
Definition: KiwiModel_ErrorBox.cpp:59
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___factory_8h_source.html b/docs/html/_kiwi_model___factory_8h_source.html index 21b371f8..84186668 100644 --- a/docs/html/_kiwi_model___factory_8h_source.html +++ b/docs/html/_kiwi_model___factory_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_Factory.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
KiwiModel_Factory.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_Object.h"
25 #include "KiwiModel_DataModel.h"
26 
27 namespace kiwi
28 {
29  namespace model
30  {
31  // ================================================================================ //
32  // OBJECT FACTORY //
33  // ================================================================================ //
34 
36  class Factory
37  {
38  public: // classes
39 
40  class ObjectClassBase;
41  template<class T> class ObjectClass;
42 
43  public: // methods
44 
51  template<typename TModel> struct isValidObject
52  {
53  enum
54  {
55  value = std::is_base_of<model::Object, TModel>::value
56  && !std::is_abstract<TModel>::value
57  && std::is_constructible<TModel, std::string, std::vector<Atom>>::value
58  && std::is_constructible<TModel, flip::Default &>::value
59  };
60  };
61 
67  template<class TModel>
68  static ObjectClass<TModel>& add(std::string const& name)
69  {
70  static_assert(isValidObject<TModel>::value, "Not a valid Object");
71 
72  assert((!name.empty() && !DataModel::has<TModel>())
73  && "Object name empty or object class already added");
74 
75  // check if the name match the name of another object in the factory.
76  if(has(name))
77  {
78  throw std::runtime_error("The \"" + name + "\" object is already in the factory");
79  }
80 
81  auto& object_classes = getClasses();
82  const auto it = object_classes.emplace(object_classes.end(),
83  std::make_unique<ObjectClass<TModel>>(name));
84 
85  return dynamic_cast<ObjectClass<TModel>&>(*(it->get()));
86  }
87 
93  static std::unique_ptr<model::Object> create(std::string const& name,
94  std::vector<Atom> const& args);
95 
101  static std::unique_ptr<model::Object> create(std::string const& name,
102  flip::Mold const& mold);
103 
109  static void copy(model::Object const& object, flip::Mold& mold);
110 
116  static ObjectClassBase* getClassByName(std::string const& name,
117  const bool ignore_aliases = false);
118 
122  static bool has(std::string const& name);
123 
128  static std::vector<std::string> getNames(const bool ignore_aliases = false,
129  const bool ignore_internals = true);
130 
131  private: // methods
132 
133  using object_classes_t = std::vector<std::unique_ptr<ObjectClassBase>>;
134 
135  using ctor_fn_t = std::function<std::unique_ptr<model::Object>(std::vector<Atom>)>;
136  using mold_maker_fn_t = std::function<void(model::Object const&, flip::Mold&)>;
137  using mold_caster_fn_t = std::function<std::unique_ptr<model::Object>(flip::Mold const&)>;
138 
140  template<class TModel>
141  static ctor_fn_t getCtor(std::string const& name)
142  {
143  return [name](std::vector<Atom> const& args)
144  {
145  return std::make_unique<TModel>(name, args);
146  };
147  }
148 
150  template<class TModel>
151  static mold_maker_fn_t getMoldMaker()
152  {
153  return [](model::Object const& object, flip::Mold& mold)
154  {
155  // make a mold with container_flag active
156  mold.make(static_cast<TModel const&>(object), false);
157  };
158  }
159 
161  template<class TModel>
162  static mold_caster_fn_t getMoldCaster()
163  {
164  return [](flip::Mold const& mold)
165  {
166  flip::Default d;
167  auto object_uptr = std::make_unique<TModel>(d);
168  mold.cast<TModel>(static_cast<TModel&>(*(object_uptr.get())));
169  return object_uptr;
170  };
171  }
172 
174  static std::string sanitizeName(std::string const& name);
175 
177  static object_classes_t& getClasses();
178 
179  private: // deleted methods
180 
181  Factory() = delete;
182  ~Factory() = delete;
183  };
184 
185  // ================================================================================ //
186  // FACTORY OBJECT CLASS BASE //
187  // ================================================================================ //
188 
190  class Factory::ObjectClassBase
191  {
192  public: // methods
193 
195  ObjectClassBase(std::string const& name,
196  std::string const& model_name,
197  const ctor_fn_t ctor,
198  const mold_maker_fn_t mold_maker,
199  const mold_caster_fn_t mold_caster)
200  :
201  m_name(name),
202  m_model_name(model_name),
203  m_ctor(ctor),
204  m_mold_maker(mold_maker),
205  m_mold_caster(mold_caster) {}
206 
208  virtual ~ObjectClassBase() = default;
209 
211  std::string const& getName() const { return m_name; }
212 
214  std::string const& getModelName() const { return m_model_name; }
215 
217  bool isInternal() const noexcept { return m_internal; }
218 
220  void setInternal(const bool is_internal) noexcept { m_internal = is_internal; }
221 
223  bool hasAlias() const noexcept { return !m_aliases.empty(); }
224 
226  std::set<std::string> const& getAliases() const noexcept { return m_aliases; }
227 
229  bool hasAlias(std::string const& alias) const noexcept { return (m_aliases.count(alias) != 0); }
230 
232  void addAlias(std::string alias)
233  {
234  if(!Factory::has(alias))
235  {
236  m_aliases.emplace(std::move(alias));
237  }
238  }
239 
243  std::unique_ptr<model::Object> create(std::vector<Atom> const& args) const
244  { return m_ctor(args); }
245 
249  void moldMake(model::Object const& object, flip::Mold& mold) const
250  { m_mold_maker(object, mold); }
251 
255  std::unique_ptr<model::Object> moldCast(flip::Mold const& mold) const
256  { return m_mold_caster(mold); }
257 
258  private: // members
259 
260  const std::string m_name {};
261  const std::string m_model_name {};
262  std::set<std::string> m_aliases {};
263  const ctor_fn_t m_ctor {};
264  const mold_maker_fn_t m_mold_maker {};
265  const mold_caster_fn_t m_mold_caster {};
266  bool m_internal = false;
267  };
268 
269  // ================================================================================ //
270  // FACTORY OBJECT CLASS //
271  // ================================================================================ //
272 
274  template<class TObjectClass>
275  class Factory::ObjectClass : public ObjectClassBase
276  {
277  public: // methods
278 
279  using class_t = TObjectClass;
280 
281  ObjectClass(std::string const& name)
282  : ObjectClassBase(name,
283  Factory::sanitizeName(name),
284  getCtor<class_t>(name),
285  getMoldMaker<class_t>(),
286  getMoldCaster<class_t>()),
287  m_flip_class(DataModel::declare<class_t>())
288  {
289  m_flip_class.name(getModelName().c_str())
290  .template inherit<model::Object>();
291  }
292 
294  template<class U, U class_t::*ptr_to_member>
295  void addMember(char const* name)
296  {
297  m_flip_class.template member(name);
298  }
299 
300  private: // members
301 
302  flip::Class<class_t>& m_flip_class;
303  };
304  }
305 }
kiwi::model::Factory::getNames
static std::vector< std::string > getNames(const bool ignore_aliases=false, const bool ignore_internals=true)
Gets the names of the objects that has been added to the Factory.
Definition: KiwiModel_Factory.cpp:101
-
kiwi::model::Factory::create
static std::unique_ptr< model::Object > create(std::string const &name, std::vector< Atom > const &args)
Creates a new Object with a name and arguments.
Definition: KiwiModel_Factory.cpp:32
-
kiwi::model::Factory::ObjectClassBase::ObjectClassBase
ObjectClassBase(std::string const &name, std::string const &model_name, const ctor_fn_t ctor, const mold_maker_fn_t mold_maker, const mold_caster_fn_t mold_caster)
Constructor.
Definition: KiwiModel_Factory.h:195
-
kiwi::model::Factory::ObjectClassBase::addAlias
void addAlias(std::string alias)
Adds a creator name alias to the class.
Definition: KiwiModel_Factory.h:232
-
kiwi::model::Factory
The model Object&#39;s factory.
Definition: KiwiModel_Factory.h:36
-
kiwi::model::Factory::copy
static void copy(model::Object const &object, flip::Mold &mold)
Make a mold of this object.
Definition: KiwiModel_Factory.cpp:62
-
kiwi::model::Factory::ObjectClassBase::getAliases
std::set< std::string > const & getAliases() const noexcept
Pass true if this is an internal object.
Definition: KiwiModel_Factory.h:226
-
kiwi::model::Factory::ObjectClassBase::setInternal
void setInternal(const bool is_internal) noexcept
Pass true if this is an internal object.
Definition: KiwiModel_Factory.h:220
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <typeinfo>
25 #include <vector>
26 #include <memory>
27 #include <algorithm>
28 
29 #include <KiwiModel/KiwiModel_ObjectClass.h>
30 #include <KiwiModel/KiwiModel_Object.h>
31 #include <KiwiModel/KiwiModel_DataModel.h>
32 
33 namespace kiwi
34 {
35  namespace model
36  {
37  // ================================================================================ //
38  // OBJECT FACTORY //
39  // ================================================================================ //
40 
42  class Factory
43  {
44  public: // methods
45 
52  template<typename TModel> struct isValidObject
53  {
54  enum
55  {
56  value = std::is_base_of<model::Object, TModel>::value
57  && !std::is_abstract<TModel>::value
58  && std::is_constructible<TModel, flip::Default &>::value
59  };
60  };
61 
67  template<class TModel>
68  static void add(std::unique_ptr<ObjectClass> object_class,
69  flip::Class<TModel> & data_model)
70  {
71  static_assert(isValidObject<TModel>::value, "Not a valid Object");
72 
73  std::string object_name = object_class->getName();
74 
75  assert(std::string(data_model.name()) == object_class->getModelName());
76  assert(!object_name.empty() && "Registring object with invalid name");
77  assert(DataModel::has<TModel>() && "Registering object without declaring its data model");
78 
79  // check if the name match the name of another object in the factory.
80  if(has(object_name))
81  {
82  throw std::runtime_error("The \"" + object_name + "\" object is already in the factory");
83  }
84 
85  // check aliases duplicates
86  std::set<std::string> const& aliases = object_class->getAliases();
87 
88  auto duplicate_aliases = std::find_if(aliases.begin(),
89  aliases.end(),
90  [](std::string const& alias)
91  {
92  return Factory::has(alias);
93  });
94 
95  if (duplicate_aliases != aliases.end())
96  {
97  throw std::runtime_error(object_name + "Adding twice the same alias");
98  }
99 
100  ObjectClass::mold_maker_t mold_maker = [](model::Object const& object, flip::Mold& mold)
101  {
102  mold.make(static_cast<TModel const&>(object), false);
103  };
104 
105  object_class->setMoldMaker(mold_maker);
106 
107  ObjectClass::mold_caster_t mold_caster = [](flip::Mold const& mold)
108  {
109  flip::Default d;
110  auto object_uptr = std::make_unique<TModel>(d);
111  mold.cast<TModel>(static_cast<TModel&>(*(object_uptr.get())));
112  return object_uptr;
113  };
114 
115  object_class->setMoldCaster(mold_caster);
116 
117  object_class->setTypeId(typeid(TModel).hash_code());
118 
119  m_object_classes.emplace_back(std::move(object_class));
120  }
121 
127  static std::unique_ptr<model::Object> create(std::vector<tool::Atom> const& args);
128 
134  static std::unique_ptr<model::Object> create(std::string const& name,
135  flip::Mold const& mold);
136 
142  static void copy(model::Object const& object, flip::Mold& mold);
143 
149  static ObjectClass const* getClassByName(std::string const& name,
150  const bool ignore_aliases = false);
151 
153  static ObjectClass const* getClassByTypeId(size_t type_id);
154 
158  static bool has(std::string const& name);
159 
164  static std::vector<std::string> getNames(const bool ignore_aliases = false,
165  const bool ignore_internals = true);
166 
169  static std::string toModelName(std::string const& name);
170 
173  static std::string toKiwiName(std::string const& name);
174 
175  private: // members
176 
177  static std::vector<std::unique_ptr<ObjectClass>> m_object_classes;
178 
179  private: // deleted methods
180 
181  Factory() = delete;
182  ~Factory() = delete;
183  };
184  }
185 }
kiwi::model::Factory::getNames
static std::vector< std::string > getNames(const bool ignore_aliases=false, const bool ignore_internals=true)
Gets the names of the objects that has been added to the Factory.
Definition: KiwiModel_Factory.cpp:135
+
kiwi::model::Factory::create
static std::unique_ptr< model::Object > create(std::vector< tool::Atom > const &args)
Creates a new Object with a name and arguments.
Definition: KiwiModel_Factory.cpp:38
+
kiwi::model::Factory
The model Object&#39;s factory.
Definition: KiwiModel_Factory.h:42
+
kiwi::model::Factory::copy
static void copy(model::Object const &object, flip::Mold &mold)
Make a mold of this object.
Definition: KiwiModel_Factory.cpp:86
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::model::Factory::ObjectClassBase::getModelName
std::string const & getModelName() const
Returns the name used into the data model of kiwi.
Definition: KiwiModel_Factory.h:214
-
kiwi::model::Factory::isValidObject
isValidObject type traits
Definition: KiwiModel_Factory.h:51
-
kiwi::model::Factory::ObjectClassBase::getName
std::string const & getName() const
Returns the name of the object.
Definition: KiwiModel_Factory.h:211
-
kiwi::model::Factory::add
static ObjectClass< TModel > & add(std::string const &name)
Adds an object model into the Factory.
Definition: KiwiModel_Factory.h:68
-
kiwi::model::Factory::ObjectClassBase::isInternal
bool isInternal() const noexcept
Returns true if it&#39;s an internal object.
Definition: KiwiModel_Factory.h:217
-
kiwi::model::Factory::has
static bool has(std::string const &name)
Returns true if a given string match a registered object class name.
Definition: KiwiModel_Factory.cpp:76
-
kiwi::model::Factory::ObjectClass::addMember
void addMember(char const *name)
Add a flip member to the ObjectClass.
Definition: KiwiModel_Factory.h:295
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::model::Factory::ObjectClassBase::create
std::unique_ptr< model::Object > create(std::vector< Atom > const &args) const
Creates and returns a new Object with a vector of Atom as parameter.
Definition: KiwiModel_Factory.h:243
-
kiwi::model::Factory::getClassByName
static ObjectClassBase * getClassByName(std::string const &name, const bool ignore_aliases=false)
Returns a ptr to an object class thas has this name or alias name.
Definition: KiwiModel_Factory.cpp:88
-
kiwi::model::Factory::ObjectClassBase
ObjectClass base class.
Definition: KiwiModel_Factory.h:190
-
kiwi::model::Factory::ObjectClass
ObjectClass.
Definition: KiwiModel_Factory.h:41
-
kiwi::model::Factory::ObjectClassBase::moldCast
std::unique_ptr< model::Object > moldCast(flip::Mold const &mold) const
Creates and returns a new Object from a flip::Mold.
Definition: KiwiModel_Factory.h:255
-
kiwi::model::Factory::ObjectClassBase::moldMake
void moldMake(model::Object const &object, flip::Mold &mold) const
Copy the content an object instance into a flip::Mold.
Definition: KiwiModel_Factory.h:249
-
kiwi::model::Factory::ObjectClassBase::hasAlias
bool hasAlias() const noexcept
Returns true if this object class has aliases.
Definition: KiwiModel_Factory.h:223
-
kiwi::model::Factory::ObjectClassBase::hasAlias
bool hasAlias(std::string const &alias) const noexcept
Returns true if this class has this alias name.
Definition: KiwiModel_Factory.h:229
+
kiwi::model::Factory::getClassByTypeId
static ObjectClass const * getClassByTypeId(size_t type_id)
Returns the object&#39;s class filtering by type id&#39;s hash code.
Definition: KiwiModel_Factory.cpp:123
+
kiwi::model::Factory::isValidObject
isValidObject type traits
Definition: KiwiModel_Factory.h:52
+
kiwi::model::Factory::add
static void add(std::unique_ptr< ObjectClass > object_class, flip::Class< TModel > &data_model)
Adds an object model into the Factory.
Definition: KiwiModel_Factory.h:68
+
kiwi::model::Factory::has
static bool has(std::string const &name)
Returns true if a given string match a registered object class name.
Definition: KiwiModel_Factory.cpp:100
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::ObjectClass
The static representation of an object.
Definition: KiwiModel_ObjectClass.h:96
+
kiwi::model::Factory::getClassByName
static ObjectClass const * getClassByName(std::string const &name, const bool ignore_aliases=false)
Returns a ptr to an object class thas has this name or alias name.
Definition: KiwiModel_Factory.cpp:111
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___float_8h_source.html b/docs/html/_kiwi_model___float_8h_source.html new file mode 100644 index 00000000..c9ce8b59 --- /dev/null +++ b/docs/html/_kiwi_model___float_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Float.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // FLOAT //
30  // ================================================================================ //
31 
32  class Float : public Object
33  {
34  public:
35 
36  Float(flip::Default& d) : Object(d) {}
37 
38  Float(std::vector<tool::Atom> const& args);
39 
40  static void declare();
41 
42  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::Float::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Float.cpp:65
+
kiwi::model::Float
Definition: KiwiModel_Float.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object::Object
Object()
Constructor.
Definition: KiwiModel_Object.cpp:163
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___gate_8h_source.html b/docs/html/_kiwi_model___gate_8h_source.html new file mode 100644 index 00000000..963aba90 --- /dev/null +++ b/docs/html/_kiwi_model___gate_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Gate.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // GATE //
30  // ================================================================================ //
31 
32  class Gate : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Gate(flip::Default& d) : model::Object(d) {}
41 
42  Gate(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::Gate::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Gate.cpp:87
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Gate
Definition: KiwiModel_Gate.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___gate_tilde_8h_source.html b/docs/html/_kiwi_model___gate_tilde_8h_source.html new file mode 100644 index 00000000..d50a1d7b --- /dev/null +++ b/docs/html/_kiwi_model___gate_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_GateTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // GATE~ //
30  // ================================================================================ //
31 
32  class GateTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  GateTilde(flip::Default& d) : model::Object(d) {}
41 
42  GateTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::GateTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_GateTilde.cpp:82
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::GateTilde
Definition: KiwiModel_GateTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___greater_8h_source.html b/docs/html/_kiwi_model___greater_8h_source.html new file mode 100644 index 00000000..7841f514 --- /dev/null +++ b/docs/html/_kiwi_model___greater_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Greater.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Greater.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT GREATER //
31  // ================================================================================ //
32 
33  class Greater : public Operator
34  {
35  public:
36 
37  Greater(flip::Default& d) : Operator(d) {}
38 
39  Greater(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi::model::Greater
Definition: KiwiModel_Greater.h:33
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___greater_equal_8h_source.html b/docs/html/_kiwi_model___greater_equal_8h_source.html new file mode 100644 index 00000000..e62a8f51 --- /dev/null +++ b/docs/html/_kiwi_model___greater_equal_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GreaterEqual.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_GreaterEqual.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT GREATEREQUAL //
31  // ================================================================================ //
32 
33  class GreaterEqual : public Operator
34  {
35  public:
36 
37  GreaterEqual(flip::Default& d) : Operator(d) {}
38 
39  GreaterEqual(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::GreaterEqual
Definition: KiwiModel_GreaterEqual.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___greater_equal_tilde_8h_source.html b/docs/html/_kiwi_model___greater_equal_tilde_8h_source.html new file mode 100644 index 00000000..565e5066 --- /dev/null +++ b/docs/html/_kiwi_model___greater_equal_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GreaterEqualTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_GreaterEqualTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT >=~ //
30  // ================================================================================ //
31 
32  class GreaterEqualTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  GreaterEqualTilde(flip::Default& d): OperatorTilde(d){};
41 
42  GreaterEqualTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi::model::GreaterEqualTilde
Definition: KiwiModel_GreaterEqualTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___greater_tilde_8h_source.html b/docs/html/_kiwi_model___greater_tilde_8h_source.html new file mode 100644 index 00000000..dd6ecd21 --- /dev/null +++ b/docs/html/_kiwi_model___greater_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GreaterTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_GreaterTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT >~ //
30  // ================================================================================ //
31 
32  class GreaterTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  GreaterTilde(flip::Default& d): OperatorTilde(d){};
41 
42  GreaterTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi::model::GreaterTilde
Definition: KiwiModel_GreaterTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___hub_8h_source.html b/docs/html/_kiwi_model___hub_8h_source.html new file mode 100644 index 00000000..43726def --- /dev/null +++ b/docs/html/_kiwi_model___hub_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Hub.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Hub.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <flip/Message.h>
25 
26 #include <KiwiModel/KiwiModel_Object.h>
27 
28 namespace kiwi { namespace model {
29 
30  // ================================================================================ //
31  // OBJECT HUB //
32  // ================================================================================ //
33 
34  class Hub : public model::Object
35  {
36  public: // methods
37 
38  Hub(flip::Default& d);
39 
40  Hub(std::vector<tool::Atom> const& args);
41 
42  std::string getIODescription(bool is_inlet, size_t index) const override;
43 
44  void writeAttribute(std::string const& name, tool::Parameter const& parameter) override final;
45 
46  void readAttribute(std::string const& name, tool::Parameter & parameter) const override final;
47 
48  bool attributeChanged(std::string const& name) const override final;
49 
50  static void declare();
51 
52  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
53 
54  private: // members
55 
56  flip::Message<std::string> m_message;
57 
58  };
59 }}
kiwi::model::Hub::readAttribute
void readAttribute(std::string const &name, tool::Parameter &parameter) const override final
Reads the model to initialize a parameter.
Definition: KiwiModel_Hub.cpp:80
+
kiwi::model::Hub::attributeChanged
bool attributeChanged(std::string const &name) const override final
Checks the data model to see if a parameter has changed.
Definition: KiwiModel_Hub.cpp:91
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi::model::Hub
Definition: KiwiModel_Hub.h:34
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Hub::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Hub.cpp:96
+
kiwi::model::Hub::writeAttribute
void writeAttribute(std::string const &name, tool::Parameter const &parameter) override final
Writes the parameter into data model.
Definition: KiwiModel_Hub.cpp:72
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___less_8h_source.html b/docs/html/_kiwi_model___less_8h_source.html new file mode 100644 index 00000000..99ecc14d --- /dev/null +++ b/docs/html/_kiwi_model___less_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Less.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Less.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT LESS //
31  // ================================================================================ //
32 
33  class Less : public Operator
34  {
35  public:
36 
37  Less(flip::Default& d) : Operator(d) {}
38 
39  Less(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Less
Definition: KiwiModel_Less.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___less_equal_8h_source.html b/docs/html/_kiwi_model___less_equal_8h_source.html new file mode 100644 index 00000000..9817faad --- /dev/null +++ b/docs/html/_kiwi_model___less_equal_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessEqual.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_LessEqual.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT LESSEQUAL //
31  // ================================================================================ //
32 
33  class LessEqual : public Operator
34  {
35  public:
36 
37  LessEqual(flip::Default& d) : Operator(d) {}
38 
39  LessEqual(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi::model::LessEqual
Definition: KiwiModel_LessEqual.h:33
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___less_equal_tilde_8h_source.html b/docs/html/_kiwi_model___less_equal_tilde_8h_source.html new file mode 100644 index 00000000..ebccbe49 --- /dev/null +++ b/docs/html/_kiwi_model___less_equal_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessEqualTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_LessEqualTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT <=~ //
30  // ================================================================================ //
31 
32  class LessEqualTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  LessEqualTilde(flip::Default& d): OperatorTilde(d){};
41 
42  LessEqualTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi::model::LessEqualTilde
Definition: KiwiModel_LessEqualTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___less_tilde_8h_source.html b/docs/html/_kiwi_model___less_tilde_8h_source.html new file mode 100644 index 00000000..240a6383 --- /dev/null +++ b/docs/html/_kiwi_model___less_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_LessTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT <~ //
30  // ================================================================================ //
31 
32  class LessTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  LessTilde(flip::Default& d): OperatorTilde(d){};
41 
42  LessTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
kiwi::model::LessTilde
Definition: KiwiModel_LessTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___line_tilde_8h_source.html b/docs/html/_kiwi_model___line_tilde_8h_source.html new file mode 100644 index 00000000..624b8946 --- /dev/null +++ b/docs/html/_kiwi_model___line_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LineTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_LineTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // LINE~ //
30  // ================================================================================ //
31 
32  class LineTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  LineTilde(flip::Default& d): model::Object(d){};
41 
42  LineTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 }}
47 
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::LineTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_LineTilde.cpp:66
+
kiwi::model::LineTilde
Definition: KiwiModel_LineTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___link_8h_source.html b/docs/html/_kiwi_model___link_8h_source.html index 846dc6a7..a1fd7f26 100644 --- a/docs/html/_kiwi_model___link_8h_source.html +++ b/docs/html/_kiwi_model___link_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_Link.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiModel_Link.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_Object.h"
25 
26 namespace kiwi
27 {
28  namespace model
29  {
30  // ================================================================================ //
31  // LINK //
32  // ================================================================================ //
33 
37  class Link : public flip::Object
38  {
39  public: // methods
40 
48  Link(model::Object const& from, const size_t outlet, model::Object const& to, const size_t inlet);
49 
51  ~Link() = default;
52 
54  model::Object const& getSenderObject() const;
55 
57  model::Object const& getReceiverObject() const;
58 
60  bool isSenderValid() const;
61 
63  bool isReceiverValid() const;
64 
66  size_t getSenderIndex() const;
67 
69  size_t getReceiverIndex() const;
70 
72  bool isSignal() const;
73 
74 
75  public: // internal methods
76 
78  Link(flip::Default&) {}
79 
81  static void declare();
82 
83  private: // members
84 
85  flip::ObjectRef<model::Object> m_sender;
86  flip::ObjectRef<model::Object> m_receiver;
87  flip::Int m_index_outlet;
88  flip::Int m_index_inlet;
89 
90  private: // deleted methods
91 
92  Link(Link const&) = delete;
93  Link(Link&&) = delete;
94  Link& operator=(Link const&) = delete;
95  Link& operator=(Link&&) = delete;
96  };
97  }
98 }
- - +
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_Object.h"
25 
26 namespace kiwi
27 {
28  namespace model
29  {
30  // ================================================================================ //
31  // LINK //
32  // ================================================================================ //
33 
37  class Link : public flip::Object
38  {
39  public: // methods
40 
48  Link(model::Object const& from, const size_t outlet, model::Object const& to, const size_t inlet);
49 
51  ~Link() = default;
52 
54  model::Object const& getSenderObject() const;
55 
57  model::Object const& getReceiverObject() const;
58 
60  bool isSenderValid() const;
61 
63  bool isReceiverValid() const;
64 
66  size_t getSenderIndex() const;
67 
69  size_t getReceiverIndex() const;
70 
72  bool isSignal() const;
73 
74 
75  public: // internal methods
76 
78  Link(flip::Default&) {}
79 
81  static void declare();
82 
83  private: // members
84 
85  flip::ObjectRef<model::Object> m_sender;
86  flip::ObjectRef<model::Object> m_receiver;
87  flip::Int m_index_outlet;
88  flip::Int m_index_inlet;
89 
90  private: // deleted methods
91 
92  Link(Link const&) = delete;
93  Link(Link&&) = delete;
94  Link& operator=(Link const&) = delete;
95  Link& operator=(Link&&) = delete;
96  };
97  }
98 }
- +
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
+ + + +
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+ - - - +
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___loadmess_8h_source.html b/docs/html/_kiwi_model___loadmess_8h_source.html new file mode 100644 index 00000000..a96530fe --- /dev/null +++ b/docs/html/_kiwi_model___loadmess_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Loadmess.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Loadmess.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT LOADMESS //
30  // ================================================================================ //
31 
32  class Loadmess : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Loadmess(flip::Default& d) : model::Object(d) {}
41 
42  Loadmess(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Loadmess::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Loadmess.cpp:57
+
kiwi::model::Loadmess
Definition: KiwiModel_Loadmess.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___message_8h_source.html b/docs/html/_kiwi_model___message_8h_source.html new file mode 100644 index 00000000..928526bd --- /dev/null +++ b/docs/html/_kiwi_model___message_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Message.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Message.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <flip/String.h>
25 
26 #include <KiwiModel/KiwiModel_Object.h>
27 
28 namespace kiwi { namespace model {
29 
30  // ================================================================================ //
31  // OBJECT SLIDER //
32  // ================================================================================ //
33 
34  class Message : public model::Object
35  {
36  public: // classes
37 
38  enum Signal : SignalKey
39  {
40  outputMessage
41  };
42 
43  public: // methods
44 
45  Message(flip::Default& d);
46 
47  Message();
48 
49  std::string getIODescription(bool is_inlet, size_t index) const override;
50 
51  void writeAttribute(std::string const& name, tool::Parameter const& parameter) override final;
52 
53  void readAttribute(std::string const& name, tool::Parameter & parameter) const override final;
54 
55  bool attributeChanged(std::string const& name) const override final;
56 
57  static void declare();
58 
59  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
60 
61  private: // members
62 
63  flip::String m_message_text;
64 
65  };
66 }}
kiwi::model::Message::writeAttribute
void writeAttribute(std::string const &name, tool::Parameter const &parameter) override final
Writes the parameter into data model.
Definition: KiwiModel_Message.cpp:83
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Message::attributeChanged
bool attributeChanged(std::string const &name) const override final
Checks the data model to see if a parameter has changed.
Definition: KiwiModel_Message.cpp:98
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Message::readAttribute
void readAttribute(std::string const &name, tool::Parameter &parameter) const override final
Reads the model to initialize a parameter.
Definition: KiwiModel_Message.cpp:91
+
kiwi::model::Message::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Message.cpp:110
+
kiwi::model::Message
Definition: KiwiModel_Message.h:34
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___meter_tilde_8h_source.html b/docs/html/_kiwi_model___meter_tilde_8h_source.html new file mode 100644 index 00000000..39b57ed8 --- /dev/null +++ b/docs/html/_kiwi_model___meter_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_MeterTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_MeterTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // METER~ //
30  // ================================================================================ //
31 
32  class MeterTilde : public model::Object
33  {
34  public: // enum
35 
36  enum Signal : SignalKey
37  {
38  PeakChanged
39  };
40 
41  public: // methods
42 
43  static void declare();
44 
45  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
46 
47  MeterTilde(flip::Default& d);
48 
49  MeterTilde(std::vector<tool::Atom> const& args);
50 
51  std::string getIODescription(bool is_inlet, size_t index) const override final;
52 
53  };
54 }
55 }
kiwi::model::MeterTilde
Definition: KiwiModel_MeterTilde.h:32
+
kiwi::model::MeterTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override final
Returns inlet or outlet description.
Definition: KiwiModel_MeterTilde.cpp:75
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___metro_8h_source.html b/docs/html/_kiwi_model___metro_8h_source.html new file mode 100644 index 00000000..4f2109ee --- /dev/null +++ b/docs/html/_kiwi_model___metro_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Metro.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Metro.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT METRO //
30  // ================================================================================ //
31 
32  class Metro : public model::Object
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Metro(flip::Default& d) : model::Object(d) {};
41 
42  Metro(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::Metro
Definition: KiwiModel_Metro.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Metro::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Metro.cpp:66
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___minus_8h_source.html b/docs/html/_kiwi_model___minus_8h_source.html new file mode 100644 index 00000000..40e8bb9d --- /dev/null +++ b/docs/html/_kiwi_model___minus_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Minus.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Minus.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT MINUS //
31  // ================================================================================ //
32 
33  class Minus : public Operator
34  {
35  public:
36 
37  Minus(flip::Default& d) : Operator(d) {}
38 
39  Minus(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi::model::Minus
Definition: KiwiModel_Minus.h:33
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___minus_tilde_8h_source.html b/docs/html/_kiwi_model___minus_tilde_8h_source.html new file mode 100644 index 00000000..f8df94b8 --- /dev/null +++ b/docs/html/_kiwi_model___minus_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_MinusTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_MinusTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT -~ //
30  // ================================================================================ //
31 
32  class MinusTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  MinusTilde(flip::Default& d): OperatorTilde(d){};
41 
42  MinusTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
kiwi::model::MinusTilde
Definition: KiwiModel_MinusTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___modulo_8h_source.html b/docs/html/_kiwi_model___modulo_8h_source.html new file mode 100644 index 00000000..badf6b74 --- /dev/null +++ b/docs/html/_kiwi_model___modulo_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Modulo.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Modulo.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT MODULO //
31  // ================================================================================ //
32 
33  class Modulo : public Operator
34  {
35  public:
36 
37  Modulo(flip::Default& d) : Operator(d) {}
38 
39  Modulo(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Modulo
Definition: KiwiModel_Modulo.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___mtof_8h_source.html b/docs/html/_kiwi_model___mtof_8h_source.html new file mode 100644 index 00000000..612f7174 --- /dev/null +++ b/docs/html/_kiwi_model___mtof_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Mtof.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Mtof.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // MTOF //
30  // ================================================================================ //
31 
32  class Mtof : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Mtof(flip::Default& d) : model::Object(d) {}
41 
42  Mtof(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::Mtof
Definition: KiwiModel_Mtof.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Mtof::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Mtof.cpp:56
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___new_box_8h_source.html b/docs/html/_kiwi_model___new_box_8h_source.html new file mode 100644 index 00000000..8418c4f1 --- /dev/null +++ b/docs/html/_kiwi_model___new_box_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NewBox.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_NewBox.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // NEWBOX //
30  // ================================================================================ //
31 
32  class NewBox : public model::Object
33  {
34  public:
35 
37  NewBox(flip::Default& d) : model::Object(d) {}
38 
40  NewBox();
41 
42  std::string getIODescription(bool is_inlet, size_t index) const override;
43 
45  static void declare();
46 
48  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
49  };
50 
51 }}
kiwi::model::NewBox::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_NewBox.cpp:60
+
kiwi::model::NewBox::NewBox
NewBox()
Constructor.
Definition: KiwiModel_NewBox.cpp:53
+
kiwi::model::NewBox::declare
static void declare()
Declaration method.
Definition: KiwiModel_NewBox.cpp:33
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::NewBox
Definition: KiwiModel_NewBox.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::NewBox::create
static std::unique_ptr< Object > create(std::vector< tool::Atom > const &args)
The object&#39;s creation method.
Definition: KiwiModel_NewBox.cpp:48
+
kiwi::model::NewBox::NewBox
NewBox(flip::Default &d)
flip Default Constructor.
Definition: KiwiModel_NewBox.h:37
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___noise_tilde_8h_source.html b/docs/html/_kiwi_model___noise_tilde_8h_source.html new file mode 100644 index 00000000..585bcff7 --- /dev/null +++ b/docs/html/_kiwi_model___noise_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NoiseTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_NoiseTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // NOISE~ //
30  // ================================================================================ //
31 
32  class NoiseTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  NoiseTilde(flip::Default& d): model::Object(d){};
41 
42  NoiseTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::NoiseTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_NoiseTilde.cpp:56
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::NoiseTilde
Definition: KiwiModel_NoiseTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___number_8h_source.html b/docs/html/_kiwi_model___number_8h_source.html new file mode 100644 index 00000000..7932c4c4 --- /dev/null +++ b/docs/html/_kiwi_model___number_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Number.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Number.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiTool/KiwiTool_Atom.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT NUMBER //
31  // ================================================================================ //
32 
33  class Number : public model::Object
34  {
35  public: // enum
36 
37  enum Signal : SignalKey
38  {
39  OutputValue
40  };
41 
42  public: // methods
43 
44  Number(flip::Default& d);
45 
46  Number(std::vector<tool::Atom> const& args);
47 
48  std::string getIODescription(bool is_inlet, size_t index) const override;
49 
50  static void declare();
51 
52  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
53  };
54 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Number
Definition: KiwiModel_Number.h:33
+
kiwi::model::Number::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Number.cpp:85
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___number_tilde_8h_source.html b/docs/html/_kiwi_model___number_tilde_8h_source.html new file mode 100644 index 00000000..f8fc8241 --- /dev/null +++ b/docs/html/_kiwi_model___number_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NumberTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_NumberTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiTool/KiwiTool_Atom.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT NUMBER TILDE //
31  // ================================================================================ //
32 
33  class NumberTilde : public model::Object
34  {
35  public: // methods
36 
37  NumberTilde(flip::Default& d);
38 
39  NumberTilde(std::vector<tool::Atom> const& args);
40 
41  std::string getIODescription(bool is_inlet, size_t index) const override;
42 
43  static void declare();
44 
45  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
46  };
47 }}
kiwi::model::NumberTilde
Definition: KiwiModel_NumberTilde.h:33
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::NumberTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_NumberTilde.cpp:82
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___object_8h_source.html b/docs/html/_kiwi_model___object_8h_source.html index 9b3b047c..81254c38 100644 --- a/docs/html/_kiwi_model___object_8h_source.html +++ b/docs/html/_kiwi_model___object_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_Object.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiModel_Object.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 // ---- Flip headers ---- //
25 #include "flip/Bool.h"
26 #include "flip/Int.h"
27 #include "flip/Float.h"
28 #include "flip/String.h"
29 #include "flip/Array.h"
30 #include "flip/Collection.h"
31 #include "flip/Object.h"
32 #include "flip/ObjectRef.h"
33 #include "flip/Enum.h"
34 #include "flip/Signal.h"
35 
36 #include "KiwiModel_Atom.h"
37 
38 #include <mutex>
39 #include <algorithm>
40 #include <exception>
41 #include <set>
42 
43 namespace kiwi
44 {
45  namespace model
46  {
47  class Factory;
48 
49  // ================================================================================ //
50  // INLET/OUTLET //
51  // ================================================================================ //
52 
56  class PinType : public flip::Object
57  {
58  public: // classes
59 
60  enum class IType
61  {
62  Control,
63  Signal
64  };
65 
66  public: // methods
67 
68  // @brief Constructor of type.
69  PinType(IType type);
70 
72  bool operator<(PinType const& other) const;
73 
75  bool operator==(PinType const& other) const;
76 
77  public: // internal methods
78 
80  PinType(flip::Default&);
81 
83  static void declare();
84 
85  private: // methods
86 
89  IType getType() const;
90 
91  private:
92  flip::Enum<IType> m_type;
93  };
94 
96  class Inlet : public flip::Object
97  {
98  public:
100  Inlet(std::set<PinType> types);
101 
103  ~Inlet() = default;
104 
106  bool hasType(PinType type) const;
107 
108  public: // internal methods
109 
111  Inlet(flip::Default&);
112 
114  static void declare();
115 
116  private:
117  flip::Array<PinType> m_types;
118  };
119 
121  class Outlet : public flip::Object
122  {
123  public:
125  Outlet(PinType type);
126 
128  ~Outlet() = default;
129 
130  // @brief Returns the type of the outlet.
131  PinType const& getType() const;
132 
133  public: // internal methods
134 
136  Outlet(flip::Default&);
137 
139  static void declare();
140 
141  private:
142  PinType m_type;
143  };
144 
145 
146  // ================================================================================ //
147  // OBJECT //
148  // ================================================================================ //
149 
152  class Object : public flip::Object
153  {
154  public: // methods
155 
157  Object();
158 
160  virtual ~Object() = default;
161 
163  std::string getName() const;
164 
166  std::string getText() const;
167 
169  flip::Array<Inlet> const& getInlets() const;
170 
172  Inlet const& getInlet(size_t index) const;
173 
175  size_t getNumberOfInlets() const;
176 
178  bool inletsChanged() const noexcept;
179 
181  flip::Array<Outlet> const& getOutlets() const;
182 
184  Outlet const& getOutlet(size_t index) const;
185 
187  size_t getNumberOfOutlets() const;
188 
190  bool outletsChanged() const noexcept;
191 
193  void setPosition(double x, double y);
194 
196  bool positionChanged() const noexcept;
197 
199  bool sizeChanged() const noexcept;
200 
202  bool boundsChanged() const noexcept;
203 
205  double getX() const noexcept;
206 
208  double getY() const noexcept;
209 
211  void setWidth(double new_width);
212 
214  void setHeight(double new_height);
215 
217  double getWidth() const noexcept;
218 
220  double getHeight() const noexcept;
221 
223  virtual std::string getIODescription(bool is_inlet, size_t index) const;
224 
225  protected: // methods
226 
228  void setInlets(flip::Array<Inlet> const& inlets);
229 
231  void setOutlets(flip::Array<Outlet> const& outlets);
232 
234  void pushInlet(std::set<PinType> type);
235 
237  void pushOutlet(PinType type);
238 
239  public: // internal methods
240 
242  Object(flip::Default&);
243 
245  static void declare();
246 
247  private: // members
248 
249  flip::String m_name;
250  flip::String m_text;
251  flip::Array<Inlet> m_inlets;
252  flip::Array<Outlet> m_outlets;
253 
254  flip::Float m_position_x;
255  flip::Float m_position_y;
256  flip::Float m_width;
257  flip::Float m_height;
258 
259  friend class Factory;
260 
261  private: // deleted methods
262 
263  Object(Object const&) = delete;
264  Object(model::Object&&) = delete;
265  model::Object& operator=(model::Object const&) = delete;
266  model::Object& operator=(model::Object&&) = delete;
267  };
268  }
269 }
kiwi::model::Factory
The model Object&#39;s factory.
Definition: KiwiModel_Factory.h:36
-
kiwi::model::Inlet
Class that represent an inlet able to have multiple types.
Definition: KiwiModel_Object.h:96
-
kiwi::model::Outlet
Class that represent a certain outlet having only one type.
Definition: KiwiModel_Object.h:121
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
25 
26 // ---- Flip headers ---- //
27 #include "flip/Bool.h"
28 #include "flip/Int.h"
29 #include "flip/Float.h"
30 #include "flip/String.h"
31 #include "flip/Array.h"
32 #include "flip/Collection.h"
33 #include "flip/Object.h"
34 #include "flip/ObjectRef.h"
35 #include "flip/Enum.h"
36 #include "flip/Signal.h"
37 
38 #include <KiwiTool/KiwiTool_Atom.h>
39 #include <KiwiTool/KiwiTool_Parameter.h>
40 #include <KiwiTool/KiwiTool_Listeners.h>
41 
42 #include <KiwiModel/KiwiModel_ObjectClass.h>
43 #include <KiwiModel/KiwiModel_Error.h>
44 
45 #include <mutex>
46 #include <algorithm>
47 #include <exception>
48 #include <set>
49 #include <map>
50 
51 namespace kiwi
52 {
53  namespace model
54  {
55  class Factory;
56 
57  // ================================================================================ //
58  // INLET/OUTLET //
59  // ================================================================================ //
60 
64  class PinType : public flip::Object
65  {
66  public: // classes
67 
68  enum class IType
69  {
70  Control,
71  Signal
72  };
73 
74  public: // methods
75 
76  // @brief Constructor of type.
77  PinType(IType type);
78 
80  bool operator<(PinType const& other) const;
81 
83  bool operator==(PinType const& other) const;
84 
85  public: // internal methods
86 
88  PinType(flip::Default&);
89 
91  static void declare();
92 
93  private: // methods
94 
97  IType getType() const;
98 
99  private:
100  flip::Enum<IType> m_type;
101  };
102 
104  class Inlet : public flip::Object
105  {
106  public:
108  Inlet(std::set<PinType> types);
109 
111  ~Inlet() = default;
112 
114  bool hasType(PinType type) const;
115 
116  public: // internal methods
117 
119  Inlet(flip::Default&);
120 
122  static void declare();
123 
124  private:
125  flip::Array<PinType> m_types;
126  };
127 
129  class Outlet : public flip::Object
130  {
131  public:
133  Outlet(PinType type);
134 
136  ~Outlet() = default;
137 
138  // @brief Returns the type of the outlet.
139  PinType const& getType() const;
140 
141  public: // internal methods
142 
144  Outlet(flip::Default&);
145 
147  static void declare();
148 
149  private:
150  PinType m_type;
151  };
152 
153 
154  // ================================================================================ //
155  // OBJECT //
156  // ================================================================================ //
157 
160  class Object : public flip::Object
161  {
162  public: // classes
163 
164  using SignalKey = uint32_t;
165 
166  class Listener
167  {
168  public:
169 
170  // @brief Destructor
171  virtual ~Listener() = default;
172 
174  virtual void modelParameterChanged(std::string const& name, tool::Parameter const& param) = 0;
175 
177  virtual void modelAttributeChanged(std::string const& name, tool::Parameter const& param) = 0;
178  };
179 
182  class Error : public model::Error
183  {
184  public: // methods
185 
187  Error(std::string const& message):model::Error(message) {}
188 
190  ~Error() = default;
191  };
192 
193  public: // methods
194 
196  Object();
197 
199  virtual ~Object() = default;
200 
202  std::vector<tool::Atom> const& getArguments() const;
203 
207  std::set<std::string> getChangedAttributes() const;
208 
210  tool::Parameter const& getAttribute(std::string const& name) const;
211 
213  void setAttribute(std::string const& name, tool::Parameter const& param);
214 
216  tool::Parameter const& getParameter(std::string const& name) const;
217 
219  void setParameter(std::string const& name, tool::Parameter const& param);
220 
224  virtual void writeAttribute(std::string const& name, tool::Parameter const& paramter);
225 
228  virtual void readAttribute(std::string const& name, tool::Parameter & parameter) const;
229 
232  virtual bool attributeChanged(std::string const& name) const;
233 
235  void addListener(Listener& listener) const;
236 
238  void removeListener(Listener& listener) const;
239 
241  std::string getName() const;
242 
244  ObjectClass const& getClass() const;
245 
247  std::string getText() const;
248 
250  flip::Array<Inlet> const& getInlets() const;
251 
253  Inlet const& getInlet(size_t index) const;
254 
256  size_t getNumberOfInlets() const;
257 
259  bool inletsChanged() const noexcept;
260 
262  flip::Array<Outlet> const& getOutlets() const;
263 
265  Outlet const& getOutlet(size_t index) const;
266 
268  size_t getNumberOfOutlets() const;
269 
271  bool outletsChanged() const noexcept;
272 
274  void setPosition(double x, double y);
275 
277  bool positionChanged() const noexcept;
278 
280  bool sizeChanged() const noexcept;
281 
283  bool boundsChanged() const noexcept;
284 
286  double getX() const noexcept;
287 
289  double getY() const noexcept;
290 
294  void setWidth(double new_width);
295 
299  void setHeight(double new_height);
300 
302  double getRatio() const;
303 
305  double getWidth() const noexcept;
306 
308  double getHeight() const noexcept;
309 
311  double getMinWidth() const noexcept;
312 
314  double getMinHeight() const noexcept;
315 
317  virtual std::string getIODescription(bool is_inlet, size_t index) const;
318 
320  bool hasFlag(ObjectClass::Flag flag) const;
321 
324  template <class... Args>
325  auto& getSignal(SignalKey key) const
326  {
327  flip::SignalBase& signal_base = *m_signals.at(key);
328  return dynamic_cast<flip::Signal<Args...>&>(signal_base);
329  }
330 
331  protected:
332 
334  template <class... Args>
335  void addSignal(SignalKey key, model::Object& object)
336  {
337  m_signals.emplace(key, std::make_unique<flip::Signal<Args...>>(key, object));
338  }
339 
341  void setInlets(flip::Array<Inlet> const& inlets);
342 
344  void setOutlets(flip::Array<Outlet> const& outlets);
345 
347  void pushInlet(std::set<PinType> type);
348 
350  void pushOutlet(PinType type);
351 
354  void setRatio(double ratio);
355 
358  void setMinWidth(double min_width);
359 
362  void setMinHeight(double min_height);
363 
364  public: // internal methods
365 
367  Object(flip::Default&);
368 
370  static void declare();
371 
372  private: // members
373 
374  flip::String m_text;
375  flip::Array<Inlet> m_inlets;
376  flip::Array<Outlet> m_outlets;
377  flip::Float m_position_x;
378  flip::Float m_position_y;
379  flip::Float m_width;
380  flip::Float m_height;
381  flip::Float m_min_width;
382  flip::Float m_min_height;
383  flip::Float m_ratio;
384  mutable std::map<std::string, tool::Parameter> m_attributes;
385  mutable std::map<std::string, tool::Parameter> m_parameters;
386  mutable std::unique_ptr<std::vector<tool::Atom>> m_args;
387  std::map<SignalKey, std::unique_ptr<flip::SignalBase>> m_signals;
388  mutable tool::Listeners<Listener> m_listeners;
389 
390  friend class Factory;
391 
392  private: // deleted methods
393 
394  Object(Object const&) = delete;
395  Object(model::Object&&) = delete;
396  model::Object& operator=(model::Object const&) = delete;
397  model::Object& operator=(model::Object&&) = delete;
398  };
399  }
400 }
kiwi::model::Object::Error::Error
Error(std::string const &message)
Constructor.
Definition: KiwiModel_Object.h:187
+
kiwi::model::Error
A generic exception for engine failures.
Definition: KiwiModel_Error.h:31
+
kiwi::model::Object::addSignal
void addSignal(SignalKey key, model::Object &object)
Adds a signal having singal key.
Definition: KiwiModel_Object.h:335
+
kiwi::model::Factory
The model Object&#39;s factory.
Definition: KiwiModel_Factory.h:42
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi::model::Inlet
Class that represent an inlet able to have multiple types.
Definition: KiwiModel_Object.h:104
+
kiwi::model::Outlet
Class that represent a certain outlet having only one type.
Definition: KiwiModel_Object.h:129
+
kiwi::model::ObjectClass::Flag
Flag
A list of flags that defines the object&#39;s behavior.
Definition: KiwiModel_ObjectClass.h:104
+
kiwi::model::PinType::operator==
bool operator==(PinType const &other) const
Equality comparator. Consistent with comparison operator.
Definition: KiwiModel_Object.cpp:57
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::model::PinType::operator==
bool operator==(PinType const &other) const
Equality comparator. Consistent with comparison operator.
Definition: KiwiModel_Object.cpp:55
-
kiwi::model::PinType
Class that represent a type of pin.
Definition: KiwiModel_Object.h:56
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::model::PinType::operator<
bool operator<(PinType const &other) const
Comprison operator.
Definition: KiwiModel_Object.cpp:50
+
kiwi::model::Object::Listener
Definition: KiwiModel_Object.h:166
+
kiwi::tool::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiTool_Listeners.h:38
+
kiwi::model::Object::getSignal
auto & getSignal(SignalKey key) const
Returns the object&#39;s signal referenced by this key.
Definition: KiwiModel_Object.h:325
+
kiwi::model::PinType::operator<
bool operator<(PinType const &other) const
Comprison operator.
Definition: KiwiModel_Object.cpp:52
+
kiwi::model::PinType
Class that represent a type of pin.
Definition: KiwiModel_Object.h:64
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::ObjectClass
The static representation of an object.
Definition: KiwiModel_ObjectClass.h:96
+
kiwi::model::Object::Error
an error that object can throw to notify a problem.
Definition: KiwiModel_Object.h:182
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___object_class_8h_source.html b/docs/html/_kiwi_model___object_class_8h_source.html new file mode 100644 index 00000000..3a3855e6 --- /dev/null +++ b/docs/html/_kiwi_model___object_class_8h_source.html @@ -0,0 +1,112 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_ObjectClass.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_ObjectClass.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <functional>
25 #include <set>
26 #include <string>
27 
28 #include <flip/Class.h>
29 #include <flip/Mold.h>
30 
31 #include <KiwiTool/KiwiTool_Parameter.h>
32 #include <KiwiTool/KiwiTool_Atom.h>
33 
34 namespace kiwi { namespace model {
35 
36  class Object;
37 
38  class Factory;
39 
40  // ================================================================================ //
41  // PARAMETER CLASS //
42  // ================================================================================ //
43 
46  class ParameterClass
47  {
48  public: // classes
49 
50  enum class Type
51  {
52  Attribute, // Attributes are saved/collaborative but are not invariant.
53  Parameter // Parameters are not collaborative.
54  };
55 
56  public: // methods
57 
59  ParameterClass(tool::Parameter::Type type);
60 
62  ~ParameterClass();
63 
65  ParameterClass::Type getType() const;
66 
68  tool::Parameter::Type getDataType() const;
69 
70  private: // methods
71 
73  void setType(Type param_type);
74 
75  private: // members
76 
77  Type m_type;
78  tool::Parameter::Type m_data_type;
79 
80  friend class ObjectClass;
81 
82  private: // deleted methods
83 
84  ParameterClass() = delete;
85  ParameterClass(ParameterClass const& other) = delete;
86  ParameterClass(ParameterClass && other) = delete;
87  ParameterClass& operator=(ParameterClass const& other) = delete;
88  ParameterClass& operator=(ParameterClass && other) = delete;
89  };
90 
91  // ================================================================================ //
92  // OBJECTC LASS //
93  // ================================================================================ //
94 
96  class ObjectClass
97  {
98  public: // classes.
99 
101  using ctor_t = std::function<std::unique_ptr<model::Object>(std::vector<tool::Atom> const&)>;
102 
104  enum class Flag
105  {
106  Internal,
107  ResizeWidth,
108  ResizeHeight,
109  DefinedSize
110  };
111 
112  private: // classes
113 
115  using mold_maker_t = std::function<void(model::Object const&, flip::Mold&)>;
116 
118  using mold_caster_t = std::function<std::unique_ptr<model::Object>(flip::Mold const&)>;
119 
120  public:// methods
121 
124  ObjectClass(std::string const& name, ctor_t ctor);
125 
127  ~ObjectClass();
128 
130  std::string const& getName() const;
131 
133  std::string const& getModelName() const;
134 
136  bool hasAlias() const noexcept;
137 
139  std::set<std::string> const& getAliases() const noexcept;
140 
142  bool hasAlias(std::string const& alias) const noexcept;
143 
145  void addAlias(std::string const& alias);
146 
148  void addAttribute(std::string const& name, std::unique_ptr<ParameterClass> param_class);
149 
151  bool hasAttribute(std::string const& name) const;
152 
155  ParameterClass const& getAttribute(std::string const& name) const;
156 
158  void addParameter(std::string name, std::unique_ptr<ParameterClass> param_class);
159 
161  bool hasParameter(std::string const& name) const;
162 
165  ParameterClass const& getParameter(std::string const& name) const;
166 
168  std::map<std::string, std::unique_ptr<ParameterClass>> const& getParameters() const;
169 
171  void setFlag(Flag const& flag);
172 
174  bool hasFlag(Flag const& flag) const;
175 
176  private: // methods
177 
179  void setMoldMaker(mold_maker_t maker);
180 
181  // @brief Sets the mold caster function.
182  void setMoldCaster(mold_caster_t caster);
183 
185  void setTypeId(size_t);
186 
190  std::unique_ptr<model::Object> create(std::vector<tool::Atom> const& args) const;
191 
195  void moldMake(model::Object const& object, flip::Mold& mold) const;
196 
200  std::unique_ptr<model::Object> moldCast(flip::Mold const& mold) const;
201 
202  private: // members
203 
204  std::string m_name;
205  std::string m_model_name;
206  std::set<std::string> m_aliases;
207  std::map<std::string, std::unique_ptr<ParameterClass>> m_params;
208  ctor_t m_ctor;
209  std::set<Flag> m_flags;
210  mold_maker_t m_mold_maker;
211  mold_caster_t m_mold_caster;
212  size_t m_type_id;
213 
214  friend class Factory;
215 
216  private: // deleted methods.
217 
218  ObjectClass() = delete;
219  ObjectClass(ObjectClass const& other) = delete;
220  ObjectClass(ObjectClass && other) = delete;
221  ObjectClass& operator=(ObjectClass const& other) = delete;
222  ObjectClass& operator=(ObjectClass && other) = delete;
223  };
224 
225 }}
kiwi::model::ParameterClass::~ParameterClass
~ParameterClass()
Destructor.
Definition: KiwiModel_ObjectClass.cpp:38
+
kiwi::model::ParameterClass::getType
ParameterClass::Type getType() const
Sets the attributes type. Only used by factory.
Definition: KiwiModel_ObjectClass.cpp:52
+
kiwi::model::ParameterClass::getDataType
tool::Parameter::Type getDataType() const
Returns the parameter&#39;s data type.
Definition: KiwiModel_ObjectClass.cpp:42
+
kiwi::model::Factory
The model Object&#39;s factory.
Definition: KiwiModel_Factory.h:42
+
kiwi::model::ObjectClass::Flag
Flag
A list of flags that defines the object&#39;s behavior.
Definition: KiwiModel_ObjectClass.h:104
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Parameter::Type
Type
The different types of data represented.
Definition: KiwiTool_Parameter.h:37
+
kiwi::model::ParameterClass
This is a parameter static informations.
Definition: KiwiModel_ObjectClass.h:46
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::ObjectClass
The static representation of an object.
Definition: KiwiModel_ObjectClass.h:96
+
kiwi::model::ObjectClass::ctor_t
std::function< std::unique_ptr< model::Object >(std::vector< tool::Atom > const &)> ctor_t
The construction method.
Definition: KiwiModel_ObjectClass.h:101
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___objects_8h_source.html b/docs/html/_kiwi_model___objects_8h_source.html index cf6207a2..6a0e0869 100644 --- a/docs/html/_kiwi_model___objects_8h_source.html +++ b/docs/html/_kiwi_model___objects_8h_source.html @@ -3,15 +3,17 @@ - - -Kiwi: Modules/KiwiModel/KiwiModel_Objects.h Source File + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Objects.h Source File + @@ -29,19 +31,41 @@
- + - - - - + +
@@ -66,51 +90,12 @@
KiwiModel_Objects.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_Object.h"
25 #include "KiwiModel_Factory.h"
26 
27 namespace kiwi
28 {
29  namespace model
30  {
31  // ================================================================================ //
32  // NEWBOX //
33  // ================================================================================ //
34 
35  class NewBox : public model::Object
36  {
37  public:
38 
40  NewBox(flip::Default& d) : model::Object(d) {}
41 
43  NewBox(std::string const& name, std::vector<Atom> const& args);
44 
45  std::string getIODescription(bool is_inlet, size_t index) const override;
46 
48  static void declare();
49  };
50 
51  // ================================================================================ //
52  // ERRORBOX //
53  // ================================================================================ //
54 
55  class ErrorBox : public model::Object
56  {
57  public:
58 
60  ErrorBox(flip::Default& d) : model::Object(d) {}
61 
63  ErrorBox(std::string const& name, std::vector<Atom> const& args);
64 
67  void setInlets(flip::Array<Inlet> const& inlets);
68 
71  void setOutlets(flip::Array<Outlet> const& outlets);
72 
73  std::string getIODescription(bool is_inlet, size_t index) const override;
74 
76  static void declare();
77  };
78 
79  // ================================================================================ //
80  // OBJECT PLUS //
81  // ================================================================================ //
82 
83  class Plus : public model::Object
84  {
85  public:
86 
88  Plus(flip::Default& d) : model::Object(d) {}
89 
91  Plus(std::string const& name, std::vector<Atom> const& args);
92 
93  std::string getIODescription(bool is_inlet, size_t index) const override;
94 
96  static void declare();
97  };
98 
99  // ================================================================================ //
100  // OBJECT TIMES //
101  // ================================================================================ //
102 
103  class Times : public model::Object
104  {
105  public:
106 
108  Times(flip::Default& d) : model::Object(d) {}
109 
111  Times(std::string const& name, std::vector<Atom> const& args);
112 
113  std::string getIODescription(bool is_inlet, size_t index) const override;
114 
116  static void declare();
117  };
118 
119  // ================================================================================ //
120  // OBJECT PRINT //
121  // ================================================================================ //
122 
123  class Print : public model::Object
124  {
125  public:
126 
128  Print(flip::Default& d) : model::Object(d) {}
129 
131  Print(std::string const& name, std::vector<Atom> const& args);
132 
133  std::string getIODescription(bool is_inlet, size_t index) const override;
134 
136  static void declare();
137  };
138 
139  // ================================================================================ //
140  // OBJECT RECEIVE //
141  // ================================================================================ //
142 
143  class Receive : public model::Object
144  {
145  public:
146 
148  Receive(flip::Default& d) : model::Object(d) {}
149 
151  Receive(std::string const& name, std::vector<Atom> const& args);
152 
153  std::string getIODescription(bool is_inlet, size_t index) const override;
154 
156  static void declare();
157  };
158 
159  // ================================================================================ //
160  // OBJECT LOADMESS //
161  // ================================================================================ //
162 
163  class Loadmess : public model::Object
164  {
165  public:
166 
168  Loadmess(flip::Default& d) : model::Object(d) {}
169 
171  Loadmess(std::string const& name, std::vector<Atom> const& args);
172 
173  std::string getIODescription(bool is_inlet, size_t index) const override;
174 
176  static void declare();
177  };
178 
179  // ================================================================================ //
180  // OBJECT DELAY //
181  // ================================================================================ //
182 
183  class Delay : public model::Object
184  {
185  public: // methods
186 
188  Delay(flip::Default& d) : model::Object(d) {};
189 
191  Delay(std::string const& name, std::vector<Atom> const& args);
192 
193  std::string getIODescription(bool is_inlet, size_t index) const override;
194 
196  static void declare();
197  };
198 
199  // ================================================================================ //
200  // OBJECT PIPE //
201  // ================================================================================ //
202 
203  class Pipe : public model::Object
204  {
205  public: // methods
206 
208  Pipe(flip::Default& d) : model::Object(d) {};
209 
211  Pipe(std::string const& name, std::vector<Atom> const& args);
212 
213  std::string getIODescription(bool is_inlet, size_t index) const override;
214 
216  static void declare();
217  };
218 
219  // ================================================================================ //
220  // OBJECT METRO //
221  // ================================================================================ //
222 
223  class Metro : public model::Object
224  {
225  public: // methods
226 
228  Metro(flip::Default& d) : model::Object(d) {};
229 
231  Metro(std::string const& name, std::vector<Atom> const& args);
232 
233  std::string getIODescription(bool is_inlet, size_t index) const override;
234 
236  static void declare();
237  };
238 
239  // ================================================================================ //
240  // OBJECT OSC~ //
241  // ================================================================================ //
242 
243  class OscTilde : public model::Object
244  {
245  public:
247  OscTilde(flip::Default& d): model::Object(d){};
248 
250  OscTilde(std::string const& name, std::vector<Atom> const& args);
251 
252  std::string getIODescription(bool is_inlet, size_t index) const override;
253 
255  static void declare();
256  };
257 
258  // ================================================================================ //
259  // OBJECT ADC~ //
260  // ================================================================================ //
261 
262  class AdcTilde : public model::Object
263  {
264  public:
265 
267  AdcTilde(flip::Default& d): model::Object(d){}
268 
270  AdcTilde(std::string const& name, std::vector<Atom> const& args);
271 
272  std::string getIODescription(bool is_inlet, size_t index) const override;
273 
275  static void declare();
276  };
277 
278  // ================================================================================ //
279  // OBJECT DAC~ //
280  // ================================================================================ //
281 
282 
283  class DacTilde : public model::Object
284  {
285  public:
286 
288  DacTilde(flip::Default& d): model::Object(d){}
289 
291  DacTilde(std::string const& name, std::vector<Atom> const& args);
292 
293  std::string getIODescription(bool is_inlet, size_t index) const override;
294 
296  static void declare();
297  };
298 
299  // ================================================================================ //
300  // OBJECT *~ //
301  // ================================================================================ //
302 
303  class TimesTilde : public model::Object
304  {
305  public:
306 
308  TimesTilde(flip::Default& d): model::Object(d){};
309 
311  TimesTilde(std::string const& name, std::vector<Atom> const& args);
312 
313  std::string getIODescription(bool is_inlet, size_t index) const override;
314 
316  static void declare();
317  };
318 
319  // ================================================================================ //
320  // OBJECT +~ //
321  // ================================================================================ //
322 
323  class PlusTilde : public model::Object
324  {
325  public:
326 
328  PlusTilde(flip::Default& d): model::Object(d){};
329 
331  PlusTilde(std::string const& name, std::vector<Atom> const& args);
332 
333  std::string getIODescription(bool is_inlet, size_t index) const override;
334 
336  static void declare();
337  };
338 
339  // ================================================================================ //
340  // OBJECT SIG~ //
341  // ================================================================================ //
342 
343  class SigTilde : public model::Object
344  {
345  public:
346 
348  SigTilde(flip::Default& d): model::Object(d){};
349 
351  SigTilde(std::string const& name, std::vector<Atom> const& args);
352 
353  std::string getIODescription(bool is_inlet, size_t index) const override;
354 
356  static void declare();
357  };
358 
359  // ================================================================================ //
360  // OBJECT DELAYSIMPLETILDE~ //
361  // ================================================================================ //
362 
363  class DelaySimpleTilde : public model::Object
364  {
365  public:
366 
368  DelaySimpleTilde(flip::Default& d): model::Object(d){};
369 
371  DelaySimpleTilde(std::string const& name, std::vector<Atom> const& args);
372 
373  std::string getIODescription(bool is_inlet, size_t index) const override;
374 
376  static void declare();
377  };
378  }
379 }
kiwi::model::AdcTilde::AdcTilde
AdcTilde(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:267
-
kiwi::model::Object::setOutlets
void setOutlets(flip::Array< Outlet > const &outlets)
Clear and replace all the object&#39;s outlets.
Definition: KiwiModel_Object.cpp:282
-
kiwi::model::Metro
Definition: KiwiModel_Objects.h:223
-
kiwi::model::TimesTilde::TimesTilde
TimesTilde(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:308
-
kiwi::model::SigTilde
Definition: KiwiModel_Objects.h:343
-
kiwi::model::DelaySimpleTilde
Definition: KiwiModel_Objects.h:363
-
kiwi::model::Print
Definition: KiwiModel_Objects.h:123
-
kiwi::model::OscTilde::OscTilde
OscTilde(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:247
-
kiwi::model::Receive
Definition: KiwiModel_Objects.h:143
-
kiwi::model::Pipe::Pipe
Pipe(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:208
-
kiwi::model::NewBox::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Objects.cpp:44
-
kiwi::model::Delay::Delay
Delay(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:188
-
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::model::NewBox
Definition: KiwiModel_Objects.h:35
-
kiwi::model::Plus::Plus
Plus(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:88
-
kiwi::model::Delay
Definition: KiwiModel_Objects.h:183
-
kiwi::model::Print::Print
Print(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:128
-
kiwi::model::Times::Times
Times(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:108
-
kiwi::model::DelaySimpleTilde::DelaySimpleTilde
DelaySimpleTilde(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:368
-
kiwi::model::PlusTilde::PlusTilde
PlusTilde(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:328
-
kiwi::model::ErrorBox
Definition: KiwiModel_Objects.h:55
-
kiwi::model::DacTilde::DacTilde
DacTilde(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:288
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::model::Receive::Receive
Receive(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:148
-
kiwi::model::TimesTilde
Definition: KiwiModel_Objects.h:303
-
kiwi::model::Metro::Metro
Metro(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:228
-
kiwi::model::SigTilde::SigTilde
SigTilde(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:348
-
kiwi::model::ErrorBox::ErrorBox
ErrorBox(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:60
-
kiwi::model::NewBox::NewBox
NewBox(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:40
-
kiwi::model::Loadmess::Loadmess
Loadmess(flip::Default &d)
flip Default Constructor
Definition: KiwiModel_Objects.h:168
-
kiwi::model::Times
Definition: KiwiModel_Objects.h:103
-
kiwi::model::Plus
Definition: KiwiModel_Objects.h:83
-
kiwi::model::OscTilde
Definition: KiwiModel_Objects.h:243
-
kiwi::model::DacTilde
Definition: KiwiModel_Objects.h:283
-
kiwi::model::Pipe
Definition: KiwiModel_Objects.h:203
-
kiwi::model::AdcTilde
Definition: KiwiModel_Objects.h:262
-
kiwi::model::PlusTilde
Definition: KiwiModel_Objects.h:323
-
kiwi::model::Object::setInlets
void setInlets(flip::Array< Inlet > const &inlets)
Clear and replace all the object&#39;s inlets.
Definition: KiwiModel_Object.cpp:277
-
kiwi::model::Loadmess
Definition: KiwiModel_Objects.h:163
-
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_NewBox.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_ErrorBox.h>
26 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Print.h>
27 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Receive.h>
28 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Slider.h>
29 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Plus.h>
30 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Times.h>
31 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Delay.h>
32 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Metro.h>
33 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Pipe.h>
34 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Bang.h>
35 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Toggle.h>
36 #include <KiwiModel/KiwiModel_Objects/KiwiModel_AdcTilde.h>
37 #include <KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.h>
38 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OscTilde.h>
39 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Loadmess.h>
40 #include <KiwiModel/KiwiModel_Objects/KiwiModel_SigTilde.h>
41 #include <KiwiModel/KiwiModel_Objects/KiwiModel_TimesTilde.h>
42 #include <KiwiModel/KiwiModel_Objects/KiwiModel_PlusTilde.h>
43 #include <KiwiModel/KiwiModel_Objects/KiwiModel_MeterTilde.h>
44 #include <KiwiModel/KiwiModel_Objects/KiwiModel_DelaySimpleTilde.h>
45 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Message.h>
46 #include <KiwiModel/KiwiModel_Objects/KiwiModel_NoiseTilde.h>
47 #include <KiwiModel/KiwiModel_Objects/KiwiModel_PhasorTilde.h>
48 #include <KiwiModel/KiwiModel_Objects/KiwiModel_SahTilde.h>
49 #include <KiwiModel/KiwiModel_Objects/KiwiModel_SnapshotTilde.h>
50 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Trigger.h>
51 #include <KiwiModel/KiwiModel_Objects/KiwiModel_LineTilde.h>
52 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Minus.h>
53 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Divide.h>
54 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Equal.h>
55 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Less.h>
56 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Greater.h>
57 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Different.h>
58 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Pow.h>
59 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Modulo.h>
60 #include <KiwiModel/KiwiModel_Objects/KiwiModel_MinusTilde.h>
61 #include <KiwiModel/KiwiModel_Objects/KiwiModel_DivideTilde.h>
62 #include <KiwiModel/KiwiModel_Objects/KiwiModel_LessTilde.h>
63 #include <KiwiModel/KiwiModel_Objects/KiwiModel_GreaterTilde.h>
64 #include <KiwiModel/KiwiModel_Objects/KiwiModel_EqualTilde.h>
65 #include <KiwiModel/KiwiModel_Objects/KiwiModel_DifferentTilde.h>
66 #include <KiwiModel/KiwiModel_Objects/KiwiModel_LessEqual.h>
67 #include <KiwiModel/KiwiModel_Objects/KiwiModel_LessEqualTilde.h>
68 #include <KiwiModel/KiwiModel_Objects/KiwiModel_GreaterEqual.h>
69 #include <KiwiModel/KiwiModel_Objects/KiwiModel_GreaterEqualTilde.h>
70 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Comment.h>
71 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Pack.h>
72 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Unpack.h>
73 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Random.h>
74 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Scale.h>
75 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Select.h>
76 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Number.h>
77 #include <KiwiModel/KiwiModel_Objects/KiwiModel_NumberTilde.h>
78 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Hub.h>
79 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Mtof.h>
80 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Send.h>
81 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Gate.h>
82 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Switch.h>
83 #include <KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.h>
84 #include <KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.h>
85 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Float.h>
86 #include <KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.h>
87 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Clip.h>
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___operator_8h_source.html b/docs/html/_kiwi_model___operator_8h_source.html new file mode 100644 index 00000000..e6163916 --- /dev/null +++ b/docs/html/_kiwi_model___operator_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Operator.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OPERATOR //
30  // ================================================================================ //
31 
32  class Operator : public model::Object
33  {
34  public: // methods
35 
36  Operator(flip::Default& d) : model::Object(d) {}
37 
38  Operator(std::vector<tool::Atom> const& args);
39 
40  std::string getIODescription(bool is_inlet, size_t index) const override;
41 
42  static void declare();
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Operator::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Operator.cpp:62
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___operator_tilde_8h_source.html b/docs/html/_kiwi_model___operator_tilde_8h_source.html new file mode 100644 index 00000000..c3c5f481 --- /dev/null +++ b/docs/html/_kiwi_model___operator_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_OperatorTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OPERATOR TILDE //
30  // ================================================================================ //
31 
32  class OperatorTilde : public model::Object
33  {
34  public: // methods
35 
36  OperatorTilde(flip::Default& d) : model::Object(d) {}
37 
38  OperatorTilde(std::vector<tool::Atom> const& args);
39 
40  std::string getIODescription(bool is_inlet, size_t index) const override;
41 
42  static void declare();
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
kiwi::model::OperatorTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_OperatorTilde.cpp:62
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___osc_tilde_8h_source.html b/docs/html/_kiwi_model___osc_tilde_8h_source.html new file mode 100644 index 00000000..df70ed90 --- /dev/null +++ b/docs/html/_kiwi_model___osc_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_OscTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_OscTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT OSC~ //
30  // ================================================================================ //
31 
32  class OscTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  OscTilde(flip::Default& d): model::Object(d){};
41 
42  OscTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OscTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_OscTilde.cpp:63
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::OscTilde
Definition: KiwiModel_OscTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___pack_8h_source.html b/docs/html/_kiwi_model___pack_8h_source.html new file mode 100644 index 00000000..4444737e --- /dev/null +++ b/docs/html/_kiwi_model___pack_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pack.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Pack.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // PACK //
30  // ================================================================================ //
31 
32  class Pack : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Pack(flip::Default& d) : model::Object(d) {}
41 
42  Pack(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45 
46  private: // methods
47 
48  static std::string getTypeDescription(tool::Atom const& atom);
49  };
50 
51 }}
kiwi::model::Pack::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Pack.cpp:57
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::tool::Atom
The Atom can dynamically hold different types of value.
Definition: KiwiTool_Atom.h:39
+
kiwi::model::Pack
Definition: KiwiModel_Pack.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___patcher_8h_source.html b/docs/html/_kiwi_model___patcher_8h_source.html index fa533d9d..fcabbb88 100644 --- a/docs/html/_kiwi_model___patcher_8h_source.html +++ b/docs/html/_kiwi_model___patcher_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_Patcher.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
KiwiModel_Patcher.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_Link.h"
25 
26 namespace kiwi
27 {
28  namespace model
29  {
30  // ================================================================================ //
31  // PATCHER //
32  // ================================================================================ //
33 
35  class Patcher : public flip::Object
36  {
37  public: // methods
38 
39  class User;
40  class View;
41 
42  using Objects = flip::Array<model::Object>;
43  using Links = flip::Array<model::Link>;
44  using Users = flip::Collection<User>;
45 
47  Patcher();
48 
50  ~Patcher();
51 
58  model::Object& addObject(std::string const& name, std::vector<Atom> const& args);
59 
61  model::Object& addObject(std::string const& name, flip::Mold const& mold);
62 
71  model::Link* addLink(model::Object const& from,
72  const size_t outlet,
73  model::Object const& to,
74  const size_t inlet);
75 
79  void removeObject(model::Object const& object, Patcher::View* view = nullptr);
80 
83  void removeLink(model::Link const& link, Patcher::View* view = nullptr);
84 
86  bool objectsChanged() const noexcept;
87 
89  bool linksChanged() const noexcept;
90 
92  bool usersChanged() const noexcept;
93 
95  bool nameChanged() const noexcept;
96 
98  std::string getName() const;
99 
101  void setName(std::string const& new_name);
102 
104  Objects const& getObjects() const noexcept;
105 
107  Objects& getObjects() noexcept;
108 
110  Links const& getLinks() const noexcept;
111 
113  Links& getLinks() noexcept;
114 
116  Users const& getUsers() const noexcept;
117 
119  Users& getUsers() noexcept;
120 
126  User& useSelfUser();
127 
128  public: // signals
129 
130  enum
131  {
132  Signal_USER_CONNECT = 0,
133  Signal_USER_DISCONNECT,
134  Signal_GET_CONNECTED_USERS,
135  Signal_RECEIVE_CONNECTED_USERS,
136  };
137 
138  // from server to client
139  flip::Signal<uint64_t> signal_user_connect;
140 
141  // from server to client
142  flip::Signal<uint64_t> signal_user_disconnect;
143 
144  // from client to server
145  flip::Signal<> signal_get_connected_users;
146 
147  // from server to client
148  flip::Signal<std::vector<uint64_t>> signal_receive_connected_users;
149 
150  public: // internal methods
151 
153  static void declare();
154 
155  private: // methods
156 
157  Objects::const_iterator findObject(model::Object const& object) const;
158  Objects::iterator findObject(model::Object const& object);
159 
160  Links::const_iterator findLink(model::Link const& object) const;
161  Links::iterator findLink(model::Link const& object);
162 
164  bool canConnect(model::Object const& from, const size_t outlet,
165  model::Object const& to, const size_t inlet) const;
166 
167  private: // members
168 
169  Objects m_objects;
170  Links m_links;
171 
172  Users m_users;
173 
174  flip::String m_patcher_name;
175 
176  private: // deleted methods
177 
178  Patcher(Patcher const&) = delete;
179  Patcher(Patcher&&) = delete;
180  Patcher& operator=(Patcher const&) = delete;
181  Patcher& operator=(Patcher&&) = delete;
182  };
183  }
184 }
kiwi::model::Patcher::removeLink
void removeLink(model::Link const &link, Patcher::View *view=nullptr)
Removes a link from the Patcher.
Definition: KiwiModel_Patcher.cpp:165
-
kiwi::model::Patcher::objectsChanged
bool objectsChanged() const noexcept
Returns true if an Object has been added, removed or changed.
Definition: KiwiModel_Patcher.cpp:182
-
kiwi::model::Patcher::getUsers
Users const & getUsers() const noexcept
Gets the users.
Definition: KiwiModel_Patcher.cpp:232
-
kiwi::model::Patcher::getObjects
Objects const & getObjects() const noexcept
Gets the objects.
Definition: KiwiModel_Patcher.cpp:212
-
kiwi::model::Patcher::useSelfUser
User & useSelfUser()
Returns the current User.
Definition: KiwiModel_Patcher.cpp:242
-
kiwi::model::Patcher::addObject
model::Object & addObject(std::string const &name, std::vector< Atom > const &args)
Try to create an Object with a text.
Definition: KiwiModel_Patcher.cpp:70
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_Link.h"
25 
26 namespace kiwi
27 {
28  namespace model
29  {
30  // ================================================================================ //
31  // PATCHER //
32  // ================================================================================ //
33 
35  class Patcher : public flip::Object
36  {
37  public: // methods
38 
39  class User;
40  class View;
41 
42  using Objects = flip::Array<model::Object>;
43  using Links = flip::Array<model::Link>;
44  using Users = flip::Collection<User>;
45 
47  Patcher();
48 
50  ~Patcher();
51 
55  model::Object& addObject(std::unique_ptr<model::Object> && object);
56 
60  model::Object& replaceObject(model::Object const& old_object, std::unique_ptr<model::Object> && object);
61 
63  model::Object& addObject(std::string const& name, flip::Mold const& mold);
64 
73  model::Link* addLink(model::Object const& from,
74  const size_t outlet,
75  model::Object const& to,
76  const size_t inlet);
77 
81  void removeObject(model::Object const& object, Patcher::View* view = nullptr);
82 
85  void removeLink(model::Link const& link, Patcher::View* view = nullptr);
86 
88  bool objectsChanged() const noexcept;
89 
91  bool linksChanged() const noexcept;
92 
94  bool usersChanged() const noexcept;
95 
97  Objects const& getObjects() const noexcept;
98 
100  Objects& getObjects() noexcept;
101 
103  Links const& getLinks() const noexcept;
104 
106  Links& getLinks() noexcept;
107 
109  Users const& getUsers() const noexcept;
110 
112  Users& getUsers() noexcept;
113 
115  bool hasSelfUser() const;
116 
122  User& useSelfUser();
123 
124  public: // signals
125 
126  enum
127  {
128  Signal_USER_CONNECT = 0,
129  Signal_USER_DISCONNECT,
130  Signal_GET_CONNECTED_USERS,
131  Signal_RECEIVE_CONNECTED_USERS,
132  };
133 
134  // from server to client
135  flip::Signal<uint64_t> signal_user_connect;
136 
137  // from server to client
138  flip::Signal<uint64_t> signal_user_disconnect;
139 
140  // from client to server
141  flip::Signal<> signal_get_connected_users;
142 
143  // from server to client
144  flip::Signal<std::vector<uint64_t>> signal_receive_connected_users;
145 
146  public: // internal methods
147 
149  static void declare();
150 
151  private: // methods
152 
153  Objects::const_iterator findObject(model::Object const& object) const;
154  Objects::iterator findObject(model::Object const& object);
155 
156  Links::const_iterator findLink(model::Link const& object) const;
157  Links::iterator findLink(model::Link const& object);
158 
160  bool canConnect(model::Object const& from, const size_t outlet,
161  model::Object const& to, const size_t inlet) const;
162 
163  private: // members
164 
165  Objects m_objects;
166  Links m_links;
167 
168  Users m_users;
169 
170  private: // deleted methods
171 
172  Patcher(Patcher const&) = delete;
173  Patcher(Patcher&&) = delete;
174  Patcher& operator=(Patcher const&) = delete;
175  Patcher& operator=(Patcher&&) = delete;
176  };
177  }
178 }
kiwi::model::Patcher::getUsers
Users const & getUsers() const noexcept
Gets the users.
Definition: KiwiModel_Patcher.cpp:259
+
kiwi::model::Patcher::removeLink
void removeLink(model::Link const &link, Patcher::View *view=nullptr)
Removes a link from the Patcher.
Definition: KiwiModel_Patcher.cpp:207
+
kiwi::model::Patcher::getLinks
Links const & getLinks() const noexcept
Gets the links.
Definition: KiwiModel_Patcher.cpp:249
+
kiwi::model::Patcher::replaceObject
model::Object & replaceObject(model::Object const &old_object, std::unique_ptr< model::Object > &&object)
Replaces an object by another one.
Definition: KiwiModel_Patcher.cpp:75
+
kiwi::model::Patcher::hasSelfUser
bool hasSelfUser() const
Returns true if current user is already in added to the document.
Definition: KiwiModel_Patcher.cpp:269
+
kiwi::model::Patcher::useSelfUser
User & useSelfUser()
Returns the current User.
Definition: KiwiModel_Patcher.cpp:281
kiwi::model::Patcher::User
Represents and stores informations about a user of a patcher document.
Definition: KiwiModel_PatcherUser.h:36
kiwi::model::Patcher::View
The Patcher::View class holds the informations about a view of a Patcher.
Definition: KiwiModel_PatcherView.h:35
+
kiwi::model::Patcher::linksChanged
bool linksChanged() const noexcept
Returns true if a Link has been added, removed or changed.
Definition: KiwiModel_Patcher.cpp:229
+
kiwi::model::Patcher::usersChanged
bool usersChanged() const noexcept
Returns true if a User has been added, removed or changed.
Definition: KiwiModel_Patcher.cpp:234
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::model::Patcher::getName
std::string getName() const
Returns the Patcher name.
Definition: KiwiModel_Patcher.cpp:202
kiwi::model::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiModel_Patcher.h:35
-
kiwi::model::Patcher::Patcher
Patcher()
Default constructor.
Definition: KiwiModel_Patcher.cpp:54
-
kiwi::model::Patcher::getLinks
Links const & getLinks() const noexcept
Gets the links.
Definition: KiwiModel_Patcher.cpp:222
-
kiwi::model::Patcher::removeObject
void removeObject(model::Object const &object, Patcher::View *view=nullptr)
Removes an object from the Patcher.
Definition: KiwiModel_Patcher.cpp:125
-
kiwi::model::Patcher::addLink
model::Link * addLink(model::Object const &from, const size_t outlet, model::Object const &to, const size_t inlet)
Constructs and add a Link to the Patcher.
Definition: KiwiModel_Patcher.cpp:80
-
kiwi::model::Patcher::setName
void setName(std::string const &new_name)
Sets the Patcher name.
Definition: KiwiModel_Patcher.cpp:207
-
kiwi::model::Patcher::usersChanged
bool usersChanged() const noexcept
Returns true if a User has been added, removed or changed.
Definition: KiwiModel_Patcher.cpp:192
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
-
kiwi::model::Patcher::linksChanged
bool linksChanged() const noexcept
Returns true if a Link has been added, removed or changed.
Definition: KiwiModel_Patcher.cpp:187
+
kiwi::model::Patcher::Patcher
Patcher()
Default constructor.
Definition: KiwiModel_Patcher.cpp:53
+
kiwi::model::Patcher::removeObject
void removeObject(model::Object const &object, Patcher::View *view=nullptr)
Removes an object from the Patcher.
Definition: KiwiModel_Patcher.cpp:167
+
kiwi::model::Patcher::addLink
model::Link * addLink(model::Object const &from, const size_t outlet, model::Object const &to, const size_t inlet)
Constructs and add a Link to the Patcher.
Definition: KiwiModel_Patcher.cpp:122
+
kiwi::model::Patcher::objectsChanged
bool objectsChanged() const noexcept
Returns true if an Object has been added, removed or changed.
Definition: KiwiModel_Patcher.cpp:224
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Patcher::addObject
model::Object & addObject(std::unique_ptr< model::Object > &&object)
Adds an object to the patcher model.
Definition: KiwiModel_Patcher.cpp:69
+
kiwi::model::Patcher::getObjects
Objects const & getObjects() const noexcept
Gets the objects.
Definition: KiwiModel_Patcher.cpp:239
-
kiwi::model::Patcher::nameChanged
bool nameChanged() const noexcept
Returns true if the Patcher name changed.
Definition: KiwiModel_Patcher.cpp:197
-
kiwi::model::Patcher::~Patcher
~Patcher()
Destructor.
Definition: KiwiModel_Patcher.cpp:64
+
kiwi::model::Patcher::~Patcher
~Patcher()
Destructor.
Definition: KiwiModel_Patcher.cpp:63
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___patcher_user_8h_source.html b/docs/html/_kiwi_model___patcher_user_8h_source.html index 8cc1d840..ff93260f 100644 --- a/docs/html/_kiwi_model___patcher_user_8h_source.html +++ b/docs/html/_kiwi_model___patcher_user_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_PatcherUser.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
KiwiModel_PatcherUser.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_Patcher.h"
25 #include "KiwiModel_PatcherView.h"
26 
27 namespace kiwi
28 {
29  namespace model
30  {
31  // ================================================================================ //
32  // PATCHER USER //
33  // ================================================================================ //
34 
36  class Patcher::User : public flip::Object
37  {
38  public: // methods
39 
41  User();
42 
44  ~User() = default;
45 
47  View& addView();
48 
50  flip::Collection<Patcher::View>::iterator removeView(View const& view);
51 
53  flip::Collection<Patcher::View> const& getViews() const noexcept;
54 
56  flip::Collection<Patcher::View>& getViews() noexcept;
57 
59  size_t getNumberOfViews() const noexcept;
60 
62  uint64_t getId() const;
63 
64  public: // internal methods
65 
67  static void declare();
68 
69  private: // members
70 
71  flip::Collection<Patcher::View> m_views;
72 
73  friend Patcher;
74  };
75  }
76 }
kiwi::model::Patcher::User::removeView
flip::Collection< Patcher::View >::iterator removeView(View const &view)
Remove a View.
Definition: KiwiModel_PatcherUser.cpp:56
-
kiwi::model::Patcher::User::getViews
flip::Collection< Patcher::View > const & getViews() const noexcept
Get views.
Definition: KiwiModel_PatcherUser.cpp:75
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_Patcher.h"
25 #include "KiwiModel_PatcherView.h"
26 
27 namespace kiwi
28 {
29  namespace model
30  {
31  // ================================================================================ //
32  // PATCHER USER //
33  // ================================================================================ //
34 
36  class Patcher::User : public flip::Object
37  {
38  public: // methods
39 
41  User();
42 
44  ~User() = default;
45 
47  View& addView();
48 
50  flip::Collection<Patcher::View>::iterator removeView(View const& view);
51 
53  flip::Collection<Patcher::View> const& getViews() const noexcept;
54 
56  flip::Collection<Patcher::View>& getViews() noexcept;
57 
59  size_t getNumberOfViews() const noexcept;
60 
62  uint64_t getId() const;
63 
64  public: // internal methods
65 
67  static void declare();
68 
69  private: // members
70 
71  flip::Collection<Patcher::View> m_views;
72 
73  friend Patcher;
74  };
75  }
76 }
kiwi::model::Patcher::User::removeView
flip::Collection< Patcher::View >::iterator removeView(View const &view)
Remove a View.
Definition: KiwiModel_PatcherUser.cpp:56
+
kiwi::model::Patcher::User::getId
uint64_t getId() const
Get the User id.
Definition: KiwiModel_PatcherUser.cpp:70
kiwi::model::Patcher::User
Represents and stores informations about a user of a patcher document.
Definition: KiwiModel_PatcherUser.h:36
kiwi::model::Patcher::View
The Patcher::View class holds the informations about a view of a Patcher.
Definition: KiwiModel_PatcherView.h:35
+
kiwi::model::Patcher::User::getNumberOfViews
size_t getNumberOfViews() const noexcept
Get the number of active views.
Definition: KiwiModel_PatcherUser.cpp:85
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::model::Patcher::User::~User
~User()=default
Destructor.
+
kiwi::model::Patcher::User::getViews
flip::Collection< Patcher::View > const & getViews() const noexcept
Get views.
Definition: KiwiModel_PatcherUser.cpp:75
kiwi::model::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiModel_Patcher.h:35
-
kiwi::model::Patcher::User::getId
uint64_t getId() const
Get the User id.
Definition: KiwiModel_PatcherUser.cpp:70
kiwi::model::Patcher::User::declare
static void declare()
flip declare method
Definition: KiwiModel_PatcherUser.cpp:33
-
kiwi::model::Patcher::User::getNumberOfViews
size_t getNumberOfViews() const noexcept
Get the number of active views.
Definition: KiwiModel_PatcherUser.cpp:85
kiwi::model::Patcher::User::User
User()
Constructor.
Definition: KiwiModel_PatcherUser.cpp:46
kiwi::model::Patcher::User::addView
View & addView()
Add a new View.
Definition: KiwiModel_PatcherUser.cpp:51
@@ -83,7 +107,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___patcher_validator_8h_source.html b/docs/html/_kiwi_model___patcher_validator_8h_source.html index 7d72e81e..fa749087 100644 --- a/docs/html/_kiwi_model___patcher_validator_8h_source.html +++ b/docs/html/_kiwi_model___patcher_validator_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_PatcherValidator.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@
- + - - - - + +
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "flip/DocumentValidator.h"
25 
26 #include "KiwiModel_PatcherUser.h"
27 
28 namespace kiwi
29 {
30  namespace model
31  {
32  // ================================================================================ //
33  // PATCHERVALIDATOR //
34  // ================================================================================ //
35 
36  class PatcherValidator : public flip::DocumentValidator<Patcher>
37  {
38  public: // methods
39 
40  PatcherValidator() = default;
41  ~PatcherValidator() = default;
42 
43  // @brief Validate the model before a transaction can be executed.
44  virtual void validate (Patcher& patcher) override;
45 
46  private: // methods
47 
49  void objectRemoved(Object const& object, Patcher const& patcher) const;
50 
52  void linkAdded(Link const& link) const;
53 
54  private: // deleted methods
55  PatcherValidator(PatcherValidator const& other) = delete;
56  PatcherValidator(PatcherValidator && other) = delete;
57  PatcherValidator& operator=(PatcherValidator const& other) = delete;
58  PatcherValidator& operator=(PatcherValidator && other) = delete;
59  };
60  }
61 }
kiwi::model::PatcherValidator
Definition: KiwiModel_PatcherValidator.h:36
kiwi
Definition: KiwiDsp_Chain.cpp:25
kiwi::model::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiModel_Patcher.h:35
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___patcher_view_8h_source.html b/docs/html/_kiwi_model___patcher_view_8h_source.html index aba1ba63..13e120fe 100644 --- a/docs/html/_kiwi_model___patcher_view_8h_source.html +++ b/docs/html/_kiwi_model___patcher_view_8h_source.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel/KiwiModel_PatcherView.h Source File @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
KiwiModel_PatcherView.h
-
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_PatcherUser.h"
25 
26 namespace kiwi
27 {
28  namespace model
29  {
30  // ================================================================================ //
31  // PATCHER VIEW //
32  // ================================================================================ //
33 
35  class Patcher::View : public flip::Object
36  {
37  public: // methods
38 
40  View();
41 
43  ~View();
44 
46  Patcher& getPatcher();
47 
49  void setLock(bool locked);
50 
52  bool getLock() const noexcept;
53 
55  bool lockChanged() const noexcept;
56 
58  void setZoomFactor(double zoom_factor);
59 
61  double getZoomFactor() const noexcept;
62 
64  bool zoomFactorChanged() const noexcept;
65 
66  // ================================================================================ //
67  // SELECTION //
68  // ================================================================================ //
69 
71  std::vector<model::Object*> getSelectedObjects();
72 
74  std::vector<model::Link*> getSelectedLinks();
75 
77  bool isSelected(model::Object const& object) const;
78 
80  bool isSelected(model::Link const& link) const;
81 
83  bool selectionChanged() const;
84 
86  void selectObject(model::Object& object);
87 
89  void selectLink(model::Link& object);
90 
92  void unselectObject(model::Object& object);
93 
95  void unselectLink(model::Link& object);
96 
98  void unselectAll();
99 
101  void selectAll();
102 
103  public: // internal methods
104 
106  View(flip::Default&) {};
107 
109  static void declare();
110 
111  private: // nested classes
112 
113  // ================================================================================ //
114  // PATCHER VIEW OBJECT //
115  // ================================================================================ //
116 
118  struct Object : public flip::Object
119  {
120  public: // methods
121 
122  Object() = default;
123  ~Object() = default;
124  Object(model::Object& object);
125  model::Object* get() const;
126 
127  public: // internal methods
128 
130  static void declare();
131 
132  private: // members
133 
134  flip::ObjectRef<model::Object> m_ref;
135  };
136 
137  // ================================================================================ //
138  // PATCHER VIEW LINK //
139  // ================================================================================ //
140 
142  struct Link : public flip::Object
143  {
144  public: // methods
145 
146  Link() = default;
147  ~Link() = default;
148  Link(model::Link& link);
149  model::Link* get() const;
150 
151  public: // internal methods
152 
154  static void declare();
155 
156  private: // members
157 
158  flip::ObjectRef<model::Link> m_ref;
159  };
160 
161  private: // members
162 
163  flip::Collection<View::Object> m_selected_objects;
164  flip::Collection<View::Link> m_selected_links;
165 
166  flip::Bool m_is_locked;
167  flip::Float m_zoom_factor;
168  };
169  }
170 }
kiwi::model::Patcher::View::getLock
bool getLock() const noexcept
Returns true if the view is locked.
Definition: KiwiModel_PatcherView.cpp:91
-
kiwi::model::Patcher::View::zoomFactorChanged
bool zoomFactorChanged() const noexcept
Returns true if the zoom factor changed.
Definition: KiwiModel_PatcherView.cpp:112
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiModel_PatcherUser.h"
25 
26 namespace kiwi
27 {
28  namespace model
29  {
30  // ================================================================================ //
31  // PATCHER VIEW //
32  // ================================================================================ //
33 
35  class Patcher::View : public flip::Object
36  {
37  public: // methods
38 
40  View();
41 
43  ~View();
44 
46  Patcher& getPatcher();
47 
49  void setLock(bool locked);
50 
52  bool getLock() const noexcept;
53 
55  bool lockChanged() const noexcept;
56 
58  void setZoomFactor(double zoom_factor);
59 
61  double getZoomFactor() const noexcept;
62 
64  bool zoomFactorChanged() const noexcept;
65 
66  // ================================================================================ //
67  // SELECTION //
68  // ================================================================================ //
69 
71  std::vector<model::Object*> getSelectedObjects();
72 
74  std::vector<model::Link*> getSelectedLinks();
75 
77  bool isSelected(model::Object const& object) const;
78 
80  bool isSelected(model::Link const& link) const;
81 
83  bool selectionChanged() const;
84 
86  void selectObject(model::Object& object);
87 
89  void selectLink(model::Link& object);
90 
92  void unselectObject(model::Object& object);
93 
95  void unselectLink(model::Link& object);
96 
98  void unselectAll();
99 
101  void selectAll();
102 
103  public: // internal methods
104 
106  View(flip::Default&) {};
107 
109  static void declare();
110 
111  private: // nested classes
112 
113  // ================================================================================ //
114  // PATCHER VIEW OBJECT //
115  // ================================================================================ //
116 
118  struct Object : public flip::Object
119  {
120  public: // methods
121 
122  Object() = default;
123  ~Object() = default;
124  Object(model::Object& object);
125  model::Object* get() const;
126 
127  public: // internal methods
128 
130  static void declare();
131 
132  private: // members
133 
134  flip::ObjectRef<model::Object> m_ref;
135  };
136 
137  // ================================================================================ //
138  // PATCHER VIEW LINK //
139  // ================================================================================ //
140 
142  struct Link : public flip::Object
143  {
144  public: // methods
145 
146  Link() = default;
147  ~Link() = default;
148  Link(model::Link& link);
149  model::Link* get() const;
150 
151  public: // internal methods
152 
154  static void declare();
155 
156  private: // members
157 
158  flip::ObjectRef<model::Link> m_ref;
159  };
160 
161  private: // members
162 
163  flip::Collection<View::Object> m_selected_objects;
164  flip::Collection<View::Link> m_selected_links;
165 
166  flip::Bool m_is_locked;
167  flip::Float m_zoom_factor;
168  };
169  }
170 }
kiwi::model::Patcher::View::zoomFactorChanged
bool zoomFactorChanged() const noexcept
Returns true if the zoom factor changed.
Definition: KiwiModel_PatcherView.cpp:112
kiwi::model::Patcher::View::selectAll
void selectAll()
Select all objects and links.
Definition: KiwiModel_PatcherView.cpp:240
kiwi::model::Patcher::View::setZoomFactor
void setZoomFactor(double zoom_factor)
Set zoom factor.
Definition: KiwiModel_PatcherView.cpp:101
kiwi::model::Patcher::View::View
View()
Constructor.
Definition: KiwiModel_PatcherView.cpp:70
+
kiwi::model::Patcher::View::isSelected
bool isSelected(model::Object const &object) const
Return true if the given Object is selected in this view.
Definition: KiwiModel_PatcherView.cpp:139
kiwi::model::Patcher::View
The Patcher::View class holds the informations about a view of a Patcher.
Definition: KiwiModel_PatcherView.h:35
kiwi::model::Patcher::View::unselectLink
void unselectLink(model::Link &object)
Unselect a Link.
Definition: KiwiModel_PatcherView.cpp:212
-
kiwi::model::Patcher::View::getZoomFactor
double getZoomFactor() const noexcept
Returns the current zoom factor.
Definition: KiwiModel_PatcherView.cpp:107
kiwi::model::Patcher::View::getSelectedObjects
std::vector< model::Object * > getSelectedObjects()
Return the selected Objects.
Definition: KiwiModel_PatcherView.cpp:117
kiwi
Definition: KiwiDsp_Chain.cpp:25
-
kiwi::model::Patcher::View::lockChanged
bool lockChanged() const noexcept
Returns true if the lock status changed.
Definition: KiwiModel_PatcherView.cpp:96
kiwi::model::Patcher::View::unselectObject
void unselectObject(model::Object &object)
Unselect an Object.
Definition: KiwiModel_PatcherView.cpp:190
kiwi::model::Patcher::View::getSelectedLinks
std::vector< model::Link * > getSelectedLinks()
Return the selected Links.
Definition: KiwiModel_PatcherView.cpp:128
kiwi::model::Patcher
The Patcher manages a set of Object and Link.
Definition: KiwiModel_Patcher.h:35
-
kiwi::model::Patcher::View::isSelected
bool isSelected(model::Object const &object) const
Return true if the given Object is selected in this view.
Definition: KiwiModel_PatcherView.cpp:139
+
kiwi::model::Patcher::View::selectionChanged
bool selectionChanged() const
Returns true if selection has changed.
Definition: KiwiModel_PatcherView.cpp:169
+
kiwi::model::Patcher::View::getLock
bool getLock() const noexcept
Returns true if the view is locked.
Definition: KiwiModel_PatcherView.cpp:91
kiwi::model::Patcher::View::unselectAll
void unselectAll()
Unselect all objects and links.
Definition: KiwiModel_PatcherView.cpp:234
-
kiwi::model::Patcher::View::selectionChanged
bool selectionChanged() const
Returns true if selection has changed.
Definition: KiwiModel_PatcherView.cpp:169
-
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:152
+
kiwi::model::Patcher::View::lockChanged
bool lockChanged() const noexcept
Returns true if the lock status changed.
Definition: KiwiModel_PatcherView.cpp:96
+
kiwi::model::Patcher::View::getZoomFactor
double getZoomFactor() const noexcept
Returns the current zoom factor.
Definition: KiwiModel_PatcherView.cpp:107
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
kiwi::model::Patcher::View::setLock
void setLock(bool locked)
Set the lock status.
Definition: KiwiModel_PatcherView.cpp:86
kiwi::model::Patcher::View::selectObject
void selectObject(model::Object &object)
Select an Object.
Definition: KiwiModel_PatcherView.cpp:174
@@ -95,7 +119,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/_kiwi_model___phasor_tilde_8h_source.html b/docs/html/_kiwi_model___phasor_tilde_8h_source.html new file mode 100644 index 00000000..f268aa1f --- /dev/null +++ b/docs/html/_kiwi_model___phasor_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_PhasorTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_PhasorTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // PHASOR~ //
30  // ================================================================================ //
31 
32  class PhasorTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  PhasorTilde(flip::Default& d): model::Object(d){};
41 
42  PhasorTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 }}
47 
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::PhasorTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_PhasorTilde.cpp:66
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::PhasorTilde
Definition: KiwiModel_PhasorTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___pipe_8h_source.html b/docs/html/_kiwi_model___pipe_8h_source.html new file mode 100644 index 00000000..71898410 --- /dev/null +++ b/docs/html/_kiwi_model___pipe_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pipe.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Pipe.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT PIPE //
30  // ================================================================================ //
31 
32  class Pipe : public model::Object
33  {
34  public: // methods
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Pipe(flip::Default& d) : model::Object(d) {};
41 
42  Pipe(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Pipe::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Pipe.cpp:66
+
kiwi::model::Pipe
Definition: KiwiModel_Pipe.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___plus_8h_source.html b/docs/html/_kiwi_model___plus_8h_source.html new file mode 100644 index 00000000..42764230 --- /dev/null +++ b/docs/html/_kiwi_model___plus_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Plus.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Plus.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT PLUS //
31  // ================================================================================ //
32 
33  class Plus : public Operator
34  {
35  public:
36 
37  Plus(flip::Default& d) : Operator(d) {}
38 
39  Plus(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Plus
Definition: KiwiModel_Plus.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___plus_tilde_8h_source.html b/docs/html/_kiwi_model___plus_tilde_8h_source.html new file mode 100644 index 00000000..347140c8 --- /dev/null +++ b/docs/html/_kiwi_model___plus_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_PlusTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_PlusTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT PLUS~ //
30  // ================================================================================ //
31 
32  class PlusTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  PlusTilde(flip::Default& d): model::OperatorTilde(d){};
41 
42  PlusTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
kiwi::model::PlusTilde
Definition: KiwiModel_PlusTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___pow_8h_source.html b/docs/html/_kiwi_model___pow_8h_source.html new file mode 100644 index 00000000..e18760b7 --- /dev/null +++ b/docs/html/_kiwi_model___pow_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pow.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Pow.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT POW //
31  // ================================================================================ //
32 
33  class Pow : public Operator
34  {
35  public:
36 
37  Pow(flip::Default& d) : Operator(d) {}
38 
39  Pow(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Pow
Definition: KiwiModel_Pow.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___print_8h_source.html b/docs/html/_kiwi_model___print_8h_source.html new file mode 100644 index 00000000..c6cc3ae1 --- /dev/null +++ b/docs/html/_kiwi_model___print_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Print.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Print.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT PRINT //
30  // ================================================================================ //
31 
32  class Print : public model::Object
33  {
34  public: // methods
35 
36  Print(flip::Default& d) : model::Object(d) {}
37 
38  Print(std::vector<tool::Atom> const& args);
39 
40  std::string getIODescription(bool is_inlet, size_t index) const override;
41 
42  static void declare();
43 
44  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
45 
46  };
47 
48 }}
kiwi::model::Print
Definition: KiwiModel_Print.h:32
+
kiwi::model::Print::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Print.cpp:64
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___random_8h_source.html b/docs/html/_kiwi_model___random_8h_source.html new file mode 100644 index 00000000..02b50074 --- /dev/null +++ b/docs/html/_kiwi_model___random_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Random.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Random.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // RANDOM //
30  // ================================================================================ //
31 
32  class Random : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Random(flip::Default& d): model::Object(d){};
41 
42  Random(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Random
Definition: KiwiModel_Random.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Random::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Random.cpp:69
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___receive_8h_source.html b/docs/html/_kiwi_model___receive_8h_source.html new file mode 100644 index 00000000..13cb430c --- /dev/null +++ b/docs/html/_kiwi_model___receive_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Receive.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Receive.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT RECEIVE //
30  // ================================================================================ //
31 
32  class Receive : public model::Object
33  {
34  public: // methods
35 
36  Receive(flip::Default& d) : model::Object(d) {}
37 
38  Receive(std::vector<tool::Atom> const& args);
39 
40  std::string getIODescription(bool is_inlet, size_t index) const override;
41 
42  static void declare();
43 
44  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
45 
46  };
47 }}
kiwi::model::Receive
Definition: KiwiModel_Receive.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Receive::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Receive.cpp:75
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___sah_tilde_8h_source.html b/docs/html/_kiwi_model___sah_tilde_8h_source.html new file mode 100644 index 00000000..1cdf7b1e --- /dev/null +++ b/docs/html/_kiwi_model___sah_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SahTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_SahTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // SAH~ //
30  // ================================================================================ //
31 
32  class SahTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  SahTilde(flip::Default& d): model::Object(d){};
41 
42  SahTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 }}
47 
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::SahTilde
Definition: KiwiModel_SahTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::SahTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_SahTilde.cpp:64
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___scale_8h_source.html b/docs/html/_kiwi_model___scale_8h_source.html new file mode 100644 index 00000000..33739080 --- /dev/null +++ b/docs/html/_kiwi_model___scale_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Scale.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Scale.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // SCALE //
30  // ================================================================================ //
31 
32  class Scale : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Scale(flip::Default& d): model::Object(d){};
41 
42  Scale(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Scale
Definition: KiwiModel_Scale.h:32
+
kiwi::model::Scale::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Scale.cpp:81
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___select_8h_source.html b/docs/html/_kiwi_model___select_8h_source.html new file mode 100644 index 00000000..87ec6cb2 --- /dev/null +++ b/docs/html/_kiwi_model___select_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Select.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Select.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // SELECT //
30  // ================================================================================ //
31 
32  class Select : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Select(flip::Default& d) : model::Object(d) {}
41 
42  Select(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::Select
Definition: KiwiModel_Select.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Select::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Select.cpp:65
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___send_8h_source.html b/docs/html/_kiwi_model___send_8h_source.html new file mode 100644 index 00000000..edf198ef --- /dev/null +++ b/docs/html/_kiwi_model___send_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Send.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Send.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // SEND //
30  // ================================================================================ //
31 
32  class Send : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Send(flip::Default& d) : model::Object(d) {}
41 
42  Send(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::Send::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Send.cpp:63
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Send
Definition: KiwiModel_Send.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___sig_tilde_8h_source.html b/docs/html/_kiwi_model___sig_tilde_8h_source.html new file mode 100644 index 00000000..2d869f5a --- /dev/null +++ b/docs/html/_kiwi_model___sig_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SigTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_SigTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT SIG~ //
30  // ================================================================================ //
31 
32  class SigTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  SigTilde(flip::Default& d): model::Object(d){};
41 
42  SigTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::SigTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_SigTilde.cpp:69
+
kiwi::model::SigTilde
Definition: KiwiModel_SigTilde.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___slider_8h_source.html b/docs/html/_kiwi_model___slider_8h_source.html new file mode 100644 index 00000000..44625c64 --- /dev/null +++ b/docs/html/_kiwi_model___slider_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Slider.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Slider.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <string>
25 #include <vector>
26 
27 #include <flip/detail/Default.h>
28 #include <flip/Bool.h>
29 
30 #include <KiwiModel/KiwiModel_Object.h>
31 #include <KiwiTool/KiwiTool_Atom.h>
32 
33 namespace kiwi { namespace model {
34 
35  // ================================================================================ //
36  // OBJECT SLIDER //
37  // ================================================================================ //
38 
39  class Slider : public model::Object
40  {
41  public: // enum
42 
43  enum Signal : SignalKey
44  {
45  OutputValue
46  };
47 
48  public: // methods
49 
50  Slider(flip::Default& d);
51 
52  Slider();
53 
54  std::string getIODescription(bool is_inlet, size_t index) const override;
55 
56  static void declare();
57 
58  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
59  };
60 }}
kiwi::model::Slider::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Slider.cpp:88
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Slider
Definition: KiwiModel_Slider.h:39
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___snapshot_tilde_8h_source.html b/docs/html/_kiwi_model___snapshot_tilde_8h_source.html new file mode 100644 index 00000000..da92752a --- /dev/null +++ b/docs/html/_kiwi_model___snapshot_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SnapshotTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_SnapshotTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // SNAPSHOT~ //
30  // ================================================================================ //
31 
32  class SnapshotTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  SnapshotTilde(flip::Default& d): model::Object(d){};
41 
42  SnapshotTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 }}
47 
kiwi::model::SnapshotTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_SnapshotTilde.cpp:58
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::SnapshotTilde
Definition: KiwiModel_SnapshotTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___switch_8h_source.html b/docs/html/_kiwi_model___switch_8h_source.html new file mode 100644 index 00000000..3b280178 --- /dev/null +++ b/docs/html/_kiwi_model___switch_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Switch.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Switch.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // SWITCH //
30  // ================================================================================ //
31 
32  class Switch : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Switch(flip::Default& d) : model::Object(d) {}
41 
42  Switch(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Switch::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Swith.cpp:90
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::model::Switch
Definition: KiwiModel_Switch.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___switch_tilde_8h_source.html b/docs/html/_kiwi_model___switch_tilde_8h_source.html new file mode 100644 index 00000000..38f980c1 --- /dev/null +++ b/docs/html/_kiwi_model___switch_tilde_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_SwitchTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // SWITCH~ //
30  // ================================================================================ //
31 
32  class SwitchTilde : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  SwitchTilde(flip::Default& d) : model::Object(d) {}
41 
42  SwitchTilde(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::SwitchTilde::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_SwitchTilde.cpp:82
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::SwitchTilde
Definition: KiwiModel_SwitchTilde.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___times_8h_source.html b/docs/html/_kiwi_model___times_8h_source.html new file mode 100644 index 00000000..28921355 --- /dev/null +++ b/docs/html/_kiwi_model___times_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Times.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Times.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h>
25 #include <KiwiModel/KiwiModel_Object.h>
26 
27 namespace kiwi { namespace model {
28 
29  // ================================================================================ //
30  // OBJECT TIMES //
31  // ================================================================================ //
32 
33  class Times : public Operator
34  {
35  public:
36 
37  Times(flip::Default& d) : Operator(d) {}
38 
39  Times(std::vector<tool::Atom> const& args);
40 
41  static void declare();
42 
43  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
44  };
45 
46 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Operator
Definition: KiwiModel_Operator.h:32
+
kiwi::model::Times
Definition: KiwiModel_Times.h:33
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___times_tilde_8h_source.html b/docs/html/_kiwi_model___times_tilde_8h_source.html new file mode 100644 index 00000000..a2ea9472 --- /dev/null +++ b/docs/html/_kiwi_model___times_tilde_8h_source.html @@ -0,0 +1,104 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_TimesTilde.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_TimesTilde.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT *~ //
30  // ================================================================================ //
31 
32  class TimesTilde : public OperatorTilde
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  TimesTilde(flip::Default& d): OperatorTilde(d){};
41 
42  TimesTilde(std::vector<tool::Atom> const& args);
43  };
44 
45 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::OperatorTilde
Definition: KiwiModel_OperatorTilde.h:32
+
kiwi::model::TimesTilde
Definition: KiwiModel_TimesTilde.h:32
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___toggle_8h_source.html b/docs/html/_kiwi_model___toggle_8h_source.html new file mode 100644 index 00000000..fe97d983 --- /dev/null +++ b/docs/html/_kiwi_model___toggle_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Toggle.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Toggle.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // OBJECT TOGGLE //
30  // ================================================================================ //
31 
32 
33  class Toggle : public model::Object
34  {
35  public: // enum
36 
37  enum Signal : SignalKey
38  {
39  OutputValue
40  };
41 
42  public: // methods
43 
44  static void declare();
45 
46  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
47 
48  Toggle(flip::Default& d);
49 
50  Toggle(std::vector<tool::Atom> const& args);
51 
52  std::string getIODescription(bool is_inlet, size_t index) const override;
53  };
54 
55 }}
kiwi::model::Toggle
Definition: KiwiModel_Toggle.h:33
+
kiwi::model::Toggle::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Toggle.cpp:78
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___trigger_8h_source.html b/docs/html/_kiwi_model___trigger_8h_source.html new file mode 100644 index 00000000..8c71d036 --- /dev/null +++ b/docs/html/_kiwi_model___trigger_8h_source.html @@ -0,0 +1,106 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Trigger.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Trigger.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // TRIGGER //
30  // ================================================================================ //
31 
32  class Trigger : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Trigger(flip::Default& d) : model::Object(d) {}
41 
42  Trigger(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45 
46  private: // methods
47 
48  static std::string getTypeDescription(tool::Atom const& atom);
49  };
50 
51 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Trigger
Definition: KiwiModel_Trigger.h:32
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
kiwi::tool::Atom
The Atom can dynamically hold different types of value.
Definition: KiwiTool_Atom.h:39
+
kiwi::model::Trigger::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Trigger.cpp:83
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_model___unpack_8h_source.html b/docs/html/_kiwi_model___unpack_8h_source.html new file mode 100644 index 00000000..7483bc6d --- /dev/null +++ b/docs/html/_kiwi_model___unpack_8h_source.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Unpack.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiModel_Unpack.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiModel/KiwiModel_Object.h>
25 
26 namespace kiwi { namespace model {
27 
28  // ================================================================================ //
29  // UNPACK //
30  // ================================================================================ //
31 
32  class Unpack : public model::Object
33  {
34  public:
35 
36  static void declare();
37 
38  static std::unique_ptr<Object> create(std::vector<tool::Atom> const& args);
39 
40  Unpack(flip::Default& d) : model::Object(d) {}
41 
42  Unpack(std::vector<tool::Atom> const& args);
43 
44  std::string getIODescription(bool is_inlet, size_t index) const override;
45  };
46 
47 }}
kiwi::model::Unpack
Definition: KiwiModel_Unpack.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::model::Unpack::getIODescription
std::string getIODescription(bool is_inlet, size_t index) const override
Returns inlet or outlet description.
Definition: KiwiModel_Unpack.cpp:57
+
kiwi::model::Object
The Object is a base class for kiwi objects.
Definition: KiwiModel_Object.h:160
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_network___http_8h_source.html b/docs/html/_kiwi_network___http_8h_source.html new file mode 100644 index 00000000..0c13cafd --- /dev/null +++ b/docs/html/_kiwi_network___http_8h_source.html @@ -0,0 +1,101 @@ + + + + + + +Kiwi: Modules/KiwiNetwork/KiwiNetwork_Http.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiNetwork_Http.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include "KiwiHttp/KiwiHttp.h"
25 #include "KiwiHttp/KiwiHttp_Session.h"
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_server___server_8h_source.html b/docs/html/_kiwi_server___server_8h_source.html new file mode 100644 index 00000000..f0890b73 --- /dev/null +++ b/docs/html/_kiwi_server___server_8h_source.html @@ -0,0 +1,113 @@ + + + + + + +Kiwi: Modules/KiwiServer/KiwiServer_Server.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiServer_Server.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <flip/detail/PortFactoryListener.h>
25 #include <flip/detail/PortListener.h>
26 #include <flip/contrib/transport_tcp/PortTransportServerTcp.h>
27 #include <flip/DocumentServer.h>
28 
29 #include <KiwiModel/KiwiModel_PatcherUser.h>
30 #include <KiwiModel/KiwiModel_PatcherValidator.h>
31 
32 #include <juce_core/juce_core.h>
33 
34 #include <atomic>
35 #include <set>
36 
37 
38 namespace kiwi
39 {
40  namespace server
41  {
42  // ================================================================================ //
43  // SERVER //
44  // ================================================================================ //
45 
47  std::string hexadecimal_convert(uint64_t hexa_decimal);
48 
50  class Server : public flip::PortFactoryListener, public flip::PortListener
51  {
52  public: // classes
53 
54  class Session;
55 
56  class Logger final
57  {
58  public: // methods
59 
61  Logger(juce::File const& file, juce::String const& welcome_message);
62 
64  ~Logger();
65 
67  void log(juce::String const& message);
68 
69  private: // members
70 
71  uint64_t m_limit;
72  juce::FileLogger m_jlogger;
73  };
74 
75  public: // methods
76 
79  Server(uint16_t port,
80  std::string const& backend_directory,
81  std::string const& open_token,
82  std::string const& kiwi_version);
83 
86  ~Server();
87 
89  void process();
90 
92  std::set<uint64_t> getSessions() const;
93 
95  std::set<uint64_t> getConnectedUsers(uint64_t session_id) const;
96 
97  private: // methods
98 
100  void onConnected(flip::PortBase & port);
101 
103  void onDisconnected(flip::PortBase & port);
104 
106  juce::File getSessionFile(uint64_t session_id) const;
107 
111  bool createEmptyDocument();
112 
113  private: // methods
114 
115  // PortFactoryListener
116  void port_factory_add(flip::PortBase & port) override final;
117 
118  void port_factory_remove(flip::PortBase & port) override final;
119 
120  // PortListener
121  void port_greet(flip::PortBase& port) override final;
122 
123  void port_commit(flip::PortBase& port, flip::Transaction const & tx) override final;
124 
125  void port_squash(flip::PortBase& port,
126  flip::TxIdRange const& range,
127  flip::Transaction const& tx) override final;
128 
129  void port_push(flip::PortBase& port, flip::Transaction const& tx) override final;
130 
131  void port_signal(flip::PortBase& port, const flip::SignalData & data) override final;
132 
133  private: // variables
134 
135  juce::File m_backend_directory;
136  std::string m_open_token;
137  std::string m_kiwi_version;
138  std::map <uint64_t, Session> m_sessions;
139  flip::PortTransportServerTcp m_socket;
140  std::set <flip::PortBase *> m_ports;
141  Logger m_logger;
142 
143  static const char* kiwi_file_extension;
144 
145  private: // deleted methods
146 
147  Server() = delete;
148  Server(Server const& other) = delete;
149  Server(Server &&other) = delete;
150  Server &operator=(Server const& other) = delete;
151  Server &operator=(Server &&other) = delete;
152  };
153 
154  // ================================================================================ //
155  // SERVER SESSION //
156  // ================================================================================ //
157 
158  class Server::Session final
159  {
160  public: // methods
161 
164  Session(Session && rhs);
165 
169  Session(uint64_t identifier,
170  juce::File const& backend_file,
171  std::string const& token,
172  std::string const& kiwi_version,
173  Server::Logger & logger);
174 
177  ~Session();
178 
180  uint64_t getId() const;
181 
184  bool save() const;
185 
187  bool load();
188 
190  void bind(flip::PortBase & port);
191 
194  void unbind(flip::PortBase & port);
195 
197  std::set<uint64_t> getConnectedUsers() const;
198 
199  private: // methods
200 
202  bool authenticateUser(uint64_t user_id, std::string metadata) const;
203 
205  void sendConnectedUsers() const;
206 
207  private: // members
208 
209  const uint64_t m_identifier;
210  std::unique_ptr<model::PatcherValidator> m_validator;
211  std::unique_ptr<flip::DocumentServer> m_document;
212  std::vector<flip::SignalConnection> m_signal_connections;
213  juce::File m_backend_file;
214  std::string m_token;
215  std::string m_kiwi_version;
216  Logger & m_logger;
217 
218  private: // deleted methods
219 
220  Session() = delete;
221  Session(const Session & rhs) = delete;
222  Session& operator = (const Session & rhs) = delete;
223  Session& operator = (Session && rhs) = delete;
224  };
225  }
226 }
kiwi::server::Server::Logger::Logger
Logger(juce::File const &file, juce::String const &welcome_message)
Constructor.
Definition: KiwiServer_Server.cpp:246
+
kiwi::server::Server
The Server class.
Definition: KiwiServer_Server.h:50
+
kiwi::server::Server::Session
Definition: KiwiServer_Server.h:158
+
kiwi::server::Server::Logger::log
void log(juce::String const &message)
Logs a message.
Definition: KiwiServer_Server.cpp:256
+
kiwi::server::Server::~Server
~Server()
Destructor.
Definition: KiwiServer_Server.cpp:88
+
kiwi::save
Save the current patcher document.
Definition: KiwiApp_CommandIDs.h:36
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::server::Server::getSessions
std::set< uint64_t > getSessions() const
Returns a list of sessions currenty opened.
Definition: KiwiServer_Server.cpp:98
+
kiwi::server::Server::Logger::~Logger
~Logger()
Destructor.
Definition: KiwiServer_Server.cpp:252
+
kiwi::server::Server::Logger
Definition: KiwiServer_Server.h:56
+
kiwi::server::Server::process
void process()
Process the socket hence process all sessions.
Definition: KiwiServer_Server.cpp:93
+
kiwi::server::Server::getConnectedUsers
std::set< uint64_t > getConnectedUsers(uint64_t session_id) const
Returns a list of users connected to session.
Definition: KiwiServer_Server.cpp:110
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___atom_8h_source.html b/docs/html/_kiwi_tool___atom_8h_source.html new file mode 100644 index 00000000..c4e1fbbf --- /dev/null +++ b/docs/html/_kiwi_tool___atom_8h_source.html @@ -0,0 +1,125 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_Atom.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_Atom.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <cassert>
25 #include <iostream>
26 #include <sstream>
27 #include <cstring>
28 #include <memory>
29 #include <vector>
30 
31 namespace kiwi { namespace tool {
32 
33  // ================================================================================ //
34  // ATOM //
35  // ================================================================================ //
36 
39  class Atom
40  {
41  public: // methods
42 
43  // ================================================================================ //
44  // Types //
45  // ================================================================================ //
46 
48  using int_t = int64_t;
49 
51  using float_t = double;
52 
54  using string_t = std::string;
55 
58  enum class Type : uint8_t
59  {
60  // basic types:
61  Null = 0,
62  Int,
63  Float,
64  String,
65 
66  // special types:
67  Comma,
68  Dollar,
69  };
70 
71  // ================================================================================ //
72  // CONSTRUCTORS //
73  // ================================================================================ //
74 
77  Atom() noexcept;
78 
82  Atom(const bool value) noexcept;
83 
86  Atom(const int value) noexcept;
87 
90  Atom(const long value) noexcept;
91 
94  Atom(const long long value) noexcept;
95 
99  Atom(const float value) noexcept;
100 
104  Atom(const double value) noexcept;
105 
108  Atom(string_t const& sym);
109 
112  Atom(string_t&& sym);
113 
116  Atom(char const* sym);
117 
119  static Atom Comma();
120 
124  static Atom Dollar(int_t index);
125 
129  Atom(Atom const& other);
130 
135  Atom(Atom&& other);
136 
138  ~Atom();
139 
143  Atom& operator=(Atom const& other);
144 
148  Atom& operator=(Atom&& other) noexcept;
149 
150  // ================================================================================ //
151  // Type Getters //
152  // ================================================================================ //
153 
157  Type getType() const noexcept;
158 
162  bool isNull() const noexcept;
163 
167  bool isInt() const noexcept;
168 
172  bool isFloat() const noexcept;
173 
177  bool isNumber() const noexcept;
178 
182  bool isString() const noexcept;
183 
187  bool isBang() const;
188 
192  bool isComma() const noexcept;
193 
197  bool isDollar() const noexcept;
198 
199  // ================================================================================ //
200  // Value Getters //
201  // ================================================================================ //
202 
206  int_t getInt() const noexcept;
207 
211  float_t getFloat() const noexcept;
212 
216  string_t const& getString() const;
217 
221  int_t getDollarIndex() const;
222 
223  private: // methods
224 
225  // ================================================================================ //
226  // VALUE //
227  // ================================================================================ //
228 
230  static string_t* create_string_pointer(string_t const& v);
231 
232  static string_t* create_string_pointer(string_t&& v);
233 
235  union atom_value
236  {
238  int_t int_v;
239 
241  float_t float_v;
242 
244  string_t* string_v;
245 
247  atom_value() = default;
248 
250  atom_value(const int_t v) noexcept : int_v(v) {}
251 
253  atom_value(const float_t v) noexcept : float_v(v) {}
254 
256  atom_value(string_t const& v) : string_v(create_string_pointer(v)) {}
257 
259  atom_value(string_t&& v) : string_v(create_string_pointer(std::move(v))) {}
260  };
261 
262  private: // methods
263 
265  Type m_type = Type::Null;
266 
268  atom_value m_value = {};
269  };
270 
271  // ================================================================================ //
272  // ATOM HELPER //
273  // ================================================================================ //
274 
276  struct AtomHelper
277  {
278  struct ParsingFlags { enum Flags {
279  Comma = 0x01,
280  Dollar = 0x02,
281  }; };
282 
295  static std::vector<Atom> parse(std::string const& text, int flags = 0);
296 
298  static std::string toString(Atom const& atom, const bool add_quotes = true);
299 
304  static std::string toString(std::vector<Atom> const& atoms, const bool add_quotes = true);
305 
306  static std::string trimDecimal(std::string const& text);
307  };
308 
309 }}
kiwi::tool::Atom::getFloat
float_t getFloat() const noexcept
Retrieves the Atom value as a float_t value.
Definition: KiwiTool_Atom.cpp:270
+
kiwi::tool::Atom::string_t
std::string string_t
The type of a string type in the Atom class.
Definition: KiwiTool_Atom.h:54
+
kiwi::tool::Atom::Type
Type
Enum of Atom value types.
Definition: KiwiTool_Atom.h:58
+
kiwi::tool::Atom::isString
bool isString() const noexcept
Returns true if the Atom is a string_t.
Definition: KiwiTool_Atom.cpp:231
+
kiwi::tool::AtomHelper
An Atom helper class.
Definition: KiwiTool_Atom.h:276
+
kiwi::tool::AtomHelper::ParsingFlags
Definition: KiwiTool_Atom.h:278
+
kiwi::tool::Atom::isComma
bool isComma() const noexcept
Returns true if the Atom is an comma_t.
Definition: KiwiTool_Atom.cpp:242
+
kiwi::tool::Atom::getString
string_t const & getString() const
Retrieves the Atom value as a string_t value.
Definition: KiwiTool_Atom.cpp:284
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Atom::isFloat
bool isFloat() const noexcept
Returns true if the Atom is a float_t.
Definition: KiwiTool_Atom.cpp:221
+
kiwi::tool::Atom::isInt
bool isInt() const noexcept
Returns true if the Atom is an int_t.
Definition: KiwiTool_Atom.cpp:216
+
kiwi::tool::Atom::float_t
double float_t
The type of a floating-point number in the Atom class.
Definition: KiwiTool_Atom.h:51
+
kiwi::tool::Atom::~Atom
~Atom()
Destructor.
Definition: KiwiTool_Atom.cpp:156
+
kiwi::tool::Atom::isNumber
bool isNumber() const noexcept
Returns true if the Atom is a bool, an int_t, or a float_t.
Definition: KiwiTool_Atom.cpp:226
+
kiwi::tool::Atom::getInt
int_t getInt() const noexcept
Retrieves the Atom value as an int_t value.
Definition: KiwiTool_Atom.cpp:256
+
kiwi::tool::Atom
The Atom can dynamically hold different types of value.
Definition: KiwiTool_Atom.h:39
+
kiwi::tool::Atom::isDollar
bool isDollar() const noexcept
Returns true if the Atom is a dollar or a dollar typed.
Definition: KiwiTool_Atom.cpp:247
+
kiwi::tool::Atom::getType
Type getType() const noexcept
Get the type of the Atom.
Definition: KiwiTool_Atom.cpp:206
+
kiwi::tool::Atom::isBang
bool isBang() const
Returns true if the Atom is a string_t that contains the special "bang" keyword.
Definition: KiwiTool_Atom.cpp:236
+
kiwi::tool::Atom::Atom
Atom() noexcept
Default constructor.
Definition: KiwiTool_Atom.cpp:30
+
kiwi::tool::Atom::getDollarIndex
int_t getDollarIndex() const
Retrieves the Dollar index value if the Atom is a dollar type.
Definition: KiwiTool_Atom.cpp:298
+
kiwi::tool::Atom::operator=
Atom & operator=(Atom const &other)
Copy assigment operator.
Definition: KiwiTool_Atom.cpp:166
+
kiwi::tool::Atom::isNull
bool isNull() const noexcept
Returns true if the Atom is Null.
Definition: KiwiTool_Atom.cpp:211
+
kiwi::tool::Atom::int_t
int64_t int_t
The type of a signed integer number in the Atom class.
Definition: KiwiTool_Atom.h:48
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___beacon_8h_source.html b/docs/html/_kiwi_tool___beacon_8h_source.html new file mode 100644 index 00000000..168b3ace --- /dev/null +++ b/docs/html/_kiwi_tool___beacon_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_Beacon.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_Beacon.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <string>
25 #include <map>
26 #include <set>
27 
28 #include <KiwiTool/KiwiTool_Atom.h>
29 
30 namespace kiwi { namespace tool {
31 
32  // ================================================================================ //
33  // BEACON //
34  // ================================================================================ //
35 
45  class Beacon
46  {
47  public: // methods
48 
49  class Castaway;
50 
52  inline std::string getName() const {return m_name;}
53 
55  ~Beacon() = default;
56 
58  void bind(Castaway& castaway);
59 
61  void unbind(Castaway& castaway);
62 
64  void dispatch(std::vector<Atom> const& args);
65 
66  public: // nested classes
67 
68  // ================================================================================ //
69  // BEACON CASTAWAY //
70  // ================================================================================ //
71 
73  class Castaway
74  {
75  public:
76  virtual ~Castaway() {}
77  virtual void receive(std::vector<Atom> const& args) = 0;
78  };
79 
80  // ================================================================================ //
81  // BEACON FACTORY //
82  // ================================================================================ //
83 
85  class Factory
86  {
87  public:
88  Factory() = default;
89  ~Factory() = default;
90  Beacon& getBeacon(std::string const& name);
91 
92  private:
93  std::map<std::string, std::unique_ptr<Beacon>> m_beacons;
94  };
95 
96  private: // methods
97 
99  Beacon(std::string const& name);
100  friend class Beacon::Factory;
101 
102  private: // members
103 
104  const std::string m_name;
105  std::set<Castaway*> m_castaways;
106 
107  private: // deleted methods
108 
109  Beacon(Beacon const&) = delete;
110  Beacon(Beacon&&) = delete;
111  Beacon& operator=(Beacon const&) = delete;
112  Beacon& operator=(Beacon&&) = delete;
113  };
114 
115 }}
kiwi::tool::Beacon::dispatch
void dispatch(std::vector< Atom > const &args)
Dispatch message to beacon castaways.
Definition: KiwiTool_Beacon.cpp:45
+
kiwi::tool::Beacon::bind
void bind(Castaway &castaway)
Adds a castaway in the binding list of the beacon.
Definition: KiwiTool_Beacon.cpp:35
+
kiwi::tool::Beacon::getName
std::string getName() const
Gets the name of the beacon.
Definition: KiwiTool_Beacon.h:52
+
kiwi::tool::Beacon::Castaway
The beacon castaway can be binded to a beacon.
Definition: KiwiTool_Beacon.h:73
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Beacon
The beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used...
Definition: KiwiTool_Beacon.h:45
+
kiwi::tool::Beacon::Factory
The beacon factory is used to create beacons.
Definition: KiwiTool_Beacon.h:85
+
kiwi::tool::Beacon::~Beacon
~Beacon()=default
Destructor.
+
kiwi::tool::Beacon::unbind
void unbind(Castaway &castaway)
Removes a castaways from the binding list of the beacon.
Definition: KiwiTool_Beacon.cpp:40
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___circular_buffer_8h_source.html b/docs/html/_kiwi_tool___circular_buffer_8h_source.html new file mode 100644 index 00000000..c2f57e49 --- /dev/null +++ b/docs/html/_kiwi_tool___circular_buffer_8h_source.html @@ -0,0 +1,103 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_CircularBuffer.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_CircularBuffer.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <algorithm>
25 #include <cstdlib>
26 #include <cassert>
27 
28 namespace kiwi { namespace tool {
29 
30  // ================================================================================ //
31  // CIRCULAR BUFFER //
32  // ================================================================================ //
33 
36  template<class T>
37  class CircularBuffer final
38  {
39  public: // methods
40 
41  CircularBuffer(size_t capacity):
42  m_buffer((T*) std::malloc(capacity * sizeof(T))),
43  m_head(0),
44  m_tail(0),
45  m_size(0),
46  m_capacity(capacity)
47  {
48  }
49 
50  CircularBuffer(size_t capacity, size_t size, T const& value):
51  m_buffer((T*) std::malloc(capacity * sizeof(T))),
52  m_head(0),
53  m_tail(0),
54  m_size(0),
55  m_capacity(capacity)
56  {
57  assert(m_capacity >= m_size);
58 
59  for (int i = 0; i < size; ++i)
60  {
61  push_back(value);
62  }
63  }
64 
65  ~CircularBuffer()
66  {
67  for (int i = std::min(m_head, m_tail); i < std::max(m_head, m_tail); ++i)
68  {
69  (m_buffer + i)->~T();
70  }
71 
72  std::free(m_buffer);
73  }
74 
75  void assign(size_t nb_elements, const T& value)
76  {
77  clear();
78 
79  for(int i = 0; i < nb_elements; ++i)
80  {
81  push_back(value);
82  }
83  }
84 
85  void clear()
86  {
87  size_t init_size = m_size;
88 
89  for (int i = 0; i < init_size; ++i)
90  {
91  pop_front();
92  }
93  }
94 
95  size_t size() const
96  {
97  return m_size;
98  }
99 
100  T const& operator[](size_t index) const noexcept
101  {
102  return *(m_buffer + ((m_head + index) % m_size));
103  }
104 
105  T& operator[](size_t index) noexcept
106  {
107  return *(m_buffer + ((m_head + index) % m_size));
108  }
109 
110  void push_back(T const& value)
111  {
112  if (m_size == m_capacity)
113  {
114  (m_buffer + m_tail)->~T();
115  increment_head();
116  }
117 
118  new (m_buffer + m_tail) T(value);
119 
120  increment_tail();
121  }
122 
123  void pop_front()
124  {
125  if (m_size != 0)
126  {
127  (m_buffer + m_head)->~T();
128  increment_head();
129  }
130  }
131 
132  private: // methods
133 
134  void increment_head()
135  {
136  m_head = (m_head + 1) == m_capacity ? 0 : m_head + 1;
137  --m_size;
138  }
139 
140  void increment_tail()
141  {
142  m_tail = (m_tail + 1) == m_capacity ? 0 : m_tail + 1;
143  ++m_size;
144  }
145 
146  private: // members
147 
148  T* m_buffer;
149  size_t m_head;
150  size_t m_tail;
151  size_t m_size;
152  size_t m_capacity;
153 
154  private: // deleted methods
155 
156  CircularBuffer() = delete;
157  CircularBuffer(CircularBuffer const& other) = delete;
158  CircularBuffer(CircularBuffer && other) = delete;
159  CircularBuffer& operator=(CircularBuffer const& other) = delete;
160  CircularBuffer& operator=(CircularBuffer && other) = delete;
161 
162  };
163 
164 }}
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::CircularBuffer
Definition: KiwiTool_CircularBuffer.h:37
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___concurrent_queue_8h_source.html b/docs/html/_kiwi_tool___concurrent_queue_8h_source.html new file mode 100644 index 00000000..79493d46 --- /dev/null +++ b/docs/html/_kiwi_tool___concurrent_queue_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_ConcurrentQueue.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_ConcurrentQueue.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <cstddef>
25 #include <atomic>
26 
27 #include <concurrentqueue.h>
28 
29 namespace kiwi { namespace tool {
30 
31  // ==================================================================================== //
32  // CONCURRENTQUEUE //
33  // ==================================================================================== //
34 
35  namespace mc = moodycamel;
36 
40  template <class T>
41  class ConcurrentQueue final
42  {
43  public: // methods
44 
47  ConcurrentQueue(size_t capacity):
48  m_queue(capacity),
49  m_size(0)
50  {
51  }
52 
54  ~ConcurrentQueue() = default;
55 
59  void push(T const& value)
60  {
61  if(m_queue.enqueue(value))
62  {
63  m_size++;
64  }
65  }
66 
70  void push(T&& value)
71  {
72  if(m_queue.enqueue(std::forward<T>(value)))
73  {
74  m_size++;
75  }
76  }
77 
80  bool pop(T & value)
81  {
82  if(m_queue.try_dequeue(value))
83  {
84  m_size--;
85  return true;
86  }
87 
88  return false;
89  }
90 
96  size_t load_size() const
97  {
98  return m_size.load();
99  }
100 
101  private: // classes
102 
103  struct Trait : public moodycamel::ConcurrentQueueDefaultTraits
104  {
105  static const size_t BLOCK_SIZE = 1024;
106  };
107 
108  private: // members
109 
110  mc::ConcurrentQueue<T, Trait> m_queue;
111  std::atomic<int> m_size;
112 
113  private: // deleted methods
114 
115  ConcurrentQueue() = delete;
116  ConcurrentQueue(ConcurrentQueue const& other) = delete;
117  ConcurrentQueue(ConcurrentQueue && other) = delete;
118  ConcurrentQueue& operator=(ConcurrentQueue const& other) = delete;
119  ConcurrentQueue& operator=(ConcurrentQueue && other) = delete;
120 
121  };
122 
123 }}
kiwi::tool::ConcurrentQueue::push
void push(T const &value)
Pushes element at end of queue (by copy).
Definition: KiwiTool_ConcurrentQueue.h:59
+
kiwi::tool::ConcurrentQueue::ConcurrentQueue
ConcurrentQueue(size_t capacity)
Constructor.
Definition: KiwiTool_ConcurrentQueue.h:47
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::ConcurrentQueue::~ConcurrentQueue
~ConcurrentQueue()=default
Destructor.
+
kiwi::tool::ConcurrentQueue::push
void push(T &&value)
Pushes element at end of queue (by move).
Definition: KiwiTool_ConcurrentQueue.h:70
+
kiwi::tool::ConcurrentQueue::load_size
size_t load_size() const
Returns an approximative size for the queue.
Definition: KiwiTool_ConcurrentQueue.h:96
+
kiwi::tool::ConcurrentQueue::pop
bool pop(T &value)
Pops first element in the queue.
Definition: KiwiTool_ConcurrentQueue.h:80
+
kiwi::tool::ConcurrentQueue
A mono producer, mono consumer FIFO lock free queue.
Definition: KiwiTool_ConcurrentQueue.h:41
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___listeners_8h_source.html b/docs/html/_kiwi_tool___listeners_8h_source.html new file mode 100644 index 00000000..1f30947e --- /dev/null +++ b/docs/html/_kiwi_tool___listeners_8h_source.html @@ -0,0 +1,114 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_Listeners.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_Listeners.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <memory>
25 #include <set>
26 #include <vector>
27 #include <mutex>
28 
29 namespace kiwi { namespace tool {
30 
31  // ================================================================================ //
32  // LISTENERS //
33  // ================================================================================ //
34 
37  template <class ListenerClass>
38  class Listeners
39  {
40  public:
41 
42  struct is_valid_listener : std::integral_constant<bool,
43  !std::is_pointer<ListenerClass>::value &&
44  !std::is_reference<ListenerClass>::value
45  > {};
46 
47  using listener_t = typename std::remove_pointer<typename std::remove_reference<ListenerClass>::type>::type;
48  using listener_ref_t = listener_t&;
49  using listener_ptr_t = listener_t*;
50 
52  Listeners()
53  {
54  static_assert(is_valid_listener::value,
55  "Template parameter must not be a pointer or a reference");
56  }
57 
59  ~Listeners() noexcept { m_listeners.clear(); }
60 
65  bool add(listener_ref_t listener) noexcept
66  {
67  std::lock_guard<std::mutex> guard(m_mutex);
68  bool insert_success = m_listeners.insert(&listener).second;
69  return insert_success;
70  }
71 
76  bool remove(listener_ref_t listener) noexcept
77  {
78  std::lock_guard<std::mutex> guard(m_mutex);
79  bool erase_success = m_listeners.erase(&listener);
80  return erase_success;
81  }
82 
84  size_t size() const noexcept
85  {
86  std::lock_guard<std::mutex> guard(m_mutex);
87  return m_listeners.size();
88  }
89 
91  bool empty() const noexcept
92  {
93  std::lock_guard<std::mutex> guard(m_mutex);
94  return m_listeners.empty();
95  }
96 
98  void clear() noexcept
99  {
100  std::lock_guard<std::mutex> guard(m_mutex);
101  m_listeners.clear();
102  }
103 
105  bool contains(listener_ref_t listener) const noexcept
106  {
107  return (m_listeners.find(&listener) != m_listeners.end());
108  }
109 
111  std::vector<listener_ptr_t> getListeners()
112  {
113  std::lock_guard<std::mutex> guard(m_mutex);
114  return {m_listeners.begin(), m_listeners.end()};
115  }
116 
118  std::vector<listener_ptr_t> getListeners() const
119  {
120  std::lock_guard<std::mutex> guard(m_mutex);
121  return {m_listeners.begin(), m_listeners.end()};
122  }
123 
127  template<class T, class ...Args>
128  void call(T fun, Args&& ...arguments) const
129  {
130  for(auto* listener : getListeners())
131  {
132  (listener->*(fun))(arguments...);
133  }
134  }
135 
136  private:
137 
138  std::set<listener_ptr_t> m_listeners;
139  mutable std::mutex m_mutex;
140  };
141 
142 }}
kiwi::tool::Listeners::size
size_t size() const noexcept
Returns the number of listeners.
Definition: KiwiTool_Listeners.h:84
+
kiwi::tool::Listeners::call
void call(T fun, Args &&...arguments) const
Calls a given method for each listener of the set.
Definition: KiwiTool_Listeners.h:128
+
kiwi::tool::Listeners::Listeners
Listeners()
Creates an empty listener set.
Definition: KiwiTool_Listeners.h:52
+
kiwi::tool::Listeners::getListeners
std::vector< listener_ptr_t > getListeners() const
Retrieve the listeners.
Definition: KiwiTool_Listeners.h:118
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Listeners
The listener set is a class that manages a list of listeners.
Definition: KiwiTool_Listeners.h:38
+
kiwi::tool::Listeners::getListeners
std::vector< listener_ptr_t > getListeners()
Get the listeners.
Definition: KiwiTool_Listeners.h:111
+
kiwi::tool::Listeners::clear
void clear() noexcept
Remove all listeners.
Definition: KiwiTool_Listeners.h:98
+
kiwi::tool::Listeners::empty
bool empty() const noexcept
Returns true if there is no listener.
Definition: KiwiTool_Listeners.h:91
+
kiwi::tool::Listeners::is_valid_listener
Definition: KiwiTool_Listeners.h:42
+
kiwi::tool::Listeners::contains
bool contains(listener_ref_t listener) const noexcept
Returns true if the set contains a given listener.
Definition: KiwiTool_Listeners.h:105
+
kiwi::tool::Listeners::add
bool add(listener_ref_t listener) noexcept
Add a listener.
Definition: KiwiTool_Listeners.h:65
+
kiwi::tool::Listeners::~Listeners
~Listeners() noexcept
Destructor.
Definition: KiwiTool_Listeners.h:59
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___matrix_8h_source.html b/docs/html/_kiwi_tool___matrix_8h_source.html new file mode 100644 index 00000000..910e7718 --- /dev/null +++ b/docs/html/_kiwi_tool___matrix_8h_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_Matrix.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_Matrix.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <cstddef>
25 
26 namespace kiwi { namespace tool {
27 
28  // ================================================================================ //
29  // MATRIX //
30  // ================================================================================ //
31 
35  template<class Type>
36  class Matrix final
37  {
38  public: // methods
39 
42  Matrix(size_t num_rows, size_t num_cols);
43 
45  ~Matrix();
46 
48  Matrix(Matrix const& other);
49 
51  Matrix(Matrix && other);
52 
55  Matrix& operator=(Matrix const& other);
56 
59  Matrix& operator=(Matrix && other);
60 
62  size_t getNumRows() const;
63 
65  size_t getNumCols() const;
66 
69  Type & at(size_t row, size_t colunm);
70 
73  Type const& at(size_t row, size_t column) const;
74 
75  private: // members
76 
77  size_t m_num_rows;
78  size_t m_num_cols;
79  Type* m_data;
80 
81  private: // deleted methods
82 
83  Matrix() = delete;
84  };
85 }}
86 
87 #include <KiwiTool/KiwiTool_Matrix.hpp>
kiwi::tool::Matrix
A matrix data structure.
Definition: KiwiTool_Matrix.h:36
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Matrix::~Matrix
~Matrix()
Destructor.
Definition: KiwiTool_Matrix.hpp:51
+
kiwi::tool::Matrix::operator=
Matrix & operator=(Matrix const &other)
Assignment operator.
Definition: KiwiTool_Matrix.hpp:79
+
kiwi::tool::Matrix::at
Type & at(size_t row, size_t colunm)
Gets a value stored in matrix.
Definition: KiwiTool_Matrix.hpp:117
+
kiwi::tool::Matrix::getNumRows
size_t getNumRows() const
Returns the number of rows.
Definition: KiwiTool_Matrix.hpp:105
+
kiwi::tool::Matrix::getNumCols
size_t getNumCols() const
Returns the number of colunms.
Definition: KiwiTool_Matrix.hpp:111
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___matrix_8hpp_source.html b/docs/html/_kiwi_tool___matrix_8hpp_source.html new file mode 100644 index 00000000..ca7c9163 --- /dev/null +++ b/docs/html/_kiwi_tool___matrix_8hpp_source.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_Matrix.hpp Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_Matrix.hpp
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #include <cstring>
23 #include <cassert>
24 
25 #include <KiwiTool/KiwiTool_Matrix.h>
26 
27 namespace kiwi { namespace tool {
28 
29  // ================================================================================ //
30  // MATRIX //
31  // ================================================================================ //
32 
33  template<class Type>
34  void copy(Type * const dest, Type const * const src, size_t size)
35  {
36  for (size_t index = 0; index < size; ++index)
37  {
38  dest[index] = src[index];
39  }
40  }
41 
42  template<class Type>
43  Matrix<Type>::Matrix(size_t num_rows, size_t num_cols):
44  m_num_rows(num_rows),
45  m_num_cols(num_cols),
46  m_data(new Type[m_num_rows * m_num_cols]())
47  {
48  }
49 
50  template<class Type>
51  Matrix<Type>::~Matrix()
52  {
53  delete[] m_data;
54  }
55 
56  template<class Type>
57  Matrix<Type>::Matrix(Matrix const& other):
58  m_num_rows(other.m_num_rows),
59  m_num_cols(other.m_num_cols),
60  m_data(new Type[m_num_rows * m_num_cols]())
61  {
62  copy(m_data, other.m_data, m_num_rows * m_num_cols);
63  }
64 
65  template<class Type>
66  Matrix<Type>::Matrix(Matrix && other):
67  m_num_rows(other.m_num_rows),
68  m_num_cols(other.m_num_cols),
69  m_data(new Type[m_num_rows * m_num_cols]())
70  {
71  copy(m_data, other.m_data, m_num_rows * m_num_cols);
72 
73  other.m_num_cols = 0;
74  other.m_num_rows = 0;
75  other.m_data = nullptr;
76  }
77 
78  template<class Type>
79  Matrix<Type> & Matrix<Type>::operator=(Matrix const& other)
80  {
81  assert((m_num_rows == other.m_num_rows && m_num_cols == other.m_num_cols)
82  && "Assigning matrixes with different size");
83 
84  copy(m_data, other.m_data, m_num_rows * m_num_cols);
85 
86  return *this;
87  }
88 
89  template<class Type>
90  Matrix<Type> & Matrix<Type>::operator=(Matrix && other)
91  {
92  assert((m_num_rows == other.m_num_rows && m_num_cols == other.m_num_cols)
93  && "Assigning matrixes with different size");
94 
95  copy(m_data, other.m_data, m_num_rows * m_num_cols);
96 
97  other.m_num_cols = 0;
98  other.m_num_rows = 0;
99  other.m_data = nullptr;
100 
101  return *this;
102  }
103 
104  template<class Type>
105  size_t Matrix<Type>::getNumRows() const
106  {
107  return m_num_rows;
108  }
109 
110  template<class Type>
111  size_t Matrix<Type>::getNumCols() const
112  {
113  return m_num_cols;
114  }
115 
116  template<class Type>
117  Type & Matrix<Type>::at(size_t row, size_t column)
118  {
119  assert((row < m_num_rows && column < m_num_cols) && "Accessing matrix out of bounds");
120  return m_data[m_num_cols * row + column];
121  }
122 
123  template<class Type>
124  Type const& Matrix<Type>::at(size_t row, size_t column) const
125  {
126  assert((row < m_num_rows && column < m_num_cols) && "Accessing matrix out of bounds");
127  return m_data[m_num_cols * row + column];
128  }
129 }}
kiwi::tool::Matrix
A matrix data structure.
Definition: KiwiTool_Matrix.h:36
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Matrix::~Matrix
~Matrix()
Destructor.
Definition: KiwiTool_Matrix.hpp:51
+
kiwi::tool::Matrix::operator=
Matrix & operator=(Matrix const &other)
Assignment operator.
Definition: KiwiTool_Matrix.hpp:79
+
kiwi::tool::Matrix::at
Type & at(size_t row, size_t colunm)
Gets a value stored in matrix.
Definition: KiwiTool_Matrix.hpp:117
+
kiwi::tool::Matrix::getNumRows
size_t getNumRows() const
Returns the number of rows.
Definition: KiwiTool_Matrix.hpp:105
+
kiwi::tool::Matrix::getNumCols
size_t getNumCols() const
Returns the number of colunms.
Definition: KiwiTool_Matrix.hpp:111
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___parameter_8h_source.html b/docs/html/_kiwi_tool___parameter_8h_source.html new file mode 100644 index 00000000..045d90d9 --- /dev/null +++ b/docs/html/_kiwi_tool___parameter_8h_source.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_Parameter.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_Parameter.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <KiwiTool/KiwiTool_Atom.h>
25 
26 namespace kiwi { namespace tool {
27 
32  class Parameter
33  {
34  public: // classes
35 
37  enum class Type
38  {
39  Int,
40  Float,
41  String
42  };
43 
44  public: // methods
45 
48  Parameter(Type type);
49 
52  Parameter(Type type, std::vector<Atom> const atoms);
53 
55  Parameter(Parameter const& other);
56 
58  Parameter& operator=(Parameter const& other);
59 
61  ~Parameter();
62 
64  Type getType() const;
65 
67  Atom const& operator[](size_t index) const;
68 
69  private: // members
70 
71  Type m_type;
72  std::vector<Atom> m_atoms;
73 
74  private: // deleted methods
75 
76  Parameter() = delete;
77  };
78 
79 }}
kiwi::tool::Parameter::operator=
Parameter & operator=(Parameter const &other)
Assignment operator.
Definition: KiwiTool_Parameter.cpp:87
+
kiwi::tool::Parameter
Parameter is a class designed to represent any type of data.
Definition: KiwiTool_Parameter.h:32
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Parameter::Type
Type
The different types of data represented.
Definition: KiwiTool_Parameter.h:37
+
kiwi::tool::Parameter::~Parameter
~Parameter()
Desctructor.
Definition: KiwiTool_Parameter.cpp:83
+
kiwi::tool::Atom
The Atom can dynamically hold different types of value.
Definition: KiwiTool_Atom.h:39
+
kiwi::tool::Parameter::getType
Type getType() const
Returns the type of the parameter.
Definition: KiwiTool_Parameter.cpp:99
+
kiwi::tool::Parameter::operator[]
Atom const & operator[](size_t index) const
Returns the underlying data of the parameter.
Definition: KiwiTool_Parameter.cpp:104
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___scheduler_8h_source.html b/docs/html/_kiwi_tool___scheduler_8h_source.html new file mode 100644 index 00000000..fe2db7bb --- /dev/null +++ b/docs/html/_kiwi_tool___scheduler_8h_source.html @@ -0,0 +1,120 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_Scheduler.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_Scheduler.h
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <cstdint>
25 #include <map>
26 #include <list>
27 #include <chrono>
28 #include <stdexcept>
29 #include <mutex>
30 #include <set>
31 #include <memory>
32 #include <mutex>
33 #include <thread>
34 
35 #include <KiwiTool/KiwiTool_ConcurrentQueue.h>
36 
37 namespace kiwi { namespace tool {
38 
39  // ==================================================================================== //
40  // SCHEDULER //
41  // ==================================================================================== //
42 
47  template<class Clock = std::chrono::high_resolution_clock>
48  class Scheduler final
49  {
50  public: // classes
51 
52  using clock_t = Clock;
53 
54  using time_point_t = typename Clock::time_point;
55 
56  using duration_t = typename Clock::duration;
57 
58  class Task;
59 
60  class CallBack;
61 
62  class Timer;
63 
64  private: // classes
65 
66  class Queue;
67 
68  class Event;
69 
70  public: // methods
71 
74  Scheduler();
75 
77  ~Scheduler();
78 
82  void setThreadAsConsumer();
83 
87  bool isThisConsumerThread() const;
88 
92  void schedule(std::shared_ptr<Task> const& task, duration_t delay = std::chrono::milliseconds(0));
93 
97  void schedule(std::shared_ptr<Task> && task, duration_t delay = std::chrono::milliseconds(0));
98 
101  void schedule(std::function<void(void)> && func, duration_t delay = std::chrono::milliseconds(0));
102 
106  void defer(std::shared_ptr<Task> const& task);
107 
111  void defer(std::shared_ptr<Task> && task);
112 
116  void defer(std::function<void(void)> && func);
117 
121  void unschedule(std::shared_ptr<Task> const& task);
122 
124  void process();
125 
127  std::unique_lock<std::mutex> lock() const;
128 
129  private: // members
130 
131  Queue m_queue;
132  mutable std::mutex m_mutex;
133  std::thread::id m_consumer_id;
134 
135  private: // deleted methods
136 
137  Scheduler(Scheduler const& other) = delete;
138  Scheduler(Scheduler && other) = delete;
139  Scheduler& operator=(Scheduler const& other) = delete;
140  Scheduler& operator=(Scheduler && other) = delete;
141  };
142 
143  // ==================================================================================== //
144  // QUEUE //
145  // ==================================================================================== //
146 
150  template <class Clock>
151  class Scheduler<Clock>::Queue final
152  {
153  public: // classes
154 
155  struct Command
156  {
157  std::shared_ptr<Task> m_task;
158  time_point_t m_time;
159  };
160 
161  public: // methods
162 
164  Queue();
165 
167  ~Queue();
168 
170  void schedule(std::shared_ptr<Task> const& task, duration_t delay);
171 
173  void schedule(std::shared_ptr<Task> && task, duration_t delay);
174 
176  void unschedule(std::shared_ptr<Task> const& task);
177 
179  void process(time_point_t process_time);
180 
181  private: // methods
182 
184  void emplace(Event && event);
185 
187  void remove(Event const& event);
188 
189  private: // members
190 
191  std::vector<Event> m_events;
192  ConcurrentQueue<Command> m_commands;
193 
194  private: // friend classes
195 
196  friend class Scheduler;
197 
198  private: // deleted methods
199 
200  Queue(Queue const& other) = delete;
201  Queue(Queue && other) = delete;
202  Queue& operator=(Queue const& other) = delete;
203  Queue& operator=(Queue && other) = delete;
204  };
205 
206  // ==================================================================================== //
207  // TASK //
208  // ==================================================================================== //
209 
212  template <class Clock>
213  class Scheduler<Clock>::Task
214  {
215  public: // methods
216 
219  Task();
220 
225  virtual ~Task();
226 
227  private: // methods
228 
231  virtual void execute() = 0;
232 
233  private: // friends
234 
235  friend class Scheduler;
236 
237  private: // deleted methods
238 
239  Task(Task const& other) = delete;
240  Task(Task && other) = delete;
241  Task& operator=(Task const& other) = delete;
242  Task& operator=(Task && other) = delete;
243  };
244 
245  // ==================================================================================== //
246  // CALLBACK //
247  // ==================================================================================== //
248 
251  template<class Clock>
252  class Scheduler<Clock>::CallBack : public Scheduler<Clock>::Task
253  {
254  public: // methods
255 
257  CallBack(std::function<void(void)> func);
258 
260  ~CallBack();
261 
263  void execute() override final;
264 
265  private: // members
266 
267  std::function<void(void)> m_func;
268 
269  private: // deleted methods
270 
271  CallBack() = delete;
272  CallBack(CallBack const& other) = delete;
273  CallBack(CallBack && other) = delete;
274  CallBack& operator=(CallBack const& other) = delete;
275  CallBack& operator=(CallBack && other) = delete;
276  };
277 
278 
279  // ==================================================================================== //
280  // TIMER //
281  // ==================================================================================== //
282 
285  template<class Clock>
286  class Scheduler<Clock>::Timer
287  {
288  private: // classes
289 
290  class Task;
291 
292  public: // methods
293 
296  Timer(Scheduler & scheduler);
297 
301  ~Timer();
302 
305  void startTimer(duration_t period);
306 
310  void stopTimer();
311 
312  private: // methods
313 
315  virtual void timerCallBack() = 0;
316 
318  void callBackInternal();
319 
320  private: // members
321 
322  Scheduler & m_scheduler;
323  std::shared_ptr<Task> m_task;
324  duration_t m_period;
325 
326  private: // deleted methods
327 
328  Timer() = delete;
329  Timer(Timer const& other) = delete;
330  Timer(Timer && other) = delete;
331  Timer& operator=(Timer const& other) = delete;
332  Timer& operator=(Timer && other) = delete;
333  };
334 
335  // ==================================================================================== //
336  // EVENT //
337  // ==================================================================================== //
338 
340  template<class Clock>
341  class Scheduler<Clock>::Event final
342  {
343  public: // methods
344 
346  Event(std::shared_ptr<Task> && task, time_point_t time);
347 
349  Event(Event && other);
350 
352  Event& operator=(Event && other);
353 
355  ~Event();
356 
358  void execute();
359 
360  private: // friends
361 
362  friend class Scheduler;
363 
364  private: // members
365 
366  std::shared_ptr<Task> m_task;
367  time_point_t m_time;
368 
369  private: // deleted methods
370 
371  Event() = delete;
372  Event(Event const& other) = delete;
373  Event& operator=(Event const& other) = delete;
374  };
375 
376 }}
377 
378 #include <KiwiTool/KiwiTool_Scheduler.hpp>
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::tool::Scheduler::CallBack
The scheduler&#39;s callback is a task that uses an std::function for conveniency.
Definition: KiwiTool_Scheduler.h:252
+
kiwi::tool::Scheduler::Scheduler
Scheduler()
Constructor.
Definition: KiwiTool_Scheduler.hpp:33
+
kiwi::tool::Scheduler::process
void process()
Processes events of the consumer that have reached exeuction time.
Definition: KiwiTool_Scheduler.hpp:129
+
kiwi::tool::Scheduler::Timer
An abstract class designed to repetedly call a method at a specified intervall of time...
Definition: KiwiTool_Scheduler.h:286
+
kiwi::tool::Scheduler::setThreadAsConsumer
void setThreadAsConsumer()
Sets the current thread as the consumer thread.
Definition: KiwiTool_Scheduler.hpp:46
+
kiwi::tool::Scheduler::Queue::Command
Definition: KiwiTool_Scheduler.h:155
+
kiwi::tool::Scheduler::lock
std::unique_lock< std::mutex > lock() const
Lock the process until the returned lock is out of scope.
Definition: KiwiTool_Scheduler.hpp:141
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Scheduler::defer
void defer(std::shared_ptr< Task > const &task)
Conditionally schedule a task in the consumer thread.
Definition: KiwiTool_Scheduler.hpp:78
+
kiwi::tool::Scheduler::schedule
void schedule(std::shared_ptr< Task > const &task, duration_t delay=std::chrono::milliseconds(0))
Delays execution of a task. Shared ownership.
Definition: KiwiTool_Scheduler.hpp:58
+
kiwi::tool::Scheduler::Queue
A class that holds a list of scheduled events.
Definition: KiwiTool_Scheduler.h:151
+
kiwi::tool::Scheduler::isThisConsumerThread
bool isThisConsumerThread() const
Check wehter or not this thread is the consumer.
Definition: KiwiTool_Scheduler.hpp:52
+
kiwi::tool::Scheduler::~Scheduler
~Scheduler()
Desctructor.
Definition: KiwiTool_Scheduler.hpp:41
+
kiwi::tool::Scheduler::unschedule
void unschedule(std::shared_ptr< Task > const &task)
Used to cancel the execution of a previously scheduled task.
Definition: KiwiTool_Scheduler.hpp:122
+
kiwi::tool::Scheduler::Timer::Task
Definition: KiwiTool_Scheduler.hpp:296
+
kiwi::tool::Scheduler::Event
An event that associates a task and a execution time.
Definition: KiwiTool_Scheduler.h:341
+
kiwi::tool::ConcurrentQueue
A mono producer, mono consumer FIFO lock free queue.
Definition: KiwiTool_ConcurrentQueue.h:41
+
kiwi::tool::Scheduler::Task
The abstract class that the scheduler executes. Caller must override execute function to specify the ...
Definition: KiwiTool_Scheduler.h:213
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_kiwi_tool___scheduler_8hpp_source.html b/docs/html/_kiwi_tool___scheduler_8hpp_source.html new file mode 100644 index 00000000..5f98f35d --- /dev/null +++ b/docs/html/_kiwi_tool___scheduler_8hpp_source.html @@ -0,0 +1,134 @@ + + + + + + +Kiwi: Modules/KiwiTool/KiwiTool_Scheduler.hpp Source File + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
KiwiTool_Scheduler.hpp
+
+
+
1 /*
2  ==============================================================================
3 
4  This file is part of the KIWI library.
5  - Copyright (c) 2014-2016, Pierre Guillot & Eliott Paris.
6  - Copyright (c) 2016-2017, CICM, ANR MUSICOLL, Eliott Paris, Pierre Guillot, Jean Millot.
7 
8  Permission is granted to use this software under the terms of the GPL v3
9  (or any later version). Details can be found at: www.gnu.org/licenses
10 
11  KIWI is distributed in the hope that it will be useful, but WITHOUT ANY
12  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13  A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 
15  ------------------------------------------------------------------------------
16 
17  Contact : cicm.mshparisnord@gmail.com
18 
19  ==============================================================================
20  */
21 
22 #pragma once
23 
24 #include <algorithm>
25 
26 namespace kiwi { namespace tool {
27 
28  // ==================================================================================== //
29  // SCHEDULER //
30  // ==================================================================================== //
31 
32  template<class Clock>
33  Scheduler<Clock>::Scheduler():
34  m_queue(),
35  m_mutex(),
36  m_consumer_id(std::this_thread::get_id())
37  {
38  }
39 
40  template<class Clock>
41  Scheduler<Clock>::~Scheduler()
42  {
43  }
44 
45  template<class Clock>
46  void Scheduler<Clock>::setThreadAsConsumer()
47  {
48  m_consumer_id = std::this_thread::get_id();
49  }
50 
51  template<class Clock>
52  bool Scheduler<Clock>::isThisConsumerThread() const
53  {
54  return m_consumer_id == std::this_thread::get_id();
55  }
56 
57  template<class Clock>
58  void Scheduler<Clock>::schedule(std::shared_ptr<Task> const& task, duration_t delay)
59  {
60  assert(task);
61  m_queue.schedule(task, delay);
62  }
63 
64  template<class Clock>
65  void Scheduler<Clock>::schedule(std::shared_ptr<Task> && task, duration_t delay)
66  {
67  assert(task);
68  m_queue.schedule(std::move(task), delay);
69  }
70 
71  template<class Clock>
72  void Scheduler<Clock>::schedule(std::function<void(void)> && func, duration_t delay)
73  {
74  schedule(std::make_shared<CallBack>(func), delay);
75  }
76 
77  template<class Clock>
78  void Scheduler<Clock>::defer(std::shared_ptr<Task> const& task)
79  {
80  assert(task);
81 
82  if (!isThisConsumerThread())
83  {
84  schedule(task);
85  }
86  else
87  {
88  task->execute();
89  }
90  }
91 
92  template<class Clock>
93  void Scheduler<Clock>::defer(std::shared_ptr<Task> && task)
94  {
95  assert(task);
96 
97  if (!isThisConsumerThread())
98  {
99  schedule(std::move(task));
100  }
101  else
102  {
103  task->execute();
104  task.reset();
105  }
106  }
107 
108  template<class Clock>
109  void Scheduler<Clock>::defer(std::function<void(void)> && func)
110  {
111  if (!isThisConsumerThread())
112  {
113  schedule(std::move(func));
114  }
115  else
116  {
117  func();
118  }
119  }
120 
121  template<class Clock>
122  void Scheduler<Clock>::unschedule(std::shared_ptr<Task> const& task)
123  {
124  assert(task);
125  m_queue.unschedule(task);
126  }
127 
128  template<class Clock>
129  void Scheduler<Clock>::process()
130  {
131  assert(std::this_thread::get_id() == m_consumer_id);
132 
133  std::lock_guard<std::mutex> lock(m_mutex);
134 
135  time_point_t process_time = clock_t::now();
136 
137  m_queue.process(process_time);
138  }
139 
140  template<class Clock>
141  std::unique_lock<std::mutex> Scheduler<Clock>::lock() const
142  {
143  std::unique_lock<std::mutex> head_lock(m_mutex);
144 
145  return std::move(head_lock);
146  }
147 
148  // ==================================================================================== //
149  // QUEUE //
150  // ==================================================================================== //
151 
152  template<class Clock>
153  Scheduler<Clock>::Queue::Queue():
154  m_events(),
155  m_commands(1024)
156  {
157  }
158 
159  template<class Clock>
160  Scheduler<Clock>::Queue::~Queue()
161  {
162  }
163 
164  template<class Clock>
165  void Scheduler<Clock>::Queue::schedule(std::shared_ptr<Task> const& task, duration_t delay)
166  {
167  assert(task);
168  m_commands.push({task, clock_t::now() + delay });
169  }
170 
171  template<class Clock>
172  void Scheduler<Clock>::Queue::schedule(std::shared_ptr<Task> && task, duration_t delay)
173  {
174  assert(task);
175  m_commands.push({std::move(task), clock_t::now() + delay});
176  }
177 
178  template<class Clock>
179  void Scheduler<Clock>::Queue::unschedule(std::shared_ptr<Task> const& task)
180  {
181  m_commands.push({task, clock_t::time_point::max()});
182  }
183 
184  template<class Clock>
185  void Scheduler<Clock>::Queue::remove(Event const& event)
186  {
187  m_events.erase(std::remove_if(m_events.begin(), m_events.end(), [&event](Event const& e) {
188 
189  return e.m_task == event.m_task;
190 
191  }), m_events.end());
192  }
193 
194  template<class Clock>
195  void Scheduler<Clock>::Queue::emplace(Event && event)
196  {
197  remove(event);
198 
199  auto event_it = m_events.begin();
200 
201  while(event_it != m_events.end())
202  {
203  if (event.m_time < event_it->m_time)
204  {
205  m_events.insert(event_it, std::move(event));
206  break;
207  }
208 
209  ++event_it;
210  }
211 
212  if (event_it == m_events.end())
213  {
214  m_events.emplace_back(std::move(event));
215  }
216  }
217 
218  template<class Clock>
219  void Scheduler<Clock>::Queue::process(time_point_t process_time)
220  {
221  size_t command_size = m_commands.load_size();
222 
223  for (size_t i = 0; i < command_size; ++i)
224  {
225  Command command;
226 
227  if (m_commands.pop(command))
228  {
229  Event event(std::move(command.m_task), command.m_time);
230 
231  if (event.m_time != clock_t::time_point::max())
232  {
233  emplace(std::move(event));
234  }
235  else
236  {
237  remove(event);
238  }
239  }
240  }
241 
242  m_events.erase(std::remove_if(m_events.begin(), m_events.end(), [&process_time](auto& event) {
243 
244  if (event.m_time <= process_time)
245  {
246  event.execute();
247  return true;
248  }
249 
250  return false;
251 
252  }), m_events.end());
253  }
254 
255  // ==================================================================================== //
256  // TASK //
257  // ==================================================================================== //
258 
259  template<class Clock>
260  Scheduler<Clock>::Task::Task()
261  {
262  }
263 
264  template<class Clock>
265  Scheduler<Clock>::Task::~Task()
266  {
267  }
268 
269  // ==================================================================================== //
270  // CALLBACK //
271  // ==================================================================================== //
272 
273  template<class Clock>
274  Scheduler<Clock>::CallBack::CallBack(std::function<void(void)> func):
275  Task(),
276  m_func(func)
277  {
278  }
279 
280  template<class Clock>
281  Scheduler<Clock>::CallBack::~CallBack()
282  {
283  }
284 
285  template<class Clock>
286  void Scheduler<Clock>::CallBack::execute()
287  {
288  m_func();
289  }
290 
291  // ==================================================================================== //
292  // TIMER //
293  // ==================================================================================== //
294 
295  template<class Clock>
296  class Scheduler<Clock>::Timer::Task final : public Scheduler<Clock>::Task
297  {
298  public: // methods
299 
300  Task(Timer& timer):
301  m_timer(timer)
302  {
303  }
304 
305  ~Task()
306  {
307  }
308 
309  void execute() override
310  {
311  m_timer.callBackInternal();
312  }
313 
314  private: // members
315 
316  Timer& m_timer;
317 
318  };
319 
320  template<class Clock>
321  Scheduler<Clock>::Timer::Timer(Scheduler & scheduler):
322  m_scheduler(scheduler),
323  m_task(new Task(*this)),
324  m_period()
325  {
326  }
327 
328  template<class Clock>
329  Scheduler<Clock>::Timer::~Timer()
330  {
331  stopTimer();
332  }
333 
334  template<class Clock>
335  void Scheduler<Clock>::Timer::startTimer(duration_t period)
336  {
337  stopTimer();
338 
339  m_period = period;
340 
341  m_scheduler.schedule(m_task, m_period);
342  }
343 
344  template<class Clock>
345  void Scheduler<Clock>::Timer::callBackInternal()
346  {
347  timerCallBack();
348 
349  m_scheduler.schedule(m_task, m_period);
350  }
351 
352  template<class Clock>
353  void Scheduler<Clock>::Timer::stopTimer()
354  {
355  m_scheduler.unschedule(m_task);
356  }
357 
358  // ==================================================================================== //
359  // EVENT //
360  // ==================================================================================== //
361 
362  template<class Clock>
363  Scheduler<Clock>::Event::Event(std::shared_ptr<Task> && task, time_point_t time):
364  m_task(std::move(task)),
365  m_time(time)
366  {
367  }
368 
369  template<class Clock>
370  Scheduler<Clock>::Event::Event(Event && other):
371  m_task(std::move(other.m_task)),
372  m_time(std::move(other.m_time))
373  {
374  }
375 
376  template<class Clock>
377  typename Scheduler<Clock>::Event& Scheduler<Clock>::Event::operator=(Event && other)
378  {
379  m_task = std::move(other.m_task);
380  m_time = std::move(other.m_time);
381 
382  return *this;
383  }
384 
385 
386  template<class Clock>
387  Scheduler<Clock>::Event::~Event()
388  {
389  }
390 
391  template<class Clock>
392  void Scheduler<Clock>::Event::execute()
393  {
394  if (m_task){m_task->execute();}
395  }
396 }}
kiwi::tool::Scheduler
A class designed to delay tasks&#39; execution between threads that where previously declared.
Definition: KiwiTool_Scheduler.h:48
+
kiwi::tool::Scheduler::Timer::Task::execute
void execute() override
The pure virtual execution method. Called by the scheduler when execution time is reached...
Definition: KiwiTool_Scheduler.hpp:309
+
kiwi::tool::Scheduler::Scheduler
Scheduler()
Constructor.
Definition: KiwiTool_Scheduler.hpp:33
+
kiwi::tool::Scheduler::Timer::~Timer
~Timer()
Destructor.
Definition: KiwiTool_Scheduler.hpp:329
+
kiwi::tool::Scheduler::process
void process()
Processes events of the consumer that have reached exeuction time.
Definition: KiwiTool_Scheduler.hpp:129
+
kiwi::tool::Scheduler::Timer
An abstract class designed to repetedly call a method at a specified intervall of time...
Definition: KiwiTool_Scheduler.h:286
+
kiwi::tool::Scheduler::setThreadAsConsumer
void setThreadAsConsumer()
Sets the current thread as the consumer thread.
Definition: KiwiTool_Scheduler.hpp:46
+
kiwi::tool::Scheduler::CallBack::~CallBack
~CallBack()
Destructor.
Definition: KiwiTool_Scheduler.hpp:281
+
kiwi::tool::Scheduler::Queue::Command
Definition: KiwiTool_Scheduler.h:155
+
kiwi::tool::Scheduler::Queue::~Queue
~Queue()
Destructor.
Definition: KiwiTool_Scheduler.hpp:160
+
kiwi::tool::Scheduler::lock
std::unique_lock< std::mutex > lock() const
Lock the process until the returned lock is out of scope.
Definition: KiwiTool_Scheduler.hpp:141
+
kiwi
Definition: KiwiDsp_Chain.cpp:25
+
kiwi::tool::Scheduler::CallBack::execute
void execute() override final
Executes the given functions.
Definition: KiwiTool_Scheduler.hpp:286
+
kiwi::tool::Scheduler::defer
void defer(std::shared_ptr< Task > const &task)
Conditionally schedule a task in the consumer thread.
Definition: KiwiTool_Scheduler.hpp:78
+
kiwi::tool::Scheduler::schedule
void schedule(std::shared_ptr< Task > const &task, duration_t delay=std::chrono::milliseconds(0))
Delays execution of a task. Shared ownership.
Definition: KiwiTool_Scheduler.hpp:58
+
kiwi::tool::Scheduler::Queue::process
void process(time_point_t process_time)
Processes all events that have reached execution time.
Definition: KiwiTool_Scheduler.hpp:219
+
kiwi::tool::Scheduler::Queue::schedule
void schedule(std::shared_ptr< Task > const &task, duration_t delay)
Delays the execution of a task. Shared ownership.
Definition: KiwiTool_Scheduler.hpp:165
+
kiwi::tool::Scheduler::Event::execute
void execute()
Called by the scheduler to execute a the task.
Definition: KiwiTool_Scheduler.hpp:392
+
kiwi::tool::Scheduler::Timer::startTimer
void startTimer(duration_t period)
Starts the timer.
Definition: KiwiTool_Scheduler.hpp:335
+
kiwi::tool::Scheduler::Event::operator=
Event & operator=(Event &&other)
Moove assignment operator.
Definition: KiwiTool_Scheduler.hpp:377
+
kiwi::tool::Scheduler::isThisConsumerThread
bool isThisConsumerThread() const
Check wehter or not this thread is the consumer.
Definition: KiwiTool_Scheduler.hpp:52
+
kiwi::tool::Scheduler::Queue::unschedule
void unschedule(std::shared_ptr< Task > const &task)
Cancels the execution of a task.
Definition: KiwiTool_Scheduler.hpp:179
+
kiwi::tool::Scheduler::~Scheduler
~Scheduler()
Desctructor.
Definition: KiwiTool_Scheduler.hpp:41
+
kiwi::tool::Scheduler::Timer::stopTimer
void stopTimer()
Stops the timer.
Definition: KiwiTool_Scheduler.hpp:353
+
kiwi::tool::Scheduler::unschedule
void unschedule(std::shared_ptr< Task > const &task)
Used to cancel the execution of a previously scheduled task.
Definition: KiwiTool_Scheduler.hpp:122
+
kiwi::tool::Scheduler::Event::~Event
~Event()
Destructor.
Definition: KiwiTool_Scheduler.hpp:387
+
kiwi::tool::Scheduler::Timer::Task
Definition: KiwiTool_Scheduler.hpp:296
+
kiwi::tool::Scheduler::Timer::Task::~Task
~Task()
Destructor.
Definition: KiwiTool_Scheduler.hpp:305
+
kiwi::tool::Scheduler::Queue::Queue
Queue()
Constructor.
Definition: KiwiTool_Scheduler.hpp:153
+
kiwi::tool::Scheduler::Task::~Task
virtual ~Task()
Destructor.
Definition: KiwiTool_Scheduler.hpp:265
+
kiwi::tool::Scheduler::Event
An event that associates a task and a execution time.
Definition: KiwiTool_Scheduler.h:341
+
kiwi::tool::Scheduler::Task::Task
Task()
Constructor.
Definition: KiwiTool_Scheduler.hpp:260
+
kiwi::tool::Scheduler::Task
The abstract class that the scheduler executes. Caller must override execute function to specify the ...
Definition: KiwiTool_Scheduler.h:213
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/_the-example.html b/docs/html/_the-example.html new file mode 100644 index 00000000..97edb93b --- /dev/null +++ b/docs/html/_the-example.html @@ -0,0 +1,101 @@ + + + + + + +Kiwi: The + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + +
+ +
+
+ + +
+ +
+ +
+
+
The
+
+
+

Parse a string into a vector of atoms.

Parameters
+ + + +
textThe string to parse.
flagsThe flags as a set of #ParsingFlags.
+
+
+
Returns
The vector of atoms.
+

The parsing method can be altered by the #ParsingFlags passed as parameter. If the ParsingFlags::Comma flag is set, it will create a Comma atom type for each ',' char of the string (except if the text is in double quotes) If the ParsingFlags::Dollar flag is set, it will create a Dollar atom type for each '$' char followed by a digit between 1 and 9. string : "foo \"bar 42" 1 -2 3.14" will be parsed into a vector of 5 Atom. The atom types will be determined automatically as : 2 #Atom::Type::String, 2 #Atom::Type::Int, and 1 #Atom::Type::Float.

+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/annotated.html b/docs/html/annotated.html index ad4703a5..dced62aa 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -3,8 +3,7 @@ - - + Kiwi: Class List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12345]
- + @@ -86,144 +113,292 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼Nkiwi
 ▼Nkiwi
 ►Ndsp
 ►Nmodel
 ►CAboutWindowKiwi About window
 ►CApiAn API request handler class
 CAtomThe Atom can dynamically hold different types of value
 CAtomHelperAn Atom helper class
 CBeaconDispatcher
 CBeaconDispatcherElemA Component that allows to dispatch messages to Beacon::Castaway objects
 CBeaconDispatcherToolbarFactory
 CCarrierSocketClass that encapsulate a TCP socket
 CClassicBoxThe ClassicBox let the user change the text of the box
 CConsole
 CConsoleContentThe juce ConsoleContent Component
 ►CConsoleHistoryThe Console History listen to the Console and keep an history of the messages
 CConsoleToolbarFactory
 CCustomToolbarButtonA type of button designed to go on a toolbar
 CCustomTooltipClientA custom tooltip client that provides the bounds of the tooltip to show
 ►CDocumentBrowserRequest Patcher document informations through a Kiwi API
 ►CDocumentBrowserView
 CDocumentManager
 CDspDeviceManager
 CFileHandlerClass that enable saving and loading the document from a kiwi file
 CHitTesterThe HitTester class..
 CImageButtonA button that displays a Drawable
 CInstanceThe Application Instance
 CIoletHighlighter
 ►CKiwiApp
 CLasso
 CLinkViewThe juce link Component
 CLinkViewBaseThe LinkView base class
 CLinkViewCreatorThe LinkView creator helper
 CLookAndFeel
 ►CNetworkSettings
 CObjectViewThe juce object Component
 CPatcherComponentThe PatcherComponent holds a patcher view and a patcher toolbar
 ►CPatcherManagerThe main DocumentObserver
 ►CPatcherToolbar
 CPatcherViewThe juce Patcher Component
 CPatcherViewportThe PatcherView Viewport
 CPatcherViewWindow
 CSettingsPanelA Panel Component that shows application's settings
 CStoredSettingsSettings storage class utility
 CStringHelperAn std::string helper class
 ►CSuggestEditorA text editor with auto-completion
 ►CSuggestListA string container that provide suggestion list based on given patterns
 CTooltipWindowA custom TooltipWindow
 CWindowCommon interface for all windows held by the application
 ►Nnetwork
 ►Nserver
 ►Ntool
 ►CAboutWindowKiwi About window
 CAlertBox
 ►CApiA remote API request handler
 CApiController
 CAuthPanel
 CBangView
 CBeaconDispatcher
 CBeaconDispatcherElemA Component that allows to dispatch messages to Beacon::Castaway objects
 CBeaconDispatcherToolbarFactory
 CCarrierSocketClass that encapsulate a TCP socket
 CClassicViewThe view of any textual kiwi object
 CCommentViewThe view of any textual kiwi object
 CConsole
 CConsoleContentThe juce ConsoleContent Component
 ►CConsoleHistoryThe Console History listen to the Console and keep an history of the messages
 CConsoleToolbarFactory
 CCustomToolbarButtonA type of button designed to go on a toolbar
 CCustomTooltipClientA custom tooltip client that provides the bounds of the tooltip to show
 ►CDocumentBrowserRequest Patcher document informations through a Kiwi API
 ►CDocumentBrowserView
 CDspDeviceManager
 ►CEditableObjectViewAbstract class for object's views that can be edited in mode unlock
 CFactory
 ►CFormComponent
 CHitTesterThe HitTester class..
 CImageButtonA button that displays a Drawable
 CInstanceThe Application Instance
 CIoletHighlighter
 ►CKiwiApp
 CLasso
 CLinkViewThe juce link Component
 CLinkViewBaseThe LinkView base class
 CLinkViewCreatorThe LinkView creator helper
 CLoginForm
 CLookAndFeel
 CMessageViewThe view of any textual kiwi object
 CMeterTildeView
 CMouseHandlerThe mouse handler is used to make the patcher view react to the mouse interactions
 ►CNetworkSettings
 CNumberTildeViewThe view of any textual kiwi object
 CNumberViewThe view of any textual kiwi object
 CNumberViewBaseThe view of any textual kiwi object
 ►CObjectFrameA juce component holding the object's graphical representation
 CObjectViewAbstract for objects graphical representation
 CPatcherComponentThe PatcherComponent holds a patcher view and a patcher toolbar
 ►CPatcherManagerThe main DocumentObserver
 ►CPatcherToolbar
 CPatcherViewThe juce Patcher Component
 CPatcherViewportThe PatcherView Viewport
 CPatcherViewWindow
 CSettingsPanelA Panel Component that shows application's settings
 CSignUpForm
 CSliderView
 CSpinner
 CStoredSettingsSettings storage class utility
 ►CSuggestEditorA text editor with auto-completion
 ►CSuggestListA string container that provide suggestion list based on given patterns
 CToggleView
 CTooltipWindowA custom TooltipWindow
 CWindowCommon interface for all windows held by the application
@@ -231,7 +406,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/arrowdown.png b/docs/html/arrowdown.png new file mode 100644 index 0000000000000000000000000000000000000000..0b63f6d38c4b9ec907b820192ebe9724ed6eca22 GIT binary patch literal 246 zcmVkw!R34#Lv2LOS^S2tZA31X++9RY}n zChwn@Z)Wz*WWHH{)HDtJnq&A2hk$b-y(>?@z0iHr41EKCGp#T5?07*qoM6N<$f(V3Pvj6}9 literal 0 HcmV?d00001 diff --git a/docs/html/arrowright.png b/docs/html/arrowright.png new file mode 100644 index 0000000000000000000000000000000000000000..c6ee22f937a07d1dbfc27c669d11f8ed13e2f152 GIT binary patch literal 229 zcmV^P)R?RzRoKvklcaQ%HF6%rK2&ZgO(-ihJ_C zzrKgp4jgO( fd_(yg|3PpEQb#9`a?Pz_00000NkvXXu0mjftR`5K literal 0 HcmV?d00001 diff --git a/docs/html/classes.html b/docs/html/classes.html index 5027347b..2358417b 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Index @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
Class Index
-
a | b | c | d | e | f | h | i | k | l | m | n | o | p | q | r | s | t | u | v | w
+
A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | Q | R | S | T | U | V | W
- - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - + + - - - + + - - - - - - - + + + +
  a  
-		DacTilde (kiwi::engine)   Factory::isValidObject (kiwi::model)   Object (kiwi::engine)   DocumentBrowserView::DriveView::RowElem (kiwi)   
DataModel (kiwi::model)   
  k  
-		Factory::ObjectClass (kiwi::model)   
  s  
+
  A  
+		Divide (kiwi::model)   Less (kiwi::model)   Object (kiwi::model)   Scale (kiwi::model)   
DivideTilde (kiwi::engine)   Less (kiwi::engine)   ObjectClass (kiwi::model)   Scale (kiwi::engine)   
AboutWindow (kiwi)   DivideTilde (kiwi::model)   LessEqual (kiwi::model)   ObjectFrame (kiwi)   Scheduler (kiwi::tool)   
AdcTilde (kiwi::engine)   Api::Document (kiwi)   LessEqual (kiwi::engine)   ObjectView (kiwi)   Select (kiwi::engine)   
AdcTilde (kiwi::model)   DocumentBrowser (kiwi)   LessEqualTilde (kiwi::model)   Operator (kiwi::model)   Select (kiwi::model)   
AlertBox (kiwi)   DocumentBrowserView (kiwi)   LessEqualTilde (kiwi::engine)   Operator (kiwi::engine)   Send (kiwi::engine)   
Api (kiwi)   DocumentManager (kiwi::model)   LessTilde (kiwi::model)   OperatorTilde (kiwi::engine)   Send (kiwi::model)   
ApiController (kiwi)   DocumentBrowser::Drive::DocumentSession (kiwi)   LessTilde (kiwi::engine)   OperatorTilde (kiwi::model)   Server (kiwi::server)   
KiwiApp::AsyncQuitRetrier (kiwi)   DocumentBrowser::Drive (kiwi)   LineTilde (kiwi::model)   SuggestList::Options (kiwi)   Server::Session (kiwi::server)   
Atom (kiwi::tool)   DocumentBrowserView::DriveView (kiwi)   LineTilde (kiwi::engine)   OscTilde (kiwi::engine)   Session (kiwi::network::http)   
AtomHelper (kiwi::tool)   DspDeviceManager (kiwi)   Link (kiwi::engine)   OscTilde (kiwi::model)   SettingsPanel (kiwi)   
AudioControler (kiwi::engine)   
  E  
+		Link (kiwi::model)   Outlet (kiwi::model)   Signal (kiwi::dsp)   
AudioInterfaceObject (kiwi::engine)   LinkView (kiwi)   ObjectFrame::Outline (kiwi)   SignUpForm (kiwi)   
AudioObject (kiwi::engine)   EditableObjectView (kiwi)   LinkViewBase (kiwi)   FormComponent::OverlayComp (kiwi)   SigTilde (kiwi::engine)   
AuthPanel (kiwi)   Equal (kiwi::engine)   LinkViewCreator (kiwi)   
  P  
+		SigTilde (kiwi::model)   
Api::AuthUser (kiwi)   Equal (kiwi::model)   NetworkSettings::Listener (kiwi)   FormComponent::Field::SingleLineText (kiwi)   
  B  
+		EqualTilde (kiwi::engine)   DocumentBrowser::Drive::Listener (kiwi)   Pack (kiwi::engine)   Slider (kiwi::engine)   
EqualTilde (kiwi::model)   EditableObjectView::Listener (kiwi)   Pack (kiwi::model)   Slider (kiwi::model)   
Bang (kiwi::engine)   Error (kiwi::dsp)   Console::Listener (kiwi::engine)   Payload::Pair (kiwi::network::http)   SliderView (kiwi)   
Bang (kiwi::model)   Api::Error (kiwi)   Object::Listener (kiwi::model)   Parameters::Parameter (kiwi::network::http)   SnapshotTilde (kiwi::model)   
LineTilde::BangTask (kiwi::engine)   Error (kiwi::model)   PatcherManager::Listener (kiwi)   Parameter (kiwi::tool)   SnapshotTilde (kiwi::engine)   
BangView (kiwi)   Object::Error (kiwi::model)   ConsoleHistory::Listener (kiwi)   ParameterClass (kiwi::model)   Spinner (kiwi)   
Beacon (kiwi::tool)   ErrorBox (kiwi::engine)   Listeners (kiwi::tool)   Parameters (kiwi::network::http)   StoredSettings (kiwi)   
BeaconDispatcher (kiwi)   ErrorBox (kiwi::model)   Loadmess (kiwi::model)   AtomHelper::ParsingFlags (kiwi::tool)   SuggestEditor (kiwi)   
BeaconDispatcherElem (kiwi)   Scheduler::Event (kiwi::tool)   Loadmess (kiwi::engine)   FormComponent::Field::Password (kiwi)   SuggestList (kiwi)   
BeaconDispatcherToolbarFactory (kiwi)   
  F  
+		Server::Logger (kiwi::server)   Patcher (kiwi::model)   Switch (kiwi::model)   
Body (kiwi::network::http)   LoginForm (kiwi)   Patcher (kiwi::engine)   Switch (kiwi::engine)   
Buffer (kiwi::dsp)   Factory (kiwi)   LookAndFeel (kiwi)   PatcherComponent (kiwi)   SwitchTilde (kiwi::engine)   
  C  
+		Factory (kiwi::engine)   LoopError (kiwi::dsp)   PatcherManager (kiwi)   SwitchTilde (kiwi::model)   
Beacon::Factory (kiwi::tool)   
  M  
+		PatcherToolbar (kiwi)   
  T  
+
Scheduler::CallBack (kiwi::tool)   Factory (kiwi::model)   PatcherValidator (kiwi::model)   
CarrierSocket (kiwi)   FormComponent::Field (kiwi)   KiwiApp::MainMenuModel (kiwi)   PatcherView (kiwi)   Scheduler::Timer::Task (kiwi::tool)   
Beacon::Castaway (kiwi::tool)   Float (kiwi::model)   Matrix (kiwi::tool)   PatcherViewport (kiwi)   Scheduler::Task (kiwi::tool)   
Chain (kiwi::dsp)   Float (kiwi::engine)   SuggestEditor::Menu (kiwi)   PatcherViewWindow (kiwi)   FormComponent::Field::TextButton (kiwi)   
CircularBuffer (kiwi::tool)   FormComponent (kiwi)   Message (kiwi::model)   Payload (kiwi::network::http)   Chain::Node::Tie (kiwi::dsp)   
ClassicView (kiwi)   
  G  
+		Console::Message (kiwi::engine)   PerformCallBack (kiwi::dsp)   Scheduler::Timer (kiwi::tool)   
Clip (kiwi::engine)   Message (kiwi::engine)   PhasorTilde (kiwi::engine)   Timer (kiwi::dsp)   
Clip (kiwi::model)   Gate (kiwi::model)   MessageView (kiwi)   PhasorTilde (kiwi::model)   Times (kiwi::model)   
ClipTilde (kiwi::engine)   Gate (kiwi::engine)   MeterTilde (kiwi::model)   Chain::Node::Pin (kiwi::dsp)   Times (kiwi::engine)   
ClipTilde (kiwi::model)   GateTilde (kiwi::model)   MeterTilde (kiwi::engine)   PinType (kiwi::model)   TimesTilde (kiwi::model)   
Scheduler::Queue::Command (kiwi::tool)   GateTilde (kiwi::engine)   MeterTildeView (kiwi)   Pipe (kiwi::model)   TimesTilde (kiwi::engine)   
Comment (kiwi::model)   Greater (kiwi::model)   Metro (kiwi::model)   Pipe (kiwi::engine)   Toggle (kiwi::engine)   
Comment (kiwi::engine)   Greater (kiwi::engine)   Metro (kiwi::engine)   Plus (kiwi::model)   Toggle (kiwi::model)   
CommentView (kiwi)   GreaterEqual (kiwi::model)   Minus (kiwi::model)   Plus (kiwi::engine)   FormComponent::Field::ToggleButton (kiwi)   
ConcurrentQueue (kiwi::tool)   GreaterEqual (kiwi::engine)   Minus (kiwi::engine)   PlusTilde (kiwi::engine)   ToggleView (kiwi)   
Console (kiwi::engine)   GreaterEqualTilde (kiwi::model)   MinusTilde (kiwi::engine)   PlusTilde (kiwi::model)   TooltipWindow (kiwi)   
Console (kiwi)   GreaterEqualTilde (kiwi::engine)   MinusTilde (kiwi::model)   Pow (kiwi::engine)   Trigger (kiwi::model)   
ConsoleContent (kiwi)   GreaterTilde (kiwi::model)   Modulo (kiwi::model)   Pow (kiwi::model)   Trigger (kiwi::engine)   
ConsoleHistory (kiwi)   GreaterTilde (kiwi::engine)   Modulo (kiwi::engine)   Processor::PrepareInfo (kiwi::dsp)   
  U  
+
ConsoleToolbarFactory (kiwi)   
  H  
+		MouseHandler (kiwi)   Print (kiwi::model)   
AboutWindow::Content (kiwi)   Mtof (kiwi::engine)   Print (kiwi::engine)   Unpack (kiwi::model)   
Api::Controller (kiwi)   DocumentBrowserView::DriveView::Header (kiwi)   Mtof (kiwi::model)   Processor (kiwi::dsp)   Unpack (kiwi::engine)   
Converter (kiwi::model)   HitTester (kiwi)   
  N  
+
  Q  
+		Api::User (kiwi)   
CustomToolbarButton (kiwi)   Hub (kiwi::model)   Patcher::User (kiwi::model)   
CustomTooltipClient (kiwi)   Hub (kiwi::engine)   NetworkSettings (kiwi)   Query (kiwi::network::http)   PatcherToolbar::UsersItemComponent (kiwi)   
  D  
+
  I  
+		NewBox (kiwi::engine)   Scheduler::Queue (kiwi::tool)   
  V  
AboutWindow (kiwi)   Delay (kiwi::engine)   Factory::ObjectClassBase (kiwi::model)   
AdcTilde (kiwi::model)   Delay (kiwi::model)   KiwiApp (kiwi)   ObjectView (kiwi)   Scheduler (kiwi::engine)   
AdcTilde (kiwi::engine)   DelaySimpleTilde (kiwi::model)   
  l  
-		SuggestList::Options (kiwi)   SettingsPanel (kiwi)   
Api (kiwi)   DelaySimpleTilde (kiwi::engine)   OscTilde (kiwi::engine)   Signal (kiwi::dsp)   
KiwiApp::AsyncQuitRetrier (kiwi)   Api::Document (kiwi)   Lasso (kiwi)   OscTilde (kiwi::model)   SigTilde (kiwi::model)   
Atom (kiwi)   DocumentBrowser (kiwi)   Link (kiwi::model)   Outlet (kiwi::model)   SigTilde (kiwi::engine)   
AtomHelper (kiwi)   DocumentBrowserView (kiwi)   Link (kiwi::engine)   
  p  
-		StoredSettings (kiwi)   
AudioControler (kiwi::engine)   DocumentManager (kiwi)   LinkView (kiwi)   StringHelper (kiwi)   
AudioInterfaceObject (kiwi::engine)   DocumentBrowser::Drive::DocumentSession (kiwi)   LinkViewBase (kiwi)   Patcher (kiwi::engine)   SuggestEditor (kiwi)   
AudioObject (kiwi::engine)   DocumentBrowser::Drive (kiwi)   LinkViewCreator (kiwi)   Patcher (kiwi::model)   SuggestList (kiwi)   
  b  
-		DocumentBrowserView::DriveView (kiwi)   NetworkSettings::Listener (kiwi)   PatcherComponent (kiwi)   
  t  
+
NewBox (kiwi::model)   
  R  
DspDeviceManager (kiwi)   DocumentBrowser::Listener (kiwi)   PatcherManager (kiwi)   
Beacon (kiwi::engine)   
  e  
-		DocumentBrowser::Drive::Listener (kiwi)   PatcherToolbar (kiwi)   Receive::Task (kiwi::engine)   
BeaconDispatcher (kiwi)   PatcherManager::Listener (kiwi)   PatcherValidator (kiwi::model)   Pipe::Task (kiwi::engine)   
BeaconDispatcherElem (kiwi)   Error (kiwi::dsp)   Console::Listener (kiwi::engine)   PatcherView (kiwi)   Scheduler::Task (kiwi::engine)   
BeaconDispatcherToolbarFactory (kiwi)   ErrorBox (kiwi::engine)   ConsoleHistory::Listener (kiwi)   PatcherViewport (kiwi)   Scheduler::Timer::Task (kiwi::engine)   
Buffer (kiwi::dsp)   ErrorBox (kiwi::model)   SuggestEditor::Listener (kiwi)   PatcherViewWindow (kiwi)   Chain::Node::Tie (kiwi::dsp)   
  c  
-		Scheduler::Event (kiwi::engine)   Listeners (kiwi::engine)   PerformCallBack (kiwi::dsp)   Scheduler::Timer (kiwi::engine)   
  f  
-		Loadmess (kiwi::engine)   Chain::Node::Pin (kiwi::dsp)   Timer (kiwi::dsp)   
CarrierSocket (kiwi)   Loadmess (kiwi::model)   PinType (kiwi::model)   Times (kiwi::model)   
Beacon::Castaway (kiwi::engine)   Factory (kiwi::model)   Scheduler::Lock (kiwi::engine)   Pipe (kiwi::model)   Times (kiwi::engine)   
Chain (kiwi::dsp)   Beacon::Factory (kiwi::engine)   LookAndFeel (kiwi)   Pipe (kiwi::engine)   TimesTilde (kiwi::model)   
CircularBuffer (kiwi::engine)   Factory (kiwi::engine)   LoopError (kiwi::dsp)   Plus (kiwi::model)   TimesTilde (kiwi::engine)   
ClassicBox (kiwi)   FileHandler (kiwi)   
  m  
-		Plus (kiwi::engine)   TooltipWindow (kiwi)   
Router::Cnx (kiwi::engine)   
  h  
-		PlusTilde (kiwi::model)   
  u  
+
DacTilde (kiwi::model)   ImageButton (kiwi)   Chain::Node (kiwi::dsp)   Ramp::ValueTimePair (kiwi::engine)   
DacTilde (kiwi::engine)   Inlet (kiwi::model)   NoiseTilde (kiwi::engine)   Ramp (kiwi::engine)   Patcher::View (kiwi::model)   
DataModel (kiwi::model)   Instance (kiwi::engine)   NoiseTilde (kiwi::model)   Random (kiwi::engine)   
  W  
Scheduler::Queue::Command (kiwi::engine)   KiwiApp::MainMenuModel (kiwi)   PlusTilde (kiwi::engine)   
Chain::compare_proc (kiwi::dsp)   DocumentBrowserView::DriveView::Header (kiwi)   SuggestEditor::Menu (kiwi)   Processor::PrepareInfo (kiwi::dsp)   Patcher::User (kiwi::model)   
ConcurrentQueue (kiwi::engine)   HitTester (kiwi)   Console::Message (kiwi::engine)   Print (kiwi::model)   PatcherToolbar::UsersItemComponent (kiwi)   
Console (kiwi::engine)   
  i  
-		Metro (kiwi::engine)   Print (kiwi::engine)   
  v  
+
Delay (kiwi::engine)   Instance (kiwi)   Number (kiwi::model)   Random (kiwi::model)   
Delay (kiwi::model)   IoletHighlighter (kiwi)   Number (kiwi::engine)   Receive (kiwi::engine)   Window (kiwi)   
DelaySimpleTilde (kiwi::engine)   IPerformCallBack (kiwi::dsp)   NumberTilde (kiwi::model)   Receive (kiwi::model)   
  c  
Console (kiwi)   Metro (kiwi::model)   Processor (kiwi::dsp)   
ConsoleContent (kiwi)   ImageButton (kiwi)   
  n  
-
  q  
-		Patcher::View (kiwi::model)   
ConsoleHistory (kiwi)   Chain::index_node (kiwi::dsp)   
  w  
+
DelaySimpleTilde (kiwi::model)   
  K  
+		NumberTilde (kiwi::engine)   Response (kiwi::network::http)   
Different (kiwi::engine)   NumberTildeView (kiwi)   DocumentBrowserView::DriveView::RowElem (kiwi)   Chain::compare_proc (kiwi::dsp)   
Different (kiwi::model)   KiwiApp (kiwi)   NumberView (kiwi)   
  S  
+
  i  
ConsoleToolbarFactory (kiwi)   Inlet (kiwi::model)   NetworkSettings (kiwi)   Scheduler::Queue (kiwi::engine)   
AboutWindow::Content (kiwi)   Instance (kiwi::engine)   NewBox (kiwi::engine)   
  r  
-		Window (kiwi)   
CustomToolbarButton (kiwi)   Instance (kiwi)   NewBox (kiwi::model)   
CustomTooltipClient (kiwi)   IoletHighlighter (kiwi)   Chain::Node (kiwi::dsp)   Receive (kiwi::engine)   
  d  
-		IPerformCallBack (kiwi::dsp)   
  o  
-		Receive (kiwi::model)   
Listeners::is_valid_listener (kiwi::engine)   Router (kiwi::engine)   
DacTilde (kiwi::model)   Object (kiwi::model)   
DifferentTilde (kiwi::engine)   FormComponent::Field::KiwiLogo (kiwi)   NumberViewBase (kiwi)   
DifferentTilde (kiwi::model)   
  L  
+
  O  
+		SahTilde (kiwi::engine)   Chain::index_node (kiwi::dsp)   
Divide (kiwi::engine)   SahTilde (kiwi::model)   Listeners::is_valid_listener (kiwi::tool)   
Lasso (kiwi)   Object (kiwi::engine)   
-
a | b | c | d | e | f | h | i | k | l | m | n | o | p | q | r | s | t | u | v | w
+
A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | Q | R | S | T | U | V | W
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_about_window-members.html b/docs/html/classkiwi_1_1_about_window-members.html index c5b964af..241839ca 100644 --- a/docs/html/classkiwi_1_1_about_window-members.html +++ b/docs/html/classkiwi_1_1_about_window-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -70,23 +97,24 @@

This is the complete list of members for kiwi::AboutWindow, including all inherited members.

- - - - - - - - - - - + + + + + + + + + + + +
AboutWindow()kiwi::AboutWindow
closeButtonPressed() overridekiwi::Windowprotected
getAllCommands(juce::Array< juce::CommandID > &commands) override (defined in kiwi::Window)kiwi::Window
getCommandInfo(const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override (defined in kiwi::Window)kiwi::Window
getNextCommandTarget() override (defined in kiwi::Window)kiwi::Window
isMainWindow() constkiwi::Window
perform(InvocationInfo const &info) override (defined in kiwi::Window)kiwi::Window
restoreWindowState()kiwi::Window
saveWindowState()kiwi::Window
Window(std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)kiwi::Window
~AboutWindow()=defaultkiwi::AboutWindow
~Window()kiwi::Windowvirtual
close()kiwi::Window
closeButtonPressed() overridekiwi::Windowprotected
getAllCommands(juce::Array< juce::CommandID > &commands) override (defined in kiwi::Window)kiwi::Window
getCommandInfo(const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override (defined in kiwi::Window)kiwi::Window
getNextCommandTarget() override (defined in kiwi::Window)kiwi::Window
isMainWindow() const kiwi::Window
perform(InvocationInfo const &info) override (defined in kiwi::Window)kiwi::Window
restoreWindowState()kiwi::Window
saveWindowState()kiwi::Window
Window(std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)kiwi::Window
~AboutWindow()=defaultkiwi::AboutWindow
~Window()kiwi::Windowvirtual
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_about_window.html b/docs/html/classkiwi_1_1_about_window.html index 9685105d..bbce7afa 100644 --- a/docs/html/classkiwi_1_1_about_window.html +++ b/docs/html/classkiwi_1_1_about_window.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::AboutWindow Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -92,47 +119,51 @@ - - - + - + - - - + + + - + - + - + + + - - -

Public Member Functions

+
 AboutWindow ()
 Constructor.
 
+
 ~AboutWindow ()=default
 Destructor.
 
- Public Member Functions inherited from kiwi::Window
 Window (std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)
 Constructor. More...
 Constructor. More...
 
virtual ~Window ()
 Window destructor. Called whenever buttonPressed is called. More...
 Window destructor. Called whenever buttonPressed is called. More...
 
bool isMainWindow () const
 Return true if window shall be a main window of kiwi. More...
 
bool isMainWindow () const
 Return true if window shall be a main window of kiwi. More...
 
void restoreWindowState ()
 Restore the window state. More...
 Restore the window state. More...
 
void saveWindowState ()
 Save the window state. More...
 Save the window state. More...
 
+
+void close ()
 Close the window.
 
ApplicationCommandTarget * getNextCommandTarget () override
 
+
void getAllCommands (juce::Array< juce::CommandID > &commands) override
 
+
void getCommandInfo (const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override
 
+
bool perform (InvocationInfo const &info) override
 
- @@ -149,7 +180,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_about_window_1_1_content-members.html b/docs/html/classkiwi_1_1_about_window_1_1_content-members.html index c50095b7..e5df8343 100644 --- a/docs/html/classkiwi_1_1_about_window_1_1_content-members.html +++ b/docs/html/classkiwi_1_1_about_window_1_1_content-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

Additional Inherited Members

- Protected Member Functions inherited from kiwi::Window
+
void closeButtonPressed () override
 Called when close button is pressed. Request instance to close the window.
 
- + - - - - + +
@@ -77,7 +104,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_about_window_1_1_content.html b/docs/html/classkiwi_1_1_about_window_1_1_content.html index 02760f07..15e8cd6f 100644 --- a/docs/html/classkiwi_1_1_about_window_1_1_content.html +++ b/docs/html/classkiwi_1_1_about_window_1_1_content.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::AboutWindow::Content Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -80,15 +107,15 @@ - - - @@ -102,7 +129,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_alert_box-members.html b/docs/html/classkiwi_1_1_alert_box-members.html new file mode 100644 index 00000000..9a9cb967 --- /dev/null +++ b/docs/html/classkiwi_1_1_alert_box-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+

Public Member Functions

+
 Content ()
 Constructor.
 
+
 ~Content ()=default
 Destructor.
 
+
void paint (juce::Graphics &g) override
 juce::Component
 
+ + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
kiwi::AlertBox Member List
+
+
+ +

This is the complete list of members for kiwi::AlertBox, including all inherited members.

+ + + + +
AlertBox(std::string const &message, Type type=Type::Info, bool can_cancel=true, std::function< void(void)> on_close=nullptr)kiwi::AlertBox
Type enum name (defined in kiwi::AlertBox)kiwi::AlertBox
~AlertBox()kiwi::AlertBox
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_alert_box.html b/docs/html/classkiwi_1_1_alert_box.html new file mode 100644 index 00000000..cef12e59 --- /dev/null +++ b/docs/html/classkiwi_1_1_alert_box.html @@ -0,0 +1,140 @@ + + + + + + +Kiwi: kiwi::AlertBox Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
+
kiwi::AlertBox Class Reference
+
+
+
+Inheritance diagram for kiwi::AlertBox:
+
+
+ + + +
+ + + + +

+Public Types

enum  Type : uint8_t { Info = 0, +Success = 1, +Error = 2 + }
 
+ + + + + + + +

+Public Member Functions

+ AlertBox (std::string const &message, Type type=Type::Info, bool can_cancel=true, std::function< void(void)> on_close=nullptr)
 Constructor.
 
+ ~AlertBox ()
 Destructor.
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h
    • +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_alert_box.png b/docs/html/classkiwi_1_1_alert_box.png new file mode 100644 index 0000000000000000000000000000000000000000..43c1a748389dabd9165dd191031564b8999eb276 GIT binary patch literal 682 zcmeAS@N?(olHy`uVBq!ia0vp^hk!VMgBeKHOpNjdQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;cbe_XVY%3JY;vb>gU$CpN}5?x;R~=FU&6~=+3DbyZ!r}?9MmW z*S>cORh+5vCF-Elmit<7re0WEu#Ib{lg1hyuP+k+GDIh3tIEFJ&h?Qsb;>d)W3RBk z`eH#-!u=KJ9_t~=3zde?HIpfa_?N6S4t30esunp)X@ z_^Hu_hyS(Lu;mv-@E)_QX*{$$F1;b~$1*Mh>3G(Ln?JM|&KwJ8Ofb8@f$Q`poyUwn z6!v^$NPEo1u(=Q@y@TmMP7F|X9fN^%IKzyy?piZu_A))-<>>*ch~2^Dz#Y!;Lg~m& ztHK+b=BsX%oA=gcvIv9Ljj~;f3W{Fyv_|jd%W=_k;rbmM@4jwtiG}E_1qCW{Rn<{~ z3#;e!w!K%LEV3vk>*N!zm%9aK*DgCWF=JZsHm=E{eQUPuKb0oRdreeLJZP=oE3UJl zGyYjE*Ef#1vdG2xXzXgW8gaWsccvfFF^mg - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -69,26 +96,41 @@

This is the complete list of members for kiwi::Api, including all inherited members.

- - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Api(std::string const &host, uint16_t port=80, Protocol protocol=Api::Protocol::HTTP)kiwi::Api
createDocument(std::function< void(Api::Response res, Api::Document)> callback, std::string const &document_name="")kiwi::Api
Documents typedef (defined in kiwi::Api)kiwi::Api
getApiRootUrl() constkiwi::Api
getDocuments(std::function< void(Api::Response res, Api::Documents)> callback)kiwi::Api
getHost() constkiwi::Api
getPort() const noexceptkiwi::Api
getProtocolStr() constkiwi::Api
Protocol enum name (defined in kiwi::Api)kiwi::Api
renameDocument(std::function< void(Api::Response res)> callback, std::string document_id, std::string const &new_name)kiwi::Api
Response typedef (defined in kiwi::Api)kiwi::Api
setHost(std::string const &host)kiwi::Api
setPort(uint16_t port) noexceptkiwi::Api
~Api()kiwi::Api
Api(Api::Controller &controller)kiwi::Api
Callback typedef (defined in kiwi::Api)kiwi::Api
CallbackFn typedef (defined in kiwi::Api)kiwi::Api
cancelAll()kiwi::Api
cancelRequest(uint64_t request_id)kiwi::Api
convertDate(std::string const &date)kiwi::Apistatic
createDocument(std::string const &document_name, std::function< void(Response, Api::Document)> callback)kiwi::Api
Documents typedef (defined in kiwi::Api)kiwi::Api
downloadDocument(std::string document_id, Callback success_cb)kiwi::Api
duplicateDocument(std::string const &document_id, Callback callback)kiwi::Api
ErrorCallback typedef (defined in kiwi::Api)kiwi::Api
getDocuments(std::function< void(Response, Api::Documents)> callback)kiwi::Api
getJsonValue(json const &json, std::string const &key, Type default_value={}) (defined in kiwi::Api)kiwi::Apiinlinestatic
getOpenToken(std::string document_id, CallbackFn< std::string const & > success_cb, ErrorCallback error_cb)kiwi::Api
getRelease(CallbackFn< std::string const & > success_cb, ErrorCallback error_cb)kiwi::Api
getUsers(std::unordered_set< uint64_t > const &user_ids, CallbackFn< Api::Users > sucess_cb, ErrorCallback error_cb)kiwi::Api
isPending(uint64_t request_id)kiwi::Api
login(std::string const &username_or_email, std::string const &password, CallbackFn< AuthUser > success_cb, ErrorCallback error_cb)kiwi::Api
renameDocument(std::string document_id, std::string const &new_name, Callback callback)kiwi::Api
requestPasswordToken(std::string const &user_mail, CallbackFn< std::string const & > success_cb, ErrorCallback error_cb)kiwi::Api
resetPassword(std::string const &token, std::string const &newpass, CallbackFn< std::string const & > success_cb, ErrorCallback error_cb)kiwi::Api
Response typedef (defined in kiwi::Api)kiwi::Api
Session typedef (defined in kiwi::Api)kiwi::Api
signup(std::string const &username, std::string const &email, std::string const &password, CallbackFn< std::string > success_cb, ErrorCallback error_cb)kiwi::Api
trashDocument(std::string document_id, Callback callback)kiwi::Api
untrashDocument(std::string document_id, Callback callback)kiwi::Api
uploadDocument(std::string const &name, std::string const &data, std::string const &kiwi_version, std::function< void(Response, Api::Document)> callback)kiwi::Api
Users typedef (defined in kiwi::Api)kiwi::Api
~Api()kiwi::Api
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_api.html b/docs/html/classkiwi_1_1_api.html index b69b1cb8..aa2ce286 100644 --- a/docs/html/classkiwi_1_1_api.html +++ b/docs/html/classkiwi_1_1_api.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::Api Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -66,100 +93,191 @@ Classes | Public Types | Public Member Functions | +Static Public Member Functions | List of all members
kiwi::Api Class Reference
-

An API request handler class. +

A remote API request handler. More...

#include <KiwiApp_Api.h>

- + + + + + + + + +

Classes

struct  Document
class  AuthUser
 
class  Controller
 
class  Document
 
class  Error
 
class  User
 
- - - + + + + + + + + + + + + - - + +

Public Types

enum  Protocol : uint8_t { HTTP = 0, -HTTPS = 1 - }
 
-using Documents = std::vector< Api::Document >
+using Session = network::http::Session
 
+using Response = Session::Response
 
+template<class Type >
using CallbackFn = std::function< void(Type)>
 
+using Callback = CallbackFn< Session::Response >
 
+using ErrorCallback = CallbackFn< Api::Error >
 
+using Documents = std::vector< Api::Document >
 
-using Response = cpr::Response
 
+using Users = std::vector< Api::User >
 
- - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

- Api (std::string const &host, uint16_t port=80, Protocol protocol=Api::Protocol::HTTP)
 Constructor.
 
+
+ Api (Api::Controller &controller)
 Constructor.
 
 ~Api ()
 Destructor.
 
-std::string getProtocolStr () const
 Get the API protocol as a string.
 
-std::string getApiRootUrl () const
 Get the API root URL.
 
-void setHost (std::string const &host)
 Set the API host.
 
-std::string const & getHost () const
 Get the API host.
 
-void setPort (uint16_t port) noexcept
 Set the API port.
 
-uint16_t getPort () const noexcept
 Get the API port.
 
-void getDocuments (std::function< void(Api::Response res, Api::Documents)> callback)
 Make an async API request to get a list of documents.
 
void createDocument (std::function< void(Api::Response res, Api::Document)> callback, std::string const &document_name="")
 Make an async API request to create a new document. More...
 
void renameDocument (std::function< void(Api::Response res)> callback, std::string document_id, std::string const &new_name)
 Rename a document asynchronously. More...
 
+void cancelRequest (uint64_t request_id)
 Cancels a request.
 
+bool isPending (uint64_t request_id)
 Returns true if the request is currently pending.
 
+void cancelAll ()
 Cancel all pending requests.
 
uint64_t login (std::string const &username_or_email, std::string const &password, CallbackFn< AuthUser > success_cb, ErrorCallback error_cb)
 Attempt to log-in the user. More...
 
uint64_t signup (std::string const &username, std::string const &email, std::string const &password, CallbackFn< std::string > success_cb, ErrorCallback error_cb)
 Attempt to register/signup the user. More...
 
+uint64_t getUsers (std::unordered_set< uint64_t > const &user_ids, CallbackFn< Api::Users > sucess_cb, ErrorCallback error_cb)
 Returns a list of users, retrieved with user ids.
 
+uint64_t getDocuments (std::function< void(Response, Api::Documents)> callback)
 Make an async API request to get a list of documents.
 
uint64_t createDocument (std::string const &document_name, std::function< void(Response, Api::Document)> callback)
 Make an async API request to create a new document. More...
 
+uint64_t uploadDocument (std::string const &name, std::string const &data, std::string const &kiwi_version, std::function< void(Response, Api::Document)> callback)
 Uploads a document to the server.
 
+uint64_t duplicateDocument (std::string const &document_id, Callback callback)
 Duplicates a document on server side.
 
uint64_t renameDocument (std::string document_id, std::string const &new_name, Callback callback)
 Rename a document asynchronously. More...
 
+uint64_t trashDocument (std::string document_id, Callback callback)
 Moves a document to trash.
 
+uint64_t untrashDocument (std::string document_id, Callback callback)
 Moves document out of the trash.
 
+uint64_t getOpenToken (std::string document_id, CallbackFn< std::string const & > success_cb, ErrorCallback error_cb)
 Returns the open token used to open document.
 
+uint64_t downloadDocument (std::string document_id, Callback success_cb)
 Make an async API request to download a document.
 
+uint64_t getRelease (CallbackFn< std::string const & > success_cb, ErrorCallback error_cb)
 Retrieve version of kiwi compatible with the api server.
 
+uint64_t requestPasswordToken (std::string const &user_mail, CallbackFn< std::string const & > success_cb, ErrorCallback error_cb)
 Requests a reset token to the server.
 
+uint64_t resetPassword (std::string const &token, std::string const &newpass, CallbackFn< std::string const & > success_cb, ErrorCallback error_cb)
 Sends reset request token to the server.
 
+ + + + + + +

+Static Public Member Functions

+template<class Type >
static Type getJsonValue (json const &json, std::string const &key, Type default_value={})
 
static std::string convertDate (std::string const &date)
 Converts an ISO 8601 received by server. More...
 

Detailed Description

-

An API request handler class.

+

A remote API request handler.

+

This class provide helper methods to work with the remote Kiwi REST API. All operations are done asynchronously.

Member Function Documentation

- -

◆ createDocument()

+ +
+
+ + + + + +
+ + + + + + + + +
std::string kiwi::Api::convertDate (std::string const & date)
+ 		+static
+
+ +

Converts an ISO 8601 received by server.

+

Output format is Y-m-d H:M:S

+
+
+
- + - - + + - - + + @@ -179,21 +297,60 @@

-

◆ renameDocument()

- +

void kiwi::Api::createDocument uint64_t kiwi::Api::createDocument (std::function< void(Api::Response res, Api::Document)> callback, std::string const & document_name,
std::string const & document_name = "" std::function< void(Response, Api::Document)> callback 
- + - - + + + + + + + + + + + + + + + + + + + + + + +
void kiwi::Api::renameDocument uint64_t kiwi::Api::login (std::function< void(Api::Response res)> callback, std::string const & username_or_email,
std::string const & password,
CallbackFn< AuthUser > success_cb,
ErrorCallback error_cb 
)
+
+ +

Attempt to log-in the user.

+
Parameters
+ + + +
username_or_emailuser name or email address
passwordpassword
+
+
+ +
+
+ +
+
+ + + + @@ -201,7 +358,13 @@

- + + + + + + + @@ -219,6 +382,60 @@

+
+
+

uint64_t kiwi::Api::renameDocument ( std::string  document_id,
std::string const & new_name new_name,
Callback callback 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
uint64_t kiwi::Api::signup (std::string const & username,
std::string const & email,
std::string const & password,
CallbackFn< std::string > success_cb,
ErrorCallback error_cb 
)
+
+ +

Attempt to register/signup the user.

+
Parameters
+ + + + +
usernameuser name
emailemail address
passwordpassword
+
+
+
The documentation for this class was generated from the following files:
- + - - - - + +
@@ -85,7 +112,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_beacon_dispatcher.html b/docs/html/classkiwi_1_1_beacon_dispatcher.html index 8943d83d..31155a89 100644 --- a/docs/html/classkiwi_1_1_beacon_dispatcher.html +++ b/docs/html/classkiwi_1_1_beacon_dispatcher.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::BeaconDispatcher Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -80,40 +107,40 @@ - - - - - - - - - - -

Public Member Functions

+
 BeaconDispatcher (engine::Instance &instance)
 Constructor.
 
+
 ~BeaconDispatcher ()
 Destructor.
 
+
void resized () override
 Called when resized.
 
+
void addElem ()
 
+
void removeElem ()
 
+
bool restoreState ()
 
+
void saveState ()
 
+
juce::ApplicationCommandTarget * getNextCommandTarget () override
 
+
void getAllCommands (juce::Array< juce::CommandID > &commands) override
 
+
void getCommandInfo (juce::CommandID commandID, juce::ApplicationCommandInfo &result) override
 
+
bool perform (const InvocationInfo &info) override
 
@@ -126,7 +153,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_beacon_dispatcher_elem-members.html b/docs/html/classkiwi_1_1_beacon_dispatcher_elem-members.html index 87dc048f..ecf09ccd 100644 --- a/docs/html/classkiwi_1_1_beacon_dispatcher_elem-members.html +++ b/docs/html/classkiwi_1_1_beacon_dispatcher_elem-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -82,7 +109,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_beacon_dispatcher_elem.html b/docs/html/classkiwi_1_1_beacon_dispatcher_elem.html index ebad35c6..2b8c9a1c 100644 --- a/docs/html/classkiwi_1_1_beacon_dispatcher_elem.html +++ b/docs/html/classkiwi_1_1_beacon_dispatcher_elem.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::BeaconDispatcherElem Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -86,34 +113,34 @@ - - - - - - - -

Public Member Functions

+
 BeaconDispatcherElem (engine::Instance &instance)
 Constructor.
 
+
 ~BeaconDispatcherElem ()
 Destructor.
 
+
void resized () override
 Called when resized.
 
+
void paint (juce::Graphics &g) override
 juce::Component.
 
+
void buttonClicked (juce::Button *) override
 Called when the button is clicked.
 
+
void setBackgroundColor (juce::Colour const &color)
 Set the background colour.
 
+
void restoreState (juce::XmlElement *saved_state)
 
+
void saveState (juce::XmlElement *saved_state)
 
@@ -128,7 +155,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_beacon_dispatcher_toolbar_factory-members.html b/docs/html/classkiwi_1_1_beacon_dispatcher_toolbar_factory-members.html index d1a5dc37..a93cd00c 100644 --- a/docs/html/classkiwi_1_1_beacon_dispatcher_toolbar_factory-members.html +++ b/docs/html/classkiwi_1_1_beacon_dispatcher_toolbar_factory-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -81,7 +108,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_beacon_dispatcher_toolbar_factory.html b/docs/html/classkiwi_1_1_beacon_dispatcher_toolbar_factory.html index 3c22d43d..5ac03c8c 100644 --- a/docs/html/classkiwi_1_1_beacon_dispatcher_toolbar_factory.html +++ b/docs/html/classkiwi_1_1_beacon_dispatcher_toolbar_factory.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::BeaconDispatcherToolbarFactory Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -81,24 +108,24 @@ -

Public Types

enum  ItemIds { addItem = 1, +
enum  ItemIds { addItem = 1, removeItem = 2 }
 
- - - -

Public Member Functions

+
 BeaconDispatcherToolbarFactory ()
 Constructor.
 
+
void getAllToolbarItemIds (juce::Array< int > &ids) override
 
+
void getDefaultItemSet (juce::Array< int > &ids) override
 
+
juce::ToolbarItemComponent * createItem (int itemId) override
 
@@ -111,7 +138,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_carrier_socket-members.html b/docs/html/classkiwi_1_1_carrier_socket-members.html index ead27a81..5b18fa63 100644 --- a/docs/html/classkiwi_1_1_carrier_socket-members.html +++ b/docs/html/classkiwi_1_1_carrier_socket-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -69,21 +96,22 @@

This is the complete list of members for kiwi::CarrierSocket, including all inherited members.

- - + + - - - - - - + + + + + + +
CarrierSocket(flip::DocumentBase &document, std::string const &host, uint16_t port, uint64_t session_id)kiwi::CarrierSocket
connect(std::string const &host, uint16_t port) (defined in kiwi::CarrierSocket)kiwi::CarrierSocket
CarrierSocket(flip::DocumentBase &document)kiwi::CarrierSocket
connect(std::string const &host, uint16_t port, uint64_t session_id, std::string &metadata) (defined in kiwi::CarrierSocket)kiwi::CarrierSocket
disconnect()kiwi::CarrierSocket
isConnected() constkiwi::CarrierSocket
listenConnected(std::function< void()> func)kiwi::CarrierSocket
listenDisconnected(std::function< void()> func)kiwi::CarrierSocket
listenLoaded(std::function< void()> func)kiwi::CarrierSocket
process()kiwi::CarrierSocket
~CarrierSocket()kiwi::CarrierSocket
isConnected() const kiwi::CarrierSocket
listenStateTransition(state_func_t call_back)kiwi::CarrierSocket
listenTransferBackend(transfer_func_t call_back)kiwi::CarrierSocket
process()kiwi::CarrierSocket
state_func_t typedef (defined in kiwi::CarrierSocket)kiwi::CarrierSocket
transfer_func_t typedef (defined in kiwi::CarrierSocket)kiwi::CarrierSocket
~CarrierSocket()kiwi::CarrierSocket
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_carrier_socket.html b/docs/html/classkiwi_1_1_carrier_socket.html index 58ad921e..ac865964 100644 --- a/docs/html/classkiwi_1_1_carrier_socket.html +++ b/docs/html/classkiwi_1_1_carrier_socket.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::CarrierSocket Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
+Public Types | Public Member Functions | List of all members
@@ -75,40 +103,45 @@

#include <KiwiApp_CarrierSocket.h>

+ + + + + +

+Public Types

+using state_func_t = std::function< void(flip::CarrierBase::Transition, flip::CarrierBase::Error error)>
 
+using transfer_func_t = std::function< void(size_t, size_t)>
 
- - - - - - + + + + + - - - - + + + - - - - - - - - - - + + + + + + @@ -124,7 +157,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_classic_view-members.html b/docs/html/classkiwi_1_1_classic_view-members.html new file mode 100644 index 00000000..072302eb --- /dev/null +++ b/docs/html/classkiwi_1_1_classic_view-members.html @@ -0,0 +1,135 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+

Public Member Functions

- CarrierSocket (flip::DocumentBase &document, std::string const &host, uint16_t port, uint64_t session_id)
 Constructor.
 
-void connect (std::string const &host, uint16_t port)
 
+
+ CarrierSocket (flip::DocumentBase &document)
 Constructor.
 
+void connect (std::string const &host, uint16_t port, uint64_t session_id, std::string &metadata)
 
void disconnect ()
 Stop the socket from processing and disconnect.
 
-bool isConnected () const
 Returns true if the socket is connected, false otherwise.
 
+
+bool isConnected () const
 Returns true if the socket is connected, false otherwise.
 
void process ()
 Process the socket once.
 
-void listenDisconnected (std::function< void()> func)
 Add a callback to be called once disconnected.
 
-void listenConnected (std::function< void()> func)
 Add a callback to be called on connected.
 
-void listenLoaded (std::function< void()> func)
 Add a callback to be called once first load terminated.
 
+
+void listenStateTransition (state_func_t call_back)
 Callback called when transition changes.
 
+void listenTransferBackend (transfer_func_t call_back)
 Callback called receiving backend informations.
 
 ~CarrierSocket ()
 Stops processing.
 
+ + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::ClassicView Member List
+
+
+ +

This is the complete list of members for kiwi::ClassicView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
addListener(Listener &listener)kiwi::EditableObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ClassicView(model::Object &object_model)kiwi::ClassicView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
edit()kiwi::EditableObjectView
EditableObjectView(model::Object &object_model)kiwi::EditableObjectView
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getLabel()kiwi::EditableObjectViewprotected
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
removeListener(Listener &listener)kiwi::EditableObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setEditable(bool editable)kiwi::EditableObjectViewprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~ClassicView()kiwi::ClassicView
~EditableObjectView()kiwi::EditableObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~ObjectView()kiwi::ObjectViewvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_classic_view.html b/docs/html/classkiwi_1_1_classic_view.html new file mode 100644 index 00000000..80d941fa --- /dev/null +++ b/docs/html/classkiwi_1_1_classic_view.html @@ -0,0 +1,228 @@ + + + + + + +Kiwi: kiwi::ClassicView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
kiwi::ClassicView Class Reference
+
+
+ +

The view of any textual kiwi object. + More...

+ +

#include <KiwiApp_ClassicView.h>

+
+Inheritance diagram for kiwi::ClassicView:
+
+
+ + +kiwi::EditableObjectView +kiwi::ObjectView +kiwi::model::Object::Listener + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ ClassicView (model::Object &object_model)
 Constructor.
 
+ ~ClassicView ()
 Destructor.
 
- Public Member Functions inherited from kiwi::EditableObjectView
 EditableObjectView (model::Object &object_model)
 Constructor. More...
 
+ ~EditableObjectView ()
 Destructor.
 
+void addListener (Listener &listener)
 Add a listener.
 
+void removeListener (Listener &listener)
 Remove a listener.
 
+void edit ()
 Edits the label.
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- Protected Member Functions inherited from kiwi::EditableObjectView
+juce::Label & getLabel ()
 Returns the label created by the editable object.
 
void setEditable (bool editable)
 Sets the editable object view as editable or not. More...
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+

Detailed Description

+

The view of any textual kiwi object.

+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ClassicView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ClassicView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_classic_view.png b/docs/html/classkiwi_1_1_classic_view.png new file mode 100644 index 0000000000000000000000000000000000000000..cabad27b58f8c72fc0a355ea1ade58dcfac3693c GIT binary patch literal 2257 zcmbVO2~bn#7QPS-6uD0kD;f|`A1X)$B`ie*qUM-c;#>Z@g9$QWv^Kn)xm5@6zy%3+*oez1d#%8nE zW)B-cQ2m0Jr#Aovtz7-RJ_n#zSa&D1Poj#XY^tQvMAOBZfSg~BNvUf$46bW!Rr};N zK1JBOrc!Tk7unsoN`7Qn_ws3`0}xa&ESmAG%_tod6~Lv^{sK6FEP&&1#h;_>3Uu-k ztBqW4AW9G#em#ER3@(9V<$sK{ygNsL&(O2+Oq6?Pps3NGt~pAjBV)zTFANA(Xy2Fp zr_5S{5PHq$JvAn`1|aTkkNogl9}*n{^I`M@3;XQfb7O;X9dEYM zhvet-)r9>yy3IA})tvSYz9LoMJJjNJJYS^11mYW_(xQ>vChIF2-}o#FL;JBhB!>l? zxB(1J{RWzla-Kj`Zq`BEG*&SEaJ4qK&1%lY61X=W5L(aHpm`OurEq?iZusny+#^#& zyHd+a*<{f|M}63#JN>q`jhr{&d^%!uuT5_RbBKUg8F!-p|p6>u3*S5&dxH=`ELsU>nM`7(0_m z!Ri0VhXcQE<#viAWBBU?Dt&;VZC=Z7{UnJbNyXL?0jMXFYX1c=pydqhzGQD~a)VS1 zfn>*_wHx&Dz~3=}&V6%D*;$gf$g35qzx~uwQJELCtG1mWk5{)71WxS$hedloNArG` zZau84yeHfcEt9jiGE$Uy0dM+f1ioRIHV{7cd_>6RO&^1*tq z)uAE@>!eg-N8?hKX4`o+hl{Lt&k-$OSUI%J-HB+p zQnpVnRo+A=9is%r5V}PQ*QEeZ$RiIcQmvQ*Hm{E^YU00h(gvF!PR`Z$A4ZraZQs2d z|Io`NAyfG?d|qZhaLGt}(;++-m#}O1`?I09)MxH;qQh%A&7&Jp7Nnyvu(zV2Dm^}a zCE^TaYQ1HuNNgNN%Q-BTrE~`O@TQH9=X6(RG2}@E=W~ydSSEhgdcF3s(Qb@d3^I zv1AR<%VTm8a5}qYB1=ryVZbU?94|b)Q!o2%XkPU~Its{o`sP-`LNMu%nz|?suKOo& zJr@P2=Y7HWHo2jGfO@*VAVKAlD+2gC_Ir=H=6%H=-MXqsy57-G6Ne+#JZFm((v?p5 zqa}zks3razU8qN!JPjKiq%NP2wO=eukRc1rF6S8aUM?N9yod6Sej3?y{#{-;l!MpP z4-bNks`b96mgW{D*Dx@6Q6!3-)j?5n<6+~%{YcX|dbxb*iNnFEZLE9yh+9mgLuq3> z1XjA0+{yQak0-T$+IMtjFrKJ1COc+E&BsNCs8$~`&7@>l#}O&1vH{edyvfEXq$jgY znYC=`U-%I(t2q;ra!1}F?y=uy8yUOwqy%y9$7f?9H+ss24CZEevQOwb+M>*+DDr9a ztRITnC1dR}EoDr&XGRUZC5ME^E+BOZN7hSFFVe_gHTN@2H82|feiXP)yu6ab5*xsh zNM>(KImGonf#D5dm+t@2H7Xf@c)P&Zmds9C4)iOD*ncZwOYe;$#3-j4 zvFU5w;(VB(4Y3~SVNGXWEsJyjQIbsREtRDH)DLUPH zMHEt)>vWtunPltjoL9^`?eStD7~=8N+$5K3(Vf=P;$dz*P7B%my>aUR7IcTDV+1|A qC98@Lyn>Yff7;4v0VcSp1YixtkE{ + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::CommentView Member List
+
+
+ +

This is the complete list of members for kiwi::CommentView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
addListener(Listener &listener)kiwi::EditableObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
CommentView(model::Object &object_model)kiwi::CommentView
create(model::Object &object_model)kiwi::CommentViewstatic
declare() (defined in kiwi::CommentView)kiwi::CommentViewstatic
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
edit()kiwi::EditableObjectView
EditableObjectView(model::Object &object_model)kiwi::EditableObjectView
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getLabel()kiwi::EditableObjectViewprotected
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
removeListener(Listener &listener)kiwi::EditableObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setEditable(bool editable)kiwi::EditableObjectViewprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~CommentView()kiwi::CommentView
~EditableObjectView()kiwi::EditableObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~ObjectView()kiwi::ObjectViewvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_comment_view.html b/docs/html/classkiwi_1_1_comment_view.html new file mode 100644 index 00000000..aba18ebe --- /dev/null +++ b/docs/html/classkiwi_1_1_comment_view.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::CommentView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
+
kiwi::CommentView Class Reference
+
+
+ +

The view of any textual kiwi object. + More...

+ +

#include <KiwiApp_CommentView.h>

+
+Inheritance diagram for kiwi::CommentView:
+
+
+ + +kiwi::EditableObjectView +kiwi::ObjectView +kiwi::model::Object::Listener + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ CommentView (model::Object &object_model)
 Constructor.
 
+ ~CommentView ()
 Destructor.
 
- Public Member Functions inherited from kiwi::EditableObjectView
 EditableObjectView (model::Object &object_model)
 Constructor. More...
 
+ ~EditableObjectView ()
 Destructor.
 
+void addListener (Listener &listener)
 Add a listener.
 
+void removeListener (Listener &listener)
 Remove a listener.
 
+void edit ()
 Edits the label.
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + + +

+Static Public Member Functions

+static void declare ()
 
+static std::unique_ptr< ObjectView > create (model::Object &object_model)
 Creation method.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- Protected Member Functions inherited from kiwi::EditableObjectView
+juce::Label & getLabel ()
 Returns the label created by the editable object.
 
void setEditable (bool editable)
 Sets the editable object view as editable or not. More...
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+

Detailed Description

+

The view of any textual kiwi object.

+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_CommentView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_CommentView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_comment_view.png b/docs/html/classkiwi_1_1_comment_view.png new file mode 100644 index 0000000000000000000000000000000000000000..068b94a339a78bf76e87a583a575ed6f859e6d6b GIT binary patch literal 2259 zcmbW32~bnl8pm(o5fHsV+psiX$$N}t6==91M3!i=V8Muh?PCid1_>g_9zh_yRFOgf zLADA=EsHDy3J;X91W*x31;f51U=#w91=$w~z4)e``sU4Z#yj(!d%ip8+;i?ZzyJT- zLLS|Bf$xP8|_|$-OgC}(V64cN1Q1LLH>NiuZH`Oom{nLaZuA9Wgm&-8C7iV z>v`;ys$3Fs&Op03EaqukhvB|q=|bIf`qrSfv7r$i$6~OXaV((l0E@w_#J-=Mf@~YC zBG-C1hA!BEj=}miOeSIE%Ouj;j`dezBN%yeeaePYJd_i-S%Mb|Z!OwO8r3$K_G5Gx z0;)^Bvyt+@KqtJrf@L#m{;qWSPpX@u6!jC{F*BI1&L0<2=bV zZlU*~?9?;ULm5cVvoy9V{D~AIs^lAegeQr{yS47K8duWR)y-}2AscpvD9=t)s!bly z;~wQAQ@hqPk<$ru{hMy{%HpGW(mq5~o*&viG4`SG1VyDlJ9=V#MH(1l!kjho>2j;-@&k?xW z4Lqq?fD9<)2lMBfS67>W{TL9q9U5KX(LBs4P%e}#LQo4EvUTcFpSoZx`BBlbJ3Y(srIH)06~ye1ZA|{_8|Vjg&;4XC-|zO5fxb`4Q$phB?`65I zwi1R{6ZZjTFF}GjDyButl;|ELTG^nM4*wwP<{971J|k0(oR{n&*XL4{;UJZ6Q=w zy#h(U*Fl=xCV|~Pjr^#j&xFEBZm)lhueftoRNIz_^vzo3XElGX`Lkb*v0V1fT_u)R z*Iu(X)w)^O`#0Yn17}1rReS8d)QW@~47Kgl3MeV#o+cd`M$h^s9|y1l%(G3o!N)L5(Pn7jJm2vY7%OkTI~xkDQoXy)XW z`)6794$DPtO7$C)%ILh9p2yr_r^8_Vq$hIR-$CihL8(f*9WA3Vrf=$>B6aBy%E_Uu z;9g$;tpHb)3FwR>Krl=l39YXL(O$#X$zfvZ(&ob|y}>hM0&g9Wqko#_O@9Yx>Pp?| z_)BLu<7d%1xyCOPT#afY%ZlN(K8XS0g@d`so=$+)4fYlx@J_KhsyVqas{dQJf2ufr zck`V5(j33dmd4;T@HWeTc#%;`%%4_-4+{+Xcg5P+_>x2z6#^8NR~-)^@Zs<cDN(MaidcMkp+*`7@=E;YJ4*YykJrz`^PmIBqE zoJIq6uMUDhihZca=FR{x1sf{fu4TvzC+zWE1jqA39dk+|e!9T5G|XQ#(Ub&uuxn;r zE^AYIi+w~o<2e&}s#%?+aT3*RzFA|yFnZUU<@MWJ-t$Q^Fn3YSp!0c%6IEk(Iwy=D z>{x#bStjxt-X?G1HOlOuBhccGMx3y5bB@0B# z?wCz)_Rl2O$gk%OXU~`I8Gqz16@k{vU;$IZb6n64Zt(x?96nc85Poe|rAIUQ*umd= R;Xe@I_%VWY)lsj1{SLVs5mo>I literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_console-members.html b/docs/html/classkiwi_1_1_console-members.html index d79ac127..a0867083 100644 --- a/docs/html/classkiwi_1_1_console-members.html +++ b/docs/html/classkiwi_1_1_console-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -81,7 +108,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console.html b/docs/html/classkiwi_1_1_console.html index 5b44c14a..6c1cc8ba 100644 --- a/docs/html/classkiwi_1_1_console.html +++ b/docs/html/classkiwi_1_1_console.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::Console Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -80,28 +107,28 @@ - - - - - - -

Public Member Functions

+
 Console (sConsoleHistory history)
 Constructor.
 
+
void resized () override
 juce::Component::resized
 
+
void paint (juce::Graphics &g) override
 juce::Component::paint
 
+
juce::ApplicationCommandTarget * getNextCommandTarget () override
 
+
void getAllCommands (juce::Array< juce::CommandID > &commands) override
 
+
void getCommandInfo (juce::CommandID commandID, juce::ApplicationCommandInfo &result) override
 
+
bool perform (const InvocationInfo &info) override
 
@@ -114,7 +141,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console_content-members.html b/docs/html/classkiwi_1_1_console_content-members.html index 4ce0c0c7..cab043a7 100644 --- a/docs/html/classkiwi_1_1_console_content-members.html +++ b/docs/html/classkiwi_1_1_console_content-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -79,7 +106,7 @@ getColumnAutoSizeWidth(int columnId) overridekiwi::ConsoleContent getHistory()kiwi::ConsoleContent getNumRows() overridekiwi::ConsoleContent - getNumSelectedRows() constkiwi::ConsoleContent + getNumSelectedRows() const kiwi::ConsoleContent paint(juce::Graphics &g) override (defined in kiwi::ConsoleContent)kiwi::ConsoleContent paintCell(juce::Graphics &g, int rowNumber, int columnId, int width, int height, bool rowIsSelected) overridekiwi::ConsoleContent paintOverChildren(juce::Graphics &g) overridekiwi::ConsoleContent @@ -101,7 +128,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console_content.html b/docs/html/classkiwi_1_1_console_content.html index 740f6989..3c00f221 100644 --- a/docs/html/classkiwi_1_1_console_content.html +++ b/docs/html/classkiwi_1_1_console_content.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::ConsoleContent Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -87,63 +114,63 @@ - - - - - - - - - - - - + + + - - - - @@ -153,38 +180,38 @@ - - - - - - -

Public Member Functions

+
 ConsoleContent (sConsoleHistory history)
 Constructor.
 
+
 ~ConsoleContent ()
 Destructor.
 
+
sConsoleHistory getHistory ()
 Gets the ConsoleHistory.
 
void consoleHistoryChanged (ConsoleHistory const &history) final override
 The function is called by an hisotry when it has changed. More...
 
+
void resized () override
 
+
void paint (juce::Graphics &g) override
 
+
void selectedRowsChanged (int row) override
 Called when selected rows changed.
 
+
void deleteKeyPressed (int lastRowSelected) override
 Called when the delete key has been pressed.
 
+
int getNumRows () override
 Get the number of rows currently displayed by the console.
 
-int getNumSelectedRows () const
 Get the number of selected rows.
 
+
+int getNumSelectedRows () const
 Get the number of selected rows.
 
void paintRowBackground (juce::Graphics &g, int rowNumber, int width, int height, bool rowIsSelected) override
 This is overloaded from TableListBoxModel, and should fill in the background of the whole row.
 
+
void paintOverChildren (juce::Graphics &g) override
 Paint over cells.
 
+
void backgroundClicked (const juce::MouseEvent &mouse) override
 Called when the console background has been clicked (clear row selection).
 
+
void paintCell (juce::Graphics &g, int rowNumber, int columnId, int width, int height, bool rowIsSelected) override
 This must paint any cells that aren't using custom components.
 
void sortOrderChanged (int newSortColumnId, bool isForwards) override
 This is overloaded from TableListBoxModel,. More...
 
+
void cellDoubleClicked (int rowNumber, int columnId, const juce::MouseEvent &mouse) override
 Called when a cell is double-clicked,.
 
int getColumnAutoSizeWidth (int columnId) override
 This is overloaded from TableListBoxModel. More...
 
+
void scrollToTop ()
 Scroll the list to the top.
 
+
void scrollToBottom ()
 Scroll the list to the bottom.
 
+
void clearAll ()
 Clear all the console content.
 
+
void tableColumnsResized (juce::TableHeaderComponent *tableHeader) override
 This is called when one or more of the table's columns are resized.
 
+
void tableColumnsChanged (juce::TableHeaderComponent *tableHeader) override
 This is called when some of the table's columns are added, removed, hidden, or rearranged.
 
+
void tableSortOrderChanged (juce::TableHeaderComponent *tableHeader) override
 This is called when the column by which the table should be sorted is changed.
 
+
void updateRighmostColumnWidth (juce::TableHeaderComponent *header)
 This is called when the rightmost column width need to be updated.
 
-

Friends

+
class Console
 
@@ -192,9 +219,7 @@

The juce ConsoleContent Component.

The juce Console Component maintain a ConsoleHistory and display Console messages to the user. The user can select a message to copy it to the system clipboard, delete a specific message or a range of messages, sort messages, double-click on a row to hilight the corresponding object...

Member Function Documentation

- -

◆ consoleHistoryChanged()

- +
@@ -228,9 +253,7 @@

-

◆ getColumnAutoSizeWidth()

- +

@@ -257,9 +280,7 @@

-

◆ refreshComponentForCell()

- +

@@ -308,9 +329,7 @@

-

◆ sortOrderChanged()

- +

@@ -356,7 +375,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console_history-members.html b/docs/html/classkiwi_1_1_console_history-members.html index dd4e4ae7..3b2b641b 100644 --- a/docs/html/classkiwi_1_1_console_history-members.html +++ b/docs/html/classkiwi_1_1_console_history-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -78,7 +105,7 @@ erase(size_t index)kiwi::ConsoleHistory erase(size_t begin, size_t last)kiwi::ConsoleHistory erase(std::vector< size_t > &indices)kiwi::ConsoleHistory - get(size_t index)kiwi::ConsoleHistory + get(size_t index)kiwi::ConsoleHistory removeListener(Listener &listener)kiwi::ConsoleHistory size()kiwi::ConsoleHistory sort(Sort type=ByIndex)kiwi::ConsoleHistory @@ -90,7 +117,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console_history.html b/docs/html/classkiwi_1_1_console_history.html index f83db2c4..d98316ed 100644 --- a/docs/html/classkiwi_1_1_console_history.html +++ b/docs/html/classkiwi_1_1_console_history.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::ConsoleHistory Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -103,26 +130,26 @@ - - - - - - - + + + @@ -135,11 +162,11 @@ - - @@ -148,9 +175,7 @@

The Console History listen to the Console and keep an history of the messages.

It expose methods to fetch messages sorted by date, message or by type.

Member Enumeration Documentation

- -

◆ Sort

- +

Public Member Functions

+
 ConsoleHistory (engine::Instance &instance)
 Constructor.
 
+
 ~ConsoleHistory ()
 Destructor.
 
+
void clear ()
 Clear the messages.
 
+
size_t size ()
 Retreives the number of messages in the history.
 
-std::pair< engine::Console::Message const *, size_t > get (size_t index)
 Get a message from the history at a given index.
 
+std::pair< engine::Console::Message const *, size_t > get (size_t index)
 Get a message from the history at a given index.
 
void erase (size_t index)
 Erase a message from the history. More...
 
void sort (Sort type=ByIndex)
 Sort the messages by index, type or text. More...
 
+
void addListener (Listener &listener)
 Add an history listener.
 
+
void removeListener (Listener &listener)
 Remove an history listener.
 
@@ -162,20 +187,21 @@

-

- -
Enumerator
ByIndex 

Sort messages by Index.

+
Enumerator
ByIndex  +

Sort messages by Index.

ByType 

Sort message by type.

+
ByType  +

Sort message by type.

ByText 

Sort message by text.

+
ByText  +

Sort message by text.

Member Function Documentation

- -

◆ erase() [1/3]

- +
@@ -199,9 +225,7 @@

-

◆ erase() [2/3]

- +

@@ -236,9 +260,7 @@

-

◆ erase() [3/3]

- +

@@ -262,9 +284,7 @@

-

◆ sort()

- +

@@ -298,7 +318,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console_history_1_1_listener-members.html b/docs/html/classkiwi_1_1_console_history_1_1_listener-members.html index a952c8a4..146623a8 100644 --- a/docs/html/classkiwi_1_1_console_history_1_1_listener-members.html +++ b/docs/html/classkiwi_1_1_console_history_1_1_listener-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -76,7 +103,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console_history_1_1_listener.html b/docs/html/classkiwi_1_1_console_history_1_1_listener.html index 3cb25d29..adbb1f61 100644 --- a/docs/html/classkiwi_1_1_console_history_1_1_listener.html +++ b/docs/html/classkiwi_1_1_console_history_1_1_listener.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::ConsoleHistory::Listener Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -93,9 +120,7 @@

Detailed Description

The Console History Listener is a is a virtual class you can inherit from to receive console history change notifications.

Member Function Documentation

- -

◆ consoleHistoryChanged()

- +
@@ -137,7 +162,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console_toolbar_factory-members.html b/docs/html/classkiwi_1_1_console_toolbar_factory-members.html index 31227ba4..598f0c79 100644 --- a/docs/html/classkiwi_1_1_console_toolbar_factory-members.html +++ b/docs/html/classkiwi_1_1_console_toolbar_factory-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -82,7 +109,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_console_toolbar_factory.html b/docs/html/classkiwi_1_1_console_toolbar_factory.html index ddf25b06..59e3781d 100644 --- a/docs/html/classkiwi_1_1_console_toolbar_factory.html +++ b/docs/html/classkiwi_1_1_console_toolbar_factory.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::ConsoleToolbarFactory Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -81,7 +108,7 @@ - @@ -89,17 +116,17 @@

Public Types

enum  ItemIds { clear = 1, +
enum  ItemIds { clear = 1, scroll_to_top = 2, scroll_to_bottom = 3 }
- - - -

Public Member Functions

+
 ConsoleToolbarFactory ()
 Constructor.
 
+
void getAllToolbarItemIds (juce::Array< int > &ids) override
 
+
void getDefaultItemSet (juce::Array< int > &ids) override
 
+
juce::ToolbarItemComponent * createItem (int itemId) override
 
@@ -112,7 +139,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_custom_toolbar_button-members.html b/docs/html/classkiwi_1_1_custom_toolbar_button-members.html index f64d7dd8..7390eb09 100644 --- a/docs/html/classkiwi_1_1_custom_toolbar_button-members.html +++ b/docs/html/classkiwi_1_1_custom_toolbar_button-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -82,7 +109,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_custom_toolbar_button.html b/docs/html/classkiwi_1_1_custom_toolbar_button.html index dccf11d1..10ef5d92 100644 --- a/docs/html/classkiwi_1_1_custom_toolbar_button.html +++ b/docs/html/classkiwi_1_1_custom_toolbar_button.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::CustomToolbarButton Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -88,26 +115,26 @@  CustomToolbarButton (int itemId, const juce::String &labelText, const juce::Colour bgcolor, juce::Drawable *normalImage, juce::Drawable *toggledOnImage)  Constructor. More...
  - +  ~CustomToolbarButton ()  Destructor.
  - + bool getToolbarItemSizes (int toolbarDepth, bool isToolbarVertical, int &preferredSize, int &minSize, int &maxSize) override   - + void paintButtonArea (juce::Graphics &, int width, int height, bool isMouseOver, bool isMouseDown) override   - + void contentAreaChanged (const juce::Rectangle< int > &) override   - + void buttonStateChanged () override   - + void resized () override   - + void enablementChanged () override   @@ -115,9 +142,7 @@

A type of button designed to go on a toolbar.

This class is a modified version of the juce::ToolbarButton class.

See also
juce::ToolbarButton, ToolbarItemFactory

Constructor & Destructor Documentation

- -

◆ CustomToolbarButton()

- +
@@ -181,7 +206,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_custom_tooltip_client-members.html b/docs/html/classkiwi_1_1_custom_tooltip_client-members.html index 37873de3..74e1a606 100644 --- a/docs/html/classkiwi_1_1_custom_tooltip_client-members.html +++ b/docs/html/classkiwi_1_1_custom_tooltip_client-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -77,7 +104,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_custom_tooltip_client.html b/docs/html/classkiwi_1_1_custom_tooltip_client.html index 24d8ccb9..5f61f9d8 100644 --- a/docs/html/classkiwi_1_1_custom_tooltip_client.html +++ b/docs/html/classkiwi_1_1_custom_tooltip_client.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::CustomTooltipClient Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -86,15 +113,15 @@ - - - @@ -110,7 +137,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser-members.html b/docs/html/classkiwi_1_1_document_browser-members.html index a799296f..2ac384d1 100644 --- a/docs/html/classkiwi_1_1_document_browser-members.html +++ b/docs/html/classkiwi_1_1_document_browser-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

Public Member Functions

+
virtual ~CustomTooltipClient ()=default
 Destructor.
 
+
virtual juce::Rectangle< int > getTooltipBounds (juce::String const &tip, juce::Point< int > pos, juce::Rectangle< int > parent_area, int width, int height)=0
 Returns the bounds of the tooltip to show.
 
+
virtual bool drawTooltip (juce::Graphics &g, juce::String const &text, int width, int height)
 Can be overriden to provide a custom drawing method.
 
- + - - - - + +
@@ -69,22 +96,17 @@

This is the complete list of members for kiwi::DocumentBrowser, including all inherited members.

- - - - - - - + + + -
addListener(Listener &listener)kiwi::DocumentBrowser
DocumentBrowser()kiwi::DocumentBrowser
getDrives() constkiwi::DocumentBrowser
process()kiwi::DocumentBrowser
removeListener(Listener &listener)kiwi::DocumentBrowser
start(const int interval=5000)kiwi::DocumentBrowser
stop()kiwi::DocumentBrowser
DocumentBrowser(std::string const &drive_name, int refresh_time)kiwi::DocumentBrowser
getDrive() const kiwi::DocumentBrowser
setDriveName(std::string const &name)kiwi::DocumentBrowser
timerCallback() overridekiwi::DocumentBrowser
~DocumentBrowser()kiwi::DocumentBrowser
~Listener()=defaultkiwi::NetworkSettings::Listenervirtual
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser.html b/docs/html/classkiwi_1_1_document_browser.html index 6f09399e..a5b01498 100644 --- a/docs/html/classkiwi_1_1_document_browser.html +++ b/docs/html/classkiwi_1_1_document_browser.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DocumentBrowser Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -81,7 +108,6 @@
-kiwi::NetworkSettings::Listener
@@ -89,53 +115,29 @@ Classes - - -
class  Drive
 
struct  Listener
 Listen to document explorer changes. More...
 
- - - - + + + - - - - - - - - - - + + + - - - - - - - - - - - - - + + +

Public Member Functions

- DocumentBrowser ()
 Constructor.
 
+
+ DocumentBrowser (std::string const &drive_name, int refresh_time)
 Constructor.
 
 ~DocumentBrowser ()
 Destructor.
 
-void start (const int interval=5000)
 start processing
 
-void stop ()
 stop processing
 
-void process ()
 Scan the LAN to find a service provider.
 
+
+void setDriveName (std::string const &name)
 Sets the drive's name.
 
void timerCallback () override
 juce::Timer callback.
 
-std::vector< Drive * > getDrives () const
 Returns a list of drives.
 
-void addListener (Listener &listener)
 Add a listener.
 
-void removeListener (Listener &listener)
 remove a listener.
 
- Public Member Functions inherited from kiwi::NetworkSettings::Listener
-virtual ~Listener ()=default
 Destructor.
 
+Drive * getDrive () const
 Returns a list of drives.
 

Detailed Description

Request Patcher document informations through a Kiwi API.

@@ -148,7 +150,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser.png b/docs/html/classkiwi_1_1_document_browser.png index fc2e45326c1bc0f8e09207270a6b20906230f297..65badba373536560b8898b23249a68242093c17e 100644 GIT binary patch delta 485 zcmaFJKAAw!z7srqa#bX|#Tw)ib=k7FhsSoFp0|`Exj-JVpHSmmTy)to02MC|G`t5mP z^Xi?#bN>rmzioBfpEGc6&O@!-aQ0f4^x5~Oa!o&8qh|HCNadx?`Bzh(#JN8&>-+yH zZR=!J&+rrdEh?@{`hd6|L;!J)Ra)9!Ha3Me)>3=n2=2~X94O}ak1twZC2(An6zIXP0_9^B$39kzl-e1C8u)xOZ_2+Ar z_t#(7yuLds^Ww+)`?XuQ-q5Uz-v`XBKA z_tnrZ-gDf(*Y{Y>KR4M`e(t%&{pT!7uKzhXS8>{BskzHbU%hcQmSCRybKmcMALGqe z-`P@QAvt%aWDlc!t;DO@=Qd0~>}bz+hneYG?B&b)R>wV9XPYj)RVe<O+ZQ_z$e7@|Ns9$=8HF9OZyK^ z0J6aNz<~p-opc_wQ z8m+G83AfLN&9N;?zPN}ZW7f$J)29SU@t!jDy=)@2q;lT#jT=s>X6iWYRM{zXO7-N_ z06oujEk&M1Pv@QrwtIG4d}HXmGdH)D$ldh&cH{Q-_yE&qN}jcSh4E+W!>9cIlR8gx z`jWPs54%s@J{PaK$L_!A)6<#UUu!nE{Jr+=*!PmD`Kf>RN(z@QE!?`_{o^^gOWE_i z9j2f2p1b^+fUM@t1?^y7a=QmuiIW)jN7s?qT{C z^_Mz(wRd}XZd&>-QulIhVBNGsHs?P_ztFH3I&`&VicjFBttM`tT$g`dnzeY3PT1|A z2V8${TljC&C)*drex8$b*M3rd9Ao`mX`8Rk*M#Ed%m4J%eyvQpxw$BQC#U=6mA=OQ zms({DX5QZx*8FyQh1U0uPi7g~s%9@#mfE$?uM^8Es#M=-bJ}TM;J!4m=^E?5yK2r1 z`uF{LSmd-v1v!@w{7kW2yY!SsDA&r(9y9O1WB;aVt}*|4<-Yl0J5?$Zzx#PsfdcjZ zGOx%kt)6jozn^nAZbLpB{*R%HOohqKb_GXW9@|)WY zt7vLPfd|mF8>%V+HPdvT) z|B+HzZU$MWpYc=D4~H77Xq|cWX67mt%?7^t^CPx(8{6-fczQj}BV@|W)hqvnKMl>> zT5ElBA&Z$xu%5s5soNd@`-M-ZR%aW#onsDleWX*p`EIDMo__PW-`?5|?dL=JKKR4J n4NI7$Ry@^QY9hg4{)yfG`qVksN;_Wz^CN?&tDnm{r-UW|nfle< diff --git a/docs/html/classkiwi_1_1_document_browser_1_1_drive-members.html b/docs/html/classkiwi_1_1_document_browser_1_1_drive-members.html index e30e5581..e20e8c51 100644 --- a/docs/html/classkiwi_1_1_document_browser_1_1_drive-members.html +++ b/docs/html/classkiwi_1_1_document_browser_1_1_drive-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -73,28 +100,22 @@ createNewDocument()kiwi::DocumentBrowser::Drive DocumentBrowser (defined in kiwi::DocumentBrowser::Drive)kiwi::DocumentBrowser::Drivefriend DocumentSessions typedef (defined in kiwi::DocumentBrowser::Drive)kiwi::DocumentBrowser::Drive - Drive(std::string const &name, std::string const &host, uint16_t api_port, uint16_t session_port) (defined in kiwi::DocumentBrowser::Drive)kiwi::DocumentBrowser::Drive - getApiPort() constkiwi::DocumentBrowser::Drive - getDocuments() constkiwi::DocumentBrowser::Drive - getDocuments()kiwi::DocumentBrowser::Drive - getHost() constkiwi::DocumentBrowser::Drive - getName() constkiwi::DocumentBrowser::Drive - getSessionPort() constkiwi::DocumentBrowser::Drive - operator==(Drive const &drive) constkiwi::DocumentBrowser::Drive + Drive(std::string const &name) (defined in kiwi::DocumentBrowser::Drive)kiwi::DocumentBrowser::Drive + getDocuments() const kiwi::DocumentBrowser::Drive + getDocuments()kiwi::DocumentBrowser::Drive + getName() const kiwi::DocumentBrowser::Drive refresh()kiwi::DocumentBrowser::Drive removeListener(Listener &listener)kiwi::DocumentBrowser::Drive - setApiPort(uint16_t port)kiwi::DocumentBrowser::Drive - setHost(std::string const &host)kiwi::DocumentBrowser::Drive setName(std::string const &host)kiwi::DocumentBrowser::Drive - setSessionPort(uint16_t port)kiwi::DocumentBrowser::Drive - useApi()kiwi::DocumentBrowser::Drive + setSort(Comp comp)kiwi::DocumentBrowser::Drive + uploadDocument(std::string const &name, std::string const &data)kiwi::DocumentBrowser::Drive ~Drive()=default (defined in kiwi::DocumentBrowser::Drive)kiwi::DocumentBrowser::Drive
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser_1_1_drive.html b/docs/html/classkiwi_1_1_document_browser_1_1_drive.html index 318d4f48..fd46026b 100644 --- a/docs/html/classkiwi_1_1_document_browser_1_1_drive.html +++ b/docs/html/classkiwi_1_1_document_browser_1_1_drive.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DocumentBrowser::Drive Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -83,107 +110,62 @@ - - + +

Public Types

-using DocumentSessions = std::vector< std::unique_ptr< DocumentSession > >
 
+using DocumentSessions = std::vector< std::unique_ptr< DocumentSession >>
 
- - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - - - + + + + + + - - - -

Public Member Functions

- Drive (std::string const &name, std::string const &host, uint16_t api_port, uint16_t session_port)
 
+
+ Drive (std::string const &name)
 
void addListener (Listener &listener)
 Add a listener.
 
+
void removeListener (Listener &listener)
 remove a listener.
 
-Api & useApi ()
 Returns the API object reference.
 
-void setApiPort (uint16_t port)
 Set the kiwi api port.
 
-uint16_t getApiPort () const
 Returns the kiwi api port.
 
-void setSessionPort (uint16_t port)
 Set the kiwi document session port.
 
-uint16_t getSessionPort () const
 Returns the kiwi document session port.
 
-void setHost (std::string const &host)
 Set both the api's and session's host.
 
-std::string const & getHost () const
 Returns the session host.
 
+
void setName (std::string const &host)
 Set the name of this drive.
 
-std::string const & getName () const
 Returns the name of this drive.
 
+
+std::string const & getName () const
 Returns the name of this drive.
 
+void uploadDocument (std::string const &name, std::string const &data)
 Uploads a document. data is represented as a string.
 
void createNewDocument ()
 Creates and opens a new document on this drive.
 
-DocumentSessions const & getDocuments () const
 Returns the documents.
 
+
+void setSort (Comp comp)
 Changes the way documents are sorted.
 
+DocumentSessions const & getDocuments () const
 Returns the documents.
 
DocumentSessions & getDocuments ()
 Returns the documents.
 
bool operator== (Drive const &drive) const
 Returns true if the drive match the other drive. More...
 
+
void refresh ()
 Refresh all the document list.
 
-

Friends

+
class DocumentBrowser
 
-

Member Function Documentation

- -

◆ operator==()

- -
-
- - - - - - - - -
bool kiwi::DocumentBrowser::Drive::operator== (Drive const & drive) const
-
- -

Returns true if the drive match the other drive.

-

this operator only compares ip and port.

- -
-
The documentation for this class was generated from the following files:
  • Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.h
  • Client/Source/KiwiApp_Network/KiwiApp_DocumentBrowser.cpp
    • @@ -193,7 +175,7 @@

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1_document_browser_1_1_drive_1_1_document_session-members.html b/docs/html/classkiwi_1_1_document_browser_1_1_drive_1_1_document_session-members.html index a96e142f..1ff4909d 100644 --- a/docs/html/classkiwi_1_1_document_browser_1_1_drive_1_1_document_session-members.html +++ b/docs/html/classkiwi_1_1_document_browser_1_1_drive_1_1_document_session-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -71,22 +98,31 @@ - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
DocumentBrowser::Drive (defined in kiwi::DocumentBrowser::Drive::DocumentSession)kiwi::DocumentBrowser::Drive::DocumentSessionfriend
DocumentSession(DocumentBrowser::Drive &parent, Api::Document document)kiwi::DocumentBrowser::Drive::DocumentSession
getHost() constkiwi::DocumentBrowser::Drive::DocumentSession
getName() constkiwi::DocumentBrowser::Drive::DocumentSession
getSessionId() constkiwi::DocumentBrowser::Drive::DocumentSession
getSessionPort() constkiwi::DocumentBrowser::Drive::DocumentSession
open()kiwi::DocumentBrowser::Drive::DocumentSession
operator==(DocumentSession const &other_doc) constkiwi::DocumentBrowser::Drive::DocumentSession
rename(std::string const &new_name)kiwi::DocumentBrowser::Drive::DocumentSession
useDrive()kiwi::DocumentBrowser::Drive::DocumentSession
useDrive() constkiwi::DocumentBrowser::Drive::DocumentSession
~DocumentSession()kiwi::DocumentBrowser::Drive::DocumentSession
download(std::function< void(std::string const &)> callback)kiwi::DocumentBrowser::Drive::DocumentSession
duplicate()kiwi::DocumentBrowser::Drive::DocumentSession
getAuthor() const kiwi::DocumentBrowser::Drive::DocumentSession
getCreationDate() const kiwi::DocumentBrowser::Drive::DocumentSession
getName() const kiwi::DocumentBrowser::Drive::DocumentSession
getOpenedDate() const kiwi::DocumentBrowser::Drive::DocumentSession
getOpenedUser() const kiwi::DocumentBrowser::Drive::DocumentSession
getOpenToken() const kiwi::DocumentBrowser::Drive::DocumentSession
getSessionId() const kiwi::DocumentBrowser::Drive::DocumentSession
getTrashedDate() const kiwi::DocumentBrowser::Drive::DocumentSession
isTrashed() const kiwi::DocumentBrowser::Drive::DocumentSession
open()kiwi::DocumentBrowser::Drive::DocumentSession
operator==(DocumentSession const &other_doc) const kiwi::DocumentBrowser::Drive::DocumentSession
rename(std::string const &new_name)kiwi::DocumentBrowser::Drive::DocumentSession
trash()kiwi::DocumentBrowser::Drive::DocumentSession
untrash() (defined in kiwi::DocumentBrowser::Drive::DocumentSession)kiwi::DocumentBrowser::Drive::DocumentSession
useDrive()kiwi::DocumentBrowser::Drive::DocumentSession
useDrive() const kiwi::DocumentBrowser::Drive::DocumentSession
~DocumentSession()kiwi::DocumentBrowser::Drive::DocumentSession
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser_1_1_drive_1_1_document_session.html b/docs/html/classkiwi_1_1_document_browser_1_1_drive_1_1_document_session.html index a14c606b..237bf9c6 100644 --- a/docs/html/classkiwi_1_1_document_browser_1_1_drive_1_1_document_session.html +++ b/docs/html/classkiwi_1_1_document_browser_1_1_drive_1_1_document_session.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DocumentBrowser::Drive::DocumentSession Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -73,60 +100,111 @@ - + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

- DocumentSession (DocumentBrowser::Drive &parent, Api::Document document)
+ DocumentSession (DocumentBrowser::Drive &parent, Api::Document document)
 Constructor.
 
+
 ~DocumentSession ()
 Destructor.
 
+
Drive & useDrive ()
 Returns the document drive.
 
+
void open ()
 Tells the Kiwi instance to open up this document.
 
-std::string getName () const
 Returns the document name.
 
-std::string getHost () const
 Returns the document session host.
 
-uint64_t getSessionId () const
 Returns the session id of the document.
 
-uint16_t getSessionPort () const
 Returns the document session port.
 
-DocumentBrowser::Drive const & useDrive () const
 Returns the drive that holds this document.
 
+
+std::string getName () const
 Returns the document name.
 
+uint64_t getSessionId () const
 Returns the session id of the document.
 
+std::string const & getOpenToken () const
 Returns the open token of the document.
 
+DocumentBrowser::Drive const & useDrive () const
 Returns the drive that holds this document.
 
void rename (std::string const &new_name)
 Rename the document.
 
bool operator== (DocumentSession const &other_doc) const
 Returns true if the DocumentSession match another DocumentSession. More...
 
+void duplicate ()
 Duplicates the document on server side.
 
+void trash ()
 Move the document to trash.
 
+void untrash ()
 
void download (std::function< void(std::string const &)> callback)
 Called to download the document. More...
 
+std::string const & getCreationDate () const
 Returns the date creation as a string.
 
+std::string const & getAuthor () const
 Returns the author's username.
 
+bool isTrashed () const
 Returns true if document is trashed.
 
+std::string const & getTrashedDate () const
 Returns trashed date as string.
 
+std::string const & getOpenedDate () const
 Returns the last modification date.
 
+std::string const & getOpenedUser () const
 Returns the user that modified document last.
 
bool operator== (DocumentSession const &other_doc) const
 Returns true if the DocumentSession match another DocumentSession. More...
 
-

Friends

+
class DocumentBrowser::Drive
 

Member Function Documentation

- -

◆ operator==()

+ +
+
+ + + + + + + + +
void kiwi::DocumentBrowser::Drive::DocumentSession::download (std::function< void(std::string const &)> callback)
+
+ +

Called to download the document.

+

download is asynchronous and callback is called on the main thread if request succeed.

+
+
+
@@ -154,7 +232,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser_view-members.html b/docs/html/classkiwi_1_1_document_browser_view-members.html index 00daec30..d433207e 100644 --- a/docs/html/classkiwi_1_1_document_browser_view-members.html +++ b/docs/html/classkiwi_1_1_document_browser_view-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -69,20 +96,16 @@

This is the complete list of members for kiwi::DocumentBrowserView, including all inherited members.

- - - - - - - - + + + +
DocumentBrowserView(DocumentBrowser &browser)kiwi::DocumentBrowserView
driveAdded(DocumentBrowser::Drive &drive) overridekiwi::DocumentBrowserViewvirtual
driveChanged(DocumentBrowser::Drive const &drive) overridekiwi::DocumentBrowserViewvirtual
driveRemoved(DocumentBrowser::Drive const &drive) overridekiwi::DocumentBrowserViewvirtual
paint(juce::Graphics &g) overridekiwi::DocumentBrowserView
resized() overridekiwi::DocumentBrowserView
~DocumentBrowserView()kiwi::DocumentBrowserView
~Listener()=defaultkiwi::DocumentBrowser::Listenervirtual
DocumentBrowserView(DocumentBrowser &browser, bool enabled)kiwi::DocumentBrowserView
paint(juce::Graphics &g) overridekiwi::DocumentBrowserView
resized() overridekiwi::DocumentBrowserView
~DocumentBrowserView()kiwi::DocumentBrowserView
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser_view.html b/docs/html/classkiwi_1_1_document_browser_view.html index cb098f78..9f0b5f41 100644 --- a/docs/html/classkiwi_1_1_document_browser_view.html +++ b/docs/html/classkiwi_1_1_document_browser_view.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DocumentBrowserView Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -76,7 +103,6 @@
-kiwi::DocumentBrowser::Listener
@@ -88,39 +114,22 @@
- - - - + + + - - - - - - - - - - - - - - -

Public Member Functions

- DocumentBrowserView (DocumentBrowser &browser)
 Constructor.
 
+
+ DocumentBrowserView (DocumentBrowser &browser, bool enabled)
 Constructor.
 
 ~DocumentBrowserView ()
 Destructor.
 
-void driveAdded (DocumentBrowser::Drive &drive) override
 Called when the document list changed.
 
-void driveChanged (DocumentBrowser::Drive const &drive) override
 Called when a drive changed.
 
-void driveRemoved (DocumentBrowser::Drive const &drive) override
 Called when the document list changed.
 
+
void resized () override
 Called when resized.
 
+
void paint (juce::Graphics &g) override
 juce::Component::paint
 
- Public Member Functions inherited from kiwi::DocumentBrowser::Listener
-virtual ~Listener ()=default
 Destructor.
 
The documentation for this class was generated from the following files:
  • Client/Source/KiwiApp_Application/KiwiApp_DocumentBrowserView.h
    • @@ -131,7 +140,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1_document_browser_view.png b/docs/html/classkiwi_1_1_document_browser_view.png index 79e5567987756edf6630b33b679fe130952b50b5..5d5d62f95cb7612bd09189aee165791bf61efcf1 100644 GIT binary patch delta 561 zcmZ3*agRl@Gr-TCmrII^fq{Y7)59eQNUs9o01jp#xo@G|`H6~F^^9*lT^vIy7~jr~ z6?&u~z*Zgi=Ux3{(}N7oCEkxRbhie(dMof`*3}+8lf!G^8PymvbxB50=%htE*X^3? z={f6p){W4swr`@|^oK@=%#696CC8sC;{J7INvWw_m@e1s!_&UCr~Tcf;yJlxW!cNQ zK9kgbPRz1w_FmDKtC~5jKfk_V@~i6K4nW~QakhNrzRsl!_5c20o3Lbg&HMBEp{km* z3PL@9@vYSIytrhQifeJWsc|$@Lq#4#_J+P!Z@2ZlwpvwwIW$H*=&Uq@!n_dH4z*Cm zMV_Gz89|~7vv70&RfigHHa)-)R<8h6zbflw)%#yDeewrbzBioQk@Z0-Er8WxJttk`O; z*2+rgTguM4yu^aPJo0C+&AK-g%v&ypOur&uus!^C?8W%K5}qu4LN&e c+5>)P^|WV4vJzN;iGabA-PO-!ol`;+0L_a6%m4rY literal 1066 zcmeAS@N?(olHy`uVBq!ia0y~yVC(_112~w0q;1Zo89+)Rz$e7@|Ns9$=8HF9OZyK^ z0J6aNz<~p-op9hQi61>Z zU;eCECHMUK{(aLXo{5*1)IZkWaYAq&XZq(`^5TM(N8M9=g6GVBUTx&!66O;xyY`jF zGj<` zHYr@QZ6+tzon6zDIxp=}=qdNqCrbUHa<@wY_rAHma@D+aZ@16@?uh#zo+jP(b65ACvb~o<3Z0Jy?b@ev+vv@y7g=G4PtUx#X7Rm(h4GT> z?>A2R#BKB`^L@12x>{i|&r1n=&i;G| zJ-3#Xsr~z5Hg)^Fo%yvT4}12WW)2BGze#hkWy1B}{`W#>`AxcF*8X;9-npJhA@8qW z%=6cB-#z!nvKqg(Rj=6M=lq(=BRJ7p2pEua1VF@xP{~!R;?+}Dtg=!>B_75Z1$n(Z zB_Vm(fG3>o!D<_ZcL%@9tEMpgc<^yYZ|`e+uM-R(4t{2Qm-P5ozmO5b9RYTW24N>Q z!dR~V_+vc=7KZg5MvNAUDGcP`J)T~gu~H4Y3%<5wzg{|H&&;1OJ`NuX>lZtkJjP&9T=? z%KS4Ashxjv#gpr9#({0OPp{z0Vm!Mou={dp@YmVZv!`okvzBk3F4(&=&*Z|E-KQhG zu3Nq^|NP5!Z#Gx8Y-P+m5BJ+pl?e z9wQ|34OFB~y*V3_E%|l6QTz4z)(6b{&WcxiFx?Kb=20n&l)t$5+g#zt`X^rWovHhO za<|vzi7RsXZWrI3BdNObUU{H)vZ>UDx6h0i);XVGC~(4o5A97^GUd`##vgY78J(Hu V9V~HRb^vB<22WQ%mvv4FO#q&a+(-Zb diff --git a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view-members.html b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view-members.html index 7074a838..5434b524 100644 --- a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view-members.html +++ b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -70,20 +97,26 @@

This is the complete list of members for kiwi::DocumentBrowserView::DriveView, including all inherited members.

+ + - - - - - - - + + + + + + + + + - + + +
backgroundClicked(juce::MouseEvent const &e) overridekiwi::DocumentBrowserView::DriveView
deleteDocumentForRow(int row)kiwi::DocumentBrowserView::DriveView
disable()kiwi::DocumentBrowserView::DriveView
documentAdded(DocumentBrowser::Drive::DocumentSession &doc)kiwi::DocumentBrowser::Drive::Listenerinlinevirtual
documentChanged(DocumentBrowser::Drive::DocumentSession &doc)kiwi::DocumentBrowser::Drive::Listenerinlinevirtual
documentRemoved(DocumentBrowser::Drive::DocumentSession &doc)kiwi::DocumentBrowser::Drive::Listenerinlinevirtual
driveChanged() overridekiwi::DocumentBrowserView::DriveViewvirtual
DriveView(DocumentBrowser::Drive &drive)kiwi::DocumentBrowserView::DriveView
getHostName() constkiwi::DocumentBrowserView::DriveView
getNumRows() overridekiwi::DocumentBrowserView::DriveView
listBoxItemDoubleClicked(int row, juce::MouseEvent const &e) overridekiwi::DocumentBrowserView::DriveView
openDocument(int row)kiwi::DocumentBrowserView::DriveView
operator==(DocumentBrowser::Drive const &other_drive) constkiwi::DocumentBrowserView::DriveView
downloadDocumentForRow(int row)kiwi::DocumentBrowserView::DriveView
driveChanged() overridekiwi::DocumentBrowserView::DriveViewvirtual
DriveView(DocumentBrowser::Drive &drive)kiwi::DocumentBrowserView::DriveView
duplicateDocumentForRow(int row)kiwi::DocumentBrowserView::DriveView
enable()kiwi::DocumentBrowserView::DriveView
getHostName() const kiwi::DocumentBrowserView::DriveView
getNumRows() overridekiwi::DocumentBrowserView::DriveView
listBoxItemDoubleClicked(int row, juce::MouseEvent const &e) overridekiwi::DocumentBrowserView::DriveView
openDocument(int row)kiwi::DocumentBrowserView::DriveView
paintListBoxItem(int rowNumber, juce::Graphics &g, int width, int height, bool selected) overridekiwi::DocumentBrowserView::DriveView
refreshComponentForRow(int row, bool selected, juce::Component *component_to_update) overridekiwi::DocumentBrowserView::DriveView
renameDocumentForRow(int row, std::string const &new_name)kiwi::DocumentBrowserView::DriveView
returnKeyPressed(int last_row_selected) overridekiwi::DocumentBrowserView::DriveView
restoreDocumentForRow(int row)kiwi::DocumentBrowserView::DriveView
returnKeyPressed(int last_row_selected) overridekiwi::DocumentBrowserView::DriveView
uploadDocument()kiwi::DocumentBrowserView::DriveView
~DriveView()kiwi::DocumentBrowserView::DriveView
~Listener()=defaultkiwi::DocumentBrowser::Drive::Listenervirtual
@@ -91,7 +124,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view.html b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view.html index 53dd0b14..45e17bbc 100644 --- a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view.html +++ b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DocumentBrowserView::DriveView Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -94,70 +121,94 @@ - - - - - + + + - + + + + + + - - - - - - - - - + + + + + + + + + + + + + + + - - - - @@ -165,9 +216,7 @@

Detailed Description

Listen to document browser changes.

Member Function Documentation

- -

◆ driveChanged()

- +

Public Member Functions

+
 DriveView (DocumentBrowser::Drive &drive)
 Constructor.
 
+
 ~DriveView ()
 Destructor.
 
-std::string getHostName () const
 Returns the session host name.
 
+std::string getHostName () const
 Returns the session host name.
 
void driveChanged () override
 Called by the DocumentBrowser::Drive changed. More...
 
+
+void disable ()
 Disable the display of document and their modification.
 
+void enable ()
 Enable the display of documents and their modification.
 
int getNumRows () override
 Returns the number of items in the list.
 
void paintListBoxItem (int rowNumber, juce::Graphics &g, int width, int height, bool selected) override
 Draw a row of the list. More...
 
+
juce::Component * refreshComponentForRow (int row, bool selected, juce::Component *component_to_update) override
 Used to create or update a custom component to go in a row of the list.
 
+
void backgroundClicked (juce::MouseEvent const &e) override
 Called when the user clicking on a part of the list where there are no rows.
 
+
void returnKeyPressed (int last_row_selected) override
 Called when the return key is pressed.
 
+
void listBoxItemDoubleClicked (int row, juce::MouseEvent const &e) override
 Called when the user double-clicking on a row.
 
-bool operator== (DocumentBrowser::Drive const &other_drive) const
 Returns true if the two drive view refer to the same drive.
 
+
void openDocument (int row)
 Opens document for the given row.
 
+
+void duplicateDocumentForRow (int row)
 Make an API call to duplicate the document on server side.
 
void renameDocumentForRow (int row, std::string const &new_name)
 Make an API call to rename the remote document.
 
+void uploadDocument ()
 Makes an API call to upload a document.
 
+void downloadDocumentForRow (int row)
 Makes an API call to download the remote document.
 
+void deleteDocumentForRow (int row)
 Moves a document to trash.
 
+void restoreDocumentForRow (int row)
 Restore a trashed document.
 
- Public Member Functions inherited from kiwi::DocumentBrowser::Drive::Listener
+
virtual ~Listener ()=default
 Destructor.
 
+
virtual void documentAdded (DocumentBrowser::Drive::DocumentSession &doc)
 Called when a document session has been added.
 
+
virtual void documentChanged (DocumentBrowser::Drive::DocumentSession &doc)
 Called when a document session changed.
 
+
virtual void documentRemoved (DocumentBrowser::Drive::DocumentSession &doc)
 Called when a document session has been removed.
 
@@ -195,9 +244,7 @@

-

◆ paintListBoxItem()

- +

@@ -261,7 +308,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_header-members.html b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_header-members.html index 830cad1d..a8ffce75 100644 --- a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_header-members.html +++ b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_header-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -69,17 +96,18 @@

This is the complete list of members for kiwi::DocumentBrowserView::DriveView::Header, including all inherited members.

- + - + +
Header(juce::ListBox &listbox, DocumentBrowser::Drive &drive)kiwi::DocumentBrowserView::DriveView::Header
Header(DocumentBrowserView::DriveView &drive_view)kiwi::DocumentBrowserView::DriveView::Header
mouseDown(juce::MouseEvent const &event) overridekiwi::DocumentBrowserView::DriveView::Header
paint(juce::Graphics &g) overridekiwi::DocumentBrowserView::DriveView::Header
resized() overridekiwi::DocumentBrowserView::DriveView::Header
~Header()=defaultkiwi::DocumentBrowserView::DriveView::Header
setText(std::string const &text)kiwi::DocumentBrowserView::DriveView::Header
~Header()=defaultkiwi::DocumentBrowserView::DriveView::Header
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_header.html b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_header.html index 0e6983a0..ac5170d7 100644 --- a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_header.html +++ b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_header.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DocumentBrowserView::DriveView::Header Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -80,26 +107,30 @@ - - - - + + + - - - + + +

Public Member Functions

- Header (juce::ListBox &listbox, DocumentBrowser::Drive &drive)
 Constructor.
 
+
+ Header (DocumentBrowserView::DriveView &drive_view)
 Constructor.
 
 ~Header ()=default
 Destructor.
 
+
void paint (juce::Graphics &g) override
 juce::Component::paint
 
+
void resized () override
 juce::Component::resized
 
+
void mouseDown (juce::MouseEvent const &event) override
 juce::Component::mouseDown
 
+void setText (std::string const &text)
 Sets the text diaplyed by the header bar.
 
The documentation for this class was generated from the following files:
  • Client/Source/KiwiApp_Application/KiwiApp_DocumentBrowserView.h
    • @@ -110,7 +141,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem-members.html b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem-members.html index 89c1991e..3bd82ad6 100644 --- a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem-members.html +++ b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -77,16 +104,16 @@ mouseUp(juce::MouseEvent const &event) overridekiwi::DocumentBrowserView::DriveView::RowElem paint(juce::Graphics &g) overridekiwi::DocumentBrowserView::DriveView::RowElem resized() overridekiwi::DocumentBrowserView::DriveView::RowElem - RowElem(DriveView &drive_view, std::string const &name)kiwi::DocumentBrowserView::DriveView::RowElem + RowElem(DriveView &drive_view, std::string const &name, std::string const &tooltip)kiwi::DocumentBrowserView::DriveView::RowElem showEditor()kiwi::DocumentBrowserView::DriveView::RowElem - update(std::string const &name, int row, bool now_selected)kiwi::DocumentBrowserView::DriveView::RowElem + update(std::string const &name, std::string const &tooltip, int row, bool now_selected)kiwi::DocumentBrowserView::DriveView::RowElem ~RowElem()kiwi::DocumentBrowserView::DriveView::RowElem
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem.html b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem.html index 2cea734b..5ee5eb75 100644 --- a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem.html +++ b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DocumentBrowserView::DriveView::RowElem Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -80,54 +107,54 @@ - - - - + + + - - - - - - - - - - - - + + +

Public Member Functions

- RowElem (DriveView &drive_view, std::string const &name)
 Constructor.
 
+
+ RowElem (DriveView &drive_view, std::string const &name, std::string const &tooltip)
 Constructor.
 
 ~RowElem ()
 Destructor.
 
+
void showEditor ()
 Show the document name editor.
 
+
void paint (juce::Graphics &g) override
 juce::Component::paint
 
+
void resized () override
 Called when resized.
 
+
void mouseEnter (juce::MouseEvent const &event) override
 juce::Component::mouseEnter
 
+
void mouseExit (juce::MouseEvent const &event) override
 juce::Component::mouseExit
 
+
void mouseDown (juce::MouseEvent const &event) override
 juce::Component::mouseDown
 
+
void mouseUp (juce::MouseEvent const &event) override
 juce::Component::mouseUp
 
+
void mouseDoubleClick (juce::MouseEvent const &event) override
 juce::Component::mouseDoubleClick
 
+
void labelTextChanged (juce::Label *label_text_that_has_changed) override
 Called when a Label's text has changed.
 
-void update (std::string const &name, int row, bool now_selected)
 Update the document session.
 
+void update (std::string const &name, std::string const &tooltip, int row, bool now_selected)
 Update the document session.
 
The documentation for this class was generated from the following files:
  • Client/Source/KiwiApp_Application/KiwiApp_DocumentBrowserView.h
    • @@ -138,7 +165,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem.png b/docs/html/classkiwi_1_1_document_browser_view_1_1_drive_view_1_1_row_elem.png index 92e30c005a0e39a4367df3114581a17993320f14..7ff802da40f73047db6c4a3631259990ea1df86b 100644 GIT binary patch literal 1613 zcmeAS@N?(olHy`uVBq!ia0y~yU~T}i12~w0WWCMn>p)5(z$e7@|Ns9$=8HF9OZyK^ z0J6aNz<~p-op-cLQ zeVHnjM^4%!zhC&k`u{&S*Z-N%`=D3NpZUjLzH&=z|DSgk{h!M4Z&l%>l;(KO2U9ou zsed`CDsSJn%+mb6?cW_mYA5|~>NlJ&JFl9z^oY1Rqu>4QTyvMi?21<}R+qiMo=H#o z-??!2@2V%)f7s1vbMwh%Gxz5*Yl|}f{nPaPmLl&RtD1fD)!lp36LjOl_fC85wyL(Y zW;cUfSaE0iq(6M`1rJ2Gn&o+JQm>AD74&S~_Nv(%IvMVHeD%1aQfd2M;(&VFudBbl z?-x99{=B{5f!S~6`k#Nj=bv9Ma$s%=&>TJX+r3Qcn$ib)V%D{%f33G|c+@7;T$ zZSVf2ix%+9-q&w9FZzR>d56($554Pdd_d3MbA7ojQMtifR(|CymG#fxGX3~d^Ix6$ zN9aHQ?^`|0&$_Rh-zPgM#s1sIE4^y&x_0vW{#{GbQUATRXMU}?+L=p01~~REKpAH~ z#Q|g1dcgE7JgT;L9t5}L5Y&KEOw3Sf?-dCHR*JOlDP3T(13RHDtfzm;p zP;Q{i22a(dNOS`bns~K@KxR){#VQ@50x}z@%WQ=Q$ULB~oPdcSDO3X;U9lM0e)wSk zU;E*OGC;z+k%{%+|0_WO3l5w!X`nLsKt7?z@RUTd4I7t8g=VR^%~B!9#_Pf52ZOZ) zMJjA@3KSPz|5%p0_38H?e-6z5VEBOlxUP1EMVjry*zNXnA1wR(@c^3u*PeNy3=jL( zhu3Ev+C2C9@w@Vj5wX(3|7x0wgPA#4%N`3ISpWL-#}iAL^zJYJRk&yFk5@ag{;g7# zkMF+QAA3&qna#VbGpUnWXW!e-y;HJqUTRuX{=K;U@nsuldTRtcXxCxfQ}OXuV>iEk z-`<_Is(D{)Y~Q_jnZ5k}nSEa(mVQorf3@fJR3E<&e{bKmomYO9!Krco;hQPp&-QHl zUHWjR(f3oY?k{~9@%f$B<=R#Hs;~6y`Nco|4Ky%3nCV*HZMnC?U;|?d)B5M7j4?hn z;f(uV)@oIScSd+!%v!gc(PsKa?@Qa&D{7={WNrXWzP@=zPT|v!@7+Z|Y@3;Q)aZBC zs^1K8Vx{l?>NHH}6Bdrif0DL(bu2Lc9^@B2-;o`*Z7<)0oi7a6t((35KFf!F46*;$ z-(Io)dg06um-f}onw#)o+HU7%K>O<_hd%seru6u8@tcx8`sRn9TA9vouiInOAI-bV z=Khv--gkC=zv~pnX!HHvyayL=Up@o1B#2-X5{_i!V-l%7hH}iTX+P|*he`9Vo_@3m QSoSk`y85}Sb4q9e08nZGkpKVy literal 1227 zcmeAS@N?(olHy`uVBq!ia0y~yU;<)>01jp#`7|s$8AwS4_=LFr|NkGzeDUUMY5$=K zKo%GuIB=>&3*CM}Pgd zw-cEjd9ly+2huJqy6Td#Fpi@NRRJxR%P+YGI#Dz1}q z0=-mEGA<37^d$&4mpv{7;=;Z(Y7Tll_<<@alD_*IKiE;y3S{ z_gcBcx9{w(5HH`R8Eo6mJ(CZ4_3w;vrkwlzf74a=pH$DQvG)8s+3T*?m&e6&mmYmu ze9HgaJKjl8zW)$eso(3B32}`D&GrEY%$AA(!}OrtbZ<-6+CM*o{SN9uMZy=K z(tPnKE5wqudP>j*Z%x+rDFFcoJVETM8WsztG%@)tn$i@v%IhHGQW22?A&|CEEp-u|zvl@|MO?@1)vyuWI-#~j(j)=n3W{8G_($@oC`?#sUq2g}T2W7UzEB6WFg znw5(6x`U4%KfCaz=GOatUYEB<_t{Igx8p%vzbyS%CPs#Z zzH)u-o;YjG#{j*wUH!{vB;4lnZVk(t zb7hBauC}S!3yFkZ3f=B=ZCy24?GvXy%rTy&cVzY2UNg%uYxc8h-S?{%-`B`JZuoq* z=+dggTe~DWM4fjU!nj diff --git a/docs/html/classkiwi_1_1_dsp_device_manager-members.html b/docs/html/classkiwi_1_1_dsp_device_manager-members.html index 6fb395f6..cee0bf88 100644 --- a/docs/html/classkiwi_1_1_dsp_device_manager-members.html +++ b/docs/html/classkiwi_1_1_dsp_device_manager-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -74,7 +101,7 @@ AudioControler()=defaultkiwi::engine::AudioControler DspDeviceManager()kiwi::DspDeviceManager getFromChannel(size_t const channel, dsp::Signal &input_signal) overridekiwi::DspDeviceManagervirtual - isAudioOn() const overridekiwi::DspDeviceManagervirtual + isAudioOn() const overridekiwi::DspDeviceManagervirtual remove(dsp::Chain &chain) overridekiwi::DspDeviceManagervirtual startAudio() overridekiwi::DspDeviceManagervirtual stopAudio() overridekiwi::DspDeviceManagervirtual @@ -85,7 +112,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_dsp_device_manager.html b/docs/html/classkiwi_1_1_dsp_device_manager.html index 4e849b10..47c0f253 100644 --- a/docs/html/classkiwi_1_1_dsp_device_manager.html +++ b/docs/html/classkiwi_1_1_dsp_device_manager.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DspDeviceManager Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -84,7 +111,7 @@  DspDeviceManager ()  Constructor. More...
  - +  ~DspDeviceManager ()  Destructor.
  @@ -94,40 +121,38 @@ void remove (dsp::Chain &chain) override  Removes a chain from the device manager. More...
  - + void startAudio () override  Starts the device.
  - + void stopAudio () override  Stops the device.
  - -bool isAudioOn () const override - Returns true if the audio is on.
-  - + +bool isAudioOn () const override + Returns true if the audio is on.
+  + void addToChannel (size_t const channel, dsp::Signal const &output_buffer) override  Adds a buffer to the output matrix of signal.
  - + void getFromChannel (size_t const channel, dsp::Signal &input_signal) override  Gets a buffer from the input matrix signal.
  - Public Member Functions inherited from kiwi::engine::AudioControler - +  AudioControler ()=default  the default constructor
  - + virtual ~AudioControler ()=default  The destuctor.
 

Constructor & Destructor Documentation

- -

◆ DspDeviceManager()

- +
@@ -147,9 +172,7 @@

Member Function Documentation

- -

◆ add()

- +
@@ -178,9 +201,7 @@

-

◆ remove()

- +

@@ -218,7 +239,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_editable_object_view-members.html b/docs/html/classkiwi_1_1_editable_object_view-members.html new file mode 100644 index 00000000..497d42ac --- /dev/null +++ b/docs/html/classkiwi_1_1_editable_object_view-members.html @@ -0,0 +1,133 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+

+ + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::EditableObjectView Member List
+
+
+ +

This is the complete list of members for kiwi::EditableObjectView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
addListener(Listener &listener)kiwi::EditableObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
edit()kiwi::EditableObjectView
EditableObjectView(model::Object &object_model)kiwi::EditableObjectView
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getLabel()kiwi::EditableObjectViewprotected
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
removeListener(Listener &listener)kiwi::EditableObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setEditable(bool editable)kiwi::EditableObjectViewprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~EditableObjectView()kiwi::EditableObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~ObjectView()kiwi::ObjectViewvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_editable_object_view.html b/docs/html/classkiwi_1_1_editable_object_view.html new file mode 100644 index 00000000..98906695 --- /dev/null +++ b/docs/html/classkiwi_1_1_editable_object_view.html @@ -0,0 +1,281 @@ + + + + + + +Kiwi: kiwi::EditableObjectView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Public Member Functions | +Protected Member Functions | +List of all members
+
+
kiwi::EditableObjectView Class Referenceabstract
+
+
+ +

Abstract class for object's views that can be edited in mode unlock. + More...

+ +

#include <KiwiApp_EditableObjectView.h>

+
+Inheritance diagram for kiwi::EditableObjectView:
+
+
+ + +kiwi::ObjectView +kiwi::model::Object::Listener +kiwi::ClassicView +kiwi::CommentView +kiwi::MessageView +kiwi::NumberViewBase +kiwi::NumberTildeView +kiwi::NumberView + +
+ + + + +

+Classes

struct  Listener
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 EditableObjectView (model::Object &object_model)
 Constructor. More...
 
+ ~EditableObjectView ()
 Destructor.
 
+void addListener (Listener &listener)
 Add a listener.
 
+void removeListener (Listener &listener)
 Remove a listener.
 
+void edit ()
 Edits the label.
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+juce::Label & getLabel ()
 Returns the label created by the editable object.
 
void setEditable (bool editable)
 Sets the editable object view as editable or not. More...
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+ + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
+

Detailed Description

+

Abstract class for object's views that can be edited in mode unlock.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
kiwi::EditableObjectView::EditableObjectView (model::Object & object_model)
+
+ +

Constructor.

+

The label is not a child component by default, initialised with not text.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
void kiwi::EditableObjectView::setEditable (bool editable)
+ 		+protected
+
+ +

Sets the editable object view as editable or not.

+

Editable object is editable by default.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_EditableObjectView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_EditableObjectView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_editable_object_view.png b/docs/html/classkiwi_1_1_editable_object_view.png new file mode 100644 index 0000000000000000000000000000000000000000..ac6fbf8862e8c4a8fa4999c41622ad5c0fd4abbe GIT binary patch literal 3562 zcmb7H4LH+l8{atRP-#bXPAZlEuQK@LYLraOoANiQ%s5f6z=3D5TvK%Mt3sDjs zvL}Ri_iXqKpKF-3n#+t^AHugT#IlbrV>gs*pUDvkf*>gY7egE(KcmJN>QV%#` z7tUWXAAvwDbl78e5P?uff$@~4I`}+Ex8Z@WWd|JH?3GF-7z#$Ek)*~8U^Mq`XlVF4 zwO1cZH3i$RL|LZi!ROYOO7qGb}L@?8mD`#W!udT7Mk z!fZ8%hIMZp>KhHU7@HNRcr+q|J0?4g$ldbWpy_O+7aE3VF&)UbwHP-j)RB<9G8F|u zx=YYEu?4me>xrF);G*CFRJjG148>!#^rm$4MBi)?*x3sIt+#+tF<1T+s+u z&9!Ofj5B=$#+sTyHK+S_bA$&V>Ed9F;|B8wU7ZpVYAmTa`dNe}zkH8Y@r@DY<15}W zMu*Hj141)J?#!&Zk@mnb#S}fn(3OeZNK%lvZ?;w&JN0GF3=20e?4@*F-&}kS)xJjQ zK-`y|Cse#-npG@sBRx5xH*jP>@zBr5#XZdJanKQA5GhPl#3&Gtm&lBDupTA_>J!cD zG228Lt)}UN-ef`esTJ%45%J_6X)8lmcJfKZ*&*)rvnciwVEFV~L3rE@6758#5$t4x zM8Yo+n)m&Y=>)t`>L%cy%p>IxfmAyqKp=O4Wq(8J;JcX7d79cczdcy>S(7iE zpvGJJ;pm%YAV#j(n2%P4Y@N(Bb%SOArU4?9A3zO29`*s%gQn>pV695q2V8FkshI=z zc617_LR2%FNXwx_b=?WTDE-S|;l8RD+&Bs0d|mIa0CZx|2GXa$H&!^@0UaW)xQlWo zHJ#9_UWKtH(a4ONK6tjA-8B^$vw}|1DQ+FU<-*Iq1q)rHJkcp65@{8iM52uI;s_YM zrV|Q7RXaiGqw|XDO8N+%6BZ$vL^|1)!@TymgLNLX7=97xK-^2Nq>Q>EXYxLV47@Wg zJ-(L}(v2m?^8LpLx>5v)Q{^O7F?$zrB(6+PVUIR!Q;wI9y$f2JI_^S9PP(WQc{O-O zG8-4^skMo4)hJd(hTmU76Yg*N=FaMhZ#s~(HaJ#(i7eH=(l7JE<3~q36DWR#u<#$8 zk@l*l{i+kPBCmR!lLsE2it){pbqXr^FSg99&{KR3x+D1EfF;wSLW6%xfKdKGeFL(y z!6-8ZVwHvzs#5H%t>Tc6$!?A8eh4B)Mje&2^5LKW0Eq4^!Cw_vi}_Na7~F6bAXNkw zyUN;h7k1(!=3+)m>*Jm;K-PjXB#*iH`m#Jeg4OBkZ_taDuWCSj27sTUizmUXBsJYg zMj+p>3S2OU(N9f2f$-m#4~PAU?b?84DO|BSXoB53833dW^`H1|+*|02;xLaVnbM1x z`@EgJu1Dw6w!ZW!=sO)bml6p5$7w9qveW+{_tp2_=s%3-e#NQ?@@ZC`Jn%J!KQToo zBa46GEbr_Wos70^jUBHh6M&zw0Q2wq|M~EqNoC0+o!nA%UW+e)6^KkRUv@S+Hqm&S zXa^y#QpzzzwnfHRPTXe9MDGUM*3j~8D?){G+{K!~e5RNfHuCV~W{^&OK8{$EU?eso zc*a+mT(;8p5^PRVRvN380Lc}dF?bv4Y1zca6m9j(=5#41YTjq4ylIgzEgK*8?Fvuy zov-MMcw1-QUOdgOdpF*@M%-EsD7~`KtAmd(Z0!JKGa?_ip5XjkBRdw`tJOYnHT>{9#bRP0A zgD=z#?62Nx3JM=?zLLb9_&F)7KQU3#m4$ps=d7cnO7ncHvGHef7{w zVIlQ04T6B@OVx0YL4oZo1%`9?^usWSso5KR$pd0Jt;IvELcVW@Lc23RkxFd1G+*{DtQ$D7Tmv~?j z5?!rWTtis}AyoO=#2vC2<6y{}p0l=lSeqGh;8=ob6-Bn3K z`R%StoH-E5=AGspOE8#NAFGqwYLRP+H<8l^hNzKK{~QvH1l_Kxl)bkh%2nuid#sWU z!#$G^fOMGIK+OVp6OUKK`o$HvK^BFB@&&q=Bw+n&-gCJ`%^Q+l5nNEsQ}tWSw3K}* zA7*JocilUH8k6GRq<_U0=H6kX5#p+WWzsI$N#RRf2yRZ1jiwCZQd4{ z53cy)$RFm%YFnOVz;Gt5kgmk53Y5PJ1Px}Y8wV@^}D z#qLn2O0XJ(%fU@cCr4wnGNQ*(&OY*h)hil0-dGt-X-;+Z;J83(lN8joGf5l$q3xT1 zTruzPr`$R&rnH1zi&*CywbXu_)j58IIE`HQA_Wt&WcJP(hy@7PqMX9;U2d|jOt2j8 ziBdY&vANvrc-d`SLWeA}`$vWMyi)kMO33J99NRdcZ4KLAk=VyDK220-PSMCQLd-_R z$e%Vp`4VezhGLTqaJDQY^1e~kTyvyN-av8ACRu!pE5GDoYEc7qNeWzJaf3i*MD8`4 zoQQ{m!tlZ}m#OIgJTZ?r%D6Sr6&cU$?NC;E#Q5+Bo@9CCIKA3U3~i)eE`xKH z0tr%YNQGfP-X@T{#BA_Ti&bhF0E%P>sPB9#$Z^L9Ju + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::Factory Member List
+
+
+ +

This is the complete list of members for kiwi::Factory, including all inherited members.

+ + + + + +
add(std::string const &name, ctor_fn_t create_method)kiwi::Factoryinlinestatic
createObjectView(model::Object &object_model)kiwi::Factorystatic
ctor_fn_t typedef (defined in kiwi::Factory)kiwi::Factory
m_creators (defined in kiwi::Factory)kiwi::Factorystatic
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_factory.html b/docs/html/classkiwi_1_1_factory.html new file mode 100644 index 00000000..d2d83861 --- /dev/null +++ b/docs/html/classkiwi_1_1_factory.html @@ -0,0 +1,165 @@ + + + + + + +Kiwi: kiwi::Factory Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +Static Public Member Functions | +Static Public Attributes | +List of all members
+
+
kiwi::Factory Class Reference
+
+
+ + + + +

+Public Types

+using ctor_fn_t = std::function< std::unique_ptr< ObjectView >(model::Object &model)>
 
+ + + + + + + + +

+Static Public Member Functions

static std::unique_ptr< ObjectView > createObjectView (model::Object &object_model)
 The construction methods. More...
 
+template<class TObject >
static void add (std::string const &name, ctor_fn_t create_method)
 Adds a object to the factory.
 
+ + + +

+Static Public Attributes

+static std::map< std::string, ctor_fn_t > m_creators
 
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
std::unique_ptr< ObjectView > kiwi::Factory::createObjectView (model::Object & object_model)
+ 		+static
+
+ +

The construction methods.

+

Returns an object corresponding to a certain object's model.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Factory.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Factory.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component-members.html b/docs/html/classkiwi_1_1_form_component-members.html new file mode 100644 index 00000000..f3993bc6 --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component-members.html @@ -0,0 +1,126 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::FormComponent Member List
+
+
+ +

This is the complete list of members for kiwi::FormComponent, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
addField(Args &&...args)kiwi::FormComponentprotected
clearFields()kiwi::FormComponentprotected
dismiss()kiwi::FormComponentvirtual
FormComponent(std::string const &submit_button_text, std::string const &overlay_text="")kiwi::FormComponent
getBestHeight()kiwi::FormComponent
getFieldsHeight()kiwi::FormComponentprotected
getFieldValue(std::string const &name)kiwi::FormComponentprotected
hasOverlay()kiwi::FormComponentprotected
hideOverlay()kiwi::FormComponentprotected
onUserCancelled()kiwi::FormComponentprotectedvirtual
onUserSubmit()=0kiwi::FormComponentprotectedpure virtual
OverlayComp (defined in kiwi::FormComponent)kiwi::FormComponentfriend
removeField(std::string const &name)kiwi::FormComponentprotected
resized() override (defined in kiwi::FormComponent)kiwi::FormComponentprotected
setSubmitText(std::string const &submit_text)kiwi::FormComponentprotected
showAlert(std::string const &message, AlertBox::Type type=AlertBox::Type::Error)kiwi::FormComponentprotected
showOverlay()kiwi::FormComponentprotected
showSuccessOverlay(juce::String const &message)kiwi::FormComponentprotected
~FormComponent()kiwi::FormComponentvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component.html b/docs/html/classkiwi_1_1_form_component.html new file mode 100644 index 00000000..a0924e52 --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component.html @@ -0,0 +1,338 @@ + + + + + + +Kiwi: kiwi::FormComponent Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Public Member Functions | +Protected Member Functions | +Friends | +List of all members
+
+
kiwi::FormComponent Class Referenceabstract
+
+
+
+Inheritance diagram for kiwi::FormComponent:
+
+
+ + +kiwi::LoginForm +kiwi::SignUpForm + +
+ + + + + + +

+Classes

class  Field
 
class  OverlayComp
 
+ + + + + + + + + + + + + +

+Public Member Functions

 FormComponent (std::string const &submit_button_text, std::string const &overlay_text="")
 Constructor. More...
 
+virtual ~FormComponent ()
 Destructor.
 
virtual void dismiss ()
 This is called when the form is dismissed. More...
 
int getBestHeight ()
 Computes and returns the best height for this form. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+template<class FieldType , class... Args>
FieldType & addField (Args &&...args)
 Add a new field.
 
+juce::Value getFieldValue (std::string const &name)
 Returns a field Value.
 
+void removeField (std::string const &name)
 Remove fields by name.
 
+void clearFields ()
 Remove all fields.
 
+void showAlert (std::string const &message, AlertBox::Type type=AlertBox::Type::Error)
 Show an Alert on the top of the form;.
 
+void showOverlay ()
 Show overlay.
 
+void showSuccessOverlay (juce::String const &message)
 Show success overlay.
 
+void hideOverlay ()
 Hide overlay.
 
+void setSubmitText (std::string const &submit_text)
 Changes the submit button text.
 
+bool hasOverlay ()
 Returns true if the overlay component is visible.
 
virtual void onUserSubmit ()=0
 Called when the user clicked the submit button. More...
 
virtual void onUserCancelled ()
 Called when the user clicked the cancel button. More...
 
+void resized () override
 
+int getFieldsHeight ()
 Returns the height of all fields.
 
+ + + +

+Friends

+class OverlayComp
 
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
kiwi::FormComponent::FormComponent (std::string const & submit_button_text,
std::string const & overlay_text = "" 
)
+
+ +

Constructor.

+

Creates a login form.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
void kiwi::FormComponent::dismiss ()
+ 		+virtual
+
+ +

This is called when the form is dismissed.

+

(either cancelled or when registration succeeds).

+ +
+
+ +
+
+ + + + + + + +
int kiwi::FormComponent::getBestHeight ()
+
+ +

Computes and returns the best height for this form.

+

It will be based on the number of fields and form components.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void kiwi::FormComponent::onUserCancelled ()
+ 		+protectedvirtual
+
+ +

Called when the user clicked the cancel button.

+

The default implementation will call the dismiss() method, Subclasses can override this to react to the user cancel action.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual void kiwi::FormComponent::onUserSubmit ()
+ 		+protectedpure virtual
+
+ +

Called when the user clicked the submit button.

+

Subclasses need to override this to perform form submission.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h
    • +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component.png b/docs/html/classkiwi_1_1_form_component.png new file mode 100644 index 0000000000000000000000000000000000000000..e9d4d008a574ddd604d8096bae7df4c86f2daeb7 GIT binary patch literal 1282 zcmeAS@N?(olHy`uVBq!ia0y~yU=#qdJ2;quq{K9ry&x*UC&cyt|NlVdi#K0O`wvY3 zvcUMjfdj0acjSRwj*=k1U){wsz@?^Yq>W`}*#zZTI-X?Q3wrf=58tf? zf1lpGIq_5#w@3Z!Z3&wimpZj=TbhzvSN@%KKl>8tZ>6{MOCP^_`qa4mJMVl3qb$3S zqVThmOH1zDeQw8|Vs-D_^xePP?ngO`HKsW8x@S)`Gp=Rw2tRAid~?+V%?XKIzMD8g z%D=1DuW;J5@7=rTe+&X|4bB%yp2(VYa@EI+n#%r_DW`H&b~Abe=j>|anHBTyRjB&! z*xhF&5@W6}ckcbHd^=0+SKdp#1x5K81JdxR7v_ z)PyNPTG@=iKuhH^@%Hv8O@=#5S_e3S`xI zdn1)0G=yV87Z+nlpkjlT7E6F@E5oW40uG|0Oe+>SF@(lm|60uRL0v|eKY$e|>c9}n zz!<{Ff}ivCdc%?_L5a*Z$DclCLDpp}?D2c)&9=vL*FN}TH<6e31IPR2xA^XCnOD7R zIdkTh+FMm?1Xi|w+w)iYSJrBilD)rAZ{ECb(>$(}BMbPi*~Z=9T=?0bcS@LhX@*4o zp3-kI3bilKTWrbZm{8I2X2{nX_p6D5=F*UB4D}~W9V{9cbat+5<}lD|U|1yHuK*0uFj)&cfpb-!Dd>9XUm0eR zZ;S8c5)p=opuQ`xY}Kk)lU}b{waU9LY{scGYgUMM%!~|V7cdTHMZ#;DJU_*+_t85S zt!pZ8yt(-v%chBoB{Mbsiyx*ekX1-aGk$;Px2%|ZZ!+#==kJC`iLNbH-gvFl%lZ+D=wfSKl#q`D$??|%}bM^GyXHv3w zpVsl7i0V^2kurUz$(lDt=?ybx%6^Ns-a9k$nJ>`w$8Gov)vlE)+_W|@uD)%~5Xl$F z<`LhKmiD~Hy;Y}8gXPGXHbP0l+XkK^BWjI literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field-members.html b/docs/html/classkiwi_1_1_form_component_1_1_field-members.html new file mode 100644 index 00000000..f8c7b476 --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field-members.html @@ -0,0 +1,112 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::FormComponent::Field Member List
+
+
+ +

This is the complete list of members for kiwi::FormComponent::Field, including all inherited members.

+ + + + + + +
Field(std::string name) (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getName() const (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getPreferedHeight() (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
getValue()=0 (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldpure virtual
~Field()=default (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field.html b/docs/html/classkiwi_1_1_form_component_1_1_field.html new file mode 100644 index 00000000..a4c1f6ec --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field.html @@ -0,0 +1,154 @@ + + + + + + +Kiwi: kiwi::FormComponent::Field Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Public Member Functions | +List of all members
+
+
kiwi::FormComponent::Field Class Referenceabstract
+
+
+
+Inheritance diagram for kiwi::FormComponent::Field:
+
+
+ + +kiwi::FormComponent::Field::KiwiLogo +kiwi::FormComponent::Field::SingleLineText +kiwi::FormComponent::Field::TextButton +kiwi::FormComponent::Field::ToggleButton +kiwi::FormComponent::Field::Password + +
+ + + + + + + + + + + + +

+Classes

class  KiwiLogo
 
class  Password
 
class  SingleLineText
 
class  TextButton
 
class  ToggleButton
 
+ + + + + + + + + +

+Public Member Functions

+ Field (std::string name)
 
+std::string const & getName () const
 
+virtual juce::Value & getValue ()=0
 
+virtual int getPreferedHeight ()
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h
    • +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field.png b/docs/html/classkiwi_1_1_form_component_1_1_field.png new file mode 100644 index 0000000000000000000000000000000000000000..855b8cc2e3c09e9ca3a9f2479eca010e64363835 GIT binary patch literal 2907 zcmd5;2~bmM5)Oz;9KmcE94d(r5FV$5QAd;`1mp?^h>nq{tHNji z5di@a_kqBQ5Seh93^JG@94QWgfB`XpK*ABOM6&N?s-~>jt*x4^nyP(O>HP2Y-~D%g z-G6uAbay+hv0=vs1OlPqa>D5p0-=V6){W|GAbQunf&=|+b3f_jtWYSR<=CV&HkF+Q zt(3pU#>TZb2X;ZP>M^I>JQ2_)`00Am~e4A>P1$W5=?myV^PP1^s~m76!D2$ z)W_Xa&A;9sz0x$8_N0MZmeYWG-(#h#Nk4NHp~Ch<@-1Aip)ucFL1CPbsNGIT4^=hw zi#P^CMRg-yN!u2Ugp!47pSSDl20NtYp3t6`rDZ~!q&*Q43*KC1Jt(FITGo5*T`2>f}+=u zmPHh--L%QApz4&TrX@^sxk*xzHKR`n=Y?_pRF<)jYTEKyqi|3<%xwA9t)sH&*a zD$(D%!(iUif^ByB`{YhlwU^51r6_$$5p52M8t;s&4cx`s)jN6yGjRSO$DAjf;Ojs+ zk|GiZcaC)Ms`9uTXJk7ZE=16W=&TqMaiD4V<^{QagI7+8sG3Ohj3V0F4-N#C6{IMMp}?Cl@5m~oPQFo20J$jnSj z`qKe|f}729Sp`aRrt$L93u7tEkNTmQNEXxE_kGS}M7DgsgU%Q#a)$FE@jCu|r!n4? zI#fuD?SGE`u>=m;(t$kg6MYRaUz z9zj+k{Z9_5t+)1zW~|P4WT)&?yFc=(`~n2pV}fXdZ>cZ1QQ2 za{{}B21_ak#wGar0kN5_8@ZM}B}Glru&PG;95O|nkT^7VAUjJhCZw5QTQ_LOyWXSO zQkV2R*Dl&}fg{-zK^3{nk6P#%<%6M|5hAa}ACS`LkwF0NohO^Omx@CIfDYmO5UVnr zcM|Bj#p2i((m+t79Cgo{=zX6GDEYCnc+IB!9puNf=&We*r7Dl!(bZYzTmEuvT*<5I z++Cz;t<vTUOfhvr=OX;xCm;h)@v3l5oy)HU z!6`LOPX&o@7a8p_eR3)oYDmG7$CKI=b@kEqW9G*eYnT1;OFy6q)_Y~LiTjTedLP{a zL%FsX`MLfEib3w}H-Q+7Yx5;6%cr2G?I&+*LEe&ITf0VO$EBU2fh#r4w`E|_q=B$% z(Y8F2bo)8lTSjW*5g+VhNGA5Y6ZC|JP!9S4KGO!mpuSasg=3w$p}lnnKn87Nl2L?849mgQ}M{we6snD z`1FdHSMntM?!$()$e&iOkUmCeFKII*E3*0$T0|N}R8o@chAiKC&sw%Z!7g2>R&?Yq zy+HSM_n-3v=(%x{oE8elb^})*CD_IasMYCxQwzbqz>t(rQYu?qH+Cy#KTe)D>a8 z=pT6XeJ7GUkP6;HzmQ2EZn2tgsG*7d>GX&yj}0q)QHz#W+D*MQDdtkbk%~ zIY(Yi3%&t@hgewhXi{6{OZt3<3bSspSy-+3v{>5G-)ZL!>HdxyH0SZ4pP)ZgTnbhX z0Brlp&mVsl>)k3Yh{8ijL`|po`2o^9Hn|H?CSE{NR$lL-k7((tS#6`oGw|}yo30C4 zOzKVrpD)i#j})DkC{D4PvrECtCm9l|2U}{9IPMN{-07V4m8+W=k{SIHP;WCv9>g%q zODWgAwae21=;F?BYTN?q$2jhf zQ8-=Tbhh#OJ>n3oa087x1j z0jQ|jG?$?>Z0h7mspxJZ6FXKmU6#K*t)(=n?Vshey3!S2WM-eqc=_m>gEsCCN8U{D z=pO!uW7or?Xjne{RUwVbip!Sb2!t1l+W zVImNOn;MOdeFm + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::FormComponent::Field::KiwiLogo Member List
+
+
+ +

This is the complete list of members for kiwi::FormComponent::Field::KiwiLogo, including all inherited members.

+ + + + + + + + + +
Field(std::string name) (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getName() const (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getPreferedHeight() override (defined in kiwi::FormComponent::Field::KiwiLogo)kiwi::FormComponent::Field::KiwiLogovirtual
getValue() override (defined in kiwi::FormComponent::Field::KiwiLogo)kiwi::FormComponent::Field::KiwiLogovirtual
KiwiLogo() (defined in kiwi::FormComponent::Field::KiwiLogo)kiwi::FormComponent::Field::KiwiLogo
paint(juce::Graphics &g) override (defined in kiwi::FormComponent::Field::KiwiLogo)kiwi::FormComponent::Field::KiwiLogo
~Field()=default (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
~KiwiLogo()=default (defined in kiwi::FormComponent::Field::KiwiLogo)kiwi::FormComponent::Field::KiwiLogo
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_kiwi_logo.html b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_kiwi_logo.html new file mode 100644 index 00000000..4d51ab58 --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_kiwi_logo.html @@ -0,0 +1,140 @@ + + + + + + +Kiwi: kiwi::FormComponent::Field::KiwiLogo Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
kiwi::FormComponent::Field::KiwiLogo Class Reference
+
+
+
+Inheritance diagram for kiwi::FormComponent::Field::KiwiLogo:
+
+
+ + +kiwi::FormComponent::Field + +
+ + + + + + + + + + + + + +

+Public Member Functions

+void paint (juce::Graphics &g) override
 
+juce::Value & getValue () override
 
+int getPreferedHeight () override
 
- Public Member Functions inherited from kiwi::FormComponent::Field
+ Field (std::string name)
 
+std::string const & getName () const
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h
    • +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_kiwi_logo.png b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_kiwi_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..6511dac1670bfa5c72b96a46dbf0d7bacfc00450 GIT binary patch literal 1019 zcmeAS@N?(olHy`uVBq!ia0vp^_kg&AgBeKf&s&-gq$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0yF6VSLn;{G&V4&+wE~X=f8nyq|K|Hv zi*Y8z-oAQ|bF%EYUkBYSSRcg)d1c0UtXj2LsA|=!I8NKp(Dio~ny2f8Uj4qaM$i0( zE_0pPD(1aL_jYw;)_vX+dG_<`cP}4@hKJsL>bAG^*5^IXH{B7reBFQ5s_7qDZG+Fn zgoNrp-v4@SWk$r_ZEIJ(D!ntq(t2-kbx7z}qj!JaJzcV6>a(w1wM7#wLqp4dMlHAy z9J+VL!LK2q`+Z-mTves|B_wq3r^VBQybd#c@RehDY_#p(W5X@?Z&cZrDgWkOCq7g7 zfc`@E2U9OFfAD(2SfTobVUJK11JL0N>s#a+!kzdJXroH&CC^%x88gGh#ZC2#iwjV( zl2V-I(&=aFf2Zw>{O96QX1PX0u+md}VbAA1*2W*Cf%3A)4X52Y|EFtShsROgD({)> zF)y3#r)RE$E0`CZPD6fWc3JM+e^pg=2mn^M7| z?zM9}PAESA@=5J=(mHi#mmuHUS<8QSdP^^qdUoil^@Z&4_xx3=t$R8GqGDEuC(W8% zx-;(fw(Hs3R|2)=FP%2){?~11ZoZs*dvSGD`JBCK8#`2jXPt?>`sDpQTf5hKE8@3T z8ZJL(R(W@lrK^kH)5HFIJ5E%$%%~`-#zg!+x6}#-A)1T6SdFGuTNE8SiHOrgP+ zPn$9BlB>q!kjtX#I(R?=ZrX7t+<`@&4+ki#X??Jm);ZulM#u6q0GujBe9 z6T}6*x}(;g(vyEN)vI`u-u2hZF2CG*drNn&`j57GYhSk2tqfoKhGpp-P)J{u_}jj4 z-rDP4lD9TuTAwR0dC1KbLh*2~7YQ CUiI?; literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password-members.html b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password-members.html new file mode 100644 index 00000000..a72b13bf --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password-members.html @@ -0,0 +1,118 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::FormComponent::Field::Password Member List
+
+
+ +

This is the complete list of members for kiwi::FormComponent::Field::Password, including all inherited members.

+ + + + + + + + + + + + +
Field(std::string name) (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getName() const (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getPreferedHeight() (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
getValue() override (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineTextvirtual
m_text_editor (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineTextprotected
Password(std::string name, std::string text, std::string placeholder_text) (defined in kiwi::FormComponent::Field::Password)kiwi::FormComponent::Field::Password
resized() override (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineText
SingleLineText(std::string name, std::string text, std::string placeholder_text) (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineText
~Field()=default (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
~Password()=default (defined in kiwi::FormComponent::Field::Password)kiwi::FormComponent::Field::Password
~SingleLineText()=default (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineTextvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password.html b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password.html new file mode 100644 index 00000000..aea93f5c --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password.html @@ -0,0 +1,155 @@ + + + + + + +Kiwi: kiwi::FormComponent::Field::Password Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
kiwi::FormComponent::Field::Password Class Reference
+
+
+
+Inheritance diagram for kiwi::FormComponent::Field::Password:
+
+
+ + +kiwi::FormComponent::Field::SingleLineText +kiwi::FormComponent::Field + +
+ + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ Password (std::string name, std::string text, std::string placeholder_text)
 
- Public Member Functions inherited from kiwi::FormComponent::Field::SingleLineText
+ SingleLineText (std::string name, std::string text, std::string placeholder_text)
 
+juce::Value & getValue () override
 
+void resized () override
 
- Public Member Functions inherited from kiwi::FormComponent::Field
+ Field (std::string name)
 
+std::string const & getName () const
 
+virtual int getPreferedHeight ()
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from kiwi::FormComponent::Field::SingleLineText
+juce::TextEditor m_text_editor
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h
    • +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password.png b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_password.png new file mode 100644 index 0000000000000000000000000000000000000000..a2626c835eb2637ab04415f0d70b6bbf49110f11 GIT binary patch literal 1460 zcmcJPc}&x17{^;Xk2w%xW((^gECHN5KtV+XECN-3g4~FXNjd8Zws=4}D#aMBN+;DK zt$;e6+zkj)TCTPTB9lTY9R=DSQn#ucy|~&^O6}?rvn|>F+>?CY=lkY;^8E36@;=wX zLl4@n|7<-30i$$$SJ&!m z<4)G=y3EMXD2TP_eMtJFJt2_Qfk4py=p3l}uJSBvo6Q;~t#ryPUvjZ;JOvx9|1GnE zVT*7SBEfzPCDEa~I{^#7#rF2108R6v#&-IAMb_5(q_>n=}c9YPZf0@t&*3Pn&Df{PLeC6NF~88q8oQR8)Xi^UL9S|O5?v434v;R~uJH2@5pQ;O!`ayvv)5h) zWU!|$|9I{?{-a_y<#Gi5B3)1aw3yATxZRn8Y7MizCT=$aVz(>%0a>Lme7Oz7dohR9 z(}&OaUfQ}`Ms8wO6l%e+zHj9rD2~ZR9uSp-Q$BP*ox!sL=r5a_tn5|KQ1!jixK`cN zft}Y+ZPE>G{L;f|Jj;;*Pxk@xD5EOorg2-`L7>l`;nA4Fytr6Vjgh_>5%19I!aE`h7Pmd+Fe|(ck$^%#791JUpjYfJih%CE`HBCr z01)GTQx^zg-oTW798sB_eaXM#`Y)O%w-+fK;0J*9hu?P=$J3J@%j`72qS{V`6wukv z6T|7mY0q0^O|0h0ol0TmY@xOzH&1|9xz;Mi@P+&;jMe=dBOMe=gClzgh6(ashDQ#6 zrs@a&PnJ>6zL`~q5urlUFmM&c+{2I0OupThqfI;VhKZJRKbm^nKGO0^MQ!GuRt{ZH zJIuox{zCmSj&+sPreQBe_+>lcyORVvrYSqLp96tMz%+$!Z77~nSKhusts4Skt7T;M z+r+=YA40UzbVZ-Xk^V1Cz+5fUxb$@F_WS|8RLV^U6F2+73DT-9DV@9X-Goq}QAfjXA)$L_Yp12 z84tF0vUL%NR&M;}?CjKC=3LyF4p}4SStFSNHO<9%ppr0mc$ed7gy^VARt=5epKE;8 zAZ%n$f%r?N>F@fu=lA<(sm40qDZi*EH9Ww#%q_#JcLhoY^?Z!{dz2F43)v(Bx#ujD z{91yK<6)|dU)w}57d++LJXg=qKrWtSBHEpzJt$kMvf-r&Bu_+olh1sUZDT4%*R+Sy zV + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::FormComponent::Field::SingleLineText Member List
+
+
+ +

This is the complete list of members for kiwi::FormComponent::Field::SingleLineText, including all inherited members.

+ + + + + + + + + + +
Field(std::string name) (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getName() const (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getPreferedHeight() (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
getValue() override (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineTextvirtual
m_text_editor (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineTextprotected
resized() override (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineText
SingleLineText(std::string name, std::string text, std::string placeholder_text) (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineText
~Field()=default (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
~SingleLineText()=default (defined in kiwi::FormComponent::Field::SingleLineText)kiwi::FormComponent::Field::SingleLineTextvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_single_line_text.html b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_single_line_text.html new file mode 100644 index 00000000..79409e67 --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_single_line_text.html @@ -0,0 +1,151 @@ + + + + + + +Kiwi: kiwi::FormComponent::Field::SingleLineText Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
kiwi::FormComponent::Field::SingleLineText Class Reference
+
+
+
+Inheritance diagram for kiwi::FormComponent::Field::SingleLineText:
+
+
+ + +kiwi::FormComponent::Field +kiwi::FormComponent::Field::Password + +
+ + + + + + + + + + + + + + + +

+Public Member Functions

+ SingleLineText (std::string name, std::string text, std::string placeholder_text)
 
+juce::Value & getValue () override
 
+void resized () override
 
- Public Member Functions inherited from kiwi::FormComponent::Field
+ Field (std::string name)
 
+std::string const & getName () const
 
+virtual int getPreferedHeight ()
 
+ + + +

+Protected Attributes

+juce::TextEditor m_text_editor
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h
    • +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_single_line_text.png b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_single_line_text.png new file mode 100644 index 0000000000000000000000000000000000000000..f64bf023229906ae160a881114b691ef683ed9b3 GIT binary patch literal 1466 zcma)+c~H`67{_tRGAF~GY1>X|3M@@zDJd%v%M(#Ebh9+?(Lw^vBpu{vYPVz4FtSjT zT1u;3Q`Yh}g)*f!!I3;s$2Jd&%f%FfpTbhJ?QXOC$G$Vq`#jIQ&&>PGcb?C4F+42L z!G4WB2n2G#1^E%Ie!*&DJFxYB54qN2b*sWdBK<8Ei#2?snWeIy6j-B=CKiirFAhVk zsa+N!ECOUL`fz%GjobzT+2U}1dn0pfw0!l0Ti-Y?-UIzs28i@d2cE%f4q{xJ(aGJJ z&r{^E)n-DlOQN8t*cPspb|!HQsi`RAxdn71uNc#HS7NXQc8N&`%q&1*AuladUj^E= z?QZPz&D{RH;=xVyZgVQNx5??9KjTXvJ2my@>qWWQUYXmr11l`03kd&!+9@@!n30E^ zoPTVtc1TDyxU?Eu;^jtK7CZfYvjwXxDJEw|zpB{}L|DHMbN;)BYGirgJy7X0+YN34 zEt31pB+#leS1H8tTFsIRI0g7AOlxCp8HB>+o-QiG_=L!vHaHU@j#oc_K8gx` zxniX=&OTUyCxpo3I7!nS#tDo0`D~IICwD&oJ*Vb{qrh-dL=%j~58&luz2l_3f2N`Z zhNh1)y{q(;yyWKn)3wLk<5VU>REDs{%Sor=>6PUjv#Lvm-ocoL**5`b_VKS~%WHq! z;oY!yqZ_)9#+g|r97Jx-StTb&1-l{`mHCs9Qj=Zi&e0M83@~-9#Q29pVc$iMRT!v2 zlqk_it8kBEF4u>1wvE6iUZBjzQ&a9p5M1NRaH?Do`6b&7^Y?2=J^V{8AQare2DIx9X?;s z>-u_4J-^SJr_>1{hqPSRwgSqYC0qWXH`z&{POeE0t6We>+YAfCmM5*L^?bY9j-v5X zyD1Tqj-7}(2B6>%^`_TPsVN$jOdzG@o*dNz`MT!$I{s|5nKC8uf4rVeK8*nGu))9x zLnNB+ufZ_&blKV0m)(^+;c8Rn+LJ+#sQpG=Y}$y_h!$oOd}UBWCq*XQHB-AEEk@l` z&GAv@cmU<{g_nfoHTR-van6;lLGZl#)9m&`ST5y@Y+w1ggA$jLS&e>u5VByWxpY-3y}7N;2hC7g3= z^~N5iE{g1cqn(kO0u3CGjCE9ZMyRL>M`%m1>?>4ilw*qV4$nG3Em|pU$H&I2>~*zV zNn0#GlogkDM7Tr4Mcubh#Y}qWSfHljVSR?WJ3mcF|0fO|w6*PHS(RfkaRp_Q1J&6J z^}f+_M*`zXw~gSt-uqrk4XyDpRTeUs4MTgSk9I8}HKbER7sE+4hS + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::FormComponent::Field::TextButton Member List
+
+
+ +

This is the complete list of members for kiwi::FormComponent::Field::TextButton, including all inherited members.

+ + + + + + + + + + +
buttonClicked(juce::Button *) override final (defined in kiwi::FormComponent::Field::TextButton)kiwi::FormComponent::Field::TextButton
Field(std::string name) (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getName() const (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getPreferedHeight() override final (defined in kiwi::FormComponent::Field::TextButton)kiwi::FormComponent::Field::TextButtonvirtual
getValue() override final (defined in kiwi::FormComponent::Field::TextButton)kiwi::FormComponent::Field::TextButtonvirtual
resized() override (defined in kiwi::FormComponent::Field::TextButton)kiwi::FormComponent::Field::TextButton
TextButton(std::string const &name, std::string const &buton_text, std::function< void()> call_back) (defined in kiwi::FormComponent::Field::TextButton)kiwi::FormComponent::Field::TextButton
~Field()=default (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
~TextButton() (defined in kiwi::FormComponent::Field::TextButton)kiwi::FormComponent::Field::TextButton
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_text_button.html b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_text_button.html new file mode 100644 index 00000000..395e0466 --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_text_button.html @@ -0,0 +1,146 @@ + + + + + + +Kiwi: kiwi::FormComponent::Field::TextButton Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
kiwi::FormComponent::Field::TextButton Class Reference
+
+
+
+Inheritance diagram for kiwi::FormComponent::Field::TextButton:
+
+
+ + +kiwi::FormComponent::Field + +
+ + + + + + + + + + + + + + + + + +

+Public Member Functions

+ TextButton (std::string const &name, std::string const &buton_text, std::function< void()> call_back)
 
+juce::Value & getValue () override final
 
+int getPreferedHeight () override final
 
+void resized () override
 
+void buttonClicked (juce::Button *) override final
 
- Public Member Functions inherited from kiwi::FormComponent::Field
+ Field (std::string name)
 
+std::string const & getName () const
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h
    • +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_text_button.png b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_text_button.png new file mode 100644 index 0000000000000000000000000000000000000000..a9fc74b8bd956b5353a44c5737d2cc6c6936eb06 GIT binary patch literal 1437 zcmeAS@N?(olHy`uVBq!ia0y~yV7vlkcW^KR$;?Bq(twmifKQ0)|NsAi%olIImi8Z- z0AzvjfddCvJMYK?xf~@ye!&btMIdnXREQA+1FMdwi(^Oy zA17=XOLuRtuspmeLqS|Y*7Zds)^MH83UZVd6PniTK#wr(2N2J!n7SNg_#-Vz1s zN`J|oyQTMd^6CvLZ#$QIUAoMpomHQ^cik%XSC=k0PWlFNNa&tYBcRgj$txMw9}i-j z^l_nu_odq#LOi|NmU;yl!5rW7*i(1uls60#4dI1s1`L%OLKXx;wuE5e|=ZhTmm^84EU$k-)rE+#cwugp&MtYY3j@s@n71p78c`QT02uVydbSDJm* z;M=@a=1Wx%zkYpX@$TP`d~~N@ej0lG^3qlNdzP-#@YH`K9wa_>>zu5>HBEQfYrchV z*W*2XxZG>Dszvn5Tc` zIcso#_R7Pts#|yNsffMj`pPPJ{sgNVw>{PxmA?CUHK;vCChWeU_v%a6Jz|w&-_F?W z9sB*RSFHXKK|%YEj4Qu>+P&nt$?xkPYngAdd|7v8Vd-Ycyt0eGPrv`ae|g>WPtobG z*QU(5{$f|^9sc9jUabuM>JYo@&UWK9RXp#71wS(9PmWr<^>Supe*3I{tovNDT#l@> zd7-TIDD$3b=%jrNu;lx=I7nIPUh7gf7hs$!D*+=_Q1Il2D;*svGXAe#mRO}OpA_Y# zd6TiiIKAO>F0!$z|DbGOaCj&a<`4_*Q4`V!w4O zjl+BI_q*SnFKz#)o7ElC(DpVu_U-0bcY@3xzV2UVv4QvJ4AI!&`!-+KMz3z$_&sE= zrmkmL{BpUwcf(#yx=`Ea7qr~*cuW2=n=MydQ+1dB`W$}n9kbo<)zQ=2o<6i*dX^`+ z|7-B+l@7Hrm8)hxxe&Da$Cion%-4y&jtiHof3RuZLdmqrE5H6z3|kiUYR?BV>u2wRuGel4y3YMkE!cc>w3fqRD?eU) z@4b@Ouj*CR|J=KId0b@O@!MfpoBgA+Qs1%9$Uo`r+yGd3$7) z$yw+5m0#tK&7byo<$Hrn>!*!Nnckc-XT21}Sau+Y(XIuUs~>a7=b&Zkqmuvt literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button-members.html b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button-members.html new file mode 100644 index 00000000..a487fd8e --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button-members.html @@ -0,0 +1,115 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::FormComponent::Field::ToggleButton Member List
+
+
+ +

This is the complete list of members for kiwi::FormComponent::Field::ToggleButton, including all inherited members.

+ + + + + + + + + +
Field(std::string name) (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getName() const (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Field
getPreferedHeight() override (defined in kiwi::FormComponent::Field::ToggleButton)kiwi::FormComponent::Field::ToggleButtonvirtual
getValue() override (defined in kiwi::FormComponent::Field::ToggleButton)kiwi::FormComponent::Field::ToggleButtonvirtual
resized() override (defined in kiwi::FormComponent::Field::ToggleButton)kiwi::FormComponent::Field::ToggleButton
ToggleButton(std::string name, std::string text, bool _default=false) (defined in kiwi::FormComponent::Field::ToggleButton)kiwi::FormComponent::Field::ToggleButton
~Field()=default (defined in kiwi::FormComponent::Field)kiwi::FormComponent::Fieldvirtual
~ToggleButton()=default (defined in kiwi::FormComponent::Field::ToggleButton)kiwi::FormComponent::Field::ToggleButton
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button.html b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button.html new file mode 100644 index 00000000..ae4b69b8 --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button.html @@ -0,0 +1,143 @@ + + + + + + +Kiwi: kiwi::FormComponent::Field::ToggleButton Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
kiwi::FormComponent::Field::ToggleButton Class Reference
+
+
+
+Inheritance diagram for kiwi::FormComponent::Field::ToggleButton:
+
+
+ + +kiwi::FormComponent::Field + +
+ + + + + + + + + + + + + + + +

+Public Member Functions

+ ToggleButton (std::string name, std::string text, bool _default=false)
 
+juce::Value & getValue () override
 
+void resized () override
 
+int getPreferedHeight () override
 
- Public Member Functions inherited from kiwi::FormComponent::Field
+ Field (std::string name)
 
+std::string const & getName () const
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.h
    • +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button.png b/docs/html/classkiwi_1_1_form_component_1_1_field_1_1_toggle_button.png new file mode 100644 index 0000000000000000000000000000000000000000..758029e7a044fb8cc9244239a4004cfd31e499c3 GIT binary patch literal 1039 zcmeAS@N?(olHy`uVBq!ia0vp^Ux2uSgBeIZ7c?saQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;pK__N=jc>G7b(&jT6#&VZkzun(&Y`nXvdTICL zGbhiy;i{YbCFbiK&+WNq&*(jz_v)_a{OG4?Y2gKz%d2$H+`ectPxJl1oUdla)hGRX zBrgFi{q|pd$=NeD0+-U#ft?!-6?94&4+a* zTK}f|AM1YUKPj$AV#<=(U4ljSr?1YItyk0als&HOfARd9&0ADL@2J_zJ~l9}^*TMJ zZ=vR%ZMutH6EgSOy?ghGOY?ko_s3UNFV{q=#p~=+nyI<)?E0Q(4s|~ttdma6-MDq~ zlFfT`_v&5Nn_PL^)5|n>wfOq^7F(4=?#9?%X20~-=YMmFUWB#s6R~oS=RRGszu#WU zy&bnJ_Qj-#Te6!o)AN%9$g}e<9X8-O$M8c@j^W-1jlUHZ zTfS-hE%}!IHpps~c>_Q8@WK(Ccig=+E1Ov!bVEZoVe&lxr}`UW^+ov~h_*X6fWt5} z?6x}Fg5?#f^FqGv(C58SxW>fQe)G9Y45GDR?E8Pk>7_4Op1f!7%iyTGV}>TJ*SDo^ z;m}!o{rKJ3c~d{_*(R~R>ZNI`>P4Gd-@+{aZK_+vlLZdoKT)nmmkVxpq?)jQI?Y~w zmm|CT+uA?t`L6!m_hyOI=4pCyD~xZJc{$&Hb@a8m-&>AQ^SeIpOE-6h&fMqqWJ`(l z<^KwExv!n$*m*SilB?pK*)PK{Sw_6Mkv~1}_P0xKo$PHd-<@Zt9P74XQX z2S3@}xNLnX{_V?EIWivMsXRf2CRcZNt+{`!DEgfCvbsCho-O(z7y5qHgxb)(#d + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::FormComponent::OverlayComp Member List
+
+
+ +

This is the complete list of members for kiwi::FormComponent::OverlayComp, including all inherited members.

+ + + + + + +
OverlayComp(juce::String message) (defined in kiwi::FormComponent::OverlayComp)kiwi::FormComponent::OverlayCompinline
paint(juce::Graphics &g) override (defined in kiwi::FormComponent::OverlayComp)kiwi::FormComponent::OverlayCompinline
resized() override (defined in kiwi::FormComponent::OverlayComp)kiwi::FormComponent::OverlayCompinline
showSuccess(juce::String message) (defined in kiwi::FormComponent::OverlayComp)kiwi::FormComponent::OverlayCompinline
~OverlayComp()=default (defined in kiwi::FormComponent::OverlayComp)kiwi::FormComponent::OverlayComp
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_overlay_comp.html b/docs/html/classkiwi_1_1_form_component_1_1_overlay_comp.html new file mode 100644 index 00000000..a38a69b7 --- /dev/null +++ b/docs/html/classkiwi_1_1_form_component_1_1_overlay_comp.html @@ -0,0 +1,134 @@ + + + + + + +Kiwi: kiwi::FormComponent::OverlayComp Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
kiwi::FormComponent::OverlayComp Class Reference
+
+
+
+Inheritance diagram for kiwi::FormComponent::OverlayComp:
+
+
+ + + +
+ + + + + + + + + + +

+Public Member Functions

+ OverlayComp (juce::String message)
 
+void paint (juce::Graphics &g) override
 
+void resized () override
 
+void showSuccess (juce::String message)
 
+
The documentation for this class was generated from the following file:
    +
  • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_form_component_1_1_overlay_comp.png b/docs/html/classkiwi_1_1_form_component_1_1_overlay_comp.png new file mode 100644 index 0000000000000000000000000000000000000000..f5f7f0127c5a69b41da3b70bd6749dd4826dd289 GIT binary patch literal 656 zcmeAS@N?(olHy`uVBq!ia0vp^*MT^IgBeKf6%%+4q$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0KlwE+)nw0`lw|NZY9 znD5=lV>42ozUl?nJryb8pQ6T_84s#tS{(A8^hY3W(v$YvdzVG2c>X`XmcMBGb(yz& zC)D56X7|3G7JUA-nx_8U*w=4sr!DDQzUR_sKYp9o&%R-I@;xu<+Pn>o39nOmDOPt~ zTXg2fJ-2pFD&hCPdidPyThBE-w|}_tbL*5{U$b@zr@q#|?(BK%iE$**#&-!J`kud3 z9;$lQap-$~I=p@Q%$pSqHC_4*jFMMgzs~mA=(u;^);1C8tJ<#=8`KYRAK-t;`k?&- z(+B4Y#vh7%7=TV@0BU8hZxL^hN0t5~0P-0_n=({Y#NJE(nmh09=i)ga*51spTjVrf zQ_h$9%X9WHSoJxdS^U29X{fv7uXo&<-s^wPn$@`{{%Cg8wKIoL-znN6QE@hI*Y2>o zmsgEdPK8w7w0drk`gUsWsgtgA<`k>Vt({tHIze21%PO9uEk>cYtEX-H7G<{mvgd#O z16j8srBCbs$$1|>``wMzo|QLO-(4?Xu{3FeP{|ePRy~_Xpr0{v6f2#AoXFY#c zS?XxcreF2;&Hv8pQFC^wT(>*E?$FxpzDqT_ZhD?tcW!zp^O_yAsv>%I+E4y^x@PIt zclR`Me(pY@e(Cf&FH`f=cP;!Prx!O!SE{^gU3_Knbx)u5ap{Wok61rc!$RnCU|O1) b%zp;XvSx1A3|3ZP@?r3F^>bP0l+XkKA;>v8 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_hit_tester-members.html b/docs/html/classkiwi_1_1_hit_tester-members.html index afe22293..ffa401b9 100644 --- a/docs/html/classkiwi_1_1_hit_tester-members.html +++ b/docs/html/classkiwi_1_1_hit_tester-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -71,31 +98,31 @@ - - - - - - - + + + + + + + - + - - - - + + + + - + - + - + @@ -104,7 +131,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_hit_tester.html b/docs/html/classkiwi_1_1_hit_tester.html index 408c3ed5..18b3cf35 100644 --- a/docs/html/classkiwi_1_1_hit_tester.html +++ b/docs/html/classkiwi_1_1_hit_tester.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::HitTester Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
Border enum namekiwi::HitTester
Bottom enum value (defined in kiwi::HitTester)kiwi::HitTester
getBorder() const noexceptkiwi::HitTester
getIndex() const noexceptkiwi::HitTester
getLink() const noexceptkiwi::HitTester
getObject() const noexceptkiwi::HitTester
getPatcher() const noexceptkiwi::HitTester
getTarget() const noexceptkiwi::HitTesterinline
getZone() const noexceptkiwi::HitTester
getBorder() const noexceptkiwi::HitTester
getIndex() const noexceptkiwi::HitTester
getLink() const noexceptkiwi::HitTester
getObject() const noexceptkiwi::HitTester
getPatcher() const noexceptkiwi::HitTester
getTarget() const noexceptkiwi::HitTesterinline
getZone() const noexceptkiwi::HitTester
HitTester(PatcherView const &patcher)kiwi::HitTester
Left enum value (defined in kiwi::HitTester)kiwi::HitTester
linkTouched() const noexceptkiwi::HitTesterinline
linkTouched() const noexceptkiwi::HitTesterinline
LinkView (defined in kiwi::HitTester)kiwi::HitTesterfriend
None enum value (defined in kiwi::HitTester)kiwi::HitTester
nothingTouched() const noexceptkiwi::HitTesterinline
objectTouched() const noexceptkiwi::HitTesterinline
ObjectView (defined in kiwi::HitTester)kiwi::HitTesterfriend
patcherTouched() const noexceptkiwi::HitTesterinline
nothingTouched() const noexceptkiwi::HitTesterinline
ObjectFrame (defined in kiwi::HitTester)kiwi::HitTesterfriend
objectTouched() const noexceptkiwi::HitTesterinline
patcherTouched() const noexceptkiwi::HitTesterinline
reset()kiwi::HitTester
Right enum value (defined in kiwi::HitTester)kiwi::HitTester
Target enum namekiwi::HitTester
test(juce::Point< int > const &point) noexceptkiwi::HitTester
test(juce::Rectangle< int > const &rect, std::vector< ObjectView *> &objects, std::vector< LinkView *> &links)kiwi::HitTester
test(juce::Rectangle< int > const &rect, std::vector< ObjectFrame * > &objects, std::vector< LinkView * > &links)kiwi::HitTester
testLinks(juce::Point< int > const &point) noexceptkiwi::HitTester
testLinks(juce::Rectangle< int > const &rect, std::vector< LinkView *> &links)kiwi::HitTester
testLinks(juce::Rectangle< int > const &rect, std::vector< LinkView * > &links)kiwi::HitTester
testObjects(juce::Point< int > const &point) noexceptkiwi::HitTester
testObjects(juce::Rectangle< int > const &rect, std::vector< ObjectView *> &objects)kiwi::HitTester
testObjects(juce::Rectangle< int > const &rect, std::vector< ObjectFrame * > &objects)kiwi::HitTester
Top enum value (defined in kiwi::HitTester)kiwi::HitTester
Zone enum namekiwi::HitTester
~HitTester()kiwi::HitTester
- + - - - - + +
@@ -79,14 +106,14 @@ - - -

Public Types

enum  Target : int { Nothing = 0, +
enum  Target : int { Nothing = 0, Patcher = 1, Box = 2, Link = 3 }
 The target type.
 
enum  Zone : int {
+
enum  Zone : int {
  Outside = 1<<0, Inside = 1<<1, Inlet = 1<<2, @@ -97,7 +124,7 @@ }
 The Zone.
 
enum  Border {
+
enum  Border {
  None = 1<<0, Left = 1<<1, Right = 1<<2, @@ -111,11 +138,11 @@
- - @@ -131,73 +158,71 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+
 HitTester (PatcherView const &patcher)
 Contructor.
 
+
 ~HitTester ()
 Destructor.
 
bool testLinks (juce::Point< int > const &point) noexcept
 Test a point. More...
 
void test (juce::Rectangle< int > const &rect, std::vector< ObjectView *> &objects, std::vector< LinkView *> &links)
 Test a rectangle. More...
 
void testObjects (juce::Rectangle< int > const &rect, std::vector< ObjectView *> &objects)
 Test a rectangle. More...
 
void testLinks (juce::Rectangle< int > const &rect, std::vector< LinkView *> &links)
 Test a rectangle. More...
 
-Target getTarget () const noexcept
 Get the last touched Target.
 
-bool nothingTouched () const noexcept
 Returns true if nothing has been hit by the test, otherwise returns false.
 
-bool patcherTouched () const noexcept
 Returns true if the test hit the patcher, otherwise return false.
 
-bool objectTouched () const noexcept
 Returns true if the test hit an object, otherwise return false.
 
-bool linkTouched () const noexcept
 Returns true if the test hit a link, otherwise return false.
 
-PatcherView const & getPatcher () const noexcept
 Get the patcher.
 
-ObjectView * getObject () const noexcept
 Get the object box that has been touched by the last hit-test.
 
-LinkView * getLink () const noexcept
 Get the link that has been touched by the last hit-test.
 
Zone getZone () const noexcept
 Get the Zone of the Target that result of the hit-test. More...
 
-int getBorder () const noexcept
 Returns the type of border (if a border of an object box has hit).
 
size_t getIndex () const noexcept
 Returns the index of the Zone of the object box. More...
 
void test (juce::Rectangle< int > const &rect, std::vector< ObjectFrame * > &objects, std::vector< LinkView * > &links)
 Test a rectangle. More...
 
void testObjects (juce::Rectangle< int > const &rect, std::vector< ObjectFrame * > &objects)
 Test a rectangle. More...
 
void testLinks (juce::Rectangle< int > const &rect, std::vector< LinkView * > &links)
 Test a rectangle. More...
 
+Target getTarget () const noexcept
 Get the last touched Target.
 
+bool nothingTouched () const noexcept
 Returns true if nothing has been hit by the test, otherwise returns false.
 
+bool patcherTouched () const noexcept
 Returns true if the test hit the patcher, otherwise return false.
 
+bool objectTouched () const noexcept
 Returns true if the test hit an object, otherwise return false.
 
+bool linkTouched () const noexcept
 Returns true if the test hit a link, otherwise return false.
 
+PatcherView const & getPatcher () const noexcept
 Get the patcher.
 
+ObjectFrame * getObject () const noexcept
 Get the object box that has been touched by the last hit-test.
 
+LinkView * getLink () const noexcept
 Get the link that has been touched by the last hit-test.
 
Zone getZone () const noexcept
 Get the Zone of the Target that result of the hit-test. More...
 
+int getBorder () const noexcept
 Returns the type of border (if a border of an object box has hit).
 
size_t getIndex () const noexcept
 Returns the index of the Zone of the object box. More...
 
- - - + +

Friends

+
class LinkView
 
-class ObjectView
 
+class ObjectFrame
 

Detailed Description

The HitTester class...

Member Function Documentation

- -

◆ getIndex()

- +
@@ -223,9 +248,7 @@

-

◆ getZone()

- +

@@ -251,9 +274,7 @@

-

◆ reset()

- +

@@ -271,9 +292,7 @@

-

◆ test() [1/2]

- +

@@ -305,9 +324,7 @@

-

◆ test() [2/2]

- +

@@ -320,13 +337,13 @@

- + - + @@ -349,9 +366,7 @@

-

◆ testLinks() [1/2]

- +
std::vector< ObjectView *> & std::vector< ObjectFrame * > &  objects,
std::vector< LinkView *> & std::vector< LinkView * > &  links 
@@ -384,9 +399,7 @@

-

◆ testLinks() [2/2]

- +

@@ -399,7 +412,7 @@

- + @@ -421,9 +434,7 @@

-

◆ testObjects() [1/2]

- +
std::vector< LinkView *> & std::vector< LinkView * > &  links 
@@ -456,9 +467,7 @@

-

◆ testObjects() [2/2]

- +

@@ -471,7 +480,7 @@

- + @@ -502,7 +511,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_image_button-members.html b/docs/html/classkiwi_1_1_image_button-members.html index 971313db..34d81ed0 100644 --- a/docs/html/classkiwi_1_1_image_button-members.html +++ b/docs/html/classkiwi_1_1_image_button-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

std::vector< ObjectView *> & std::vector< ObjectFrame * > &  objects 
- + - - - - + +
@@ -75,12 +102,12 @@ colourChanged() override (defined in kiwi::ImageButton)kiwi::ImageButtonprotected ColourIds typedef (defined in kiwi::ImageButton)kiwi::ImageButton enablementChanged() override (defined in kiwi::ImageButton)kiwi::ImageButtonprotected - getCurrentImage() const noexceptkiwi::ImageButton - getDownImage() const noexceptkiwi::ImageButton - getImageBounds() constkiwi::ImageButtonvirtual - getNormalImage() const noexceptkiwi::ImageButton - getOverImage() const noexceptkiwi::ImageButton - getStyle() const noexceptkiwi::ImageButton + getCurrentImage() const noexceptkiwi::ImageButton + getDownImage() const noexceptkiwi::ImageButton + getImageBounds() const kiwi::ImageButtonvirtual + getNormalImage() const noexceptkiwi::ImageButton + getOverImage() const noexceptkiwi::ImageButton + getStyle() const noexceptkiwi::ImageButton ImageButton(juce::String const &button_name, std::unique_ptr< juce::Drawable > drawable, ButtonStyle style=ButtonStyle::ImageAboveTextLabel)kiwi::ImageButton paintButton(juce::Graphics &, bool isMouseOverButton, bool isButtonDown) override (defined in kiwi::ImageButton)kiwi::ImageButtonprotected resized() override (defined in kiwi::ImageButton)kiwi::ImageButtonprotected @@ -94,7 +121,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_image_button.html b/docs/html/classkiwi_1_1_image_button.html index b4eb662c..db6ad8a3 100644 --- a/docs/html/classkiwi_1_1_image_button.html +++ b/docs/html/classkiwi_1_1_image_button.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::ImageButton Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -87,79 +114,79 @@ - -

Public Types

+
using ButtonStyle = juce::DrawableButton::ButtonStyle
 
+
using ColourIds = juce::DrawableButton::ColourIds
 
- - - - - - + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +

Public Member Functions

+
 ImageButton (juce::String const &button_name, std::unique_ptr< juce::Drawable > drawable, ButtonStyle style=ButtonStyle::ImageAboveTextLabel)
 Constructor.
 
+
 ~ImageButton ()
 Destructor.
 
void setImages (juce::Drawable const *normal_image, juce::Drawable const *over_image=nullptr, juce::Drawable const *down_image=nullptr, juce::Drawable const *disabled_image=nullptr, juce::Drawable const *normal_image_on=nullptr, juce::Drawable const *over_image_on=nullptr, juce::Drawable const *down_image_on=nullptr, juce::Drawable const *disabled_image_on=nullptr)
 Sets up the images to draw for the various button states. More...
 
+
void setCommand (std::function< void(void)> fn)
 Set the command to execute when the button has been clicked.
 
void setButtonStyle (ButtonStyle new_style)
 Changes the button's style. More...
 
-ButtonStyle getStyle () const noexcept
 Returns the current style.
 
+ButtonStyle getStyle () const noexcept
 Returns the current style.
 
void setEdgeIndent (int num_pixels_indent)
 Gives the button an optional amount of space around the edge of the drawable. More...
 
-juce::Drawable * getCurrentImage () const noexcept
 Returns the image that the button is currently displaying.
 
-juce::Drawable * getNormalImage () const noexcept
 Returns the image that the button will use for its normal state.
 
-juce::Drawable * getOverImage () const noexcept
 Returns the image that the button will use when the mouse is over it.
 
-juce::Drawable * getDownImage () const noexcept
 Returns the image that the button will use when the mouse is held down on it.
 
-virtual juce::Rectangle< float > getImageBounds () const
 Can be overridden to specify a custom position for the image within the button.
 
+juce::Drawable * getCurrentImage () const noexcept
 Returns the image that the button is currently displaying.
 
+juce::Drawable * getNormalImage () const noexcept
 Returns the image that the button will use for its normal state.
 
+juce::Drawable * getOverImage () const noexcept
 Returns the image that the button will use when the mouse is over it.
 
+juce::Drawable * getDownImage () const noexcept
 Returns the image that the button will use when the mouse is held down on it.
 
+virtual juce::Rectangle< float > getImageBounds () const
 Can be overridden to specify a custom position for the image within the button.
 
- - - - - - @@ -167,9 +194,7 @@

Detailed Description

A button that displays a Drawable.

Member Function Documentation

- -

◆ setButtonStyle()

- +

Protected Member Functions

+
void paintButton (juce::Graphics &, bool isMouseOverButton, bool isButtonDown) override
 
+
void buttonStateChanged () override
 
+
void resized () override
 
+
void enablementChanged () override
 
+
void colourChanged () override
 
+
void clicked (juce::ModifierKeys const &modifiers) override
 This method is called when the button has been clicked.
 
@@ -188,9 +213,7 @@

-

◆ setEdgeIndent()

- +

@@ -209,9 +232,7 @@

-

◆ setImages()

- +

@@ -285,7 +306,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_instance-members.html b/docs/html/classkiwi_1_1_instance-members.html index f2a67d1d..bf8a4e69 100644 --- a/docs/html/classkiwi_1_1_instance-members.html +++ b/docs/html/classkiwi_1_1_instance-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -72,29 +99,33 @@ askUserToOpenPatcherDocument()kiwi::Instance closeAllPatcherWindows()kiwi::Instance closeWindow(Window &window)kiwi::Instance - getEngineInstance() constkiwi::Instance + closeWindowWithId(WindowId window_id)kiwi::Instance getPatcherClipboardData()kiwi::Instance - getUserId() const noexceptkiwi::Instance + getUserId() const noexceptkiwi::Instance Instance()kiwi::Instance + login()kiwi::Instance + logout()kiwi::Instance newPatcher()kiwi::Instance openFile(juce::File const &file)kiwi::Instance - openRemotePatcher(DocumentBrowser::Drive::DocumentSession &session)kiwi::Instance - removePatcher(PatcherManager const &patcher_manager)kiwi::Instance - removePatcherWindow(PatcherViewWindow &patcher_window)kiwi::Instance - showAboutKiwiWindow()kiwi::Instance - showAppSettingsWindow()kiwi::Instance - showAudioSettingsWindow()kiwi::Instance + openRemotePatcher(DocumentBrowser::Drive::DocumentSession &session)kiwi::Instance + removePatcherWindow(PatcherViewWindow &patcher_window)kiwi::Instance + showAboutKiwiWindow()kiwi::Instance + showAppSettingsWindow()kiwi::Instance + showAudioSettingsWindow()kiwi::Instance + showAuthWindow(AuthPanel::FormType type)kiwi::Instance showBeaconDispatcherWindow()kiwi::Instance showConsoleWindow()kiwi::Instance showDocumentBrowserWindow()kiwi::Instance - useEngineInstance()kiwi::Instance + timerCallback() override finalkiwi::Instance + useEngineInstance()kiwi::Instance + useEngineInstance() const kiwi::Instance ~Instance()kiwi::Instance
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_instance.html b/docs/html/classkiwi_1_1_instance.html index 77338a17..0882847e 100644 --- a/docs/html/classkiwi_1_1_instance.html +++ b/docs/html/classkiwi_1_1_instance.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::Instance Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -74,85 +101,109 @@ More...

#include <KiwiApp_Instance.h>

+
+Inheritance diagram for kiwi::Instance:
+
+
+ + + +
- - - - - - + + + + + + + + + + + + - - - - - + + + - - - + + + - - - - + + + - - - - - - + + + - - - @@ -160,9 +211,7 @@

Detailed Description

The Application Instance.

Member Function Documentation

- -

◆ closeAllPatcherWindows()

- +

Public Member Functions

+
 Instance ()
 Constructor.
 
+
 ~Instance ()
 Destructor.
 
-uint64_t getUserId () const noexcept
 Get the user ID of the Instance.
 
+
+void timerCallback () override final
 Timer call back, processes the scheduler events list.
 
+uint64_t getUserId () const noexcept
 Get the user ID of the Instance.
 
+void login ()
 Enables the document browser view.
 
+void logout ()
 Close all remote patchers and disable document browser view.
 
void newPatcher ()
 create a new patcher window.
 
+
engine::Instance & useEngineInstance ()
 Returns the engine::Instance.
 
-engine::Instance const & getEngineInstance () const
 Returns the engine::Instance.
 
+
+engine::Instance const & useEngineInstance () const
 Returns the engine::Instance.
 
bool openFile (juce::File const &file)
 Open a File.
 
+
void askUserToOpenPatcherDocument ()
 Open a patcher from file.
 
+
void removePatcherWindow (PatcherViewWindow &patcher_window)
 Removes the view of a certain patcher.
 
+
void closeWindow (Window &window)
 Attempt to close the given window asking user to save file if needed.
 
+void closeWindowWithId (WindowId window_id)
 Attempt to close the window with the given id, asking user to save file if needed.
 
bool closeAllPatcherWindows ()
 Attempt to close all document, after asking user to save them if needed. More...
 
-PatcherManager * openRemotePatcher (DocumentBrowser::Drive::DocumentSession &session)
 Attempt to create a new patcher with document Session informations.
 
+
+void openRemotePatcher (DocumentBrowser::Drive::DocumentSession &session)
 Attempt to create a new patcher with document Session informations.
 
void showAppSettingsWindow ()
 Brings the Application settings window to front.
 
-void removePatcher (PatcherManager const &patcher_manager)
 Removes a patcher from cach.
 
+
void showAudioSettingsWindow ()
 Opens a juce native audio setting pannel.
 
+
void showConsoleWindow ()
 Brings the Console to front.
 
+
+void showAuthWindow (AuthPanel::FormType type)
 Brings the Auth form window to front.
 
void showAboutKiwiWindow ()
 Brings the "About Kiwi" window to front.
 
+
void showDocumentBrowserWindow ()
 Brings the DocumentBrowserWindow to front.
 
+
void showBeaconDispatcherWindow ()
 Brings the BeaconDispatcherWindow to front.
 
+
std::vector< uint8_t > & getPatcherClipboardData ()
 Get Patcher clipboard data.
 
@@ -189,7 +238,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_instance.png b/docs/html/classkiwi_1_1_instance.png new file mode 100644 index 0000000000000000000000000000000000000000..cc04a4872803092a221b8e679ed78cc10aab6ac4 GIT binary patch literal 387 zcmeAS@N?(olHy`uVBq!ia0vp^VL%+f!3-p~Tr9c)q$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IXgg*;sxLn;{G&b?c7M1iCA{7%mI|BsnY za=T($y7|UiznKqz9G>CNqIO-uv%XPD=^odc*&EzLpZ=U(-}UWT^s)_^Clp_+wa%{% zm-kB+e&&)MTW2nxyD?ZvssF2unfOI{>(JBtC$(JSR8mqtYOlCKzDw1!obkXKGlmb> zrQU4QeYozR+AFSiN^jarof4R(ZyaFK5W8`J?VEgp=cRZBh6?Qs`x~yFyjQsHcDFiH z<_3lfFI{uC)vn%jaaruWcaQH)wUXFAH!G)c?&>5KsnvJWR&A`3cS!!Gcr7O&ZfK0{ d1-h=5@%%OuQ<>RCQos;n@O1TaS?83{1OR&Xs9*p9 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_iolet_highlighter-members.html b/docs/html/classkiwi_1_1_iolet_highlighter-members.html index a1c5e167..1f7ad6c8 100644 --- a/docs/html/classkiwi_1_1_iolet_highlighter-members.html +++ b/docs/html/classkiwi_1_1_iolet_highlighter-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -73,8 +100,8 @@ getTooltip() overridekiwi::IoletHighlighter getTooltipBounds(juce::String const &tip, juce::Point< int >, juce::Rectangle< int > parent_area, int width, int height) overridekiwi::IoletHighlightervirtual hide()kiwi::IoletHighlighter - highlightInlet(ObjectView const &object, const size_t index)kiwi::IoletHighlighter - highlightOutlet(ObjectView const &object, const size_t index)kiwi::IoletHighlighter + highlightInlet(ObjectFrame const &object, const size_t index)kiwi::IoletHighlighter + highlightOutlet(ObjectFrame const &object, const size_t index)kiwi::IoletHighlighter IoletHighlighter()kiwi::IoletHighlighter paint(juce::Graphics &g) overridekiwi::IoletHighlighter ~CustomTooltipClient()=defaultkiwi::CustomTooltipClientvirtual @@ -84,7 +111,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_iolet_highlighter.html b/docs/html/classkiwi_1_1_iolet_highlighter.html index ff6231f6..ddd465ab 100644 --- a/docs/html/classkiwi_1_1_iolet_highlighter.html +++ b/docs/html/classkiwi_1_1_iolet_highlighter.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::IoletHighlighter Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -81,44 +108,44 @@ - - - - - - - - - - - + + + + + + - - - @@ -132,7 +159,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_kiwi_app-members.html b/docs/html/classkiwi_1_1_kiwi_app-members.html index 7b3a4fbc..8ba58b3d 100644 --- a/docs/html/classkiwi_1_1_kiwi_app-members.html +++ b/docs/html/classkiwi_1_1_kiwi_app-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

Public Member Functions

+
 IoletHighlighter ()
 Constructor.
 
+
 ~IoletHighlighter ()=default
 Destructor.
 
+
void paint (juce::Graphics &g) override
 The paint method.
 
+
void hide ()
 Stop highlighting.
 
-void highlightInlet (ObjectView const &object, const size_t index)
 Highlight inlet.
 
-void highlightOutlet (ObjectView const &object, const size_t index)
 Highlight outlet.
 
+
+void highlightInlet (ObjectFrame const &object, const size_t index)
 Highlight inlet.
 
+void highlightOutlet (ObjectFrame const &object, const size_t index)
 Highlight outlet.
 
juce::String getTooltip () override
 Returns the string that this object wants to show as its tooltip.
 
+
juce::Rectangle< int > getTooltipBounds (juce::String const &tip, juce::Point< int >, juce::Rectangle< int > parent_area, int width, int height) override
 Returns the bounds of the tooltip to show.
 
+
bool drawTooltip (juce::Graphics &g, juce::String const &text, int width, int height) override
 Overriden to provide a custom drawing method.
 
- Public Member Functions inherited from kiwi::CustomTooltipClient
+
virtual ~CustomTooltipClient ()=default
 Destructor.
 
- + - - - - + +
@@ -74,21 +101,23 @@ bindToKeyMapping(juce::Component *target)kiwi::KiwiAppstatic closeWindow(Window &window)kiwi::KiwiApp commandStatusChanged()kiwi::KiwiAppstatic - createEditMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp - createFileMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp - createHelpMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp - createMenu(juce::PopupMenu &menu, const juce::String &menuName)kiwi::KiwiApp - createOpenRecentPatchersMenu(juce::PopupMenu &menu)kiwi::KiwiApp - createOptionsMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp - createViewMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp - createWindowMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp - error(std::string const &text)kiwi::KiwiAppstatic - getAllCommands(juce::Array< juce::CommandID > &commands) overridekiwi::KiwiApp - getApp()kiwi::KiwiAppstatic - getApplicationName() overridekiwi::KiwiApp - getApplicationVersion() overridekiwi::KiwiApp - getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo &result) overridekiwi::KiwiApp - getCommandManager()kiwi::KiwiAppstatic + createAccountMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp + createEditMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp + createFileMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp + createHelpMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp + createMenu(juce::PopupMenu &menu, const juce::String &menuName)kiwi::KiwiApp + createOpenRecentPatchersMenu(juce::PopupMenu &menu)kiwi::KiwiApp + createOptionsMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp + createViewMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp + createWindowMenu(juce::PopupMenu &menu) (defined in kiwi::KiwiApp)kiwi::KiwiApp + error(std::string const &text)kiwi::KiwiAppstatic + getAllCommands(juce::Array< juce::CommandID > &commands) overridekiwi::KiwiApp + getApp()kiwi::KiwiAppstatic + getApplicationName() overridekiwi::KiwiApp + getApplicationVersion() overridekiwi::KiwiApp + getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo &result) overridekiwi::KiwiApp + getCommandManager()kiwi::KiwiAppstatic + getCurrentUser()kiwi::KiwiAppstatic getKeyMappings()kiwi::KiwiAppstatic getMenuBarModel()kiwi::KiwiAppstatic getMenuNames()kiwi::KiwiApp @@ -99,27 +128,32 @@ isWindows()kiwi::KiwiAppstatic KiwiApp()=default (defined in kiwi::KiwiApp)kiwi::KiwiApp log(std::string const &text)kiwi::KiwiAppstatic - moreThanOneInstanceAllowed() overridekiwi::KiwiApp - perform(InvocationInfo const &info) overridekiwi::KiwiApp - post(std::string const &text)kiwi::KiwiAppstatic - processEngine()kiwi::KiwiApp - shutdown() overridekiwi::KiwiApp - systemRequestedQuit() overridekiwi::KiwiApp + logout()kiwi::KiwiAppstatic + moreThanOneInstanceAllowed() overridekiwi::KiwiApp + perform(InvocationInfo const &info) overridekiwi::KiwiApp + post(std::string const &text)kiwi::KiwiAppstatic + setAuthUser(Api::AuthUser const &auth_user)kiwi::KiwiAppstatic + shutdown() overridekiwi::KiwiApp + systemRequestedQuit() overridekiwi::KiwiApp + timerCallback() override finalkiwi::KiwiApp use()kiwi::KiwiAppstatic - useEngineInstance()kiwi::KiwiAppstatic - useInstance()kiwi::KiwiAppstatic - useLookAndFeel()kiwi::KiwiAppstatic - userID()kiwi::KiwiAppstatic + useApi()kiwi::KiwiAppstatic + useEngineInstance()kiwi::KiwiAppstatic + useInstance()kiwi::KiwiAppstatic + useLookAndFeel()kiwi::KiwiAppstatic + userID()kiwi::KiwiAppstatic + useScheduler()kiwi::KiwiAppstatic useSettings()kiwi::KiwiAppstatic useTooltipWindow()kiwi::KiwiAppstatic warning(std::string const &text)kiwi::KiwiAppstatic ~KiwiApp()=default (defined in kiwi::KiwiApp)kiwi::KiwiApp + ~Listener()=defaultkiwi::NetworkSettings::Listenervirtual
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_kiwi_app.html b/docs/html/classkiwi_1_1_kiwi_app.html index bad4422f..7d392218 100644 --- a/docs/html/classkiwi_1_1_kiwi_app.html +++ b/docs/html/classkiwi_1_1_kiwi_app.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::KiwiApp Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -77,6 +104,7 @@
+kiwi::NetworkSettings::Listener
@@ -90,179 +118,205 @@
- - - - - - - - - - - + + + - - - - + + - - - - - - - - - + + + +

Public Member Functions

+
void initialise (juce::String const &commandLine) override
 Called when the application starts.
 
+
void anotherInstanceStarted (juce::String const &command_line) override
 Indicates that the user has tried to start up another instance of the app.
 
+
void shutdown () override
 Called to allow the application to clear up before exiting.
 
+
void systemRequestedQuit () override
 Called when the operating system is trying to close the application.
 
+
const juce::String getApplicationName () override
 Returns the application's name.
 
+
const juce::String getApplicationVersion () override
 Returns the application's version number.
 
+
bool moreThanOneInstanceAllowed () override
 Checks whether multiple instances of the app are allowed.
 
-void processEngine ()
 Run the engine scheduler executed queued events.
 
+
+void timerCallback () override final
 Timer call back, processes the scheduler events list.
 
void closeWindow (Window &window)
 Attempt to close the given window asking user to save file if needed.
 
+
juce::StringArray getMenuNames ()
 Called by MainMenuModel to get the menu names.
 
+
void createMenu (juce::PopupMenu &menu, const juce::String &menuName)
 Called by MainMenuModel to create menus.
 
+
void createOpenRecentPatchersMenu (juce::PopupMenu &menu)
 Called by createMenu to create each menu.
 
+
+void createAccountMenu (juce::PopupMenu &menu)
 
void createFileMenu (juce::PopupMenu &menu)
 
+
void createEditMenu (juce::PopupMenu &menu)
 
+
void createViewMenu (juce::PopupMenu &menu)
 
+
void createOptionsMenu (juce::PopupMenu &menu)
 
+
void createWindowMenu (juce::PopupMenu &menu)
 
+
void createHelpMenu (juce::PopupMenu &menu)
 
+
void handleMainMenuCommand (int menuItemID)
 Called by MainMenuModel to handle the main menu command.
 
+
void getAllCommands (juce::Array< juce::CommandID > &commands) override
 This must return a complete list of commands that this target can handle.
 
+
void getCommandInfo (juce::CommandID commandID, juce::ApplicationCommandInfo &result) override
 This must provide details about one of the commands that this target can perform.
 
+
bool perform (InvocationInfo const &info) override
 This must actually perform the specified command.
 
- Public Member Functions inherited from kiwi::NetworkSettings::Listener
+virtual ~Listener ()=default
 Destructor.
 
- - - - - - - + + + + + + + + + + + + + + + - - - - - - - - - - - - -

Static Public Member Functions

+
static bool isMacOSX ()
 Returns true if the app is running in a Mac OSX operating system.
 
+
static bool isLinux ()
 Returns true if the app is running in a Linux operating system.
 
+
static bool isWindows ()
 Returns true if the app is running in a Windows operating system.
 
+
static KiwiApp & use ()
 Get the current running application instance.
 
+
static KiwiApp * getApp ()
 Get the current running application instance.
 
+
static Instance & useInstance ()
 Get the current running kiwi instance.
 
+
+static Api & useApi ()
 Get the Api object.
 
+static tool::Scheduler & useScheduler ()
 Gets the application scheduler.
 
+static void setAuthUser (Api::AuthUser const &auth_user)
 Sets the auth user.
 
+static Api::AuthUser const & getCurrentUser ()
 Returns the current user.
 
+static void logout ()
 Log-out the user.
 
static engine::Instance & useEngineInstance ()
 Get the current running engine instance.
 
+
static uint64_t userID ()
 Get the user id associated to this running application instance.
 
+
static StoredSettings & useSettings ()
 Returns the application stored settings.
 
+
static juce::MenuBarModel * getMenuBarModel ()
 Returns the MenuBarModel.
 
+
static LookAndFeel & useLookAndFeel ()
 Returns the application look and feel.
 
+
static TooltipWindow & useTooltipWindow ()
 Returns the Tooltip Window component.
 
+
static void log (std::string const &text)
 post a log message in the Console.
 
+
static void post (std::string const &text)
 post a message in the Console.
 
+
static void warning (std::string const &text)
 post a warning message in the Console.
 
+
static void error (std::string const &text)
 post an error message in the Console.
 
static void bindToCommandManager (ApplicationCommandTarget *target)
 Bind a command target to the command manager. More...
 
+
static void bindToKeyMapping (juce::Component *target)
 Bind a component to the key mapping set.
 
+
static juce::ApplicationCommandManager & getCommandManager ()
 Get the global ApplicationCommandManager.
 
+
static void commandStatusChanged ()
 Notify command manager that a command status changed.
 
+
static juce::KeyPressMappingSet * getKeyMappings ()
 Get the command manager key mapping.
 

Member Function Documentation

- -

◆ bindToCommandManager()

- +
@@ -303,7 +357,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_kiwi_app.png b/docs/html/classkiwi_1_1_kiwi_app.png index 4b1294a8f5c2a9e6308d816b7c4a58776fdf97cb..b2f5cefddb6f784b5fd42b3f5b26ddbb6482319e 100644 GIT binary patch literal 1315 zcmeAS@N?(olHy`uVBq!ia0y~yU@`!*12~w0q=CzRJs>3!;1lBd|Nnm=^TnI5rTvE{ z09jys;J^Xa&O7ozE=Ng_UoZnu5eQs86=KA|z_Q8H#WAFU@$KB#MW3|Y?XLIKTzWC#@14Buw=;5f`vW-&o|ht~9CC5#an1}Q8?8xY9ow#IKgoNj-W)$Ax^{tgW^V816_xrC~=2oY(Qs?xP`SU!3MBNjEKE~Qv zzSLr$I{(j~pYz|yol{kMG$-|*|Lgy24L*x5;pYpTr1isN#?pt4vz*{fF0# zjt=I}f3I^D%lw(lu>Nmt%g-+!sw=zvTO!ltS}H>}2ke~nbyo9*5M6!ezJSjbo~s^( z%vfoYpS`T&@%489@*y}GvT*cP%iyr1^80-P(hud#TC-NX`&w51)vC*uyK*L~x#m1w6RI^$ z>C`6qos-|3Z=HE>|J#!KpJrZ{%wv?#%&}j(M3&vMEL#TXb}he_$e@$2ZQYhEa_PEW zwB!8FLZcr`t=wjWZhicq)l4w0e%JM9tGboX#LWp#e5UBzdXh2yoSWt%9rwg(F<-5I z=tRi`U#ctm7|x#9b$h}R?;leQj{cp;WqkeqlKFR~rgH_W%~6%#%N5+xlyt$+v36p{ zDNg;@)BVdQpPpONX|Vfy`1DN8XuMZ^B6Ycs62rBCMwZt1vwJI?snB=c<% zo1SelYRs|iU!Q*S>7v+AH=oZh{cFmeyZ?6FjIT#jUuxB<_o!SASR(JaYt~`|LBX{V z$=)tUr2kAcnDpg)1TZGE%1-JjJ>u2rQF;5bT-nD@Ur_LUQliRA&D!7~mm})H#FPa} zRdyh?prnPw%L_=JJ1OszGYb&DxLnsn+Px-IUYl`08nkUu2KKXg5cy1y? z)yGZ)2KITe%kREiHG7)@!`_PM87pkMXdX0P7zLgS2= z+_yptuT2D7*r+X04<#6$)j2T|sE`+!<7d~@ze*uO` zL_t(|0qvdJvV$NDMOR+B|NoDVMQ#deDKm8DOj@_l1hYs;ea6gekuXVGB4&93q z*$}P_1y>K%j}q*emCoy=Chj3df5RWl>&Wb~_9c(3%GG7%R=i<#YxvA+poKMfUcDNY zR*GSd|F0^q`#ubgx)1y3B}tE}>L5u2a+V~`$yt&#r^PHYvo!)3*9%~g7P4Nib+Co3 z4YdrmlJ#%<&{+VJau&dxoCPo^X93K~Spai#7QmdG1u!RP0p&6?TOsTiyu(^&v>A95DJoEEdp%+}}+cpN=k8M7&^00000NkvXXu0mjfGE>rZ diff --git a/docs/html/classkiwi_1_1_kiwi_app_1_1_async_quit_retrier-members.html b/docs/html/classkiwi_1_1_kiwi_app_1_1_async_quit_retrier-members.html index e0675154..a97f750d 100644 --- a/docs/html/classkiwi_1_1_kiwi_app_1_1_async_quit_retrier-members.html +++ b/docs/html/classkiwi_1_1_kiwi_app_1_1_async_quit_retrier-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -76,7 +103,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_kiwi_app_1_1_async_quit_retrier.html b/docs/html/classkiwi_1_1_kiwi_app_1_1_async_quit_retrier.html index 525c5231..40e87540 100644 --- a/docs/html/classkiwi_1_1_kiwi_app_1_1_async_quit_retrier.html +++ b/docs/html/classkiwi_1_1_kiwi_app_1_1_async_quit_retrier.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::KiwiApp::AsyncQuitRetrier Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -80,7 +107,7 @@ -

Public Member Functions

+
void timerCallback ()
 
@@ -92,7 +119,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_lasso-members.html b/docs/html/classkiwi_1_1_lasso-members.html index ee0e91d4..95f5baa9 100644 --- a/docs/html/classkiwi_1_1_lasso-members.html +++ b/docs/html/classkiwi_1_1_lasso-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -71,7 +98,7 @@ - + @@ -81,7 +108,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_lasso.html b/docs/html/classkiwi_1_1_lasso.html index e68433ef..d2e47b35 100644 --- a/docs/html/classkiwi_1_1_lasso.html +++ b/docs/html/classkiwi_1_1_lasso.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::Lasso Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
begin(juce::Point< int > const &point, const bool preserve_selection)kiwi::Lasso
end()kiwi::Lasso
isPerforming() const noexceptkiwi::Lasso
isPerforming() const noexceptkiwi::Lasso
Lasso(PatcherView &patcher)kiwi::Lasso
paint(juce::Graphics &g) overridekiwi::Lasso
perform(juce::Point< int > const &point, bool objects, bool links, const bool preserve)kiwi::Lasso
- + - - - - + +
@@ -80,15 +107,15 @@ - - - @@ -98,19 +125,17 @@ - - - - + + +

Public Member Functions

+
 Lasso (PatcherView &patcher)
 Contructor.
 
+
 ~Lasso ()
 Destructor.
 
+
void paint (juce::Graphics &g) override
 The paint method.
 
void perform (juce::Point< int > const &point, bool objects, bool links, const bool preserve)
 Perform the selection of the links and the boxes. More...
 
+
void end ()
 Ends the selection of the links and the boxes.
 
-bool isPerforming () const noexcept
 Retrieve Returns true if the Lasso is performing the selection.
 
+bool isPerforming () const noexcept
 Retrieve Returns true if the Lasso is performing the selection.
 

Member Function Documentation

- -

◆ begin()

- +
@@ -145,9 +170,7 @@

-

◆ perform()

- +

@@ -205,7 +228,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_link_view-members.html b/docs/html/classkiwi_1_1_link_view-members.html index a55d2dcb..a676db3f 100644 --- a/docs/html/classkiwi_1_1_link_view-members.html +++ b/docs/html/classkiwi_1_1_link_view-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -71,11 +98,11 @@ - - + + - - + + @@ -93,7 +120,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_link_view.html b/docs/html/classkiwi_1_1_link_view.html index 933b67a6..0f96ca93 100644 --- a/docs/html/classkiwi_1_1_link_view.html +++ b/docs/html/classkiwi_1_1_link_view.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::LinkView Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
componentMovedOrResized(Component &component, bool was_moved, bool was_resized) overridekiwi::LinkView
distantSelectionChanged(std::set< uint64_t > distant_user_id_selection) (defined in kiwi::LinkView)kiwi::LinkView
getModel() constkiwi::LinkViewinline
hitTest(juce::Point< int > const &pt, HitTester &result) constkiwi::LinkView
getModel() const kiwi::LinkViewinline
hitTest(juce::Point< int > const &pt, HitTester &result) const kiwi::LinkView
hitTest(juce::Rectangle< float > const &rect)kiwi::LinkView
isSelected() const noexceptkiwi::LinkView
isSignal() const (defined in kiwi::LinkView)kiwi::LinkView
isSelected() const noexceptkiwi::LinkView
isSignal() const (defined in kiwi::LinkView)kiwi::LinkView
linkChanged(model::Link &link) (defined in kiwi::LinkView)kiwi::LinkView
LinkView(PatcherView &patcherview, model::Link &link_m)kiwi::LinkView
LinkViewBase()=default (defined in kiwi::LinkViewBase)kiwi::LinkViewBase
- + - - - - + +
@@ -86,45 +113,45 @@ - - - - - - - - - + + + + + + - - - - - - + + - - - - + + + @@ -135,26 +162,24 @@ - - - -

Public Member Functions

+
 LinkView (PatcherView &patcherview, model::Link &link_m)
 Constructor.
 
+
 ~LinkView ()
 Destructor.
 
-model::Link & getModel () const
 Get the Link model.
 
-bool isSelected () const noexcept
 Returns true if the link is selected.
 
+
+model::Link & getModel () const
 Get the Link model.
 
+bool isSelected () const noexcept
 Returns true if the link is selected.
 
void linkChanged (model::Link &link)
 
+
void objectChanged (model::Object &object)
 
+
void localSelectionChanged (bool selected_for_view)
 
+
void distantSelectionChanged (std::set< uint64_t > distant_user_id_selection)
 
-bool isSignal () const
 
+
+bool isSignal () const
 
void paint (juce::Graphics &g) override
 
-bool hitTest (juce::Point< int > const &pt, HitTester &result) const
 internal kiwi PatcherView Hit-Testing.
 
+
+bool hitTest (juce::Point< int > const &pt, HitTester &result) const
 internal kiwi PatcherView Hit-Testing.
 
bool hitTest (juce::Rectangle< float > const &rect)
 internal kiwi PatcherView HitTesting (overlaps a rectangle).
 

Additional Inherited Members

- Protected Member Functions inherited from kiwi::LinkViewBase
+
void updateBounds ()
 
- Protected Attributes inherited from kiwi::LinkViewBase
+
juce::Point< int > m_last_outlet_pos
 
+
juce::Point< int > m_last_inlet_pos
 
+
juce::Path m_path
 

Detailed Description

The juce link Component.

Member Function Documentation

- -

◆ componentMovedOrResized()

- +
@@ -213,7 +238,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_link_view_base-members.html b/docs/html/classkiwi_1_1_link_view_base-members.html index 22e9c436..93eb4e55 100644 --- a/docs/html/classkiwi_1_1_link_view_base-members.html +++ b/docs/html/classkiwi_1_1_link_view_base-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -80,7 +107,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_link_view_base.html b/docs/html/classkiwi_1_1_link_view_base.html index 9c54002f..8718e0b6 100644 --- a/docs/html/classkiwi_1_1_link_view_base.html +++ b/docs/html/classkiwi_1_1_link_view_base.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::LinkViewBase Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -88,19 +115,19 @@ -

Protected Member Functions

+
void updateBounds ()
 
- - -

Protected Attributes

+
juce::Point< int > m_last_outlet_pos
 
+
juce::Point< int > m_last_inlet_pos
 
+
juce::Path m_path
 
@@ -115,7 +142,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_link_view_creator-members.html b/docs/html/classkiwi_1_1_link_view_creator-members.html index 72fc3bca..1c7b3e59 100644 --- a/docs/html/classkiwi_1_1_link_view_creator-members.html +++ b/docs/html/classkiwi_1_1_link_view_creator-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -69,12 +96,12 @@

This is the complete list of members for kiwi::LinkViewCreator, including all inherited members.

- - - - + + + + - + @@ -88,7 +115,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_link_view_creator.html b/docs/html/classkiwi_1_1_link_view_creator.html index 44117287..0678a18c 100644 --- a/docs/html/classkiwi_1_1_link_view_creator.html +++ b/docs/html/classkiwi_1_1_link_view_creator.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::LinkViewCreator Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
getBindedIndex() constkiwi::LinkViewCreatorinline
getBindedObject() constkiwi::LinkViewCreatorinline
getEndPosition() const noexceptkiwi::LinkViewCreator
isBindedToSender() constkiwi::LinkViewCreatorinline
getBindedIndex() const kiwi::LinkViewCreatorinline
getBindedObject() const kiwi::LinkViewCreatorinline
getEndPosition() const noexceptkiwi::LinkViewCreator
isBindedToSender() const kiwi::LinkViewCreatorinline
LinkViewBase()=default (defined in kiwi::LinkViewBase)kiwi::LinkViewBase
LinkViewCreator(ObjectView &binded_object, const size_t index, bool is_sender, juce::Point< int > dragged_pos)kiwi::LinkViewCreator
LinkViewCreator(ObjectFrame &binded_object, const size_t index, bool is_sender, juce::Point< int > dragged_pos)kiwi::LinkViewCreator
m_last_inlet_pos (defined in kiwi::LinkViewBase)kiwi::LinkViewBaseprotected
m_last_outlet_pos (defined in kiwi::LinkViewBase)kiwi::LinkViewBaseprotected
m_path (defined in kiwi::LinkViewBase)kiwi::LinkViewBaseprotected
- + - - - - + +
@@ -86,52 +113,52 @@ - - - - + + + - - - - - - - - - - + + + + + + + + + - - - - + + +

Public Member Functions

- LinkViewCreator (ObjectView &binded_object, const size_t index, bool is_sender, juce::Point< int > dragged_pos)
 Constructor.
 
+
+ LinkViewCreator (ObjectFrame &binded_object, const size_t index, bool is_sender, juce::Point< int > dragged_pos)
 Constructor.
 
 ~LinkViewCreator ()=default
 Destructor.
 
-ObjectView & getBindedObject () const
 Get the binded object.
 
-size_t getBindedIndex () const
 Get the portlet index.
 
-size_t isBindedToSender () const
 Returns true if the link is binded to an outlet.
 
+
+ObjectFrame & getBindedObject () const
 Get the binded object.
 
+size_t getBindedIndex () const
 Get the portlet index.
 
+size_t isBindedToSender () const
 Returns true if the link is binded to an outlet.
 
void setEndPosition (juce::Point< int > const &pos)
 Set end position of the link.
 
-juce::Point< int > getEndPosition () const noexcept
 Get The end position of the link.
 
+
+juce::Point< int > getEndPosition () const noexcept
 Get The end position of the link.
 
void paint (juce::Graphics &g) override
 
- - - -

Additional Inherited Members

- Protected Member Functions inherited from kiwi::LinkViewBase
+
void updateBounds ()
 
- Protected Attributes inherited from kiwi::LinkViewBase
+
juce::Point< int > m_last_outlet_pos
 
+
juce::Point< int > m_last_inlet_pos
 
+
juce::Path m_path
 
@@ -146,7 +173,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_login_form-members.html b/docs/html/classkiwi_1_1_login_form-members.html new file mode 100644 index 00000000..8815d04b --- /dev/null +++ b/docs/html/classkiwi_1_1_login_form-members.html @@ -0,0 +1,125 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::LoginForm Member List
+
+
+ +

This is the complete list of members for kiwi::LoginForm, including all inherited members.

+ + + + + + + + + + + + + + + + + + + +
addField(Args &&...args)kiwi::FormComponentprotected
clearFields()kiwi::FormComponentprotected
dismiss()kiwi::FormComponentvirtual
FormComponent(std::string const &submit_button_text, std::string const &overlay_text="")kiwi::FormComponent
getBestHeight()kiwi::FormComponent
getFieldsHeight()kiwi::FormComponentprotected
getFieldValue(std::string const &name)kiwi::FormComponentprotected
hasOverlay()kiwi::FormComponentprotected
hideOverlay()kiwi::FormComponentprotected
LoginForm()kiwi::LoginForm
removeField(std::string const &name)kiwi::FormComponentprotected
resized() override (defined in kiwi::FormComponent)kiwi::FormComponentprotected
setSubmitText(std::string const &submit_text)kiwi::FormComponentprotected
showAlert(std::string const &message, AlertBox::Type type=AlertBox::Type::Error)kiwi::FormComponentprotected
showOverlay()kiwi::FormComponentprotected
showSuccessOverlay(juce::String const &message)kiwi::FormComponentprotected
~FormComponent()kiwi::FormComponentvirtual
~LoginForm()=defaultkiwi::LoginForm
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_login_form.html b/docs/html/classkiwi_1_1_login_form.html new file mode 100644 index 00000000..fbab0bc4 --- /dev/null +++ b/docs/html/classkiwi_1_1_login_form.html @@ -0,0 +1,216 @@ + + + + + + +Kiwi: kiwi::LoginForm Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
kiwi::LoginForm Class Reference
+
+
+
+Inheritance diagram for kiwi::LoginForm:
+
+
+ + +kiwi::FormComponent + +
+ + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 LoginForm ()
 Constructor. More...
 
+ ~LoginForm ()=default
 Destructor.
 
- Public Member Functions inherited from kiwi::FormComponent
 FormComponent (std::string const &submit_button_text, std::string const &overlay_text="")
 Constructor. More...
 
+virtual ~FormComponent ()
 Destructor.
 
virtual void dismiss ()
 This is called when the form is dismissed. More...
 
int getBestHeight ()
 Computes and returns the best height for this form. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from kiwi::FormComponent
+template<class FieldType , class... Args>
FieldType & addField (Args &&...args)
 Add a new field.
 
+juce::Value getFieldValue (std::string const &name)
 Returns a field Value.
 
+void removeField (std::string const &name)
 Remove fields by name.
 
+void clearFields ()
 Remove all fields.
 
+void showAlert (std::string const &message, AlertBox::Type type=AlertBox::Type::Error)
 Show an Alert on the top of the form;.
 
+void showOverlay ()
 Show overlay.
 
+void showSuccessOverlay (juce::String const &message)
 Show success overlay.
 
+void hideOverlay ()
 Hide overlay.
 
+void setSubmitText (std::string const &submit_text)
 Changes the submit button text.
 
+bool hasOverlay ()
 Returns true if the overlay component is visible.
 
+void resized () override
 
+int getFieldsHeight ()
 Returns the height of all fields.
 
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
kiwi::LoginForm::LoginForm ()
+
+ +

Constructor.

+

Creates a login form.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.h
    • +
  • Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_login_form.png b/docs/html/classkiwi_1_1_login_form.png new file mode 100644 index 0000000000000000000000000000000000000000..474c3dc958fa65990f68a9cc77ce349890368355 GIT binary patch literal 1145 zcmeAS@N?(olHy`uVBq!ia0y~yU=#qdJ2;quq{K9ry&x*UC&cyt|NlVdi#K0O`wvY3 zvcUMjfdj0acjSRwj*=k1U*`yq)PZT#rX4u2#+)^u}L$#T2q!K zDb8H^Mx-dd&e(YV`M%p_oS9_}CzHjmm+?CP_O`vJzGUY!Q)PK!quLv76Vl`6&a^zM zr+BIV+5V7U|L*MDBKvl>xO=tMYfZ(!i*Gm0+!LXdVzK?&=57CH&eX2-^Z0)2cJlj@ z_g9~NU3}(D?;eGel%K06t<S5e><=D9a41~) z+S&8xk4*j%Cx(a59^1I(+3}etDKbo+lNHEnVRbK+;ixE+#ySCq!d8YZZI*x-#fC>* zj3VJ23wAg$EM52dmkr|%7n_d^N1cd5PqUm>ty;y$cc3!J)kQ{%yOZOnlakZM2^|4C zDoRs|ximk8N56}oHNT_dYRKw&de59#kHdQ>=N{vl7?sg~ z`~JfyTW$4StA9T`8W!T)_Y?l{ovs!()^W(F%i$8O{^saxnFxFXV zk&p5Itf${(<>NI|;uP~aGVj*4PS`kolT%I1i9feK>#w@}M=#|@s+iNavvY#;ckf!_ zCX%@Aw9mN`?K2x1d!(;z*%>|I>&NtasY*(AvkL9|I&O5ey0j!I3NHMk?4+dh4aqAa zK%YI$0r|C$_dsh9vxOMbhH1OD2_}Gp`LLS~%Y(!<%mF$q)IsY&u?q^-qMCAKGxs@r z++L&J{(g0NPp|)bnfod%2@~VlK79GH&&}iT-;&v`ttF)ezpZ2L#M@fl|7$1nV>^eW zDbIbjU(&nVUbfrp@T^|-mCfM%bdHz*c8j>FmG?M3X-fN$n|bEb4i`OrU?7SM8u6v< zWBIe%DW%8xTI-2Ng_(+zRYRZq?f1|rn|bq!)UvyxEevnYRiEE6W5UTCrV6X@)f4j4 z81_u#_LFS5o~+oA1Vcq;ic6;y - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -84,7 +111,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_look_and_feel.html b/docs/html/classkiwi_1_1_look_and_feel.html index 63ca261d..c057a5dd 100644 --- a/docs/html/classkiwi_1_1_look_and_feel.html +++ b/docs/html/classkiwi_1_1_look_and_feel.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::LookAndFeel Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -81,53 +108,51 @@ - - - - - - - -

Public Member Functions

+
 LookAndFeel ()
 Constructor.
 
+
 ~LookAndFeel ()=default
 Destructor.
 
juce::Typeface::Ptr getTypefaceForFont (juce::Font const &font) override
 Returns the typeface for a certain font name and style. More...
 
+
void drawPropertyPanelSectionHeader (juce::Graphics &g, const juce::String &name, bool is_open, int width, int height) override
 Overriden to draw a custom PropertyPanel section header.
 
+
void drawTableHeaderBackground (juce::Graphics &g, juce::TableHeaderComponent &header) override
 Overriden to draw a custom Table header background.
 
+
void drawTableHeaderColumn (juce::Graphics &g, juce::String const &columnName, int, int width, int height, bool isMouseOver, bool isMouseDown, int columnFlags) override
 Overriden to draw a custom Table header column.
 
+
void drawButtonBackground (juce::Graphics &g, juce::Button &b, juce::Colour const &bgcolor, bool mouse_over, bool mouse_down) override
 Custom Button background drawing.
 
+
void paintToolbarBackground (juce::Graphics &g, int w, int h, juce::Toolbar &toolbar) override
 Custom Toolbar background drawing.
 
+
void paintToolbarButtonBackground (juce::Graphics &g, int, int, bool isMouseOver, bool isMouseDown, juce::ToolbarItemComponent &component) override
 Custom Toolbar Button background drawing.
 
-

Static Public Member Functions

+
static juce::TextLayout layoutTooltipText (juce::String const &text, juce::Colour colour=juce::Colours::black) noexcept
 Make a textLayout for tootips.
 

Member Function Documentation

- -

◆ getTypefaceForFont()

- +
@@ -163,7 +188,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_message_view-members.html b/docs/html/classkiwi_1_1_message_view-members.html new file mode 100644 index 00000000..eb7ef9eb --- /dev/null +++ b/docs/html/classkiwi_1_1_message_view-members.html @@ -0,0 +1,137 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+

+ + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::MessageView Member List
+
+
+ +

This is the complete list of members for kiwi::MessageView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
addListener(Listener &listener)kiwi::EditableObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
create(model::Object &object_model)kiwi::MessageViewstatic
declare() (defined in kiwi::MessageView)kiwi::MessageViewstatic
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
edit()kiwi::EditableObjectView
EditableObjectView(model::Object &object_model)kiwi::EditableObjectView
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getLabel()kiwi::EditableObjectViewprotected
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
MessageView(model::Object &object_model)kiwi::MessageView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
removeListener(Listener &listener)kiwi::EditableObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setEditable(bool editable)kiwi::EditableObjectViewprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~EditableObjectView()kiwi::EditableObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~MessageView()kiwi::MessageView
~ObjectView()kiwi::ObjectViewvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_message_view.html b/docs/html/classkiwi_1_1_message_view.html new file mode 100644 index 00000000..ca70a5b9 --- /dev/null +++ b/docs/html/classkiwi_1_1_message_view.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::MessageView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
+
kiwi::MessageView Class Reference
+
+
+ +

The view of any textual kiwi object. + More...

+ +

#include <KiwiApp_MessageView.h>

+
+Inheritance diagram for kiwi::MessageView:
+
+
+ + +kiwi::EditableObjectView +kiwi::ObjectView +kiwi::model::Object::Listener + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ MessageView (model::Object &object_model)
 Constructor.
 
+ ~MessageView ()
 Destructor.
 
- Public Member Functions inherited from kiwi::EditableObjectView
 EditableObjectView (model::Object &object_model)
 Constructor. More...
 
+ ~EditableObjectView ()
 Destructor.
 
+void addListener (Listener &listener)
 Add a listener.
 
+void removeListener (Listener &listener)
 Remove a listener.
 
+void edit ()
 Edits the label.
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + + +

+Static Public Member Functions

+static void declare ()
 
+static std::unique_ptr< ObjectView > create (model::Object &object_model)
 Creation method.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- Protected Member Functions inherited from kiwi::EditableObjectView
+juce::Label & getLabel ()
 Returns the label created by the editable object.
 
void setEditable (bool editable)
 Sets the editable object view as editable or not. More...
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+

Detailed Description

+

The view of any textual kiwi object.

+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_MessageView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_MessageView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_message_view.png b/docs/html/classkiwi_1_1_message_view.png new file mode 100644 index 0000000000000000000000000000000000000000..7517658c92881535f993839e4e28b6bd87b28c62 GIT binary patch literal 2284 zcmbW32UJsO7RO%*1|}FCfuTg2tHW4mLJ-7A8>*BbFe^<0BB7%PLYoK#8BmJAAT1E8 z2%~@?tVCqM1cxHTK|=>A!b%ZHC<~!U=F85mXPDh{JZIiH_r3dn?|a|*?)QH8-j`rw zZHhvokq`u-%*~8!AxHoLe7Z0koXxtOMZrbN#?s!H$KwHac3~|fwIvOB|28_EzAxde zJdnafTWdQA4B{Vso%ZVB7RlVmz&;$dm_HwSPi;Sv1+unZ@`nT zB_n}i;cYL>ZKd(z-K8EK)W38rj9X#n>qZC-DUE3)g_OedElOi3j-Go}iFX=1n$0d; ztr|%|mrlB*n75$PV9+TMRhU zA=VYxiki0*>~TYKjy9)y_*a@>ISq}`zfcfPiZv` zCDfqB+s{dcaZ|P5xS7vwJ5cUVYCo5$WxSN_7Hxl5a0hWZsfC2b?y3|qrZ}fiXZ)QjSjtHvDHd+RyW>(sm?Ik}J=aq)VIkDB7v<}*!qE$qehvVCl}{Pl;7+(Y%_!H3El zh)j`SL%g`dbnrtwCudE&H_`LTXh1Mt4fS>u_tUc>3lx)ivTphdjXL=w;8w*^6y)?b z)CcD;FT=yQ5<3^psA*LEfVm!4oq~b96EHv}?@^Yw(4`ry_a`t?@$OHt(3=Jr(db&Y z$ZHr2QqZ9}<2g@gGy7&CALz^cZRf=gP3!AFL$V4eNU*8N-W;-#1rOvtV+A9Nq4P)x z_8N|q)DH)!{1wCRf1&15xE5gtD1?ZueDW@UctKboq~Bu$K_>4}OnjfhS2ICZeaCo- z#X)`QX&gPvTuP+5GHN<+Rj!Jt{1H!-vDdsu}YAZrChuT$Or# z53!(d^~IEWKJvQ*Z~{TqCk@5=NQ_R~B+8>zgE?;N-I2ZUljl`6B{S{t>}u1BXE9 z`(Gsuh|!HhoVZVnfJ%blv$w|zB#YqS`w|0b&0~I_DB{wF`$&t65ilKnG$i~z=|MVF zqyzB6e$Hqki~V0g0!2dND&!@wuD@cvNaNBIQ=7tD5xm}e0;0aD-HMf06H*z)g*C5kC<&nj*#O;3kS!wS) zK1aNldpOePbM!htmYt(V1epyd$-c#yIih${E@K>*S8XWYlB@L^lHd*H}MZt)x-yEapMqP<3W!% z)_P51*SIr``cFhnlm^OUwEMR|>L1{|99Cy<-q^ZpmDKVuCb1;};b$@!xe+`TB^W9# zZCZX%ySng0r;BpiXsBI8wrwnS$Ue42K&ku*((>rkL8AdWv+|2uuX8C)7Rn$+qv3p> z<1x@vrRSxLRHZZoWVKo44-zim_qNeU0&Roh_@5^7N5yY8xMG6~Coap8XWv3PC7){1 zNL4j=cw|+8NX9_7fBje$y5>qExsnfn$#0IiK0F5f1ZskC>SwHbF|;vc9~qj3#ff|# z$N!IOkt)A2Lc(Md;&S|bejof(fol$b(L-!FPRni+I^EeADRl`zmrlb#+G*28QKoS6 zL9k}!O{du9aHTwlI)h?^T%D0s)(OcBYhIYcn zl#m`rqc??6p(C;^x=Nh*w-NuHNtS$C5ku@pwW(%y;ibCW0w ku*g5>F6cOGFmHz5srt;d%X2F`;MW8)H?}r + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::MeterTildeView Member List
+
+
+ +

This is the complete list of members for kiwi::MeterTildeView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
create(model::Object &model) (defined in kiwi::MeterTildeView)kiwi::MeterTildeViewstatic
declare() (defined in kiwi::MeterTildeView)kiwi::MeterTildeViewstatic
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
MeterTildeView(model::Object &object_model) (defined in kiwi::MeterTildeView)kiwi::MeterTildeView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~MeterTildeView() (defined in kiwi::MeterTildeView)kiwi::MeterTildeView
~ObjectView()kiwi::ObjectViewvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_meter_tilde_view.html b/docs/html/classkiwi_1_1_meter_tilde_view.html new file mode 100644 index 00000000..5e7e7b01 --- /dev/null +++ b/docs/html/classkiwi_1_1_meter_tilde_view.html @@ -0,0 +1,198 @@ + + + + + + +Kiwi: kiwi::MeterTildeView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Public Member Functions | +Static Public Member Functions | +List of all members
+
+
kiwi::MeterTildeView Class Reference
+
+
+
+Inheritance diagram for kiwi::MeterTildeView:
+
+
+ + +kiwi::ObjectView +kiwi::model::Object::Listener + +
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ MeterTildeView (model::Object &object_model)
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + +

+Static Public Member Functions

+static void declare ()
 
+static std::unique_ptr< ObjectView > create (model::Object &model)
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_MeterTildeView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_MeterTildeView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_meter_tilde_view.png b/docs/html/classkiwi_1_1_meter_tilde_view.png new file mode 100644 index 0000000000000000000000000000000000000000..ac629b7f40791b15f7663e647ba5d0bc442bbf36 GIT binary patch literal 1367 zcmeAS@N?(olHy`uVBq!ia0y~yU!o);Dn6a_`Qpm0UY9Oz4D;kV9;K=& zlRb4w!J5!XhkmZT=3aWv^7;3lSGR4w783hf(DT*;pRm(%_KT#VWDWRr#BKhr;NS9X zcHK|;NyX>hZ(1HYDK5$T^_r6RYhrujFGYRhahxruoSbf8$Gd)Bo%qw)QNPVHC957^ zF}T_OxIlW^7k_ERiuv>UXO`Ktwbx0n{d}Y(YU{$9ZvL%&yX5xCt$iDns58Jy)Wze!e5zLldq+{`FZK-sb`rbGRwARt-n)r?x(KV7Qgi$K5h42nRR=6 z=$5=UH@M$io#&SABUIu0I^h1l^0m&bRqM7!ZVuhFtR!%)j{pC#*G0MKEcYL;6MA8- zI{Tl%+TV&hYHokulDB4!-EZTy&9mL^+=x5P3Ua`2)$G4aS}V7ly%S|U}*M84(nFYgj`@-uB{3TL|;r{ZAor{-0{siay}p zk;2%Lyq4i%gtmjlH73oah1UCDsQx_XerEEus5!j<>-w&xt-2W1w)nJW(!RjmBY>br4%UNKvwPt9Q^b^B}_V-qlxGTw!~6;%++X8pl54QDXpj|3uR zoxC(<rdXb4EjZeYiq05NN8M)%B*!sEnQjeV`zCKcjo#R-$R)hvezvI1^L?7kCtpRKE2vZ z=grjEv+N8xg_>)*jeYZKmu;PM+eanAar4i}ON#YLZC~#jnjin#!aj9!+2{Kg zqna{*Y+t+8@5t#{Te_~jdXV<{2O~pt%*K@5D^vDha zpPgh^vAQc%c*6IOn>IxT=Kj=W1hq<&>qkXJkV1L;5Pc_}OI-Pn+N4_FE^ Nc)I$ztaD0e0ssOdl3V}) literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_mouse_handler-members.html b/docs/html/classkiwi_1_1_mouse_handler-members.html new file mode 100644 index 00000000..747fb1ad --- /dev/null +++ b/docs/html/classkiwi_1_1_mouse_handler-members.html @@ -0,0 +1,122 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::MouseHandler Member List
+
+
+ +

This is the complete list of members for kiwi::MouseHandler, including all inherited members.

+ + + + + + + + + + + + + + + + +
Action enum name (defined in kiwi::MouseHandler)kiwi::MouseHandler
Direction enum name (defined in kiwi::MouseHandler)kiwi::MouseHandler
Down enum value (defined in kiwi::MouseHandler)kiwi::MouseHandler
getCurrentAction()kiwi::MouseHandler
handleMouseDoubleClick(juce::MouseEvent const &e)kiwi::MouseHandler
handleMouseDown(juce::MouseEvent const &e)kiwi::MouseHandler
handleMouseDrag(juce::MouseEvent const &e)kiwi::MouseHandler
handleMouseMove(juce::MouseEvent const &e)kiwi::MouseHandler
handleMouseUp(juce::MouseEvent const &e)kiwi::MouseHandler
Left enum value (defined in kiwi::MouseHandler)kiwi::MouseHandler
MouseHandler(PatcherView &patcher_view)kiwi::MouseHandler
None enum value (defined in kiwi::MouseHandler)kiwi::MouseHandler
Right enum value (defined in kiwi::MouseHandler)kiwi::MouseHandler
Up enum value (defined in kiwi::MouseHandler)kiwi::MouseHandler
~MouseHandler()kiwi::MouseHandler
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_mouse_handler.html b/docs/html/classkiwi_1_1_mouse_handler.html new file mode 100644 index 00000000..f94f24b6 --- /dev/null +++ b/docs/html/classkiwi_1_1_mouse_handler.html @@ -0,0 +1,187 @@ + + + + + + +Kiwi: kiwi::MouseHandler Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
+
kiwi::MouseHandler Class Reference
+
+
+ +

The mouse handler is used to make the patcher view react to the mouse interactions. + More...

+ +

#include <KiwiApp_PatcherViewMouseHandler.h>

+ + + + + + +

+Public Types

enum  Action {
+  None = 0, +CopyOnDrag = 1, +Object = 2, +CreateLink = 3, +
+  Lasso = 4, +MoveObject = 5, +PopupMenu = 6, +ObjectEdition = 7, +
+  SwitchSelection = 8, +Selection = 9, +SwitchLock = 10, +ResizeObject = 11 +
+ }
 
enum  Direction : int {
+  None = 0, +None = 0, +Up = 1 << 0, +Down = 1 << 1, +
+  Left = 1 << 2, +Right = 1 << 3 +
+ }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+Action getCurrentAction ()
 Returns the current action.
 
+ MouseHandler (PatcherView &patcher_view)
 Constructor.
 
+ ~MouseHandler ()
 Destructor.
 
+void handleMouseDown (juce::MouseEvent const &e)
 Handles patcher view's mouse down event.
 
+void handleMouseDrag (juce::MouseEvent const &e)
 Handles patcher view's mouse drag event.
 
+void handleMouseUp (juce::MouseEvent const &e)
 Handles patcher view's mouse up event.
 
+void handleMouseDoubleClick (juce::MouseEvent const &e)
 Handles patcher view's mouse double click events.
 
+void handleMouseMove (juce::MouseEvent const &e)
 Handles patcher view's mouse move events.
 
+

Detailed Description

+

The mouse handler is used to make the patcher view react to the mouse interactions.

+
The documentation for this class was generated from the following files: +
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_network_settings-members.html b/docs/html/classkiwi_1_1_network_settings-members.html index c57d1024..bd0b817f 100644 --- a/docs/html/classkiwi_1_1_network_settings-members.html +++ b/docs/html/classkiwi_1_1_network_settings-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -70,25 +97,25 @@

This is the complete list of members for kiwi::NetworkSettings, including all inherited members.

- - - - - - - - + + + + + + - + + +
addListener(Listener &listener)kiwi::NetworkSettings
getApiPort() constkiwi::NetworkSettings
getApiPortValue()kiwi::NetworkSettings
getHost() constkiwi::NetworkSettings
getHostValue()kiwi::NetworkSettings
getRefreshInterval() constkiwi::NetworkSettings
getRefreshIntervalValue()kiwi::NetworkSettings
getSessionPort() constkiwi::NetworkSettings
getSessionPortValue()kiwi::NetworkSettings
getApiPort() const kiwi::NetworkSettings
getHost() const kiwi::NetworkSettings
getRefreshInterval() const kiwi::NetworkSettings
getRememberUserFlag() const (defined in kiwi::NetworkSettings)kiwi::NetworkSettings
getServerAddress()kiwi::NetworkSettings
getSessionPort() const kiwi::NetworkSettings
NetworkSettings()kiwi::NetworkSettings
readFromXml(juce::XmlElement const &xml)kiwi::NetworkSettings
readFromXml(juce::XmlElement const &xml)kiwi::NetworkSettings
removeListener(Listener &listener)kiwi::NetworkSettings
resetToDefault()kiwi::NetworkSettings
setRememberUserFlag(bool remember_me) (defined in kiwi::NetworkSettings)kiwi::NetworkSettings
setServerAddress(std::string const &host, uint16_t api_port, uint16_t session_port)kiwi::NetworkSettings
~NetworkSettings()kiwi::NetworkSettings
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_network_settings.html b/docs/html/classkiwi_1_1_network_settings.html index bf1653a0..e42041b4 100644 --- a/docs/html/classkiwi_1_1_network_settings.html +++ b/docs/html/classkiwi_1_1_network_settings.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::NetworkSettings Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -87,59 +114,57 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + - @@ -153,7 +178,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_number_tilde_view-members.html b/docs/html/classkiwi_1_1_number_tilde_view-members.html new file mode 100644 index 00000000..5d023921 --- /dev/null +++ b/docs/html/classkiwi_1_1_number_tilde_view-members.html @@ -0,0 +1,142 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+

Public Member Functions

+
 NetworkSettings ()
 Constructor.
 
+
 ~NetworkSettings ()
 Destructor.
 
+
void resetToDefault ()
 Reset to default settings values.
 
-bool readFromXml (juce::XmlElement const &xml)
 Restore settings with an xml.
 
-std::string getHost () const
 Returns the Host as a string.
 
-juce::Value getHostValue ()
 Returns the Host as a juce::Value.
 
-uint16_t getApiPort () const
 Returns the api port as an integer.
 
-juce::Value getApiPortValue ()
 Returns the api port as a juce::Value.
 
-uint16_t getSessionPort () const
 Returns the session port as an integer.
 
-juce::Value getSessionPortValue ()
 Returns the session port as a juce::Value.
 
-uint16_t getRefreshInterval () const
 Returns the session port as an integer.
 
-juce::Value getRefreshIntervalValue ()
 Returns the session port as a juce::Value.
 
+
+void setServerAddress (std::string const &host, uint16_t api_port, uint16_t session_port)
 Sets the server adress.
 
+juce::ValueTree getServerAddress ()
 Retrieves a copy of the server adress info.
 
+void readFromXml (juce::XmlElement const &xml)
 Restore settings with an xml.
 
+std::string getHost () const
 Returns the Host as a string.
 
+uint16_t getApiPort () const
 Returns the api port as an integer.
 
+uint16_t getSessionPort () const
 Returns the session port as an integer.
 
+uint16_t getRefreshInterval () const
 Returns the session port as an integer.
 
+void setRememberUserFlag (bool remember_me)
 
+bool getRememberUserFlag () const
 
void addListener (Listener &listener)
 Add a listener.
 
+
void removeListener (Listener &listener)
 remove a listener.
 
+ + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
kiwi::NumberTildeView Member List
+
+
+ +

This is the complete list of members for kiwi::NumberTildeView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
addListener(Listener &listener)kiwi::EditableObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
create(model::Object &object_model)kiwi::NumberTildeViewstatic
declare() (defined in kiwi::NumberTildeView)kiwi::NumberTildeViewstatic
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
edit()kiwi::EditableObjectView
EditableObjectView(model::Object &object_model)kiwi::EditableObjectView
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getDisplayNumber() const kiwi::NumberViewBaseprotected
getLabel()kiwi::EditableObjectViewprotected
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
NumberTildeView(model::Object &object_model)kiwi::NumberTildeView
NumberViewBase(model::Object &object_model)kiwi::NumberViewBase
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
removeListener(Listener &listener)kiwi::EditableObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setDisplayNumber(double number)kiwi::NumberViewBaseprotected
setEditable(bool editable)kiwi::EditableObjectViewprotected
setIconColour(juce::Colour colour)kiwi::NumberViewBaseprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~EditableObjectView()kiwi::EditableObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~NumberTildeView()kiwi::NumberTildeView
~NumberViewBase()kiwi::NumberViewBase
~ObjectView()kiwi::ObjectViewvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_number_tilde_view.html b/docs/html/classkiwi_1_1_number_tilde_view.html new file mode 100644 index 00000000..6884852b --- /dev/null +++ b/docs/html/classkiwi_1_1_number_tilde_view.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::NumberTildeView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
+
kiwi::NumberTildeView Class Reference
+
+
+ +

The view of any textual kiwi object. + More...

+ +

#include <KiwiApp_NumberTildeView.h>

+
+Inheritance diagram for kiwi::NumberTildeView:
+
+
+ + +kiwi::NumberViewBase +kiwi::EditableObjectView +kiwi::ObjectView +kiwi::model::Object::Listener + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ NumberTildeView (model::Object &object_model)
 Constructor.
 
+ ~NumberTildeView ()
 Destructor.
 
- Public Member Functions inherited from kiwi::NumberViewBase
+ NumberViewBase (model::Object &object_model)
 Constructor.
 
+ ~NumberViewBase ()
 Destructor.
 
- Public Member Functions inherited from kiwi::EditableObjectView
 EditableObjectView (model::Object &object_model)
 Constructor. More...
 
+ ~EditableObjectView ()
 Destructor.
 
+void addListener (Listener &listener)
 Add a listener.
 
+void removeListener (Listener &listener)
 Remove a listener.
 
+void edit ()
 Edits the label.
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + + +

+Static Public Member Functions

+static void declare ()
 
+static std::unique_ptr< ObjectView > create (model::Object &object_model)
 Creation method.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- Protected Member Functions inherited from kiwi::NumberViewBase
+void setDisplayNumber (double number)
 Sets the displayed text and call repaint.
 
+double getDisplayNumber () const
 Returns the displayed text as a number.
 
void setIconColour (juce::Colour colour)
 Sets the triangle icon colour. More...
 
- Protected Member Functions inherited from kiwi::EditableObjectView
+juce::Label & getLabel ()
 Returns the label created by the editable object.
 
void setEditable (bool editable)
 Sets the editable object view as editable or not. More...
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+

Detailed Description

+

The view of any textual kiwi object.

+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_NumberTildeView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_NumberTildeView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_number_tilde_view.png b/docs/html/classkiwi_1_1_number_tilde_view.png new file mode 100644 index 0000000000000000000000000000000000000000..92f0da20663207831dfe1b08d335fd8ccc606bcc GIT binary patch literal 2426 zcmbVO3s4i+8s1=IRfL#(ML;duFlZwZd^9Qw7B#3mL`sYSbOF)GBNVJ*d5WT93~~XB z1VjX-HWMIeKq3em!Pp>LqCk}-yh1?BD*<^cia-yJb9Ef2(|dPj_doxh-Lq%^?{Q9o zo9ixvd5h;k5M|9dKxr)`o@ry-!6jIyHhHa zViQ`IfpkuoyDJp}56v8kntkgaXzpA`%C>!xnEvdh^k)gxSY zr)wiO9+aY}wj!BA>2sSc2$ZGdZO_6U_qFR7y%CbfJkfLhXR1>#H95?Ia_4@INT?0? zb%&iFTC<*-itIS@!evFqVAl(O&vF4XSRTH&A}V0<(x?8Y3$l56B+JK%Wm=oyK5@SlVUbm%5&d@1SX1Bgl|Rc#N}CP zwKrYSR{l%clU;p1UQSKXd(F{;exD6ZB_mbe6GCzV!_*R!N&Y39 zgN~L@oa*ta+e75lZ6dJ`^RMo=F4k>gC}{(`Rke?_;(>f-^T^JJt!;t?B5xEQgDM?* zT<9_3iWtd}M+xmu#m>1VuGo;u((3&k32#EKTm+LW5(tiXWGz#ithHd}T-I;;Imoom zLS(y^+1l`sab2jijiACr-Yps3c#FaaKg4iqbD+G%gNiGWpR9~PR~Yt`g@iz;j7K~( z5C_V^)9>TGb0{j(h3w@C1}3InLV1JGg6;hidMEHYJ-3db`Ztq78sqjv597Fbbw1W( z6N*Y}sqsw`^mW6@x8GUGQ7FEM1epr;?Pu%sF5W|-BcG&^wq`gYG+(-Ls8sKvFAS{% zBh6Q0m!Cy2|0tD`M`JabYs0Y;k?sXfYB7q(NAQ(^HW3d{p&WI0>YWFI(2|!XYQK#j zikPo5(K@S@NZRCl>{7!5bfZC06VwviOP znxqj3hOhPgRnr0!rD>__jr_8te-HO8&D8S@*fOq<7S!Cn!_{tdsKzZ&0rW|st2ms< zjL=>uBJVB$T17@lMGV;ZD4kN3ag(G2w-bvD{`@cmR;kS(BQt1w zUaU`?wI2+vvNiL%>+@eeyw>qf-fez`9VY+?eh(U#DfqAsAs} z&#Khpg;uf8y;b+r(%)OVp0s%xOXo6SXMBrCjX%9f)3tm{17dqiQDU?3SN*)^FVO;K z$u#qvMbS`^Sxrf)=`B*+EW-;Ojh?GI5=0fPc`L5r$Y@PBy_<(%kd~fi8~O&+`x@*i z>usV{44nK0!R%?#dS#C@Zg)qM=XekfhdFU*D%sl=9qXAe9wfTj+8kk}3Y>Lg|jr0K@^LJL7Xjm&TpdJBL^ z_eC}rTSEq*l5^yrRqco3e@@f?ORp#w*vb@ic^fFc`rV{uA54O62g76DyTZ>a*N3M! zEm`7?$A=z*3xPcaUw%2h1K@3$oSwjG^n0wtIK8nkm8I@ z&a{Eyx>~dr;o3c};L1AJ1zp*kl)IB=m9L<&1?SBPi-o#<^pZ@5c~(_RAB%ajCMVWv ztck0-O^Ty#RVfytNg_{K@pKfA*hbm}q?g2%alUzswh`HfSIVRI(#fIlXqUZbQU0kh zK85mBs5_`aMPzi?M&XcF8XNF~pZIzmDK2GGJ#AgEdf+;z!h4S8hC~~fkN9R@%7~K3BNe&& zzB1N?MnS`-AecK + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::NumberView Member List
+
+
+ +

This is the complete list of members for kiwi::NumberView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
addListener(Listener &listener)kiwi::EditableObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
create(model::Object &object_model)kiwi::NumberViewstatic
declare() (defined in kiwi::NumberView)kiwi::NumberViewstatic
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
edit()kiwi::EditableObjectView
EditableObjectView(model::Object &object_model)kiwi::EditableObjectView
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getDisplayNumber() const kiwi::NumberViewBaseprotected
getLabel()kiwi::EditableObjectViewprotected
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
NumberView(model::Object &object_model)kiwi::NumberView
NumberViewBase(model::Object &object_model)kiwi::NumberViewBase
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
removeListener(Listener &listener)kiwi::EditableObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setDisplayNumber(double number)kiwi::NumberViewBaseprotected
setEditable(bool editable)kiwi::EditableObjectViewprotected
setIconColour(juce::Colour colour)kiwi::NumberViewBaseprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~EditableObjectView()kiwi::EditableObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~NumberView()kiwi::NumberView
~NumberViewBase()kiwi::NumberViewBase
~ObjectView()kiwi::ObjectViewvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_number_view.html b/docs/html/classkiwi_1_1_number_view.html new file mode 100644 index 00000000..d8baa4cf --- /dev/null +++ b/docs/html/classkiwi_1_1_number_view.html @@ -0,0 +1,262 @@ + + + + + + +Kiwi: kiwi::NumberView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Public Member Functions | +Static Public Member Functions | +List of all members
+
+
kiwi::NumberView Class Reference
+
+
+ +

The view of any textual kiwi object. + More...

+ +

#include <KiwiApp_NumberView.h>

+
+Inheritance diagram for kiwi::NumberView:
+
+
+ + +kiwi::NumberViewBase +kiwi::EditableObjectView +kiwi::ObjectView +kiwi::model::Object::Listener + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ NumberView (model::Object &object_model)
 Constructor.
 
+ ~NumberView ()
 Destructor.
 
- Public Member Functions inherited from kiwi::NumberViewBase
+ NumberViewBase (model::Object &object_model)
 Constructor.
 
+ ~NumberViewBase ()
 Destructor.
 
- Public Member Functions inherited from kiwi::EditableObjectView
 EditableObjectView (model::Object &object_model)
 Constructor. More...
 
+ ~EditableObjectView ()
 Destructor.
 
+void addListener (Listener &listener)
 Add a listener.
 
+void removeListener (Listener &listener)
 Remove a listener.
 
+void edit ()
 Edits the label.
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + + +

+Static Public Member Functions

+static void declare ()
 
+static std::unique_ptr< ObjectView > create (model::Object &object_model)
 Creation method.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- Protected Member Functions inherited from kiwi::NumberViewBase
+void setDisplayNumber (double number)
 Sets the displayed text and call repaint.
 
+double getDisplayNumber () const
 Returns the displayed text as a number.
 
void setIconColour (juce::Colour colour)
 Sets the triangle icon colour. More...
 
- Protected Member Functions inherited from kiwi::EditableObjectView
+juce::Label & getLabel ()
 Returns the label created by the editable object.
 
void setEditable (bool editable)
 Sets the editable object view as editable or not. More...
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+

Detailed Description

+

The view of any textual kiwi object.

+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_NumberView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_NumberView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_number_view.png b/docs/html/classkiwi_1_1_number_view.png new file mode 100644 index 0000000000000000000000000000000000000000..0d00b433da16f02d411e5e59ce7a3eca522c626f GIT binary patch literal 2390 zcmb7G2~ZPR8t%ZLE_ZY-t^qYFNRY5b1c?fx1Q~(?au@>Bf*c}&bsUox1jM*79E+@$ zT%$x3H3|vo2ok{t0t$kH1XM`NF@TDIHiwEqV8m?WxK)}0Ce2Gr+Whc0mkF$Me6u7DdWu)-WYoA@O4qCRCqWts)SD7K7~gg@4C7= zjr87Sc)Ez|?coF9ljg6^W?w4a_1ulV)i;(fcCP2}GqS!$h9Y1{rJAPOe}mj<_Fpo# zzNc_)$MR^O7ehJO-f@oEOceTcl2G|`Hb?GxRk4)#np@I>lvt6T>i(xKxMFp*=8$}b z<`fq#vhtgNR*^zd!>^rHsM5>P9^LmUuY5JdUKKCa$3k^CgEa<1brJahLkJMwz}O zK9X);Z_awT(kH^!A=N&{siheNo%1W=M|V0u8#v|oESyj69lLxVJ;>UZcv0`FoAIe&8X6xaGR<41PAnMX6DNS5DIB1%8!3ARO#o5!3) z{iHDzhv9^DQ;=gBI1xz~c7F)Z0ylYnyZY(SneFKHj3@EPEUL~`N+!4)IESy~ma$rY z82_*gQE)i&8RMoq2S?Uk?X>TL_*6_7b2%zvpR%j1W5f87m0|3O&IUe5)=&ULMB1ay z0#Ml}H{y_{-;R2(NeMlk4~t9vVlT@~EC%_L8iyfkBgK%b^t{hKzIpC8JJH!D_w>Mm zUu+Ms2RC0UQEYza1v(5@*Si{Q>cr9Bn_HccHobBlYs@^5jNmxyeqbDSp(iZD$|%@B z(<;?JwMizBAp7C7VlD)tTg-r^dw^|4M}v5JAs|4m-V;z8H1?ZXf3^?bIy<2)jlBjJ`d|lwHToK8}PIh8q1R) z!rfr-|4R?*fhg1#F(b1SyiEWO6lSEw(xfn-lSos9gNhuEJSG^#Bb=gzwc>ddg^ecG z2)(vM>1GexClQJLZ!Ez__2HRSy-vVrd z{Zx6vb4C%=SiyKHa$Jg~e0^fWpww88DFIkbi-Pe!R%*JNGg6lWmN9OoG>Z~;eIWy4XwnCWR7 z2W|MEN)qB9@tBs`_|$I4noB-m+J7w^8?YG>lKbD^@U2}(P2g3+X=yP>e74dXsuCDX zxr0gv7s2=gD9IW_)>V;6jwc`%-rb)JvGO2X{-*wUP$q)Fn3<=*N|0@)$J4X{R&>a0 z>K2w#a5>nB`z2FH365zHq3D$o6C~Dlztfmrj?HEv@*|g;`e?0J9FESOaOmj2@0s0K-ODbDJ1~=d zjt3D+9*+d9%Gnb*n^FTORUOZ|*(#`!Qg}-g$Pnp9sjnOkKbD^~>V>{;-;EA=l~XRT z4Y+ za<0qImR|sN{x4-ja2pE` z0!X+EHG^)9YJI1Usp;P?`>Jg}TjeXJ{u86T_}_PN1^sje0E3?`xYv^@?8EMkx5qWg zsqvw6^Ci9ni^spxq;ZR^$chwl=K+;S3@pJ+KxeFibGaF|^rr}%&hUSxaJJ7*vu`c7 zQ7u?#6afw+xm&Dja_VQO`;9kc7H;>mF7A|SGxc2Qw*F`_%wC_D8NK+&>uusYU1j;d8Q9EVre-`GTBmVUphqBuF1(LEx3w)0oa zCTompNxFCok#k+>n>D}W=rb@1F=TuOFyysOs{IYnoM%arca)HZS4wh1SD6iJ>AiF@1_W~kpHvMw1(}@<1M#}1k{ko=-fT0h;6JktA;ps#gRuyRt zkQ9&`+CF<`rQhM5w+>m(-5XrXJ+uB{69&|+Q$Q{#src<~-QkuCk)yUL#(q)=Q;R)s zKgEV)p{OO2hu365$W`~?$oCb2#s{O#mdW7;KfEqpV*k~K)bnD;Ag@V&|$jeHIP@U1>ffqW$-MwEw gcRrpj;{#4NOgx`vP7y5dpCG`^#e)uS3;xHy0a-z8ga7~l literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_number_view_base-members.html b/docs/html/classkiwi_1_1_number_view_base-members.html new file mode 100644 index 00000000..dc9400c8 --- /dev/null +++ b/docs/html/classkiwi_1_1_number_view_base-members.html @@ -0,0 +1,138 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::NumberViewBase Member List
+
+
+ +

This is the complete list of members for kiwi::NumberViewBase, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
addListener(Listener &listener)kiwi::EditableObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
edit()kiwi::EditableObjectView
EditableObjectView(model::Object &object_model)kiwi::EditableObjectView
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getDisplayNumber() const kiwi::NumberViewBaseprotected
getLabel()kiwi::EditableObjectViewprotected
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
NumberViewBase(model::Object &object_model)kiwi::NumberViewBase
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
removeListener(Listener &listener)kiwi::EditableObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setDisplayNumber(double number)kiwi::NumberViewBaseprotected
setEditable(bool editable)kiwi::EditableObjectViewprotected
setIconColour(juce::Colour colour)kiwi::NumberViewBaseprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~EditableObjectView()kiwi::EditableObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~NumberViewBase()kiwi::NumberViewBase
~ObjectView()kiwi::ObjectViewvirtual
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_number_view_base.html b/docs/html/classkiwi_1_1_number_view_base.html new file mode 100644 index 00000000..88b7ff9b --- /dev/null +++ b/docs/html/classkiwi_1_1_number_view_base.html @@ -0,0 +1,273 @@ + + + + + + +Kiwi: kiwi::NumberViewBase Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
kiwi::NumberViewBase Class Referenceabstract
+
+
+ +

The view of any textual kiwi object. + More...

+ +

#include <KiwiApp_NumberViewBase.h>

+
+Inheritance diagram for kiwi::NumberViewBase:
+
+
+ + +kiwi::EditableObjectView +kiwi::ObjectView +kiwi::model::Object::Listener +kiwi::NumberTildeView +kiwi::NumberView + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ NumberViewBase (model::Object &object_model)
 Constructor.
 
+ ~NumberViewBase ()
 Destructor.
 
- Public Member Functions inherited from kiwi::EditableObjectView
 EditableObjectView (model::Object &object_model)
 Constructor. More...
 
+ ~EditableObjectView ()
 Destructor.
 
+void addListener (Listener &listener)
 Add a listener.
 
+void removeListener (Listener &listener)
 Remove a listener.
 
+void edit ()
 Edits the label.
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+void setDisplayNumber (double number)
 Sets the displayed text and call repaint.
 
+double getDisplayNumber () const
 Returns the displayed text as a number.
 
void setIconColour (juce::Colour colour)
 Sets the triangle icon colour. More...
 
- Protected Member Functions inherited from kiwi::EditableObjectView
+juce::Label & getLabel ()
 Returns the label created by the editable object.
 
void setEditable (bool editable)
 Sets the editable object view as editable or not. More...
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+ + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
+

Detailed Description

+

The view of any textual kiwi object.

+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
void kiwi::NumberViewBase::setIconColour (juce::Colour colour)
+ 		+protected
+
+ +

Sets the triangle icon colour.

+

By default colour is outline colour.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_NumberViewBase.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_NumberViewBase.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_number_view_base.png b/docs/html/classkiwi_1_1_number_view_base.png new file mode 100644 index 0000000000000000000000000000000000000000..fd3cfce345316caa2f043ea245d163b976594aff GIT binary patch literal 2531 zcma)82~-nV7OkK(h-__x;DT{lq6RS{gQzG=vnNPE2*_55XjF`#LIR?oh_)z7+Y=Lz zC?HEfAXc*@1tKj2Dq)il((J1sDHbuHAWNoTj^{Y7)2Hj4s(SDLTfhE)%YE;rBiTkt zVXXoH07^t#OD6!pK&U(|zYKj|z4iVB`qFefK(UfarKtFJWQuX;`LC$7bXQbV$lmP0 zqN+UIiR=uZpv6mAL(vC-6@f&{pD5=sqY0z2`Mg!K{85iUX-HU~MkF?V&z<8Vk}*Z~ z+@B(w8|S!woWYr2P5s-88svIbb68FnjJO2i1)~-!*n%U5_<*Ruq{}%7gk>gpE?3~K!sEj{WV7c%I+xX?6-EsqHd(pFG2G*{JFlQm z2C+%2<54#1t_d}`t;ip%Vy0#kVP<)MN5#)>8fI!Rp=H+Qv*LXQE1plS)95kht=y>k z+IzutJ0AvQj)1_C972R1iq}LZ6kB9fze8l?uQD*#eushQjSNsj0a$hx=k5A`F+P8} z#8|R_`-d4_i9aVj)C4GQBsB@}4D>jHTmq5@v7F##NFD(p;ko;!X`uZCXk9HvoUhe* z2W>Qc=Eq9ImXJh~XE*c{J~lMsh@N>_sbn-5jT)+8<#9Bu6gE7hZOv!rx*BQT51K9L z{=}bl+1j~WdwBcq5omB~it}=ENQbXbg+cP{^6QQF^RuVBuvSdvndhxj zQnn&rtEkKRXy7`dffl^}cX^HQgbH0f{>*|$Ubp6&OBb6Z8UfgY5Rypcs zkue;QLj`w_5s0wne@(XHv&nJ@$XZ6Bf4fPd`5}QpT|efAxt!{alM>k{s))=Db5Yd= z>1X9RGHUVka>0y@*9`_{`HyXUX$I9@!))U>oc^UlVF)qD_yEwq`3nCN7++%ka)}D# z0(5^^K!7mQGLC|1d?|ksUpY;S%#rq+V$%BccAc3Q0>otkisC_6Z9gn>A={2=cv`Dm zz;@A!aT7DsLfk~TP;%``gpDtx zF)%KzVvmGr{waru;a@BT%|CiR>Pz=`Up2;2CeM5t%){TsvmKkyJCLNfnIR zZ2jS;DTg8+f|S}ZFU2rWXYBdHk{0bnqY{iBAQE6SBjlITxxO5TL{E6|d~4p02u*Zo zqwd!k`?nqQ&3ym*>$58M0)qy*ib)tq{N>M^tn4D)&dtM#itS(Y50qc@pO@>|#6wPi zz`E*PCYdXJs$S~>o;*Yjv>0x;j_%wgE5V7j+|6&~HrQehE8Xj#>F)7);V!xe@;QTT zHN9bL3}VhF!-KXt%1yT18HYU}zX3bDkdxx}>zf zd z&;~Eh?Ui9`y68O0j*_`eI~pL3vVzbKTdVjyN3wMxlqv1-zC+PkjatNY(IQK@JhTs5l|d&qVNoVq>Vp2%6rpNA gQoKmWCnfXP=bPx%63;VUXh#MRt;m*;xliPO0E6tr;Q#;t literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_object_frame-members.html b/docs/html/classkiwi_1_1_object_frame-members.html new file mode 100644 index 00000000..09367aa2 --- /dev/null +++ b/docs/html/classkiwi_1_1_object_frame-members.html @@ -0,0 +1,132 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::ObjectFrame Member List
+
+
+ +

This is the complete list of members for kiwi::ObjectFrame, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
attributeChanged(std::string const &name, tool::Parameter const &parameter)kiwi::ObjectFrame
ColourIds enum name (defined in kiwi::ObjectFrame)kiwi::ObjectFrame
editObject()kiwi::ObjectFrame
getInletPatcherPosition(const size_t index) const kiwi::ObjectFrame
getModel() const kiwi::ObjectFrame
getObjectBounds() const kiwi::ObjectFrame
getOutletPatcherPosition(const size_t index) const kiwi::ObjectFrame
hitTest(int x, int y) overridekiwi::ObjectFrame
hitTest(juce::Point< int > const &pt, HitTester &result) const kiwi::ObjectFrame
hitTest(juce::Rectangle< int > const &rect) const kiwi::ObjectFrame
isSelected() const kiwi::ObjectFrame
lockStatusChanged()kiwi::ObjectFrame
mouseDown(juce::MouseEvent const &e) override finalkiwi::ObjectFrame
mouseDrag(juce::MouseEvent const &e) override finalkiwi::ObjectFrame
mouseUp(juce::MouseEvent const &e) override finalkiwi::ObjectFrame
objectChanged(model::Patcher::View &view, model::Object &object)kiwi::ObjectFrame
ObjectFrame(PatcherView &patcher_view, std::unique_ptr< ObjectView > object_view)kiwi::ObjectFrame
patcherViewOriginPositionChanged()kiwi::ObjectFrame
Pin enum value (defined in kiwi::ObjectFrame)kiwi::ObjectFrame
Selection enum value (defined in kiwi::ObjectFrame)kiwi::ObjectFrame
selectionChanged()kiwi::ObjectFrame
SelectionDistant enum value (defined in kiwi::ObjectFrame)kiwi::ObjectFrame
SelectionOtherView enum value (defined in kiwi::ObjectFrame)kiwi::ObjectFrame
~Listener()=defaultkiwi::EditableObjectView::Listenervirtual
~ObjectFrame()kiwi::ObjectFrame
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_object_frame.html b/docs/html/classkiwi_1_1_object_frame.html new file mode 100644 index 00000000..7ca6ba18 --- /dev/null +++ b/docs/html/classkiwi_1_1_object_frame.html @@ -0,0 +1,264 @@ + + + + + + +Kiwi: kiwi::ObjectFrame Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Public Types | +Public Member Functions | +List of all members
+
+
kiwi::ObjectFrame Class Reference
+
+
+ +

A juce component holding the object's graphical representation. + More...

+ +

#include <KiwiApp_ObjectFrame.h>

+
+Inheritance diagram for kiwi::ObjectFrame:
+
+
+ + +kiwi::EditableObjectView::Listener + +
+ + + + +

+Classes

struct  Outline
 
+ + + +

+Public Types

enum  ColourIds { Selection = 0x1100000, +SelectionOtherView = 0x1100001, +SelectionDistant = 0x1100002, +Pin = 0x1100003 + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ ObjectFrame (PatcherView &patcher_view, std::unique_ptr< ObjectView > object_view)
 Constructor.
 
+ ~ObjectFrame ()
 Destructor.
 
+void objectChanged (model::Patcher::View &view, model::Object &object)
 Called whenever an object's model has changed.
 
+void attributeChanged (std::string const &name, tool::Parameter const &parameter)
 Updates the inner object's view attributes.
 
void editObject ()
 Called whenever the client wants to edit an object. More...
 
void selectionChanged ()
 Called by the patcher every time the selection status of this object has changed. More...
 
+void lockStatusChanged ()
 Called every time a patcher is locked or unlocked.
 
+void patcherViewOriginPositionChanged ()
 Called when the patcher's origin changes.
 
+juce::Rectangle< int > getObjectBounds () const
 Returns The object's bounds relative to the patcher position.
 
+juce::Point< int > getInletPatcherPosition (const size_t index) const
 Returns the inlet position relative to the parent PatcherView component for a given index.
 
+juce::Point< int > getOutletPatcherPosition (const size_t index) const
 Returns the outlet position relative to the parent PatcherView component for a given index.
 
+model::Object & getModel () const
 Returns the object's model.
 
+bool hitTest (int x, int y) override
 Overloaded from juce::Component to exclude border size.
 
+bool hitTest (juce::Point< int > const &pt, HitTester &result) const
 Internal kiwi PatcherView HitTesting.
 
+bool hitTest (juce::Rectangle< int > const &rect) const
 Internal kiwi PatcherView HitTesting (overlaps a rectangle).
 
+bool isSelected () const
 Returns true if the object is selected.
 
+void mouseDown (juce::MouseEvent const &e) override final
 Called when object's frame is clicked.
 
+void mouseUp (juce::MouseEvent const &e) override final
 Called when object's frame is clicked.
 
+void mouseDrag (juce::MouseEvent const &e) override final
 Called when object's frame is clicked.
 
- Public Member Functions inherited from kiwi::EditableObjectView::Listener
+virtual ~Listener ()=default
 Destructor.
 
+

Detailed Description

+

A juce component holding the object's graphical representation.

+

ObjectFrame is implemented as a wrapper around an object view that displays selections and outlet and handle certain interactions.

+

Member Function Documentation

+ +
+
+ + + + + + + +
void kiwi::ObjectFrame::editObject ()
+
+ +

Called whenever the client wants to edit an object.

+

Will only edit the object if its a textual object.

+ +
+
+ +
+
+ + + + + + + +
void kiwi::ObjectFrame::selectionChanged ()
+
+ +

Called by the patcher every time the selection status of this object has changed.

+

Function called when local selection or distant selection has changed.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectFrame.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectFrame.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_object_frame.png b/docs/html/classkiwi_1_1_object_frame.png new file mode 100644 index 0000000000000000000000000000000000000000..16c3ce050ce01632f988637c92cf8bfaa4fb5009 GIT binary patch literal 1046 zcmeAS@N?(olHy`uVBq!ia0y~yV4MYH2XHV0N%1?*=0Hj!z$e7@|Ns9$=8HF9OZyK^ z0J6aNz<~p-op(b+(P}_6m{~FiMO8Iwd+R9IRypr|aE=ap)v*U8=v<;$y6GdO2+|9gy?X#Vy&QG%n z2O8D3c71qO*R;K&Yo!Dy>b>5#`pOm8PtQDqPsg0RHtpHj%l+lESIxQ<`dP<2pg4DL z?K8v6+fGy`S4E^vxwYxes?%py=f5;rGv&JHx8BsVl`pnmeKNt{aQ>;yLAr14SFWma z^Y;}E%F6v!<#ybxOggS7H}7ro^R2%B-t67jVIAD7`TkBwsQu!_X`U|9%1_s<+?d0( zeRbOY?A2+X&;8qZMf^{7*0R^(S7+?*{2CRWd*evW-Ox_~mv4p#UwZV4ebW58$g@>z zR=sL}qrN3Q)l*yl%9py&x99)%3tzl!Uw!qyo4S|tc3oZgMc34FpYMm~pW@7 zn|01|L*VECo0qlxc^bL-Z17v{__?Ob)wax8@~k>L{py^J{*?`@Ua6N{HCeu~*V9w( z>4bA@f40Z*Ke4=1oO(MnY-5&J`tPX8d%K?RinD&ZIx8g9dd}`&-lj@Q%LB@rI!h)U$B9Z*uJF`c%4m=UjNx1c2EXTg1|o-R z0#`78IPuqR*6hT68dn%9o_v&T-YNO4+ljX!*zI&Wb1hK5z>@$z`L}LAKbr%?2Q@)M zhUqO*gAw~!VpAoUXc;)hABj4Fi<#{hpu;F-M-7@RHpJvoI zHs36UeLgD;FZv#JSaXn#fYO^zTpE6`EXn28xY MUHx3vIVCg!0A7RY%K!iX literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_object_view-members.html b/docs/html/classkiwi_1_1_object_view-members.html index f8eb446c..d11fd3b9 100644 --- a/docs/html/classkiwi_1_1_object_view-members.html +++ b/docs/html/classkiwi_1_1_object_view-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -69,31 +96,31 @@

This is the complete list of members for kiwi::ObjectView, including all inherited members.

- - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
distantSelectionChanged(std::set< uint64_t > distant_user_id_selection) (defined in kiwi::ObjectView)kiwi::ObjectView
getBoxBounds() constkiwi::ObjectView
getInletPatcherPosition(const size_t index) constkiwi::ObjectView
getModel() constkiwi::ObjectViewinline
getOutletPatcherPosition(const size_t index) constkiwi::ObjectView
hitTest(int x, int y) overridekiwi::ObjectView
hitTest(juce::Point< int > const &pt, HitTester &result) constkiwi::ObjectView
hitTest(juce::Rectangle< int > const &rect)kiwi::ObjectView
isEditing()kiwi::ObjectView
isSelected()kiwi::ObjectView
localSelectionChanged(bool selected_for_view) (defined in kiwi::ObjectView)kiwi::ObjectView
lockStatusChanged(bool locked) (defined in kiwi::ObjectView)kiwi::ObjectView
mouseDown(juce::MouseEvent const &event) override (defined in kiwi::ObjectView)kiwi::ObjectView
mouseDrag(juce::MouseEvent const &event) override (defined in kiwi::ObjectView)kiwi::ObjectView
objectChanged(model::Patcher::View &view, model::Object &object) (defined in kiwi::ObjectView)kiwi::ObjectView
ObjectView(PatcherView &patcher_view, model::Object &object_m) (defined in kiwi::ObjectView)kiwi::ObjectView
paint(juce::Graphics &g) override (defined in kiwi::ObjectView)kiwi::ObjectView
patcherViewOriginPositionChanged() (defined in kiwi::ObjectView)kiwi::ObjectView
~ObjectView() (defined in kiwi::ObjectView)kiwi::ObjectView
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~ObjectView()kiwi::ObjectViewvirtual
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_object_view.html b/docs/html/classkiwi_1_1_object_view.html index ada3f35c..af5e6409 100644 --- a/docs/html/classkiwi_1_1_object_view.html +++ b/docs/html/classkiwi_1_1_object_view.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::ObjectView Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
+Public Types | Public Member Functions | +Protected Member Functions | List of all members
kiwi::ObjectView Class Reference
-

The juce object Component. +

Abstract for objects graphical representation. More...

#include <KiwiApp_ObjectView.h>

@@ -80,88 +109,160 @@
-kiwi::ClassicBox +kiwi::model::Object::Listener +kiwi::BangView +kiwi::EditableObjectView +kiwi::MeterTildeView +kiwi::SliderView +kiwi::ToggleView +kiwi::ClassicView +kiwi::CommentView +kiwi::MessageView +kiwi::NumberViewBase +kiwi::NumberTildeView +kiwi::NumberView
+ + + +

+Public Types

enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +

Public Member Functions

- ObjectView (PatcherView &patcher_view, model::Object &object_m)
 
-void objectChanged (model::Patcher::View &view, model::Object &object)
 
-void localSelectionChanged (bool selected_for_view)
 
-void distantSelectionChanged (std::set< uint64_t > distant_user_id_selection)
 
-void lockStatusChanged (bool locked)
 
-void patcherViewOriginPositionChanged ()
 
-void paint (juce::Graphics &g) override
 
-void mouseDown (juce::MouseEvent const &event) override
 
-void mouseDrag (juce::MouseEvent const &event) override
 
-juce::Rectangle< int > getBoxBounds () const
 Returns The box bounds relative to the parent Component.
 
-juce::Point< int > getInletPatcherPosition (const size_t index) const
 Returns the inlet position relative to the parent PatcherView component for a given index.
 
-juce::Point< int > getOutletPatcherPosition (const size_t index) const
 Returns the outlet position relative to the parent PatcherView component for a given index.
 
-model::Object & getModel () const
 Get the Object model.
 
-bool hitTest (int x, int y) override
 overloaded from Component to exclude border size.
 
-bool hitTest (juce::Point< int > const &pt, HitTester &result) const
 internal kiwi PatcherView HitTesting.
 
-bool hitTest (juce::Rectangle< int > const &rect)
 internal kiwi PatcherView HitTesting (overlaps a rectangle).
 
-bool isSelected ()
 Returns true if the object is selected.
 
-bool isEditing ()
 Returns true if the object is currently being editing.
 
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 

Detailed Description

-

The juce object Component.

-
The documentation for this class was generated from the following files:
    -
  • Client/Source/KiwiApp_Patcher/KiwiApp_ObjectView.h
    • -
  • Client/Source/KiwiApp_Patcher/KiwiApp_ObjectView.cpp
    • +

    Abstract for objects graphical representation.

    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::ObjectView::defer (std::function< void()> call_back)
    +     		+protected
    +
    + +

    Defers a task on the main thread.

    +

    The task is automatically unscheduled when object is destroyed.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::ObjectView::schedule (std::function< void()> call_back,
    tool::Scheduler<>::duration_t delay 
    )
    +     		+protected
    +
    + +

    Schedules a task on the main thread.

    +

    The tasks is automatically unscheduled when object is destroyed.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.h
      • +
    • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectView.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1_object_view.png b/docs/html/classkiwi_1_1_object_view.png index 32245737eb878d697051ef0c05dffceb0896dd6b..0356946e6a888eb2fdc3f05f13c9bb1c0fc4326b 100644 GIT binary patch literal 4359 zcmb_gd011|wx{~2EvWd^7Oe`krif!yP*4o?3f2aJAcKfZ;y|<@5fNetN$S8wW%7oK z0s^8}P{9O=lp)CpqJqdI1_)CU1tE|C2S~z^gd}et`n}$J|LA+|_jP|?7AyO#tbO*{ zYyZ}7an;jf-vX1bOpJ_-7T|wy@iH=+3jzJ(XLEs^!M~P*Kg&GbeD)d)2A~d&sAJM< zt^;lMQ(awce6`mSeEsa4mxs3zFhWQBYoBdKMvF4=E`Rem|H-IW5&Nj|E0_0mN9RWy z$UMKk&(jV#v%i?~>-K(fs^p{uZ%CMPsWW0nwzOp(Z0jzB=b0>BRy)`aM!Aj14o`Pz zH#bSXud%AH@d>fsk|EE=n0nLls}DUQF*mxY6XqOy2;ob&phg2YnjIt95)8JoBUGe` z49ipIVk)1Vl0|gN_BK|rJkE?%tQ;R_Kf*3u)nBbuBVqE zA}uX3ICZzSj9dwpZ{2toF2*U<6JRX1Q;FHJT_4(5o4C4|GL6K(PqK#=)0hcq=guw> z@&-|=O;x&hS|QwZYlSn}Ky{o{6#+Mb7gB#(OD#PJOJg?fFM%XYut=XwmcsF8k1VLDmOtyE#Z?Yf1aNkIoW2d1#%9AG3 z4&UmE0tYnng+z#;2m5JK?npj*YK1X7@pPA84-ps?r^>lJK2YX|{Tzj!W734*K`F-n zirmz=){B;YJQUsbeziL@;UVOCWMjJ>{>uXJf=_&a(Jj=dv@2qVATJXV+PVuYtUZso zM}+Pz-h^FhU4mxF(nCvnMyuiv1q6dfs4wdhD}86lddrRs^daiOq&T^(-jkC59a!K_ zb=3n@KKkRbGqSwL_Y-5_EbGTlfwOC~F8@-Qe2mi-L3i@J^WDxNQ$Y?`z!e10_~8Co zx%c1X%jmF?@0;qHe*w3G!z!}T58GQ9a<70u{0vS%JXJ1PVJk8ZE(8&r%z#2hj|@kK z(=Uq0`t`cFndvg^t#$PFPt4Fj@b1C*?*5J^t5i4zSF_9DPs{)ALiu?wsrcyYunv}= zbcN<L>W^6)A=}%guw77r6ccNHWxvP;4YR8jZoN2u5m`A4-Yvg zm9H{$xZi3b-i?G$QM4P++yonX9iYiQ_^#nZtWs7MLP(<`IBx2_cQS_}@SE{n4cS|( z%YNH-Ltj|3=VP#i(p@&F&)H+%G%LUOcbVN3rqo`TV{DQf3Ql?HA=BB1OL|W0(BPpt zXx#C_lBz(H!eTZxwyj6?^|Sh)k~6X{kOrmV$nq0hab$zuSdi!VQnb^o$+Z6gRPxo~ z;4P_x2`?W)o3P8=l{I}n(hT$D0!nDqBT|Fu_d;HYeS7(U@x4>Qhi=PzCNH+yVmErI zPg9H$Fh8tjgh=7dv4(K6Z((TRn74>No)RQmqI@wQ=Np`M zHzYQ2rhn}14vzKBH6h#-($M(Vy3qBc`vC=SgPW*MBcWF5AFk!O%hSMHZ5UK%Vu*nu z$C$hqg12^fRs|H0rowqNT^gpu{XO^%nCTP=i;E+1?vWw&4&@W4Y2e4teI)LNepf0% z3W|U($0@rFQR{w8JluOasBK6;Q4w-x@Dg$E;41v&CWDJK(VSYvYe~}0WQ9z}ulFeA zc5ZhV>slUnP|9s3YMS*lOPMMy@xQdJ=lYwZeyWCUH$i^O-;#zun`Ecrn@>F$tTZXS zMIy+1G`Wi{%2P*ei@1}W<)$=j%XJK49IK+mKk+k9)tC-E1*t5xIpis9vP9@2TOmU8N0n@C)kq%s8_qB`l^-u4XB15aTUTI-Pn2wAJs zz1TlYb&EUDnTV@%PMdqM7#^WQ+XAg=@`@^lo7~*o{5%Eq@Yfy&4r5Bvj*Lgpbvrh* zNTr!&0mBTRQ;Y*rWUV@gMle9s5Czp{#Q%lx;ZzP9!0)7_%~M{|>@<<^T^;I3rlKv= zJ%Ig7ymNbs;QK2Gl3KEg_UJWB7&NT)xX&+!btQyi$cZqM1(hGv)oI3Zw-mmvpqyjw z9t;`MemrVs)>u^bt|MPNFwK$^THd5<9FyrB=GbFM`v#jZ^AKwB>58f15c{}jw9NGK zJ<{hoC#ON;)sQwsRZ)3}8mrKYYU3Np)<51#3f#YP=%I2V|zk&CD0mlq51{&=lhxPIiibkofWp|gqq;lN zPg!IC2wVJjfNA$A`PD|hqTQUiCn?YDvp{9PGhp0*GT3^{Pk*(+xxHxW}gxM({* z_Xvx`cWf20I4Q!^mehu1?B!r9*iEX)%!$#(GX)|<|Iaapw2(qPE@|hA=ndj^x|DD? zrp+TbT$4L^J{VT+CDZ3|>ixMNCL{2Z*Zt0&UoRKIY!inb`>~4up1JYHbbx>U)$w#r zY^P=#!zhBwSCic3T^M@$*d2J_hGbzdE#xhEN2Q(5Ez(M4m6O>T)|hzUA@jpR?9lk} zHutlfAO?R)Tt3fEh1)R1^*3+Up7&x~tVJ&3ToGapj`fu2cbN8m^L{y3V61&l+)mbC z5igjbX)K~wnZ;vOUX-+kUUlQxT5ZM9Xc6NF3CT*`_jxo6UOjF1?U}dK*!$6i>9-H7 zX?Urysf$l?*eY-*B3f6ecO7Jdw-~>;uw`$PRe8^}p6rahfjofYpYh8^^k>4X>xO`Wi~UEJV&^Vg|u|&n@63@_%dYd z&Gzr5q~^qaFAd*WGa72ge^gm2y) zPWQzRKGr~YNz57VT+wR09>=hQy$RKr%7$w)bNzFlM8I(cH<8S;?RX1sT4>6z6Sv5m z=}N$v58`8fV1ioyAINZE7DTT6A0UF0uu$wEC_RL>DaZII4$RqK3doR2al$Njy*m1f ze$RzD8}0&%H7C3;jju+jve_(qT7Co7|AS`D&i{d#Wi_!}G0Vi-^PQln`y7f;pu6)t z5;QA)|022aH^!5p9t3;(GRzeaoIoi+h5xUY{8z)7y(!VKZ72%6S0S11DTRiWXaCqLj7vEJ4bi z^5;2(nRY_Tk1@THhNv?i&WuM@Ly8Y?{?Wps>|=7K9zjW$8SDPnDOrVU*F`DzBs~}T z4Zu5^uj!w@$w}q^e3V{btPZl8+5dTZ<6%Hwk5xW~6Jj|`oT3Y(jI9g{l2gkHf;J`) z87c@eP575X(hxPUrL^9^=kYN{Fz8ZYDLahA65NCLzt1DwI^F>a#IlCdG=iE>6&$IK z=;gN~Ua9CstM{k6O9yJ4^0w3$`=Y(LgQodM%`3N8x}V(7{wSIkBPCEJ0}TlWD)x=KY~w@HZor?7~Do1m|5q__S3v17j Gi~j>CnhBEt delta 684 zcmZoyy1}a08Q|y6%O%Cdz`(%k>ERLtq%(lHgM%4J+O)+9PE@q2XG-^UaSW+od^`7T z-(mwE2KBy{`~Q3SC$-jW(!FL{zUt0d2ZKB{PQBmL1)L%n9Yeo<-r*5?^~ip4+15p? ze$DxL{hfKu;j32ZzVBM~?VM-m z)~D|~ik|8SeBHTfmF)Uec>?u&w>JZ&_3Pc!9b?yWr@vb59=d#$)zLq4g%ek;;uK%G zYF30MmtqSmgH0N9#6hi#+jNcA3ca0Yx-4~({u(QB#v28K4V>bPGtj8OUo8TMxHuT* zA9rO?yVm__<+iZDA*QM(XL9*t?(d&jq0S_+Q>EN!sUwEz3#ZI_yo!WNUvvrasVV&uOv|C3y`(^7b9 z;HUeqMN3m7I!{fw`{Qq4iE7xYchl3agjU#l1>bwiyk=Qko%`ig+Q0AJozuy1@8~C^ zpX*(hZD0I%s#vgr7t>=P-!Ap< zF|F@@eHu&K9#x>^R}EYrA~i>6M>dT&$!5 zv!0(RUO(5l>$zq4aiP5~FE?Ghw#evD{ng!3wvwDinc+$EO*&SsDg3jn`0nn$=e@5Y zpS7Od_RjaBW!UD@RJN~Oc`m63f9C6H9Szq{*V}b-SD9Y!O+HS?CE1UScj>lm6Paas zwR->ez7Jboox6WAKU7`mlVgmEQqmz;B_*}6uB4tq#(D;ZpFw_~nkRMx(;tJUtDnm{ IC#HlZ09o%bW&i*H diff --git a/docs/html/classkiwi_1_1_patcher_component-members.html b/docs/html/classkiwi_1_1_patcher_component-members.html index 757601ed..43500aab 100644 --- a/docs/html/classkiwi_1_1_patcher_component-members.html +++ b/docs/html/classkiwi_1_1_patcher_component-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -75,16 +102,17 @@ paint(juce::Graphics &g) overridekiwi::PatcherComponent PatcherComponent(PatcherView &patcherview)kiwi::PatcherComponent perform(const InvocationInfo &info) override (defined in kiwi::PatcherComponent)kiwi::PatcherComponent - resized() overridekiwi::PatcherComponent - usePatcherManager()kiwi::PatcherComponent - usePatcherView()kiwi::PatcherComponent - ~PatcherComponent()kiwi::PatcherComponent + removeUsersIcon()kiwi::PatcherComponent + resized() overridekiwi::PatcherComponent + usePatcherManager()kiwi::PatcherComponent + usePatcherView()kiwi::PatcherComponent + ~PatcherComponent()kiwi::PatcherComponent
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_component.html b/docs/html/classkiwi_1_1_patcher_component.html index b91655da..69682d4b 100644 --- a/docs/html/classkiwi_1_1_patcher_component.html +++ b/docs/html/classkiwi_1_1_patcher_component.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::PatcherComponent Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -85,40 +112,44 @@ - - - - - - - + + + - - -

Public Member Functions

+
 PatcherComponent (PatcherView &patcherview)
 Constructor.
 
+
 ~PatcherComponent ()
 Destructor.
 
+
void resized () override
 juce::Component::resized
 
+
PatcherView & usePatcherView ()
 Returns the patcher view.
 
+
PatcherManager & usePatcherManager ()
 Returns the patcher manager.
 
+
void paint (juce::Graphics &g) override
 juce::Component::paint
 
+
+void removeUsersIcon ()
 Removes the users icon from toolbar;.
 
juce::ApplicationCommandTarget * getNextCommandTarget () override
 
+
void getAllCommands (juce::Array< juce::CommandID > &commands) override
 
+
void getCommandInfo (juce::CommandID commandID, juce::ApplicationCommandInfo &result) override
 
+
bool perform (const InvocationInfo &info) override
 
@@ -133,7 +164,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_manager-members.html b/docs/html/classkiwi_1_1_patcher_manager-members.html index f6702bfc..ae464ad5 100644 --- a/docs/html/classkiwi_1_1_patcher_manager-members.html +++ b/docs/html/classkiwi_1_1_patcher_manager-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -72,25 +99,29 @@ addListener(Listener &listener)kiwi::PatcherManager askAllWindowsToClose()kiwi::PatcherManager bringsFirstViewToFront()kiwi::PatcherManager - closePatcherViewWindow(PatcherView &patcherview)kiwi::PatcherManager - connect(DocumentBrowser::Drive::DocumentSession &session)kiwi::PatcherManager - documentAdded(DocumentBrowser::Drive::DocumentSession &doc) overridekiwi::PatcherManagervirtual - documentChanged(DocumentBrowser::Drive::DocumentSession &doc) overridekiwi::PatcherManagervirtual - documentRemoved(DocumentBrowser::Drive::DocumentSession &doc) overridekiwi::PatcherManagervirtual - driveChanged()kiwi::DocumentBrowser::Drive::Listenerinlinevirtual - forceCloseAllWindows()kiwi::PatcherManager - getConnectedUsers()kiwi::PatcherManager - getDocumentName() constkiwi::PatcherManager + closePatcherViewWindow(PatcherView &patcherview)kiwi::PatcherManager + connect(std::string const &host, uint16_t port, DocumentBrowser::Drive::DocumentSession &session)kiwi::PatcherManager + disconnect()kiwi::PatcherManager + documentAdded(DocumentBrowser::Drive::DocumentSession &doc) overridekiwi::PatcherManagervirtual + documentChanged(DocumentBrowser::Drive::DocumentSession &doc) overridekiwi::PatcherManagervirtual + documentRemoved(DocumentBrowser::Drive::DocumentSession &doc)kiwi::DocumentBrowser::Drive::Listenerinlinevirtual + driveChanged()kiwi::DocumentBrowser::Drive::Listenerinlinevirtual + forceCloseAllWindows()kiwi::PatcherManager + getConnectedUsers()kiwi::PatcherManager + getDocumentName() const kiwi::PatcherManager + getFirstWindow()kiwi::PatcherManager getNumberOfUsers()kiwi::PatcherManager getNumberOfView()kiwi::PatcherManager getPatcher()kiwi::PatcherManager - getPatcher() constkiwi::PatcherManager - getSessionId() const noexceptkiwi::PatcherManager - isRemote() const noexceptkiwi::PatcherManager - loadFromFile(juce::File const &file)kiwi::PatcherManager - needsSaving() const noexceptkiwi::PatcherManager - newView()kiwi::PatcherManager - PatcherManager(Instance &instance)kiwi::PatcherManager + getPatcher() const kiwi::PatcherManager + getSelectedFile() const kiwi::PatcherManager + getSessionId() const noexceptkiwi::PatcherManager + isRemote() const noexceptkiwi::PatcherManager + loadFromFile(juce::File const &file)kiwi::PatcherManager + needsSaving() const noexceptkiwi::PatcherManager + newView()kiwi::PatcherManager + PatcherManager(Instance &instance, std::string const &name)kiwi::PatcherManager + pull()kiwi::PatcherManager removeListener(Listener &listener)kiwi::PatcherManager saveDocument()kiwi::PatcherManager ~Listener()=defaultkiwi::DocumentBrowser::Drive::Listenervirtual @@ -100,7 +131,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_manager.html b/docs/html/classkiwi_1_1_patcher_manager.html index 3880f17e..6d114dd5 100644 --- a/docs/html/classkiwi_1_1_patcher_manager.html +++ b/docs/html/classkiwi_1_1_patcher_manager.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::PatcherManager Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -92,104 +119,119 @@ - - - - + + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + - - - - - - + + + - - + + + @@ -198,9 +240,7 @@

The main DocumentObserver.

The Instance dispatch changes to all other DocumentObserver objects

Member Function Documentation

- -

◆ askAllWindowsToClose()

- +

Public Member Functions

- PatcherManager (Instance &instance)
 Constructor.
 
+
+ PatcherManager (Instance &instance, std::string const &name)
 Constructor.
 
 ~PatcherManager ()
 Destructor.
 
-void connect (DocumentBrowser::Drive::DocumentSession &session)
 Try to connect this patcher to a remote server.
 
-void loadFromFile (juce::File const &file)
 Load patcher datas from file.
 
+
+bool connect (std::string const &host, uint16_t port, DocumentBrowser::Drive::DocumentSession &session)
 Try to connect this patcher to a remote server.
 
+void disconnect ()
 Disconnects the patcher manager.
 
+void pull ()
 Pull changes from server if it is remote.
 
+bool loadFromFile (juce::File const &file)
 Load patcher datas from file.
 
bool saveDocument ()
 Save the document. More...
 
+bool needsSaving () const noexcept
 Returns true if the patcher needs to be saved.
 
+juce::File const & getSelectedFile () const
 Returns the file currently used to save document.
 
model::Patcher & getPatcher ()
 Returns the Patcher model.
 
-model::Patcher const & getPatcher () const
 Returns the Patcher model.
 
-bool isRemote () const noexcept
 Returns true if the this is a remotely connected document.
 
uint64_t getSessionId () const noexcept
 Returns the session ID of the document. More...
 
std::string getDocumentName () const
 Returns the name of the document. More...
 
+
+model::Patcher const & getPatcher () const
 Returns the Patcher model.
 
+bool isRemote () const noexcept
 Returns true if the this is a remotely connected document.
 
uint64_t getSessionId () const noexcept
 Returns the session ID of the document. More...
 
std::string getDocumentName () const
 Returns the name of the document. More...
 
size_t getNumberOfUsers ()
 Returns the number of users connected to the patcher document.
 
+
std::unordered_set< uint64_t > getConnectedUsers ()
 Returns the list of users connected to the patcher document.
 
+
size_t getNumberOfView ()
 Returns the number of patcher views.
 
+
void newView ()
 create a new patcher view window.
 
+
void bringsFirstViewToFront ()
 Brings the first patcher view to front.
 
-void forceCloseAllWindows ()
 Force all windows to close without asking user to save document.
 
bool askAllWindowsToClose ()
 Attempt to close all document windows, after asking user to save them if needed. More...
 
bool closePatcherViewWindow (PatcherView &patcherview)
 Close the window that contains a given patcherview. More...
 
-bool saveDocument ()
 Save the document.
 
-bool needsSaving () const noexcept
 Returns true if the patcher needs to be saved.
 
+
+PatcherViewWindow & getFirstWindow ()
 Returns the first window of the patcher manager.
 
void closePatcherViewWindow (PatcherView &patcherview)
 Close the window that contains a given patcherview. More...
 
void addListener (Listener &listener)
 Add a listener.
 
+
void removeListener (Listener &listener)
 remove a listener.
 
+
void documentAdded (DocumentBrowser::Drive::DocumentSession &doc) override
 Called when a document session has been added.
 
+
void documentChanged (DocumentBrowser::Drive::DocumentSession &doc) override
 Called when a document session changed.
 
-void documentRemoved (DocumentBrowser::Drive::DocumentSession &doc) override
 Called when a document session has been removed.
 
+void forceCloseAllWindows ()
 Force all windows to close without asking user to save document.
 
- Public Member Functions inherited from kiwi::DocumentBrowser::Drive::Listener
+
virtual ~Listener ()=default
 Destructor.
 
+
+virtual void documentRemoved (DocumentBrowser::Drive::DocumentSession &doc)
 Called when a document session has been removed.
 
virtual void driveChanged ()
 Called when one or more documents has been added, removed or changed.
 
@@ -218,14 +258,12 @@

-

◆ closePatcherViewWindow()

- +

- + @@ -239,9 +277,7 @@

-

◆ getDocumentName()

- +

bool kiwi::PatcherManager::closePatcherViewWindow void kiwi::PatcherManager::closePatcherViewWindow ( PatcherView &  patcherview)
@@ -255,13 +291,11 @@

Returns the name of the document.

-

This function returns 0 if the document is loaded from disk or memory.

See also
isRemote
+

This function returns 0 if the document is loaded from disk or memory.

See also
isRemote
- -

◆ getSessionId()

- +

@@ -283,7 +317,25 @@

Returns the session ID of the document.

-

This function returns 0 if the document is loaded from disk or memory.

See also
isRemote
+

This function returns 0 if the document is loaded from disk or memory.

See also
isRemote
+ + + + +
+
+

+ + + + + + +
bool kiwi::PatcherManager::saveDocument ()
+
+ +

Save the document.

+

Returns true if saving document succeeded false otherwise.

@@ -296,7 +348,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_toolbar-members.html b/docs/html/classkiwi_1_1_patcher_toolbar-members.html index 0e78d898..c2c066a2 100644 --- a/docs/html/classkiwi_1_1_patcher_toolbar-members.html +++ b/docs/html/classkiwi_1_1_patcher_toolbar-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -71,13 +98,14 @@ - + +
paint(juce::Graphics &g) overridekiwi::PatcherToolbar
PatcherToolbar(PatcherManager &patcher_manager)kiwi::PatcherToolbar
resized() overridekiwi::PatcherToolbar
removeUsersIcon()kiwi::PatcherToolbar
resized() overridekiwi::PatcherToolbar
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_toolbar.html b/docs/html/classkiwi_1_1_patcher_toolbar.html index e0e8b824..7e642ede 100644 --- a/docs/html/classkiwi_1_1_patcher_toolbar.html +++ b/docs/html/classkiwi_1_1_patcher_toolbar.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::PatcherToolbar Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -87,18 +114,22 @@ - - - + + +

Public Member Functions

+
 PatcherToolbar (PatcherManager &patcher_manager)
 Constructor.
 
+
void resized () override
 juce::Component::resized
 
+
void paint (juce::Graphics &g) override
 juce::Component::paint
 
+void removeUsersIcon ()
 Removes users icon.
 
The documentation for this class was generated from the following files:
  • Client/Source/KiwiApp_Patcher/KiwiApp_PatcherComponent.h
    • @@ -109,7 +140,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1_patcher_toolbar_1_1_users_item_component-members.html b/docs/html/classkiwi_1_1_patcher_toolbar_1_1_users_item_component-members.html index d2d5749a..01f04eff 100644 --- a/docs/html/classkiwi_1_1_patcher_toolbar_1_1_users_item_component-members.html +++ b/docs/html/classkiwi_1_1_patcher_toolbar_1_1_users_item_component-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -72,9 +99,11 @@ connectedUserChanged(PatcherManager &manager) overridekiwi::PatcherToolbar::UsersItemComponentvirtual contentAreaChanged(const juce::Rectangle< int > &newArea) overridekiwi::PatcherToolbar::UsersItemComponent getToolbarItemSizes(int toolbarDepth, bool isVertical, int &preferredSize, int &minSize, int &maxSize) overridekiwi::PatcherToolbar::UsersItemComponent - paintButtonArea(juce::Graphics &, int width, int height, bool isMouseOver, bool isMouseDown) overridekiwi::PatcherToolbar::UsersItemComponent - startFlashing()kiwi::PatcherToolbar::UsersItemComponent - stopFlashing()kiwi::PatcherToolbar::UsersItemComponent + mouseDown(juce::MouseEvent const &e) override finalkiwi::PatcherToolbar::UsersItemComponent + paintButtonArea(juce::Graphics &, int width, int height, bool isMouseOver, bool isMouseDown) overridekiwi::PatcherToolbar::UsersItemComponent + startFlashing()kiwi::PatcherToolbar::UsersItemComponent + stopFlashing()kiwi::PatcherToolbar::UsersItemComponent + updateUsers()kiwi::PatcherToolbar::UsersItemComponent UsersItemComponent(const int toolbarItemId, PatcherManager &patcher_manager)kiwi::PatcherToolbar::UsersItemComponent ~Listener() (defined in kiwi::PatcherManager::Listener)kiwi::PatcherManager::Listenerinlinevirtual ~UsersItemComponent()kiwi::PatcherToolbar::UsersItemComponent @@ -83,7 +112,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_toolbar_1_1_users_item_component.html b/docs/html/classkiwi_1_1_patcher_toolbar_1_1_users_item_component.html index 1292cc49..e61b06c5 100644 --- a/docs/html/classkiwi_1_1_patcher_toolbar_1_1_users_item_component.html +++ b/docs/html/classkiwi_1_1_patcher_toolbar_1_1_users_item_component.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::PatcherToolbar::UsersItemComponent Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -86,38 +113,46 @@ - - - - + + + - - - - + + +

Public Member Functions

+
 UsersItemComponent (const int toolbarItemId, PatcherManager &patcher_manager)
 Constructor.
 
+
 ~UsersItemComponent ()
 Destructor.
 
+
void connectedUserChanged (PatcherManager &manager) override
 Called when one or more users are connecting or disconnecting to the Patcher Document.
 
+
+void updateUsers ()
 Call to update the number of users displayed and user names.
 
bool getToolbarItemSizes (int toolbarDepth, bool isVertical, int &preferredSize, int &minSize, int &maxSize) override
 Provides prefered size for this item.
 
+
void paintButtonArea (juce::Graphics &, int width, int height, bool isMouseOver, bool isMouseDown) override
 Paint the button area.
 
+
void contentAreaChanged (const juce::Rectangle< int > &newArea) override
 Called when content area changed.
 
+
void startFlashing ()
 Starts this component flashing.
 
+
void stopFlashing ()
 Stops this component flashing.
 
+void mouseDown (juce::MouseEvent const &e) override final
 Displays the list of usernames.
 

Detailed Description

A toolbar component that displays informations about the users of the patch.

@@ -130,7 +165,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_view-members.html b/docs/html/classkiwi_1_1_patcher_view-members.html index 47404414..1b56e2d5 100644 --- a/docs/html/classkiwi_1_1_patcher_view-members.html +++ b/docs/html/classkiwi_1_1_patcher_view-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -69,36 +96,38 @@

This is the complete list of members for kiwi::PatcherView, including all inherited members.

- - - - + + + + - + - - - + + + - - - - - - - - - - - + + + + + + + + + + + + + + + - - @@ -107,7 +136,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_view.html b/docs/html/classkiwi_1_1_patcher_view.html index e14b57ed..d1a0050e 100644 --- a/docs/html/classkiwi_1_1_patcher_view.html +++ b/docs/html/classkiwi_1_1_patcher_view.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::PatcherView Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
createObjectModel(std::string const &text)kiwi::PatcherView
endEditBox(ClassicBox &box, std::string new_text)kiwi::PatcherView
getAllCommands(juce::Array< juce::CommandID > &commands) override (defined in kiwi::PatcherView)kiwi::PatcherView
getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo &result) override (defined in kiwi::PatcherView)kiwi::PatcherView
editObject(ObjectFrame &object_frame)kiwi::PatcherView
getAllCommands(juce::Array< juce::CommandID > &commands) override (defined in kiwi::PatcherView)kiwi::PatcherView
getCommandInfo(juce::CommandID commandID, juce::ApplicationCommandInfo &result) override (defined in kiwi::PatcherView)kiwi::PatcherView
getDistantSelection(ObjectFrame const &object) const kiwi::PatcherView
getLink(model::Link const &link)kiwi::PatcherView
getLinks() constkiwi::PatcherView
getLinks() const kiwi::PatcherView
getNextCommandTarget() override (defined in kiwi::PatcherView)kiwi::PatcherView
getObject(model::Object const &object)kiwi::PatcherView
getObjects() constkiwi::PatcherView
getOriginPosition() constkiwi::PatcherView
getObject(model::Object const &object)kiwi::PatcherView
getObjects() const kiwi::PatcherView
getOriginPosition() const kiwi::PatcherView
getPatcherViewModel()kiwi::PatcherView
getViewport()kiwi::PatcherViewinline
isLocked() constkiwi::PatcherView
isSelected(ObjectView const &object) constkiwi::PatcherView
isSelected(LinkView const &link) constkiwi::PatcherView
keyPressed(const juce::KeyPress &key) override (defined in kiwi::PatcherView)kiwi::PatcherView
LinkViews typedef (defined in kiwi::PatcherView)kiwi::PatcherView
mouseDoubleClick(const juce::MouseEvent &event) override (defined in kiwi::PatcherView)kiwi::PatcherView
mouseDown(juce::MouseEvent const &event) override (defined in kiwi::PatcherView)kiwi::PatcherView
mouseDrag(juce::MouseEvent const &e) override (defined in kiwi::PatcherView)kiwi::PatcherView
mouseMove(juce::MouseEvent const &event) override (defined in kiwi::PatcherView)kiwi::PatcherView
mouseUp(juce::MouseEvent const &e) override (defined in kiwi::PatcherView)kiwi::PatcherView
ObjectViews typedef (defined in kiwi::PatcherView)kiwi::PatcherView
isEditingObject() const kiwi::PatcherView
isLocked() const kiwi::PatcherView
isSelected(ObjectFrame const &object) const kiwi::PatcherView
isSelected(LinkView const &link) const kiwi::PatcherView
keyPressed(const juce::KeyPress &key) override (defined in kiwi::PatcherView)kiwi::PatcherView
LinkViews typedef (defined in kiwi::PatcherView)kiwi::PatcherView
mouseDoubleClick(const juce::MouseEvent &event) override (defined in kiwi::PatcherView)kiwi::PatcherView
mouseDown(juce::MouseEvent const &event) override (defined in kiwi::PatcherView)kiwi::PatcherView
mouseDrag(juce::MouseEvent const &e) override (defined in kiwi::PatcherView)kiwi::PatcherView
mouseMove(juce::MouseEvent const &event) override (defined in kiwi::PatcherView)kiwi::PatcherView
mouseUp(juce::MouseEvent const &e) override (defined in kiwi::PatcherView)kiwi::PatcherView
objectEditorHidden(ObjectFrame const &object_frame)kiwi::PatcherView
objectEditorShown(ObjectFrame const &object_frame)kiwi::PatcherView
ObjectFrames typedef (defined in kiwi::PatcherView)kiwi::PatcherView
objectTextChanged(ObjectFrame const &object_frame, std::string const &new_text)kiwi::PatcherView
paint(juce::Graphics &g) override (defined in kiwi::PatcherView)kiwi::PatcherView
patcherChanged(model::Patcher &patcher, model::Patcher::View &view) (defined in kiwi::PatcherView)kiwi::PatcherView
PatcherView(PatcherManager &manager, Instance &instance, model::Patcher &patcher, model::Patcher::View &view)kiwi::PatcherView
perform(const InvocationInfo &info) override (defined in kiwi::PatcherView)kiwi::PatcherView
setLock(bool locked)kiwi::PatcherView
startEditBox(ClassicBox *box)kiwi::PatcherView
updateWindowTitle() const (defined in kiwi::PatcherView)kiwi::PatcherView
usePatcherManager()kiwi::PatcherView
~Listener() (defined in kiwi::PatcherManager::Listener)kiwi::PatcherManager::Listenerinlinevirtual
~PatcherView()kiwi::PatcherView
- + - - - - + +
@@ -87,157 +114,153 @@ - - - - + + + +

Public Types

-using ObjectViews = std::vector< std::unique_ptr< ObjectView > >
 
-using LinkViews = std::vector< std::unique_ptr< LinkView > >
 
+using ObjectFrames = std::vector< std::unique_ptr< ObjectFrame >>
 
+using LinkViews = std::vector< std::unique_ptr< LinkView >>
 
- - - - - - - - - - - - - - - + + + + + + + + + - - - - - - - - - - + + + + + + + + + + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - - - - - - -

Public Member Functions

+
 PatcherView (PatcherManager &manager, Instance &instance, model::Patcher &patcher, model::Patcher::View &view)
 Constructor.
 
+
 ~PatcherView ()
 Destructor.
 
+
PatcherManager & usePatcherManager ()
 Returns the PatcherManager.
 
+
void patcherChanged (model::Patcher &patcher, model::Patcher::View &view)
 
+
model::Patcher::View & getPatcherViewModel ()
 Returns the patcher view model.
 
-ObjectViews const & getObjects () const
 Returns the ObjectViews.
 
-LinkViews const & getLinks () const
 Returns the LinkViews.
 
-ObjectView * getObject (model::Object const &object)
 Returns the ObjectView corresponding to a given Object model.
 
+
+ObjectFrames const & getObjects () const
 Returns the Objects' frames.
 
+LinkViews const & getLinks () const
 Returns the LinkViews.
 
+ObjectFrame * getObject (model::Object const &object)
 Returns the Object's frame corresponding to a given Object model.
 
LinkView * getLink (model::Link const &link)
 Returns the LinkView corresponding to a given Link model.
 
+
void setLock (bool locked)
 Set the lock status of the patcher view.
 
-bool isLocked () const
 Get the lock status of the patcher view.
 
-bool isSelected (ObjectView const &object) const
 Returns true if the object is selected.
 
-bool isSelected (LinkView const &link) const
 Returns true if the link is selected.
 
+bool isLocked () const
 Get the lock status of the patcher view.
 
+std::set< uint64_t > getDistantSelection (ObjectFrame const &object) const
 Returns a list of Users that selected an object.
 
+bool isSelected (ObjectFrame const &object) const
 Returns true if the object is selected.
 
+bool isSelected (LinkView const &link) const
 Returns true if the link is selected.
 
PatcherViewport & getViewport ()
 Returns the Viewport that contains this patcher view. More...
 
-juce::Point< int > getOriginPosition () const
 Returns the position of the patcher origin relative to the component position.
 
-model::Object & createObjectModel (std::string const &text)
 Create an object model.
 
bool startEditBox (ClassicBox *box)
 Call this to switch the box to edit mode. More...
 
void endEditBox (ClassicBox &box, std::string new_text)
 called by ClassicBox when hmmm.. the text has been edited. More...
 
-void updateWindowTitle () const
 
+
+juce::Point< int > getOriginPosition () const
 Returns the position of the patcher origin relative to the component position.
 
void editObject (ObjectFrame &object_frame)
 Call this to switch the box to edit mode. More...
 
+void objectEditorShown (ObjectFrame const &object_frame)
 Called when the object has entered edition mode.
 
+void objectTextChanged (ObjectFrame const &object_frame, std::string const &new_text)
 Called once an object's text has changed.
 
+void objectEditorHidden (ObjectFrame const &object_frame)
 Called when the object is quitting edition mode.
 
+bool isEditingObject () const
 Returns true if an object if being edited.
 
void paint (juce::Graphics &g) override
 
+
void mouseDown (juce::MouseEvent const &event) override
 
+
void mouseDrag (juce::MouseEvent const &e) override
 
+
void mouseUp (juce::MouseEvent const &e) override
 
+
void mouseMove (juce::MouseEvent const &event) override
 
+
void mouseDoubleClick (const juce::MouseEvent &event) override
 
+
bool keyPressed (const juce::KeyPress &key) override
 
+
juce::ApplicationCommandTarget * getNextCommandTarget () override
 
+
void getAllCommands (juce::Array< juce::CommandID > &commands) override
 
+
void getCommandInfo (juce::CommandID commandID, juce::ApplicationCommandInfo &result) override
 
+
bool perform (const InvocationInfo &info) override
 

Detailed Description

The juce Patcher Component.

Member Function Documentation

- -

◆ endEditBox()

- +
- + - - - - - - - - - - + + - -
void kiwi::PatcherView::endEditBox void kiwi::PatcherView::editObject (ClassicBox & box,
std::string new_text 
ObjectFrame & object_frame) )
-

called by ClassicBox when hmmm.. the text has been edited.

-

You will need to call startEditBox() function before calling this.

+

Call this to switch the box to edit mode.

+

Will result in objectEdited being called in case of success.

- -

◆ getViewport()

- +
@@ -261,27 +284,6 @@

-

◆ startEditBox()

- -
-
-

- - - - - - - -
bool kiwi::PatcherView::startEditBox (ClassicBox * box)
-
- -

Call this to switch the box to edit mode.

-

You will need to call endEditBox() function after calling this.

-
The documentation for this class was generated from the following files:
    @@ -293,7 +295,7 @@

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1_patcher_view_window-members.html b/docs/html/classkiwi_1_1_patcher_view_window-members.html index 45f32b86..e01af49b 100644 --- a/docs/html/classkiwi_1_1_patcher_view_window-members.html +++ b/docs/html/classkiwi_1_1_patcher_view_window-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -69,25 +96,28 @@

This is the complete list of members for kiwi::PatcherViewWindow, including all inherited members.

- - - - - - - - - + + + + + + + + + + + - - + + +
closeButtonPressed() override (defined in kiwi::PatcherViewWindow)kiwi::PatcherViewWindow
getAllCommands(juce::Array< juce::CommandID > &commands) override (defined in kiwi::Window)kiwi::Window
getCommandInfo(const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override (defined in kiwi::Window)kiwi::Window
getNextCommandTarget() override (defined in kiwi::Window)kiwi::Window
getPatcherManager()kiwi::PatcherViewWindow
getPatcherView()kiwi::PatcherViewWindow
isMainWindow() constkiwi::Window
PatcherViewWindow(PatcherManager &manager, PatcherView &patcherview) (defined in kiwi::PatcherViewWindow)kiwi::PatcherViewWindow
perform(InvocationInfo const &info) override (defined in kiwi::Window)kiwi::Window
close()kiwi::Window
closeButtonPressed() override (defined in kiwi::PatcherViewWindow)kiwi::PatcherViewWindow
getAllCommands(juce::Array< juce::CommandID > &commands) override (defined in kiwi::Window)kiwi::Window
getCommandInfo(const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override (defined in kiwi::Window)kiwi::Window
getNextCommandTarget() override (defined in kiwi::Window)kiwi::Window
getPatcherManager()kiwi::PatcherViewWindow
getPatcherView()kiwi::PatcherViewWindow
isMainWindow() const kiwi::Window
PatcherViewWindow(PatcherManager &manager, PatcherView &patcherview) (defined in kiwi::PatcherViewWindow)kiwi::PatcherViewWindow
perform(InvocationInfo const &info) override (defined in kiwi::Window)kiwi::Window
removeUsersIcon()kiwi::PatcherViewWindow
restoreWindowState()kiwi::Window
saveWindowState()kiwi::Window
Window(std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)kiwi::Window
~Window()kiwi::Windowvirtual
showOkCancelBox(juce::AlertWindow::AlertIconType icon_type, std::string const &title, std::string const &message, std::string const &button_1, std::string const &button_2)kiwi::PatcherViewWindow
Window(std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)kiwi::Window
~Window()kiwi::Windowvirtual
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_view_window.html b/docs/html/classkiwi_1_1_patcher_view_window.html index 0729e3a6..08e32900 100644 --- a/docs/html/classkiwi_1_1_patcher_view_window.html +++ b/docs/html/classkiwi_1_1_patcher_view_window.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::PatcherViewWindow Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -81,53 +108,65 @@ - - + + + - - + + + - + - + - - - + + + - + - + - + + + - - -

Public Member Functions

+
 PatcherViewWindow (PatcherManager &manager, PatcherView &patcherview)
 
+
+bool showOkCancelBox (juce::AlertWindow::AlertIconType icon_type, std::string const &title, std::string const &message, std::string const &button_1, std::string const &button_2)
 Shows an modal window asking for user input.
 
void closeButtonPressed () override
 
+
PatcherManager & getPatcherManager ()
 returns the patcher manager.
 
+
PatcherView & getPatcherView ()
 returns the PatcherView.
 
+void removeUsersIcon ()
 Removes the connected users icon. Called once patcher disconnected.
 
- Public Member Functions inherited from kiwi::Window
 Window (std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)
 Constructor. More...
 Constructor. More...
 
virtual ~Window ()
 Window destructor. Called whenever buttonPressed is called. More...
 Window destructor. Called whenever buttonPressed is called. More...
 
bool isMainWindow () const
 Return true if window shall be a main window of kiwi. More...
 
bool isMainWindow () const
 Return true if window shall be a main window of kiwi. More...
 
void restoreWindowState ()
 Restore the window state. More...
 Restore the window state. More...
 
void saveWindowState ()
 Save the window state. More...
 Save the window state. More...
 
+
+void close ()
 Close the window.
 
ApplicationCommandTarget * getNextCommandTarget () override
 
+
void getAllCommands (juce::Array< juce::CommandID > &commands) override
 
+
void getCommandInfo (const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override
 
+
bool perform (InvocationInfo const &info) override
 
- @@ -141,7 +180,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_viewport-members.html b/docs/html/classkiwi_1_1_patcher_viewport-members.html index 77fccbb6..b72e9ca7 100644 --- a/docs/html/classkiwi_1_1_patcher_viewport-members.html +++ b/docs/html/classkiwi_1_1_patcher_viewport-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

Additional Inherited Members

- Protected Member Functions inherited from kiwi::Window
+
void closeButtonPressed () override
 Called when close button is pressed. Request instance to close the window.
 
- + - - - - + +
@@ -70,13 +97,13 @@

This is the complete list of members for kiwi::PatcherViewport, including all inherited members.

- - - - - - - + + + + + + + @@ -90,7 +117,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_patcher_viewport.html b/docs/html/classkiwi_1_1_patcher_viewport.html index 6d0a38e0..11cf0030 100644 --- a/docs/html/classkiwi_1_1_patcher_viewport.html +++ b/docs/html/classkiwi_1_1_patcher_viewport.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::PatcherViewport Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
bringRectToCentre(juce::Rectangle< int > bounds)kiwi::PatcherViewport
getObjectsArea() const noexceptkiwi::PatcherViewport
getOriginPosition() const noexceptkiwi::PatcherViewport
getRelativePosition(juce::Point< int > point) const noexceptkiwi::PatcherViewport
getRelativeViewArea() const noexceptkiwi::PatcherViewport
getRelativeViewPosition() const noexceptkiwi::PatcherViewport
getZoomFactor() const noexceptkiwi::PatcherViewport
jumpViewToObject(ObjectView const &)kiwi::PatcherViewport
getObjectsArea() const noexceptkiwi::PatcherViewport
getOriginPosition() const noexceptkiwi::PatcherViewport
getRelativePosition(juce::Point< int > point) const noexceptkiwi::PatcherViewport
getRelativeViewArea() const noexceptkiwi::PatcherViewport
getRelativeViewPosition() const noexceptkiwi::PatcherViewport
getZoomFactor() const noexceptkiwi::PatcherViewport
jumpViewToObject(ObjectFrame const &)kiwi::PatcherViewport
PatcherViewport(PatcherView &patcher)kiwi::PatcherViewport
resetObjectsArea()kiwi::PatcherViewport
resized() overridekiwi::PatcherViewport
- + - - - - + +
@@ -85,66 +112,66 @@ - - - - - - - - + + + - - - - - - - - - - + + + + + + + + + - - - - - - - + + + + + + - - - - + + + @@ -152,9 +179,7 @@

Detailed Description

The PatcherView Viewport.

Member Function Documentation

- -

◆ setZoomFactor()

- +

Public Member Functions

+
 PatcherViewport (PatcherView &patcher)
 Constructor.
 
+
 ~PatcherViewport ()=default
 Destructor.
 
+
void visibleAreaChanged (juce::Rectangle< int > const &new_visible_area) override
 Called by juce::Viewport when the visible area changed.
 
+
void resized () override
 Overriden from juce::Viewport to update patcher area on viewport resize.
 
-void jumpViewToObject (ObjectView const &)
 Make the object visible in the viewport area.
 
+
+void jumpViewToObject (ObjectFrame const &)
 Make the object visible in the viewport area.
 
void bringRectToCentre (juce::Rectangle< int > bounds)
 Attempts to brings the center of the given bounds to the center of the viewport view area.
 
-juce::Point< int > getRelativePosition (juce::Point< int > point) const noexcept
 Transforms a given point into a point relative to the patcher origin position.
 
-juce::Rectangle< int > getRelativeViewArea () const noexcept
 Returns the current patcher area relative to the patcher origin position.
 
-juce::Point< int > getRelativeViewPosition () const noexcept
 Get the view position relative to the patcher origin position.
 
+
+juce::Point< int > getRelativePosition (juce::Point< int > point) const noexcept
 Transforms a given point into a point relative to the patcher origin position.
 
+juce::Rectangle< int > getRelativeViewArea () const noexcept
 Returns the current patcher area relative to the patcher origin position.
 
+juce::Point< int > getRelativeViewPosition () const noexcept
 Get the view position relative to the patcher origin position.
 
void setRelativeViewPosition (juce::Point< int > position)
 Set the new view position relative to the patcher origin position.
 
void setZoomFactor (double zoom_factor)
 Set the zoom factor. More...
 
-double getZoomFactor () const noexcept
 Returns the current zoom factor.
 
-juce::Point< int > getOriginPosition () const noexcept
 Returns the position of the patcher origin relative to the component position.
 
+
+double getZoomFactor () const noexcept
 Returns the current zoom factor.
 
+juce::Point< int > getOriginPosition () const noexcept
 Returns the position of the patcher origin relative to the component position.
 
void resetObjectsArea ()
 Reset the objects area.
 
-juce::Rectangle< int > getObjectsArea () const noexcept
 Returns the current objects area.
 
+
+juce::Rectangle< int > getObjectsArea () const noexcept
 Returns the current objects area.
 
void updatePatcherArea (bool keep_same_view_position)
 Update patcher size.
 
@@ -182,7 +207,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_settings_panel-members.html b/docs/html/classkiwi_1_1_settings_panel-members.html index 823d7184..c802a4b2 100644 --- a/docs/html/classkiwi_1_1_settings_panel-members.html +++ b/docs/html/classkiwi_1_1_settings_panel-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -76,7 +103,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_settings_panel.html b/docs/html/classkiwi_1_1_settings_panel.html index 27ac8007..2274a293 100644 --- a/docs/html/classkiwi_1_1_settings_panel.html +++ b/docs/html/classkiwi_1_1_settings_panel.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::SettingsPanel Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -85,11 +112,11 @@ - - @@ -105,7 +132,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_settings_panel.png b/docs/html/classkiwi_1_1_settings_panel.png index 2fb9650df8691676937039529e57edb7f1bf7dc5..c423be47a40c6d67336e2e44b405e77613a252af 100644 GIT binary patch delta 686 zcmV;f0#W_31lk25iBL{Q4GJ0x0000DNk~Le0002+0000`2m=5B01%f5PLUxxe*$Sq zL_t(|0qvdJma8BT1*>1&|NqBl3jLa9{K?Fcw7{(J@F;Aw z^><_Q=<1^tfdp~{OV&MFC{YsK5tQOAOG;p++q#3>w z9tT|bCrK5y2+u_PEZ6rG4i)Y|;jo9(P_eW&7aot5q#9eQba7rrp|%UBDm@YYEVCu4 z!hUCX@01?C!zpLpZFD;(Tz0i%mCo|FDAl9Dy9i5Cg{_~$uY@IOKU`Rne-`;UVM$t# z3rkWfTv(D0#)T!R6@S8JW^KuY&CJ>Yu#OJkEY1l2Yr>VSp#&!T?Xkg#m7Wf0V!Z delta 515 zcmcb`x{*b(Gr-TCmrII^fq{Y7)59eQNEZWf00%RWlwG>ZXQHB2J>vmS7srqa#wEp8m`}||FtTs31y}Z@- zM2)<^+LrBQSLURrS1X<4P5TsA@3#8O(VMrv*=?S^(dYU%w#}C3o6lqy=3ULb=EmKhAmIPh*E!I?TN^$DxQgcEx9o$4{)-FS(AYufQ-<_yu- zLI(ofLVX(i5>LHJIKN{ft55Nag?r@|e>!!kvNa%X<8xJ|ORK(L`Z8sY%4C~JLvGFQ zK^~gXnX63JryB+O&iEp-Y~wqBo&4Yf+s-YtJqUbo;>q1ED$+JzFYm+acP_1~RctUJ~P z``H~>bBOte_xz6H=h^HRGXI`tIQF7_hLTe8SAGd4=e#uyp$~xZ%HZkh=d#Wzp$P!D C{P(E< diff --git a/docs/html/classkiwi_1_1_sign_up_form-members.html b/docs/html/classkiwi_1_1_sign_up_form-members.html new file mode 100644 index 00000000..6a8e2abd --- /dev/null +++ b/docs/html/classkiwi_1_1_sign_up_form-members.html @@ -0,0 +1,126 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+

Public Member Functions

+
 SettingsPanel ()
 Constructor.
 
+
 ~SettingsPanel ()
 Destructor.
 
+ + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
kiwi::SignUpForm Member List
+
+
+ +

This is the complete list of members for kiwi::SignUpForm, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
addField(Args &&...args)kiwi::FormComponentprotected
clearFields()kiwi::FormComponentprotected
dismiss()kiwi::FormComponentvirtual
FormComponent(std::string const &submit_button_text, std::string const &overlay_text="")kiwi::FormComponent
getBestHeight()kiwi::FormComponent
getFieldsHeight()kiwi::FormComponentprotected
getFieldValue(std::string const &name)kiwi::FormComponentprotected
hasOverlay()kiwi::FormComponentprotected
hideOverlay()kiwi::FormComponentprotected
onUserCancelled()kiwi::FormComponentprotectedvirtual
removeField(std::string const &name)kiwi::FormComponentprotected
resized() override (defined in kiwi::FormComponent)kiwi::FormComponentprotected
setSubmitText(std::string const &submit_text)kiwi::FormComponentprotected
showAlert(std::string const &message, AlertBox::Type type=AlertBox::Type::Error)kiwi::FormComponentprotected
showOverlay()kiwi::FormComponentprotected
showSuccessOverlay(juce::String const &message)kiwi::FormComponentprotected
SignUpForm()kiwi::SignUpForm
~FormComponent()kiwi::FormComponentvirtual
~SignUpForm()=defaultkiwi::SignUpForm
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_sign_up_form.html b/docs/html/classkiwi_1_1_sign_up_form.html new file mode 100644 index 00000000..3b4b3656 --- /dev/null +++ b/docs/html/classkiwi_1_1_sign_up_form.html @@ -0,0 +1,219 @@ + + + + + + +Kiwi: kiwi::SignUpForm Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
kiwi::SignUpForm Class Reference
+
+
+
+Inheritance diagram for kiwi::SignUpForm:
+
+
+ + +kiwi::FormComponent + +
+ + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 SignUpForm ()
 Constructor. More...
 
+ ~SignUpForm ()=default
 Destructor.
 
- Public Member Functions inherited from kiwi::FormComponent
 FormComponent (std::string const &submit_button_text, std::string const &overlay_text="")
 Constructor. More...
 
+virtual ~FormComponent ()
 Destructor.
 
virtual void dismiss ()
 This is called when the form is dismissed. More...
 
int getBestHeight ()
 Computes and returns the best height for this form. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from kiwi::FormComponent
+template<class FieldType , class... Args>
FieldType & addField (Args &&...args)
 Add a new field.
 
+juce::Value getFieldValue (std::string const &name)
 Returns a field Value.
 
+void removeField (std::string const &name)
 Remove fields by name.
 
+void clearFields ()
 Remove all fields.
 
+void showAlert (std::string const &message, AlertBox::Type type=AlertBox::Type::Error)
 Show an Alert on the top of the form;.
 
+void showOverlay ()
 Show overlay.
 
+void showSuccessOverlay (juce::String const &message)
 Show success overlay.
 
+void hideOverlay ()
 Hide overlay.
 
+void setSubmitText (std::string const &submit_text)
 Changes the submit button text.
 
+bool hasOverlay ()
 Returns true if the overlay component is visible.
 
virtual void onUserCancelled ()
 Called when the user clicked the cancel button. More...
 
+void resized () override
 
+int getFieldsHeight ()
 Returns the height of all fields.
 
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
kiwi::SignUpForm::SignUpForm ()
+
+ +

Constructor.

+

Creates a signup form.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.h
    • +
  • Client/Source/KiwiApp_Auth/KiwiApp_AuthPanel.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_sign_up_form.png b/docs/html/classkiwi_1_1_sign_up_form.png new file mode 100644 index 0000000000000000000000000000000000000000..5f78dc0d97cbcb7ea6de874ae218a767fb70a243 GIT binary patch literal 1162 zcmeAS@N?(olHy`uVBq!ia0y~yU=#qdJ2;quq{K9ry&x*UC&cyt|NlVdi#K0O`wvY3 zvcUMjfdj0acjSRwj*=k1UtaZ2HCke8-<`^)81g8cYYjXz&mG2zUa;AF*_D}pL}RupjJ`={A6e^&6tlzDjUXAX(qEoE)y^Va|Dj~Nr{&J?@dQ(N+HldNL@9V_F_ z=M)u<`v2_@$@{!hjz@T}>H2ehA=jLp^5Shpd`gp7PFR_rop$(-v9bB5852HkyT1N! z+Me}h`SVlL-aX+|G=3dD)hE?<^F_b3XIAGqBk#SJm!CP)x-x_Jrby7;EUR7SOYd6# zZJDrf)_t9n^-j~AmW5{+icg$1bLUj~RTHvu(w@cDIdt$voPV0CSf0K)!nE$o)QQV& zKAn1V<_)jYucXVoDM=S?uC3np=KZbIXPReT|N0d6`FCKhY4^;%&K_yc+~RhAb5xu; z^S`@}im@p7NuQ^tK;HV}PDa5SC!7g^3NAHOTsoyF&&5M?=^W{X>z5d}Owwpzf#>thND11BGA+AoI7LmrcY+R;HM`jxcr!tlGDZs9RWHj zN+R5y97}x_UH@gB{_gl+Sa9RayXQJOc1!AKM|!v%(fZwg`@3EGl2S$6`;%pi!aJ@U zDzN+Gm%KIH>e$8Y&#vBFyD3W4DEk7twETOuW&ZySY_qbrSe2d;e?NDt_LHz*+Wd#5 zgantKE4p&*DZ8Cr(1}e>aRNp={&FaO)=6!x*gfItjc?*tt^SJ{y*1KSJbrJ^vhA_4 zLCRelZltc7SJ*n!Y(nMXRkM$?M(*GDG*(UN(b}2cA9r-@jqq^M5EBwSB`+u>Sf~SJ zb+x**Bq<6m1WBv~d$pMPL-!>{3o)h*Q`c=4OgQGm@bJ}PHyxG-d25&hbXcf^>Sj*} z^0KsKc>Cnf%LtAIaAcyNl5z3d&x$)DVd7tTziv3Z`*=GCV?^r5JKtLwWX`H{yxckU zP(cXqyV<|Ly`H}^MQnNUN*>$8?`vl=`b_dtr zPS5JMuUJu)U$u(gcIsBQO|eSydM>x$aYu%oNavpUe1Fa7?9h7m4x3w3coiQv6{hh1 zEK$5VDN1wF)8z%hBWoX$C3=`dr0uFGL=?h7$ c=1=UCo@`xtw_IsGu;5_uboFyt=akR{0E80t8~^|S literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_slider_view-members.html b/docs/html/classkiwi_1_1_slider_view-members.html new file mode 100644 index 00000000..fda7b364 --- /dev/null +++ b/docs/html/classkiwi_1_1_slider_view-members.html @@ -0,0 +1,130 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+
kiwi::SliderView Member List
+
+
+ +

This is the complete list of members for kiwi::SliderView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
create(model::Object &object) (defined in kiwi::SliderView)kiwi::SliderViewstatic
declare() (defined in kiwi::SliderView)kiwi::SliderViewstatic
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
SliderView(model::Object &object_model) (defined in kiwi::SliderView)kiwi::SliderView
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~ObjectView()kiwi::ObjectViewvirtual
~SliderView() (defined in kiwi::SliderView)kiwi::SliderView
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_slider_view.html b/docs/html/classkiwi_1_1_slider_view.html new file mode 100644 index 00000000..4f6c2199 --- /dev/null +++ b/docs/html/classkiwi_1_1_slider_view.html @@ -0,0 +1,197 @@ + + + + + + +Kiwi: kiwi::SliderView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
+
kiwi::SliderView Class Reference
+
+
+
+Inheritance diagram for kiwi::SliderView:
+
+
+ + +kiwi::ObjectView +kiwi::model::Object::Listener + +
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SliderView (model::Object &object_model)
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + +

+Static Public Member Functions

+static void declare ()
 
+static std::unique_ptr< ObjectView > create (model::Object &object)
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_SliderView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_SliderView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_slider_view.png b/docs/html/classkiwi_1_1_slider_view.png new file mode 100644 index 0000000000000000000000000000000000000000..1db5e74ee006111f948bee878826b4c92c04475e GIT binary patch literal 1506 zcmaJ>eKeF=7=MSeXI?LFt--*fMMp8K48f4}==`TOlM z)Hl}$0Km}8lRyLj6olBBXkG1Crg1{R%zt;Fheo48%r{eW^z2q9Vtwu{EiHOk!&qdB z28n(F0OF)=;*LOj0MLu}BJ2o^M@?UUo?q;2px1fW^rObj6{UMmw`Awy(jH-{&7BFK z@58+sbBNx`jEOe_2zCQl%wdV#ucA{lCG%u~UM%*Y$rl{W7svwSMntQvx4B{V} z*<5&}xZt_G0mdHoAzi+Ew=^~><4Uzvpz>90zqmbgPcmoly>(pOK+tvh@UX1VOiqoG+2dlq~{sX-W4a@2oM%p2KZ6o1$lLqLL zX;h}W(TdFDUCW{@d-YbFZ_1ui6}#BAWO-tKGyb93^_e_d(Fm-!qyVXzikHpgd=RzB zT>!LNP=G^B+?maYn_0;+3j-u}u~Y|r7DSyZlB-;e0i74S-;+`Q=eOgV$JD1olLA!$ z$BCOOGitE{snodJ{Sz`qoc3~^61DypWCUv!^pg{Imq~fplhkAC@NUu6uBW~DO`(eV z4z&v+o{If})4t_&Hhb;sqZBwfPU(OU_fKKP_`YciBfFOYO@?(zWx0?Jm1@^u0r$R~ zjb}<{(HHB=oIr`hZ9+*m@$#W<4Wsx*&}ncppXd5GxbNC<1Dw)cIeFD~q=xGVJA&-} z;eV9gCt>Y+g3Ni(NB0Sj3(|{w@T@NC42C}ONmv`z!7s;zlA=SoFvgDBM(IptdyDQk0~Z?&TX8&4Vb#n-e#1r*zQgsu99F5b`&`K<5qV;P zEpK${xAj_4fU&QICU45xUdf>hNu$SGj1z~z{VFMq1$BWazFCI(szd?cx<%AZ#J^`*Nm|A__e@1O6m;pJjrAa|448Ov#qwATnnPsj7L&}gtoV?_H>K} zEbzg|2-KYn@H%f9k^ah{Qyk^jcs-`>a<=#ecZ3!5wDIfQ85zw+z+Px3qjP>od5s; literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1_stored_settings-members.html b/docs/html/classkiwi_1_1_stored_settings-members.html index b77ef9ae..fe88f41c 100644 --- a/docs/html/classkiwi_1_1_stored_settings-members.html +++ b/docs/html/classkiwi_1_1_stored_settings-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -80,7 +107,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_stored_settings.html b/docs/html/classkiwi_1_1_stored_settings.html index 13f26b00..2bff4f69 100644 --- a/docs/html/classkiwi_1_1_stored_settings.html +++ b/docs/html/classkiwi_1_1_stored_settings.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::StoredSettings Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -85,27 +112,27 @@ - - - - - - @@ -121,7 +148,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_suggest_editor-members.html b/docs/html/classkiwi_1_1_suggest_editor-members.html index 086a383f..402214ec 100644 --- a/docs/html/classkiwi_1_1_suggest_editor-members.html +++ b/docs/html/classkiwi_1_1_suggest_editor-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

Public Member Functions

+
 StoredSettings ()
 Constructor.
 
+
 ~StoredSettings ()
 Destructor.
 
+
juce::PropertiesFile & getGlobalProperties ()
 Returns the global properties file.
 
+
void flush ()
 Flush settings.
 
+
void reload ()
 Reload settings.
 
+
NetworkSettings & network ()
 Returns the NetworkSettings.
 
- + - - - - + +
@@ -69,24 +96,14 @@

This is the complete list of members for kiwi::SuggestEditor, including all inherited members.

- - - - - - - - - - - +
addListener(SuggestEditor::Listener &listener)kiwi::SuggestEditor
closeMenu()kiwi::SuggestEditor
escapePressed() overridekiwi::SuggestEditor
focusLost(juce::Component::FocusChangeType focus_change) overridekiwi::SuggestEditor
isMenuOpened() const noexceptkiwi::SuggestEditor
keyPressed(juce::KeyPress const &key) overridekiwi::SuggestEditor
removeListener(SuggestEditor::Listener &listener)kiwi::SuggestEditor
returnPressed() overridekiwi::SuggestEditor
showMenu()kiwi::SuggestEditor
SuggestEditor(SuggestList::entries_t entries)kiwi::SuggestEditor
textEditorTextChanged(juce::TextEditor &ed) overridekiwi::SuggestEditor
SuggestEditor(SuggestList::entries_t entries)kiwi::SuggestEditor
~SuggestEditor()kiwi::SuggestEditor
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_suggest_editor.html b/docs/html/classkiwi_1_1_suggest_editor.html index 6c7c87de..348b5014 100644 --- a/docs/html/classkiwi_1_1_suggest_editor.html +++ b/docs/html/classkiwi_1_1_suggest_editor.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::SuggestEditor Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -86,9 +113,6 @@ - - - @@ -98,58 +122,16 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Classes

struct  Listener
 Receives callbacks from a SuggestEditor component. More...
 
class  Menu
 Suggestion menu. More...
 
 SuggestEditor (SuggestList::entries_t entries)
 Constructor. More...
 
+
 ~SuggestEditor ()
 Destructor.
 
-void addListener (SuggestEditor::Listener &listener)
 Adds a SuggestEditor::Listener.
 
-void removeListener (SuggestEditor::Listener &listener)
 Removes a SuggestEditor::Listener.
 
-void showMenu ()
 Shows the menu.
 
-bool isMenuOpened () const noexcept
 Returns true if the menu is currently opened.
 
-void closeMenu ()
 Close the menu.
 
-void textEditorTextChanged (juce::TextEditor &ed) override
 juce::TextEditor::Listener
 
-void returnPressed () override
 Called when the user presses the return key.
 
-void escapePressed () override
 Called when the user presses the escape key.
 
-void focusLost (juce::Component::FocusChangeType focus_change) override
 Called when the text editor loses focus.
 
-bool keyPressed (juce::KeyPress const &key) override
 juce::TextEditor.
 

Detailed Description

A text editor with auto-completion.

This component shows a dropdown menu list below it.

Constructor & Destructor Documentation

- -

◆ SuggestEditor()

- +
@@ -182,7 +164,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_suggest_editor.png b/docs/html/classkiwi_1_1_suggest_editor.png index 6f4bd7154d24aa4943379de2db9c7887b8881a3f..64d199322719f7c11c1bbd831b3efc30e6cc2cd3 100644 GIT binary patch delta 688 zcmV;h0#E(<2HXW9iBL{Q4GJ0x0000DNk~Le0002=0000`2m=5B02zF!G?5`Xe*$Ys zL_t(|0qvd9nxh~LMo(`1-~WxbMFqsJi?ti|Gc%rwrPJg<$lPLP<_`JC%*-83lANif zCCQnPmLwNKT9SMTX-R6B+MT58dOg-}zaP^jNnPxfE`geXB<-hTr`I276vwfH^hQdO z)J?Z^+SfEpTU-`BjbATme%$Rf6|L{ziKI*6K{Ri;r3|6t6pvRTvxKDlfZ{Pkfd$)m3L_t+hlg+RV%wfG-&U&f}c$Pm~^p zQ?1Vl|3v9m&@-*i3I9mx=-vR{gfxH)Ar0V5NCUVK(g41MG=K}wlpcm*I1zxmam%Cu zju6rSPavcLo&nQ^wu>_VuZ{JHH=48eU5pU`3kh%Ck{iFXZ*4)AfEF$(hZAJT-l4zKx4A?sD~4 zY5aPbXR0r~j&xDYqiN@+a-F7)qYj`Uo_tMv11fARZ#Tb${3F*5g& z-msne*1RmuS-7}#Npt*d&h+*cuY2`Pq}%L1NiPrc{xf~Se_3@KTjX0h^k(-?Z&meP zEloZ>my!nP=U^AUpY-xf1MKF8JDm&q>)h{I-T(&(X#j6R8o+^&2Jptr%pHIu`~m4i WjbsK_D^&mh002ov22Mn-LSTZ~mr>pT literal 889 zcmeAS@N?(olHy`uVBq!ia0y~yU@Qi*12~w0;BSfb6({NDf3 z{fDXFv;?Ql;P#t~HXhXJy6v=2RY^&9+WwA?l6QRalcxAsW_o%(`}Uzs&vWLDohnb0 zo==+6J=Z%(@BSQr>$OWBz0f~>d;RH$6P7q{@vGtuDOFiHxAMw|Nj1x7aC zgy+2fqvC0G=B3U4XR9sV)SP&=aChvRjrZrbeKh>K|Jfn_%6%=8$$Odf?cX~*;hxif zIW|?M|MrWTIrE)fZ=5#s)3Z0Olm0!~^V#Z})Srka-E;W8@5+3i^ZDabSKIa1lN^C^ z>d&*EueF?!EB>VNb&tR0{B38BRvONDS+o0v>#p-l-6riTT=;p}4)srau2pw`e#Ktn z!RUGG`7N9Ldoj1OPVb6;bG_K}*5gA}|LoW4K4!DEu9wZ;IMaS}lKAu`va{xjx2D*w zmH%4t9BB94?MH3j#Z1zB_GO9c%kn(_d|+U7f&v2=Iy+H92PE+2oU+m;O*L7;iD&E8 zY#fAT57gQi?U~EG;IM4H-Emo{?z?o*+1XI1|=TBsXuCE-|i{0lUaXyqU)JEk!{PC zKTC_5YX z)!#dBUin<5EB5Bkg3q!yFHf^v?-kndMrOgXRl3gUdOEjlOVkgVzfOJ5P#seJV)uee zKetWTe!bXw{ha)=3%%<$*6dO7OHH|aCi(H&MK?sWH&4;CwzvMDw2&bR=nb}QUu70Z vTC-;)u2fro^(JPx^_R;DPUJn%`-gd7l^9h5etDnm{r-UW|R86=9 diff --git a/docs/html/classkiwi_1_1_suggest_editor_1_1_menu-members.html b/docs/html/classkiwi_1_1_suggest_editor_1_1_menu-members.html index d474a590..9ddae9a8 100644 --- a/docs/html/classkiwi_1_1_suggest_editor_1_1_menu-members.html +++ b/docs/html/classkiwi_1_1_suggest_editor_1_1_menu-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -70,24 +97,27 @@

This is the complete list of members for kiwi::SuggestEditor::Menu, including all inherited members.

- - - - - - - - - + + + + + + + + + + + - + +
action_method_t typedef (defined in kiwi::SuggestEditor::Menu)kiwi::SuggestEditor::Menu
Menu(SuggestList &list)kiwi::SuggestEditor::Menu
paint(juce::Graphics &g) override (defined in kiwi::SuggestEditor::Menu)kiwi::SuggestEditor::Menu
resized() override (defined in kiwi::SuggestEditor::Menu)kiwi::SuggestEditor::Menu
selectFirstRow()kiwi::SuggestEditor::Menu
selectNextRow()kiwi::SuggestEditor::Menu
selectPreviousRow()kiwi::SuggestEditor::Menu
selectRow(int idx)kiwi::SuggestEditor::Menu
setItemClickedAction(action_method_t function)kiwi::SuggestEditor::Menu
setItemDoubleClickedAction(action_method_t function)kiwi::SuggestEditor::Menu
getSelectedRow() const kiwi::SuggestEditor::Menu
Menu(SuggestList &list, SuggestEditor &creator)kiwi::SuggestEditor::Menu
paint(juce::Graphics &g) override (defined in kiwi::SuggestEditor::Menu)kiwi::SuggestEditor::Menu
resized() override (defined in kiwi::SuggestEditor::Menu)kiwi::SuggestEditor::Menu
selectFirstRow()kiwi::SuggestEditor::Menu
selectNextRow()kiwi::SuggestEditor::Menu
selectPreviousRow()kiwi::SuggestEditor::Menu
selectRow(int idx)kiwi::SuggestEditor::Menu
setItemValidatedAction(action_method_t function)kiwi::SuggestEditor::Menu
setSelectedItemAction(action_method_t function)kiwi::SuggestEditor::Menu
setUnselectedItemAction(std::function< void(void)> function)kiwi::SuggestEditor::Menu
unselectRow()kiwi::SuggestEditor::Menu
update()kiwi::SuggestEditor::Menu
~Menu()kiwi::SuggestEditor::Menu
validateSelectedRow()kiwi::SuggestEditor::Menu
~Menu()kiwi::SuggestEditor::Menu
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_suggest_editor_1_1_menu.html b/docs/html/classkiwi_1_1_suggest_editor_1_1_menu.html index d227b1db..a0c6c738 100644 --- a/docs/html/classkiwi_1_1_suggest_editor_1_1_menu.html +++ b/docs/html/classkiwi_1_1_suggest_editor_1_1_menu.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::SuggestEditor::Menu Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -86,58 +113,70 @@ -

Public Types

+
using action_method_t = std::function< void(juce::String)>
 
- - - - + + + - - - - - - - + + + - + + + + + + - - - - + + + - - + + +

Public Member Functions

- Menu (SuggestList &list)
 Constructor.
 
+
+ Menu (SuggestList &list, SuggestEditor &creator)
 Constructor.
 
 ~Menu ()
 Destructor.
 
-void setItemClickedAction (action_method_t function)
 Set the action to execute when an item has been clicked.
 
-void setItemDoubleClickedAction (action_method_t function)
 Set the action to execute when an item has been double-clicked.
 
+
+void setItemValidatedAction (action_method_t function)
 Set the action to execute when an item has been double-clicked.
 
void setSelectedItemAction (action_method_t function)
 Set the action to execute when an item has been selected.
 
+
+void setUnselectedItemAction (std::function< void(void)> function)
 Set the action to execute when item are unselected.
 
+void unselectRow ()
 Unselect the currently selected row.
 
void selectRow (int idx)
 Select an item of the list.
 
+
void selectFirstRow ()
 Select the first item of the list.
 
+
void selectPreviousRow ()
 Select the previous item of the list.
 
+
void selectNextRow ()
 Select the next item of the list.
 
+
+void validateSelectedRow ()
 Called to validate the current selected row.
 
void update ()
 Update the list.
 
+
void paint (juce::Graphics &g) override
 
+
void resized () override
 
+int getSelectedRow () const
 Returns the curretly selected row.
 

Detailed Description

Suggestion menu.

@@ -150,7 +189,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_suggest_list-members.html b/docs/html/classkiwi_1_1_suggest_list-members.html index 457d4d01..07ef5950 100644 --- a/docs/html/classkiwi_1_1_suggest_list-members.html +++ b/docs/html/classkiwi_1_1_suggest_list-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -73,17 +100,17 @@ addEntry(std::string const &entry)kiwi::SuggestListinline applyFilter(std::string const &pattern)kiwi::SuggestListinline begin() (defined in kiwi::SuggestList)kiwi::SuggestListinline - begin() const (defined in kiwi::SuggestList)kiwi::SuggestListinline + begin() const (defined in kiwi::SuggestList)kiwi::SuggestListinline clear()kiwi::SuggestListinline const_iterator typedef (defined in kiwi::SuggestList)kiwi::SuggestList - empty() const noexceptkiwi::SuggestListinline + empty() const noexceptkiwi::SuggestListinline end() (defined in kiwi::SuggestList)kiwi::SuggestListinline - end() const (defined in kiwi::SuggestList)kiwi::SuggestListinline + end() const (defined in kiwi::SuggestList)kiwi::SuggestListinline entries_t typedef (defined in kiwi::SuggestList)kiwi::SuggestList - getCurrentFilter() constkiwi::SuggestListinline + getCurrentFilter() const kiwi::SuggestListinline iterator typedef (defined in kiwi::SuggestList)kiwi::SuggestList setOptions(Options options)kiwi::SuggestListinline - size() const noexceptkiwi::SuggestListinline + size() const noexceptkiwi::SuggestListinline SuggestList()=defaultkiwi::SuggestList SuggestList(entries_t entries)kiwi::SuggestListinline ~SuggestList()=defaultkiwi::SuggestList @@ -92,7 +119,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_suggest_list.html b/docs/html/classkiwi_1_1_suggest_list.html index 4eabc160..00c2e2a0 100644 --- a/docs/html/classkiwi_1_1_suggest_list.html +++ b/docs/html/classkiwi_1_1_suggest_list.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::SuggestList Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -85,43 +112,43 @@ - - -

Public Types

+
using entries_t = std::vector< std::string >
 
+
using iterator = entries_t::iterator
 
+
using const_iterator = entries_t::const_iterator
 
- - - - - - - - - - + + + + @@ -131,23 +158,23 @@ - - - - - - - + + + + + + - - - - + + + @@ -156,9 +183,7 @@

A string container that provide suggestion list based on given patterns.

This class maintain

Member Function Documentation

- -

◆ addEntries()

- +

Public Member Functions

+
 SuggestList ()=default
 Constructor.
 
+
 SuggestList (entries_t entries)
 Constructor.
 
+
 ~SuggestList ()=default
 Destructor.
 
+
iterator begin ()
 
+
iterator end ()
 
-const_iterator begin () const
 
-const_iterator end () const
 
+
+const_iterator begin () const
 
+const_iterator end () const
 
void setOptions (Options options)
 Set the sorting options.
 
void addEntries (std::vector< std::string > const &entries)
 Add suggestion entries to the list. More...
 
-entries_t::size_type size () const noexcept
 Returns the size of the current filtered selection.
 
-bool empty () const noexcept
 Returns true if there is no suggestion entry.
 
+
+entries_t::size_type size () const noexcept
 Returns the size of the current filtered selection.
 
+bool empty () const noexcept
 Returns true if there is no suggestion entry.
 
void clear ()
 Clear all entries.
 
-std::string const & getCurrentFilter () const
 Returns the current filter pattern applied to the list.
 
+
+std::string const & getCurrentFilter () const
 Returns the current filter pattern applied to the list.
 
void applyFilter (std::string const &pattern)
 Apply a pattern matching filter to the entries.
 
@@ -185,9 +210,7 @@

-

◆ addEntry()

- +

@@ -222,7 +245,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_toggle_view-members.html b/docs/html/classkiwi_1_1_toggle_view-members.html new file mode 100644 index 00000000..15b3f820 --- /dev/null +++ b/docs/html/classkiwi_1_1_toggle_view-members.html @@ -0,0 +1,130 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
+
+

+ + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
kiwi::ToggleView Member List
+
+
+ +

This is the complete list of members for kiwi::ToggleView, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + +
Active enum value (defined in kiwi::ObjectView)kiwi::ObjectView
Background enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ColourIds enum name (defined in kiwi::ObjectView)kiwi::ObjectView
create(model::Object &model) (defined in kiwi::ToggleView)kiwi::ToggleViewstatic
declare() (defined in kiwi::ToggleView)kiwi::ToggleViewstatic
defer(std::function< void()> call_back)kiwi::ObjectViewprotected
drawOutline(juce::Graphics &g)kiwi::ObjectViewprotected
Error enum value (defined in kiwi::ObjectView)kiwi::ObjectView
getModel() const kiwi::ObjectView
getScheduler() const kiwi::ObjectViewprotected
Highlight enum value (defined in kiwi::ObjectView)kiwi::ObjectView
modelAttributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::ObjectViewvirtual
ObjectView(model::Object &object_model)kiwi::ObjectView
Outline enum value (defined in kiwi::ObjectView)kiwi::ObjectView
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::ObjectViewprotected
setAttribute(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
setParameter(std::string const &name, tool::Parameter const &param)kiwi::ObjectViewprotected
Text enum value (defined in kiwi::ObjectView)kiwi::ObjectView
ToggleView(model::Object &object_model) (defined in kiwi::ToggleView)kiwi::ToggleView
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~ObjectView()kiwi::ObjectViewvirtual
~ToggleView() (defined in kiwi::ToggleView)kiwi::ToggleView
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_toggle_view.html b/docs/html/classkiwi_1_1_toggle_view.html new file mode 100644 index 00000000..c2c0a451 --- /dev/null +++ b/docs/html/classkiwi_1_1_toggle_view.html @@ -0,0 +1,197 @@ + + + + + + +Kiwi: kiwi::ToggleView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
Kiwi +
+
+
+ + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
+
kiwi::ToggleView Class Reference
+
+
+
+Inheritance diagram for kiwi::ToggleView:
+
+
+ + +kiwi::ObjectView +kiwi::model::Object::Listener + +
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ ToggleView (model::Object &object_model)
 
- Public Member Functions inherited from kiwi::ObjectView
+ ObjectView (model::Object &object_model)
 Constructor.
 
+virtual ~ObjectView ()
 Destructor.
 
+model::Object & getModel () const
 Returns the model represented by the graphical object.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &param) override final
 Called when one of the model's attributes has changed.
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &param) override final
 Called when a parameter has changed.
 
+ + + + + +

+Static Public Member Functions

+static void declare ()
 
+static std::unique_ptr< ObjectView > create (model::Object &model)
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from kiwi::ObjectView
enum  ColourIds {
+  Background = 0x1100004, +Error = 0x1100005, +Text = 0x1100006, +Outline = 0x1100007, +
+  Highlight = 0x1100008, +Active = 0x1100009 +
+ }
 
- Protected Member Functions inherited from kiwi::ObjectView
+tool::Scheduler & getScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+void drawOutline (juce::Graphics &g)
 Draws the outlines of the object.
 
+void setAttribute (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's attribute.
 
+void setParameter (std::string const &name, tool::Parameter const &param)
 Changes one of the data model's parameter.
 
+
The documentation for this class was generated from the following files:
    +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ToggleView.h
    • +
  • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ToggleView.cpp
    • +
+
+ +
+Generated by   +doxygen + 1.8.11 +
+ + diff --git a/docs/html/classkiwi_1_1_toggle_view.png b/docs/html/classkiwi_1_1_toggle_view.png new file mode 100644 index 0000000000000000000000000000000000000000..7a182a43613709713a39a85ff1d1c3706e3851e9 GIT binary patch literal 1335 zcmeAS@N?(olHy`uVBq!ia0y~yUhdbnEh6it1p=WwNI(DX3fhHE?e6xu2zVTXWZ%hF-67nPfIYeRXQT{UWI-*#Nd_-1GjeGT-uT zcHK|;NyX>ZZ(1HYiErc5tr~Z&v%?>^Z#h@pw!pW4;znbM`EB9;`@28+uC1NDg=cSJ z){HlY3wQ8(|61NFu*ZLT@-o@}hYRn!WzU@9x7zGX{>Nq49Iqd~zWD3hn;-rKpR?S5 zWZJdJw3oeW|3|xTO(-L3lGXc4c5bSal5Njiduw7eNKxChm%?%X-Uh9@^(|L) zt+e$wrs}QBFG@{j>C2RTb^HIi(iH*cx0+>d^SU-gZ`IV#m-k=Y6*C*??2YqTew~}+ zTicDr+TvOY&N*-0ipDmT58k)2sh;p8W?4ezn+SovxSO{mxvVWrZ#2 ztXl<2FDWnX)vsDub=4%`+j=$Cm+tG)9Wy zFJ?AimoaEK@A0KsLXAh67;K% z!SAT%y&I@DJYN*m?)vr8%Kuw}&L4i-aG!J6maqoiZ|de-nD(42-TLkA#)<{E%(SGP zzSX@I|FV6ddCzs5wpWY|%VWY`>umnA%zxLlZy9fSJ# - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -81,7 +108,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_tooltip_window.html b/docs/html/classkiwi_1_1_tooltip_window.html index 07716fc8..b8f5ff4f 100644 --- a/docs/html/classkiwi_1_1_tooltip_window.html +++ b/docs/html/classkiwi_1_1_tooltip_window.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::TooltipWindow Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -88,14 +115,14 @@  TooltipWindow (juce::Component *parentComponent=nullptr, int m_milliseconds_before_tip_appears=700)  Constructor. More...
  - +  ~TooltipWindow ()  Destructor.
  void setMillisecondsBeforeTipAppears (int new_delay_ms=700) noexcept  Changes the time before the tip appears. More...
  - + void displayTip (juce::Point< int > screen_position, juce::String const &text)  Can be called to manually force a tip to be shown at a particular location.
  @@ -105,7 +132,7 @@ void unsetCustomTooltipClient (CustomTooltipClient &client)  Unset a custom tooltip client. More...
  - + void hideTip ()  Can be called to manually hide the tip if it's showing.
  @@ -114,9 +141,7 @@

A custom TooltipWindow.

This is basically a copy of the juce::TooltipWindow class that adds the possibility to set a custom tooltip client that can be used to overwrite the original "mouse over component" behavior.

See also
juce::TooltipWindow, CustomTooltipClient, juce::SettableTooltipClient

Constructor & Destructor Documentation

- -

◆ TooltipWindow()

- +
@@ -154,9 +179,7 @@

Member Function Documentation

- -

◆ setCustomTooltipClient()

- +
@@ -175,9 +198,7 @@

-

◆ setMillisecondsBeforeTipAppears()

- +

@@ -204,9 +225,7 @@

-

◆ unsetCustomTooltipClient()

- +

@@ -234,7 +253,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_window-members.html b/docs/html/classkiwi_1_1_window-members.html index f043bbec..86a79c66 100644 --- a/docs/html/classkiwi_1_1_window-members.html +++ b/docs/html/classkiwi_1_1_window-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -69,22 +96,23 @@

This is the complete list of members for kiwi::Window, including all inherited members.

- - - - - - - - - - + + + + + + + + + + +
closeButtonPressed() overridekiwi::Windowprotected
getAllCommands(juce::Array< juce::CommandID > &commands) override (defined in kiwi::Window)kiwi::Window
getCommandInfo(const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override (defined in kiwi::Window)kiwi::Window
getNextCommandTarget() override (defined in kiwi::Window)kiwi::Window
isMainWindow() constkiwi::Window
perform(InvocationInfo const &info) override (defined in kiwi::Window)kiwi::Window
restoreWindowState()kiwi::Window
saveWindowState()kiwi::Window
Window(std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)kiwi::Window
~Window()kiwi::Windowvirtual
close()kiwi::Window
closeButtonPressed() overridekiwi::Windowprotected
getAllCommands(juce::Array< juce::CommandID > &commands) override (defined in kiwi::Window)kiwi::Window
getCommandInfo(const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override (defined in kiwi::Window)kiwi::Window
getNextCommandTarget() override (defined in kiwi::Window)kiwi::Window
isMainWindow() const kiwi::Window
perform(InvocationInfo const &info) override (defined in kiwi::Window)kiwi::Window
restoreWindowState()kiwi::Window
saveWindowState()kiwi::Window
Window(std::string const &name, std::unique_ptr< juce::Component > content, bool resizable=false, bool is_main_window=true, juce::String settings_name=juce::String::empty, bool add_menubar=false)kiwi::Window
~Window()kiwi::Windowvirtual
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1_window.html b/docs/html/classkiwi_1_1_window.html index 4d62d2d5..22f682cb 100644 --- a/docs/html/classkiwi_1_1_window.html +++ b/docs/html/classkiwi_1_1_window.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::Window Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -94,31 +121,35 @@ virtual ~Window ()  Window destructor. Called whenever buttonPressed is called. More...
  -bool isMainWindow () const - Return true if window shall be a main window of kiwi. More...
-  +bool isMainWindow () const + Return true if window shall be a main window of kiwi. More...
+  void restoreWindowState ()  Restore the window state. More...
  void saveWindowState ()  Save the window state. More...
  - + +void close () + Close the window.
+  + ApplicationCommandTarget * getNextCommandTarget () override   - + void getAllCommands (juce::Array< juce::CommandID > &commands) override   - + void getCommandInfo (const juce::CommandID commandID, juce::ApplicationCommandInfo &result) override   - + bool perform (InvocationInfo const &info) override   - @@ -126,9 +157,7 @@

Detailed Description

Common interface for all windows held by the application.

Constructor & Destructor Documentation

- -

◆ Window()

- +

Protected Member Functions

+
void closeButtonPressed () override
 Called when close button is pressed. Request instance to close the window.
 
@@ -181,7 +210,7 @@

- +
contentA component that will be owned and displayed by the window
resizablePass true to make a resizable window.
is_main_windowsee isMainWindow()
is_main_windowsee isMainWindow()
settings_nameThe name of the window settings (pass an empty string if you dont want to save the window state)
add_menubarPass true to add the kiwi application menubar to the window
@@ -190,9 +219,7 @@

-

◆ ~Window()

- +
@@ -219,9 +246,7 @@

Member Function Documentation

- -

◆ isMainWindow()

- +
@@ -239,9 +264,7 @@

-

◆ restoreWindowState()

- +

@@ -259,9 +282,7 @@

-

◆ saveWindowState()

- +

@@ -288,7 +309,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_buffer-members.html b/docs/html/classkiwi_1_1dsp_1_1_buffer-members.html index 8fe8dcda..0ded8500 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_buffer-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_buffer-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -74,11 +101,11 @@ Buffer(const size_t nchannels, const size_t nsamples, const sample_t val=0.)kiwi::dsp::Buffer Buffer(Buffer &&other) noexceptkiwi::dsp::Buffer clear()kiwi::dsp::Buffer - empty() const noexceptkiwi::dsp::Buffer - getNumberOfChannels() const noexceptkiwi::dsp::Buffer - getVectorSize() const noexceptkiwi::dsp::Buffer + empty() const noexceptkiwi::dsp::Buffer + getNumberOfChannels() const noexceptkiwi::dsp::Buffer + getVectorSize() const noexceptkiwi::dsp::Buffer operator=(Buffer &&other) noexceptkiwi::dsp::Buffer - operator[](const size_t index) constkiwi::dsp::Buffer + operator[](const size_t index) const kiwi::dsp::Buffer operator[](const size_t index)kiwi::dsp::Buffer setChannels(std::vector< Signal::sPtr > signals)kiwi::dsp::Buffer ~Buffer()kiwi::dsp::Buffer @@ -87,7 +114,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_buffer.html b/docs/html/classkiwi_1_1dsp_1_1_buffer.html index 8a624428..2ef6cd08 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_buffer.html +++ b/docs/html/classkiwi_1_1dsp_1_1_buffer.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Buffer Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -101,23 +128,23 @@ void clear ()  Clears buffers data. The resulting buffer will be empty. More...
  - -size_t getVectorSize () const noexcept - Gets the vector size of the Buffer object.
-  - -size_t getNumberOfChannels () const noexcept - Gets the number of channels of the Buffer object.
-  - -bool empty () const noexcept - Returns true if the Buffer object has no Signal.
-  - -Signal const & operator[] (const size_t index) const - Gets the Signal object for a given channel.
-  - + +size_t getVectorSize () const noexcept + Gets the vector size of the Buffer object.
+  + +size_t getNumberOfChannels () const noexcept + Gets the number of channels of the Buffer object.
+  + +bool empty () const noexcept + Returns true if the Buffer object has no Signal.
+  + +Signal const & operator[] (const size_t index) const + Gets the Signal object for a given channel.
+  + Signal & operator[] (const size_t index)  Gets the Signal object for a given channel.
  @@ -126,9 +153,7 @@

A class that wraps a vector of Signal objects.

The class is a wrapper for a vector of Signal objects that offers optimized operations. It can either own its own memory or share it with the outside.

Constructor & Destructor Documentation

- -

◆ Buffer() [1/4]

- +
@@ -146,9 +171,7 @@

-

◆ Buffer() [2/4]

- +

@@ -172,9 +195,7 @@

-

◆ Buffer() [3/4]

- +

@@ -216,9 +237,7 @@

-

◆ Buffer() [4/4]

- +

@@ -250,9 +269,7 @@

-

◆ ~Buffer()

- +

@@ -271,9 +288,7 @@

Member Function Documentation

- -

◆ clear()

- +
@@ -291,9 +306,7 @@

-

◆ operator=()

- +

@@ -325,9 +338,7 @@

-

◆ setChannels()

- +

@@ -360,7 +371,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_chain-members.html b/docs/html/classkiwi_1_1dsp_1_1_chain-members.html index 4ce00f49..84adae54 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_chain-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_chain-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -73,8 +100,8 @@ Chain()kiwi::dsp::Chain connect(Processor &source, size_t outlet_index, Processor &dest, size_t inlet_index)kiwi::dsp::Chain disconnect(Processor &source, size_t outlet_index, Processor &destination, size_t inlet_index)kiwi::dsp::Chain - getSampleRate() const noexceptkiwi::dsp::Chain - getVectorSize() const noexceptkiwi::dsp::Chain + getSampleRate() const noexceptkiwi::dsp::Chain + getVectorSize() const noexceptkiwi::dsp::Chain prepare(size_t const samplerate, size_t const vectorsize)kiwi::dsp::Chain release()kiwi::dsp::Chain removeProcessor(Processor &proc)kiwi::dsp::Chain @@ -86,7 +113,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_chain.html b/docs/html/classkiwi_1_1dsp_1_1_chain.html index 60fc7a6d..0814d478 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_chain.html +++ b/docs/html/classkiwi_1_1dsp_1_1_chain.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Chain Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -103,12 +130,12 @@ void release ()  Deallocate memory needed to perform tick method. More...
  -size_t getSampleRate () const noexcept - Gets the current sample rate. More...
-  -size_t getVectorSize () const noexcept - Gets the current vector size. More...
-  +size_t getSampleRate () const noexcept + Gets the current sample rate. More...
+  +size_t getVectorSize () const noexcept + Gets the current vector size. More...
+  void addProcessor (std::shared_ptr< Processor > processor)  Adds a processor to the chain. More...
  @@ -129,9 +156,7 @@

An audio rendering class that manages processors in a graph structure.

Updating the chain can be updated by incrementingly adding processors and connecting them. The chain can then be prepared with a certain samplerate and vectorsize making it's tick function ready to be called in a separate thread. The chain is transactional that's to say that changes will not be effective until either prepare or update is called.

Constructor & Destructor Documentation

- -

◆ Chain()

- +
@@ -149,9 +174,7 @@

-

◆ ~Chain()

- +

@@ -170,9 +193,7 @@

Member Function Documentation

- -

◆ addProcessor()

- +
@@ -191,9 +212,7 @@

-

◆ connect()

- +

@@ -234,9 +253,7 @@

-

◆ disconnect()

- +

@@ -277,9 +294,7 @@

-

◆ getSampleRate()

- +

@@ -301,13 +316,11 @@

Gets the current sample rate.

-
See also
getVectorSize
+
See also
getVectorSize
- -

◆ getVectorSize()

- +

@@ -329,13 +342,11 @@

Gets the current vector size.

-
See also
getSampleRate
+
See also
getSampleRate
- -

◆ prepare()

- +

@@ -364,9 +375,7 @@

-

◆ release()

- +

@@ -389,9 +398,7 @@

-

◆ removeProcessor()

- +

@@ -410,9 +417,7 @@

-

◆ tick()

- +

@@ -438,9 +443,7 @@

-

◆ update()

- +

@@ -467,7 +470,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node-members.html b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node-members.html index 4c89c522..5a14a04e 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -83,7 +110,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node.html b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node.html index 02936b05..466c6083 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node.html +++ b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Chain::Node Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -89,13 +116,13 @@ -

Public Types

+
using uPtr = std::unique_ptr< Node >
 
- @@ -111,14 +138,14 @@ -

Public Member Functions

+
 Node (std::shared_ptr< Processor > processor)
 Constructor.
 
void perform () noexcept
 The digital signal processing perform method. More...
 
+
void release ()
 Releases the node disabling performing it.
 
-

Friends

+
class Chain
 
@@ -126,9 +153,7 @@

The Node object wraps and manages a Processor object inside a Chain object.

The node can be connected to other node and enables signal data to go through its pins (inlet, outlet). Node also manages its signal allocation via its prepare and release method.

Member Function Documentation

- -

◆ connectInput()

- +
@@ -163,9 +188,7 @@

-

◆ disconnectInput()

- +

@@ -200,9 +223,7 @@

-

◆ perform()

- +

@@ -228,9 +249,7 @@

-

◆ prepare()

- +

@@ -258,7 +277,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_pin-members.html b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_pin-members.html index 8713b3e0..9e4cb4ab 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_pin-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_pin-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -85,7 +112,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_pin.html b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_pin.html index d258c815..ea7ef365 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_pin.html +++ b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_pin.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Chain::Node::Pin Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -85,7 +112,7 @@  Pin (Pin &&other)  move constructor. More...
  - + virtual ~Pin ()  Destructor.
  @@ -95,38 +122,36 @@ bool disconnect (Pin &other_pin)  Disconnects the nodes. More...
  - + void disconnect ()  Removes all connection from the pin.
  - - - -

Public Attributes

+
Node & m_owner
 
+
const size_t m_index
 
+
Signal::sPtr m_signal
 
+
std::set< Node::Tie > m_ties
 
-

Friends

+
class Node
 

Detailed Description

The pin helds a set of tie that points to other pins.

Constructor & Destructor Documentation

- -

◆ Pin() [1/2]

- +
@@ -161,9 +186,7 @@

-

◆ Pin() [2/2]

- +

@@ -183,9 +206,7 @@

Member Function Documentation

- -

◆ connect()

- +
@@ -204,9 +225,7 @@

-

◆ disconnect()

- +

@@ -234,7 +253,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_tie-members.html b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_tie-members.html index 1394c6b4..e0593675 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_tie-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_tie-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -70,7 +97,7 @@

This is the complete list of members for kiwi::dsp::Chain::Node::Tie, including all inherited members.

- + @@ -79,7 +106,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_tie.html b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_tie.html index 0c3d8728..832813a4 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_tie.html +++ b/docs/html/classkiwi_1_1dsp_1_1_chain_1_1_node_1_1_tie.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::dsp::Chain::Node::Tie Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
m_pin (defined in kiwi::dsp::Chain::Node::Tie)kiwi::dsp::Chain::Node::Tie
operator<(Tie const &other) const noexceptkiwi::dsp::Chain::Node::Tie
operator<(Tie const &other) const noexceptkiwi::dsp::Chain::Node::Tie
Tie(Pin &pin)kiwi::dsp::Chain::Node::Tie
Tie(Tie const &other)=defaultkiwi::dsp::Chain::Node::Tie
~Tie()=default (defined in kiwi::dsp::Chain::Node::Tie)kiwi::dsp::Chain::Node::Tie
- + - - - - + +
@@ -78,22 +105,22 @@ - - - - - + + +

Public Member Functions

+
 Tie (Pin &pin)
 Constructor with the pin that will be referenced.
 
+
 Tie (Tie const &other)=default
 Copy constructor of Tie.
 
-bool operator< (Tie const &other) const noexcept
 Comparison operator. Compares pin and pins' indexes.
 
+bool operator< (Tie const &other) const noexcept
 Comparison operator. Compares pin and pins' indexes.
 
-

Public Attributes

+
Pin & m_pin
 
@@ -108,7 +135,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_error-members.html b/docs/html/classkiwi_1_1dsp_1_1_error-members.html index 3e269869..2ced51c2 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_error-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_error-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -77,7 +104,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_error.html b/docs/html/classkiwi_1_1dsp_1_1_error.html index cc428b84..a0d7e8b7 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_error.html +++ b/docs/html/classkiwi_1_1dsp_1_1_error.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Error Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -92,7 +119,7 @@  Error (const char *message)  The const char* constructor. More...
  - + virtual ~Error () noexcept=default  The destructor.
  @@ -102,9 +129,7 @@

The class defines the std::exception objects that can be trown during of by

DSP objects during the compilation of a Chain object.

Constructor & Destructor Documentation

- -

◆ Error() [1/2]

- +
@@ -136,9 +161,7 @@

-

◆ Error() [2/2]

- +

@@ -178,7 +201,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_i_perform_call_back-members.html b/docs/html/classkiwi_1_1dsp_1_1_i_perform_call_back-members.html index c099d957..8f3ca910 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_i_perform_call_back-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_i_perform_call_back-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -77,7 +104,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_i_perform_call_back.html b/docs/html/classkiwi_1_1dsp_1_1_i_perform_call_back.html index 58599d15..6168b8f6 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_i_perform_call_back.html +++ b/docs/html/classkiwi_1_1dsp_1_1_i_perform_call_back.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::IPerformCallBack Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -86,15 +113,15 @@ - - - @@ -110,7 +137,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_loop_error-members.html b/docs/html/classkiwi_1_1dsp_1_1_loop_error-members.html index 3d7fc1cf..1e7c72af 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_loop_error-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_loop_error-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

Public Member Functions

+
 IPerformCallBack ()=default
 The default contrustor.
 
+
virtual ~IPerformCallBack ()=default
 Destructor.
 
+
virtual void perform (Buffer const &intput, Buffer &output)=0
 pure virtual method that perform input and output buffers.
 
- + - - - - + +
@@ -80,7 +107,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_loop_error.html b/docs/html/classkiwi_1_1dsp_1_1_loop_error.html index 1f0f7b64..414b9ced 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_loop_error.html +++ b/docs/html/classkiwi_1_1dsp_1_1_loop_error.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::LoopError Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -92,18 +119,18 @@  LoopError (const char *message)  The const char* constructor. More...
  - +  ~LoopError () noexcept override=default  The destructor.
  - Public Member Functions inherited from kiwi::dsp::Error  Error (const std::string &message) - The std::string constructor. More...
+ The std::string constructor. More...
   Error (const char *message) - The const char* constructor. More...
+ The const char* constructor. More...
  - + virtual ~Error () noexcept=default  The destructor.
  @@ -112,9 +139,7 @@

An exception to detect loops.

An exception that is thrown whenever a loop is detected in a chain.

Todo:
Add more infos about the detected loop.

Constructor & Destructor Documentation

- -

◆ LoopError() [1/2]

- +
@@ -146,9 +171,7 @@

-

◆ LoopError() [2/2]

- +

@@ -188,7 +211,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_perform_call_back-members.html b/docs/html/classkiwi_1_1dsp_1_1_perform_call_back-members.html index 4907027f..0fb34adf 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_perform_call_back-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_perform_call_back-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -79,7 +106,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_perform_call_back.html b/docs/html/classkiwi_1_1dsp_1_1_perform_call_back.html index 42d2b673..f37826a9 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_perform_call_back.html +++ b/docs/html/classkiwi_1_1dsp_1_1_perform_call_back.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::PerformCallBack< TProc > Class Template Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -79,31 +106,31 @@
- + kiwi::dsp::IPerformCallBack
- - - - - @@ -122,7 +149,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_processor-members.html b/docs/html/classkiwi_1_1dsp_1_1_processor-members.html index 8dfbdd67..4ff29636 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_processor-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_processor-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

Public Member Functions

+
 PerformCallBack (TProc &processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
 Constructor, get a pointer to the processor and its call back to be called later.
 
+
void perform (Buffer const &input, Buffer &output) override final
 Implementation of perform that binds a processor and its method.
 
+
 ~PerformCallBack ()=default
 Destructor. The callback doesn't hold ownership of either the processor or the processor's method therefor the no destruction occurs in destructor.
 
- Public Member Functions inherited from kiwi::dsp::IPerformCallBack
+
 IPerformCallBack ()=default
 The default contrustor.
 
+
virtual ~IPerformCallBack ()=default
 Destructor.
 
- + - - - - + +
@@ -70,18 +97,18 @@

This is the complete list of members for kiwi::dsp::Processor, including all inherited members.

- - + + - +
Chain (defined in kiwi::dsp::Processor)kiwi::dsp::Processorfriend
getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
shouldPerform() const noexceptkiwi::dsp::Processorinline
shouldPerform() const noexceptkiwi::dsp::Processorinline
~Processor()=defaultkiwi::dsp::Processorvirtual
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_processor.html b/docs/html/classkiwi_1_1dsp_1_1_processor.html index 52ed62e6..ca207766 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_processor.html +++ b/docs/html/classkiwi_1_1dsp_1_1_processor.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Processor Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
@@ -83,16 +110,23 @@
-kiwi::engine::AudioObject -kiwi::engine::AudioInterfaceObject -kiwi::engine::DelaySimpleTilde -kiwi::engine::ErrorBox -kiwi::engine::OscTilde -kiwi::engine::PlusTilde -kiwi::engine::SigTilde -kiwi::engine::TimesTilde -kiwi::engine::AdcTilde -kiwi::engine::DacTilde +kiwi::engine::AudioObject +kiwi::engine::AudioInterfaceObject +kiwi::engine::ClipTilde +kiwi::engine::DelaySimpleTilde +kiwi::engine::ErrorBox +kiwi::engine::GateTilde +kiwi::engine::LineTilde +kiwi::engine::MeterTilde +kiwi::engine::NoiseTilde +kiwi::engine::NumberTilde +kiwi::engine::OperatorTilde +kiwi::engine::OscTilde +kiwi::engine::PhasorTilde +kiwi::engine::SahTilde +kiwi::engine::SigTilde +kiwi::engine::SnapshotTilde +kiwi::engine::SwitchTilde
@@ -106,19 +140,19 @@ - - - - - - - - - - + + + + + + + + +
 Processor (const size_t ninputs, const size_t noutputs) noexcept
 The constructor. More...
 
+
virtual ~Processor ()=default
 The destructor.
 
size_t getNumberOfInputs () const noexcept
 Gets the current number of inputs. More...
 
size_t getNumberOfOutputs () const noexcept
 Gets the current number of outputs. More...
 
bool shouldPerform () const noexcept
 Returns true if the processor shall be performed by the chain. More...
 
size_t getNumberOfInputs () const noexcept
 Gets the current number of inputs. More...
 
size_t getNumberOfOutputs () const noexcept
 Gets the current number of outputs. More...
 
bool shouldPerform () const noexcept
 Returns true if the processor shall be performed by the chain. More...
 
@@ -129,7 +163,7 @@

Protected Member Functions

-

Friends

+
class Chain
 
@@ -137,9 +171,7 @@

The pure virtual class that processes digital signal in a Chain object.

The class is pure virtual and allows to implement digital signal processing. You should implement the virtual methods prepare, perform and release.

See also
Buffer and Infos

Constructor & Destructor Documentation

- -

◆ Processor()

- +
@@ -183,9 +215,7 @@

Member Function Documentation

- -

◆ getNumberOfInputs()

- +
@@ -208,13 +238,11 @@

Returns
The number of inputs of the Processor object.
-
See also
getNumberOfOutputs()
+
See also
getNumberOfOutputs()
- -

◆ getNumberOfOutputs()

- +

@@ -237,13 +265,11 @@

Returns
The number of outputs of the Processor object.
-
See also
getNumberOfInputs()
+
See also
getNumberOfInputs()
- -

◆ setPerformCallBack()

- +
@@ -282,9 +308,7 @@

-

◆ shouldPerform()

- +

@@ -318,7 +342,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_processor.png b/docs/html/classkiwi_1_1dsp_1_1_processor.png index f1da1c2f9d7b1b6ecda753a117229630ceb61b2c..91354766a1e962e3b5b043dac9dd3d3196a3e939 100644 GIT binary patch literal 8177 zcmdT}3pmsJ{~xw;IT3}DtcZ$37q?1iC6~hFn(I#2;}TLR_soeTA%$GBO4x*A%q`Q6 z3TSr}?|0w%KKp)N@7L@7dcQvLHr8g# z#1+IL5XdqMa}!$#L%4^z&mCRs2K2Pm5rtSemiE3K zWPu6!;>bp{$2Fp;LIJyp?JLqOjBocyb;vHr9kB*gcI+DLJB@0c#H< zBX`U(Nq((0i{5z$7(*b^5$vEaVlag`l}lEA~Mg0K9KZq`nsSe;B{-m{Tg(0dQ1< zd@5-mFe34ykOOaZZ+SE`p=_r=-E2-!Tn`J!oW>vy*4*gbI z&1!g6&JII99j56rSTr|`Jorn5_Y9*|HmSqbwDSckB*6#9ec-Ux-({%;vV!{|%*J&; zO|gVS?n)Y$BSuuDdo_^yjvCwH~2{N!UJW!4+Zaua_5? zk-dpFTs|PfkY%D7i~o3}UB$dY%N>eMyO*$zQWic3IC3X^9=vAGMD{q?bOq7FAd~Dm zm*smPRpwur{%_OsJ9vMPk-xgRlLVutBy0tQcPm}OHbO$c-*1bx4@S>q>fH%_HZnXu zs(poISHG{fO?CFXFGW*2k0UWNiVyB=Hd{_sM2azzrpDo=gW{`{_stgA9u{uxpody{ zUG0g5ITEl&YG?(`X-fD^f$9Sz-Ce=xd>fTQG2 zmaN}IZ67_cE8dKTC{4=C&RF_fUUy;XmqQ755!=351~s(31km7`lF=TK3&bG`8Y0}V zf1&gIo#gx%=+(IhN+(NDI&R5-p}s0#)z{k8zc)9oy-{o_n{+!erPLV}y)BqW2+vqY ziMoTzclIHS1wVP2yVc#yCN+hZ(KGSEJMwPai)8u;#RGsh7qnjy(v-)D7-||%p?btS`b6_nKe!?GKA%nNvp`J&Q##>m_s-Cio%$^H^6-%7d^;J)& zuQ{#m$<7dU5mT6D*&+HWiP9bKblfY-{isT3u~&T7ih9GRLlNwGE^qH^SGTBbOi5ZI z=RSHij9ed>HapTf9$;S~r8J!qM&5NZ$>p8jboa(tjIZJH>xQC-*T$hUSNgp%7*}Z5 zBEAf-#kM3CR(n+)>xq_}#ZcZQVy2>}lc|bu6?4}1jpL>)p@MT>XKiSY~J4EGlLF zV=j4X$WJgshr-K`w{L+(;rZxxn>ZmD4GW z;lkw1hBl?V9!c{Ak+eQBM3GZi)@YC;9AC8&+G=MXwE>-}PEC6m-1qivc5Fc;fg02J zfuf}IOnG=U0+$|gbkv3`3p%WD(bas8GB^-FmTnuN`U6D;s}SOZaPJCY3N`djdm})P zRsI(&`rEYtdP8247Amne^5K+)Zw1!q zecyLYR8O-wQ7@>%y+3q)L=DD@BYF1G^h24gq?}hDZ)51ixTH%MJH*raD0RV;8P#umW_M%>tYnBi*I5a;y<04F}5tA>vsR6X8qhCKNlo zg3n-YpD$Y~6I-9Q$8~uxF@Ly=css>c!_)0}cZq$}`=>Ch#~`*d zkF&-knL*l3Nwbei0IJ)d?Q6jz{J1Q@B(>Cv3tEyCXh}{I!lDrQ@2viRk!zrUKq>hP zgHk$!!1*J9c@s2(MXrU{U|gr^ruIoYR!NWW$aV-Y}<}%HH&f)9<{qmki{#wi@BKQ zZpurN$6Nf8TKl}=b<=^zm1rd~D!q`CEV@g+gUK91$9~X8v=2vPW=$z^bq5x?285GE zpjSpZBI1B>O2XfP{}@B~c6C=2SKN&959p5J#bEATt~~MP+?@ryM*Y0wM%!*+0^&o= zS!PD=$&3@Xe5`SNYbe&^eRX3V#{gg^d&}DrN8IvyH@x= z9WvM@xjXU-RS~!tWcWb+&b3-~0jm({FjmvK`X!l)>^a`$ncH(*l<;`RKu1%0X)p_m zj;(OiD7-b*jh6e<%7oHRI8IqKxsc0VRP5z=BC_gqH@j|+$Y48!!X;cnsdM7EUroqX zw7cDJ;i3w$S=Ku#je#_sK6{&5G-GwCOdzqBxuqW~*M(}4eL!y|se3-UQ4H1BR&q#Y zB!$l^;eAbqH2ny3V}l+7{7NKTaGqK3su78<++e10@V3S{rQpMeK9}|?#y%rwfS(q7 z0|m7K4TyKf*p_<&XywL|SrrQE+tOY1`Al_zMi~k;N>g+l#BBqZHUG*aelv>xEtgx0 z7G@$bNEE3VhOLMFpzG5w(SEJx)*LeYcs#JSI zOm`>kUbsq0EAzE?t>#)$swO7%0F;h5%*^3NV~$kasJ>}f`S4`aF4P{@^+i`|4_xWs zN`Jz1xwto>EC&-|Xml7{CiTQn{mOk^*Jw+*zVklzQVBXK;sjf;rnfDuEM?1}lKR;L z`EAtgojSx5IEGYsnZTI(AHWgKfQU4(V)Hn)fPY9gKXV-M;6Ipu+JEvd@@D%S;ls4y zc1fd1kO1&BP+~;&LNQaaDuO$elNYV(-pdSuuP!rwG;4U+`&;w{{Uk8w{0Ci z=Z7{Fh`ZohoTl4y(;7G(!*mJ8^D#BTjY{{~ro9{+MAmWL5NhW$N4Ko@97^iTR*#_i z42F<2UbcfdAP`N*K@mh>za3)yC~oPZY$gc0on0OM3E*DExbaH7%XAgm9zKN)BUg&# z5US{dWYktONbik1H626n7uPBpKR!7F%xOHzm+wLqUQg} z&#AB8*tlo6<$UI6UEl1vr^}=RcY;uArukT91E{_B zDQ@gE9*nb8k5hG$z$$&J{?6p2<8!Yh?&?IR&B=?89E17FboP6{{G>JH+jB0A{H88# znO}TqF2U8Dl`Kk?P`DPU?ipA{b8alrm2XW#Q!m;}h1|f*b0eeHrwfLA;8FDi9@UkP z+eDRPV}RODR|8_k35fZ4?6?v&e1m|MDzRgypjOVV=L)g)nR=C(^YbGLW+f*Y3-tHygM`0|ibk2r03Bjqv(PT$x8(zM(`TGx)G&I#xv+j z;^;j7K0!{uF?Zy&bYAGqjkHt-Q3io?I$x%XtsMi7wjoU9<9Rs#8S zsT_1UL<>aZ|JQ)?KccdOl!fpQ3c|kuw0$r7YnK0~r}qEdpPrhTWqHLBqoU&Kg^!I* z)!@REhmG%91??lYoGc#s6)IHJXMx~ud&GN6af9tUZqB!t1TKe~9T%T~SL^J#!&xD% zQ{*g`nZ(0GI}1#i%iV-s5zX!-SzD-PwOfcY?!$Y$=euo5#xl-rU7eNz@ z2@cWnJeR-_Syap@uK@1zj^5y`d1qKL8{+ zKjdToq>wasU4aX?=4VerAysj4Hr)F) z^R5B@lrRK$q<51o1Xd^4)$QT(O;{njA<;R^Aj9@5F8`X!9|4==fCzr zB);kh?X3g((0biymJ;51;0z2*d&b`0+ z%~f~TBOu*Px>{OVAlMIwJhZfQAb{TV<#OO1%M2O^em1)QcpR!wC;;{2xH#s<%bS3v zdYYP=w6FFV1I;flc({6M0Y*ycdVSnNOG_^ScF6H~{4zm*Z)_EF{TCf!-(MCgTIUt- zSNcS|!&Ykn zrYhwaWVxxZPlM^koCCkano$f7|Rxtq3BEW#oCAH zp*23)7f`|WVg>x``%XhMil zhCX2S`CB2b*B9$}Hi&xBG@L}V^G1mpuUOYPse{3uamkfvgBtM5v;m0-NBq+fkme`q zw)Ue&R+xGU6-DYn^|9HiDY<|5KeoTxj-wLgwB6nBH7;5A2n{!>K2FQu+Ya^4 z{Hz)Kbi|q8`2Rzve*=RYhzn~*AYoa$aM!33@Pvg4J-w;#Z_c)F!xB%BkA5ITV;VV}EW^w+ht2X&<=_PGrR@3< zu`oaTwe}iPR+^B3Wo)oi)#TunPQ&+&&vjnW;|sh4Zi0nN{(;pg3@mt^t%_PHLqZG^>DvhGtrr*-jE}qu zqBIzJ+BK;!s%H`ws`eY`k`KfQ&Dri}2cwKnM5|*T=u!fwH5zf%8{!aL%WOqTe`yU> z)k5<#HUkSzC{*WJ>C>gc_`SRf%`WU_|=p=SQ;3^;evySPhqaGKp zhaRiY-lO{*NCPR*-19eX4z{ne`doG8P#2b^U9sx@_*eQDDXn+Fn3w3CV4xfea6hf` zIgUHq9AK_X@ya@gTkzSl3-4PZ#uMqzI3RSeD($w_@h_*!1qck^7dM2QB-(unOlp3Yd12{n9uo& zNEu`mR(K>U%tm;(H?QckS#0;aJ@!}q29g^iDnCV zJ7G9Oe>=}^Qo!-fYtdHh+JjI%{aRP6>IgTSsT*5T#ry%c-H&_cl|qQ1ZQnZMYD|GZ zaKk%Aa!Fx`_f8E7kWar+5?4nBF6V)_o44kF||JxWN3JjRvQlpT9Z z#oq$E&5a*w@04USBi4PKeRV-BOhOnOqC&P}tSzw)cXMQ)pPx^kR1A6GZVgC4`v984Zi<5lYfa+5z zIcX%e>=C~5j8}`H0@xMRL|79E=gfD8%h%bE=88=dfw4xfJB8HER2GMfncySq4f$^A z@c6T!YBxqd-OL-g#;_gz&O%6H5KBz!tlr;do-Cw@`ux3;aMe%p{1n1Kv|n10RZH8$p1 z{ptC7NU60ip%pun$lt@ub+xx-yc)c5xY5|6dT)*Gs}%vs`(}8|lf@K6d}ZHxWF;Lb znX7a30H3drRq^*G z&{4SI=OjpQSvWE;q>wWQ$48#LB^=1&rILLp0j=1F!iIBowrqw1xw*~*(RYk%0zs_E zwQoBjz|BVNkg-Qk_R&ydhvK^Dkcic%W`AMUH9ixWVD1dEP@**N`iRZw!K$R+-DHrw8AIgS!No((%CCL+$b9dt{>XK?CfgF(yv`)#Tv-a zP(3(pzo{@5QEKT+pkq&U8yY<&a`qoE5x}YLb7yot17kFoH;^QkDk-=w-bzMqki^um+4z9lU;wASZJ=KdUlsPsNtA`PK! z^76}MJzd#bGoP$E4KtUBqs-i5lZH8JC{t>L%O5fP zCGPZx{?Y&COz5!z4kBY0Vu+MDP)!%-;G3VZv?fRGtRe#=>Ub|4BcX8Pk&#F zJf@`RlhqUF2(anL#BURm->~=_l;^{Uz>@f;_RP}%;RF-`lPnzkWmz1Fm+2%z_r`2Q z_f@RELd9GO;^!7ql6s!^+y&<+T0+=6Mm?G%$E@|07YuEOu{=p)*fYKxzq_{=PMto- zzP}-3zCAZ)@7YRIn7tT)VUNyzUz_=Qo2ybIg}p@(^AS_cCXV0n{;Klq?O-I6h`DeY zhaRp3koHM5f>{tOC{SMf21CkN{t7v|!(R_zn~gYwbRKSaTS*9Q3)Iho7uE3&sw890 z?JpjY{pUUm#eKvY*L07BnVp-d2F^?Kq}`C`p2};W{z7TeyRlMHE}7*`csJZ}Z3Fd9 zZj8hv-48bXbOj`sT!09XWoTUXclj$IHQk1LBb7t z-aycHLFM!N?oZkv<(gi}Wb(HF3cOu^`zMf|ijhWWwpt7lhyxTE?^A-C4XL5vZEslQ)(wi) Lx*jS&7?}DW2i~o> diff --git a/docs/html/classkiwi_1_1dsp_1_1_signal-members.html b/docs/html/classkiwi_1_1dsp_1_1_signal-members.html index 7731361c..749777c5 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_signal-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_signal-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -72,16 +99,16 @@ add(Signal const &other_signal) noexceptkiwi::dsp::Signal add(Signal const &signal_1, Signal const &signal_2, Signal &result)kiwi::dsp::Signalstatic copy(Signal const &other_signal) noexceptkiwi::dsp::Signal - data() const noexceptkiwi::dsp::Signal + data() const noexceptkiwi::dsp::Signal data() noexceptkiwi::dsp::Signal fill(sample_t const &value) noexceptkiwi::dsp::Signal operator=(Signal &&other) noexceptkiwi::dsp::Signal - operator[](const size_t index) constkiwi::dsp::Signal + operator[](const size_t index) const kiwi::dsp::Signal operator[](const size_t index)kiwi::dsp::Signal scPtr typedef (defined in kiwi::dsp::Signal)kiwi::dsp::Signal Signal(const size_t size, const sample_t val=sample_t(0.))kiwi::dsp::Signal Signal(Signal &&other) noexceptkiwi::dsp::Signal - size() const noexceptkiwi::dsp::Signal + size() const noexceptkiwi::dsp::Signal sPtr typedef (defined in kiwi::dsp::Signal)kiwi::dsp::Signal uPtr typedef (defined in kiwi::dsp::Signal)kiwi::dsp::Signal ~Signal()kiwi::dsp::Signal @@ -90,7 +117,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_signal.html b/docs/html/classkiwi_1_1dsp_1_1_signal.html index 3ac5ad0f..ca5eb025 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_signal.html +++ b/docs/html/classkiwi_1_1dsp_1_1_signal.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Signal Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -79,19 +106,19 @@ - - -

Public Types

+
typedef std::shared_ptr< Signal > sPtr
 
+
typedef std::shared_ptr< const Signal > scPtr
 
+
typedef std::unique_ptr< Signal > uPtr
 
- + @@ -103,39 +130,39 @@ - - - - - - - + + + + + + - - - + + + - -

Public Member Functions

 Signal (const size_t size, const sample_t val=sample_t(0.))
 Signal (const size_t size, const sample_t val=sample_t(0.))
 Constructs and fill a Signal object. More...
 
 Signal (Signal &&other) noexcept
 ~Signal ()
 The destructor. More...
 
-size_t size () const noexcept
 Gets the number of samples that the Signal object currently holds.
 
-sample_t const * data () const noexcept
 Returns a read pointer to the samples data.
 
+
+size_t size () const noexcept
 Gets the number of samples that the Signal object currently holds.
 
+sample_t const * data () const noexcept
 Returns a read pointer to the samples data.
 
sample_t * data () noexcept
 Returns a write pointer to the samples data.
 
sample_t const & operator[] (const size_t index) const
 Gets a read sample_t for a given index. More...
 
sample_t const & operator[] (const size_t index) const
 Gets a read sample_t for a given index. More...
 
sample_t & operator[] (const size_t index)
 Gets a write sample_t for a given index. More...
 
void fill (sample_t const &value) noexcept
 Fill this Signal with a new value. More...
 
+
void copy (Signal const &other_signal) noexcept
 Copies the samples of another signal into it.
 
+
void add (Signal const &other_signal) noexcept
 Adds a Signal to this one.
 
- @@ -144,9 +171,7 @@

A class that wraps a vector of sample_t.

The class is a wrapper for a vector of sample_t values that offers optimized operations. The class also offers static methods to perform these operations with other Signal objects.

Constructor & Destructor Documentation

- -

◆ Signal() [1/2]

- +

Static Public Member Functions

+
static void add (Signal const &signal_1, Signal const &signal_2, Signal &result)
 Adds two Signal together and returns the resulting Signal.
 
@@ -181,9 +206,7 @@

-

◆ Signal() [2/2]

- +

@@ -215,9 +238,7 @@

-

◆ ~Signal()

- +

@@ -236,9 +257,7 @@

Member Function Documentation

- -

◆ fill()

- +
@@ -270,9 +289,7 @@

-

◆ operator=()

- +

@@ -304,14 +321,12 @@

-

◆ operator[]() [1/2]

- +

- + @@ -330,9 +345,7 @@

-

◆ operator[]() [2/2]

- +

sample_t const & kiwi::dsp::Signal::operator[] sample_t const & kiwi::dsp::Signal::operator[] ( const size_t  index)
@@ -365,7 +378,7 @@

Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_timer-members.html b/docs/html/classkiwi_1_1dsp_1_1_timer-members.html index 19a2a8b8..b237d64b 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_timer-members.html +++ b/docs/html/classkiwi_1_1dsp_1_1_timer-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

- + - - - - + +
@@ -84,7 +111,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1dsp_1_1_timer.html b/docs/html/classkiwi_1_1dsp_1_1_timer.html index e494ee03..830ad9ad 100644 --- a/docs/html/classkiwi_1_1dsp_1_1_timer.html +++ b/docs/html/classkiwi_1_1dsp_1_1_timer.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Timer Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
- + - - - - + +
@@ -78,47 +105,47 @@ - - - - - -

Public Types

+
typedef std::chrono::nanoseconds nanoseconds
 The nanosecond precision.
 
+
typedef std::chrono::microseconds microseconds
 The microseconds precision.
 
+
typedef std::chrono::milliseconds milliseconds
 The milliseconds precision.
 
+
typedef std::chrono::seconds seconds
 The seconds precision.
 
+
typedef std::chrono::minutes minutes
 The minutes precision.
 
+
typedef std::chrono::hours hours
 The hours precision.
 
- - - - @@ -135,7 +162,7 @@
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1engine_1_1_adc_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_adc_tilde-members.html index 4ef80248..d1e8b972 100644 --- a/docs/html/classkiwi_1_1engine_1_1_adc_tilde-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_adc_tilde-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

Public Member Functions

+
 Timer ()=default
 The constructor.
 
+
 ~Timer ()
 The destrcutor.
 
+
template<typename TDur >
double get (const bool reset) noexcept
 Gets the ellapsed time.
 
+
void start () noexcept
 Starts the timer.
 
- + - - - - + +
@@ -69,40 +96,53 @@

This is the complete list of members for kiwi::engine::AdcTilde, including all inherited members.

- + - + - - - - + + + + + + + + + + - + - + + + - + - + - + - + + + + + - - + + - - + + +
AdcTilde(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::AdcTilde)kiwi::engine::AdcTilde
AdcTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::AdcTilde)kiwi::engine::AdcTilde
addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
AudioInterfaceObject(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
AudioInterfaceObject(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
error(std::string const &text) constkiwi::engine::Objectprotected
getBeacon(std::string const &name) constkiwi::engine::Objectprotected
getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::AdcTilde)kiwi::engine::AdcTildestatic
declare() (defined in kiwi::engine::AdcTilde)kiwi::engine::AdcTildestatic
defer(std::function< void()> call_back)kiwi::engine::Objectprotected
deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
error(std::string const &text) const kiwi::engine::Objectprotected
getBeacon(std::string const &name) const kiwi::engine::Objectprotected
getMainScheduler() const kiwi::engine::Objectprotected
getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
getScheduler() const kiwi::engine::Objectprotected
loadbang()kiwi::engine::Objectinlinevirtual
log(std::string const &text) constkiwi::engine::Objectprotected
log(std::string const &text) const kiwi::engine::Objectprotected
m_audio_controler (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
m_router (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
m_routes (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
parseArgs(std::vector< Atom > const &args) const (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
parseArgs(std::vector< tool::Atom > const &args) const (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::AdcTilde)kiwi::engine::AdcTilde
post(std::string const &text) constkiwi::engine::Objectprotected
post(std::string const &text) const kiwi::engine::Objectprotected
prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::AdcTildevirtual
Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
receive(size_t index, std::vector< Atom > const &args) override finalkiwi::engine::AudioInterfaceObjectvirtual
receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::AudioInterfaceObjectvirtual
removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
shouldPerform() const noexceptkiwi::dsp::Processorinline
warning(std::string const &text) constkiwi::engine::Objectprotected
shouldPerform() const noexceptkiwi::dsp::Processorinline
warning(std::string const &text) const kiwi::engine::Objectprotected
~AudioInterfaceObject()=default (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectvirtual
~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
~Object() noexceptkiwi::engine::Objectvirtual
~Processor()=defaultkiwi::dsp::Processorvirtual
~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
~Object() noexceptkiwi::engine::Objectvirtual
~Processor()=defaultkiwi::dsp::Processorvirtual
Generated by   doxygen - 1.8.13 + 1.8.11
diff --git a/docs/html/classkiwi_1_1engine_1_1_adc_tilde.html b/docs/html/classkiwi_1_1engine_1_1_adc_tilde.html index d65674bd..0396b840 100644 --- a/docs/html/classkiwi_1_1engine_1_1_adc_tilde.html +++ b/docs/html/classkiwi_1_1engine_1_1_adc_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::AdcTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
Public Member Functions | +Static Public Member Functions | List of all members
kiwi::engine::AdcTilde Class Reference
@@ -75,123 +103,165 @@
-kiwi::engine::AudioInterfaceObject -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor +kiwi::engine::AudioInterfaceObject +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener
- - - + + - - - - - - - + + + + + + + - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + + +

Public Member Functions

- AdcTilde (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
 
+
+ AdcTilde (model::Object const &model, Patcher &patcher)
 
void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
 
void prepare (dsp::Processor::PrepareInfo const &infos) override final
 Prepares everything for the perform method. More...
 
- Public Member Functions inherited from kiwi::engine::AudioInterfaceObject
- AudioInterfaceObject (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
 
void receive (size_t index, std::vector< Atom > const &args) override final
 Receives a set of arguments via an inlet. More...
 
-std::vector< size_t > parseArgs (std::vector< Atom > const &args) const
 
+ AudioInterfaceObject (model::Object const &model, Patcher &patcher)
 
void receive (size_t index, std::vector< tool::Atom > const &args) override final
 Receives a set of arguments via an inlet. More...
 
+std::vector< size_t > parseArgs (std::vector< tool::Atom > const &args) const
 
- Public Member Functions inherited from kiwi::engine::AudioObject
+
 AudioObject (model::Object const &model, Patcher &patcher) noexcept
 Constructor.
 
+
virtual ~AudioObject ()=default
 Destructor.
 
- Public Member Functions inherited from kiwi::engine::Object
+
 Object (model::Object const &model, Patcher &patcher) noexcept
 Constructor.
 
+
virtual ~Object () noexcept
 Destructor.
 
+
virtual void loadbang ()
 Called when the Patcher is loaded.
 
+
void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
 
+
void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
 
+void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
 Called when a parameter has changed.
 
+void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
 Called when an attribute has changed.
 
- Public Member Functions inherited from kiwi::dsp::Processor
 Processor (const size_t ninputs, const size_t noutputs) noexcept
 The constructor. More...
 The constructor. More...
 
+
virtual ~Processor ()=default
 The destructor.
 
size_t getNumberOfInputs () const noexcept
 Gets the current number of inputs. More...
 
size_t getNumberOfOutputs () const noexcept
 Gets the current number of outputs. More...
 
bool shouldPerform () const noexcept
 Returns true if the processor shall be performed by the chain. More...
 
size_t getNumberOfInputs () const noexcept
 Gets the current number of inputs. More...
 
size_t getNumberOfOutputs () const noexcept
 Gets the current number of outputs. More...
 
bool shouldPerform () const noexcept
 Returns true if the processor shall be performed by the chain. More...
 
+ + + + +

+Static Public Member Functions

+static void declare ()
 
+static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
 
- - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - + +

Additional Inherited Members

- Protected Member Functions inherited from kiwi::engine::Object
-void log (std::string const &text) const
 post a log message in the Console.
 
-void post (std::string const &text) const
 post a message in the Console.
 
-void warning (std::string const &text) const
 post a warning message in the Console.
 
-void error (std::string const &text) const
 post an error message in the Console.
 
-Beacon & getBeacon (std::string const &name) const
 Gets or creates a Beacon with a given name.
 
void send (const size_t index, std::vector< Atom > const &args)
 Sends a vector of Atom via an outlet. More...
 
+void log (std::string const &text) const
 post a log message in the Console.
 
+void post (std::string const &text) const
 post a message in the Console.
 
+void warning (std::string const &text) const
 post a warning message in the Console.
 
+void error (std::string const &text) const
 post an error message in the Console.
 
+tool::Scheduler & getScheduler () const
 Returns the engine's scheduler.
 
+tool::Scheduler & getMainScheduler () const
 Returns the main scheduler.
 
void defer (std::function< void()> call_back)
 Defers a task on the engine thread. More...
 
void deferMain (std::function< void()> call_back)
 Defers a task on the main thread. More...
 
void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the engine thread. More...
 
void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
 Schedules a task on the main thread. More...
 
+tool::Beacon & getBeacon (std::string const &name) const
 Gets or creates a Beacon with a given name.
 
void send (const size_t index, std::vector< tool::Atom > const &args)
 Sends a vector of Atom via an outlet. More...
 
void setAttribute (std::string const &name, tool::Parameter const &parameter)
 Changes one of the data model's attributes. More...
 
void setParameter (std::string const &name, tool::Parameter const &parameter)
 Changes one of the data model's parameter. More...
 
- Protected Member Functions inherited from kiwi::dsp::Processor
template<class TProc >
void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
 Constructs a callback that will bind a processor and its perform method. More...
 Constructs a callback that will bind a processor and its perform method. More...
 
- Protected Attributes inherited from kiwi::engine::AudioInterfaceObject
-Router m_router
 
+
engine::AudioControler & m_audio_controler
 
+std::vector< size_t > m_routes
 

Member Function Documentation

- -

◆ prepare()

- +
@@ -227,15 +297,15 @@

KiwiEngine_Objects.h -
  • Modules/KiwiEngine/KiwiEngine_Objects.cpp
    • +
  • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_AdcTilde.h
    • +
  • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_AdcTilde.cpp
    • Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_adc_tilde.png b/docs/html/classkiwi_1_1engine_1_1_adc_tilde.png index 0c390238fb80fd231ae03b3691abf4fb365edcea..0a78681b77eaf412ccef9deb57808e32c718c26b 100644 GIT binary patch literal 2433 zcmcJRc~BE+8pazX0|szF6Lo_QD57#Gh&U=kbONR%D?-d+Bpk}PAcDZKfq*d_wmTq- z!jRz-Qi?p9I$u~u!>bk*3-h# zdperva7GJ>K>`4vMX)^5uSAf5_{*lD-V1 zBh^gG4jr$*tiD|c4c7sR&J?pYk>b2BuZMq*NLx-c!%vnFHeK=}Yz?fA@m9B5T-=YggPJo#&!#$oK9|7t`w39CTT&X~*;Hjzoi!kYJ>- zDv#X!BgFdB_$s4!@zU!^weceeDws%Z7Yd?M^!CQwVz5$&?d6O?dd7}=UyDA<)3OWL zT%ovIHGkDYt+YU~+sICCK+>)wtP)#m_2BNYs$?KT|s|G7g z&-*@g?(R|EjW{O?DCL^;ZlC{~{ba`SyfRRa>Nr!RFL;wYB0ah|3Q`_Q)fFvWMBmv& zsPS;isiP=q#c4tGBr+?hKY%D4LIbRX{x)C^76kdP0fv!Rx`W`f+~q)wn^&SXg9>ba>3S6N_?X(sj3uojNo*ue;W z-&_*=5Z!)fX$ZCOHo3##z_B*p&Vnc|+-DzLakfdph=giya_cPH5{Jk1O6|39Lw5I2 z3sGR=YfUAO8c=5OfJW?zku<(8m(xS3j zZP)#4rE0r0SS4!t8T|)w0w!G!xwX{0In!cI!kbK+$z+F+tKY2H!|&FFqQyX8Q-eZJ zB-GCB&sP|aBJ%mKqNmc_%(-Zp1}XH1H%ob}yWt1MhCv4$S9f&;iP>H*VT8F$jqHw^ zE8XHGdg~i!O*6K)!$YTq{C5lW_c1m;!_Y94k1fQ++5Sg{9_Tz0n2pQUk7#u<|IO8h zXr!)h{y8eUCz)7aOT^aULKW40i2sXU&h#y;;DKjf!Odic3r3^thPw@*k0VQYCkb(PdsK#p0m=I#NP@O#8-!?#_W)G%Ci4K`oWYRQ{5; zP@MKIwV?{yd@?4Co?UeoDOAT)$a{<)F;^@W)1VQAkzILxnkej$IP~YVr~Aon4JV!a zd0YjSdy~zBIu4aw@jO+Z0H!(%v}c~Z#ExY_9%$aFWs7So_EPVrT*(b)(i20LrtTKu zGtY@_IguGV6eJwiY))!G3r%?Eo2@Sh<;LW|r@~kzt@S4^<=X+=z^Q&GSjaHddn$>0P7nA&G85 zyOmOh4`oqFznUSrx1&Ih-ihjl+m{UCxSGCH3=J7wl65vt@c2R}ru?S!ecwGrhrG;2 zEyb)gn=`IcC(jkMO_x>FvcEK@wXrrASO?ZR`Oi!^-rVGzS@6V3l;$*wI_CLg+>gMH zT@}dEggajp9ki2sa0_!3xzZXeg1YpBL}`m8^<4d{HCL%t?eDm52L3w_&$$p^w&Vkc zahmvxINhLgN8C^F%b#F>+W zkuNP)7rR!3*`9n!WbGsHsdOIB@QA+t$L`(Yz;rNT>sw}A&Ij;YKU)6F<*<2ltNreMwP8D1|eROJ-_8MAT_a1)0o^H8eO$We=} zb;WV;gF%YthD9_<``gQ(Qe>PrQ8k4DmUWaWxhgGWODake{$BzJc!$$PHkZLa0D?0$ A(*OVf literal 1982 zcmcJQYfw|y8isd-4U~wn8l`|Baug3i#3Bf-MBI%u1PGU0zycv!h6)I=DFo#b@kFr$ zUZ6zgj z%@$?fjop0wqjMWt*uD-UcKi5iHHhI1Ir-=}mDs{fZ*$AMo7u?A(rlH>)GKuG{!dqn zm@Hj`aCcPyWLqE-I2WwPYfWh@mnqL9&u8rQ;pJIFjUQM^iXQEH&ApsBz@|Dg**~0K z4Tg(BL_loju{<$rdd$|XHFbk@mDq%Xz-y|gl=#W{}9~R+=2&iE=eZWnhc( zfSy|(K1SR4S7=JRMr-#5YHhs#`yHi=g%ykCevF!4DGMIN7A9-&5IBwzynN}_lEocr ziFg*-c|x1z;KTDq3g;>Z_6IVM_LqK(ZG48lnFPsomLPqmyM4JM}RMPdTP(ue2Y<2+!?C3WT<(cz&j zh}vGhB&v@Z!@RWf(Ua=+9jA~_E)d^eovt*WauV1)^>|nBIp?f z#KcwG?cKX(ETzDuwWp*CH8yyr;YIS(Fl>M7jH;y80OGIq6;E+-((`P5x6vFp{ip^x zz*#0h)4HWoa=}$mdL4Vav}QK$M4zlv9T&fa%Y)KBI1yDbM~`rN-4-Hy9Gl?kSux@K z^1Oywb*sf5r$+YF%#V~2zf`=S_U`1g-=}9=x%AGT3P{gcm33|#7;mXSb2GZ|{Y$mnTD}MbD#7uL2mBaIOcST|E%;h7&Q~xXs`94Bf_}oBs9Sm%7|&gx(`VoP2uV(7w2%+J@S{)zH%uCM*n!q2 zsqwlc!J_8C{1!;T2goJD6yGInoYX4}x@62@aHO{9R6bC+y!H0Y6$TUAPBa-RNZh=y z{NE!k;=G>DpZCUJg}WXWv|MceSozR&$bs!_G8Dbq9FK-&s7L-y;A|$|P`63svbjl` n`#-WVkqNO>JQXmMGmmrmrL^xJm)DDawgAOD;7G+s#{|CtDoJP6 diff --git a/docs/html/classkiwi_1_1engine_1_1_audio_controler-members.html b/docs/html/classkiwi_1_1engine_1_1_audio_controler-members.html index a7a10927..d5aa3d79 100644 --- a/docs/html/classkiwi_1_1engine_1_1_audio_controler-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_audio_controler-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    - + - - - - + +
    @@ -73,7 +100,7 @@ addToChannel(size_t const channel, dsp::Signal const &output_signal)=0kiwi::engine::AudioControlerpure virtual AudioControler()=defaultkiwi::engine::AudioControler getFromChannel(size_t const channel, dsp::Signal &input_signal)=0kiwi::engine::AudioControlerpure virtual - isAudioOn() const =0kiwi::engine::AudioControlerpure virtual + isAudioOn() const =0kiwi::engine::AudioControlerpure virtual remove(dsp::Chain &chain)=0kiwi::engine::AudioControlerpure virtual startAudio()=0kiwi::engine::AudioControlerpure virtual stopAudio()=0kiwi::engine::AudioControlerpure virtual @@ -83,7 +110,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_audio_controler.html b/docs/html/classkiwi_1_1engine_1_1_audio_controler.html index 3ec9caea..ed961884 100644 --- a/docs/html/classkiwi_1_1engine_1_1_audio_controler.html +++ b/docs/html/classkiwi_1_1engine_1_1_audio_controler.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::AudioControler Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -86,39 +113,39 @@ - - - - - - - - + + + - - - @@ -134,7 +161,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_audio_interface_object-members.html b/docs/html/classkiwi_1_1engine_1_1_audio_interface_object-members.html index bc72de5f..aea62f21 100644 --- a/docs/html/classkiwi_1_1engine_1_1_audio_interface_object-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_audio_interface_object-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    Public Member Functions

    +
     AudioControler ()=default
     the default constructor
     
    +
    virtual ~AudioControler ()=default
     The destuctor.
     
    +
    virtual void startAudio ()=0
     Starts the audio thread.
     
    +
    virtual void stopAudio ()=0
     Stops the audio thread.
     
    -virtual bool isAudioOn () const =0
     Returns true if the audio is on.
     
    +
    +virtual bool isAudioOn () const =0
     Returns true if the audio is on.
     
    virtual void add (dsp::Chain &chain)=0
     Adds a chain to be ticked by the audio thread.
     
    +
    virtual void remove (dsp::Chain &chain)=0
     Removes a chain from the ticked chains list.
     
    +
    virtual void addToChannel (size_t const channel, dsp::Signal const &output_signal)=0
     Adds a signal to the output_buffer of the AudioControler.
     
    +
    virtual void getFromChannel (size_t const channel, dsp::Signal &input_signal)=0
     Gets a signal from one of the input channels of the AudioControler.
     
    - + - - - - + +
    @@ -70,36 +97,47 @@

    This is the complete list of members for kiwi::engine::AudioInterfaceObject, including all inherited members.

    - + - - - - + + + + + + + + - + - + + + - - + + - + - + + + + + - - + + - - + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioInterfaceObject(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
    AudioInterfaceObject(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_audio_controler (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
    m_router (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
    m_routes (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    parseArgs(std::vector< Atom > const &args) const (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
    post(std::string const &text) constkiwi::engine::Objectprotected
    parseArgs(std::vector< tool::Atom > const &args) const (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
    post(std::string const &text) const kiwi::engine::Objectprotected
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args) override finalkiwi::engine::AudioInterfaceObjectvirtual
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::AudioInterfaceObjectvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) constkiwi::engine::Objectprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioInterfaceObject()=default (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectvirtual
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_audio_interface_object.html b/docs/html/classkiwi_1_1engine_1_1_audio_interface_object.html index 7fe8fb2c..c2c25011 100644 --- a/docs/html/classkiwi_1_1engine_1_1_audio_interface_object.html +++ b/docs/html/classkiwi_1_1engine_1_1_audio_interface_object.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::AudioInterfaceObject Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -76,116 +103,149 @@
    -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor -kiwi::engine::AdcTilde -kiwi::engine::DacTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener +kiwi::engine::AdcTilde +kiwi::engine::DacTilde
    - - - - - - - + + + + + + + - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + +

    Public Member Functions

    - AudioInterfaceObject (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    -std::vector< size_t > parseArgs (std::vector< Atom > const &args) const
     
    + AudioInterfaceObject (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +std::vector< size_t > parseArgs (std::vector< tool::Atom > const &args) const
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    - - - + +

    Protected Attributes

    -Router m_router
     
    +
    engine::AudioControler & m_audio_controler
     
    +std::vector< size_t > m_routes
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     

    Member Function Documentation

    - -

    ◆ receive()

    - +
    @@ -201,7 +261,7 @@

    - + @@ -218,22 +278,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_audio_interface_object.png b/docs/html/classkiwi_1_1engine_1_1_audio_interface_object.png index 557d1ff6581fbf229bf1850f8a10ffbfb71a57a8..fe1c30f32bcc2632925cb97bd3895be554b9c329 100644 GIT binary patch literal 2567 zcmcJRc~DbX7RDc#G!RUKilA(wC16O4pe!Pa#0C*$%_0aQDx(5{(17eD&_O{|z!q5} z8e4(nABob&9HDPRaoD`5#@=IPYTP(5AMRbADu>UYk$Rqv1c-gmxp zZG3lgD=0002#dcX+_07`VIo>yG~#nOEboT0SN+a2$$P$-~sOe%}beQ+77zS7p# z2G8o-04-I|U_EgF^wO6{(1G6$0BQxUP8fWG(nM+Rl}aN`z}|!KS&`?pI`t65sS zy`Ja-cgiRj%*VRfsRGL2D6A!@#1QF?TN9f zB>MVuJ^HPtAuqQdm2o44Nv^>@WLy1odbyO+mDo8_-BiXJ7=57#cH;Be)i_aFWoj0Jb`Fijy}N~Ri?ip4R*}-bQ;Xa1f^{YOIP{48$wytL!zYW4&}d@gzPUma#wA6=Ir+BSw? z5*mZVaN%|HR6@Eldr=HNPYC3v7YSXW4HT1>;N%bi15R0Xh$PcIIJ3HL<5*t(O;*Q2 zDv4{+Bo@s3#2SkSA_;-R9D10)Ot{zD=3eP+>h(x9)*9U22D7>a9UEjk1x#I3nLQ`F zKu4VoO?dbsJNCN}F9H4)Rh#E!DyT?w;kOhO{N_Ha*S9s3@=|1(b%=aL2ZmfhdxChT=4Zdu!{dvPCMs9;! zRO*%xUH7@xMzhJPON(g6#C}=m8?Pum%WUF6D5lX~L42~H=ZUIN+kKhsOqcfpzF^CJj}&Rt2cgJv=Ui+nl< zXMVOs9k8}ojt-{mYV=C8uMyzz)(?c}qZnE+&BBihX&E_M_%9t~e06yJF041yR#qxc zf8Zj_;7Tx)KVc-r;YO~Cqw+85*R0c^Zv9JiZz;Q)4*anD!vA;Cf)A!b(q!%v7|f3I zi9va$P8>H-S^_pK$DC0xTvpMXPD!|d!3G|>2>gn zBoZc)@lErGF+}#0jN%C`Uv+;m$kJ}Q*q0uMC^_`v)5DrPVeE<1I0t-gy}dQff9@IU ztguGZn0fP-N(KcFiM(6>gmB|zd=TnDEY0K=ljDkz&meTM`I1HH6dKO_#^iU5FsN>* zck6)70NZZGX28-F14P-~=+bob!)iJnF{ixLbi_kd2v)=K7?l5J+KAUYE4nbiPD8F5 z`ge^p@|w!R84NEaG!b>I3#rWT39z+a`r*t%z{*%OEbaT>-j8{976-K!TPGj;B(E2| z^@WLZj&G7APC5)gauWU{=c#>MVeq!4n5N#S(3y+>xL4yP1GrRH`}F5q>dR$SH`P5v zdzNhI2HMnjoq*|W1#%v1il@c4c@~X+w5yHuh?E*xZ-@H$Egr&UFVQ->sEuf8@*#M5^_4*r8)uN{7NQ z8jYaLgIG3vJVG&Vh_Cs1LEk2EEP6-((CCfXSK(n|E4}vY;#l`6@;7>u<&Wa^f)=0O z?+Msf(%F7;i#;c z_tnC7NTsvJaHU7@hD?!4PEd8$L9zL%QRn6@fsLt61gwqsp0>846d*76!+hyZ)5j2OD+|{$Xghs>9ClT&5V{>2Irp< zk2)PP#}!7=Vrf-GyiH=)u{gBW|ppzTNN)&o3Ek?d8;PqE+kAL=eB> z14#FRSv&I!DdvnlweG9_Yw(h+3=T&QjP8-nj~vyS`H8+?5BI);+Ow)tdQ$dnoee90 zP?$a5vA}JVUz6-Px@M-BUQ#8k$B<15NV$EN%0&Az*`}~6QVU2-Il|AOmuSt2=(DHO zd)qG~v;zi&+(!3qUX_txGy&b-jto;!dg@j^S|c)gVmQ-GKNUJSHAfebdYpVstHyVp z`cXq5qx9I0qiKF41W+T9z;~hQeiX|3)~0M>j6!#l60-VXS;W!Rx8+s}W5%{eb&;zo zDQBk;@<(yb{P#A@8eHuU{jwM>iA zTDKzG5)tCkb-yH8yXfn#n%G1_(H4nlEfLiv?@#xiPXBm!W@p|r^Lftq%$zyrIdjhU zJn2|pcP+R+8~^|9xuT8Opi)d>P`GGQH9`{ogbz>^o(tSLKQ{lGF9Of^N#j|9; z&<@*qPmJ`)dp+fn9dl_W5X~&L>k~-cjl(Kyo|?=*6JP^hTcZ`jUp9-yEsVAt@;e2y zCYp$KU?oaR^^qdm4|#L$py6*Xv{@Mu>@NEBkgYsk$z|6~?me0MrB>8>Ot685(A(i) zBdvR7%uRm7dGD$@{f5)n`p)?NpNKJQ1+G=>XGrkwzX#_wrp={xHgO|f?L^;b+wPND zG-ua5mncJ$ekFUL9&9s-f-^7j{Lo`7qiTLP6QWPB)Fnq)IFT*9aOc=&tt`X+%Sq0%q1Q;mU~B!0GPFrI!Zi6-8u4OZT+BQDSbF@~s|}MYrCn|HuP-kJw#N zyGfa2A!;&m&5*FEZR)*CNI{AIt*$e@3!%{22o)`sAfI5rx`0d0^2W*i)--U`0)t-# zo!=0Ule%Ra@Y1ZWVs(iJ8YnIm#yr@R2)#+aL>*G8heq7n#B7P}1CXHlDU|&LFN-IS{BTuesHXt*LIcsQK^Md3G3avRJ1wH~j-@}@!*W63Jf%xBzJ`WFoV)gS)Qn5z zw*gb&%(E-1>KOQre?meQ&dYH(F!zK}0v;&S&;OLOmh(93_)%tf#JCNK4D;bYPe~j= z;rVPe81uASt=dS*S+|-d^Fe}cOn*m_IP>P?wxh|%7t9nvJclI>;r(&*LtkfgVrr2Z zcTsZ6&F}EV%b_rzfS&ec3I_v|l|Qf2Me+-^Kpk6ux(m-S*>9w7spuw>G9*0N1dE(a zW0hX2Bh! zhBV=?T8GIQk^oWEADTjoFrnK@D)AVrG`-m8Jr*^z^df>J{+D!L04H?9@NQvIG=fH(@w1Gt_8 z0yDQd=_YsT%C>Lx&oYxc3`mWX8Qy`+`F}^za@8j90r0K!(EdxGy@i2RSZvlGOayA}`Pq1-Bl&*P15J+98^x`sk?lH^i=dhHta!bZNC($&3#l4fRfBI( z+DHA01UKx!`#L~q@DF5v#h~duYra{zbr|w2sWY+xRsSQ%584dHiB!>nTY^V_Ol#I6 zIp&N=(LsU>DT(E@UZLhQ9j}z_NpyO>GHLj>d5s)AVf}_G`-O8f?D$;ufIKdv3WjoI z^0isHnQ5Jyy~DIb-NCuK|F|?8tsF^WH&le+rF4Ngd7wHtLu&u~yKt}Disi<)hc_Ng z!oNK+xm&9A?dDJ5v6LX-Pa_Ds5PskafPV$&u16OH)6g!qN6B>2YD-r}mE1n&_vIyU8U(Xa_xcHd3z zvUDV9%~7P>g=QK>zYSs44yOnY_HVANN^Jz@P>cSQDEMhp#%K>Ak$^pOy`Zz& z8O^`Yd_vR~9q34ms2Z+xo zD9=+GdiZBe2zpyb^W zjrzrj- - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    - + - - - - + +
    @@ -71,30 +98,41 @@ - - - - + + + + + + + + - + + + - + - + - + + + + + - - + + - - + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    post(std::string const &text) const kiwi::engine::Objectprotected
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args)=0kiwi::engine::Objectpure virtual
    receive(size_t index, std::vector< tool::Atom > const &args)=0kiwi::engine::Objectpure virtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) constkiwi::engine::Objectprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_audio_object.html b/docs/html/classkiwi_1_1engine_1_1_audio_object.html index 3db3f594..14db91cb 100644 --- a/docs/html/classkiwi_1_1engine_1_1_audio_object.html +++ b/docs/html/classkiwi_1_1engine_1_1_audio_object.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::AudioObject Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -80,100 +107,142 @@
    -kiwi::engine::Object -kiwi::dsp::Processor -kiwi::engine::AudioInterfaceObject -kiwi::engine::DelaySimpleTilde -kiwi::engine::ErrorBox -kiwi::engine::OscTilde -kiwi::engine::PlusTilde -kiwi::engine::SigTilde -kiwi::engine::TimesTilde -kiwi::engine::AdcTilde -kiwi::engine::DacTilde +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener +kiwi::engine::AudioInterfaceObject +kiwi::engine::ClipTilde +kiwi::engine::DelaySimpleTilde +kiwi::engine::ErrorBox +kiwi::engine::GateTilde +kiwi::engine::LineTilde +kiwi::engine::MeterTilde +kiwi::engine::NoiseTilde +kiwi::engine::NumberTilde +kiwi::engine::OperatorTilde +kiwi::engine::OscTilde +kiwi::engine::PhasorTilde +kiwi::engine::SahTilde +kiwi::engine::SigTilde +kiwi::engine::SnapshotTilde +kiwi::engine::SwitchTilde
    - - - - - - - - + + + - - + + + + + + - + - - - - - - - - - - + + + + + + + + +

    Public Member Functions

    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    virtual void receive (size_t index, std::vector< Atom > const &args)=0
     Receives a set of arguments via an inlet. More...
     
    +
    virtual void receive (size_t index, std::vector< tool::Atom > const &args)=0
     Receives a set of arguments via an inlet. More...
     
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     

    Detailed Description

    @@ -188,7 +257,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_audio_object.png b/docs/html/classkiwi_1_1engine_1_1_audio_object.png index a479a0e459c1d34099983423952e13d6f1fd91de..7e6a567e810dcb65f1bc19101ef088e9d4369f0b 100644 GIT binary patch literal 9713 zcmdT~dpy)>-$uzcg?-jDu_0SKWt&PWMLAV!Ym#F#CgspH#ad@!$QT{oF%^-Y4IxrF zG%`qw$$6ZTQ{@rXI1Gb?aVm!}-uoWf)${K2ywASxKf6AkK4zN3@BZE2>$<+z_qts- zH9jJZT8k1B6O+arJ!CE>CIKEV|Kf{f;D1g_Ewcc>6ikof56{ofgNJViKX`?5Zh=Rl zf5pYclGnK^;OQ5h=Ef()z?TI5|fbCq4L?)7YBZBsPm-HIx%JS4?)-|H198e#G2#NWljC znTiB*oU^+vVwD88iN(ByDXO`tv#IJBSl~VEeqRrC2zC-)#g%^JP2tgcGk%BT^ zQV;d-KYg9(o3HFx@)}d(@4;rGOD$ftv#3nNs3B&gS05$(X)~_Kt3Ej>n zV7XI9GXc(1=abdy=LP)^v)qo6=K71y=-$ZPMb``l+h1goeAn81OyRW5jc>*Y>~5lR zXbscDcjk+(ZtR=?c*NtYEOVTP>h?4a4;^dwp?5~1qr#Gqt1hTgEVC}^e=ko}CJ&6+ z+H#*N{Dh&5+Y(5V9xSGt4~0mG8V=Zv4m29%%Uj_|^M(xRu5E;tjVf|Kdud z_h{feGzT=VZ7J%{Wer>K`1T=+hY+1&$5gkE)hyR9$J;MXY^cxvB}mZ);nuE2yUZo= zRPw(O-a#dM$D71qCdaz4HK}hs`?ovtNdC3bHT+IpN##Ai>End(Lj@7Lu|hhCZ2Q}oenA3IVK z55Pz*d|Inmn4L3gHj)fr*BUuNOCQ=6@b}rx0F;7)l037&b(;NaU_J41jH$I7_uhXw z^5OL51#tgoXsiT3F=CRmikbXkK-wkH_T@_oK31CL4Cl7{y%}%Gh?*Q%sIXouLwtnF zxRPAZ8JhJdq9b&zmET#yC4GK~eEv-Xq#{@lF=}6}cC(e$*6CmRBx)<-ujC(lp2p4O znW`2VSGRQj7nBAYy5*(r#vR$oY=EpoU8PqHOJ%UJx}DTrmrp=tX_cp*tPWbP>{{?s z#`#i@k=j=s-X#R^%9)!e+sd1K!L!J#Dkn%ZAa_MQ?b2uc+_@c4P4x;jMgjkCY3vKo}iK$v3n{7IY6gqNik z*Tts-w{pn4{9d%U3fJlU0?2BqA4=i&>W zwEchR#l17Zzr6-pfFv29V^K?>J}Ep9^@LBzC{d`lAcG5m{X|7k_Od}v!pvK*-S^hYP&z{)Uxq>>(7e$t|!-oAAT3|AT(=mxRs`>HaW-9 zr>dA-*w(B+;@QcYh8vD2t?Bgf3LbKBIT^Pi3<=$ut2OA^Yf!D;%lDj6v04k&Sqd%V z=sWr>^uy%q0oy%Wr8?I7x80q#)$$eGJVLp8$(ARB_HLZ{(POgQf5((DI^rrt`a)o2 zhZ=WEfOXmvQ!BT(<(q8z$~k{(Lk^R3|2rztAc9CdRyD?s+@!7e3Y1fe>6UiZ_W8RH z(r58J^+BO@SC_@pborSVUj45K;%|1PsuKenoVGEi`Xa**t$P+~d52N^K)y8OhSFqW z_lnH)d4}tFcIMoCM7>T8ThRin*$)V=%Njqx{M(Ku>3|(a2qy=naATfKiCJ-3BHf_H z7zrq8OeTW9YO)8&#NH&Z4j*|m_~qy$ht@L!dwpfnlvfSO;j;>zy$QBp*eJw?%d!ZU zB(@*<4Ojp_|GvlkVax!D(Kr2%VZ%-5RF3S;##C)&P0*<8@`T;D(v#BPu!knNI1kvx zbU+7tOxCV{TjKGNITCM5Qk+2-6zyZZv#wUFXY}ZT_EX=h_@cJ`R@?HRR)oI?U}NMO zDod;~mF#44p>#|GBRozwXt>9DIeTdpeDM-Wwd$0e*PSuB!^SsCo?xx;yuoY?+Xxae z1PFpO+Ph6QRlPj|ljEz81}Nygu2XoxX}e5b>4pLT1NGW(0q6w}7cNA8S9e4B`m*9} z;lo@d4;q`TxLk+9z(;Ku+!@$gO~T90Pg*w)k*+0#?VoIaR`nZv-p66TI6L-MR4*3O6PvvLeNX<^U$D zf8xT%rjG2OhHS%mT;EclVp~~Dnh}>5=omTqLlHr;sEP{*Q4SWW=)gh2wm!zxg z)?=$>MUIQc{VWquuu%bgE%Fzq)L;x|ot zghUcZmdn?a%53bc`8gFd3*h(CN1_(1pNw6tsm!V{Q>jv@>?w*LxPs~?w_DO{?Xr9~ zG>I&yyvl38EbQur)rULJ*`Ito9eOU<@b=pZ@+ovD5iDn?bIzV?q%d3H1-=%X;Nfp% zk=nlLG|5fj+(mT$FO6z zl<&j2xP4&78xhfGc5lJwnx};G_cXaOQS+~uZfsN4DkB#z9xcoRHYWdzzaUJwX}|LS zJ$Plv`z{jewR!DZR#P^u|src>c$@{W1qB{3!PdLJw$CnA+S!K(Ld2< z+jIn-?Hqa?YQAiW`YN~leHChnm4Q7DUpknQB1g%SqaO!BZ@LQ6VoP6dlx(S6+i`tE z(Af;#ih?sGFMVHrixa?>MmtQmmPlu2)DQQs2;+B4JkXu*SZD>lK3AKE`;!Sgb9aTc zfe!0T69ChLr0^%VHZ?p}8>f)3`s}B7-@;5sEG(D3GgfV`L0VWAV=zg|QOKgb)eGhZ z>>bo1h{ti-Ks#;I$tYK?N{7TRO6Q!_KZ>Zr^#_=uCwA-M;&4!pYFC6|>ftQHl=!XH z;w61>Kow`9zDFfFT$Jm)>ywQ#?d)0Nw}2n`L!-ohBJA3Cuu>~by_w8O|4GNxS76u zNMVd^-50+tPe&zUg6p>VL+hJqa>hCB79ox-i9-}2iRZ925=!YInYy*o)eYag&R8Fu zW{{?JmoMys8%arZLsEh)b*pDLG*)IZ5@{#sS*OGKYoJyuVyViS_-3zA#WI^~rDGkF zwx*=~-8h#~+G2q{uQuB#c{6qtXr=;@j~zB_?5Rk@c?1C~1}+f^9r1hcVi?7d zBpVYHR&1=AgiBfmCQ6=0SSyysH{I16=pGi}ulKeLPj)8sXgF?p`ll`jV7=eppaV8=Jcjs2I-Q z1Z#F_X(PX;!OVDTouWReXQ~7hl7==m-+j)Z?t^8oe3f1rDhIEXw`1XAMfW*P?gn)0 z$=zs~0(rcG>v1F|KOP0gnnUZ_fv01%@iYpEu+DU*`lMA6_}pvA+x_%RyLj|m;xaHL zCe&c6lwpCtg$4HPcO94tGpLPH{N7L|rs@eLfkV3i#F}adYQ{|iDM>9kQ5W~-!~&nm z=XG&32KdUUtIQEoOHgzuFG9PkM-hAY7J~Ti`{+*$J1zO$h{yk8&zD&D|5K7MyG#^W zEca23V;w~D!J7WH&9KH&SI3hL5v#6a!wJ3u8=2W=W!towkk(M#&O?yT_n=(wsxIyC zDpSn{67|(2=;G-$g9=aBwS)H6+5NdmeSz+8slQ~`t8@=Cm>DsSI}8x32VhqOpL_WV zhc!ctvh9Q@Rd%|larYvTr=t;2b)$zSVv#y@-N*fAs~pUR=J48U0b5H8#t z7{Ok_4Zz%^khv@rg*c9xJ`d3unaU|>)WOk2>D8R{2AuHU?(d(~pC|s-pW}=#>>MOh zsJn;#T=X|qDJ&2a_vA*sM!>F?gmi3v2C8-HSZxT&!BuXyWyVCen=y(XW<^tDJL~cDmZjEz&TiL2Ng74^z_r0VXrf020 z_*ih&j8pXV?m$$Yz$_;G)r?W+)V0%cm?}cM$$~|bb^fw7h`h6}ZO)sZkhGV`%dg-@ z0gJs@@Jx&NHFI)OE-qhI3aRJ*773i%4+zx&vRG8|NFl3CMeFfLHfitdU{Zm~g^mob z8iR1YBCM(!oX!N>`*CA_P#K1qZUK7%w-dn~(b!n7bzL~00wax%j&BgY?Y|qC|ExsU zTtf6|4Ps@$U`TqLf8UU*h2)ep1iZ!QonQP23Tr_Wd~=upgnXZO&GqS1d94xFak8s? zT@(V>ZPJPhX$mSCzZ$Y^!l?8d&f_u^LW|FGnteo4YH>?v=EYd!8E1Fs8HVv%xawPB z4PG?n^QeMd0j$;SZ5h+>*o#86Wy|NIFFm~ecwY%?)Sn6nU#jvKaJ&{;Dqys;o5CeQIwxX zFw@!)B$^<-o2CGKd}fK5V%u?qqewgiMT3Tst39IoMdfc1L zyL|_OWWXN8aWuhMz!q8U-r&JE(;%v=XP|XNf$*AwyqH2(U+AbWRC@m%_DC$e?;Jvu zq?U~`IkJ)rCUa3k*QHt;`(~W?bXU5Ak%!cY!N&5*N6TYNvT8ydbW>5)599IinO@Ux zv-XDbMSF!ga z1!x()0$~mNX=M3q?zHX6`N>D>_VkhCe{b^$RjN_i?}QA%Prrl_wO z%91Sb?EF4K|KaR8jvP7=8;+sCQpi4n8J*QS$GO6hc%KVz+Y@I@CnitV@mftcdGAun zL-?oRg=w(h>r#hsPokj~EJLqL9l(ukfwyCer!(FGE02N&JpxY@VAEeptflGAnZ-!8 z1q%Z9e@%0C?ri6*)pl@xeHu&G#k6dvSkgHp9rhnBj~Lc-!v;8(h8C^v7aA>zhSUpn-2T-leLAW4S4qp*yd0A8_`_7+$1!S(WBRSl^co5{ZA` zsrTE8lvF%!*=hEiy}!ULZo=mg&C0^pIVQ8_bl+KJQOyg9Jj`wbi(YEnc}mSl!lgmO z=O;f>h}9E4<8_;kAwh7Lv1sr90wzaqCTLp#OH6y$_tGrT0)7IgQlDBt!DlI5VoCM( z955$ylR#PA7^viyXN3m_9m~q4yWZ*M5ENb*BV0I$3Cu{W)yakdmL0OY$;}`X0;#G& zlI*g2LbHi4p!)#4cn%!cxx^RY{7F%JKfx>98HWjgu3`2pAvZNxwWnr-zY?82di$ZW!NHtW zb6Mvj-Ht`$@Q}rnzi$&T&7CQm5*tex$#e*!i z)K}B(4fzK}R~#a8Kb81}w(b|L7?FJ7p>;Rcjme=lkr(vboQENGd+Tp~msJzr=Vg1a zccP~z(gnAG57$Q{UR+aBlRqho&Em9x!1(H?3IiSvm6Iq@shq?vb&cRPT=1s|ItStL z=nizn`)$}M_OhnbIh-^59>??y!qRi+VtflD55-X5j3?+4j;P(j5aH9JM<|N?zM5&9=ZQLm>Rs*bKt1 z#c}=AaAjW@rpeMfz-f5uS$~#)$A{YG0M27+;5hEakVfdyr@5f*p2$t(>?wSmK{kHw zk`R#A(U#*oQV2RX7>sk`Je5C&&X>?WmOsRKz9C6^7FD=PseNG?T2#f`aJZL<~W|JSgUA_stvGIjKw@I-gysWU(u9z4$3}!)7M>d z_-1hQrs`3-BC|kiQ04+5_a{#IDV0i_F*~)D6e1|#_YeX}sGxG4H+>hRSWRPFuv840 zYe9PaEjVrfofq5+@NtpCvorIv9$mEwe(ir-U`WEi!~@XPzoPugc3_$g6MT%IuHRNRSn)~MFUBd>A-Z)>hHQ-8 zHSAh*1KvJ~##Bkd3aW|ztf#U$u2+<_H|64a)Ejh^!ML&-lzv?h+w?t*-fm7qI>Ir6 zrU1Ps*IwO{L#x#y3*@`KhydGWr?IfTg(rAU5tzN*ivSoaUXj__Ue8=4e{8J>1(;P= zA8mB!9d07$WRiT(NABf;#JQ-qmsc5>9D6xGxx3QK1&RD*!U3Z;F&A`4V5BK{2RgtWoH=u!J=P7}}ynWD#hUEr9}2)_^Qwr$Q@76KhRa z3<07jqHF<$B0>@<8U(^t2p|wZLy7E?u!V$Vz9cZGXL>sA%;`V#os%!`<-6Z~@7?>m z_x^6KxjLUx2kC-TR8-WFr$2L3QBi{d0>H9Hm&h9FJko@Abdzh%G{51vnnY~B+pXRxXp6Z&EN|(KZ>?RR|T`-FkC@ZMoVWES5cv(ioWvUeFOq>_VKXcA5zY*zk*!y0ji@F6NmW&~ z>@p6MFXl!ctIWAnQdCak3RqObZ>BMKd^yumHEIiGIa4%G)=|#^G1`rmWt- zf@j~3>Fd7RcONe#P4Wxd2(%F0(TVJ@8($KFccD-SWNN8m1$^S)U{dn(V1T>iQYn9_ zJGdn^0nylv-(*5`_PJPgB^A-fs9Mp=It6xIU5%BOb9ZCtT z0;B*;-=J|ROzB3BgFSFHk1GxY42tW*DxKumHHi08;1&dWu&qdmw)FHz3X5xNpWW7_ zG^eVnyTZQ)2Di7hd2FkQYv3+y0wx1ifY;pmR5AG1!#_a(?^RLuDjNY)yGT#N^yVGJ< zmzv@Qxlfoj?^!6F;^*8Q$ZGA@`MAmsQJ9Rz7s(8KaM%B~PSC9-si7zTq_Qo`INiEV{>CdTUl5-;&!>YcO zRL!f~h=R13}}aCC|@)49?|8sQPmQH{$%ieb($$RB`bgE)@>V zx-|wDGWMu)DpZd47Wt`rX_wo>b}RtX(4PO_Y4gbLT5d!gGons@uXK>7rD(5yAntAN z|9tYE^rbm+?1#vs&^GT&=a7%pj{hAwFu}#Aqd67dK@H0s4!7ynJcN2?VAK$Iy$=G_ z6Mu$irjYF175_=yC&b3`J=sveRK!5_Jn*}(BfbHutz5|+`KzX|iN9pJgu~XY_alj+ z5fHki06T$*o9DciQF2EmVsL)cygGvmf^pWOj-t_%Mz7mNC3m~=5=yMpFJipokT|K! zi|La^Go(NVZI+7*!ZT3~OG!CUWaWj#;uD&N9{q$+vx?BG*YylS3PaS^3ZXiM<>A#p z{?_+RHMl1O3Yx{in0uPzWH3^Y-*&xUsdviQ6qN@j&@?<&;=lIB9v+`)^moLS;e zAW%O=j`5k9?sg|vPn|lCD2RI2+}9MzTH0iG5UgfKn7Y}pWHYbT=$~}fY&LQh$0G&C zwy&;Dm94}}rQN}FwK7S)8g72+6fA&MssWK4awI~}AEUdqwzLfI`8Y&+!1AfMmCy`PeeUCj7NcClAQUxZ#`-yU783L1SoNy1p=NjP&O2Vs{! zZbw>wZA$&=bFes4Z|-y#)|u#o!(rH;cXDRgHC~1}VDW(jVYF4)5Pn{q z!M?p*(0xTXm?#;~*1FhEu%5BL$eOs%D|=n;WRiRq#Q5I&B!owcEoum*lfk5NA5+)@ zZ6>Az9mHBWj3gdK`4ykY4Y*c>nLDC`lO;RAF0y<%J}CZ>3Kd;(*o5cvPKpx*ZNME{ zsqGeR)~T_@kQ?_VLNGp*rC5yQlN1tmx+WXdK`_+yAo?Ue)avw{)r9flRFNi27cguu zPRzl@3jmbfsD2SLwa*v;A*pZW%56DFX<4>jy%dfQWIdHR+2$_oynJq8 z61Lw(42J={^N5aZUHMVp_;<~zB(RWU!QemwS<4K=2TtQtubfSJUeaT*E+D{gfZIGv zbw3yO$c<=N<))*h0{{j)lJG{j+a?PvoNJsV8~24ACxJ66EktKhDhJw(gS&T-e%#sD z_2g8aGo&p6GKb#(0CIKB1=5`v%-;v@vOFt30mD36j5ll{eOs)7jU(;S>l5qYMtSFK19L+6bdM&jSXne(ohrJm=`a z$v#8eDS291Z~GPcc*vu%^>%X9*&e7TYZ1e0S>f7F2f+d!)k?U|HLjogK7!Ww-JH!6 z?pUua%9*=C%Ll&-L%~d@hC!MGYcG(76tH8(PlmXnpwgK$hui3>K7#~E)8g)0KWy?e zkSubSXT{b?sn@@f+agL^Qu@nW#swh-kG(vI<@O3mOq15L-9V>NE6@VolDpSOW_SQ@2y{Pk&~Pqg^0 z=;bsABNG}&?iFvm0m9Z5!}jQxPLT+D!aWM(r_GM7=0ROH!isVS5e(GdfOS8n=GMnm zfbj~4F=NjsZ6+r#)9KMWN5eD@iKj#fm+VAFMjDx$Y2x6Lj8;YiWZ!`^M6697I9fZl za>8iigDr0Vtb|@jnVIHHFNtFG_S&iE317ZmfAmD-!3~YWZFTa9z7AJ?o)ELT)go|v zQTm(Mo()!k;G>UN;g|FFwJg!P9EmhU4p^ui+fJ~LVf!jLl%yhIcotxp^Ra312$4S7 z7;cDUm?U9F&-Giuy7W7@rL2c%>#+-I`UOk)RXBrPeZ7ta_JZncA z`vOCO`E_q*59-OQV?DlURGK>YER_ diff --git a/docs/html/classkiwi_1_1engine_1_1_bang-members.html b/docs/html/classkiwi_1_1engine_1_1_bang-members.html new file mode 100644 index 00000000..ce0e5a6a --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_bang-members.html @@ -0,0 +1,135 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Bang Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Bang, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    Bang(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Bang)kiwi::engine::Bang
    create(model::Object const &object, Patcher &patcher) (defined in kiwi::engine::Bang)kiwi::engine::Bangstatic
    declare() (defined in kiwi::engine::Bang)kiwi::engine::Bangstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Bangvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    signalTriggered() (defined in kiwi::engine::Bang)kiwi::engine::Bang
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Bang() (defined in kiwi::engine::Bang)kiwi::engine::Bang
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_bang.html b/docs/html/classkiwi_1_1engine_1_1_bang.html new file mode 100644 index 00000000..6f81ca4e --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_bang.html @@ -0,0 +1,264 @@ + + + + + + +Kiwi: kiwi::engine::Bang Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Bang Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Bang:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Bang (model::Object const &model, Patcher &patcher)
     
    +void signalTriggered ()
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &object, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Bang::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Bang.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Bang.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_bang.png b/docs/html/classkiwi_1_1engine_1_1_bang.png new file mode 100644 index 0000000000000000000000000000000000000000..05af5c45101c60ff8a0f4446022e786d63467595 GIT binary patch literal 980 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GW4o-U3d6^w7^UYxX9OMvZm|EfLzmF2@l z+*udRK3Tt|OvuVjVgYl{PSvGT-tl`*dgqtnHA#G-re~bU*@HE=q&!z`Fq^d@v1aC~ z!wgH4(TScP!+B;+3Yt4H7;Ad@?>22>V_wSZ1lUF)>NA&F9 zr0*u%(?3sm`B(m$?dGjjV_fl6?fYIc^|FtCOR8IP)#gjQ z{-luSYoBe3{waKKs7Uc(x`ZOV9K2m6+ewbIuy&)m;x;vEA$M)i+D_ zE!jH9ccCut{%^}>`}{w5^N#9;v_8}H?KAgf$9<{{TbuT)W|zv!w%7YFw6?!F`h4T; zwD%WvJ+1%gpDpLl@LU%2x48IjiRUjq8U$3aMBBrE1`K!RUSRp4WWu<|V)0DnoS6Oo zi%rvY4wRnDW~w=2az_8S)k@2$^G}?)rLKP=VzTP8WimG5GcG(`e2sm<;h!_+rfFVI zU3(+$Oux>ot9A^sewnj4&-A1gYE92Q`Z34MiD6aEs+r64vTm)}IQyUI+0qk#?yXD9 z4fH+wFej{>VZq_4BDXGmc%4(_eff3HJE06^yY#n3+yDD|Z?0QXboFyt I=akR{0Q0=u<^TWy literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_clip-members.html b/docs/html/classkiwi_1_1engine_1_1_clip-members.html new file mode 100644 index 00000000..b358e9de --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_clip-members.html @@ -0,0 +1,133 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Clip Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Clip, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    Clip(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Clip)kiwi::engine::Clip
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Clip)kiwi::engine::Clipstatic
    declare() (defined in kiwi::engine::Clip)kiwi::engine::Clipstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Clipvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_clip.html b/docs/html/classkiwi_1_1engine_1_1_clip.html new file mode 100644 index 00000000..fa1d7688 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_clip.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Clip Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Clip Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Clip:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Clip (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Clip::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Clip.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_clip.png b/docs/html/classkiwi_1_1engine_1_1_clip.png new file mode 100644 index 0000000000000000000000000000000000000000..a8f6e821a3c41932ba78586a75edb3a94f99aaf4 GIT binary patch literal 964 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GV{o-U3d6^w7^UYxXALBOToH}v2C$?LVd znwu`3N(q1M=fuv;Jcq}mQg!K+clwi5?#4E1dd6}2czy~xD060c?!+Z+*ZhRddh{=E znZ3Xyhna7BR)W_h&8-I9N%`yauBo0`sdM_t@}1h{elJgj^3B|58e~#7J#(6%{n?*8 z&!xSLNHb;*<7(b{XzKEvKFR4 zFGBmJgA?DG{k2LfJ7bt8dU?}@A{(D4zt%SH^qY5o`KFux7t6|j``ve)wN-k??G*XM zYw5+$zdV*Nt1!Et`|Fs)r48D)%V&2dd`v(6a<$-FzVI^hdmGI^g#T~Vi#s~$N^pWz zP@U=QNl%s>n4+T3x=f`q^N5e;(%akzqV*eozm}Y_{<^Zo{6@d z8@jFMeUn+HQoF3_#_SKtz>w2^vV78lJCh`rt&_1apAleu+h!Gu&s5%NOM34muPb=E za>~jm=~t)zcy#ZS-XAvU%C+b-soS?{Z=05>yZ?Ne^1IKz_6N?ady%BK>}Arr$Fk?r zW}5Ghmb5x`snCpnjee$Xx^Bqo!`JVZJpS^2&e`6^RiiVObObxmtoIW zrXBm|HU6x!ZTc)ZL;0z&g?y8wANz-3JRyS?aKHKu+Y=?;>9aNL)`o_qRp-p+oEINA z + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::ClipTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::ClipTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    ClipTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::ClipTilde)kiwi::engine::ClipTilde
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::ClipTilde)kiwi::engine::ClipTildestatic
    declare() (defined in kiwi::engine::ClipTilde)kiwi::engine::ClipTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::ClipTilde)kiwi::engine::ClipTilde
    performMax(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::ClipTilde)kiwi::engine::ClipTilde
    performMin(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::ClipTilde)kiwi::engine::ClipTilde
    performMinMax(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::ClipTilde)kiwi::engine::ClipTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::ClipTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::ClipTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_clip_tilde.html b/docs/html/classkiwi_1_1engine_1_1_clip_tilde.html new file mode 100644 index 00000000..e1b4d6c6 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_clip_tilde.html @@ -0,0 +1,344 @@ + + + + + + +Kiwi: kiwi::engine::ClipTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::ClipTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::ClipTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + ClipTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    +void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performMinMax (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performMin (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performMax (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::ClipTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::ClipTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ClipTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_clip_tilde.png b/docs/html/classkiwi_1_1engine_1_1_clip_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..db080daee96d0642aa2c198ec223d34837f834b9 GIT binary patch literal 1837 zcmb_dYfw{17`*`z!~#}}B2*Yl6cG)+2oz9!U@$0Pkq`_ZS{;F0l1R%l5P~vR9#ZNp zR1iTx5ei84rHap!bu* z;pn9FS!hzd2yf40facKR;I;bf0Dz?pc-MVCF{rUT0W{IDa!FUQUcdT^kxM_Cmc6ri zjR_f-lHSdS9!ve*t%nq-dtV%c_T+_Rp`Ey!@liztXwDO=9o^$A46Owi7SXgLYrhJlBK3>k+(^^{GWOhx}@+fN5mho6DY+2o4?ZS~qA-SYXCG^9=9-{EqJF1jehsG-YxbcaKKxtVO ziflMJ)lWxcY;` zQE5bA=OUomoj^6X+HlO0eE=t}{z)qmYSh&xF)u{t?kX6FDl+DHB3jQ=eE-{Kapr_F zfZDj&BT_k<;rMZr7OPbp0f`L09fUMf!Dw~4mT&kYQGU1T3|n}5&c0gA-5{}h7MgXd zX}h&Z)=^4;umY|$U?djK*kLMpbNfbZrNn9~M4EIdbu%KR#E|u40`kMM6(pmxPM?vU z#wyd=R~le`!hx>t$5DeOYohBOm44NFcHjKhGji# zS3AMH&k@IPd&CedHAMZ)k1beWg1Y8o55%J0C`-JsAx3YsEvlDR!osXRYM})oPXw7P z?m+Lz!uq?8oc>6*rUp#_8Q-zpJ26%W*1AA)pJ7ur*MZGg7SUEf;h0RLb*}U1+k~nW zrNev`Wusk?v^_LUbAfimy)*R3OVF;XYxW0qY{m!2gh$}%2D$tZ+aGS#YSfTd&^il6 zw3W+LfiUzA+eX?Tffq&cFm^UzoacPWCj9&3?IaQeHy~iT)@Hc2l*T;pvr*#@Q zR@PpJgV@h$fvi58YYA_dgg)Py8VyriI^jBUlb8E6ZVszq3FaQVi&h!uQTdA7t!rdF zwvqPGgL}+Yaqd|2J*K)IxgQuL+wy%~ZmW0)5xFXLyW(gUb}^kq)V^bMSq83~_N#s_ zf%{1D{@kS&I2Ve_0A@e}W4qx3#~C|V0SrX5J)exKg(6je&$`(&G@2bt93R+97L3<2 z^}0#+8H1Y(=N}5{4*5NWWIgm}V-)jB`~EMnZeG?2&O7A>6rnhk{+4%p zdUlUbQAntTmYX+vLxuB3WJczx5`*Y2stlwDi`lt0WgP@258U=#?i6CKEuHWn1?O~$ ze9W)b7Txz*NhCcga|a3Ya-#0wz}M4>$HuJmwN#C>J$(dsC~^@m z=uP2#VivzJ>BaU$ + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Comment Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Comment, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    Comment(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Comment)kiwi::engine::Comment
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Comment)kiwi::engine::Commentstatic
    declare() (defined in kiwi::engine::Comment)kiwi::engine::Commentstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Commentvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Comment() (defined in kiwi::engine::Comment)kiwi::engine::Comment
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_comment.html b/docs/html/classkiwi_1_1engine_1_1_comment.html new file mode 100644 index 00000000..51764cbd --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_comment.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Comment Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Comment Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Comment:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Comment (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Comment::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Comment.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Comment.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_comment.png b/docs/html/classkiwi_1_1engine_1_1_comment.png new file mode 100644 index 0000000000000000000000000000000000000000..55ad884c5fcdba1b87dd41e3c2d7c61ee673b931 GIT binary patch literal 1001 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GT_o-U3d6^w7^zMiyNL4fUc|EfLzmF2^y z%yyV`c1hngziDxzY#9eH?r#w|^i|R0($zv=&rOF+RZn&;*(vh>w3O$o3DVsgQvZsE zE@upKl{T2WYO$uL{>95aU5huiMdfGaJ)NO8@2&5~!svAs9g4R@(>t#{GdXkd@p7wq z*H_P!>buy*cXQE&Ges|R^rP>`nubmdcegZIy{j@qIx_a{xuwrGroN516g1`E!!5Js z$}MiS|GLt|fA+t9X=i5aOcTBAz3}lz4W-Ya?#BFb|Kp<0eiYie+xpy>;1t7h_sy|y zW~TkknP*g6mwY+>^UY=EoGQA@jZS@eTwyiz=OPk5B z@N;7PA1>8wlS@~){|D-F=S3cVq{kCUsX4U2S;hTlO|6Jy8k{rfk+P_3H>)AiH^J!A% z|GtK0Z1ehjbJO$ofUA}VZ(6E zhGE@#TNC;I=!$#J#as6@Kle4Uz0CNgz?VTgM)&~Nb(Rf>Oc~eU=04)j);ql^MqaD| z7*LSFbv_#rYj*B^`i)&rH4k|6}w=El)l_qDY2fT zf3CZ>{lzmyPd8*vv&bn8Ghg2QL^}D~Z7=n=84S9~XOp)dGv3y|Yfl)84W3CZ} idOgB)dTONJdHa-D=du|~7~O#RlEKr}&t;ucLK6V+)!WVh literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_console-members.html b/docs/html/classkiwi_1_1engine_1_1_console-members.html index 79593e8b..6d6d653b 100644 --- a/docs/html/classkiwi_1_1engine_1_1_console-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_console-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -71,7 +98,7 @@ - +
    addListener(Listener &listener)kiwi::engine::Console
    Console()=defaultkiwi::engine::Console
    post(Message const &mess) constkiwi::engine::Console
    post(Message const &mess) const kiwi::engine::Console
    removeListener(Listener &listener)kiwi::engine::Console
    ~Console()=defaultkiwi::engine::Console
    @@ -79,7 +106,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_console.html b/docs/html/classkiwi_1_1engine_1_1_console.html index b1edd510..6511558b 100644 --- a/docs/html/classkiwi_1_1engine_1_1_console.html +++ b/docs/html/classkiwi_1_1engine_1_1_console.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Console Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -87,23 +114,23 @@ - - - - - - + + + - @@ -119,7 +146,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_console_1_1_listener-members.html b/docs/html/classkiwi_1_1engine_1_1_console_1_1_listener-members.html index 9d809dea..fe893e4b 100644 --- a/docs/html/classkiwi_1_1engine_1_1_console_1_1_listener-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_console_1_1_listener-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    Public Member Functions

    +
     Console ()=default
     Constructor.
     
    +
     ~Console ()=default
     Destructor.
     
    -void post (Message const &mess) const
     Print a post-type message in the console.
     
    +
    +void post (Message const &mess) const
     Print a post-type message in the console.
     
    void addListener (Listener &listener)
     Adds a Console listener.
     
    +
    void removeListener (Listener &listener)
     Removes a Console listener.
     
    - + - - - - + +
    @@ -76,7 +103,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_console_1_1_listener.html b/docs/html/classkiwi_1_1engine_1_1_console_1_1_listener.html index 5c70ca39..a79aa69e 100644 --- a/docs/html/classkiwi_1_1engine_1_1_console_1_1_listener.html +++ b/docs/html/classkiwi_1_1engine_1_1_console_1_1_listener.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Console::Listener Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -86,7 +113,7 @@ - @@ -101,7 +128,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_console_1_1_message-members.html b/docs/html/classkiwi_1_1engine_1_1_console_1_1_message-members.html index b74a77a3..47d920e3 100644 --- a/docs/html/classkiwi_1_1engine_1_1_console_1_1_message-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_console_1_1_message-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    Public Member Functions

    +
    virtual void newConsoleMessage (Console::Message const &message)=0
     Receive the Console messages.
     
    - + - - - - + +
    @@ -77,7 +104,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_console_1_1_message.html b/docs/html/classkiwi_1_1engine_1_1_console_1_1_message.html index a34592f8..b87a0df7 100644 --- a/docs/html/classkiwi_1_1engine_1_1_console_1_1_message.html +++ b/docs/html/classkiwi_1_1engine_1_1_console_1_1_message.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Console::Message Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -78,7 +105,7 @@ -

    Public Types

    enum  Type { Log = 0, +
    enum  Type { Log = 0, Normal, Warning, Error @@ -88,10 +115,10 @@
    - -

    Public Attributes

    +
    std::string text
     
    +
    Type type
     
    @@ -105,7 +132,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_dac_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_dac_tilde-members.html index 16b0ec15..afed32c4 100644 --- a/docs/html/classkiwi_1_1engine_1_1_dac_tilde-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_dac_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -70,39 +97,52 @@

    This is the complete list of members for kiwi::engine::DacTilde, including all inherited members.

    - + - - - - - + + + + + + + + + + + - + - + + + - + - + - + - + + + + + - - + + - - + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioInterfaceObject(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
    AudioInterfaceObject(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    DacTilde(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::DacTilde)kiwi::engine::DacTilde
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::DacTilde)kiwi::engine::DacTildestatic
    DacTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::DacTilde)kiwi::engine::DacTilde
    declare() (defined in kiwi::engine::DacTilde)kiwi::engine::DacTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_audio_controler (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
    m_router (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
    m_routes (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    parseArgs(std::vector< Atom > const &args) const (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
    parseArgs(std::vector< tool::Atom > const &args) const (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObject
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::DacTilde)kiwi::engine::DacTilde
    post(std::string const &text) constkiwi::engine::Objectprotected
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::DacTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args) override finalkiwi::engine::AudioInterfaceObjectvirtual
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::AudioInterfaceObjectvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) constkiwi::engine::Objectprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioInterfaceObject()=default (defined in kiwi::engine::AudioInterfaceObject)kiwi::engine::AudioInterfaceObjectvirtual
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_dac_tilde.html b/docs/html/classkiwi_1_1engine_1_1_dac_tilde.html index 369e4d6e..a143d36d 100644 --- a/docs/html/classkiwi_1_1engine_1_1_dac_tilde.html +++ b/docs/html/classkiwi_1_1engine_1_1_dac_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::DacTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::DacTilde Class Reference
    @@ -75,123 +103,165 @@
    -kiwi::engine::AudioInterfaceObject -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor +kiwi::engine::AudioInterfaceObject +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener
    - - - + + - - - - - - - + + + + + + + - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + + +

    Public Member Functions

    - DacTilde (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    +
    + DacTilde (model::Object const &model, Patcher &patcher)
     
    void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    - Public Member Functions inherited from kiwi::engine::AudioInterfaceObject
    - AudioInterfaceObject (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    -std::vector< size_t > parseArgs (std::vector< Atom > const &args) const
     
    + AudioInterfaceObject (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +std::vector< size_t > parseArgs (std::vector< tool::Atom > const &args) const
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::AudioInterfaceObject
    -Router m_router
     
    +
    engine::AudioControler & m_audio_controler
     
    +std::vector< size_t > m_routes
     

    Member Function Documentation

    - -

    ◆ prepare()

    - +
    @@ -227,15 +297,15 @@

    KiwiEngine_Objects.h -
  • Modules/KiwiEngine/KiwiEngine_Objects.cpp
    • +
  • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DacTilde.h
    • +
  • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DacTilde.cpp
    • Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_dac_tilde.png b/docs/html/classkiwi_1_1engine_1_1_dac_tilde.png index 0c46dbf2efaaa638208b8bddfd1cdb9e013bfb77..e7b2e7203125e3e55cb22a61b7b9dd928aa7162d 100644 GIT binary patch literal 2444 zcmcJRc~BE+8pazW0|Zb}qArXhiYTWbqRt@52FyxUgqXv~EzW|70x}^1Ljdh5L0DK= zk#HC=B4;?|KE{A3;Bun`BoMA}hG68#0^!Is?rs$|wY64l)pXVG>!-WkfBJjgr{6CU zV|P&nt_}wPKm~1c0Sf>!Oh~UN?10u(s|FNwJAkppqoh(PB&UU9a%@8!q`pvJUk{5M zJOn)|1YqrO093Sfaa!;u0HCOWzJSCB$;_qBJ}%YU4GdK1iKOq2Yxps}Zj=nC>7J^k z;18&J{bBR{a!8mePgcq;?Ot=|7=rc0kCDpRhsXWGo8}dectCPh9CK= zvEp9Vo(%3Wm<3{KaoHAw_@Iy)@2*-sn91~s3U)TA?TAN|)fx0w-?7JNl>`OC_2de0 zt$$}ycj?_E4XwC!gv-yIf)PMEp@++fNIrBl`T>cWGHxp-jX9=`QGGutU573nPzFkFA<`Eh$`>1t} z9u71-27$4kmgB>LbVymnQvum{@ONkEg=lT_h%*WEN}#O+%XJ0SGSri{vk2CVRT^CJ zdFeF3lSbXYJm_D_(jVHt^cUN?wDl!vz#)SDe4!?%GigG2dSwd4KNTuS+WRp+3v_1l z$@aOsr^E2p|L9u1$k}baPwhGCHXlc-=Lc*quG@6IPHHMdXgP(sUkdEYUI?U(3>FWm zmMOc>3>7W3t-Rvz2o^Za>ro*7r$H_Ufw_fRo_9)WP@ZqKyPCei*%WHqUTh6EaLSH zDzPY{FqE^tGdZznUxwr`FDq9PN-te*Qp>1uUulczKX~n!_sY0P`_1@yR`|$ErfX0F z_yg6~;~vl1xFGi#j+Y{cDngWbB^OQd{T<-~+;ieNeMk3rX1h|w42IlZ2~T0Kd2=Tj zA5xlXm^;r$hdO4~T!M2I)GNe1-Di{ylNAPY0;X$I-pCjXJuw;bg7NY=&b8^hgI@tl zV!;Zg6)<~Gl>F#v*_Z&PIB|B*SG}{C&R}{V3M|)6Zf)2Ky<4&c_b7?Q+EitYJ=`kK z*?n2zX$K@&B+F<~s6`A(_~4VN$q8XaXF-33=}KbP6BgcbisrOs?r$L?zW54l|A#?n zNy^Z?Up44^OF`2Bvh75mC8YEqWtuDhbt9p=ubTb8Yep<2Y>|;{y?B~ngoI;NY`4)? z4kI`EIiz!M)KPFGqiZdWME-_vJa3~YC|wNtscv~mnH)HqSA4uFEcBmNY*ZIN=~y~r zYIFxXQ5h%BQ3snr>L_8a*~QL+=uQjYsmzln9?!7N4QD-Rqh@!hQVz_}aWZc;h(QM> z_-Rf@l;_8qiQJ4w4yk7>yim^0T}wP-yz$Mr-i#g?`SX<}b~m+|3-^8{xs4rsz&tD! z+O3vFB)&F+vwn^MJ%(m$n|^lFhQ`%rw<0EA*G<&dJX^r#I#9&HPBA`53Qu?$O_@$o zw`@+kLzugq*ZsMyqK>vpkJwG!nP(nQ=ioO#YaguWl%7}YFvxJ2QakHeJmZU|#cpy$ z4DPoLg@!g_4_1DbBwP5(0!CPSD3DsivAmmqHfKrYYyIrEW#B(~sAe(QqP5%5FlJ1C z69>FK3X^#|LAhiNxTBGPfAt#L8n^4a(KdTCeET541Z^` zxzeA?{WP_UId+9=RM!`skUez{CPV9Zk$lw&=KzNi~IkcT4acX64>!0gf5fS=cwekh}1NsUh zr?Hp>%9&evXBLk(A`HjBlPm75R!oA-OE$-Lx0SK!;CtSa%Fqt$*Hl=HVH*LkU!@`e zqeaWMt8m$%hoof15uy$B!e8%{%sTwP1p^8vv_C4q<|8T47SvAgnzOnN9i0F)%I-p; H)phV!UL!M7 literal 1993 zcmcJQZB&wJ8h}AzWNci?adSpZtuwf>j^dhTT2M@1;!!dLDJ`)&Ca#Gg`7ui7P}7dN zX>0jC29^x^8jy{s;1`pVw4z2SIwgpXn;#gMHq?p=`_}G{rayDeo-@xm*L`2_InR&h zx$oybZ$T9CfP=lOJp=-AAcXBDK_E~b=yHTD7&B51d<~{gq9VxqtX3d_+Lq@0!4k!*y7ITQ+XYEPH7SEqjT^$A zN;{7fF8!eNZG>2N1?M+1`2@aKew&8j5_tB1DoDrfp;nRYZ4d)+AC1JjlmoH3_8YL; zwTw|)FX(o>$aQxD3HkpZ&%I9S+Xrd$*k^L81F!Hd>;|65d^?WZ`ct<|mYzm8cUmdT zxJjU$E%8!2&cz&)bpI(N_h1Ab@G*~e(6l$ctTj_DTz~+L{EfqHf@zaV( zhm*v$Z=a5nUD!h25#=wbp&kNhEtZla`Tn@iY3Jq~xy&8#TaLj`+K2s4eDjU~nHc^lb8)oQ+To$NkYlh+lovcL1h!Lp8`b0ukU@ZXMpC{JcUKHMDv z*8eD@H4ug@bA}t$bi>v_i@5~Di{`K_r5Yd4{oiKD*kpH`kZWyL;GYa(^ zR;W~}(SbEK(mMH?QLbGR%TCTib(_OXdt|1*H0$Au*uPj_Hn}YMay%4mNK@!*%!^Jw z4N&lL*>w8H;v*__jy|z%VUZPnWfP%SXG$Kdp8QHFUtFfT1g2DWMJlEOgPR56;>>NQ zFZt$r!~qrelY=Q+vz|IYrdWJ~HEH@0(UTC=ukgwx`&7KAeHj-s8k{{0XbQlfdD{kH4s-0_=?g8Euie?;DERW=k5!zo#<7$MPMSgVg^y%BCyn;qJ z_6g7uEWA>r&{&qR^@BH`xo*ptwVagR$IuKRr;8Z(yqVF7HQ}15A9`u5$=tt-&rSc7 z)M$e*d>g}*bcNqAODDMjgF!Sz5lGfzM__#D=bi87{cG4DL>E30wW*qsTp4@C~A zt+sQ_N;j0TfM>?#?;)u=me#BRK7ZIs@3iy9Fp`k+lsevb&u{m|q)ZbE8gm|C5eZz@ zI{(B+0g)bj`iXwAv^Fz%M95|7?)39&|2F3&kM4>`%9X1Z)ZuuD_>3q3x@wO`OrVGq r?|j-OI27jn9@78^td9sP_gwTme2hP)>+gK?(}ocC5%-F|NZ|YjO4EJQ diff --git a/docs/html/classkiwi_1_1engine_1_1_delay-members.html b/docs/html/classkiwi_1_1engine_1_1_delay-members.html index d40baa56..e7c197e2 100644 --- a/docs/html/classkiwi_1_1engine_1_1_delay-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_delay-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    - + - - - - + +
    @@ -70,25 +97,39 @@

    This is the complete list of members for kiwi::engine::Delay, including all inherited members.

    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    Delay(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::Delay)kiwi::engine::Delay
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::Delayvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Delay() (defined in kiwi::engine::Delay)kiwi::engine::Delay
    bang() (defined in kiwi::engine::Delay)kiwi::engine::Delay
    create(model::Object const &object, Patcher &patcher) (defined in kiwi::engine::Delay)kiwi::engine::Delaystatic
    declare() (defined in kiwi::engine::Delay)kiwi::engine::Delaystatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    Delay(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Delay)kiwi::engine::Delay
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Delayvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Delay() (defined in kiwi::engine::Delay)kiwi::engine::Delay
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_delay.html b/docs/html/classkiwi_1_1engine_1_1_delay.html index 59ce642f..4f8e68c8 100644 --- a/docs/html/classkiwi_1_1engine_1_1_delay.html +++ b/docs/html/classkiwi_1_1engine_1_1_delay.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Delay Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    -Classes | Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::Delay Class Referencefinal
    @@ -76,69 +103,114 @@
    -kiwi::engine::Object +kiwi::engine::Object +kiwi::model::Object::Listener
    - - - - - + + + + + + + - - - - - + + + + + + +

    Public Member Functions

    - Delay (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    + Delay (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &object, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     

    Member Function Documentation

    - -

    ◆ receive()

    - +
    @@ -154,7 +226,7 @@

    - + @@ -171,22 +243,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Delay.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_delay.png b/docs/html/classkiwi_1_1engine_1_1_delay.png index 3d14dcad0f8e558eb09896a8e92f5d5315f26e1b..670eeb8733711ac9052b0d47fa6be256e01b7c6f 100644 GIT binary patch literal 990 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GVq6Q>_+ zNZrtwGbMJ##U5(`d+SZC^`4qbe>+cFvRio8q$jQ!UX#REKTEL7?Nu?==v{W(;NQ$u zcUiKJZae%ih}YM1my36C=$o@wuU2^%Yn?XwnU{B}H+aV<)$*D9Or1>3)?e09u3PoF zR`%@H#F=M#G{oFCpIBR7JoDJORoPSjZkyt|d6o6MU2h|6XU|>xY*Xs(ol6c*`Iahv z_E<;UgYsmpvv-&6Uq93MS;Xd7m%SD~t(Yr1n4@xGCK&1@&PQnMeadYc7rg>@Jm7k zmi_HpzIU0X=lqRY-_-s@07H)JXC80Bx|4jt!S8IsXRJ%xR(a)C;;tL#CT)2b0}8V2 znR-hX?VBN=XbF%byZ;jo!)hGLBt%>wsyZc|5&(0BzJ*%3zYgX!>!#87| zpZ&jKL2>$EcgCA&s!h%o1B-sFv+L#`_pH;UQYTVOM`%VX25g!Zz97E>xG;T zTr-#|3fIlNoxA?A;M{9-)`zPzt||%@exST8^GrT}A$J*N3S5yxDAHtgR59a=BFEyJ>&|wm^6mD{{@a!o%Xs0b@!2_IvA(lST`%)Q zz4POL_0@NN-Za_ummX-$`n`E4|Kry7M_)x&z5FpZXV=V!+_OTNLc2p&W*OC9j+xtF zb$R_9pYPi*-1q(FZ@T^{Yr^4H$9Wgm+;3x;zQgE5cwjzH%N&SHq`nRVEJXZv%0 YzU|I_=1+cj0y86nr>mdKI;Vst09}FJzyJUM delta 539 zcmcb|ev(D8Gr-TCmrII^fq{Y7)59eQNLK)H00%RWeCq1Bd!nLMJ>v~e7srqa#TnEKPV}E-g;0;DR_(An=9Mp z1O;DaTD+boFM8pKEVF2Y%M;_&7b_CjW#&y0uC5d=R0-n^HvAzGuyEC_iBp-KCO3)h zcu=HozfhBTTj1$y57hRXu+6DIw_@Ez?>C}3<##$?%YNmw_?61xS0>fuUH4t~`H3Ib zZy&wscdq=-jXj3buQpiNWj%eh`u&bg(@tvr+p=!mvdQKA71ysGx87S>y!WHOJy)%K zO_^m!N60Vh4LkK+T>MOV?%H<)o%>~K!u!4P3Jtfb7}i|S`tW#T#~!XfPu3~wGuPKI zTx~9q&}Sx*(1jg8*fgg&ueE>y=y8VNFY*UAF1}v4Z`r||EpJ|LkmC6;(MdA&wUC9) ze&#?`^}I)xLZ{nSO4RVIxbSE0B%k%%dOPl%_Rl!gkb7kl_l=%a%UG8?ugaRT)y#K) z67x3Z{Kmq?iERmQmotTVu3UcKqxj0g$>(lLJjpr!);e!{R?OvDr?VVt3a_j>q`G0_ zG*9DgAwW-`-5DJ|`|92OJMGTxVqSNRufX@4)9%1S_c|G-hg25)*J1Lx5Z*MmIIppe ZVb@K`Z3^!n - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    - + - - - - + +
    @@ -71,34 +98,55 @@ - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    DelaySimpleTilde(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTilde
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTilde
    performDelay(dsp::Buffer const &input, dsp::Buffer &output) noexceptkiwi::engine::DelaySimpleTilde
    post(std::string const &text) constkiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::DelaySimpleTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args) override finalkiwi::engine::DelaySimpleTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) constkiwi::engine::Objectprotected
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTildestatic
    declare() (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    DelaySimpleTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTilde
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    load() (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTilde
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTilde
    performDelay(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::DelaySimpleTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::DelaySimpleTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    startTimer(duration_t period)kiwi::tool::Scheduler< Clock >::Timer
    stopTimer()kiwi::tool::Scheduler< Clock >::Timer
    store(std::shared_ptr< CircularBuffer > new_buffer) (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTilde
    Timer(Scheduler &scheduler)kiwi::tool::Scheduler< Clock >::Timer
    timerCallBack() override finalkiwi::engine::DelaySimpleTildevirtual
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~DelaySimpleTilde() (defined in kiwi::engine::DelaySimpleTilde)kiwi::engine::DelaySimpleTilde
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Timer()kiwi::tool::Scheduler< Clock >::Timer
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_delay_simple_tilde.html b/docs/html/classkiwi_1_1engine_1_1_delay_simple_tilde.html index b3fe38b9..80e77c15 100644 --- a/docs/html/classkiwi_1_1engine_1_1_delay_simple_tilde.html +++ b/docs/html/classkiwi_1_1engine_1_1_delay_simple_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::DelaySimpleTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    +Classes | Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::DelaySimpleTilde Class Reference
    @@ -75,147 +104,177 @@
    -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor +kiwi::engine::AudioObject +kiwi::tool::Scheduler< Clock >::Timer +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener
    - - - - - - + + + + + - + + + + + + + + - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - DelaySimpleTilde (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +
    + DelaySimpleTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void performDelay (dsp::Buffer const &input, dsp::Buffer &output) noexcept
    +void performDelay (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    +void timerCallBack () override final
     The pure virtual call back function.
     
    +void store (std::shared_ptr< CircularBuffer > new_buffer)
     
    +std::shared_ptr< CircularBuffer > load ()
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    - Public Member Functions inherited from kiwi::tool::Scheduler< Clock >::Timer
     Timer (Scheduler &scheduler)
     Constructor. More...
     
     ~Timer ()
     Destructor. More...
     
    void startTimer (duration_t period)
     Starts the timer. More...
     
    void stopTimer ()
     Stops the timer. More...
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     

    Member Function Documentation

    - -

    ◆ performDelay()

    - -
    -
    - - - - - -
    - - - - - - - - - - - - - - - - - - -
    void kiwi::engine::DelaySimpleTilde::performDelay (dsp::Buffer const & input,
    dsp::Buffer & output 
    )
    -     		-noexcept
    -
    -

    Durty solution to synchronize circular buffer. Should be implemented as an atomic shared pointer and a release pool https://www.youtube.com/watch?v=boPEO2auJj4 48'

    - -
    -
    - -

    ◆ prepare()

    - +
    @@ -250,9 +309,7 @@

    -

    ◆ receive()

    - +

    @@ -268,7 +325,7 @@

    - + @@ -285,22 +342,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_delay_simple_tilde.png b/docs/html/classkiwi_1_1engine_1_1_delay_simple_tilde.png index 2bb8c822d6245cb8313f2552f95696337ba7edad..ebf98e3d2678071e0611229c75df414d71e95b9e 100644 GIT binary patch literal 2572 zcmb`J2~ZPR9>x(j3Me?PC?XJ?nQ(0!BFG^urvt_gks#=_ga||opkRP-43ZdBlwH&z z+8AWGg2MpI2#Ls{+#m}`Fd`s=oMH&a5D*itD3I;2>ugQ!RP9vlc2#%3ey`v4z2E

    a&13z9qnih5v}UW43SPZ zakf#mSJ(jpC^b zWZm;!7+}#Do_HJ=)z%oLWed~+pOj+`vpF7lq|3Ro&Cv$Hnw3aR7ypZpA~nqyusq6f zBwp{d_GM+?6l>$0OL_{mn+AN^lo4Wu`g+4BOuTb0ol;~IzW=lcztp{h_Hbg+5Neah z{&S`NPd~khu2fJViRXXDyb=OsvR<)KHu@qQr0cvsPgL6$Pk8Fv@1Vo?!?`tkc|v}k zY@`C!wkHF`yyF=9Z-3+%3KdCCfwr<@#~!R{{BjK-vGf(NQ8HwLkXfbIEY8n0A~+WOz|TRS)bDWC=UeF z?ITkKKcQJg8TONMA^)J(QhhnG1jH;(^P|$>zOXaSIx=F2(ctQ7& zH)0@0(niwjHr`M|dT4$ZzH2vOMm~BJfG`qUSoi|jlhBpXzZh?j0v2Jkd<>u>GJb#P*KUn=m=3Q*?jh6L6XlF0)%t}V?6sR z+oTZ{)L|FHwp}c;LxupmjAhlD#aF`m98HxG;P`VVqV(vyu zpSDP9-eRUrW#$%lnLlrmwnokQiTMX>n;wlm&T2`VD)i1DgH%Jv9X7;4|8LKw;FB%E zMbDFiXHKq0-0r0jJLWpi-ioLgsVHb^X-lltX7-R~#kI_y>V-F=f&J+ZFXWzmvC`V#U6CS#xC} z)jFI2`xzgi^Yp}8)#jLl0s4#6UL3lmx(|AUmE@x{slyfL&8dQ~&~1T#oarZMF~5G` zYUXCzEp%PXS!~X{n-Bxaj$B9`@JQ7Gk>r5+FU7v+^uq?Du1+{{QYby_Voj=>eI<}F zSa$J)%QUc0zho$`cN2*k3y(TMPK1}an<42TK&J7wuexC4+QECrm$(9uV*v?(EZsf8 zY&rljIF88sFcmg(d@35ISK(s6ZE$c%#2sEEXg_%!o8T3>wsq7+c3@zspn47BcKO1|mh*n8@uA&*PYn1g8 zj{khcj`Qp2u`*g<-m9%~lCZRS(HTburiO*yk%prko>qDxZ~4N+CWACD*duih6vkWe z{fg9J_k3p7F2Uxm2!2wSr|$kjI(^o@jywDR=LEYs2pD4K|sQhCJ++jib%miksC@l9ST9J5Q-#< zK;^Q54+x4t4B;BkVuOel!zCmjd`1yO5<^Hh(obz?TBmlpGrRkC_U-Px_j~`%z~fG! zG_*AU06<~wF)jdrh=A?$tC8^7otpg`o;Ks1h_)(~3O1il$)f4)*|7Dlx3#sc%ox^% zm#d>(aIOIC^tK83#JvEpG6;(~MvO&F7Y;H@53U6+JS|vM8H%FZgKwq1DdFl(7OVMv zH5sVa*(M?mMEg2;soCjc9NSnRd|`_64}}g#$=Q}qmmZkLM1QtnSh>C!s%DZ zZf(Y|Vh2KZBX~b$AlyeWekB-1mZog> zpqc4%XrniaHLC5<@!be|FZa5vR`SDe=LXQwot>G}Cn2h`bZ}+K9#m|D-d-IWQlw2h zxV4egGD*RK=}q9Gkvv+cPk(W?%5^F#JeSOhyK@q9)o_eYS3Dl9A}Q>KbvH6yxx4pO zTNXzD=*%*(mtCRYt@SvSO~P~w#^q&|1J!MUv@yv>F^_TcRjh~nhsH#Gd@GOU&dMeo zJ6ZP3MrPr#I6BTl@ict0y+nCYi_??&sGlug(*MF@HeuFgXbLwAy` zI^+?A#7q$>Nhx)Jz}EKpj0$UU{?~bYHyZ^S0zZSD@h;pTqdyt&y{RJk(%tf0ISgp+ zxg$^2!%ptXOEg|}ejtPu zU?C8GM1U6({wf%e_XyY0Y+R@UZ&!y2m~uC^(xy>>pH`h2iQku$BkA1pTX{FCOCsF+ zJZ@M!rIR){{%zTVM^YpIMy{`ioWhE!laqWfJ!I+Zeg-|@Mem85R|XqI^=bvg}K|J$L@r;aSPEz563w}(XYbLeQmaEX|0S&4J{*F(3(CWX3OwR10ZlNO?1Cjt*!?Qm0j@>2VN=0me11w}8cY?5v#F{nF zT85H!QC&R9u9YRKse zW{|TEVt-c>i>MiPRMCdOMLyiYKrYsND4?#LGmUKCW+3@qa{kJ2o$X&%-G+Z+0BeiG Ju#cZg`2%s<>DmAQ diff --git a/docs/html/classkiwi_1_1engine_1_1_different-members.html b/docs/html/classkiwi_1_1engine_1_1_different-members.html new file mode 100644 index 00000000..d4c4e488 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_different-members.html @@ -0,0 +1,138 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +

    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Different Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Different, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Different)kiwi::engine::Differentvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Different)kiwi::engine::Differentstatic
    declare() (defined in kiwi::engine::Different)kiwi::engine::Differentstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    Different(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Different)kiwi::engine::Different
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_different.html b/docs/html/classkiwi_1_1engine_1_1_different.html new file mode 100644 index 00000000..15df89c7 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_different.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::Different Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Different Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Different:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Different (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Different.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Different.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_different.png b/docs/html/classkiwi_1_1engine_1_1_different.png new file mode 100644 index 0000000000000000000000000000000000000000..3ba7a655d8400b84ba309c51991b67a1fba2f1e1 GIT binary patch literal 1316 zcmcJPe^8PK7{^~tOFgyJ>)hH8OHpHHq`uUp`6JP>S3?a*Ze?n9AS7B1HJPT>R-7}h zMlSP3bfr+4;F$`CSaMk_!dFc~bA;FmmHau;WvMXi_DBD0|LwVZe%MO`jy~A;(%Q7Hc^+F`s+!{v~Vm!4(RHeaQXLj>j7YftaMoL)3JBLm}Z z)jhpcfi=VL)*+8`fXHYMMQN|yj5lc0?mz%A|K2Weu%tMn`4Y-F^`j8Qc7wUEABG{y z!rwPQZ-SWokqYDSv6BXA1e%*yU16%jB4UdzLyWPV{=2r|?DLv8S2|K0+Q;c!?y zv9kd2mg*;|vhttaA1feJFEaJFzat|w{Sb7}S6ZbJFR2f^nbVi6ec%*Xl zV#iDfB3SDB8QpAH=)w*jVm#pwIH@&V$*m*1Bi|ZoQw_KeqM zbM%3jA?bX?E6U%T)i&w#J|uOZ!TlzDTrbI8-oBRkT7nYeUx1#Y*>h(o}o$RWbFBVL|011u#zoS%YVy&>1Utsf|xf zZ@h^a!S5&d-83Th$A@EBS~2b6ovxQe%IDXWc0OJ9zZ#CgI|Hpk>vzTuxQ>{oVJf{y z>K0l?n;vZNeqQ&?9vO;oSsG$~uij?kLIH2v)jv>GYbu98t-s + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::DifferentTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::DifferentTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::DifferentTilde)kiwi::engine::DifferentTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::DifferentTilde)kiwi::engine::DifferentTildestatic
    declare() (defined in kiwi::engine::DifferentTilde)kiwi::engine::DifferentTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    DifferentTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::DifferentTilde)kiwi::engine::DifferentTilde
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_different_tilde.html b/docs/html/classkiwi_1_1engine_1_1_different_tilde.html new file mode 100644 index 00000000..5d64e233 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_different_tilde.html @@ -0,0 +1,275 @@ + + + + + + +Kiwi: kiwi::engine::DifferentTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::DifferentTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::DifferentTilde:
    +
    +
    + + +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + DifferentTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DifferentTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DifferentTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_different_tilde.png b/docs/html/classkiwi_1_1engine_1_1_different_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..f9b3a8880457e20e7ae355a666edf0c7cb2db15d GIT binary patch literal 2305 zcmd5;docJ@rqo;`c^?EbO$oO|!*cfY?se)soz z+?(NpKC7ytqXL7$R8i+#ePJ+ofDCUPke7{V>P}?Y^gACbUADuYYQ5<ce;3U z@IFB5&$Y|1a@GJj+o9msblI*`Dgn~6D;+VO5rBH|2}ruQcoVbJE^^jS!!IhS!%AGu z(#U-CPc4S^vho$M1 zV5kNl1&j{~f*0e!9Gtb)mtM|dA1lx0^CzuSwEVs3)1`PXRsCjdczm#MFuLqUKzyn6 z`K8aq*xk2Df5bmxK>4roDtd5*J^n+}b(gppZBYRk0mlD9I2~Q^g}G5qcfnmj)i{u% zkHWm9a^r?tE2fT)%v)3vsFW3TJ8S;iNx_BGQ?(1!>N|*-*V^FYD>e|fC=9?QN@pU$ z?DDP*R;8r%mO%YPq`ADR6sOUm{g)li1kng3eD_9utZ?NBJ{=m=@-dJjF?%_=(D2Og z;)Y?pUFS5RX?1`Y*R+aDj%#usKBmmHF)e@9Hl+!qM9_N_>@N>B{XDknreaq|2yc=Y z`V4>)zGvN}fNkoEh@=F{6n$dH1%>2U6z`p(BlPA9e)Jd?)kh|`St9bxWK|e2T~L*r z!n!XSMWXPJ?*XJ~_usl@pNvUpL*}P1^SJGzogC%P0o7U8l8fyemDvTNLjmt@zbytn zIT@aaWSA7;nQ{-WR~`TN0$C)orqGI=n{QtBDJLlZ$8y@1Y1bglkK-{++gI}kCO6?t z0A+*>1lSP5s%h1>-kp}#5pe^IYJjwNu6e0$*U5BBXDte2z-yVE7*r44B%SX4F)HHS z@rWA_HEf~MtEP{=6feBno1B;)WI#_!N~?u&W{NA|_W3HbDsJFwFcY4y-2E2Hw&Wfs zPUPV-@dqcmS>QJT$?06f-ssyp@jg>qf5P;^cn()kf_vo4%;I2PQz@mj3jok(o?~$Empyy!R{wWMc`Rob2TyH)naSX$b1&Zetmj9 zF&1=NSho(jaksX-4RCe`p<2C;rjYCf;S3a;2nQP>pbu%IrG<0LjEGSjB)Wx6sI@JL z>oDoZnY9qw*8^lvtbJuy1EG?%?G*GsCWOXX^#(BSmx5j~#&5!yp~y?-%`3Or6jcYk ze6zSjPa!nO4SE!%;K^@!Avh))v9yVuxkg{Rc78Kqa}Gp;kkd5-p*LfnxYhG0%=cAU z2)$WdX48%zi7TVX9^L3{94X7YD(_?ebUM{QqMf~Y_!co12Jb{M=P$|7j3^nD1wJgsDaO?~rKA`440NR3mq;HuUGcD4Qr+|E_pV%p~`)Dt6lj zy!*gxHbZmP+tdAQBaA!(TF@nNS)bpcnJSc3oJ=yyDpNE&Ej{qd+JI%60SCLSQ%0LB zOSW|^4Z+KbqrO@oI6jDA|4GsQNOA6hw4cfX|_8Q3l^?K=nL1P-ZuSD4BgVhq{yD`5Bqhe~K_ vf5xf7(^AiVc;=P(;AFq3NB*_io_xyFnvOoB+Uv6W3Jm3jcD;Wl?9YD#^0#YH literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_divide-members.html b/docs/html/classkiwi_1_1engine_1_1_divide-members.html new file mode 100644 index 00000000..03ee109c --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_divide-members.html @@ -0,0 +1,138 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Divide Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Divide, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Divide)kiwi::engine::Dividevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Divide)kiwi::engine::Dividestatic
    declare() (defined in kiwi::engine::Divide)kiwi::engine::Dividestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    Divide(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Divide)kiwi::engine::Divide
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_divide.html b/docs/html/classkiwi_1_1engine_1_1_divide.html new file mode 100644 index 00000000..3d6aec15 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_divide.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::Divide Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Divide Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Divide:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Divide (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Divide.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Divide.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_divide.png b/docs/html/classkiwi_1_1engine_1_1_divide.png new file mode 100644 index 0000000000000000000000000000000000000000..df056a622eb2fe789f793cadf6698a0022b488d3 GIT binary patch literal 1299 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~S>);B7*fIbcJAv>Mv>ym2Jtkp^RYu8;g_7{fm8>KWGAtrzb+xwd(y@AY%5vZw#uw#9Yx3+s7N=XLg-Jr`E&8M$|w$&71u zZx-F$u}J*KUDMWQdN1E+KkKr*rt@rzSH@1;GiTmLI~PaW?ALeQEWgNV_g}C3XHBZj zOOk|mLFS(`VgH<2t+LX!yhI{C z?NHvmkDIQWsJ=7~J9@84KHD$%rsDjyjHhgGCQ6-}{G8AD>Ke27t$s83$~LKl&dJUz zdVTZOvcuN`<<9hPnYH`%_GXo>mRDmog}%RWYuVPncC&gb=d1s9Fb;POFV>v3?pfL1 z!+UqGn|*&Rhpg*Mi&^YT^)s`>y;m%GeBFQ7$}jKl%noG~t5?C!r>lneV-EQmR!|wo4)?(q|f>jmrUCCY|`2)_uaqFoyyzU zou(O*x^|b}q}=_N&V*jP3QUC8=eSRoeh_>%_y3!dpY4t8k=l6P>le_ATwYb&(BV*Eo~(gG&D zNBr4*hYjw?vo-7%hK6wZtja6rb{feqPzcX9w3{E>eaY0fp?`(Q{d*6Zo?WR+OZBl? z#?WgUnFLB*eO4u>f0WG-H#27Z22NX%JMRLM)|&9>;@LG~SAx%~#$N4P{qa%w0?3(3$^~$X1yeOci7~fwdn^J1RSM8NBeSdbZ+5tmw;wqo?W$W>@6Pho9 zsq0bk(%Y-H?$4CmR;g=$M@#mB(f!}f#h3R?uxyBbB!2eu8OA?C*OxHYv_mtJglT)C cMBaJ(u-@cr6HQJy0ZT9jPgg&ebxsLQ06D#X4*&oF literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_divide_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_divide_tilde-members.html new file mode 100644 index 00000000..a5cf991b --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_divide_tilde-members.html @@ -0,0 +1,147 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::DivideTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::DivideTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::DivideTilde)kiwi::engine::DivideTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::DivideTilde)kiwi::engine::DivideTildestatic
    declare() (defined in kiwi::engine::DivideTilde)kiwi::engine::DivideTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    DivideTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::DivideTilde)kiwi::engine::DivideTilde
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_divide_tilde.html b/docs/html/classkiwi_1_1engine_1_1_divide_tilde.html new file mode 100644 index 00000000..8b4cbe7a --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_divide_tilde.html @@ -0,0 +1,275 @@ + + + + + + +Kiwi: kiwi::engine::DivideTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::DivideTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::DivideTilde:
    +
    +
    + + +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + DivideTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DivideTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_DivideTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_divide_tilde.png b/docs/html/classkiwi_1_1engine_1_1_divide_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..558ea385afc31a85a8d8e0e1c655335d4f0414e4 GIT binary patch literal 2275 zcmb_edr(tX9=^avQHo%ds^DXVAPNE^N&&@3A=IEE5EAf4BH$}Rc(f1%1rw1c-w>ADA)$g}zwq3ReEJ^ibl5XeO_42UJhESlVq$KOEj({reeG}R zZ}09sy@Im=+_j>LyRVZrJR?|$23#?gSe7f-g^^9Zjo#O8ijBCBXN+bM0==TsjTs%j zoSm7}$=ds5@l($-O4+^+6xT(x6$DKl5MzP@9&;s)djmG)w|` z6fu>_thaBfQY1zGqfn$@PJIHeb$4N*4EC1e6rP?}4NBbu@fCgHosT|Fgh!u;2EHP3 zd`1%4F+@z@Kr&QEdV;&?Ft>GFAld4u2!y)09+JpYYt3aL>)Py_*3au; z&Q1QKT4bMKfdd40g7z7rwl^w&8NDh_V(N$O9m!N(RzjK;ver#6qu>VIRh?%uM!BrzV<)2d2eiH zUS-!CeFgh5+y!EM72Js>U`1`;ux;X@zWzb2!~#r+kYBJYwL6J! z$Dv-R5FSplv!p4b44a74)6sq*zm)P?Uozu2m-=nS9gZn)CJ&w|(G)E-ze+AcR zZP!u5cKt?v5%7UOQ5BA0o^^+xGUo5bkh7;x~gB;Td!H&@EDf<9%(W*l#1l!m*cim=dXh zqbM4~MsLb}KEvP&YvdnENC_@v@LWW!FF&QpqH-=lF@2L;PTb=m6&p|s4b!k)ZE`n+ zt6o{v+d2rNRmlY4>&cTjFXY%E0|=lU^7!h1(|P$6mPO+l>HRa!7LL?*Rw%E~E_f5+4sAu98ZWSfF5&JbHo zvbcrc}GuJr0~_-PZK zbOMp{D%|p0=s6nc18fe;pIKsSjljZFme_417(O0PN6#58`r4=Rk;Q>CNQO4kLuAWz zfhg6IIf`@xiM99=Zn^c=b1}l#w*4}Le;E$%Gb{Fwku*; z)sh1b>t`K9!O)bu3xrop@!oyE=kz@1ToYoUC6Kp-a^~DWJh_Pyu;1V7)&sbWeW0|M z`urOv*o5XuK9+3KiMtN6pIy4<*spXO8Z=F#U;f=8v5x&mcXA8to1AOZ7+3TF>hv@+Dm1L7-i&^C5%Bd( z0n&ZFew`mZ|Frx5an%-o>m#MIbn1$1>wn7o%zmmFwV;DS+@}|W_+D%)ixA+j+_Fk6rIZQ!R@u~R6D4= zdALYoy{>~VIzyEARBFm1#A2>RI=J};hHQRTkN<@1Q&G|gQr{bc@q4&M)Mk&PP}ry? z(T1CzeQI1ca{sN1)h;`URu|%55Afv8HzxStMKhzT^!)5K%omvE&sg1wXWbr_()^+1GJ~K Y3hu*<9sT$<$c+TRVqBd#-}uJ<3;9cB^Z)<= literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_equal-members.html b/docs/html/classkiwi_1_1engine_1_1_equal-members.html new file mode 100644 index 00000000..cf21a402 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_equal-members.html @@ -0,0 +1,138 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Equal Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Equal, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Equal)kiwi::engine::Equalvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Equal)kiwi::engine::Equalstatic
    declare() (defined in kiwi::engine::Equal)kiwi::engine::Equalstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    Equal(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Equal)kiwi::engine::Equal
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_equal.html b/docs/html/classkiwi_1_1engine_1_1_equal.html new file mode 100644 index 00000000..df708b8e --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_equal.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::Equal Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Equal Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Equal:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Equal (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Equal.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Equal.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_equal.png b/docs/html/classkiwi_1_1engine_1_1_equal.png new file mode 100644 index 0000000000000000000000000000000000000000..e14da8596960c919834ed875ae954185797293b2 GIT binary patch literal 1303 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~S?1~D7*fIbcJA9ro3#YkZnv+x^Iugy zT!fAF`ktA#tG7EQIPXOAwOz4l1k z`u_IKkzCvE`7~!Gnyil58GZRuS*UL0w@mNZX_L$2O5-Wo%UNYP58V2?Mv&MQG9lppMJ}>w~1NTmiMK-wW-%X`>dkt+iL5+FV4QkW$wlH zH`8amy=UX{>u2}ecW2*=)rvb@D)CtCVa|R~Z2n%4^^FG$mVGmoJD#Fr-ZKCRAsKj*E_^tzNTax}1A zK3gwSTJio=&Qq2*6E#mwz0MPS^~<(xTB6gs*Xnp$@4LRH=;^v8PlJqabys?>uFQzn zpLFGU^x534-;}?#z2vQ*bJlO~dGWt4#_mT0in(VkOv`=0!Q6ZQ&)c&XZjQ8?e|GYP z=^>Y|3S>$C=oP=~^6UJYv#|`O$ya9ND%XbZIr@3kt==!C<(@(O*MT9!chmfQviaG~ zi=!u%{h9WxoPCSRXMi(^YXe@Qw8Puj!b>-i}O(54QGIDVt?u7P-u0P!FIV^bywyE_e$HgsX^Ubi&l-gK=KE&meJPEvzZIyL6}Gb| zJVCZHxLXnERex+xkhOS@goYtKQ!7-1Kt3NpT2| zY3>CX)9aUVnQK->9zTEo9uIH&=H2GAgOtC`e75gr#YO(vm)fE;FTVd+d{(Vt7T@Vj zYahRVeBj)jZLE9~_uYG5Gh5r!y5?W&I+;!KvPb4;&s%%7*JSqPm`QAZwk=cnYXVAH zEz49Y4YQX`x%8It!!y=``gsd~R@olntg;xX2*kqK;Z|<=XModin$bi)F*e+^Yn9(n?8M z{h$9CwNv90823jPgg&ebxsLQ02YpPvH$=8 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_equal_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_equal_tilde-members.html new file mode 100644 index 00000000..9797c4ba --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_equal_tilde-members.html @@ -0,0 +1,147 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + + +
    +
    +
    kiwi::engine::EqualTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::EqualTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::EqualTilde)kiwi::engine::EqualTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::EqualTilde)kiwi::engine::EqualTildestatic
    declare() (defined in kiwi::engine::EqualTilde)kiwi::engine::EqualTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    EqualTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::EqualTilde)kiwi::engine::EqualTilde
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_equal_tilde.html b/docs/html/classkiwi_1_1engine_1_1_equal_tilde.html new file mode 100644 index 00000000..c8b368ca --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_equal_tilde.html @@ -0,0 +1,275 @@ + + + + + + +Kiwi: kiwi::engine::EqualTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::EqualTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::EqualTilde:
    +
    +
    + + +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + EqualTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_EqualTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_EqualTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_equal_tilde.png b/docs/html/classkiwi_1_1engine_1_1_equal_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..2b8fdaee2950bce59fe590680b4481f4919f4a7e GIT binary patch literal 2286 zcmb_edr(tX9!_{Fm104}g2+mfW(ARI8?At-JiRCp2?Aa~rHDczff^H`0g86OvN5Ct z0V@Q2P+rO9l>~(Fh&m0nSRoKDukcVRk%WhcKp;RiII}zJc6N4lx@YE```vr)ALsnO z$2sYKIB#PkOCtmVVGJDc@JAq!fm*Cur>h-PHoE3%A6xv61$b&S8ZCS^F-KuO`az4{ zb&*J8Ay2$cNYtnQsBxx2A`F}gja%D$lqnssn0QKHU)`SNK)wdslE0(w+sOZ$r zQ>m1Nmh$M`BI#!)y=;XJh#uca1TjB_M8psp`EcuQ!p9W_Veaw>=MPJ^|2`8F`N5E| zBwXyAeEYhRT8Fb9jp{azG{?Z;Ib2Zt=nVI`0FPgZaq)tD2a;d8)GW?lPCO5d+Pi#9 zE#qX&b$wM=A*&WtTP%D59xv1z>TwDvO@e%%g1=aHd77VU4m(85+`Vkm4-JIGt=7gy zhoy7Jnp5D#wz?9*Z;;@-vJKYHES%SmnSy!O&=mT8>6{`&&{q&U75psExuC(KK78V@ z_puA?Fb?X+9qM3KvM1k5IZVKUj6mRx8N@n=0nxwU_&%(6CBaDhwMCjiBs%X)L5!e4 zq)bMdF*^I{8i2(1DY;SlDqUN15st6Zn;wX8mKdGIfXE3C`xJJRew7)7px*m)lWxNc zD{^wf+&t^;xKvyDuJk~l=DlSGfkFk3lv#w`OB1Tkm{)y2U^9OQw%~*nj$VjV^Nx1X zwszS8EfM|=*gGdUD5&Oc_hNplz%@hiBo4ds)V-~$%DZRd^2Jg&j-=p|hvKY3se7PkALky-E_$?KL{-399NRZ`6L%p%IrF&!%odww7s;u)4^rJ!Oi z@y|gw>fY9~^)|1csJx^cB3RT@&M4_JJ0NdsNB_-~^Ka*&Qic1#fz2J&*J_awGP-G8 zfOcC-lph4m4eTt>SF}gdk90a!@_jnP=Sx@t8T;IZJL~}Ocrq3E#v~8!aZD?^q&0)} zopLpc-!5#QYtk~%{uwd5=pg!ERkCKBDNx-!eXziXs3ojbcVx^U&K6fQ6r~?W7P8xv z0Bi*zNK+h_?4B&{J`lN@a&zZ@SBsn~9K`917T&yMn!L97pGEab-K4Bnn0fHtivk$@de8w@c( zGb^^M`Z`E&ykwgWF#L=2EX6BoGQr!q1-2zO+|Fn%`+{Gh@XmC?a#IjO4yKYw)@)ZwG;UnDUwiw(0e>L0u6aY9>iZ4&@n1)pb1${Rz8* zYQVjTB+OM%NieD~>JR!IKJ}2Wtv(q#8WXFGZ<_H5PA~9TzV-Q(_2jzILyVp*EhUfn zRz9rNgO1{*%}~tq+@j%+AUu?dGOH9X6{G$FXukhL#NCCPr`1fuk%4-o9s(mV8X2R~ zgAkvu0TT8!veCm{WV5mCPh0puC&Q9fF*Yf9$8e57hicW zE^kPb&N76QElnTK%0T+lae|Wp2JcQQPreBfyPT6_u5bOVr-f*pfP{D#INLbA!NFW} z2P)A%Zaz>7O-kvzE6XXRZh4^6Rv=xPur_;i81j8CJY*UlDy7typ+bZdY~9|b>?hv| z=ls#c#r_JFEFrw)Tz!orGrB2|#5U)8iQZb~f`d}_H%vz5^Z~;1Y3YHfq<9WUgxV#o zt6lGyn=VB;>^J=cFjN^plj9+7vE2{^`G)4Oc3dRr0D8tNQ#>b7+c(1-bz??&R(d zI^sTpJjX6$t(o}fsN>yC|5)(}&{`7Z;Lf#cOoRJoVXN5f7p8baMed}SZ}0m;bae|r zj3Iau!-^ErKGaof$jWod9~k-iM317l;o>Cx^AiR_DMxc6AIov3x8!i2tENHb zWFO3URrW*fQkcddVnO8CL%ynnduzYA;Yp>>j@%H&LKX^#H{kfXhvAOKICM}^zjYkvo5A9OeX literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_error_box-members.html b/docs/html/classkiwi_1_1engine_1_1_error_box-members.html index c07e84c0..5e5b9945 100644 --- a/docs/html/classkiwi_1_1engine_1_1_error_box-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_error_box-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -71,32 +98,45 @@ - - - - - + + + + + + + + + + + - + + + - + - + - + + + + + - - + + - - + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    error(std::string const &text) constkiwi::engine::Objectprotected
    ErrorBox(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::ErrorBox)kiwi::engine::ErrorBox
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    create(model::Object const &object, Patcher &patcher) (defined in kiwi::engine::ErrorBox)kiwi::engine::ErrorBoxstatic
    declare() (defined in kiwi::engine::ErrorBox)kiwi::engine::ErrorBoxstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    ErrorBox(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::ErrorBox)kiwi::engine::ErrorBox
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::ErrorBoxvirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::ErrorBoxvirtual
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::ErrorBoxvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) constkiwi::engine::Objectprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_error_box.html b/docs/html/classkiwi_1_1engine_1_1_error_box.html index 841fc702..123ee2e7 100644 --- a/docs/html/classkiwi_1_1engine_1_1_error_box.html +++ b/docs/html/classkiwi_1_1engine_1_1_error_box.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::ErrorBox Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::ErrorBox Class Reference
    @@ -75,105 +103,147 @@
    -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener
    - - - - - + + + + + - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + + +

    Public Member Functions

    - ErrorBox (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    + ErrorBox (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &object, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     

    Member Function Documentation

    - -

    ◆ prepare()

    - +
    @@ -208,9 +278,7 @@

    -

    ◆ receive()

    - +

    @@ -226,7 +294,7 @@

    - + @@ -243,22 +311,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ErrorBox.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_ErrorBox.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_error_box.png b/docs/html/classkiwi_1_1engine_1_1_error_box.png index adc4259253895b58c25af3ae21973eb31921e944..8d8152e672c8dcd96be504199d8356ee27f1ddc4 100644 GIT binary patch literal 1828 zcmcIleN>WH9DdPUW?4&DISs81jz_CiTAGmbrRl55RD>EX%~NNg1oRw@$!%o(#&w%ly53bSXiKqq zFsUvF-9l5^cX<-8uz7wl{<-b71Z7T`vF@pp*oR>*dvm)_)Ajl+JXbV4*|O(vRVF{Dbv5o*qWezFziG9n z&bhOS%%gO74jk#|rMk86;x{>`_uZ_BeONA-$MK0OQ_|!OZQS;ktv~t+*?VC*C|D~` ze;vQ{4e8z6#yD292qyk=?y_qR2fcesT8(S1N?Mv(R&44$L_zGLJI zcLzb03k0|=!Os3?!ANw>IudIC&abA%fzl=aR#TfjDvoRbDlY{q>OQje^kd!CkI1F$ zYz%Zw*U&HVUDNy6Qd18P$98#w>HO$9N{(9r^Zqy;QOU3jF5#ro44??tHZ9Y*@q=`PhKIEvb&kq&u$%kdAE{@@_LGF4>A+f+cN+GQCh8{uTddrrcCATDazFE^yC%T+;|oM&zd+?~auwsN(%kGOIms9J0? zwHaQg9+)jV-}8X#Kcel_wr)$V1v5we825^64u#uaed0h(`}`br5cg|LqU`)cVLexM zN9{ekgRIx9V69!^vTv8q5^HG8D)zPf8IL{#G0v6ZA*|QUOA<1&}T|?pvDwbPn>R N0bn38K)88V#_!{;h9Cd{ literal 1382 zcmeAS@N?(olHy`uVBq!ia0y~yV6*|UJ2;qur0@6TkAaj#fKQ0)|NsAi%olIImi8Z- z0AzvjfddCvJMYK?xf~@ye!&btMIdnXREQA+1It%W7srqa#Iu zX!f-9YI*FUUB}XL%m0S(ioM+ySEKRXvE}vOfBk9oN~_o_75u-Nx)nyt?$huuoyuGJ ze$MTAdv2Sa*2{D{bJcgw)LkStmejE?q6_g zlWx95+PlQ^GgU{9o{G-=ercPn$U~cXzc}L9F73Hu5;RwM(slL?n(OT*hd=dw|9|bC zR|_KMv}k{NR~UZVOeg=;DT@%h_RTZ_*j)8CxT=6k$sf0=K%dTF$+${NMwwW+t)9{w?5&s+}i zn`No#_7ihM#dA&t+n%}hDsXP$j+f4rtK2J;EUv0o#NIo%DQxcKPgh>9Dq8)@?)dC~ zZ8lf!ALM=t`QL^V)}WwYy(h@aQh6$vWXONaRFHR0I_VU1N8!#n_wH3X`&2R*u4|lo z7s5<5N@QU1tYmNul5?0agwQ1_e!i1&>qA z9E7=l=71cd%8(-UqqG0b{1g(uB)a74 zKl`rRQXh?<-d&d%wY9l!WsLW)&iku=9sAx?cF?Tq*tKN+%LT~?H;Dbe-*(T=``(hA z8maZSbG0(^r&hhqiO4oP5zTX9%MXpp!&RBfOx`Wts=19d_wn6p{HynQ#?>Fmei3A_I+^ynKZ(8kE-dVJx^3&*-00KMwoFVdQ&MBb@0CK^Zi2wiq diff --git a/docs/html/classkiwi_1_1engine_1_1_factory-members.html b/docs/html/classkiwi_1_1engine_1_1_factory-members.html index bb603373..2e3ec6e9 100644 --- a/docs/html/classkiwi_1_1engine_1_1_factory-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_factory-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    - + - - - - + +
    @@ -69,15 +96,16 @@

    This is the complete list of members for kiwi::engine::Factory, including all inherited members.

    - + - + +
    add(std::string const &name)kiwi::engine::Factoryinlinestatic
    add(std::string const &name, ctor_fn_t create_method)kiwi::engine::Factoryinlinestatic
    create(Patcher &patcher, model::Object const &model)kiwi::engine::Factorystatic
    has(std::string const &name)kiwi::engine::Factorystatic
    ctor_fn_t typedef (defined in kiwi::engine::Factory)kiwi::engine::Factory
    has(std::string const &name)kiwi::engine::Factorystatic
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_factory.html b/docs/html/classkiwi_1_1engine_1_1_factory.html index 99c6db42..ad0e0ac4 100644 --- a/docs/html/classkiwi_1_1engine_1_1_factory.html +++ b/docs/html/classkiwi_1_1engine_1_1_factory.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Factory Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    +Public Types | Static Public Member Functions | List of all members
    @@ -75,12 +103,18 @@

    #include <KiwiEngine_Factory.h>

    + + + +

    +Public Types

    +using ctor_fn_t = std::function< std::unique_ptr< Object >(model::Object const &model, Patcher &patcher)>
     
    - - - - + + + + @@ -91,13 +125,11 @@

    Detailed Description

    The engine Object's factory.

    Member Function Documentation

    - -

    ◆ add()

    - +
    -template<class TEngine , typename std::enable_if< std::is_base_of< Object, TEngine >::value, Object >::type * = nullptr>
    +template<class TEngine , typename std::enable_if< std::is_base_of< Object, TEngine >::value, Object >::type * = nullptr>

    Static Public Member Functions

    template<class TEngine , typename std::enable_if< std::is_base_of< Object, TEngine >::value, Object >::type * = nullptr>
    static void add (std::string const &name)
     Adds an object engine into the Factory. More...
     
    template<class TEngine , typename std::enable_if< std::is_base_of< Object, TEngine >::value, Object >::type * = nullptr>
    static void add (std::string const &name, ctor_fn_t create_method)
     Adds an object engine into the Factory. More...
     
    static std::unique_ptr< Object > create (Patcher &patcher, model::Object const &model)
     Creates a new engine Object. More...
     
    - + + + + + + + + + + +
    @@ -106,8 +138,18 @@

    static void kiwi::engine::Factory::add

    		( std::string const & name)name,
    ctor_fn_t create_method 
    )
    @@ -127,9 +169,7 @@

    -

    ◆ create()

    - +
    @@ -172,9 +212,7 @@

    -

    ◆ has()

    - +

    @@ -216,7 +254,7 @@

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_float-members.html b/docs/html/classkiwi_1_1engine_1_1_float-members.html new file mode 100644 index 00000000..c7da0590 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_float-members.html @@ -0,0 +1,133 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    +

    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Float Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Float, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Float)kiwi::engine::Floatstatic
    declare() (defined in kiwi::engine::Float)kiwi::engine::Floatstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    Float(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Float)kiwi::engine::Float
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Floatvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_float.html b/docs/html/classkiwi_1_1engine_1_1_float.html new file mode 100644 index 00000000..8ad48c5a --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_float.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Float Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Float Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Float:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Float (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Float::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Float.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_float.png b/docs/html/classkiwi_1_1engine_1_1_float.png new file mode 100644 index 0000000000000000000000000000000000000000..5bfb329f4b1dff5e2afedcf2fbee6e9791a44a18 GIT binary patch literal 985 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GT}o-U3d6^w7^UYxW zmgof299cg3s|Tkn34WEhu4D1mwutydzuZcnowM3cJrG%UNp$+lb;66jf7o@#=<)HG zb+Z$26mv@O=#YuVS`u_o5W zZjJZPW*U@x{+HVva>g+2@n!9WsnrtatF9kh(>;BE@I{&SjM;Y!m%g_-yV-ii?F9M6 zZPmr$FOTb&?J&1jtqpbvy0tZM>Fnl&mFMG@UU%9enRn{$l|I`>{l8qbl_K7kJQ`nm zRA!o}p7dwi$g_H6bi&N=)Cd%V~`1Sc?6 zXc{o?5t+dNRL`K#s@5=_N%(+wBjXRCYG)*gx3w6!+rz2V;D?-$?v_`CKJ zzkzoskKy!1l1bNo@>LhdZvXRDsYGPy;|#ee`t$*Ft~mZOCSp5Xc-pS*0! zrN6FBJ9fhY(|E?w!@p$DOZJ>o-7Rk?xZ?8+hW(c|ooSsB{QINMs^Voo{zRw+Ti);b zoMW(V+5ESvyN`eteNsrzKO7@T+3x32rSVrP<>C0oJde3SEYt}w)(wtdO)59Yr*zUxzhcJ2Ph Za8%UU>8G0s2QVKpc)I$ztaD0e0s!uY&H(@b literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_gate-members.html b/docs/html/classkiwi_1_1engine_1_1_gate-members.html new file mode 100644 index 00000000..e7501ff1 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_gate-members.html @@ -0,0 +1,133 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Gate Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Gate, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Gate)kiwi::engine::Gatestatic
    declare() (defined in kiwi::engine::Gate)kiwi::engine::Gatestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    Gate(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Gate)kiwi::engine::Gate
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Gatevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_gate.html b/docs/html/classkiwi_1_1engine_1_1_gate.html new file mode 100644 index 00000000..c39e6dea --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_gate.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Gate Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Gate Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Gate:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Gate (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Gate::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Gate.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_gate.png b/docs/html/classkiwi_1_1engine_1_1_gate.png new file mode 100644 index 0000000000000000000000000000000000000000..68248f2b11296de989629698f822bc16795d9e48 GIT binary patch literal 983 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GU^o-U3d6^w7^zMiyLLBOqFKD6?``#qi$ zz6UdW)5Ei?+k~gS_Dr6UKQRIy}sL@{=FXZ zR!u|nHeb6puZikQ5#_UsEM{k~D)ls;w#R2z^z5Kyp732u^gd<^EGjRasn-8vrQi2j z6L05vYb678rOs-Fzq=-MeBG+0t7=cFW|x&7kKJy&d->I!SI7%uhP8{3W56luj@VBz<+3T+y=hHLx>CS)fQ^5Cp34?Wv z@ByytEE^7)G6Iz|XyfMo=r?udc=%61<>k8_%TyvC&YF~RRQ>GIpE=nonMbyiR{l4Y zE&JQI+;+L9=l;bS=hXgeP1C7tEeU6uk~PUW$7}BOu4UQAx2;x{bWGp2Sta+!n#iZ8 zVl_VoY5(&6tQvjx?vJX8OAO^rKj-C!%jg!ST8@tf9NxjK*QmF3wz(eB#s)|5$oRCIr@pS^6&jI3>* z!NwbTUfp6;i@EisVsiPO>id0*cG?^K%43+nV~Ufl@cy66);IpSw|l4Og1m{Qm%EQV zvwr$)()XQab6Ka&~>?bf6GI+ZBxvX + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::GateTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::GateTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::GateTilde)kiwi::engine::GateTildestatic
    declare() (defined in kiwi::engine::GateTilde)kiwi::engine::GateTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    GateTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::GateTilde)kiwi::engine::GateTilde
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    performSig(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::GateTilde)kiwi::engine::GateTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::GateTilde)kiwi::engine::GateTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(PrepareInfo const &infos) override finalkiwi::engine::GateTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::GateTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_gate_tilde.html b/docs/html/classkiwi_1_1engine_1_1_gate_tilde.html new file mode 100644 index 00000000..38854cd4 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_gate_tilde.html @@ -0,0 +1,338 @@ + + + + + + +Kiwi: kiwi::engine::GateTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::GateTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::GateTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + GateTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void prepare (PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performSig (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::GateTilde::prepare (PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::GateTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GateTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_gate_tilde.png b/docs/html/classkiwi_1_1engine_1_1_gate_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..60768fb927fed6338e4d7ef6afc5d8720e7ab20d GIT binary patch literal 1847 zcmbtVX;4!~9DkA1Q0oPFP@&c+0wb3KLPTrB;iHHcAjks}tO9`uh{zFcv4uhrY9vyK zh$wP}hZPf$D+#57HWrDP014NWfhY+egn(R4gRPzVq0{NOGrRlS%e0USO7ral$fKbq8y2~O}@%$tGlbGqe7uj!k1EcbnZ{zE79A|;c(P4`wf&! z&5Kw!4?uZowef%Pv;+Y4cF^IdXB=XpNJ6Q#(^jK7Ql}J;I}kh9+7#^P-gD@2h0NDB zFlbWtY|;?>2#|j}zckhm+Wo|h;X)}QQc-B0F&JY?XVMQ#wu8c32XF(8O9U_G_JEpG zF$Zsqt1w)i8`Uv7UFO?`{5L!(!!l&sl>YHEBO7u?0;QITBF)wW*`cSiKcA4t4LM2r z&9C6>-EonpVaKt=`Mqs;gHUnRqR4X(e0(6XC-B*rsBN0cbi4QZ!W7n9xDY;N{y zN%{M)2)G7o*gbYZ6=&e%#c-b0jxAo#W+qe^y4yw+mBfMdt)n7VdGwuNt9cEgKP%B0 z5fK|MF@7HD_@;_+lwM~priUSabWFcm~vK}1}(9shV)Y-#OfP>8xAI^G|@gh;^``A z;>W4I-UI_?pJEYG#%_wmO2 z#bg*$kewYXdv-{Wt)*Ak-kF6!!JVfN%Y(m`R&4tLN^Mdjljs^_VJSf&FnB2Fr^Dgb1bkJA%E%&AzLjK+W>bA>5hlXUjFw{Sqzr+@ z6KPiA1^0o4Sct1y99!2Z`a~fjCYe@EE}`n`3x(vvrh!c9oBkuJp)k$)JhhAU+c|$! zbr4rh^1qNk>yU6v23)3WADswpZzIj~2Pcpcu$Fmd1 zgO=0hsw3=FQLhX(Dh>T!&TV<|mNFm_ZIcQNqaZ|ofA};qV9zRm+f7pQiE43(s~_&+ ze~pF`N#o=S;-Pl_smS*eBQZ;Gzb+g-*cVQswTneYtwSdI(HSEt*Kw(Ai);^d(P9zH zRpOouIUCzxmX+KDdpxFQ?Yn{rTd2rhf7w2$YS+?!rfz|3z%TvFN}?G*7uzx$9j4R9 zJ&IqR0haY*=I-~-mX%N+If?pXk*ye*?tBT$Ix6|$n;515tZJT=VWO7O1=j4O*E`Mo zU#x8cEfRQ*TNC+V}=~xiq(RngyG}#a{}w!!75aW!hj$T zWE@sE>M-xhJHbPqFYJj}lrSdQ4*^q_85B$K1GW&znn3gQ_d~PcmY_z`Sg$dxv#cQ- X`}UZtaY>%?mjggYH;0-p0@D5fPb!#w literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_greater-members.html b/docs/html/classkiwi_1_1engine_1_1_greater-members.html new file mode 100644 index 00000000..979e3519 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_greater-members.html @@ -0,0 +1,138 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Greater Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Greater, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Greater)kiwi::engine::Greatervirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Greater)kiwi::engine::Greaterstatic
    declare() (defined in kiwi::engine::Greater)kiwi::engine::Greaterstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    Greater(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Greater)kiwi::engine::Greater
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_greater.html b/docs/html/classkiwi_1_1engine_1_1_greater.html new file mode 100644 index 00000000..12f6db4d --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_greater.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::Greater Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Greater Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Greater:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Greater (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Greater.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Greater.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_greater.png b/docs/html/classkiwi_1_1engine_1_1_greater.png new file mode 100644 index 0000000000000000000000000000000000000000..8a154f7a921b9534727e0fc7dfe67ba70ddb604b GIT binary patch literal 1323 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~+2!ft7*fIbcJ9MTixmXeZuhU+^Iv(s zc2{$g;p-)S+3E`yGq#i!e9+fiT2k*ZsifQ~c+wsYU(ZjAGWecdzvdCty!B#<^s)Yx zw|E1zw#o7>&&u$+q!~5Kb)$J$_-o~}D|IeE*}PNJ-0$J3_B*M+u5(2%fGeX6|6w(#%H zFkAP6wXWQE>CWgc=S_=`$z+GsMrm%bkz4ls*ZPG!`R46kzUU_Z#j?`hGxxpDe3qAy z*Ic_K(th@CANze952t^=yC`4CL#k})^p|PM5uY|seVMIvOLX0(yHEP=Htzo=_Nzd9 z+7h{iFEf5#&G4Eeyin6Ku4S1@rD4{xDVN?det5=OP(N?s&nnwPpCxB4ekyDuzesW> z-vjpyrV7DX3~?=L4dM$qAGqS?)<+mGo$`*~bJ9CMp!wn;^Y>hqIkSH4#3f>PuOQy6N&wXC|EYYAEt8n=z~C`OZTnri;&pPvyIOux#2A-uI^A zJBz|jl|*R2YToI&dgtysTaTdG+h?85%1zJly*#T<{;b>n*WGmsW^P`zdZ&tSc=6tQ z4{z!`ewMH8dBCB5h_$q!k&%y* zFROa$#@u(3&)FpZ?s(oT_vq~^xj*7(y*JD7Tvqd|s5rL7^A{gI0;zK(o{r4Z{JPWBic4E!qr$2g3Zzg7)n){sV^3|TOtMH^+MWJv+JIlo`%n| z)ZR7AEc4r};@6)TVy?zKKYu^0W!J?VyV;?u1$Qsoxp&Y07rWapEsNf{$o5g`S*^xZ zjHfr9{ha^#fLmTAOW91j`OmAOwLPV4?m4BK-Sn3JSbBEx)?E|Rw$AnrYX84h)APQX ziR#Jj3sY3|-Of%4+GWddZx6$}^TsCe>)k8toQt>AG(C4VQNGOhhr^da-%0pD_XU;@ zN+yiJY=?{ch(DX}u)!U9wuarp(A3yIYv;)_i+#)UUQb!gVC~2DvPJEH>9WFG&6b&d zPnUbAy`A&e_*zQ)O3m_l+CJB-w(ZQcT4R4)E8hf^u)OAN3c12wJo)P0o6D+J{QSr8 zO(t7!_15`?<~QB$vl&{i`5raPY!-uT-C9uk%AA~b_DH0Kwm$O|t_Hs4VzpM0VSB3X z^)0%2!{C)iUf$oPXJvuEy7yIUtUfa{{MdyGGe)aDcPHd9g)(3NJnPM>+1_E|!joTC z#%s*vyKwBi?w70EXZAnaZOXi(CD>%QzB2>+A2Hbn+0Z<8^gNq2&*6gde~dR)CO`k> TeB&vwWMlAj^>bP0l+XkKa5;hv literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_equal-members.html b/docs/html/classkiwi_1_1engine_1_1_greater_equal-members.html new file mode 100644 index 00000000..7509c099 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_greater_equal-members.html @@ -0,0 +1,138 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::GreaterEqual Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::GreaterEqual, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::GreaterEqual)kiwi::engine::GreaterEqualvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::GreaterEqual)kiwi::engine::GreaterEqualstatic
    declare() (defined in kiwi::engine::GreaterEqual)kiwi::engine::GreaterEqualstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    GreaterEqual(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::GreaterEqual)kiwi::engine::GreaterEqual
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_equal.html b/docs/html/classkiwi_1_1engine_1_1_greater_equal.html new file mode 100644 index 00000000..96a1ba9d --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_greater_equal.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::GreaterEqual Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::GreaterEqual Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::GreaterEqual:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + GreaterEqual (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterEqual.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterEqual.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_equal.png b/docs/html/classkiwi_1_1engine_1_1_greater_equal.png new file mode 100644 index 0000000000000000000000000000000000000000..1fc551a9b1dee3b065d94c4bd3ec6590e4feb549 GIT binary patch literal 1356 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~x$WuV7*fIbcJ9SVo3#YkZuhU+^Ius$ zT!fuva*o>b>$h$$UCbyGm2g5=b7@Jf$E1={r{GC@ID9=nEz0nFcKMn|Q2XACC9|K| z2bXdLXx-vl?p$i3`ck!OmTRF%_KL65o&{}7{B-x$6zSi8+MHRTcPp=NOaGc%x^33&Nn1BAIXUIu zQ-j%a)!l^aE0$fd(fRdzmSyre)75r+MQ&|tf4Q^%b;i4cpZ|Mrww$-9tn~QIx)+(p z-eqi?T)Qmt{aNQ_^Y`C)d9P;M3tuMB%L{vq?#i%4*L^dp^>^8QD0J8CI~&zMgx9y; zv*}XJbjh%asw*{9J=u9-ii$qSt20c4y75 z6XP#WS#n;ZYjJ~owqB~V;{BUi>=H!a^;6n?7c zruM7uO3&4m6?OYPg61!ubvtXT^0&5^y!CU=`t3h2{@2Ag{b)e3_pF7_{_Qz@Pp9y6 zeSX`yw3jtz{z37V;^KT4&T710anW~KeR{qbXGrhH=Q(p<`hK2vesz}lMZ$RJMY`S3XHpQ=jo|f&B~sj!1y!X zQD;|`{*G#ox$iP5>liq+ZoOdFwtkXmmc20T>a6D~H$Q2gog?b(JKMzl?AFrT4D++z zJ%0ZG9uIH&=H2G2!<4_xO#A(#;v)a-OUt4w7s-DtKC9KZsv-5}wU4)LHW+WuZFF9? z{`<~**Svz7&#%9r-Tua%{p0gl>Di@KLlqn#I>k3h%e-P;F`fyft!0&{@R>nnY-+K z7=Wn@k|MRv)@1KJe?RfYt|w{-8kbf1CO0r|J?<#{z<8R)--NYl2O5meF8vdd`t8`C zOU1rr5wnV(Z#`79cJX@O)2aVY^e%lZw4rBrpD8r-PJlx%?0wqoR{={4XD={XxATkX z_N!KX6+IVznbw|enX%06@|&|&RdyG)JhYl+Cj8AuM@@CDPyFw!vs%+O`ia-xHG7-$ zO>OIDhqYd&U{N*)5E4X6%vp22I(~FGN z@mcn~cwx#eOY`n0Vr%~0{rPwOgx~A0|CIbS`{Au*-UrElOjlo)Inb=1!SrW7G^CE6 gZ?yKkTvGavdF93wdtr$UprVh#)78&qol`;+0Nj_L8~^|S literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde-members.html new file mode 100644 index 00000000..36539339 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde-members.html @@ -0,0 +1,147 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::GreaterEqualTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::GreaterEqualTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::GreaterEqualTilde)kiwi::engine::GreaterEqualTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::GreaterEqualTilde)kiwi::engine::GreaterEqualTildestatic
    declare() (defined in kiwi::engine::GreaterEqualTilde)kiwi::engine::GreaterEqualTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    GreaterEqualTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::GreaterEqualTilde)kiwi::engine::GreaterEqualTilde
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde.html b/docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde.html new file mode 100644 index 00000000..44c32e59 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde.html @@ -0,0 +1,275 @@ + + + + + + +Kiwi: kiwi::engine::GreaterEqualTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::GreaterEqualTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::GreaterEqualTilde:
    +
    +
    + + +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + GreaterEqualTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde.png b/docs/html/classkiwi_1_1engine_1_1_greater_equal_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..b2a214d795781fcc71baf79f38a8935bd42b331c GIT binary patch literal 2405 zcmcImc~BEs8gCT^WHd0WA|hzkgHaq&QNeK};t7I?At7=G2LUC7fMYlU38{gF9bLfj zmP1P9N(T~L7%@Ns1EYu>SqEAM0(1~i=m3!o4bqroo2|8K)~c=A+T&GqzpvkWe|-J@ zj_-Z%<#}So^0mtW09fJXdXx+Ri#T}v-e?K_hGP1k;?o*056UsUUXO>P<0w0;@fsfe z{b^`uSo(e6di>MqGTGA`zz;19=mljrzBKK2)P)kiXd+K>9o%UOxYMyr>0(g z-P8Izr`n4z&p$6RzCpueYPnHE%NSLD0;H`VLc+9b2=$073K9d(aB19EdqJzV4C>i9 zy%6-VzIi3Iq4PnPB!DJGh>yE0CK9<5pe`QG+AXk>Wt=)P6yi^~LmZxBgxJA3?v9<- zbf{@Iw);++pc+XFTTSyJnb^b6{`zhgVoycI0uLmo=Iw*l=Wn{-uM>%QCoSAbz0}b8 zKlh?mapTer!o;;`gg04R;gWuIio!LoWVd+=1XpsCxqrlbe|?vHpwx;#_ZYKF-U0tb)0-3 zN;=KX@4aaU(zNG%1}ODzAdTw=8lKh6BgsukAT8s!oHxzIwjOUx;D@FpF4XG4@>0!{&hzKo7y@o70?1}=! zLe77`-LQiT&xQ{#wj0HfD-S}G7V;xYBa8$=ds8XmwTa!PF1h)ATZdcc!iox{6caHd zp3Jug?c?d%$~o~{XL%@Ro9be0%@>-D6mCZh+PUZU>iiDD{g)Blte>^tH16M{ABj|@ zTs+wRrg)1hx{6f5yQ>soSXnQH1g{s!PV$B3!AG=Dz-@ycvay8G!DNOlNzpEk<0>)` z6P@GWcw7Crq6x8Z2hB4P#(;B}A5(GuIB?yqLW}2k|1=ix|Fq25LP$C z6?#@YPDpYriA$C-I1Ko!!T}%r&)AKEFoknUShl7}x82GeU78LFZQdxAtTgc31f29{ zx;ST0J*7e5_z|)cA?%jLg5o*#tzx|RJa;Jqe-zJ0G~!SkCfhW5NscQGseuUUQs%Rr`wCDlHhB)zO|Z{~+8Uso_AZU&?DDl5yp4*P^y)rFbDCBmE(<~vzs3?Yf>W#Vg}O7cR|j`mt(lpU zhQ0f0;xCed<>efPUwV#ACSQ-ncZ$|?SXiA5^NpYLd7&()RNX;-f{>h7W8sRC>B~qs z{RDVQQi?srghldaKE;d-VIX`ms4kGrJTMK)Py3K^b88V*3cH*anRi|8f-2I{AI&?4 zT5mFaO5gzz+=iZFY@Sz&Xo1laA+dSC--uhsAK^K(mxkO=Xtz#<>wR)umG?nBLQ3hy-N*Tq}&&%e9{#HT(!{xi|M48+VXxaA-KH&vx_EOz96MrIMkJK`0A2E z4&ORE$oY`=VUl*;T?@y^4so8-hwPN*E8D6Do)nG6+#{tu`y3ms_|t(*D)%#psv7B% zH?~%jmt`ziGeMLP#P(KDFXj&4juE<-^K2$cU^4%U;-c-V{l1K1hK?nf`R|Ludp&&w zoB2Tv(mz9q2;-O)qUyZlTz<9x(zMSbbjYuc8Cv!ws`0Y$a0*!)G>MhB({0nO(bfb0 z{Z`1VdB-=UCN`CJEdP#KbI+Dxwxg9qMkU?v%gq(^QPvVHR!m>Ok-vqMSoqe-H8 z)8p%^@G0-`rfNTKKW9G*q|Z&U>)}CLkfkwcAmDv7Xm|ZIK*CGrWc*1}jW$LDyVp^v_?-xFJLY**bU66CzX59Pv$p^M literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_greater_tilde-members.html new file mode 100644 index 00000000..c1f55882 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_greater_tilde-members.html @@ -0,0 +1,147 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::GreaterTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::GreaterTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::GreaterTilde)kiwi::engine::GreaterTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::GreaterTilde)kiwi::engine::GreaterTildestatic
    declare() (defined in kiwi::engine::GreaterTilde)kiwi::engine::GreaterTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    GreaterTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::GreaterTilde)kiwi::engine::GreaterTilde
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_tilde.html b/docs/html/classkiwi_1_1engine_1_1_greater_tilde.html new file mode 100644 index 00000000..7f7bd95c --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_greater_tilde.html @@ -0,0 +1,275 @@ + + + + + + +Kiwi: kiwi::engine::GreaterTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::GreaterTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::GreaterTilde:
    +
    +
    + + +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + GreaterTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_GreaterTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_greater_tilde.png b/docs/html/classkiwi_1_1engine_1_1_greater_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..3280b74480f3b5cce0df24083db754fc7c78616b GIT binary patch literal 2307 zcmcIm3s6(p8NNgTi=u2axlp8O!Zli6W}FW6TTrtgdmoSp?XTpDKiff76*R8v=UZMBIUX+`a4Db^=1xrQaBwoO5tVBKmTe) zU%4Xkq8)0%qS z?+TdcRU+Pk9Q!nz5ekU~H~C4G;jp(r@=rA6qm`P5bmM`ZdfalrPH8eQ%t`eFwk?4W z7luJ2$w6*;nF^p-KLd{ZTF|DRl$r0>@69^HZ+z~U2|tJ8hN`%Ob=>{J9kZzb2{A-Y(62O zfpeBcoyh7`x(zeK0&0)_QN{5z+O*I;BbpcRk5893>5B55x5#$pt+(u@IN?H?(bQ)i zMq6U|{GlhLJj&#>PL6&Z#1fadneN=M;NFrvMa}X@+Vdo20o)b|1=NTipILwIOAkrc zE)JnYwF$i1*hN@17ZDa?6#Ky+c7$tA<8Ft{yVo^nAKP`icR34+EfxzANqade`psH| z{8&$fPOTJaZ>^+Tvo_}@f*R)o`sR<50uJ7?f=;_(i#WL@37@6uY6CP+aBpot1*M}t z{wo(A@haK48q?80t_F<=iXVwE?>A1jTHcK5~Pm~ff3C+lqvO{M6EisM~LDD{9St52j}ERbkMO4Hm(tbXp3 z*EbRJR)tjeMtsdsd!zBYa^!|pWRIiq#H0+(vg??GYpW|-TiTBMI$uR;15f-8?&~QC z<>mRZB;U{w6z`&%E3&P5-wE+I1E z`=O9}v+Q{|kHzMBA4yHrZOe;}&5RGfW-56Hbw_#Lxb4ZErg=-zJ@3302C+f% zIVKEmY8%yDHe27inWdcTdhLEl!sw>KxL4c32cjMRWbc#(b(tQGzbbdI&uFrlh6Q1-%JUCWwDMc2+Zu%&wzc6-D zjB8A-N? Glm7}SJ9JP0 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_hub-members.html b/docs/html/classkiwi_1_1engine_1_1_hub-members.html new file mode 100644 index 00000000..0d352737 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_hub-members.html @@ -0,0 +1,135 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Hub Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Hub, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    attributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::engine::Hubvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Hub)kiwi::engine::Hubstatic
    declare() (defined in kiwi::engine::Hub)kiwi::engine::Hubstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    Hub(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Hub)kiwi::engine::Hub
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Hubvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Hub() (defined in kiwi::engine::Hub)kiwi::engine::Hub
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_hub.html b/docs/html/classkiwi_1_1engine_1_1_hub.html new file mode 100644 index 00000000..3e08e772 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_hub.html @@ -0,0 +1,303 @@ + + + + + + +Kiwi: kiwi::engine::Hub Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Hub Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Hub:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Hub (model::Object const &model, Patcher &patcher)
     
    void attributeChanged (std::string const &name, tool::Parameter const &param) override final
     Called once one of the data model's attributes has changed. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Hub::attributeChanged (std::string const & name,
    tool::Parameter const & attribute 
    )
    +     		+finaloverridevirtual
    +
    + +

    Called once one of the data model's attributes has changed.

    +

    Automatically called on the engine's thread.

    + +

    Reimplemented from kiwi::engine::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Hub::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Hub.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Hub.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_hub.png b/docs/html/classkiwi_1_1engine_1_1_hub.png new file mode 100644 index 0000000000000000000000000000000000000000..87537657d3a11880567160e490be8a332163ae5d GIT binary patch literal 975 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GV1o-U3d6^w7^KAf~zL4a*`|EfLzmFH`B zH7glzoou~!w$5HDiG|EO|5TsPdCwm?>78GO*Cg?Unx1hXXH)*&mhybH!F1LJlUkpv z3!9@h@=Nety*Oow_ZO4Zk0RrjN6BZNOO;)AN7r|0;kx{Jm2P< zm5*{B@t-%D)$aN~W^>A!h|QfZmtNRq>+|H>+QmCd^B?>aID4Xm z!QM&uK=%cf4@xGCdpLX<^l@{4^qUr+`}uEz>dSX6%Ty`_XH9x?)EXLug|}uc>*usM z(z|=_GEL9@i?!yJ{>VPNbB*$p-BylEmsydl zp1uF+dUNN+ky7WMDSTDUeVWC!b%U{UPca#5oviaGI7j-?Y|4n_in>lKd=KOtkV#H%7?Q@2u2cKD%&ugj~_Ea+7 znV+7qFRuSXP201SpDgFwGu)Oj{}7zT5Z9vCAij|Efold+1#a%q`ZY6yyuP=y6qG|l z^U`qJ9&`x})(I=A8B~IM`!4H>>z;OlaQ@p*PYFU^?dJX~;7`i9?($ghtV zS!d6>8xp?9v-x5U-?wGkm%ZH@d!qS%!o}S5`!{CqX307--6wwk+xpA5a)MX1{Y`52d^L9{51L_D5!e=F*b#e+&*MoK0#rF3AVxJ_b)$ KKbLh*2~7Y-^y16_ literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_instance-members.html b/docs/html/classkiwi_1_1engine_1_1_instance-members.html index 774e937c..081ec0ec 100644 --- a/docs/html/classkiwi_1_1engine_1_1_instance-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_instance-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    - + - - - - + +
    @@ -70,23 +97,25 @@

    This is the complete list of members for kiwi::engine::Instance, including all inherited members.

    - - - - - - - + + + + + + + + + - - + +
    addConsoleListener(Console::Listener &listener)kiwi::engine::Instance
    error(std::string const &text) constkiwi::engine::Instance
    Factory()=default (defined in kiwi::engine::Beacon::Factory)kiwi::engine::Beacon::Factory
    getAudioControler() const (defined in kiwi::engine::Instance)kiwi::engine::Instance
    getBeacon(std::string const &name) (defined in kiwi::engine::Beacon::Factory)kiwi::engine::Beacon::Factory
    Instance(std::unique_ptr< AudioControler > audio_controler)kiwi::engine::Instance
    log(std::string const &text) constkiwi::engine::Instance
    post(std::string const &text) constkiwi::engine::Instance
    error(std::string const &text) const kiwi::engine::Instance
    Factory()=default (defined in kiwi::tool::Beacon::Factory)kiwi::tool::Beacon::Factory
    getAudioControler() const (defined in kiwi::engine::Instance)kiwi::engine::Instance
    getBeacon(std::string const &name) (defined in kiwi::tool::Beacon::Factory)kiwi::tool::Beacon::Factory
    getMainScheduler()kiwi::engine::Instance
    getScheduler()kiwi::engine::Instance
    Instance(std::unique_ptr< AudioControler > audio_controler, tool::Scheduler<> &main_scheduler)kiwi::engine::Instance
    log(std::string const &text) const kiwi::engine::Instance
    post(std::string const &text) const kiwi::engine::Instance
    removeConsoleListener(Console::Listener &listener)kiwi::engine::Instance
    warning(std::string const &text) constkiwi::engine::Instance
    ~Factory()=default (defined in kiwi::engine::Beacon::Factory)kiwi::engine::Beacon::Factory
    warning(std::string const &text) const kiwi::engine::Instance
    ~Factory()=default (defined in kiwi::tool::Beacon::Factory)kiwi::tool::Beacon::Factory
    ~Instance()kiwi::engine::Instance
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_instance.html b/docs/html/classkiwi_1_1engine_1_1_instance.html index 927a440f..823936b6 100644 --- a/docs/html/classkiwi_1_1engine_1_1_instance.html +++ b/docs/html/classkiwi_1_1engine_1_1_instance.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Instance Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -80,51 +107,59 @@
    -kiwi::engine::Beacon::Factory +kiwi::tool::Beacon::Factory
    - - - - + + + - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - + + + + + + + + + + +

    Public Member Functions

    - Instance (std::unique_ptr< AudioControler > audio_controler)
     Constructs an Instance and adds the engine objects to the engine::Factory.
     
    +
    + Instance (std::unique_ptr< AudioControler > audio_controler, tool::Scheduler<> &main_scheduler)
     Constructs an Instance and adds the engine objects to the engine::Factory.
     
     ~Instance ()
     Destructor.
     
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    +
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    void addConsoleListener (Console::Listener &listener)
     Adds a console listener.
     
    +
    void removeConsoleListener (Console::Listener &listener)
     Removes a console listener.
     
    -AudioControler & getAudioControler () const
     
    - Public Member Functions inherited from kiwi::engine::Beacon::Factory
    -Beacon & getBeacon (std::string const &name)
     
    +AudioControler & getAudioControler () const
     
    +tool::Scheduler & getScheduler ()
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler ()
     Returns the main's scheduler.
     
    - Public Member Functions inherited from kiwi::tool::Beacon::Factory
    +Beacon & getBeacon (std::string const &name)
     

    Detailed Description

    The Instance adds the engine objects to the engine::Factory.

    @@ -138,7 +173,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_instance.png b/docs/html/classkiwi_1_1engine_1_1_instance.png index f4cb2142ab6ad25e15414cd3cb886e43061438fd..54b62b3a130339b9fc6c95ad9a2c1ddc8955ddb5 100644 GIT binary patch delta 591 zcmV-V0@LXZoEFV+ZmqUyZTx%6oD|Jo6D5Gr1E_l5T6_Nm5i#yk%LIVFmC_Jpjhl*m#e}(0pU#J%8y& z<{KPuRxUtX6AvJ&i3bqX!~=+G;sHc8@c^QlcmPpNJb&s)+{>RR=E{t?PUj9dB*^^HH4Q0o>9L@z(ZoW|gql+i10{ru=Hk z!Eb{Jb#d8MPj4n&!YfewXm4v*41c~eo2%lEr<)GItB05O1j)3Lpl0FDle~F%)aI|^ zt>2nHUUt_UdBr@ark6DVygnp%9c-C(*Zb`Bsw-TM?r2-5CG(*)ygFPLliS0K+`XzW z+~OrqzH%#fZ8qg=mJU@ez-9gLyK@(>n-+lkx_x@Rv;f@KH dlu{a2{{a5pAw(b3o8ABb002ovPDHLkV1jZ`9W4L= delta 652 zcmbQhdX`nOGr-TCmrII^fq{Y7)59eQNN)h*01jp#*{93@Zla$bmmK|=H4C(HA-KS4ox+8RS!&?5!GllboueMIN*&MC3dd~ZOCFZfWCS6&{ zec)zWz1JoEDQbU`TL1reJ9WuwBjLJmp-Ernn>4DP3>J=6J4j3RF40=@zJxeY& z$oC)YaA&Uj)aPm=^I?xFLyc)8qYd$Rdpw6?j|$TPi&+O4=7F$PJ#*jUYs-(zD+Fi$ ztDE|(fl=?}@&nn`m9DD)uP@yZ6&Aclaq;Kd2{Fd|EkfGD9T}#cYZQL=Z_D$d0+qctt*^WR PCNKt1S3j3^P6 + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Less Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Less, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Less)kiwi::engine::Lessvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Less)kiwi::engine::Lessstatic
    declare() (defined in kiwi::engine::Less)kiwi::engine::Lessstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    Less(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Less)kiwi::engine::Less
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_less.html b/docs/html/classkiwi_1_1engine_1_1_less.html new file mode 100644 index 00000000..e50402de --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_less.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::Less Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Less Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Less:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Less (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Less.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Less.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_less.png b/docs/html/classkiwi_1_1engine_1_1_less.png new file mode 100644 index 0000000000000000000000000000000000000000..513a078be80361e941ba3eee98b61bdc12d0fa01 GIT binary patch literal 1279 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~>GO1P45?szJNLEFVl4r-+x@Hd{8yG& zj$>mF3itAtr>4iGR%Q8IjM!7Qc}qq5 z^WQ~g*PE7_UryL;Fl+XmD)Z$l->%t}c5}I^?kv}Pg;#f_eKfI-KAU>-)xISMmwZb# zpWQ3AxAXp1O_TEOe|yvVW+b0oHnAb7pE6T zOsZ;Gw)m-kdhnz<9KN2PluT4lb_W_Sos!4jV6NZr`!mnk>#qgpoxdQXJO9B?fwLVY z4E9dK2f8n?d{8oB+{59^ppTpTqun&v>*c=*Dlgx)EK{izoHgmmQT4M2|J;)C%(|#6 zd#r!uhSlYF-dg&4?m7kxyAPXyAt(6hu9c&uy0wq%&QEg^SIxTjEG)bAWs zzIl72FPGdjI@Mk2xq4^z{#ccjXWh@HZha*feRxaT{qt#y?|pT(zi=k-;?Ie`NH%qOE)WqT>AK0e^=+1`)|%_HFOzno1v?`S1ayOWmvA; zuRXg}R<^$0e?h$c&GhFRXFt1mQP)$n-uv@qM%|N3^8eq75s#fz=L|~^J+m~ImQ*wB zsbst}KRsh#T>pofwr3eXSm-TZ}QJWQX2un>tzcvS-tDH*|mbY4`kgjOVHkKgF$zPsCYutk0HP zd$rf3`*O@At3SEEp1({%`3IB=46~L^x%8It!!y=``gsd~R@ol*Tep2iX0x@`_&Howe-rw7|GC-g?ScE7NVxXFmJhc5q46nYmMU zifqp8^2={IJ?pZ4WW2HX^jXFC&WqLViVWLh?!5cvn(t|QBmau+jW}@EX + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::LessEqual Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::LessEqual, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::LessEqual)kiwi::engine::LessEqualvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::LessEqual)kiwi::engine::LessEqualstatic
    declare() (defined in kiwi::engine::LessEqual)kiwi::engine::LessEqualstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    LessEqual(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::LessEqual)kiwi::engine::LessEqual
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_less_equal.html b/docs/html/classkiwi_1_1engine_1_1_less_equal.html new file mode 100644 index 00000000..64bd7597 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_less_equal.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::LessEqual Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::LessEqual Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::LessEqual:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + LessEqual (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessEqual.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessEqual.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_less_equal.png b/docs/html/classkiwi_1_1engine_1_1_less_equal.png new file mode 100644 index 0000000000000000000000000000000000000000..d435fd052583a41b19508bce26af17cf383a7396 GIT binary patch literal 1334 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~IqK=+7*fIbc5d$E#R>v!x7%0!`9HsA zodzGrx}9g(5SH!dJa;rP*2e z$)ztAq-+uOYk!sDbxE~qmTTda>jAHI&#LAgezJS3hPdA4sroxleY!Gp(as$uo45Wr zb?*DuoM}yK%`YcxH<-0MW@q%}OJ$+Dk>4`CXQxdqkK4L7(su2+u;S=V+w?PyR@Pgd zNn3t2;}L(Z*4e|0_OG9*{48eks>|F9bE{{}`W@_E{NAQs|Ln7hu3J}S-G41yCb@g@ zO}}q5)ApM4Pptcww7mNBZr6M!k6C<~A}^mQ+<3HE{AIPmEzxy{?jGs0ZLI$i|KjZ8 zh)HfO%N9TFKetT9670hauSw#Y)4VkA$}!}}F?@e6IcxoOWt;g6Eu-xYepZ|%_>!Tn zMXf=6A?E|v45kXfSqyQwxgX`Tmrc3!SJCs*T~1%mPf8}LC%fO9sDI8bR#|y`L&+@r zWrr5ttK5FwMD?X{*P|7O`%R~B>7DTY6wA{&Z#IZLJ(b&dMelHqhZsQw7oYi z-&quXspzKhtL{qA)s-3h<5gCk-#+Vh)>h?jZ7+H2=bZK1dtUsni?RFBfMV`h3!mM) zmzY1T?(=qY=k(1bcC*zN>Sy|gJFiH4U>;W@{L+52`D}(&$8IEV>-(~-qWgL1R_T|o z-%VN~x9-1FzRafldB^i+rMqueG5w=`_B~&Qr`q1%&!6pjG3kpjEIk}uGc(9*JNtpz z;s^d#wmp0OmE(MR#<^+!A8I<%T&x=8i3%l982&jvOLJ*Sy~m`Ia;M-)dpLlhm9)Zg zX8derPusSom;X#$Vt8L9{=$?c=OcdoJZ-*b+0G^F?To7PE9;&i1=VV=;>GKK|6MNk zbkQ@t@ONIPlBe|iN{YLb6}I$t^4+Ju)Fy=(U%L~wTK3|%x(%D0<1BUpKh`*RXD+vlQtjUJKh44?N!9#oT_>|iUiQfR?0IXi_L{7|95adSPqwe; zuS~eduK8##z0LgKEcb(dHqM{FR<%4gHc3CNUSa2AtR#D&{{qVgB@;$q7%=EN2_NXj z&Ha~rHgndp--lTW%ApDut)KZh=j6}RJYL6puYF*(xF9Z-%~W%wQ|&;*c9ZE}LZ{u# zei}KWc-oqpMc~vGWqLDOV(QXb$z^)G7wkMeb@!xcr{@L6pYhI%-CkLJ@>aq6gwuK% z&%U>vTvB$XdFsxP&5^wO|E;UuJdfAk_jbMe<+fvHUuIp8{E~Lj>$=0#bK ziFsyCoQs9NJ4}`N*J}6nf!A+-Q}^dG2SV!{H(Q-${MU5<0?Q9ps3()I%~_VY%eJ23 YrF9DTWWH6+z(S6})78&qol`;+08QwY&Hw-a literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_less_equal_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_less_equal_tilde-members.html new file mode 100644 index 00000000..7a09ec6c --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_less_equal_tilde-members.html @@ -0,0 +1,147 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::LessEqualTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::LessEqualTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::LessEqualTilde)kiwi::engine::LessEqualTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::LessEqualTilde)kiwi::engine::LessEqualTildestatic
    declare() (defined in kiwi::engine::LessEqualTilde)kiwi::engine::LessEqualTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    LessEqualTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::LessEqualTilde)kiwi::engine::LessEqualTilde
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_less_equal_tilde.html b/docs/html/classkiwi_1_1engine_1_1_less_equal_tilde.html new file mode 100644 index 00000000..f5b1ee18 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_less_equal_tilde.html @@ -0,0 +1,275 @@ + + + + + + +Kiwi: kiwi::engine::LessEqualTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::LessEqualTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::LessEqualTilde:
    +
    +
    + + +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + LessEqualTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessEqualTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessEqualTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_less_equal_tilde.png b/docs/html/classkiwi_1_1engine_1_1_less_equal_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..8f21243de6449e12986bf5ea00883f22c61dff44 GIT binary patch literal 2325 zcmcJRcT`hp7QkOXR6t~;1Qr$%fu)1W3P)g2lwyJ+EfC1k;s8Sl<$zQvBaBF>h6U*? z(o_QB2?-?xB16K66zKtmqCx4>F*MnSqkG&l?(9D^@0|C&d*64@JNLWy{_cJ8=4K`W zd=h*B00JUHlb^F!tYkK)RY-w#iP*}M2$rDgg&41sJe{<*~an!@K`SzU)r6ujZ`OkgMY*di*)fb%+5TodVqqRm4mOjGi*BYe2a zu=j3YY0~V8a<0xG;h)hAq$L+z1;L9Z%E|i~fw)o1gdn|p4LAc#V?khgErg{?pGB+E zxAbTus`O#B>LtEGzSL+2mz*;Q@IopVod1tioAe~NQe~l=&mxP$Ji7CUU7o)UV^Dp$Vu~e_X z-u)cMz=B>u;)^+cLEggezsEf~FFND1l+ken8_d)Vlr;V}YTi|G4YMnyydbbeW1Va4 z-3ZxWX9~?>GTlU|kDPo6HP8IPaJEA-dHq`*r{m@K-E2b*2sP~(@Mc+n303yqo`%f= zvR*jl&J}iEiu&Q`H&suNC>g}aqy~29l{Y@=gbT|1@qQFuz@+E(l*0+#j?;hTQHWQQ z+L$1t>S~4F+j@^B%Hfu0Evn9rdvr>{b#pH3@yU6l6+QDRp_TM37CHMTzR5dqAs5`i zPUM1wn&&VOrTEC66l{D?_|~R4vJGu7CjNpZIqd@KvXe{<#2s*T5;paW36HF+y*f*+ z$X=ImVndYb_I)%$r=@JqwAUo}Z<~8>Q?1pZTDfve(vUE|w$d00mBkx>3KW0FXHY(q zGpPjOw7J8J9i`x!rK77ufq%r8A7f!*UDGRdnZuvN3mslrwDxE<_$i(v8qtST;iq5; zJXh&h7)0OK)F0Z|D|K+-Vh5>P`V`Oantt^|P6fXQxw^*Zy6JM5(i46XR8U~^Xqm3!mnmkX;epjPCRO+PA|6{OebLX}w7*RKDecreT z&Cvu)Vs!JtKEoYf8g`-_?>a$TA`=@5BoC9a1&T&Z3`D45B5^M_W!)E415s(oIn>rI zozgajEk3>1s!sYwvb*tE3(MSfa}`44%*I1Pan$s6OtUOyWQ(wFqN>#zfzXK$#_bJS zoI>mie@6R1tlNq}`P$h7cJ%}SZa;N6zn^|eTqjp6| z!h9bE7Y+j|jZ_d$DPOjr13&2{46Rq%rB{0;a_T$RWD%qN!=zP`a(BPXO^dz5(5Za` z7jJXSn6Xs+V&xDqtbKR;Jm=bMMN)aWTCnT|vgzDyWV%p-y0g-iV0gPXm?< zsk$fmk1%Xxmf{3qB7reV%N7vm#qRd&&RAUb+2G>mK)T@6VhMA82P*;mQ= zUqt@KI3gmu)I%Mhlk1qN5Z7PsLqoKgv9i?dDjQ7gb@cPS`^$8M*1xFtcsRnkSeVw# zDwFHI@Tdc+E&tqu$P!uxYTuggpb4W&`j2`xY+Gr|`|i%BU3oXafamo!&(8VCf6Uke z40p9xSd5kSD>x&Ad1Krh*cW5}?7oIK^_Fq*sZqz+W<|znQX->ru4U|~z4)F`oT&QXK#*cCeDMhj>ZF6K8!@(>cY6er?<{Ht zQTTnrnO&D{OTtE8$Ya}T&$z{n=`Oqq5s78X9IAS!FD4m4Qio5TiOPFBy%BZEo4f}5 z00kh^YEyxJ(FFvYe)#XfNEc;jUGKYn5m4GaA}#v3n^0@|9rO + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::LessTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::LessTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::LessTilde)kiwi::engine::LessTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::LessTilde)kiwi::engine::LessTildestatic
    declare() (defined in kiwi::engine::LessTilde)kiwi::engine::LessTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    LessTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::LessTilde)kiwi::engine::LessTilde
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_less_tilde.html b/docs/html/classkiwi_1_1engine_1_1_less_tilde.html new file mode 100644 index 00000000..ab0c5b3b --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_less_tilde.html @@ -0,0 +1,275 @@ + + + + + + +Kiwi: kiwi::engine::LessTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::LessTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::LessTilde:
    +
    +
    + + +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + LessTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LessTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_less_tilde.png b/docs/html/classkiwi_1_1engine_1_1_less_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..9f8d97d69c495ba6e323ec51c1aa5fd7855645c4 GIT binary patch literal 2282 zcmc&$dr(tX9!_v6H7?XD4?)DO3yUN?1OZ1LapfTdOz292+lzn?1Og^VB>_Yp-PT$J zK_Zcr#{?m02wVi@5+x)Cc~#2tPQaM(tON)V5dz2~+0dQYS=&E$I^CH)GxwbDo^$5T z{r$e*_nnjRInGBHVS<3cV7eGzuTwA>JV=9AKi;P4(|4i^HN&3IPvX7RYPAMV&nYQ6 z&u?qcPme$#(9V$T*Svlle+m}}(`?#m!cM${W-1BebsV1vR}{aZ)w%4^F7&3)tG|B* z|185aeA!yP>&#(dbJ4(`-jiq6`RZ#hoVOi@fvfkU6-Uv{UHgz2YAJy>R}>U;Iz@Dp zR_|d|#ip!0L&o$q7cHDQm%!Q)MQ3_e5sT?$B~-D{58QAh8jqTJUl_01*U|CUi>nQF z+VgE!js#{h<`#HT@JjPwu&|_Sq7}&Odaua+7D5kpf1%`9VS&P?O?Hn{VeBUzks_CU z<1)xUgf7~jDQ)aOA9KM@><9#;ZQlr$@43GWIa5R)qWBQJ(+`{-Q8o_kYELdDc?X)Y zYy+a4Dr@aZl<(gvh@^RuxY_huy-_1qqb`ejXSn~YVMVKQHW+$oW|@GHVKZ;MX_Fo@ z$Qvo3Mh+n{5uNC}%wwN|eQTlMiAqi6sauhIRhqxd2*T9u25I54Z-90F{4uliSlLHA zVMSi3^ukv*q42IPz!fHHzug7GV*hXoKBt)|j?%8#4Z^6U1_E5Y)^J7;%(V}3))M$_ zi%Th^Y3PTAv0EI01RDASlD2*|sT`_A%S|!Bg~#<=HNn78xy*HEDcdd$b*$cdshXxO zxn>jT%xCr}>1;2HKnr@=J9|bJ2YMD{WyLP`xJ_m4-g~pXGbf83EqqlbJaaCwY4}hF z^rmasKFUcZ3u`+0x3S6qDDU3H#QJ@`08>qf-78)r=%hGP>4@ieBcs+3aH{Xpch zt18+?p)MB9A^^z~6tF*rWedL}a_C)s*061bI<6v!ni!Q^T}t9o*P(OJL`+I z0xV`=1W7(KC6!w}FGONuTdD}O5x<`+MglEsxN@V5`19*II)Z=bj(HV@^ZO8EQ&iXd zp*vki0JuaFnS^{~c`vqJtLdw6tp9s~$f#T?PFt|@?)48ki8{Z!oYpk8yFWd!&%giS zRyA7!7BBuSbju+zfkDYO2Wvwb4?c}_+#FG}uf_-;Js{9jzMN_HCK@F*S%}ui+vZ8b zVe+HoZdUj~6Vx#WF?Qs;!k8Xj-uP4&QLSuLx`bAdLKc z`s?d)so;QFjG-%|6KdlalU_^3cA0!n`JQlRZ>&A5dczgGm@b!siw+%XDu-`K7)q(- z4BZsR*&5XW&ezCcT98PHdV+`wi{qfRt0G<~Yi(ZkDxh z^-GWz|97eAM@lK#N?P~?A#5~$yKn!o1OFNSmeJu@(EPe;623|$ z!{7o;z1EYb(g_2>$t@6k>om-+5ApV+1OHP!e`pgPqbr-TZI_W(F>CR^@SawHJNvjh zm+9o}&s}GjlLidcgKFZJJt_Lu1&q*2^UYiL8DXjef$dI^-b^I+j~6MEDy}T6`#~|m zfz2kwVrPb@WxQ*HlUOcgjyJO?*>YeKuI$dyvK0I=KM=Ai<~M}krsShgbrKv5h^f3w zxMXcDx@pLT3|8Zjvl8mGH{-O><-~m~NVyF}r{v*`o*xIXV_bp7p{BvOry1tKT#AxR z@MDK>HS0zVl7B4=nv&$j!MA9|=8WZ@Uy=`q{hO5%7FngXSTH>+xiuFd= z5tp#y-xl~`R!CcA3q)=#QDeH zf3bKMWlRu0z!2^8-Kp|n%z*yE8JB<2)KV5+pEK)Ik#Jsz5?y~+H1F;PQ-61h;%3vx zK5c4a9hB1sXKY@|8O>N1Psw4q$kTufjXZ=6@P$JxLA E6GyFb4FCWD literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_line_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_line_tilde-members.html new file mode 100644 index 00000000..41508204 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_line_tilde-members.html @@ -0,0 +1,144 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::LineTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::LineTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::LineTilde)kiwi::engine::LineTildestatic
    declare() (defined in kiwi::engine::LineTilde)kiwi::engine::LineTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    LineTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::LineTilde)kiwi::engine::LineTilde
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::LineTilde)kiwi::engine::LineTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) overridekiwi::engine::LineTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::LineTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~LineTilde() (defined in kiwi::engine::LineTilde)kiwi::engine::LineTilde
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_line_tilde.html b/docs/html/classkiwi_1_1engine_1_1_line_tilde.html new file mode 100644 index 00000000..ad699393 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_line_tilde.html @@ -0,0 +1,341 @@ + + + + + + +Kiwi: kiwi::engine::LineTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::LineTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::LineTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + +

    +Classes

    class  BangTask
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + LineTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override
     Prepares everything for the perform method. More...
     
    +void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::LineTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    +     		+overridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::LineTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LineTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LineTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_line_tilde.png b/docs/html/classkiwi_1_1engine_1_1_line_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..63685ffff656b772a33426922a95e2ceacd08b62 GIT binary patch literal 1833 zcmb_dX;4#F6n+7zmMXXuu^^igtssgz$|j&dun#0)N`k(ys0ajNf>harMD18AW^f5G z0YXp_+2X?rS(K>6A|hJ^BM&7=u!tZ55ip`)NFR3S*y)c>r@b@xp6{M}f1G>H_nn&_ zfZwq|-$Wk(fCb=pUIYNZkWeh0r;Dx>CkYuf%K~-=;V3I~SN@n?TMhoVnYDwXP` zcUhp@c}EEN?*a7E%xG^6+z0?)+yK3{2PR>Lc`A0L^VfP@T=t0eK|RJQJ@{Vlm~GqU z%%$L#n*yt;^$g|21w(1s0QQwUodi}cf!POEL)Zqqz=zF~#|)Q0toCM;zRe)+PSo(r zmzp&jO<*LRj1wf#`CcBf=M^c8Yf=NL0#@1eiplaPjtA>UH>S-`v?agk+?u$_bu`G8 z8Jno;vR9K_10v)0!?>3phe>I|?#D8s`dQ#A*zXy0fN|h(;^EXtSZrc%}`_B8J10D7vlu7BK)JffGigGXcTv@#A7Q>roIw% z*QBOEiYj4(eaWTT{yG_E+z8^H#KyA-V@KnIXd(sI<;wWWbnffAr}mq(y7T&F6-0J( z7Go{Aei7U@847#z+iXB)A(1`g#kYPsn~wgI(A1p~ck|<6{W=SQd@tMM+$L-&rg;YN z+mrO(EQWztO9EyHb?_*9zbt`)ghC@JUZC?NodmeF>F-?){kOxn4COJm5^n5z@B$tt zvfX%;Y-<-Z)P&hklZ%9WHo>scw{j~U=VT5RNeE1H z5bC>xM7O4RN;Z|&hYcawjtZ+o6w$*^7-N7ZKS8Rqk0ugo1et55Be8^M*F;E2o2yMa?p{4@w2+ZP^pp=nGLD zY6*mWMavQTJR;9BS+g{;AAn2ME&@ysm%jDEosqN*UE! z|30<#cn0aX!?`TIf96K;I!;p=@IHi@`T-cR{I^WNh=8G9)>-_n3ri!72~87#bE9C*)uA-D79!CN?|) zsRkDXV+9u+$s>zNRWBxm>u%m|=~dsi-G@DjAC>3E(I_c7&M~(Ng3+oKKMP>L)h4%g zT%*vI)L7s47RYXfvUhGBRB;S2;N*_abv;ux*_Xn1sJONQH8MR*z!BA}1IPE4PRw_KmR1@mDKMCpaQSOJRKDNXKNxyo)wr z#YR0?kt7#l;#C3Dc{_Z1ly0UmY30fC?9(=aL6~M1OXn%?mzmEgAHzYc<`0VCG~Y7H z`u4K~Dh)D)uc%u_45aS+saAd`bWS literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task-members.html b/docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task-members.html new file mode 100644 index 00000000..2ef1a3c6 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task-members.html @@ -0,0 +1,112 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::LineTilde::BangTask Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::LineTilde::BangTask, including all inherited members.

    + + + + + + +
    BangTask(LineTilde &owner) (defined in kiwi::engine::LineTilde::BangTask)kiwi::engine::LineTilde::BangTaskinline
    execute() overridekiwi::engine::LineTilde::BangTaskinlinevirtual
    Task()kiwi::tool::Scheduler< Clock >::Task
    ~BangTask()=default (defined in kiwi::engine::LineTilde::BangTask)kiwi::engine::LineTilde::BangTask
    ~Task()kiwi::tool::Scheduler< Clock >::Taskvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task.html b/docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task.html new file mode 100644 index 00000000..fb9e435f --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task.html @@ -0,0 +1,137 @@ + + + + + + +Kiwi: kiwi::engine::LineTilde::BangTask Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::engine::LineTilde::BangTask Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::LineTilde::BangTask:
    +
    +
    + + +kiwi::tool::Scheduler< Clock >::Task + +
    + + + + + + + + + + + + + + +

    +Public Member Functions

    + BangTask (LineTilde &owner)
     
    +void execute () override
     The pure virtual execution method. Called by the scheduler when execution time is reached.
     
    - Public Member Functions inherited from kiwi::tool::Scheduler< Clock >::Task
     Task ()
     Constructor. More...
     
    virtual ~Task ()
     Destructor. More...
     
    +
    The documentation for this class was generated from the following file:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LineTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task.png b/docs/html/classkiwi_1_1engine_1_1_line_tilde_1_1_bang_task.png new file mode 100644 index 0000000000000000000000000000000000000000..493e29abd3e2093a047c3e55d1663a597b75bdb8 GIT binary patch literal 831 zcmeAS@N?(olHy`uVBq!ia0vp^mw`BdgBeI}`MY5*kdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~I_K%)7*fIbcJAxG#|9j3{hcQ7|DU+6 zwvjRZ(w4iCmAY>KW*srNkT9;lxh*%^Cr3%iTXTks%d>EU&WUVznEf;+6ncijY;AxrpmT|{#OHTc) zZhuSo%-^zWpC6Z)*q{4%N_l&1ZbnJSu{VjK&!yBCtvPC<<}0}a{}&`M&4@q9 zVz9r7Gog-E_`n}7wT7RfJ`A6=XD|SRmGR7aGzG`KG?yNAVT$mAX)^UWzWnW;Ho2a8 zcfYRC^a(d+usXGxG575gM&SeDQu&kJ-F&`>?LWO`d-`|9xdlgFTr8G2_wX8@@zpoa z+&5qT9kzUK)xxr>WYu1;^qa3{d3v6T&iw6c{pYaD5u=@f$CoTt+0xq^nIiu$d)cXF zolTuyZ#zHlvRkgbtZd;Xt$k(6e-YKp&`S~Pq-+9|&G5s0GzQ1(q{UCZM@R?I` z*EHUSmCm!4*L_*^ZfC3e^1>x6t0gbHE;-Lq5MBRrzT|=IyJp`kgQevg;x9!X+h?Kv wd%n?5`7cX+P6UU}|UZboFyt=akR{03f21k^lez literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_link-members.html b/docs/html/classkiwi_1_1engine_1_1_link-members.html index 484e979e..fd26786e 100644 --- a/docs/html/classkiwi_1_1engine_1_1_link-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_link-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -69,19 +96,19 @@

    This is the complete list of members for kiwi::engine::Link, including all inherited members.

    - - + + - +
    getReceiver() constkiwi::engine::Link
    getReceiverIndex() constkiwi::engine::Link
    getReceiver() const kiwi::engine::Link
    getReceiverIndex() const kiwi::engine::Link
    Link(Object &receiver, size_t index)kiwi::engine::Link
    Link(Link const &other)=defaultkiwi::engine::Link
    Link(Link &&other)=defaultkiwi::engine::Link
    operator<(Link const &other) constkiwi::engine::Link
    operator<(Link const &other) const kiwi::engine::Link
    ~Link()=defaultkiwi::engine::Link
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_link.html b/docs/html/classkiwi_1_1engine_1_1_link.html index a80ec0ea..64a3c719 100644 --- a/docs/html/classkiwi_1_1engine_1_1_link.html +++ b/docs/html/classkiwi_1_1engine_1_1_link.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Link Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -77,34 +104,34 @@ - - - - - - - - - - - - - + + + + + + + + +

    Public Member Functions

    +
     Link (Object &receiver, size_t index)
     Constructor.
     
    +
     Link (Link const &other)=default
     Copy constructor.
     
    +
     Link (Link &&other)=default
     Move constructor.
     
    +
     ~Link ()=default
     Destructor.
     
    -bool operator< (Link const &other) const
     Comparison operator.
     
    -Object & getReceiver () const
     Gets the Object that receives messages.
     
    -size_t getReceiverIndex () const
     Gets the index of the inlet of the Link.
     
    +bool operator< (Link const &other) const
     Comparison operator.
     
    +Object & getReceiver () const
     Gets the Object that receives messages.
     
    +size_t getReceiverIndex () const
     Gets the index of the inlet of the Link.
     

    Detailed Description

    The Link represents the connection between the outlet of an Object to the inlet of another.

    @@ -117,7 +144,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_loadmess-members.html b/docs/html/classkiwi_1_1engine_1_1_loadmess-members.html index b0be145e..f00f5ffc 100644 --- a/docs/html/classkiwi_1_1engine_1_1_loadmess-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_loadmess-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -70,25 +97,38 @@

    This is the complete list of members for kiwi::engine::Loadmess, including all inherited members.

    - - + + + + + + + + - - + + + + - - + + - - - - + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Loadmess)kiwi::engine::Loadmessstatic
    declare() (defined in kiwi::engine::Loadmess)kiwi::engine::Loadmessstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang() overridekiwi::engine::Loadmessvirtual
    Loadmess(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::Loadmess)kiwi::engine::Loadmess
    log(std::string const &text) constkiwi::engine::Objectprotected
    Loadmess(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Loadmess)kiwi::engine::Loadmess
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t, std::vector< Atom > const &args) overridekiwi::engine::Loadmessvirtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Loadmessvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Loadmess()=default (defined in kiwi::engine::Loadmess)kiwi::engine::Loadmess
    ~Object() noexceptkiwi::engine::Objectvirtual
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Loadmess()=default (defined in kiwi::engine::Loadmess)kiwi::engine::Loadmess
    ~Object() noexceptkiwi::engine::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_loadmess.html b/docs/html/classkiwi_1_1engine_1_1_loadmess.html index 0b59aab2..453e10b0 100644 --- a/docs/html/classkiwi_1_1engine_1_1_loadmess.html +++ b/docs/html/classkiwi_1_1engine_1_1_loadmess.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Loadmess Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::Loadmess Class Reference
    @@ -75,69 +103,111 @@
    -kiwi::engine::Object +kiwi::engine::Object +kiwi::model::Object::Listener
    - - - - - - + + + + + - - - - + + + + + + +

    Public Member Functions

    - Loadmess (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +
    + Loadmess (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    void loadbang () override
     Called when the Patcher is loaded.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     

    Member Function Documentation

    - -

    ◆ receive()

    - +
    @@ -153,7 +223,7 @@

    - + @@ -170,22 +240,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Loadmess.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Loadmess.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_loadmess.png b/docs/html/classkiwi_1_1engine_1_1_loadmess.png index ee020b882e4b578e9a3427c7de5d9e595e26f505..813674306b524415bd25fbd5d151c12a11cd53c2 100644 GIT binary patch delta 963 zcmZoERLtq?ZA42M05djQWtkJWuwFt@af53lcvf9Pg*m@ z(D`e0w93lGmm+tzK3#7#SM5aG;=?5?`If2dT_Ts}CUe&GNELT+?r)=)d9S_ZX79M9 zx^s>HTmjv?m9uJ(^jqHDe(_Ab?C+eb4NifHVmoTKZ!LY(Hp}Eau$f|4m=PbG@X~^{_)2F%8>(}oYE0dnh==ERU^6hP4<+SB|X)|s9?iV>* z*wJ@WHvHGg%~89XD|x>0Y`!~tx!3&tH%jvDyniihSW=L+*lRss(_Xvksc~Ez&lS`M zzYBePMg2qgey4o7qmxV~B})a>na-M&qH=tSinir4mB`G4J%-0lb03J}Z+QJ$Zbtuc zU5odPI|J@DepZ_i_mZKk$cI7OQmtXCjPL=kKF$Qy<18B{B{M~wG-O=!WClYRvh;ol z<6{!*^%tqc#`bA?0;N1R)n76`6Y%$%nCGj^8`9JEpL+PjeEv66AJ1Ptl7%J@kI%@y z9qv(X>2PwA#I7n#imp6ERLtq`QGQfP)!G%Gs4EPE@q2XA&4zE{`yN}E3AU@`DyC0V(FWnuLaWYK zxlD4Kb*^pw{!<5T%xskGR_`0qTrj%Q2k)=9JKkN%kM7nI37O?zkUjleY*t#jho%DSsd4o^B&c&aG$^^~PQ z)?f23^ZUPe>%Fz#?exvrv*UKJRTKDZyXxG<=Bk%k+c`u0T&nway?ni8j?LlX60yV2 z-`$mual1d;E@9{H<0>mJuiwOzr|mf_qR*D)LyUfXgYOo> z)33MkpK;TP*SLM)&5=jXITBRT88;M(F=!K@el_bTwruF+V2C~u$*^V)>jACJOV+XN zZl80;Z?4$1I~y5nE-jBps;>9dy7zvuy!)eoUF?%SS_aHC(_4D_;O>WiZf+8(Z~8MO z`pqea+o9SkH{bD7eOfAz5p{Z!gkngp(2nFa_1 zj`OrC|2x~Zi$66z_fKNnud1D%sgEx%Id&y)_3X3pHy2Ml?X|aL>g^wMpTGEZtvUX( z@2}5|maDI^&3PwyU{l@mb^k2AH>)zpU#@?mwRGPt20OL?bJ;*1UVS#gi6fE!FSCog W>_NGxD>H!!g~8L+&t;ucLK6TS&Juk9 diff --git a/docs/html/classkiwi_1_1engine_1_1_message-members.html b/docs/html/classkiwi_1_1engine_1_1_message-members.html new file mode 100644 index 00000000..7e4eeef9 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_message-members.html @@ -0,0 +1,136 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Message Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Message, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    attributeChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::engine::Messagevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Message)kiwi::engine::Messagestatic
    declare() (defined in kiwi::engine::Message)kiwi::engine::Messagestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    Message(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Message)kiwi::engine::Message
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    outputMessage() (defined in kiwi::engine::Message)kiwi::engine::Message
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Messagevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Message() (defined in kiwi::engine::Message)kiwi::engine::Message
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_message.html b/docs/html/classkiwi_1_1engine_1_1_message.html new file mode 100644 index 00000000..727d9df2 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_message.html @@ -0,0 +1,307 @@ + + + + + + +Kiwi: kiwi::engine::Message Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Message Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Message:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Message (model::Object const &model, Patcher &patcher)
     
    void attributeChanged (std::string const &name, tool::Parameter const &param) override final
     Called once one of the data model's attributes has changed. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void outputMessage ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Message::attributeChanged (std::string const & name,
    tool::Parameter const & attribute 
    )
    +     		+finaloverridevirtual
    +
    + +

    Called once one of the data model's attributes has changed.

    +

    Automatically called on the engine's thread.

    + +

    Reimplemented from kiwi::engine::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Message::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Message.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Message.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_message.png b/docs/html/classkiwi_1_1engine_1_1_message.png new file mode 100644 index 0000000000000000000000000000000000000000..c253a3e85fa1bb7e6e96c1e5982f9b2fa598d3ee GIT binary patch literal 1015 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GU|o-U3d6^w7^KAf~!fycFf`pkX*mFr^z zIk|4+UH(~Ow)@T^#RG~0f4sdkW8+mkckN;dp0r0~#-t}pd5ewqUsLkro$B`3%=UlJ zOM?SxH>`P)5+-S44i|xzxF8_PV}13;Dv=Z94tu8pp-WmC|W%KPI0$ zUuv?wt<>c5!T^agOxtaBQ{U}gkf-*0+ceS5n|fov&%1j2P>$hs-P`@DzRR|(b~cf= zt!lLYveJNm_CLF{b2ALno?iA^__adf{HJRNbef<4pT6iO|HZoU-!tnzm=v2Ed_O3c zcrE?&gqM$7dCxz)x$M1=$1J|3(_cPQiuk;F>PuC@w|wC*^NNn&I}rbuYj35fcaVSM zOOKydGrT5EhWk-H4e0GShI>^EG4bCI)Y#-5tmHqV{#4c?ze#c?--G1`SUv9+)`nd^EirL2+1#;q@gi zlcxRSOD~o-|G!if zo%!a9C_13l4XL}vB z>S)~mS&FOr8Z?U>>RZpE~0PTsFS8(a^&C5fE13frAJtwHWP>w<-sMOIyX zD4knXZJU=~Jl)~y3GZd=^M9MJJ^QJ)mtRe@JoG v-?dB?p39wof+zQr~Jb18$TtDnm{r-UW|qf^@r literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_meter_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_meter_tilde-members.html new file mode 100644 index 00000000..3cb681f6 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_meter_tilde-members.html @@ -0,0 +1,150 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::MeterTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::MeterTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    clock_t typedef (defined in kiwi::engine::MeterTilde)kiwi::engine::MeterTilde
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::MeterTilde)kiwi::engine::MeterTildestatic
    declare() (defined in kiwi::engine::MeterTilde)kiwi::engine::MeterTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    MeterTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::MeterTilde)kiwi::engine::MeterTilde
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &intput, dsp::Buffer &output) (defined in kiwi::engine::MeterTilde)kiwi::engine::MeterTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::MeterTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::MeterTildevirtual
    release() override finalkiwi::engine::MeterTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    startTimer(duration_t period)kiwi::tool::Scheduler< Clock >::Timerprivate
    stopTimer()kiwi::tool::Scheduler< Clock >::Timerprivate
    Timer(Scheduler &scheduler)kiwi::tool::Scheduler< Clock >::Timerprivate
    timerCallBack() override finalkiwi::engine::MeterTildevirtual
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Timer()kiwi::tool::Scheduler< Clock >::Timerprivate
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_meter_tilde.html b/docs/html/classkiwi_1_1engine_1_1_meter_tilde.html new file mode 100644 index 00000000..63abaf5c --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_meter_tilde.html @@ -0,0 +1,385 @@ + + + + + + +Kiwi: kiwi::engine::MeterTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::MeterTilde Class Reference
    +
    +
    + +

    ================================================================================ // + More...

    + +

    #include <KiwiEngine_MeterTilde.h>

    +
    +Inheritance diagram for kiwi::engine::MeterTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::tool::Scheduler< Clock >::Timer +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + +

    +Public Types

    +using clock_t = std::chrono::high_resolution_clock
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + MeterTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void perform (dsp::Buffer const &intput, dsp::Buffer &output)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void release () override final
     Releases everything after the digital signal processing. More...
     
    +void timerCallBack () override final
     The pure virtual call back function.
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Detailed Description

    +

    ================================================================================ //

    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::MeterTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::MeterTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    void kiwi::engine::MeterTilde::release ()
    +     		+finaloverridevirtual
    +
    + +

    Releases everything after the digital signal processing.

    +

    You can use this method to free the memory allocated during the call of the prepare method for example.

    See also
    prepare() and perform()
    + +

    Reimplemented from kiwi::dsp::Processor.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_MeterTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_MeterTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_meter_tilde.png b/docs/html/classkiwi_1_1engine_1_1_meter_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..ff5d7b415f2cf3f42a751053824a1f5d42efbc27 GIT binary patch literal 2527 zcmbtW3sh3s8a5jnGj-}(KAMuL)HE#9@`b3`Xoi|PWuge01KLpL`+$-%v8Wfipf26?_KNOX|20v%{^$izjYyExGc+#)z?Ij68#7ZZj@%ZB$m7H%69R(HE#~eOWGK zmM(Ma4H(MUvxlbV#Q1_4qXx?tU&EVE1HYc6wm*Xl-2iwe0JZiSnn1;sqf>%9w5Wxo zV44}1ilOwzylW^t@O^KaHqhz1bfI88qi>>n2_M)Pr~c4V$D?RBV#WlVcZHgj&S}Mv zq#FX08Z95UrDG#Q1{MjEL_VK=y3oMC6rGYSYO?UjSxz^)KH=vuDj=sphfcm6wbVia z{4D~tuosX>fs_>!Vi6iVS&g#X(-kC8TeayMDv?qGIzO9pnD{KZsZTDg& zgcQjjjRO@|;xo*V@S5`#udc56Qrk(=YfxQ1HeAq_1Fp;K6quhpsP_?4 zw2Io~57Z;;>=g;_5)kV*emTMa>GYPu6B9UlW%kn*%oW;KH*_ zz$i5mAxO<0dA%Vb-|vGxkyx-Ufv4|v#~_o)CVLXQy%zMkb&9PKfxJ;P0+@}G;x0UG zn{oq8>)tW*p}7Vm0uc*1@^5baNoVTa5;F4cSUBEDtHYK*utmD!X6{pKCr zAyi9%UKRHXD;MPpsb*;(J*inx8)|PPI)7^DpuMGCe^YeACxRQGv)l?Ly`z&Z5Qm(~ zWd}7G)4F%v0XAU|GCl5ggsj8m9A)wV%`{7vX*qfS<3v9(`OOesH#gJhD!@OzIL-{| z^u_3D$G#$qSGdz|rw*O%H*Jc}Zo2OzzX|1`&};e8o#jNa4b7tx0qDH`WkdCE3Ek>m zbc;=m)lLWrY?jZ2a~8HA9-61WYJrL~(;N_id>Ivo@JQaeD3%lcEA&$47ZcN7C*MEx)Hjs#~@2QxYpKUf{^T<<$=Z4 zv+04jGtC{?$c-~Z6a_yJo&eaxrBJib*Wk7k1(Om51^C>1eWC6_ApBOHHQWHmL?xK} zw(lDOg8=W(m_$g@^Pq@26|izVz^@U{xsd__TtDG?+tyvv*;>;DpIlWPoj@jtwYj_4 znkOS|PEP%d&e|NiAm+b2=U>ZV`6e~sC?HY%5iIgzVRz#-x6XwR4mtg^82&s~=UR7= zx_J7_l-<{g$8H(O%E4?by8e$4X>o#=s}TVJ?#9AfdJ!p|(F`dL9gcdYm1;!6{~InJ)k28@8HFH4d8COAbpSiw6~~5 z&ZGF}u>2~WI4zrVMHAL2_x(JWx?@GI{72+7K}!;Sr;s%aLV6@`hea@cxaL@bHKE}V z!l(;?l8!de85fqiP6TG)ZJ)k(vDQ1gP;YN(<>@BrAwMi$QVdaG3Zr)8^mMf88c`M> z$0x&)z`S3iAXxSN(O$`@WK8xX_;AR=F_x1Q;_fwaU?QMNvYc2Wqs)lL*l4|oIcxOo zOjuIc&wF?NrS}1qBa1u!tlYopNtKh(47>4ycG*MOhha}`)KtOSy$IN^>=MCdUo<{G zOq-8-&O7ZTAX^nB2jch2I;k&MV;41=pi?olijMq&rMU5Yqm^_p1j19Yz@u)vGkuAb z9kgZoz-`0pBC(NWRg$?-R8qaKcvs(#^q&RK$nR^S=HrG9Uj=d-MCu*ReT=$ECQ4OU zUBtPk5&p&@sZ8+Q45W5{i@Vlaon|}aM6MhKZWg|XxR86V8!2o`01@$Zg<7+6oza%(YeNvab#LPwY67MVegro5o$o1Yw zuCws7b*oE33}tSmg1(7Wbus=9J|_NSBZ}_g7Rq0j=YL^aeUb6?g6gxI9Sq^K7 zCkFGnL6)arQX<5qPBExLLdB^@<;%rvv@N8Vg8r#q*1Q1OFRTdg)&2HODNn?4SUZ0f zB4LJ58R{<;GM&gE_vef}8HsYp)?l5&qU?I^B^|_0F>M&`G6f+uzhj1Nx|7*;BFN`V z9gBp~gPcp+FsWdrFg{Z#Oo38nD)Kb+unl3lwNq|(>thw?l2-4ly+PrLrFR8C1mb6h zeQ5m|p=E+*Bcp6hexOh5KkDf{W2WUt0o&W#< literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_metro-members.html b/docs/html/classkiwi_1_1engine_1_1_metro-members.html index 47b0f5c8..9ed26c26 100644 --- a/docs/html/classkiwi_1_1engine_1_1_metro-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_metro-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -70,30 +97,39 @@

    This is the complete list of members for kiwi::engine::Metro, including all inherited members.

    - - + + + + + + + + - - + + + + - - + + - - - - - - + + + + + + + + -
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Metro)kiwi::engine::Metrostatic
    declare() (defined in kiwi::engine::Metro)kiwi::engine::Metrostatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    Metro(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::Metro)kiwi::engine::Metro
    log(std::string const &text) const kiwi::engine::Objectprotected
    Metro(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Metro)kiwi::engine::Metro
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t index, std::vector< Atom > const &oargs) overridekiwi::engine::Metrovirtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Metrovirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    startTimer(duration_t period)kiwi::engine::Scheduler< Clock >::Timerprivate
    stopTimer()kiwi::engine::Scheduler< Clock >::Timerprivate
    Timer(thread_token producer_token, thread_token consumer_token)kiwi::engine::Scheduler< Clock >::Timerprivate
    timerCallBack() overridekiwi::engine::Metrovirtual
    warning(std::string const &text) constkiwi::engine::Objectprotected
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    timerCallBack() (defined in kiwi::engine::Metro)kiwi::engine::Metro
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Metro() (defined in kiwi::engine::Metro)kiwi::engine::Metro
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Timer()kiwi::engine::Scheduler< Clock >::Timerprivate
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_metro.html b/docs/html/classkiwi_1_1engine_1_1_metro.html index 99cf1ebd..fb42ff69 100644 --- a/docs/html/classkiwi_1_1engine_1_1_metro.html +++ b/docs/html/classkiwi_1_1engine_1_1_metro.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Metro Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::Metro Class Referencefinal
    @@ -75,74 +103,114 @@
    -kiwi::engine::Object -kiwi::engine::Scheduler< Clock >::Timer +kiwi::engine::Object +kiwi::model::Object::Listener
    - - - - - - - - + + + + + + + - - - - - + + + + + + +

    Public Member Functions

    - Metro (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &oargs) override
     Receives a set of arguments via an inlet. More...
     
    -void timerCallBack () override
     The pure virtual call back function.
     
    + Metro (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +void timerCallBack ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     

    Member Function Documentation

    - -

    ◆ receive()

    - +
    @@ -158,7 +226,7 @@

    - + @@ -175,22 +243,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Metro.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Metro.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_metro.png b/docs/html/classkiwi_1_1engine_1_1_metro.png index 5032c76ac6bdaaa483855678f989bf3d1114f11d..30f2ef0a07f3bc724f20a9befce8c0d38e7ebd7d 100644 GIT binary patch delta 946 zcmaFBahF}OGr-TCmrII^fq{Y7)59eQNG}884i07@8TBE7d7`3qeU7J#V@L(#+qn-n zZPwy(oj!Z!zW>Vc{TeK++2=i=&Z^mN_Vk!)%+6DK zr-Rj9ii;)FUVltJ_dVCd`>-eMGe zCimpGWY5W(e_sil_3ICOz+WqM=J2BWzM00)WHx_%x%9#|+n)5=R|(e+e*Pb1a$ND& z`gazW`RAp*<9lXzBYno(dp0S*es<4&cecEHpSMD$)s(J6yHV3KuByEr5{UkXuVwy|Y;V5*bHjB5)tC8N9g7+N_W%R0ttOml zitfzB%v0x9AKWqP;m*p4V{P_F#qWKBW)<`7fc^V&C^H=s;nxy&vYC)^+OO+=6LGeMl;lcGQt~TWF zd7*ZB|7P=Y&MRjEi?^Nq68m}DdF?Fo%h&I!dfM)+YqhgTvA5~JYjD0V&-2#H|A%VI z9lVX6Uhbd$dXe{~a&TfeFhxcG><9Ry}*ve*huz( zKU#o*!>b;9fW4GIHfLGpuKhC@-mQa%;Y-`JyzOz%ZQ0h&-f31ZG=KFBhWbl2%VxaN zp5guT<7p#f-OcBw9i8I8{mmY!HQ8&$s`u%ND*=HZ&-|V@7t>)~PN&LIZZ_WB1kiBnxh2BiQg2?;7mRKgmMcOpn zKVdveT#WyLc~M+RL%s$yZOk%Uo;fRT{eK2yN#}qA*E`&RxsZXw)78&qol`;+0E#Qg A9{>OV literal 1120 zcmeAS@N?(olHy`uVBq!ia0y~yV7v!p2XHV0$%fu1Z-JCVfKQ0)|NsAi%olIImi8Z- z0AzvjfddCvJMYK?xf~@ye!&btMIdnXREQA+1M_=N7srqa#b>2%e)=;n-EG;wWJ-{2?%5ii;x{g9drsfb{;BDn=9$jozpt4?F5ZrxELlBg*<*`ksrOBJIc_s^8w zR@MEpyVfH(S&Jskyme{w z(zR#q^%lO@JXbo+&eiDk9h=$OduQH>-TQOFSNZ7I+q0|J-}`rU|9*Gp?~V6T{~iB2 zFQRH%z-z_SmcmyvuBCsS=Duk1v~13}ofhBir%iWQ_eMjzf3rEivgi6u@pH0u_FkzL zNSygK9Q&dxob5COx`WJ@4Gj2n%(*u({!&3I*0D)c}gzZ zkjJKTpQZI)>4(=Q-K>w&Rg8Ozw%?v}fA`(6KW%Xg$G3#fW}LOqb?@0Hc`5o0 z$x79XcZ6Mq`o5T<3PTb3o*ZGFE;Pl(F-KOjg3?J;0CIi(~k%jFX zub0M3Gnlv=`^#dQaL(9eLt$U?yDxrcy~|@27m7cynfh(5bid~d))lUzd;fmzFiGI~ zy6v5A?d8AKayDi+7M@<4FTd~C!!(Hl-YszrpM8>y_kK2gF;n`}Y)culGnedo|IAZj z{vaQic)!i1v&&ikK=z*S_m7Jgl)o@Dt@FyW*8Re?$7AoKJO5{F zKF?-<>fRsGd9wW%xC?r + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Minus Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Minus, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Minus)kiwi::engine::Minusvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Minus)kiwi::engine::Minusstatic
    declare() (defined in kiwi::engine::Minus)kiwi::engine::Minusstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    Minus(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Minus)kiwi::engine::Minus
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_minus.html b/docs/html/classkiwi_1_1engine_1_1_minus.html new file mode 100644 index 00000000..b4bde47f --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_minus.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::Minus Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Minus Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Minus:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Minus (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Minus.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Minus.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_minus.png b/docs/html/classkiwi_1_1engine_1_1_minus.png new file mode 100644 index 0000000000000000000000000000000000000000..33a218ee61211dc5bd90a570e74664de97cf9610 GIT binary patch literal 1298 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~S?KBF7*fIbcJAv*s}%&;ZuhU+^Ius$ zT!fu9`I@Kf+PSe-66HvJ1Kw7x@+#Uf}@t5^e+xwH)oo5`p%PI)^2o3E|pAs`7wCT z{MT1?L{DcdJDinh629}3$?}!&*F<%_*{-TPEA(dJ<=oS+ZokPfovwSkPnB0~>*l*z zW>sIr>aH)pbSL-M^I4WjeWt6;)(S-RwP)_E%g$KW{QQ6L>YMS4-oE>$Tzmb}nY$P6 z=zW`*R%=#1vF=Y&d-~_Q%kr5#q{>!`zkH??@o2N?%WQ>Pvg;1rJ<_+gasMyvFAqa? zJZ+sWU;MOswWg)AGl^PRS3>vh-*=65Xa5^lX!MY&@Ouw&t29FH9g}%=701nHkiN7Wl~g0cKgTk zCO5WP%YB=(OeJ=)#y7S-Yb=+hw*3ha)0m#pzEaD49=A`h@vS?nO=cL~j+kV&=X%W3 zQ^B6W+r+NStn^&H^Y#9;Nmrh&eYPq3wq*3>Ez9n&Pg{KVtFQfqGl3Vc#xyNkz4KeS z#q88Of9^*uTpVf@ceeS$^exLaD~4SD_&R@A=a=_$&iXQh7OydkcK@}ks`Gi|R>_y2 zUrt&gwr;%Crvr&{f=$Io`Xob*K&mL8I>_-HP@&HUgj z_k({n&Y!JEn79_28=e;%f=NUBL{HnT%>PxB17W-=s7tad*C8@l*Z`$>Aos)dQp?Nmq zGnS=oS!GuKt1{01Rit0mx}v8mm)N*#t}y;QDQxqq*nQWW&*dw5n%168-M-EE*2VI$ zvQu}nt~t$)z5Qi!%H{PY#UUl8xfkA;KEL&pA?9k#^Yj1LioRNx_BkhPtJ|Ad&$d<9 zUoLOI)E52nqTI(_X`&8S8&YpS`?>=uTm#C+4@t+^$476$JY>HnF3?dcM=1FFZgkESrl7rGUD z*`GDaZlC`E1T&$DjJJb6v5b^9lEP+knVG-WMoX zi8}9WdeiN`+|1r*>(mc0PB&Q|zj0sMI7Gs=xQX zy5;@tGu!)DX&JXef3Wx@-UV69a`)uj%Urqc{^onR%YE4`&R(y(_{U_mE!&49g{E(F s`5tt>U&dV13QZdlrtOImdFSnA&m~__oN!PPSb#Bjy85}Sb4q9e07R>DssI20 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_minus_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_minus_tilde-members.html new file mode 100644 index 00000000..37a423af --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_minus_tilde-members.html @@ -0,0 +1,147 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::MinusTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::MinusTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::MinusTilde)kiwi::engine::MinusTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::MinusTilde)kiwi::engine::MinusTildestatic
    declare() (defined in kiwi::engine::MinusTilde)kiwi::engine::MinusTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    MinusTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::MinusTilde)kiwi::engine::MinusTilde
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_minus_tilde.html b/docs/html/classkiwi_1_1engine_1_1_minus_tilde.html new file mode 100644 index 00000000..5866699a --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_minus_tilde.html @@ -0,0 +1,275 @@ + + + + + + +Kiwi: kiwi::engine::MinusTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::MinusTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::MinusTilde:
    +
    +
    + + +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + MinusTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_MinusTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_MinusTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_minus_tilde.png b/docs/html/classkiwi_1_1engine_1_1_minus_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..cdd85281f6d8f318cbd4dbaee154d94067f735a3 GIT binary patch literal 2282 zcmcImdr(tX9=?enh*+>L+X_Xh2B;vGK>-aYMWOCR8<0nEE(B1i8xmsV5#$Y(szXs( zA|OJuyr0Pp0tqoOJgPjz0)dbO2~VY{A@Yb2P@a3~w4G_EGdnxGduGl#-#PdGapw0u z&Pnyao!q8lr~?4NHt=sQo&bQtBlw;6CS*+3KbD6~AA6kkc3odzN8sx>YFhfEe<0}R z-rU@*nL1>GEVUy&ab5uO(?*j%^|nE_Vn7#X?`YH%LrJg2{zY@pHEU-5Njqxy7W;b# zf2`K%*R{$C4G+2VrYVxppKuH)FS=9WZVs7t;5cq{1~Cic&}#uk;h1WCg3Of8IbO+n zbSb^5irCxiZLRlgY7z~ZD)h;ad8r?TLK1RhYld81cTrVgZQ$+46m3Nly#I%jYDwq2 zHh0zR5L;GxJ`|2Ey!oO9O6yc8V$=}{RgCW@spGaJ%F~4tuQIxL<>Lp*#=P11X)!F2 zQPZS?w{5aV0m44w(be6vaqx-j@_u;>tCXdBP_gGn-d3WO&Gq#YOj_KQ?kmgLvaBan zGh2xaYU5FOY5;P`5%)ZwJO3(~|EUSp=|Eut@7#C0c(7wEO)V+ z?L+U(r0oZj_CUqz2Iv;P*oVI2!o&=u;=$S-Fgde^MK7ZP11bPM+=)*Ao9)tMXd08*lEovIQJq2ISy9^>#Zb0YMn9q#+MEzehF_r*OCe)8lZS{QZH8b?_Ola z7Cbk5ah)NX)P}x)Uym{>X9>q)lZWX!s^|`W?CG(eFY&6!v;QyL}t4N_F|7+(9O6E z^lj4cPD+Bd_XYB*U5W*7DFWI<=X6`b^vIl5HYQ8?QDIY$1$gq^*E95ahfpYxstZnh zhX=7=WG$M8Zkj*{(EuoM`sqjP_qs3@8?k?&i|>DuCbK@k=B@Z zBz<1-t6Y9lb_aK)N+fWh%bu|b5=WifD3c_gA?Tfy<0dxYTji3P+}(Jw!d%4O=Kg~_ zv-^vKJ;c7-eh^)a%CLV?_PR1lJnU`F9?ka~l)vZx^ZUuIs zRUW`3E%W`Kk_Kk^3EC3KH+{^aFrjq-d+KagrjkMkkIQRUUh{qAHlO*T{oweS-g;|0 zN%T=ZLelAn1sKKpToFv|m767kOGdreiCEA^RRvSA8W@Gi_CGRaE|Jp+iz*=A;YuVQ}6e3cYLmf6?{E4q4&cnRPx&s*{wsvG{ zx)UfbgV$2mVB#-m#S$n_t|AZqL~L9mD4!q++6Cw0YijPF zwS-tQ{8*^3q?FR1W>;NBdvZJvQewE0C6=+?w<%Cw%aw0V6eLy5h2H_|@yf{oxdgvQ zk1ab@%9^MrsQ7i~${&Y+P1w~J3)j)I?;E1}><;h+9S&+kBi_tj(n^3tJ+m-UC5DuB z>YBBAu{GSBypXd4|-r&>*bLAh0{oa-S&Por@yE7tEan%0A zq5i#Xm_W4MGXFL{*-5339|p3$C!3tfNvjgw%$$6w^zOWCpQoiJ?RBK(_8rpfXtu1d zrYtor#LA|;Tro*4Eoks@avSda(xsT&BBX9Yt?b3Ww9X4P@M7&Z?qYOu4vhGd2!~X* z(DEmBFs*{!O>f1HI%>#rAN;ht$4QbZ0ImF(+@nQ24tp0m&FsLvTF5Sb+8C{T!SroZ zhB8c9ZJmz!qQsOM!74#M+?1%DnQL&vw@2r4PSU~W)nY;8In+>mKZ!7WAGp*wtq(*y m{r;Lms6a}wpaO&`>wq(*f_`CNupja;0YF!r3;TG`)qepv>u!Sp literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_modulo-members.html b/docs/html/classkiwi_1_1engine_1_1_modulo-members.html new file mode 100644 index 00000000..6d1766cd --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_modulo-members.html @@ -0,0 +1,138 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Modulo Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Modulo, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Modulo)kiwi::engine::Modulovirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Modulo)kiwi::engine::Modulostatic
    declare() (defined in kiwi::engine::Modulo)kiwi::engine::Modulostatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Modulo(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Modulo)kiwi::engine::Modulo
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_modulo.html b/docs/html/classkiwi_1_1engine_1_1_modulo.html new file mode 100644 index 00000000..25644b7a --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_modulo.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::Modulo Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Modulo Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Modulo:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Modulo (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Modulo.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Modulo.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_modulo.png b/docs/html/classkiwi_1_1engine_1_1_modulo.png new file mode 100644 index 0000000000000000000000000000000000000000..3ae17a1362dbf1dd15a9d63c6c2c933b75c4eaf1 GIT binary patch literal 1301 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~S>oy97*fIbcJA9vs}*=$r_Y|b@4s?< z{|`ZdHMYx&OZ}qCE(#YEpCvR@=v0MrJ zV_T#XOt0{@2b&tGzMK*@Lpv#djovl)8NrduPWl%I=gm1Zb@dygy{1kkX6p~@*w&r- zxwGfltqnbCRyiVU#m&+4pBa6f8yG&hHu_Xkz#X>p_k%CKXgZr!r?HfQhfp0T>& zKI7@lJE^}u9^yOyY`5=vArGmtrPE(NQ;PVsdFsn(rCYLkm+n64+uOMRm;RTBp*o(n ztjm<2hA-Ci^yBjJ{1lYnHEFurnJGcL_A>1G%CuwuyvCnZwoRWUXDB}vwvcaK?zJ1ng)!(Fky(}@?p?tRcn~eBz(ZTk@LY)BBN39D{Xf zTXtT5We|ETa+22G<98lhTfWujYMO@jW{>WjulI*ex^gZ0OzQSmlF^s9EW7W%`C)nO zWqyO=uoA=ROI{}B{gplU%qs8SHl-4grH?b@mh4-yc8>4DAlZHYmd*D0f9~cQp%pWd zPv11Uy!x5y{PZhn%g!(No)lH|SNzw5Nq;}sl^wR(wM%v7rT>R&${oFpo?f;$zwSGI z$$Je0)sxRf84vGU%g1d4QDWp7t;`3+uCwN^l^?m%OsP(zQ@=wNY*UX~&&S#wD2@Wos z$9wE*PuP}ce)i{Y`&*v&Jj0t;8|6JO*>uX($R$U0qNZOjI#H=QDP&du&NpGUi)Cxw zQxlHTm?+l3pg8aWF*AD1Sr zTA$$e^tkHj9^124QEI{aZUB?lhIP@Vx5NK$T_whN;}bYTUNZ`vy>QJLrMCvh;;LoY zzDgLcmthOu*1PJ_MT0kCzn4in1n)mK=ik9!Gj`sbGxwU-9)s7 z(k;bRy=&C1Zhc{{mp`M_$o0YU^7QRhzTU-q{bs*3d#Imcbs)3$>-{tApYP6NjF}W{ ta{rCw0o9+mRtK)bQbsSxPus8Czde`y@{@aNHLwh0@O1TaS?83{1OQQ~dXxYF literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_mtof-members.html b/docs/html/classkiwi_1_1engine_1_1_mtof-members.html new file mode 100644 index 00000000..949b9e7e --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_mtof-members.html @@ -0,0 +1,134 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Mtof Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Mtof, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Mtof)kiwi::engine::Mtofstatic
    declare() (defined in kiwi::engine::Mtof)kiwi::engine::Mtofstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Mtof(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Mtof)kiwi::engine::Mtof
    Mtof()=default (defined in kiwi::engine::Mtof)kiwi::engine::Mtof
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Mtofvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_mtof.html b/docs/html/classkiwi_1_1engine_1_1_mtof.html new file mode 100644 index 00000000..6a1a2014 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_mtof.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Mtof Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Mtof Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Mtof:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Mtof (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Mtof::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Mtof.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Mtof.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_mtof.png b/docs/html/classkiwi_1_1engine_1_1_mtof.png new file mode 100644 index 0000000000000000000000000000000000000000..99b4f5002d997d7f6b63b2c423c107dd5914eac0 GIT binary patch literal 989 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GUUo-U3d6^w7^KAf~zL4fUc|EfLzmFH_K zH7glzoouysZmgAr#6s5gKdMWoyyN$r^v*BCYm)dvP0zTTS(ATm(VcWkn)7-~SACuMEa;TU&#bqn=AJHks@1M@-^$yhJpb?%>$+K= zOLxzTc9%SRCqTC+ZR+iH*EZeRy(-W5TePO@=1l4KcgnN#S8u+m6TMB|dzR13@b;^3 z?i6nO&|WQd_VBX$bu*3A*4#YuC1}MSIkio7uQRS4{QQ6ERh#%lf8WhZ|D|~8%-xH3 z^uKv*t~KYMX;-)5;qIS#m&-X-eA|nry?myi@$=^CFS9zz+Gm%T?@ac8u>K!cZH0*U zCCP;^Gk#vZIz>g@DR|Nz4qwktN!NTdm)>T6aF+YQKO5)IU#nW48=It`RhHeKw!3g9vT#-8q-P)z4*}Q$iB}a{%MG literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_new_box-members.html b/docs/html/classkiwi_1_1engine_1_1_new_box-members.html index 7426bdfb..35ed0516 100644 --- a/docs/html/classkiwi_1_1engine_1_1_new_box-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_new_box-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -70,24 +97,37 @@

    This is the complete list of members for kiwi::engine::NewBox, including all inherited members.

    - - + + + + + + + + - - + + + + - - + + - - - + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::NewBox)kiwi::engine::NewBoxstatic
    declare() (defined in kiwi::engine::NewBox)kiwi::engine::NewBoxstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    NewBox(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::NewBox)kiwi::engine::NewBox
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    NewBox(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::NewBox)kiwi::engine::NewBox
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::NewBoxvirtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::NewBoxvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Object() noexceptkiwi::engine::Objectvirtual
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_new_box.html b/docs/html/classkiwi_1_1engine_1_1_new_box.html index 69c34496..9266f6ef 100644 --- a/docs/html/classkiwi_1_1engine_1_1_new_box.html +++ b/docs/html/classkiwi_1_1engine_1_1_new_box.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::NewBox Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::NewBox Class Reference
    @@ -75,69 +103,111 @@
    -kiwi::engine::Object +kiwi::engine::Object +kiwi::model::Object::Listener
    - - - - - + + + + + - - - - - + + + + + + +

    Public Member Functions

    - NewBox (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    + NewBox (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     

    Member Function Documentation

    - -

    ◆ receive()

    - +
    @@ -153,7 +223,7 @@

    - + @@ -170,22 +240,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NewBox.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NewBox.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_new_box.png b/docs/html/classkiwi_1_1engine_1_1_new_box.png index d0583b25c57b4eb30771e9f5038f6130290c496e..924d47ca51e4e4c40460cbbc338b2ebfbf0a8169 100644 GIT binary patch delta 963 zcmX@l@|In(Gr-TCmrII^fq{Y7)59eQNG}884i07@8TBE7d7`3KJ#&qxi(^OyR@%DT1x3-cxhw>uwd#@bCn$Nz<8vC+!I_ z5dWO5JIN&Atx4YLUxv$^8|a!v4>euM4X{3pMk7rV3AJA7Zt z^tbmFT(iqLH~0TAeE!>P_R{*~{xr4_uI9*xr|xdfO`gBvXv+V$xyN&Iim%_>{PTOt zwi&-Cecia^=$4O9C!9UlvH6JnF_RhXuK#6>!_UZU{wO*1!am!c^uOi@)*Sr&eQnOX zl&pQxb%UxR`;(ci*)8&buR^ObWqRzTZrBc&C^`y6UnwMs59K*dThM4&82Wo8c z4p#D?nfi%uj`_hJFZK_?2}~8528??|W-!EY`7r3Ssx?e!5GZSB*I_KY9XnJwp;;zGG8_!L;^3pV|Rl9s??)0n-{b!20&k}3)dR&Uo zH~fC}Rl1C?@vMI{&Nkk^FJ9X;bM+&UV*OdcXRPie=1<%4)B4l}9q-RMeqQlGx%Ka- z1*{g{_u18a>c6>rZ;A#OyRW^u?b7add*{txaoDT=ot~%E$*;O!4l4eBSox;S(t4Nb z%FF*-f4*v%mU3&kzWH_6=}X>gfWoO!(=#p#+VuOWax>0KG5s{G@EP@4tXmOWVgJoWVf8VC?=y@4asoIuX%E6+sb9 z1kL=l79yfZ%h~q)7>CKv8Ug|$qI;63uM%bi$8`nsoxB!XIQ=oj&Zoh+nrvs3I2?m@ z9trfhawpd@sKF10-x5smI>ZE5fBD8_QHChr?FcO07eZ20B}qEl!##U z5KC}euYXzU&h$?Ur#YtB`7{_;P4Kb~*_>VKB?RgzcXAzr8vJ1RH9?SV_VxtE#d+AE zIfZ#oSIUt~`anxGtwKV;cfm^n+hbZj2{PI2y37Qcn!mmVQ7MeUHJpw1+45EJghOSA z*mM + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::NoiseTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::NoiseTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::NoiseTilde)kiwi::engine::NoiseTildestatic
    declare() (defined in kiwi::engine::NoiseTilde)kiwi::engine::NoiseTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    NoiseTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::NoiseTilde)kiwi::engine::NoiseTilde
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::NoiseTilde)kiwi::engine::NoiseTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::NoiseTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::NoiseTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_noise_tilde.html b/docs/html/classkiwi_1_1engine_1_1_noise_tilde.html new file mode 100644 index 00000000..6f4efd57 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_noise_tilde.html @@ -0,0 +1,335 @@ + + + + + + +Kiwi: kiwi::engine::NoiseTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::NoiseTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::NoiseTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + NoiseTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::NoiseTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::NoiseTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NoiseTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NoiseTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_noise_tilde.png b/docs/html/classkiwi_1_1engine_1_1_noise_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..7470b8e8c9a4d6668da4e39314143f797c2122b4 GIT binary patch literal 1848 zcmcIlYfO_@82%7Cg&|BB;6PwP(OHBVrywN*ryzVX85Ss`KnD|{rCSw+B5TV<9ra!< zN(EO`U^rX8R$NOhgi>`1(oybTN4XR=T(lGfxhr(V%w+D*vMf8vIq!3F-sC)aFVA~2 zEHr4PnY|eR04u@Z04x9);S5;5!q{*UeQIJ1W_8#X5rKNW-T;S3rqWsW&KuC1Etks? zCwrU?*A;2l&~U)uw6r=KBQ^uTd-Y(z=MhJYblhi$CNLkGbU#J)=`Wz23CPU*(vPsK z*X`YR{+w7eP+B+1(A4<@oDxo1#(KQlqfpUqHkWt_>D!6|sh)f>-%o1~s;_OqCG;)` zdHD2AQ5%gdnDYR{PCMlR{nAz|qi)R-!9j&0bIrr@>*JMy)}0-wg!k%VBlSg%W#XH@7IC}0>UPyf!I;{63UNqWWEGm< zTb)|p_mI%rPOPO{%}U|N$1$+_*KZx8!>fOGQ3x$t@QLR78&vJ0ZLCa3!+X2%EB&`? zCkA}m)Pu14F5R4~v|DaE=qmDBUeE#U_EGV_?o4vf^gP>kV03l5@X-B^url@y^wR*{*EIP2v*_PVT%Go@89$)1R7oJ3&eQ?6PhfaqG~4 zHQG9w@Vt3Euhi6Eg)fiFD{kDxl9tp)C@RE)QM4VX9u&c)U4mr%uHrMo^_}2ptP>0Q z-9&_T%WzxEWAo?ZQ8nqV$^w(nCaRAFqcgblbeMo`7Im$dFOs9k46AQbJZAJ<7=?f~ zkLJOtDSKIg5bd1C;3@~hA51Vlx$0$>FO*)HgE0+m^Gs${oLz+dX7c5z z+**{xsfl_ih9&lU1hGX5Q>bZG%VeL-rgN^v>&xZCX-BJ!!h7;v`zzpMT`+j9C`KzO zjF5I*eQA54?7L#prLy)lmTosMIv-!$&PQ?|GnayPi^N#`CK%<0cY9{iDMf?zuhZf* z{75z-FPe|6z4*3IN+Q`KODU0(b+2UEG!(?p%p9=Hx#A%I;Z6g+)JEQR1qbciZ}YFqYuG?28}JN7gJbWs_7dgTSaK8t z-pUp|$kOr#2(6PeJ^xA7J^wv?;YBY_{ZA1h&hzWRT>Gkf>ma@nZ2EK_f8#TFBQ?ui zVynT4?lN1yydvAFJ=idEsz`YaGnFG5>Z-S|N>&sRC17~PEyYF}GeLD5TkfklUJa(DB zIbS9VB-37mw2hsB=PEcz>*o3Sa^%NgcEDfd?M)2A$eNjjZsQla9$;BcJ`r*7aLohv zoWdm_u@?e_5}STR0P25e>OZyO2Z6SFW_dq0_M3I7xcqXs<@sVg>NI|hpX#Xf% z=oB*@H1{zC)IAZ5fXU(ADk9@z_8#NT0$M}0%3N9AghM^=^~u=Ow}tOix^8S=h$*6I zVlDpkZ*$$TP8@72fycyRzUoje!1xenG(8(wJOKr6EQmos0Ul{8M?rBQm*OoFU}jw) zR(R6a+Ll=Vqk)sNB~h6fb;m6CEMuXk_V%vvq}7O@W!_A$ow3Bswz%^5*AFFF5v>MQ zL-2##&f!m(^K`nZIX;DAO_Gw*;?%s!upPPO^y9dk_ScV2)rDx4?(g>xD5%=$CHsmE o$Q6In$oErp)dCs~Al%K)4LT8Kbneq~! + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Number Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Number, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Number)kiwi::engine::Numberstatic
    declare() (defined in kiwi::engine::Number)kiwi::engine::Numberstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Number(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Number)kiwi::engine::Number
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    parameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::engine::Numbervirtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Numbervirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_number.html b/docs/html/classkiwi_1_1engine_1_1_number.html new file mode 100644 index 00000000..ea5a8d3d --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_number.html @@ -0,0 +1,303 @@ + + + + + + +Kiwi: kiwi::engine::Number Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Number Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Number:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Number (model::Object const &model, Patcher &patcher)
     
    void parameterChanged (std::string const &name, tool::Parameter const &param) override final
     Called once the data model's parameters has changed. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Number::parameterChanged (std::string const & param_name,
    tool::Parameter const & param 
    )
    +     		+finaloverridevirtual
    +
    + +

    Called once the data model's parameters has changed.

    +

    Automatically called on the engine's thread.

    + +

    Reimplemented from kiwi::engine::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Number::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Number.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Number.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_number.png b/docs/html/classkiwi_1_1engine_1_1_number.png new file mode 100644 index 0000000000000000000000000000000000000000..701008403cae0cc494ca71b4c8c1366be08ca168 GIT binary patch literal 995 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GUgo-U3d6^w7^KAf~zL4fUc|EfLzmE*%i z*d2Y$CR?qYtFu=^Vk2wYAJwH(*718zTIZMHHA#G-re~bU*^_^^>rT3o_}V1#^5^7P zvlzV&+a>&1(YH)xuZ#a?4Y}UZ6xL>T`gl&|Jvu`=G{D-?|r;H zXZ`D&IU*7JrMLTBc?vt|BO!Z&GUz}YW zF{zKk*ZuVRbIVjL1!qlq;tKMr|Jf-)yKETl*)Xg-Z)+moA6;?J`EzC^`}x@!Zp)Z| z2+m@NYf)|MF)>gIb== zo9tPWzDT-$%s9|*`h1g}V*FIjQ@S@3-<>+>-OOpaShsv?!_G|yCvABgQ#@HaeCe61 z*8;+ysjf{c{vYNUG(Y%k>DF)lZ)}%+|50XUT{vI=mxFQo(S^@unY7Qk{gmVV6P3yQxK7U#Qg7W4kcuI4lU&E31xd%-Ko=yTU*?t2~gxiau=+OJK!RaUmY zUVlNl{mty>8)rXz@nYH%+5g_3-!x21Iknq9Z(X;Z=Y2&J)sx*9rl{!8o29w5q>^Dz zB}2^o>I^%%?H~5EKfC;iZ=U(Z9v}7($|j6^ID8rOorDi`Utsy5gqv%>#?tq4N$m^< zU|NHOXpc#8|6BR}mmKr0&v-9pjJCYa@}uK<=BM1VJO8+(Y`ZakaZcVzzT$AcI4PeO zRt_sqm5SPgS-!rVIn5|M+BtUS^c>Uly=oPOY#EYS>sE)}oceWDN!hP5&)MbH9CB|P z?`NH}PdGkn=k0x$9Ev&rZC!TP_o-vq_x`lar=~1?#x42Pi>vh7(y!8bRq5}`zNsBx zOlP0uyTEJDn#-Ghe}5U!zCH2n#t+fH4by+V>z~>E?B*oKnzr*fw=T;ZklpUe{zDF$ jHa->~@w;piJGcJBd*=+1sckX99LeD6>gTe~DWM4fDL>@P literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_number_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_number_tilde-members.html new file mode 100644 index 00000000..b6411777 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_number_tilde-members.html @@ -0,0 +1,147 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::NumberTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::NumberTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::NumberTilde)kiwi::engine::NumberTildestatic
    declare() (defined in kiwi::engine::NumberTilde)kiwi::engine::NumberTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    NumberTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::NumberTilde)kiwi::engine::NumberTilde
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &intput, dsp::Buffer &output) (defined in kiwi::engine::NumberTilde)kiwi::engine::NumberTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::NumberTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    release() override finalkiwi::engine::NumberTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    startTimer(duration_t period)kiwi::tool::Scheduler< Clock >::Timerprivate
    stopTimer()kiwi::tool::Scheduler< Clock >::Timerprivate
    Timer(Scheduler &scheduler)kiwi::tool::Scheduler< Clock >::Timerprivate
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Timer()kiwi::tool::Scheduler< Clock >::Timerprivate
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_number_tilde.html b/docs/html/classkiwi_1_1engine_1_1_number_tilde.html new file mode 100644 index 00000000..96eb098a --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_number_tilde.html @@ -0,0 +1,325 @@ + + + + + + +Kiwi: kiwi::engine::NumberTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::NumberTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::NumberTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::tool::Scheduler< Clock >::Timer +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + NumberTilde (model::Object const &model, Patcher &patcher)
     
    +void perform (dsp::Buffer const &intput, dsp::Buffer &output)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void release () override final
     Releases everything after the digital signal processing. More...
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::NumberTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    void kiwi::engine::NumberTilde::release ()
    +     		+finaloverridevirtual
    +
    + +

    Releases everything after the digital signal processing.

    +

    You can use this method to free the memory allocated during the call of the prepare method for example.

    See also
    prepare() and perform()
    + +

    Reimplemented from kiwi::dsp::Processor.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NumberTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_NumberTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_number_tilde.png b/docs/html/classkiwi_1_1engine_1_1_number_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..16a9f99892f06639dde7344e27abeaf738ea3fb5 GIT binary patch literal 2533 zcmb_edsI^C7B|bWiy^nt9+tYA0j;p?l46$9m^og`S85&&6jMwsAAnEPFtgEGHrb$L z<^#K?jA@wmQc&=b8mO5uX67psP(w`d(Kw>qgLnRzx!qZJ-L>ww*4bx&=j^l3xAyn@ z{q}dw&BYN4F@R`jXh5-lKklxfp@{_jhV^Sfs|XWOz}q%ACr<~JN(H*(lk+i|O*cVr z^=fEn(7HBY3{KZaySsR3fI;ffBlJXRX#6D_d)&@5evN#vKcSej>AUWc;idMaqY9TK z4RZCQZov&7$$`{;`j_b@CAhKK#iZj!mzEEi3TAc#{=q{1-9?VInp$(afuc)B5{TZb z;xS>_;_y?r01_CyIrdkjg>%N5v@~i%GY%mzkw7LpqS$bOM@20vzS{Cl=?)1*X;4U# zPzHK`{Z;-ZMqa0PLpEVRS$yJdhT*24odS|934B+X@D(*DuyX9XX(9GWzabDdgleu?rUM}<^b z4jyUkHt9tOz7gub%`HS?s}Bx-??R7sXE(geM!J2Q$&8bjdhP-IBUkKvv2?z3t>zIA z_P1+n|5(=FivC%=7P9;O8g-FJMvI9lnnvnaL(J(tK1G+()%lnxEy(z(FB7cp3qD0N zVfCk!|8r2o5(UHTauoBkcPZD6!L5xRAh8r1Ap_o*O3{if#bfDK_dsL2iWdf)YCqJ* z@R;R?W9gRYL{}!$#DC-G__uH$36~wMz$M?W#IH{ zjJ2SWUp{(brU1V^n3P|zL@v00_iVy>uYbe@k(c97(6=t~keLdc6pfMj76%!yh_TmS zA_N!eenftz=9(`xW6!ffP61vYRz{5GJZZCGJWROE;s=34RuP=a2&|zLR5=4vn>iE0 z_~pphlD>n%eH9!^JEt#o(^Z_E-q3<()CgLzvsL$B5I z8G-iYjWsQqz@W~&_v0)vB9jk>?1( zl}{Wxyz61_tcl>l&R2}Bt09=%@lm+fsvOV}d(QOs1 zSVdYkh+l1xI!@rz$QOK)BniWWy-40;f5^a?6mo+J?*6~9IXdn^Rc;tDRcnGSb2D|i z%!ZaWy?GU(qg{cynqbZ^K>jBf#ehRsS8qDv=ht@s&Wk_!@!Y#3exW=UQ8%4fa2i0n zhiDhpt44Et=psA|Yvy-VK$_hV&bUQ3nmSsVstN#FCk%PeHi-q=$+Z)OU^#i~aJ#xc zd}6)nNB>2li;+wY;k z9sN8+EkhCC;}KKR$sz#n8fjI?SyWBE_CEA{Eg*XML~${%=1B@~L|Cj>ND8W_hnaM< zm!n6l*5ULXi7jl0h_Lg74ytuX9HTNjxE2~zOO|Xwe>dF3E?HP;b#|7}L|2r6x&rwaA|8CmUqcKHu z=!Y|hzi7h$tJn|ah$f;Bf9=*l+ZpZNuEzftO(H(Rz4BD}j7D>!?nN|jx z5zd|d53yiLXDg7!yPBVk)a19OO_cpDd_vgrqXP+-ENxy1+jZrG18`3E25(iV7nS}l z(QIA+dY<2b`mulmZ`G#&P`3$8Z8n~Zt2C;i=nO@d7;Zp=-89&*KXpGLttUb|-V-pf zN*oswJLWl>7uCFG5k!4ks_L}|?{~BsSu8NOWlEq@wndB1;cVo?gI%u6Za8U6;9E4C zFAW&vrgIL!xVOsl9OLXt*#jRwEl=MDTbk6|>0_if3-r#7VK35hF7d%5(2+-uA}kwbiGGBeWjKr@=Fs2G+slIQy9Y<$nSM C#pq)I literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_object-members.html b/docs/html/classkiwi_1_1engine_1_1_object-members.html index 6a434582..7965d6fc 100644 --- a/docs/html/classkiwi_1_1engine_1_1_object-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_object-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -70,23 +97,34 @@

    This is the complete list of members for kiwi::engine::Object, including all inherited members.

    - - + + + + + + - + + + - - + + - - - + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t index, std::vector< Atom > const &args)=0kiwi::engine::Objectpure virtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args)=0kiwi::engine::Objectpure virtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Object() noexceptkiwi::engine::Objectvirtual
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_object.html b/docs/html/classkiwi_1_1engine_1_1_object.html index 0ba80cbf..ea260300 100644 --- a/docs/html/classkiwi_1_1engine_1_1_object.html +++ b/docs/html/classkiwi_1_1engine_1_1_object.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Object Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -81,75 +108,180 @@
    -kiwi::engine::AudioObject -kiwi::engine::Delay -kiwi::engine::Loadmess -kiwi::engine::Metro -kiwi::engine::NewBox -kiwi::engine::Pipe -kiwi::engine::Plus -kiwi::engine::Print -kiwi::engine::Receive -kiwi::engine::Times +kiwi::model::Object::Listener +kiwi::engine::AudioObject +kiwi::engine::Bang +kiwi::engine::Clip +kiwi::engine::Comment +kiwi::engine::Delay +kiwi::engine::Float +kiwi::engine::Gate +kiwi::engine::Hub +kiwi::engine::Loadmess +kiwi::engine::Message +kiwi::engine::Metro +kiwi::engine::Mtof +kiwi::engine::NewBox +kiwi::engine::Number +kiwi::engine::Operator +kiwi::engine::Pack +kiwi::engine::Pipe +kiwi::engine::Print +kiwi::engine::Random +kiwi::engine::Receive +kiwi::engine::Scale +kiwi::engine::Select +kiwi::engine::Send +kiwi::engine::Slider +kiwi::engine::Switch +kiwi::engine::Toggle +kiwi::engine::Trigger +kiwi::engine::Unpack
    - - - - - - + + + - - + + + + + +

    Public Member Functions

    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    virtual void receive (size_t index, std::vector< Atom > const &args)=0
     Receives a set of arguments via an inlet. More...
     
    +
    virtual void receive (size_t index, std::vector< tool::Atom > const &args)=0
     Receives a set of arguments via an inlet. More...
     
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Protected Member Functions

    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     

    Detailed Description

    The Object reacts and interacts with other ones by sending and receiving messages via its inlets and outlets.

    Member Function Documentation

    - -

    ◆ receive()

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::Object::defer (std::function< void()> call_back)
    +     		+protected
    +
    + +

    Defers a task on the engine thread.

    +

    The task is automatically unscheduled when object is destroyed.

    +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::Object::deferMain (std::function< void()> call_back)
    +     		+protected
    +
    + +

    Defers a task on the main thread.

    +

    The tasks is automatically unscheduled when object is destroyed.

    + +
    +
    +
    @@ -165,7 +297,7 @@

    - + @@ -182,15 +314,87 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implemented in kiwi::engine::LineTilde, kiwi::engine::DelaySimpleTilde, kiwi::engine::MeterTilde, kiwi::engine::Slider, kiwi::engine::Toggle, kiwi::engine::Receive, kiwi::engine::Bang, kiwi::engine::Pack, kiwi::engine::Select, kiwi::engine::Send, kiwi::engine::Clip, kiwi::engine::ClipTilde, kiwi::engine::Delay, kiwi::engine::GateTilde, kiwi::engine::Loadmess, kiwi::engine::Message, kiwi::engine::Metro, kiwi::engine::Mtof, kiwi::engine::NoiseTilde, kiwi::engine::Pipe, kiwi::engine::Random, kiwi::engine::SwitchTilde, kiwi::engine::Trigger, kiwi::engine::Unpack, kiwi::engine::Float, kiwi::engine::Gate, kiwi::engine::Hub, kiwi::engine::OscTilde, kiwi::engine::PhasorTilde, kiwi::engine::SahTilde, kiwi::engine::Scale, kiwi::engine::SigTilde, kiwi::engine::SnapshotTilde, kiwi::engine::Switch, kiwi::engine::Comment, kiwi::engine::Number, kiwi::engine::OperatorTilde, kiwi::engine::AudioInterfaceObject, kiwi::engine::ErrorBox, kiwi::engine::NewBox, kiwi::engine::Operator, and kiwi::engine::Print.

    + + + + +
    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Object::schedule (std::function< void()> call_back,
    tool::Scheduler<>::duration_t delay 
    )
    +     		+protected
    +
    -

    Implemented in kiwi::engine::DelaySimpleTilde, kiwi::engine::SigTilde, kiwi::engine::PlusTilde, kiwi::engine::TimesTilde, kiwi::engine::OscTilde, kiwi::engine::AudioInterfaceObject, kiwi::engine::Metro, kiwi::engine::Pipe, kiwi::engine::Delay, kiwi::engine::Loadmess, kiwi::engine::Receive, kiwi::engine::Print, kiwi::engine::Times, kiwi::engine::Plus, kiwi::engine::ErrorBox, and kiwi::engine::NewBox.

    +

    Schedules a task on the engine thread.

    +

    The tasks is automatically unscheduled when object is destroyed.

    - -

    ◆ send()

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Object::scheduleMain (std::function< void()> call_back,
    tool::Scheduler<>::duration_t delay 
    )
    +     		+protected
    +
    + +

    Schedules a task on the main thread.

    +

    The tasks is automatically unscheduled when object is destroyed.

    +
    +
    +
    @@ -206,7 +410,7 @@

    - + @@ -222,11 +426,85 @@

    -

    Sends a vector of Atom via an outlet.

    -
    Todo:

    Improve the stack overflow system.

    +

    Sends a vector of Atom via an outlet.

    +
    Todo:

    Improve the stack overflow system.

    See if the method must be noexcept.

    + + + +
    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Object::setAttribute (std::string const & name,
    tool::Parameter const & parameter 
    )
    +     		+protected
    +
    + +

    Changes one of the data model's attributes.

    +

    For thread safety actual model's modification is called on the main thread.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Object::setParameter (std::string const & name,
    tool::Parameter const & parameter 
    )
    +     		+protected
    +
    + +

    Changes one of the data model's parameter.

    +

    For thread safety actual model's modification is called on the main thread.

    +
    The documentation for this class was generated from the following files:
      @@ -238,7 +516,7 @@

      Generated by   doxygen - 1.8.13 + 1.8.11
      diff --git a/docs/html/classkiwi_1_1engine_1_1_object.png b/docs/html/classkiwi_1_1engine_1_1_object.png index 225e4f3f44de945ae7393637ccdc0778c39243e6..2b51815fd007d91f8d2709ced37fb895510ec8de 100644 GIT binary patch literal 11917 zcmdT~dsvcp-`7rVm9l5O%~>jYR;{O#Zk2h4XPtbSODhE>Qgdal@|YolAXZD)!Kk?; zO{H>+1QgR01yLKR<%t@BC4xCp5)@RrLqX)dL0z@?dEdX@XV>z&x^D7PxczHjL));n-; zp~mz>;HPI#M#6{?M43!@835-XL% zfk{m<7nod^GJdD$057qBI6gid80}5H$0Yvb zlL^NHTgR1){M3w^-s8^*l_JHY7vo5^mdMmITK0-N%jY3l>3J+BeWZoHWcs3klm`em z@`zScne#R4tpXKGVev)WZ^FJtM zS`E|%tL9%UVOqJ~y7ix^faN_kKQo0JcWR*j1|3^p05|+In7AY;ApT+FYlbK%7zvi<<|xK z3+!{byJ&9T`i%F43QP^AMXI#=o_Z!ayP>yzJ@f)e0of(5fp<&Tb|t2Q_H`(gIz>jE zvt4{OXt?Ye@m@Fn_WqK|=OedatRWSKP&?8=D-eX|j0y8cF#Cz8g{P6Fq&S*^$a`8IJvXyAF4>hXSv?; zHuqtp4)&! z)F!VWX_Qk)apH$55V0|>o`j-9(9R}}JI!H#Wu7kw&FU9l#a4swS$nXAD<9wgVRf^< zI7!ubvhpOXR7vY`sXry`P24^vv+cavLzl&$W6}e48!jn1<#gFl4Q`K9m7oBPpdJm? zA*jk?0byeKwf}8?4TOV}DtCH%{3#cizoqi<^y9231X1^TrkY3VrWVf9@aDgX&{AKH zL7z*8*QI;KT|I;_hGnWI7y~y^5Xne@cO5#e0e5hdw_{!)%x)nqJWR8rr@h<^Ce!_4 zJ#rQpFeEdWd|~RkJN?{eb=5mMu}4vw@(#wsFtPko-~!WNOf!`SlaAmf>U;7Jr7sp0 zfzZ*dAHb^4_A2j&r-Gf(kEK+UDIu{G5HL!vK_KJ5mgSW|1V71H5i}T$gFuRCsXr*8 z0TU@=1+BH54wICr889Z3ZsNcFXH9;h+PG6FvAL-JnQ28uy`I!`!|_@&nXO=qi-BH z>Dy{qf_|bm75ge9RB&Y(|Hk?aOj!xUwSH}#*0Y%viA%z{iCU}pcsyRSAWSWuZI4y0 zcqO77mlcP<{2Nod`Zxu%@2A53JWif+8!J+((HST|8^&CU90WqBy&uMST)@sepE>h4B;%gj|nUH>Tbft6~(;AV6(w1~`w@-3REo zFfzv2#;CgnsYPdEB7had{^i&7zrGt~Nu4Q6K@nF&rMccHttu&}Pty5O8AmT;WOYvc z9iM7#$K2KzIoY+ZgxX{TQ96a0NKG*G&NlIe{?WLnc3f=(-kq>2S}b}|7Q~axLj{sG zryq{PxLwjw&Rvf4E}kU%c1J7N42hS$D(s+MJVW9QqOAoW){1P_kxja*!i8mflbxj{ zok=Pn)~iEIckfdFP^rG4fMho$oGvf5XD)6zvdX0I`$cs;#ckO_XdZl|LOBnGpsJ%k z5w*6^@ic|nTXe2)?BU9u5Uzy3{=-hyvC+i+9+)T4W(61P;Rhfk2YnB?XmWs2Rd~RxRw60YHYiND4R{g9 zb7LoeSp6d>rHthR{d!guLLligqry%~vl$g4H#vm{GE6$Ps-7CgzE9U55A4R%O;7wP zN(*tKP%4par>Z+rN~X>U)?P-qg`*Ji>5K78G06VekWZxkC~H_n`K)^&r>*@{E~%@` z!_fc^N01+A-nb|5)?}ZduzZ!r4LpPEhmC*>!ngXyFP(yed{?9xXGp%XG{#QX(|JE; z3XiKBQ$F^szXgjcVn(<1Nz0v*6(@kWu{|A3#v@u>S8O@RV*NIUoDGS|j0nI+qo7lW zka)?9MQF`LHX}4IXAYh`gUN0YFb>+aU(67Ka3S;;bG!?6D^JL?x@s^{*t_`6o<8^d z`A4c?K7wW15&7gN6OSFscABx_RSlBJ5ga1E%0(J!u!%V0sQHE0`?s3bFpkug(`PP* zQ)VI=4-!dA`7FYrsJY*VAk$O+l#6bUx$Zi!?nhCG9^UJFGT&iVxjLgWaVvntUI-8G zAK3;wjQ~O}Bb=&O^`4Ufr#sN^B4s-~^L>t!e48D|1U%o-nPN9zfK+ zGkj>!hl7T;l|a+jrT-;{yt=G7wPSy6s6xz`dvq=_1&k}le`kN<#;zOw!)b=8`NXyl)D;^xx2MityV zj5k^R%F96j(zhQ5$vjnDij!Y(JVx z8Fk^5Z1QY=F@v0sZEbYTpoEAJ=*YLG&arQN$yrcO0>mAbD8wvdYC%YeJQxL8!@FN70zW9$H_`4 zNvcyz3BVZ}_rWR{~1;N zyJ84$F+UiS;DfP_q2#_{gMfF)b`VR4y)N96DLWnshvg6kEam`{UVj8Tfp6iIIakG# zYbx5**Iv3E`&f?;3xL_3rxjwGM*vmA8Ig@BQu2YyAqmHh$&}*u^On~AII`YeZofs* z6YMInQxTS$J4DNGc|QNJk8Ymotfm9}6~lXC4b_IJ?X?~{zQuVZ8Cag6IHfG(Wnk)i zG!Z#UOsm{vJX9lT@*a95<+yfaAL$AZW7%uhPi_T|9Q=byg>IQgK83-s04 z$+fM$FMBtNmd0KJ&eznUt8$|pEEY&@8*buwKN+i@hf*vJ#PXBV&bwZTTey$tZJ*hS zf1o#N(=jlgwiUFixQQpGi_>*EmD6l8v>#(T)3UXbt>!XCYV-@9ZW; zdFe;Y#V>2is7vCTMZNy_z)z9e1)WxwR5gR;fa^i^3A+O1W}<-lmk+S2MUV<5Y2Y2A zPm0R)otKtwFn2hAu7{T6d;^e?a2n+UR4 z)hc~fsCBrgey!Q(faT3eI~l?g9YTdH5P#J_e9<+mEnmS`Y5LOZ344G@$w35>L(2~~ zU57*y^{;}AnJ{CVlb9$9E|?QMLz@2L+$ke;nmc*>v0Rh9hK)t~tyd3#eXv2gPD~o} zt7-&K-!xiNahE^^&8JOM=2P!u?c6#)*V3vb_2k-BVlA~EYz4mBr%YxW(K0^Ey)>Cv zrOc|j=QSa;yuY?tIzR{V4S)9+tuqm3z~q?aKoi zaG23Yp#W#6*`~eRKRQu5=2G44H=*QKCyf?)_6CL4lbp*sGMib?tW_h=O{8gc;l8v` zHeL@%@v56n^N?$VTf{4oW$Ro}?uEjmg3RoOtQuWYHz?$?Zd-=cXt#67)z&_+C4j@) zEeXrv?VITCk`Eb5q3`D1#xUpuy>J;*&xL6%y+VL`gEc9AH)^tQrY5=1koM0nA7UzvZs^TTts`n zm-Jw|S2z~Zm1pfztd^CyE5xEl)}uvgF$1ofT%O=oe4$k`dPWj5;UgBEteh3DSe%1!>tY{4A+nufD>g2vme1yH*m-cv9Uas)XeMWyA$-1?&2k4j(x%ze{Y?8PnHz_3?JtkA#Xa)z(1nh?g+-B znh{5U>+Jng29>^Sx+2J6GFXSk!^FW;D^G}K^U|ioI2K-{ug;nR^~0X<$>edTg$$#| z`;O7yx5n=P4xufOa`P(@Nm+!Va<##xNc3Tt8bQo3WYQAPjgTR zlBjpRX<+ZwDBlfgA} zoTV8xfH+d*O>|a$jiCVlsL8vbaYXWjpp$JdPDT|^KD2m*?N)2(epr>L1*FK^l< z|JbFo2D8tY8L*l*Fghmb!+zd&lfeZ%Zu_{|#QX>vgN4WNuLfLIpRc$DD>Yl@&$onu zy?}c+gvXB8!b7SP0G=~ks=5uRgyn+I{_HkeU03hCi6yy@>@xd7VQA0p8_>3T${oNF zJw2LcbjJxm=_vAx%?9R_f8^Ce=;Q(ojooR&8~sJb^3M0j!xle>A!k-n;SOA=IrDFGSrt#4~acvcEz)AO;(W)hWTpgBkv+Ue=vj3iWh1FXs?o4)sa)P zKb}>&PRxI`b3L{xH@<;&$zf<3o$+{2yV7KBa}%H58GCk0)Xgy2UpUBp1?!dcaP|tZ z^}!GJ#?`Gn6Og1zhylHO`cEAM>I)ufsLhjX+|jM zk&kQu7YtyR07da`AcXi_svjOl7%}e>jdh+WiN;KsFe15sEERMJom`SICFDb3kIYJn zJ~#fxMB*2#1Z$yT)SvN;b#LZ%z5cm26#sqBLBz+Fq~a^>rblyieffkhb|JB)Roc}r zzXy(7UIMEnywtB1o%_8SU(QscztvogA22{J4Ouc|sf8uU?kJHf;dj<aFWrBViHWtU*r$Yo0 zUx8`e5AOye`kj>WEFmhxIU-I1T7t@i+^e1XP;f9AI|T(!Z?jU^zgrn_-sh4yVp$ph zUXGP+4B1KnVOjr`JIE`q1s*7%T<0=F7>{wow$mpMi|x0@Xfyu;os2;-@Kc!VPFA{oseatUmJw9ob!J3-3s>)s8~_SOW7h7o+^BTN&1z*f1sRH{> zeS*0MC<5ChnQthweRs1$JRQR$HUr6$18+qZ>mj8mmg{vq4O}_%K<3Fyu$5>ClXXXU zF7`2!CtW!eTel)w3f!wqE2aY@E|^$Hdew5KtR>M8ZsC1J8Zju&^ahqMxIAFLK?TvC zR&s33`V3fqXGwi%W=AHue&4Uob*Duug5%k4=EUynB7KA*R7}-)h)i7yFzf*1QYN`@ zPH+UMk>9ZWWYB}=1jhg-I6p3aw&739O3fccv8*1FtOmlt)g<-XFco`#X6uZ2+}(65 zTsL+S4aTKWI@g!i!PQJdJk@(mn>j9>N$rT)(B}Rm0kp;=1h@en`0E{-UVqQqb_duU z2%bAjd5|+R!b_tD7+X@6g?|HE{V^N*w9v=`J7IgWerX-r|sCg)@4eG6a z3?_H33b7xSp)_vdSTq{AI6xDW*e?*z*AG8)u{94Q+yk$YF>Q^4oZp0qXMX_}!7z@h z^U^&f6IQDPf)P=TY4j4Ahb9p&umr|TGGP?#iyQAoU!Z6DVyK8auEc%VLjEM+I{|^}XZr-a2 z%8qAZ(BEUVPy2f>3PS+V{Ef1#HDdV#g*4$TX!V+NJ4o1L(WbV))8W8%CLGr29xzD} z5R_8RUL698!4FbRZ8o5X!J_~BE!n@AxZBkDyST%DoHp@*Y8MaE!RcfhRMMvQBt?B1 z7_qi}JL8G>?X{;mBx`Ai_^L17Hj<*n-n9IBZ_(A*a{z&wwVCEUoYCIc&?m*?1__P5 z{Yc*6foby;FM)=DQk?9oRo@LQSo82%}1DHq; zW~HFWW*ncdzmpCnaVPAW0HepU{CJ~-e(bvFba4EgRp#;K<2gxL1TO?KQ+GO5f%|Bp k>3y{L-T!uaO+vb7kGqa8PdNwfj$7^67O=H+^Zt|n4YsONmH+?% literal 4265 zcmdT|c~Dd577rrephCd{3W5cK3#(NDWwi=QWQjl$L?9qmd=WzmvRy!wGU`)Q;KmTj z+R7#%L?v8=gr%iyNx_j2k;LE@#0a4fHVI4KjZ3BPb>{u^+Ud*8$vL@mC%JRZ`7K{A zAND%9R#jIOfk3Q9xw-ft5DE?m#0s}nitrWo`CG|wT7TFB<0_NM;PUn8bWHkB8F2M3 zT3T9^Ee_R#qHhZ<4>bEX)oB;4 zm)l;}C{t;gk;otFSz?@QD3&2`(manI_LZRz7@S856|!C4r#yeWbD-B)Vc412t$FE6 zX)ytt3W5zueR=){ zEu4j8>1EX93rstAh1kmuA*Wo4N{@%)n0cuMzHH}+=T>D>6O|Osm!)bw{Urf z20ydnX0|&VwGVYXY&96PIMPQEPWvsCUjJdmjWpS2l2nmI?uUqp4mET!zCE$Rq1(zX z%ypiYS+}+Mr1^Sly+;rSx>1*4tvw{%7dLo25TjzY?(S`Ph+;goJlczLB!r=*} z|}7tE;ljAhG-({-j%rprR^z1foHIpS2HXOiCUWuMD4VJ35|!KcsIoFyuk8n74(> zoD3VfY4^H_rzXqEH7KpTx{>{+2xD%`^s1#4m-z=u!06BYviwezBlWvWjA^&3!06q6 z=m1oL9t?-g%VRjBf0yUvWyHqzT%kf>VW;Bu%MJ+gUy=Z_9D?a`2%4ZlrwkaLoUMPcOteU>MxsIdi3`gIq!Q2SLfqs@3X;&*N^Q%sX7*N8}zIGMO}q%3W8(~6pf z(Wk6%KIB*s%z+X&7?&|6vqrQgJF~f94S>G~qC-?jkB}S#VC!#1J5`9|=O1{ebIxGX zbLKN*pPw>Ap=*wR1+Hmw8BCUIK9AElzEXJ+}6{8M2G*#@lyT?-wp+PP2(Qbc$(W`;_ju-TROFrb=Hn(5bvL)n2e zHy8>k%V8j||He?5`~-zY!MWyS^YVZA!H;b9kT}`VXlY0b-~V`ubbR;pCr!X5T9ld) ze$-kn)YXUZ))pwez`b~_okf=nb4*b?%S-ZK^aSK)6)W{;^{*bdF*}Y8%Gcw7^k*Re zkq>oDVtBDu`+IQvW{gPQaW?X=j8Q$%eX%y5ZUN2Tv?t*#P4io=XWsTdiH>ArGiR;2 zII!T=EG8-TA+>AXajh{Ld^Be*PfHsAM-5-y`5X7VZ#dx;^+Ura-`W8|dOww((`$uI zD)*yFeKPW+m64U9oOZC~a3D>R-@E7X>YZ(1l zA*$Csnr}Ya(8R13q!0N1?5Xp~^kiRnJid6pG|&)b?U%7!c~=8z)*zjwBwX83?dXw0 zAAOTDkYBgp2IA@=Ccd+j$<>{Zb-m;Gvfi0U|88TFXGc!9dWOn34rr~bIcvl13G-Ew ziYRYU5{7^G^Iu?sx7Qh}t*k;ic1L`H>MeY01Yolc^|F(Eg<7>(5I@ZB#evt2|J`nH zl;o5WoHWk2#*-b+kNp0q@ZrSpXC)FS*Yr$S(;09RRhI97ypF;Fbuav{yY=eo)zr zCaRq5uYka*U3&g7_eBDLyb*5+8j1+`wJnX4|KNYkvFXomG#IRYo-(HGzBmJGbc$PJ=C;sR2lKs} zqrZ${cLrFJi?NpGv`PiOL@FWz>2v3@VS5RadLm5foU_;)=i&A@PHJ~aX}#Ld)-K@X zHvc<9;t9FGxxRD@YHfa1dP&p}@{5z~5@GeYGBkwh<&5H&z$w2b*Fkfba$=e`ODbT> mQ5pA?Q_g>^+I!0BJSWpQaFE(DUJn1SfIzu=xm529`SxE0dd_12 diff --git a/docs/html/classkiwi_1_1engine_1_1_operator-members.html b/docs/html/classkiwi_1_1engine_1_1_operator-members.html new file mode 100644 index 00000000..6dc053eb --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_operator-members.html @@ -0,0 +1,135 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +
      kiwi::engine::Operator Member List
      +
      +
      + +

      This is the complete list of members for kiwi::engine::Operator, including all inherited members.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
      bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
      compute(double lhs, double rhs) const =0 (defined in kiwi::engine::Operator)kiwi::engine::Operatorpure virtual
      defer(std::function< void()> call_back)kiwi::engine::Objectprotected
      deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
      error(std::string const &text) const kiwi::engine::Objectprotected
      getBeacon(std::string const &name) const kiwi::engine::Objectprotected
      getMainScheduler() const kiwi::engine::Objectprotected
      getScheduler() const kiwi::engine::Objectprotected
      loadbang()kiwi::engine::Objectinlinevirtual
      log(std::string const &text) const kiwi::engine::Objectprotected
      m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
      m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
      modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
      modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
      Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
      Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
      post(std::string const &text) const kiwi::engine::Objectprotected
      receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
      removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
      schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
      scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
      send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
      setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
      setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
      warning(std::string const &text) const kiwi::engine::Objectprotected
      ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
      ~Object() noexceptkiwi::engine::Objectvirtual
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1engine_1_1_operator.html b/docs/html/classkiwi_1_1engine_1_1_operator.html new file mode 100644 index 00000000..5443e5ac --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_operator.html @@ -0,0 +1,279 @@ + + + + + + +Kiwi: kiwi::engine::Operator Class Reference + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +Public Member Functions | +Protected Attributes | +List of all members
      +
      +
      kiwi::engine::Operator Class Referenceabstract
      +
      +
      +
      +Inheritance diagram for kiwi::engine::Operator:
      +
      +
      + + +kiwi::engine::Object +kiwi::model::Object::Listener +kiwi::engine::Different +kiwi::engine::Divide +kiwi::engine::Equal +kiwi::engine::Greater +kiwi::engine::GreaterEqual +kiwi::engine::Less +kiwi::engine::LessEqual +kiwi::engine::Minus +kiwi::engine::Modulo +kiwi::engine::Plus +kiwi::engine::Pow +kiwi::engine::Times + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Public Member Functions

      + Operator (model::Object const &model, Patcher &patcher)
       
      void receive (size_t index, std::vector< tool::Atom > const &args) override final
       Receives a set of arguments via an inlet. More...
       
      +void bang ()
       
      +virtual double compute (double lhs, double rhs) const =0
       
      - Public Member Functions inherited from kiwi::engine::Object
      + Object (model::Object const &model, Patcher &patcher) noexcept
       Constructor.
       
      +virtual ~Object () noexcept
       Destructor.
       
      +virtual void loadbang ()
       Called when the Patcher is loaded.
       
      +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
       
      +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
       
      +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
       Called when a parameter has changed.
       
      +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
       Called when an attribute has changed.
       
      + + + + + +

      +Protected Attributes

      +double m_lhs
       
      +double m_rhs
       
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Additional Inherited Members

      - Protected Member Functions inherited from kiwi::engine::Object
      +void log (std::string const &text) const
       post a log message in the Console.
       
      +void post (std::string const &text) const
       post a message in the Console.
       
      +void warning (std::string const &text) const
       post a warning message in the Console.
       
      +void error (std::string const &text) const
       post an error message in the Console.
       
      +tool::Scheduler & getScheduler () const
       Returns the engine's scheduler.
       
      +tool::Scheduler & getMainScheduler () const
       Returns the main scheduler.
       
      void defer (std::function< void()> call_back)
       Defers a task on the engine thread. More...
       
      void deferMain (std::function< void()> call_back)
       Defers a task on the main thread. More...
       
      void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
       Schedules a task on the engine thread. More...
       
      void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
       Schedules a task on the main thread. More...
       
      +tool::Beacon & getBeacon (std::string const &name) const
       Gets or creates a Beacon with a given name.
       
      void send (const size_t index, std::vector< tool::Atom > const &args)
       Sends a vector of Atom via an outlet. More...
       
      void setAttribute (std::string const &name, tool::Parameter const &parameter)
       Changes one of the data model's attributes. More...
       
      void setParameter (std::string const &name, tool::Parameter const &parameter)
       Changes one of the data model's parameter. More...
       
      +

      Member Function Documentation

      + +
      +
      + + + + + +
      + + + + + + + + + + + + + + + + + + +
      void kiwi::engine::Operator::receive (size_t index,
      std::vector< tool::Atom > const & args 
      )
      +       		+finaloverridevirtual
      +
      + +

      Receives a set of arguments via an inlet.

      +

      This method must be overriden by object's subclasses.

      Todo:
      see if the method must be noexcept.
      + +

      Implements kiwi::engine::Object.

      + +
      +
      +
      The documentation for this class was generated from the following files:
        +
      • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.h
        • +
      • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Operator.cpp
        • +
      +
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1engine_1_1_operator.png b/docs/html/classkiwi_1_1engine_1_1_operator.png new file mode 100644 index 0000000000000000000000000000000000000000..6599079272392e70a6f98088f07a7c61e04022ca GIT binary patch literal 6034 zcmdUzdsLG7y2nX#?3Cs9bj&WJw(IPyF|}#Dl!kV9no29hMDvEJC83t#6{MO`n{GC{ zwxp!iwn7j^RMbS!wkegNl>sRtmg5ZqGJHX9a$ZdLG|lY&&zV_g4r{S^xva&ze&6SL zKHu;2{Q*DUh4Yushd>|;_k6wc5Ck$O2m&!(JI@sSq_ln0I`C!bfqj9y3I|gyn+Q`eP!LUK=^7tm7 zj*R$Xffd)>$(+#b7vaNsCNvv93;c%*j=LxrCK6jo_G#XR_%BQ4czP$S?`BADj}2_H zCE~}fk4ISE8{ofIZ>;w}l0#JKPZU}9Rq`;A>gLH-%7S5?OtaL$bChm*IVDjx&{CqQ z{$V9OdP%$v4^OOrr%B`oDAIJNJVNa;Z+afGwENha5u3BPxT2IYK1H}WuZ|)(_59|2 z9nze#pnXCVS_7#6>xf9&6>NXAM<=tbs!U`Zrs#Wnmp>Ie6G+-Fn#I~sggJMK40biu z!w|nl0CX}@BSMGDzEotZwB;0CmW(Tcx%F+#gW&>cOC)uaZCnJ5bC^ONzW{R!r;*!@ zCxg3+UYhfI&~#Hq+?n|+;WU#wUL_sYE02H|+Cxr<&zxwRU$rfJ{-3D9bKY1xZf!!C zoj**0j9;)`8BQ~K=ooY+t?hsJWfb`L3e(Aeh2)aidzw*8dKq}RrG7OzFC$}O0_eV( zl-e)pkX?fTahy9{&S{%?<0lsv^m7&`EiZW5zN7mw|LpL~;ds73$KjHT^f9?y$!?77 zln=8ft1Tv6IQSRU{n)JZgV;V#f1L0!vu(ukQl zgOt48pjRFHj8<jYHy=aoJLIhdA?%8e?^%f4?@cqCzSYoo)?QPCP~ewtb64O0A>x zJxTJ&_1z0}B88l&%4jEb4BGoaU6Hu1aux+Ftg;>zEJBq>W{1xWtS8MBBLa5WsK?Yw z$p(v7wt3P-C&YSdHNx!cRBycF)&}rGbvL9E(sRK&^4s~p*^&QJ$$yNU_QV?d#b+FM zQ`pPFdPF^u#8%9zU(HjfQHTdDZ$Kj09dYls9^u%;RnhT_;Dzif_d$r|{ zCe$g(=3Cg$&!Ky>i>vDhFQF1(6t!*Ba>*MvqZ-~t6_$LS?3ii#dLB@s#aK0j z1`4F8sfUA(c6oF`mFF3?J1e6?Rg@CjpZ^`TCczNi!0x&-z**Zu7FL-w3BCA}&*hu# zB;}d)!E>fUIV{U}6olC%<>$pLx2!JqBX<8Es$ud_aNXFI3e&Iaoyx_;Pg+(R1$FC^ zo)?!Ee+~`HN?^Ol@8L+^qdhbxjXYIWFtMgwQ@f+;N*PvB#D^m&+<16S5IZ6i zpH+rJ9F|VLKgCQ+z9+_Nqm7b4yEZ;+uDy~6$6sqE)H0%(LYCugxO(cYeVSXSeGw@` z^g}QaWgJ=fkQ(P?!}9{N3e}q7UD8FktEtV2)FeVpBRYAxNC~uDEKxSb0MKz=tkn(Q zUax^$7hB?6#kbg@sg*q(O{)~!@3X(;elbZy0SkyFT#;HM#*J1{68j#L4Ya{do?L#E zYj}0rW)2ti#V0I%WITy+@FcEV58U`&@bGW6NDSbC@aVE!DXgRX5*}A);c;rhb*iji zr8$=w3)3H@Iwv0h!J!rqmt-5q)}ldx9An>cv~_Vj^596un9APx{|QPxIxm-n9rA_C?e*$&rjbPF^DG zv{kIINV@~r7w(i1g}Mn&&LbomItYUK&nocLSV=sJSwbqOiZ|5&vNc%Nygnzg&<|at z-fzhZ;yOq#8<}#xpJZ$jMWs)N(0%IU37z|J+ioC=0sa@`@E2qs@ePVd*b2Vhs-c5~ zAGA%iIv}LXaDB#SX}_hkZm_Vo-`cnzKIaPPv3?8R^luvD6R+kTW1AB-se`;gb&xe< zMi2bc?e&+$&cehFiq)6(*Dq(?oa`idMZ)y(L9|`O2@Y9v2TB8_vUjEHj(6YDeC)P_ zL)V8d4ITH~RN@()G{xkL=qq?;$ypvgYyO^o3wNA#UB)SAE}iI2=XczcO>kRJDK4`N?l zE2a9}(bU@3fF=L|Be3!8$%ck~PTPsy=%b%&GK&3;79hnQ?tNRcf7X^^;GY?7*?n3i zyZ@xnLE=iCc)5kQJM{u*uSY0hN1}^GZZuQZ6j`)LMd8y#5pz376zMgA5gwu`yhpwD zK#xTep+Z7OGhf-IT8$=*GFC8Dy4+m@qezJnF~k*`pc(>@OR#?3=&YMs1*w81R)Ld^ zK)5Q_+7jrD5mCk4V=zrAJwM)QDfmwf`$8Je$vyQyR=Vg{CD`Wex1>j zkCD%}#BpDM<=dKx00H9?3@fQc8WFRAnBR;pjEPu1 z_>8Z>yhq>KOxHeo|9wt^PNzd^qP>oO@LsbT%&B1KujX4iJJhmM9(i&cp>BEf=S2v` z3l8s!M1u(n)h5axQ7YJAmpC>a3}f4^Hz_9|Shc;-x+rK#*9hlO7`G44r_0;^DT?yq zR&9sUJCw0PBWssI4N+EUth!1Wgr4~}$2iE2SPeR|w0%w+i3i7!vwc!a>~!f^mMlWZuc9B^6mjy#W0s9Z6uR7HKE3u;U`d@1 z@A#WBQu=zyj@+6z3HYnl5}^Yu;`CZxN7n-0SW-=XA4d@pKGQ5E)6L>hkl>N&7OMS= zW|_pw=4@6t;GyhQa96!s%2J;f*C-!>1FPt1hED|6yuMYhdLhy`-=7CL!Syhv$@bw= zjocP*?3Zh{Y192u8|`93CItR^nE$$donyxpZtbyuhrJ#uSbNa2E$DE0|btmpDx8YbaMMBL`#x z^>8%V(#t|JG-4(>-2mTfM>4oe)EMu?eDUD0!0JXoZzkq4H7Nx zI()I^q9Sh^8xyrOQOJJw&^t}$edqQ34(A23>e#YM0cgSm%%cbOd)P97&*eD#sE%Dkz&*-dfSRI%(j-Te5MOG+{;VuLFAyy0B{;|kmJAea)r zN!dF=TyOHhc!^v;5aU*9hFhpSg_W?xKHX|GE;uz>l+FsCtLfnOHui!8NpLEiLE?w% z^|IQVlZ=aymLO&;S(749*g=-3B=Ka$hZmwJdV1e#$)tFz1Jlcsk9at{%=#nNzr#=U zKlZ*<(_A&!M7`We^1wS; zu0~jm`Y4o78l!n!yY5%?jv+I&ahXL8x{`kwKx>bJ2vFS$6v+oD@-82)%1bky$OGx~ z%BDAmA0fc!4;(@AW+Mn@!c~t^z`427zrlc9{g2xjM{VtG{zhsW*=T70;pDNxOU4x< zV^0<%Ftf>PFTjFUJKs<+)L*jJo9g!}?$%ODHTsj>IO$b%K@9S{wxRIj>Gw-2R74U> z984K>p16tj)ZGL!bo?b}jh1yi*M?JX7~)hryAz(3_h^z(Oa_39vx2;$q}Eed4#kF( zR-4us1K`^3{g`rN%FyT2HIq~)69@sYH4d8^ec2S!JT?sEFYU^fPzE-_jsF15;ZDDv c!}XS`zmI<7MleYM7wC{ZyZm-mZjU_oKNin7 + + + + + +Kiwi: Member List + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +
      kiwi::engine::OperatorTilde Member List
      +
      +
      + +

      This is the complete list of members for kiwi::engine::OperatorTilde, including all inherited members.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
      AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
      compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)=0 (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildepure virtual
      defer(std::function< void()> call_back)kiwi::engine::Objectprotected
      deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
      error(std::string const &text) const kiwi::engine::Objectprotected
      getBeacon(std::string const &name) const kiwi::engine::Objectprotected
      getMainScheduler() const kiwi::engine::Objectprotected
      getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
      getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
      getScheduler() const kiwi::engine::Objectprotected
      loadbang()kiwi::engine::Objectinlinevirtual
      log(std::string const &text) const kiwi::engine::Objectprotected
      m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
      modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
      modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
      Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
      OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
      performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
      performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
      post(std::string const &text) const kiwi::engine::Objectprotected
      prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
      Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
      receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
      removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
      schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
      scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
      send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
      setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
      setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
      setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
      shouldPerform() const noexceptkiwi::dsp::Processorinline
      warning(std::string const &text) const kiwi::engine::Objectprotected
      ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
      ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
      ~Object() noexceptkiwi::engine::Objectvirtual
      ~Processor()=defaultkiwi::dsp::Processorvirtual
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1engine_1_1_operator_tilde.html b/docs/html/classkiwi_1_1engine_1_1_operator_tilde.html new file mode 100644 index 00000000..92ac2434 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_operator_tilde.html @@ -0,0 +1,348 @@ + + + + + + +Kiwi: kiwi::engine::OperatorTilde Class Reference + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +Public Member Functions | +Protected Attributes | +List of all members
      +
      +
      kiwi::engine::OperatorTilde Class Referenceabstract
      +
      +
      +
      +Inheritance diagram for kiwi::engine::OperatorTilde:
      +
      +
      + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener +kiwi::engine::DifferentTilde +kiwi::engine::DivideTilde +kiwi::engine::EqualTilde +kiwi::engine::GreaterEqualTilde +kiwi::engine::GreaterTilde +kiwi::engine::LessEqualTilde +kiwi::engine::LessTilde +kiwi::engine::MinusTilde +kiwi::engine::PlusTilde +kiwi::engine::TimesTilde + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Public Member Functions

      + OperatorTilde (model::Object const &model, Patcher &patcher)
       
      void prepare (dsp::Processor::PrepareInfo const &infos) override final
       Prepares everything for the perform method. More...
       
      void receive (size_t index, std::vector< tool::Atom > const &args) override final
       Receives a set of arguments via an inlet. More...
       
      +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
       
      +void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
       
      +virtual void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)=0
       
      - Public Member Functions inherited from kiwi::engine::AudioObject
      + AudioObject (model::Object const &model, Patcher &patcher) noexcept
       Constructor.
       
      +virtual ~AudioObject ()=default
       Destructor.
       
      - Public Member Functions inherited from kiwi::engine::Object
      + Object (model::Object const &model, Patcher &patcher) noexcept
       Constructor.
       
      +virtual ~Object () noexcept
       Destructor.
       
      +virtual void loadbang ()
       Called when the Patcher is loaded.
       
      +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
       
      +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
       
      +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
       Called when a parameter has changed.
       
      +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
       Called when an attribute has changed.
       
      - Public Member Functions inherited from kiwi::dsp::Processor
       Processor (const size_t ninputs, const size_t noutputs) noexcept
       The constructor. More...
       
      +virtual ~Processor ()=default
       The destructor.
       
      size_t getNumberOfInputs () const noexcept
       Gets the current number of inputs. More...
       
      size_t getNumberOfOutputs () const noexcept
       Gets the current number of outputs. More...
       
      bool shouldPerform () const noexcept
       Returns true if the processor shall be performed by the chain. More...
       
      + + + +

      +Protected Attributes

      +std::atomic< dsp::sample_t > m_rhs {0.f}
       
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Additional Inherited Members

      - Protected Member Functions inherited from kiwi::engine::Object
      +void log (std::string const &text) const
       post a log message in the Console.
       
      +void post (std::string const &text) const
       post a message in the Console.
       
      +void warning (std::string const &text) const
       post a warning message in the Console.
       
      +void error (std::string const &text) const
       post an error message in the Console.
       
      +tool::Scheduler & getScheduler () const
       Returns the engine's scheduler.
       
      +tool::Scheduler & getMainScheduler () const
       Returns the main scheduler.
       
      void defer (std::function< void()> call_back)
       Defers a task on the engine thread. More...
       
      void deferMain (std::function< void()> call_back)
       Defers a task on the main thread. More...
       
      void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
       Schedules a task on the engine thread. More...
       
      void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
       Schedules a task on the main thread. More...
       
      +tool::Beacon & getBeacon (std::string const &name) const
       Gets or creates a Beacon with a given name.
       
      void send (const size_t index, std::vector< tool::Atom > const &args)
       Sends a vector of Atom via an outlet. More...
       
      void setAttribute (std::string const &name, tool::Parameter const &parameter)
       Changes one of the data model's attributes. More...
       
      void setParameter (std::string const &name, tool::Parameter const &parameter)
       Changes one of the data model's parameter. More...
       
      - Protected Member Functions inherited from kiwi::dsp::Processor
      template<class TProc >
      void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
       Constructs a callback that will bind a processor and its perform method. More...
       
      +

      Member Function Documentation

      + +
      +
      + + + + + +
      + + + + + + + + +
      void kiwi::engine::OperatorTilde::prepare (dsp::Processor::PrepareInfo const & infos)
      +       		+finaloverridevirtual
      +
      + +

      Prepares everything for the perform method.

      +

      You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

      Parameters
      + + +
      infosThe DSP informations.
      +
      +
      +
      See also
      perform() and release()
      + +

      Implements kiwi::dsp::Processor.

      + +
      +
      + +
      +
      + + + + + +
      + + + + + + + + + + + + + + + + + + +
      void kiwi::engine::OperatorTilde::receive (size_t index,
      std::vector< tool::Atom > const & args 
      )
      +       		+finaloverridevirtual
      +
      + +

      Receives a set of arguments via an inlet.

      +

      This method must be overriden by object's subclasses.

      Todo:
      see if the method must be noexcept.
      + +

      Implements kiwi::engine::Object.

      + +
      +
      +
      The documentation for this class was generated from the following files:
        +
      • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.h
        • +
      • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OperatorTilde.cpp
        • +
      +
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1engine_1_1_operator_tilde.png b/docs/html/classkiwi_1_1engine_1_1_operator_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..9ecedd27129726043f3dc05bdeeed164bd92e97c GIT binary patch literal 7122 zcmdT}X;f3!+SYojy+x#YTfl*E)d)@jML;otZ5@LQDq2(wlro7x0t6C5AgOHu6$MSy zC{s$QQWP0f43I!5RA^+BDMBWJKtwnM5(&gaa`ypi>s{^rzWc3yKbo~zXWD0x|GI&3p%&T>D@u1^lf&V|Io#9OZIdwMsp z{bQ$-b$7~gKlwm#Zk&9l=snMU`1c{q5q-?I6^mH!*%mjg#5kuB4bbCQs`nbm=sxhXHq|#8c+3eKN`+hYe-uJy@&r#Tn$3pRdBWmiQ z;!cQ85$7Xr?m-w~Q!`(Y7K?Gcrk-gcVkEl@F<%*i_6(8n1d2Fk`phz7KVN?{->UPi2vrmiY1 zpL!Y|TP7vCC9z8Sh>yhNLBkYUzKD669Tztd2l0;dgw#FMVDqbpu8)IM^qH@16kG69 z%KyPY?)Y9@vj{RirPShRJHt7NPLhjkjPg_uYNQpHV*wtt%^sp=mv&4V@y+~4k8wH3 zdjE#RbN9X1^36+8Chvn*>%-qPe*Mm$b?D{wM{HZ+e9473hx+wSdORXmh}1atgwqQi zTa+43eS;0qGLr-wig|5Cb0!tQIt=Lr+_?m!_Rd4E>2^G z;Wlix+htmW_Nmsls%~t!VWOAFhuV37u|oj85H{07%cs_w zo68|bSNh0UksY~TE45LCuv1vJT{2|1oW_Tg!+3#=bAedCq}Etn^-BGCk|)HQbHv?v zMgU8{j@{1Txi*tA6+sU>Hl50NP#n@#TI{yl3WHD@;mqUpB^E|fq7_+fm)9^wrVtnb z$zYi=N?VWV3f_wJfbIIOaJpkHkIF)7(9W%p@8KIn1K!UKD)pi3^Z*vk=Mji;-5xi0 zy6+%cWWlGLWMl5`;Ut;?7m z?;mex4ytH#b@L%(7iF-Yb9{)i-lQ52B6U5BXBBP?Lf`;{XkZueM~D9LSY5=or%CPm zjsCdNA9SEMORnu5JNxlG;R?D;H4|)as0A<#zd~5lO9;cz?H*7RanrVqebWv}k)gGW z06;-zh;lc&xiZG&)U>{7xa%K6lx}$j&O;v4xp%jGm$p4h9rb*>QI&0DdqR-H{-tqX zoajz(I$z2p-zOS)+#4X;#Bn%Tc?}(#cnk4+lvkF9))wLvhzMVv5armCBn*Af^qKB6 zq+ns=^1-joQzeiKeGOzxoT9L$_4B;tqnf8Y0@~?Yam@}@nFR}nqsYphpdZwgppR8` z+0oqT8^LsHuL?`e2s@t>-4NnJT!VaZUWNqUdn2qOD~fa-=YQoD@osSpRCV@xl3T8I zZSzM{ht>@)EaFJ+mB;?+I z2KVj${+lbknJ@UwC`Yo@Avh>e9pKY$uMeXpLn508JA8g_k`(P&5Vl1zjnF#{cnsh0 zr^JEA4@5OB+a78f1bscNxZb>i3a2coQ}E5ra#vk@lrgEPBp;@ajEQW^1gVF4zp9W- zNp()?#`T7DiQM<#No>`|!7dosx@W{L$}18=d5acbUU%tQ7Fe#Mk({GX{TjcQxeq)W zvck)aO(y)pvUa?*3gRT@Y0xmfZ22gP&6I>DP}?BWd*Yh*FoCSSsq~-L3E_j#b1Hh+ zEX?^jyBMIqC=|yGt->-C_B|^l;q$QkR=G$`HPAQT60RdLjd4dNR)w#8*5lM6_ADOO zGkEPH1~(@rnsSy3)yD#udy`XMG`^6IwF30aH@595|7IyL*3RDIj5sw$ryhUm9q-Y;l1GviC=-_amo1Y3%}9qw-x;Va>b{J z5Q~y)E#F}^WB}fg&q#)W;wBJ4KqJJH>@ggmpfGq!AH9){7t{oE!L)*-qG9gV2*^6t zX6b5@xe&B*1Dv-S=Tj8N2w+4;a}rtiMuAC4%v9j`v6#CmTKm)ewVR^fC%V+D8bjB! zl(FYxDtS)RODM)A;u=*!Mb>%AC{Et}=#C$CspS0Q@G81PXh{$*FT3+aILN_t;lm|H zx6yo#r^EUagWxGDsi6kK{zNorQ8976v<0{pv60AU{=!K#uKrA-2$5Fb57dl+>zvXK z9>2KP*GNSS=Vc8%|KRh*p{oJ2W8|oj;tFZumB)tpXgl)b@hbs8J`jS$UQob+6Fbur z!pBu*kD>0K7fp8G6Nl%e&!NgN!9^K#mQ;Z9wP1m&IEtA`J|=|B;~oo2>oc zFgQ6)I72K?31r5MX@Gsr?~bt;Qio2h@TLb`xF9J~_)BQz9J|aU-O?9%e%)7)pFh4=$V%rPr%-r_zOo$Qx|XYa@_Odh!edT$=X*>7NtuMD4g}7K3mpw0DhAS< zJsA0}8(q)_hHO%naKecpn}CP$5m{RtXTcwaBOv8e6dgtoSnJrW;1&B>9Rz&N2>2S@ zUhz8BD56j2DSkttZxibO$Cadi#x*RSIw6tS|6>1tcZ`lvTD$mE6y|Q-9))0NADvQV zRY@ykYtqcyaJ}o)fEdzZKOF2JnSn@&87Tv7o{|uBTurc`=7}}DkQq1FwDfE2I}6R_ zgE?Cd0K6EX$e=zOD7$|xQ-AYQ>9GZ-l|OL-czcl=*J5UsD;x?Dga9%vtH2h>z8#`=GY^^g0U}iCDjnFq99?CU5*JD7N*4|t{3RI3ZdGB44P5MgX$ciqhHcK&o`~dN z8767ZK{VjB5VlEFz$Yz-%9?yatE(ST(IkolZ}Ko_(tBz#Ls(+d9Nrj+y%)DOH}?`j z|Dxp%6d?ahi`PN{>SZJGTPw^cz)wDW2%EWrg_e8|jrL10@F{P$YDp&28nAkUW|*7x z{0llaiD+Og_XRPcs|OsBBd+0u07L%?m_`qZn*nOF(equ;4=I{W?UzSnnOG`zT2TOELqm*Z?uKo4>3t-c8 z39b|KwhjL{dc4RGGWPlLrm$U8Ssi@yhI4Qq>*~F-&_XxE+ScAt%Fmm=cxlQaGzkeE z#|n_O-5{}0uX%w|0hfdsn<*>n3duhV@84W?xc{5k^fzRuBqF+|np~|CJTeDs&yWe=`vx#!Wc;UVKe#h166qghc}?g(4ub+R48%76(RH^J>)w*iR9dL2mvhF{vxQW0+)u;5F9Y)(#LK$WLI^Vg1sk+N6Ioa?V5kNM}42yFt* z6e41&Y8w?WKKT)B1^4jDOuW|F2jyd;JOHOspQ^R7 zPt_tP5+y`rRqz$}N(zb37U7x8$6Va1GSZQgaQ<_& z&{3q~`N)aqz8x~)`D%emUO|3KIV8UmIe_h+n;6siq|+;U|H{biO0i9f15~ zCfn0Wd+Er@h10!{y#NBwu1*>&I-!Ib4Dpn`Q;|1AKr_gY*k4h>>1>BI7DdC+62c4-~n8; z*gAZdtn>qnjl5m_y389E-5Q^4I?{46I88;Y3dfgY@9;@0=>hJb$Qz5`Wd%OrHe20r zzQrF_C$FoN)-;euz<%(JY|kH8tRL>%T}Ev2O(k#kDdKy!MOHHXpnd$chy#P*(gqeJHZDXHlaNwP{SBMu~ z=r8+(N)LmJJ}f(>)ck4!J-R3?|Kt;Vazor6ws-8@9g!4u>5%$6LiueV%B5$){z4wd z3E(TW#2_MO6WLKUu@*1aLN+L`Q%dnq$YVJwKo3%UaJl{Md!$3=9Wrtm$YeIT2D;2? zka2N2f@Pf8#YtvF5w>L>c&FoDM#T)HzMB&n{*3)D4fT`O7&TnbYu}Q zZi}q%@G(lnU%PrA`}r3aH(co}_a}_D(v~Wx)0R=+Qs;6QFBiP>Kc74V?*S#_OhTPE zP9o(#ot5dG+jf?b^)6o`ufwR*VrKJKLZl4wiul8G=>c_b@U<^H(yzz}DdKj=X0mT< zA*I=|+x!i1lVqTu@^LEqYW=b6T;|I(JB?mWHQ=?R!uxW3a$&yLOx6DPSh>25cZgw~ zQ#cQ7Q~>IAjDk04ymm8WF|Z$7gPUA`lFq#fo^UPjq&MdU7M6T1!2RDg=4Nt7zd+Pz Xx=*?;RR{h7HwUxZeOKY9pMUi)xWNkf literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_osc_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_osc_tilde-members.html index 284953e3..ef7fd6fa 100644 --- a/docs/html/classkiwi_1_1engine_1_1_osc_tilde-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_osc_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +

    @@ -71,36 +98,49 @@ - - - - + + + + + + + + + + - + + + - + - + - + - + + + + + - - + + - - + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OscTilde)kiwi::engine::OscTildestatic
    declare() (defined in kiwi::engine::OscTilde)kiwi::engine::OscTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    OscTilde(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::OscTilde)kiwi::engine::OscTilde
    OscTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OscTilde)kiwi::engine::OscTilde
    performFreq(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OscTilde)kiwi::engine::OscTilde
    performPhase(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OscTilde)kiwi::engine::OscTilde
    performPhaseAndFreq(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OscTilde)kiwi::engine::OscTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OscTilde)kiwi::engine::OscTilde
    post(std::string const &text) constkiwi::engine::Objectprotected
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OscTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::OscTildevirtual
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::OscTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) constkiwi::engine::Objectprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_osc_tilde.html b/docs/html/classkiwi_1_1engine_1_1_osc_tilde.html index 5cc7e7f3..611ab87f 100644 --- a/docs/html/classkiwi_1_1engine_1_1_osc_tilde.html +++ b/docs/html/classkiwi_1_1engine_1_1_osc_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::OscTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::OscTilde Class Reference
    @@ -75,117 +103,159 @@
    -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener
    - - - - - - + + + + + - - - - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + + +

    Public Member Functions

    - OscTilde (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +
    + OscTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +
    void performFreq (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +
    void performPhase (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +
    void performPhaseAndFreq (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     

    Member Function Documentation

    - -

    ◆ prepare()

    - +
    @@ -220,9 +290,7 @@

    -

    ◆ receive()

    - +

    @@ -238,7 +306,7 @@

    - + @@ -255,22 +323,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_OscTilde.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_osc_tilde.png b/docs/html/classkiwi_1_1engine_1_1_osc_tilde.png index 581c6f9b43d1499003f109674e9f12e4c6cdbcbf..33b125bf941e6d003c16bcfb14c8cd5d20e1c18b 100644 GIT binary patch literal 1836 zcmb_dX;4#F7=59x*q90;8n)JnrA0-BvPh`4fp?D10^Wft6XGg`!VgDwR%6 z>vBSuGY*7?kOB14$0olY<^}-ML?r(o!#EgSzAo=pjg`MwBUNo)Y-g(0DyKPAI=o67{GPcEHgyei8&Uhbw%<^)0cy>i(yz zph8w}hFHo_buh&#Rvfx^Q$Yse8C4am$Z;({_o9CmJa0jRxs0j8)xA(kN?B3S$gnMw zE=dWbD!Zt}^DS+!Q}$&=O4h`aD~l6YIn@mMmO4+#9rDUOgY#K8_BTAQ=SHo`TJZA+*X6SzJIg=9ET zxCI=TT&$ND6avF_8X+!Sr5>CJ$3~nb@`sBR&LS0~S0l>^=M_KkF5Lo7G+jTiXH5}> z)EOOEF|_hwJl8(^T#s_x9k;Zh$&udBeX{^hZS_=p;5e80Qyv_Iri&bGq2ZeG#+HD* zQbS@*53}JRlBdhPS{n7VxvPy|-h3Sq3@&pfb@suEB9$PCO5vZm;Uy=f7mfRZ@I5lr zQMk_U6!F@V?Q6A7-ZU$3MEOG957(;063OmCAbT`jv4be0YJ)4wkS?<(4hn5^=}lld zTqy{)_!^2S=sB|3BD3(VH&q!&h`VH)EtMs_#zP`TA77l*2fU%7ZG8#%gjHQ27X5a2Ya=z9tAvg^6Cz=El(jmK@ z5cr<*w=xKjH^zzHGI*G)IpT}b1h9R+(0G;tcnOtA4I{d?-Lkt+(z5QL`0n8%n{I4z zH0Ga~B2?B{6sI z>^QACQp&E<#xHeyxo1f4oqKXP%=ArY=}BluwnA>9J+Y4qkJAjtl%j zXTU;!=bqVk$bUWbHlEsIq2bY9Hrr1qnOxU$MMg&>f--f z(UXkgRkgsF0=PCVV%z_@xZ8_ZOaU>|X}2(`B4gtVlX}JQ_xj-&DrTZ7ihuTANr|Sz z;61^@<)r$Jt7y|=$&YhS?qaS)^0NnT#(L{c`AV-ol~bc-n!etBE?8ZeVY3UgA+`wV zs;+pG47>70_=p;4iDzFYlTOgG4RY>k?)V8sfu(L2l>XRlrhS~sB|&p>isSbFi>mU@ zGzHXEJ$vl9@u*?68kFDa9qNwZTgUB>Uvaa|Cw#C(T)uPnNSL8HBHxwQ?ju{Cgjq6* zhk(+9MzWc&C`z)G*5d-Sb)s33Jzm*>l=c^gL_HRL2M(aFGXo68FUyY?>`g|$Hh{D? K#9y!`^4RYI-Bx>(JQs6|k1#bp6}b`Z#F6OHVXxR?pu*xQH6do63U9~h$tucv{*!uk*mxQ} z`lNEwBmCZ!+GnPdt}ME3b+>L4U+DgO-TY5&J2u$9t2a5$J#ooon+fWk>jjT~WvdCC zr(*i@MD_DqeNXPr&%Jwk`;Yh0S!p6Loc_hwq)w<$0^v>0V$?i~*X>vIpJaF7_7l%b=>?UOQjR?JoFq71-O~*i36eWcax1n7o_x|OaHxY}Pp@P` z&N1GLPZ@8_c>eHhuk@nR%o_^1b4scox4rnpaHirAgTbRu48RCuP}bu=&~cg>8~4m- zn|{6n`5&CUSu6B$E5mNciSr-_DKbjTRq$j6B?^>OQlwfL{B7oSkD%_l?5jnqHID85 zoANj6?s`rCNpUHw+O+=nJ*qN}3%>XF=CrBS5!+6!O^f`oH}mD5uqo2pE(lj254=>e zG3j>q|D$HNwmwl!{TN;I&UKYWx6fXal?$%sP7e1C__AZlp4|N+-d)dEY(27R(VLnZ zzY{N;pNwAjV_lyv^OL#rCr?+~@oKKP_~t*;tlw|!i@j7=_B{0E_b$%GOOn^t=M-0- zU2W*C9$)hO?IqWZ8~!LfyIFQ!CVbwm(3@qJOJ2w2r{4a`v~!A$r0A0>wUM|d7E*z^OV#_)U||A7`z z92GzR#-IZXQR8)dxS|Dnc;kpe?23VrGkaO4lu*M(NmGyM>#EhKyiYya{^L$}NTArvUp{dcBTjg)uY1S9P}6g4>z4SEHT(;+An__SR^udy85}Sb4q9e E0EZx?ZU6uP diff --git a/docs/html/classkiwi_1_1engine_1_1_pack-members.html b/docs/html/classkiwi_1_1engine_1_1_pack-members.html new file mode 100644 index 00000000..938e7c22 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_pack-members.html @@ -0,0 +1,135 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Pack Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Pack, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Pack)kiwi::engine::Packstatic
    declare() (defined in kiwi::engine::Pack)kiwi::engine::Packstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Pack(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Pack)kiwi::engine::Pack
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Packvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setElement(size_t index, tool::Atom const &atom) (defined in kiwi::engine::Pack)kiwi::engine::Pack
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Pack()=default (defined in kiwi::engine::Pack)kiwi::engine::Pack
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_pack.html b/docs/html/classkiwi_1_1engine_1_1_pack.html new file mode 100644 index 00000000..aa239d67 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_pack.html @@ -0,0 +1,264 @@ + + + + + + +Kiwi: kiwi::engine::Pack Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Pack Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Pack:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Pack (model::Object const &model, Patcher &patcher)
     
    +void setElement (size_t index, tool::Atom const &atom)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Pack::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pack.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_pack.png b/docs/html/classkiwi_1_1engine_1_1_pack.png new file mode 100644 index 0000000000000000000000000000000000000000..db32ba4bc7c275689301a0e11584386fdda3a74f GIT binary patch literal 988 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GWKo-U3d6^w7^zMZsLOMvZm`>H$tRprA) z*j$seCR;_le{(7DXAZmj|4Bh!-`iC@%hgR(Pj+9JqN3mRETt~DSEY1C@3Pw_|7Wf` z%(67;e&UW0_uxr-7cc8{r5Df5s$H^kO76^>ZDvo8smA=Auv;g5uE5!|sk3sA#FyIT zFOHPjcJoX_R-(!37|ZC>MrEP8q2IE!XQu_5zuWcxX3W}iVa2yM{f)Vl;`P6vBQ5<% zsk4Wd)vudroVMoXmzPT~e5;r-@9V0?k?QCFPhV6ix9IP?dFj6vE|1*3cqjii zkIl7a{4?$LZG5=-XWr#Omxo&uxu75dO>6UEXrMpl1YMK9k(f;yqb;P7| z9KP-_43~Ym6z{YmZ?+<&YJY(sP);Ce{M;6zAC(Bb+&%l z;f41rZe`D!^hMV7W6q)VrqegAop9c(p~$x^Vph@ft%piXH?Ljn)&4ZW+WS)9_gSIq z=1korljT}%V4i8p|M<1zq+ffk-YLu8pOioI-lyXkWxs0ozhpi;M|AnD=u305u6^V? zpElF{|92&mu1glPny*X`Iek?m%krc3{gTNq_g9*gb6!~!SiJ4*m)OtK&acigzkGeU z_oS*Fb**+4C+mLLm0gzEyGu3m`2VFp-?8eRoZ@evw{Etc=YB<4a!5NnC1{r|!@WHW z@6H>W#IJX+uyZcnR@3y{*+ls=;~)H?gCzS%{@R>nnY-+L7=TF)5~}Mmp2=;yUvb7W z`&`5V&FhOwVuc@QPs`*h-kGKMbbb1=zLSizvNs*MG{t(o=(5+}HizXoub&Zjc}>yN zHB+7jXy0nyd2&(alT&w@dv+|z6f@AC_Mn6>_vpu)Yl=(c!W(4oXFXf$Z<>3}q`7Wk zrg_Hgk7+LhP54h<+Gd$owYl-Fo7^9^*>zTI31_Z~Px4*hR^xsBYgWC#+U&Q>*83m% zw~lewj{4TR&w<5P_lQY0_NVtjOT$>gTe~DWM4f)cxU& literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_patcher-members.html b/docs/html/classkiwi_1_1engine_1_1_patcher-members.html index 694e088f..1334484c 100644 --- a/docs/html/classkiwi_1_1engine_1_1_patcher-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_patcher-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,31 +96,34 @@

    This is the complete list of members for kiwi::engine::Patcher, including all inherited members.

    - - + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + +
    addLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal)kiwi::engine::Patcher
    addObject(uint64_t object_id, std::shared_ptr< Object > object)kiwi::engine::Patcher
    addLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal)kiwi::engine::Patcher
    addObject(flip::Ref object_id, std::shared_ptr< Object > object)kiwi::engine::Patcher
    addStackOverflow(Link const &link)kiwi::engine::Patcher
    clearStackOverflow()kiwi::engine::Patcher
    endStackOverflow()kiwi::engine::Patcher
    error(std::string const &text) constkiwi::engine::Patcher
    getAudioControler() constkiwi::engine::Patcher
    getBeacon(std::string const &name) constkiwi::engine::Patcher
    getStackOverflow() constkiwi::engine::Patcher
    log(std::string const &text) constkiwi::engine::Patcher
    modelChanged(model::Patcher const &model) (defined in kiwi::engine::Patcher)kiwi::engine::Patcher
    Patcher(Instance &instance) noexceptkiwi::engine::Patcher
    post(std::string const &text) constkiwi::engine::Patcher
    removeLink(uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal)kiwi::engine::Patcher
    removeObject(uint64_t object_id)kiwi::engine::Patcher
    sendLoadbang() (defined in kiwi::engine::Patcher)kiwi::engine::Patcher
    updateChain()kiwi::engine::Patcher
    warning(std::string const &text) constkiwi::engine::Patcher
    ~Patcher()kiwi::engine::Patcher
    error(std::string const &text) const kiwi::engine::Patcher
    getAudioControler() const kiwi::engine::Patcher
    getBeacon(std::string const &name) const kiwi::engine::Patcher
    getMainScheduler() const kiwi::engine::Patcher
    getPatcherModel()kiwi::engine::Patcher
    getScheduler() const kiwi::engine::Patcher
    getStackOverflow() const kiwi::engine::Patcher
    log(std::string const &text) const kiwi::engine::Patcher
    modelChanged(model::Patcher const &model) (defined in kiwi::engine::Patcher)kiwi::engine::Patcher
    Patcher(Instance &instance, model::Patcher &patcher_model) noexceptkiwi::engine::Patcher
    post(std::string const &text) const kiwi::engine::Patcher
    removeLink(flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal)kiwi::engine::Patcher
    removeObject(flip::Ref object_id)kiwi::engine::Patcher
    sendLoadbang() (defined in kiwi::engine::Patcher)kiwi::engine::Patcher
    updateChain()kiwi::engine::Patcher
    warning(std::string const &text) const kiwi::engine::Patcher
    ~Patcher()kiwi::engine::Patcher
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_patcher.html b/docs/html/classkiwi_1_1engine_1_1_patcher.html index 0ee9300e..b50f2462 100644 --- a/docs/html/classkiwi_1_1engine_1_1_patcher.html +++ b/docs/html/classkiwi_1_1engine_1_1_patcher.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Patcher Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -77,80 +104,92 @@ - - - - + + + - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - - + + + - - - - + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Patcher (Instance &instance) noexcept
     Constructor.
     
    +
    + Patcher (Instance &instance, model::Patcher &patcher_model) noexcept
     Constructor.
     
     ~Patcher ()
     Destructor.
     
    -void addObject (uint64_t object_id, std::shared_ptr< Object > object)
     Adds an object to the patcher.
     
    -void removeObject (uint64_t object_id)
     Removes an object from the patcher.
     
    -void addLink (uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal)
     Adds a link between to object of the patcher.
     
    -void removeLink (uint64_t from_id, size_t outlet, uint64_t to_id, size_t inlet, bool is_signal)
     Removes a link between two objects.
     
    +
    +void addObject (flip::Ref object_id, std::shared_ptr< Object > object)
     Adds an object to the patcher.
     
    +void removeObject (flip::Ref object_id)
     Removes an object from the patcher.
     
    +void addLink (flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal)
     Adds a link between to object of the patcher.
     
    +void removeLink (flip::Ref from_id, size_t outlet, flip::Ref to_id, size_t inlet, bool is_signal)
     Removes a link between two objects.
     
    void updateChain ()
     Updates the dsp chain held by the engine patcher.
     
    +
    void modelChanged (model::Patcher const &model)
     
    +
    void addStackOverflow (Link const &link)
     Adds a link to the current stack overflow list (or create a new list if there is no).
     
    +
    void endStackOverflow ()
     Ends a list of stack overflow.
     
    -std::vector< std::queue< Link const * > > getStackOverflow () const
     Gets the lists of stack overflow.
     
    +
    +std::vector< std::queue< Link const * > > getStackOverflow () const
     Gets the lists of stack overflow.
     
    void clearStackOverflow ()
     Clears the lists of stack overflow.
     
    -AudioControler & getAudioControler () const
     Returns the audio controler held by the patcher's instance.
     
    +
    +AudioControler & getAudioControler () const
     Returns the audio controler held by the patcher's instance.
     
    void sendLoadbang ()
     
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    +model::Patcher & getPatcherModel ()
     Returns the patcher's data model.
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     

    Detailed Description

    The Patcher manages a set of Object and Link.

    @@ -163,7 +202,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_phasor_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_phasor_tilde-members.html new file mode 100644 index 00000000..4ab198c0 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_phasor_tilde-members.html @@ -0,0 +1,144 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::PhasorTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::PhasorTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::PhasorTilde)kiwi::engine::PhasorTildestatic
    declare() (defined in kiwi::engine::PhasorTilde)kiwi::engine::PhasorTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    performSignal(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::PhasorTilde)kiwi::engine::PhasorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::PhasorTilde)kiwi::engine::PhasorTilde
    PhasorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::PhasorTilde)kiwi::engine::PhasorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::PhasorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::PhasorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_phasor_tilde.html b/docs/html/classkiwi_1_1engine_1_1_phasor_tilde.html new file mode 100644 index 00000000..3c76daf9 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_phasor_tilde.html @@ -0,0 +1,338 @@ + + + + + + +Kiwi: kiwi::engine::PhasorTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::PhasorTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::PhasorTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + PhasorTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    +void performSignal (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::PhasorTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::PhasorTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_PhasorTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_PhasorTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_phasor_tilde.png b/docs/html/classkiwi_1_1engine_1_1_phasor_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..123d1090db589901211a7734f7876e74d123d17f GIT binary patch literal 1856 zcmcIlYfw{17`+JiphkS5qBXRX2$DfW1wlJ1Lcq%-Mj+8%d0C(aqQM6VR1Dx7OBD%4 zQAt5WQ9=YIA%s8(Dxy+}fcHiTh>94)B?$5enqYeMN2j(wI-O2;W_Qm%X6M^I=R13x zLiWX3%(nml00(aH4gvrZ8iwVQO|h2lA>E2~^C$r!B%{%Y!Pk8wtjwFIF!ZU)<#O}m z9X8l-azYR}7{E4tEb#r1WdJZy0eX9eB$;S==$^N$rkkm{9iJMrENx^PZYuMpE}oiQ z<#HO~cHEVwYV@+yRA33o8GJ()`f+*m9J|#mjv%{`%IyoKF*b7$C$4b4ru1gDJ^~ib zi)1EEd(7)K75cRf`EHCpl>5RmQ+q{fMv@%3sk#~<~JcGXRyb5h=o z3M(Zd_R=#K+TML{U%&q_ayb(0eBr>VtuAp>jlClG)JUQp)!xMg`&tVmZ+aoZy?`f; z++kv&D-^+p>8{ws#=kuSh0&!OSD6lIJAesk*>v+=d!-G;w6h<9czziWUTF2q+}kmY zM>j8@B>>okR&ug%!sFvKV0DW{q&;NP=S}=ii$`Q{^g8t(R7=owUKRPZN@oeU(e_xV ze=z0?NqZ}pSw*gH$x?lURe8F~X0!-71Yc7O#>eO@{96_7#Z+!eV`&0o-9;J*#dz_D zJQNJhm)Tj*Rfgr3PPcC2!@LF_Q;yIso=ALPlG#>&)T4~GUDRC!pUY1jym3k$Jnr$d zT>LCb5c6Y9uVx%tIZ=$k+;;vrzgi<)vypSAC9BC%TAHl^S}sE2~C&{SOL zw0bn;%trn4oTlVK+M)JdVO?m*-r!kw-~xjWTAmjuU=g;!P``1tfNB9ncUTF!mxqAz zB2mB!Lzz}y8&*}fRkh77mS?l*zzMinuN5N2ldfc^+3nm@87=r(JS^dv&6(0im0%%c zbX1p(d?og4U1TqGBNSNIa)>4GAF?-^CzKTIl+RA2OlXel{B9@DtVASAIZw*LZWTWR zgwz}OcDx@_9l@S4&)1fixUEy%rFP>}&m-M)y@EWjWFS*u4%n_PR*cj_1WimXMuY!x z8hGO~Dx?U;l(@LHUB@ww0#y=|(DaPbm5@nC2UGcWU)G2ZG3~tG(Ya^D7Ck{rn|q3D z{?GF0V2V|jfU$6yVbCPp^WW;~lXNCM3mWDQ_j~j0p8PrF<^~ZP-ri{oGIr>e?CZxp zsM6IrGMx-<*!`U~bG$^#idKR3+Ca2B7hhGmd`DSwQ^Cs?SF=o`cv!=tlIf6Dk1J6z&D)F+N^h1dkEu}Iq zloIVm3Us|P?Za7QS-rXkdFOJ>$QI)>N}?=BN1@HD6^%Kir*ZizumGt(caVQ@)JigP zHPSURv<|scDQ49?O(K+fD+np~t#v2ahhq!wpbZ!$vF$hlXv{x!T}EPT9V2KGz0pvV zaPM}@mabpS>@=C_e`V~8I4x#?$$*TvU>&e)rT}0v#YyH%u{37()4HwX{=x}0X&e5h zy#9FXLsppX0}%R?f2sTDMzN%fRaLq`XA^rd(XngNn#-$FEf;*Fj31jW0P0@21Z0_) z*Uugt#GF?MAB`V+Iv<)C+qQ^^qrU!@)}{>qEjwVXd};LZhmCZnW$O5$LHC@aqaouC zB*dr7;W`Yxh!~z`Vwj<@92m}}uG?L)l&XSWB5(JdxgFN7dN;?Ea{%##FC#54ZKF=U z8L9EK6d|UZEi;q$U-eH24yk0LabL%|Me@wpY$C - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -70,25 +97,38 @@

    This is the complete list of members for kiwi::engine::Pipe, including all inherited members.

    - - + + + + + + + + - + + + - - - + + + - - - - + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Pipe)kiwi::engine::Pipestatic
    declare() (defined in kiwi::engine::Pipe)kiwi::engine::Pipestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Pipe(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::Pipe)kiwi::engine::Pipe
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::Pipevirtual
    Pipe(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Pipe)kiwi::engine::Pipe
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Pipevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Pipe() (defined in kiwi::engine::Pipe)kiwi::engine::Pipe
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Pipe() (defined in kiwi::engine::Pipe)kiwi::engine::Pipe
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_pipe.html b/docs/html/classkiwi_1_1engine_1_1_pipe.html index 84ebe1fd..55f5fe71 100644 --- a/docs/html/classkiwi_1_1engine_1_1_pipe.html +++ b/docs/html/classkiwi_1_1engine_1_1_pipe.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Pipe Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    -Classes | Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::Pipe Class Referencefinal
    @@ -76,74 +103,111 @@
    -kiwi::engine::Object +kiwi::engine::Object +kiwi::model::Object::Listener
    - - - -

    -Classes

    class  Task
     
    - - - - - + + + + + - - - - - + + + + + + +

    Public Member Functions

    - Pipe (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    + Pipe (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     

    Member Function Documentation

    - -

    ◆ receive()

    - +
    @@ -159,7 +223,7 @@

    - + @@ -176,22 +240,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pipe.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pipe.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_pipe.png b/docs/html/classkiwi_1_1engine_1_1_pipe.png index ba748fb83333ef35196c5b86d0325fbca194da54..b665a539b910e3e3f41f3e11dc3845795b003009 100644 GIT binary patch delta 935 zcmdnba*18BGr-TCmrII^fq{Y7)59eQNG}884i07@8TBE7d7`3KJ#(U`i(^Oydt@F`D-}%xZKYBWo^B8bLrwwHzg%LPoEOB%U;EEm-RwT&$yOlDwTnz z>Yp>SRaPFpm9fkBy?yZ3*$cvQtY!4BUYxQd_>0NvM;YrDUQ<20b4u!`yO*X&KQDOd z{m#g~)ags!y311p?XUja*PE7Gud#V1KX*x#Z-Of2rbU&vgVoC{LC;dv{s<^)r&iYi@pdxir91ZrSr+S1!h=pZ~vn zktN^7vhw3I_r1=%_AVo@xpv9Td1qsn$=7c@y!mJ5Wphpy-`z&1NcsS zzIyYQc}2(fHSYhVUGgzh$5Ywq^2JZ9FHTWWcM6`ghr`$N)1$RBgS@u0ADAtE;BRHy zv)5la&ZlSW)1Cj|r@+}0B@FgX!Uwu9uzXN5VFW5?(8taF(QX>-_43~Ym6z{8!6!It z(vzd=^=D7k+>-KqWtcPfUj4Ge>+XNt^4vuAWqHWai!J-F&GC*@ynmJ9>8v*f=1Z<;X66a{VW zbdKHVvf|>+7t#F1X4SQ48JO$V&zvrorI&VAP~L=@XUDdepM7tBOnbRFxk~7srqa#@4M{=yvDZGo4sJ;?fVQ=*{$*5XZW*$Jx?_C9ip%U;d?;Kg)3i<>LC?T(wDw@5#> z|C*MYw&eO9n<`WFR`YG#fA!SW@bf!1Op`4Ab$Qn=4)ynPAC|4|H?IA7_Un=Uebay0 zRD3BC5Y+r)xuG(?ql4$F@7@1mt}e@7Xdk>+z2AXB|25kNr_~3x-&Xph^bP0l+XkK?v(eY diff --git a/docs/html/classkiwi_1_1engine_1_1_plus-members.html b/docs/html/classkiwi_1_1engine_1_1_plus-members.html index cd4e994e..a29bed85 100644 --- a/docs/html/classkiwi_1_1engine_1_1_plus-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_plus-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    - + - - - - + +
    @@ -70,25 +97,42 @@

    This is the complete list of members for kiwi::engine::Plus, including all inherited members.

    - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Plus)kiwi::engine::Plus
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Plus(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::Plus)kiwi::engine::Plus
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::Plusvirtual
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Plus)kiwi::engine::Plusvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Plus)kiwi::engine::Plusstatic
    declare() (defined in kiwi::engine::Plus)kiwi::engine::Plusstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    Plus(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Plus)kiwi::engine::Plus
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Object() noexceptkiwi::engine::Objectvirtual
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_plus.html b/docs/html/classkiwi_1_1engine_1_1_plus.html index 0c77e825..cc5bf8b2 100644 --- a/docs/html/classkiwi_1_1engine_1_1_plus.html +++ b/docs/html/classkiwi_1_1engine_1_1_plus.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Plus Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::Plus Class Reference
    @@ -75,120 +103,137 @@
    -kiwi::engine::Object +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener
    - - - - - - + + + + + + + + + + - + - - - - - + + + + + + +

    Public Member Functions

    - Plus (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +
    + Plus (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void bang ()
     
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    -

    Member Function Documentation

    - -

    ◆ receive()

    - -
    -
    - - - - - -
    - - - - - - - - - - - - - - - - - - -
    void kiwi::engine::Plus::receive (size_t index,
    std::vector< Atom > const & args 
    )
    -     		-overridevirtual
    -
    - -

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    - -

    Implements kiwi::engine::Object.

    - -
    -
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Plus.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Plus.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_plus.png b/docs/html/classkiwi_1_1engine_1_1_plus.png index 5dde29b5f266399ec95e90e55c7e6172b94cccba..b87134b5c94f1ef700f63572168d31e33cd3aa6b 100644 GIT binary patch literal 1282 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~nds@_7*fIbcJAw<)doCl)6W}M{&%+% zX`XmcZHY#4!m4ZBN3QqgOx(X@%B8=Go|o=&`g(p+GEqI*y~uLL>a`P>uw^fPY1UJ} zEX&++<&83nm{kikJ(p)>iXFWd6T7zGWcenY$@8BryJOL+eZOe>%V1@foWk{^TT z&VQXTtu58eIAN>7tkp4-4nT=abliZ*7k? zkyfs1yx+Uhq-r_x* zyP@CY_2!+YzdY72t1!Et`%A5HNn&`_%)B@j@49V9wZ1O94~OoWeP?6-gZ2NoYJX@= zTOzmcWya5|8D5iwfxd`qS*B8Hn6+%mrMHY9p0O6x&s+Gj%J$G_$ytk^3fssplAOu+ zz&(ShLU0yCT#H(R_(IMHuDH4N5ynfWyyN$r^v(}xzBtJIJ(p$9T)pNI)SdU*;NMKX z-F3$=&$~QjNw&z*do9yVmv34#VZK*Gk#E_ISw+ux9x5^2e0H%{`^z+I?@MjpK|!XK zx@)cI*RwUAt9MH8zo)YDZ1maG?c21sP0Q5X-=DVl{#Rf73uhuPUX7WwZ1v8*a*Nri z_x{}Px)3;}Z*k>>Uz4sCnYCtF)&2D~pZRa@=AE7kvU*L^U;ErQ(f?_)+RV7tE_TwD zLtn#RG*5ri{yy3K?Bek4D!D)6XT6WRFv;iVm*ZzkFRQ+^1_hGftVvIfu9z9*wVnOI zZ1DqsE8CvE{>pJaJ)>`$|A(56v=plbdHkV+B>N}v?3AEg_9~vctYMLG@hVb4c?Qil zKdWw{`cmq$&Hg`a&rOzpGImd!t9v|s%}KuC;CD9RGuEYTTV=}st1?ditCqTH_|8uu zUU7>WA?{qC)G8R_>UZ>pAGT+?c{dz+;C$!YPK&(^%i zy0zqH_PMpE8F#GOxo-adXu(%*n=8#$hbfo&7F+Mx|8lo;=H<0L8RsivH+wC}I;F*G_AKKk%lY;Uw`I&fh)Y?(usbS$O{OhzhdmENxw;AC z9u8jy{d1Ym?6y7sxWX^{+|BZ4#%(o=I14&6XMOzSdUmDG!VQb3G5BtupZyXPT4n2I z7N1H7htt~coA1QDnk{-edmisw&$CsG)<1XMt1A`W`u3)Yc|&>3^)ue(rsoyl=f|OC%oW1W{ImF(0ng#LKiNI@5f8Q|y6%O%Cdz`(%k>ERLtq$_|pfP)!GK6Q26JyFrBp7DaGi(^Oy?AMMC z5AVB?-~VVdpVH$KNf4ZPe#!#dcHR#c&zU~dV-<93x}K~hahx%A)t;lFCm+1%%@b3DkkWeCd<{qZrvC62YO==y}|jrIFC ztTLBK=rfZ@=)#U4Y?@P?*IK~vdFw%j;4kq99=6L#y0d8;|JVC*bSI0!wcCQPKQld8_wByY0gyi}pNqXzopr0FW^BR{#J2 diff --git a/docs/html/classkiwi_1_1engine_1_1_plus_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_plus_tilde-members.html index fe81094e..6e4657db 100644 --- a/docs/html/classkiwi_1_1engine_1_1_plus_tilde-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_plus_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -71,26 +98,42 @@ - - - - - - + + + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) (defined in kiwi::engine::PlusTilde)kiwi::engine::PlusTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::PlusTilde)kiwi::engine::PlusTildestatic
    declare() (defined in kiwi::engine::PlusTilde)kiwi::engine::PlusTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::PlusTilde)kiwi::engine::PlusTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::PlusTilde)kiwi::engine::PlusTilde
    PlusTilde(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::PlusTilde)kiwi::engine::PlusTilde
    post(std::string const &text) constkiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::PlusTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::PlusTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    PlusTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::PlusTilde)kiwi::engine::PlusTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    @@ -98,7 +141,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_plus_tilde.html b/docs/html/classkiwi_1_1engine_1_1_plus_tilde.html index bb17c1c3..ab78b97a 100644 --- a/docs/html/classkiwi_1_1engine_1_1_plus_tilde.html +++ b/docs/html/classkiwi_1_1engine_1_1_plus_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::PlusTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::PlusTilde Class Reference
    @@ -75,196 +103,173 @@
    -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener
    - - - - - - + + + + + + + + + + + + + - - + - - - - + - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + + +

    Public Member Functions

    - PlusTilde (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +
    + PlusTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs)
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +
     
    void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    -

    Member Function Documentation

    - -

    ◆ prepare()

    - -
    -
    - - - - - -
    - - - - - - - - -
    void kiwi::engine::PlusTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    -     		-finaloverridevirtual
    -
    - -

    Prepares everything for the perform method.

    -

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    - - -
    infosThe DSP informations.
    -
    -
    -
    See also
    perform() and release()
    - -

    Implements kiwi::dsp::Processor.

    - -
    -
    - -

    ◆ receive()

    - -
    -
    - - - - - -
    - - - - - - - - - - - - - - - - - - -
    void kiwi::engine::PlusTilde::receive (size_t index,
    std::vector< Atom > const & args 
    )
    -     		-overridevirtual
    -
    - -

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    - -

    Implements kiwi::engine::Object.

    - -
    -
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_PlusTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_PlusTilde.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_plus_tilde.png b/docs/html/classkiwi_1_1engine_1_1_plus_tilde.png index ff9c999138e95ce2ea6cb4703027082b0f915f5b..da7e5e0a9564d793a9847344db20de66aebb000a 100644 GIT binary patch literal 2274 zcmb`Jc~ld30>>u`#ZpmTUDOAnRs%?=@>DK?L=mV4FdR96$pRvRK!m7}s2nC9#Ucx~ zL7);7lpA7zLJp1qL5nP|fN~5+2!g2~#BhiKBnmt9)xLK9W8c2+yf-u7ncvL3nfZLb z-^sq-=d;kDJg7w0h)$o$3k72{B&0Zb^*X8A9SiX9#rrmt-J*>`hY4 z{)BJakkO}+{_Zks*!W}rzcPTqv`u4 zGx$NYxQ=#za~v=5$FQ>}_~}n(N*cKoRZp6$T0CMXunE;18{5sM)+_c?jMJtQRGs`< zh?*j=ee(!<6e#HmMs63yx7|S%8T187 zAwh?f@26D}Q6Uu7aS!L~ie?S=1D|zr<(;&DF3j|K+_HLFHHcWnOb^#S z6VupY!MqKN*$TsQATZZpSkDE;cNf}J6|hZlDom5--Z^Dg zNMtQNDvsqj=aH~rs538y(*k2_Iy!H)^dtal`_n06Z?$D{HmP1sP1WOyHyMpqL!AD( ztE3q2@{2B)QSo9GBbfT2T!`ypCv7c@-WuW*&&%|u1V|3bkrAAS;Cxu!opGx-#}f{e zu&wF}bB?e`7fWcHW23{*f2Ll5iFUSc)LPd@$B6A;TblJqx~*9GdP})Nc6%XYzu|r) zXK496$kP{mS8V}mtO-uie41ggCP;QUzU~Y|ERrAXv~OIy%BaeCUKY%+((ZOT#IiY% zT}fIbFAlC-l>*F__0`(STu;k;7k7x(K_pOX0lhTJ|TOikhBIy6W1M z(oTtJ`o*KrVw9=1e4^uQ3Vi8ufm>(r+;x^!Kx6pg7kpOiwV<>;*v5y2YIW21RsnDv zbc)|JAXT$6T4Ff~8)p>8XT2qT1n|)=WA}u&d@x)$ig`hTBM?0an7u&Grjh{Lc}9s~x0-NR zzuF|+_TtXy)9ATsyTpMan9648>}@%tjvSOyDr@MIQHUzLEO-Ci zMi}wcLwuUGmha~(ixbMPgRR}mZmMs|WR8JUNlAZqoX3pwlM4g^dabc_pl2D8wXQ3A z7j|)3@=8e-h?0X?OWz36Y64jvk_jdI3KRKZ=O@Ijf$run6^I4;B!G}&1*@uSo+}Kb z9V1eX^>(cfXo_~G7gHVmmF+rF@erkV2YJYYnJ2wv9wI7(z))+KJy z%{WQ0m|kz2$R#V0F$sp{?X7-Khf22Hgt(3MW4k)C_#JeM|QMvf&G@%VW-*EVf6bkn9^m!IP66tI3ub zm6x~7^<)1m&^ALsQ#nV2cyNZvDIf#xV?%$H-F7Ppt9<+!Jq+>ZK7cg zas9gw-h;jG%ZCt{TLFB4@uI&CNeyL|cP&bi_z*fZo^LUpug8u?6=y?h-@%E zeRfT)u@$Apn+Ii?oa+OU5OAj$ailODJS$y9XB d1z@O&aRVwoZxVH$4*!q literal 1375 zcmeAS@N?(olHy`uVBq!ia0y~yV6*|UJ2;qur0@6TkAaj#fKQ0)|NsAi%olIImi8Z- z0AzvjfddCvJMYK?xf~@ye!&btMIdnXREQA+1Is&47srqa#A72Tfd60yDnPaZpwFsLthL3yKmkva8&VFN_+f6j#~bY z_nUk^|LgO=tydMwpZGHRPUa1_|9s=Zy;ZGOKZ(8fH@|A>f8us`f#hA2+Yd@5J(h3I z{-wTRTh3|eWizX9%-uY%aAKwQ-+Q;V`MX;5FSl!&-e{t4IydBb%agB+Ij2^ie-c`G z`FFkcdMgbv^@m-1s_$Ig#(R2p+q?Sfn=2Ws{%7B=TyrIv;^&!_r>*3so7Y!Y z-`3;XU8!(Y@$*UJeEma5XKvSje{kmVT`B%?#S-R^w_3)|z4G?)!USH??6tS@WRLlu zyxmz4m>XX9jr(d?>A__-SC`*BC3jWQzr0q%|Epvihu>G$d(*d1zP743Xr5JUXm04; z=Reo&SM>kN|6_*D)%}W3SF(9lu5t{Tmo;I^a;Ya;>!$?ud8mR&jswScFv!e)+&1GA zLsE=h`}XoX0>N?)J=qEFQ05FB2?oa?Ifn^T*acLcGO~D9V&$HGT4ZU(u>T;xuIPi! zOKchxH2D=gPBC*#`oz#gm}{>NbPONofs2}}*j3P6>+@;XtIc_VvB|$*K03K|q2%{p z!C#|a*ZEbh%D<%Bmi1rmXztkxzsl{|5n*o^_)pFD-v0rT9(-@Ooxf2nlR7IeN22KC z|6GZ;F`v{@A8-G->+Z6)Z(%F1pKIHi*SzN_i*JAMN$F2ZBQNdfzc%fL*_OHG)%G=C zd_VnCt_waM!1(Ii`jfNOEMCtv*IV{K*ZBR$zQ~Jprk};0e(zyjoO<}yw{2^mu9fQz zwfworI6q8pR_j&ijqA2;KK}UB^1SY>+xeHO*R2n|{hP5!t8$h9>{)XI7FJ80$?zUC+zGzv)^2yYoQ-X{?RP`7*54;A3qr`OYTg)62L6LQL zsci!XFqC~(5gW=RMF~{#r{Yh$*1ZNrjb+vZGy|4Tx&A+P`#b&Q$1ej6()-)Js&e<) z-<0}$-hU3!pBHm) zNzR{Z5kK}{`hE3YR;+hrX!70lo49?hTRuH27XEdHj?UaOvLWelrP1e4-k)%t`{tDL z@22)Qw{3rWt2=&UZhri$O*dpdM$gp54rY7-+PtD{DUWcUS;-d-Ur4t|F^OJP)1AV=M>k!-u147 cp=MhB-W%~>nkQ@S1(t>kp00i_>zopr0BvEKJpcdz diff --git a/docs/html/classkiwi_1_1engine_1_1_pow-members.html b/docs/html/classkiwi_1_1engine_1_1_pow-members.html new file mode 100644 index 00000000..a4d9bc81 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_pow-members.html @@ -0,0 +1,138 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Pow Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Pow, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Pow)kiwi::engine::Powvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Pow)kiwi::engine::Powstatic
    declare() (defined in kiwi::engine::Pow)kiwi::engine::Powstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    Pow(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Pow)kiwi::engine::Pow
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_pow.html b/docs/html/classkiwi_1_1engine_1_1_pow.html new file mode 100644 index 00000000..528657ed --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_pow.html @@ -0,0 +1,239 @@ + + + + + + +Kiwi: kiwi::engine::Pow Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Pow Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Pow:
    +
    +
    + + +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Pow (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void bang ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pow.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Pow.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_pow.png b/docs/html/classkiwi_1_1engine_1_1_pow.png new file mode 100644 index 0000000000000000000000000000000000000000..b2d9ababe6f3ea9cb3c53594e35f91eb1cfbeb01 GIT binary patch literal 1290 zcmah}e^8Ql7=Ja(tjx&kv{u;+TjUZmgwmE~GJ93b3F$PI^+Q5Y%g~5hnpfRi$}Y#! z^hKo~iZkVH4%5J2ESIMEidtwcx^xvvD3VwLW(>Oi?e@KUzR&ad-gD30=X0OudpR;9 z#BtfWWdHy;f(L@5ELmU)>C#1(TRcBuYe}w=;S{3TY_^mWlW()G+%L3LA44jYF21aE zv%sa9Q4wUo(quh~9*PeD*p-68`zU8^rph(k+uo~|@UVy4%$wbc14{xg+~Z_jKZDy| z!tn1NrACFSKNO9 z(UUMd6atZBi@RA&a(dbQBCJ?8D@5I_7l(^DhMK;)EL>QJ4{z-sajwWAScxR9^RF%5 zHlKzmpdDflvllB|&lUc^kvyr5rDtoQ{md^WHzTH0tkSMFtcEBwpH*>vF?klt{Nd`+4}lZ73X5HNT%*+3ajp&pLk^XRl9Y zplgUtS*}z;2mJg^!#K`Ey^dH<7)wHGzV>|Cy!v|lZyN*xB^&lmKvMO;4<3;`>Ekwx zwW_woXhTcA7{u%y0fQ;p&O0t(iawe-BAm(>CdJ97Z;ec_vL89&n9-TO*DBR1@QV$7 zv{FL*VU%C~UQ^6D^d+`SLW zvvq|FI`*W1Jv&ic>1YnqKU);X#qd9f#px1sc3%HgG&YFLZE^J_hpOKJXZ5!C0_6SY zS~rdvS0Dp34i!!VoN#;HW}HpSQWAg-a+VhK+v(gt4+H8-qeAEM&>-t8oJV(ob-o0; zXl(H1KECjg%O3lok(S3Mem4V|sawMgve0

    MQ`+7)xLl^ zO-O4GXf;<6cX;cXw-4SQsExhrMb%)&sqUa}Hj>oT==skGEBZ`#0*-M5fzvv{KVQW_ zyFDckKKUKQ)SL$36j(FP@(g-L$IEGol)vHR^t?GjHfw8|qzE;&_6{T3fkOJeF)i^t z&mMnThI*1@I>*`4sJM^E&ND&>n;b~sjJuWGcRQ=D zraR>lu(|X4709p#RUz+Rznwp7T!lQ$1OonFtWQ!JI-m~k6?1tuquNhye6Sl)cD>uP zQIU-7UarIN>9+AlAyo{se5kDF;PYO;ZT9rK?$u1fXJ0j2c~B#Clk>+PyDYCKBfze$1TVfz-tc%A`+*|61t| zepTcP<@CZzeCtN0>3Gge;B9$JMtv7TGYQzts5&p{4ywV$)cG6|sf-4otjiy2Um)1+ n8ePs?IZFDpKpZQVrg68x_+t%U9-p9FJ}v+xMg+q_KV0|^L3Vv! literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_print-members.html b/docs/html/classkiwi_1_1engine_1_1_print-members.html index c5ee71bb..174e362d 100644 --- a/docs/html/classkiwi_1_1engine_1_1_print-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_print-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - -

    + +
    @@ -70,24 +97,37 @@

    This is the complete list of members for kiwi::engine::Print, including all inherited members.

    - - + + + + + + + + - + + + - - - + + + - - - + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Print)kiwi::engine::Printstatic
    declare() (defined in kiwi::engine::Print)kiwi::engine::Printstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    Print(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::Print)kiwi::engine::Print
    receive(size_t, std::vector< Atom > const &args) overridekiwi::engine::Printvirtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    Print(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Print)kiwi::engine::Print
    receive(size_t, std::vector< tool::Atom > const &args) overridekiwi::engine::Printvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Object() noexceptkiwi::engine::Objectvirtual
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_print.html b/docs/html/classkiwi_1_1engine_1_1_print.html index 648c6074..99ced0b4 100644 --- a/docs/html/classkiwi_1_1engine_1_1_print.html +++ b/docs/html/classkiwi_1_1engine_1_1_print.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Print Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::Print Class Reference
    @@ -75,69 +103,111 @@
    -kiwi::engine::Object +kiwi::engine::Object +kiwi::model::Object::Listener
    - - - - - + + + + + - - - - - + + + + + + +

    Public Member Functions

    - Print (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    + Print (model::Object const &model, Patcher &patcher)
     
    void receive (size_t, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     

    Member Function Documentation

    - -

    ◆ receive()

    - +
    @@ -153,7 +223,7 @@

    - + @@ -170,22 +240,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Print.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Print.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_print.png b/docs/html/classkiwi_1_1engine_1_1_print.png index 706a07e2b6d296dfc15717535e62d20255cecb70..64145396f5dd2fb38d193306117337c527be4fcc 100644 GIT binary patch delta 929 zcmdnRa)w>8Gr-TCmrII^fq{Y7)59eQNG}884i07@8TBE7d7`3KJ#)0Di(^OyFX~QD^9Cd zkC|E>X#G_B$F=`X;_*i(m9%6_Mctd_>uGezRP`j+^(iXaX=eqTDr^|8)iBIEZ*5{f zKfGd}bMdyC=I7ofdoMA*Dez^`juAeUdi3 z%TC)_GW}N3N!hPUe@t4MW^5m?vhsZR*|%H1S%2I1GWUMkX5sI@7xJ4VhstE-xfZXO z`CQs&cIMq5w@+Wt@P3@b=M^7RpO@~v;@N@sKQ458?SFprj%dJE_jNaST`E5uZM%Ne zU9b50dY-Qmf5pEz(v+d$rmMn_>`#i1c#iSDcb()@GJC>{@iouv+S(RPo-_*7rmUym(ZTg6!CBtL)Z?r2GMn#39Z>o z^=N!J_y2}xCcc+HCo)x7K~zQ*dKtG(X?*O-zIbEG>>0+DyB2VM5I$}6Hfq`|@88_L zB0D35OuoBxrfRUQm)*T3_j9n1B;$prOVXx!m#@^FekU-#OFuHh%#cC(TxOp173*hD zwoKoZT>d?0+hhi}KWikn+g*7Rb~bia<*Ll-!G&-3T{g3+Sg=-0_JPUvKjE9Nt~n=hfa`J2ysB{Km?Qr#FrF!dB#5ra;#tdH ce*DAU+v#kz%yAF7srqa#grf?ow2(^=VILk&41Gc z1t-pH+x+aWrqHZC0xJ$EDb3e(bZ50rC_ifYPtWwB^1fBGKb=$zSR!`y(5fj9+GfNw z80+0#dYadALHnbP-UXZO__<{2zpq$#G5Ut~jj}r@U*~>hdGptZ#oe0sU}f$1p5SHw zUzZxbPPtc@{P|c+6!W8s)!gCnwvSImWrcoQURG)J}#ACdXN2l z9G{ZX)PHWWr&A<#EgoNr-F0UIbCrhNZU%Ep<${<+*-zMRIkK-Z z&J(v~_??vGTyWk0`aw%|*?v8<*E>ot@)qpOt@ + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Ramp Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Ramp, including all inherited members.

    + + + + + + + + +
    getNextValue() noexceptkiwi::engine::Ramp
    getValue() noexceptkiwi::engine::Ramp
    Ramp(dsp::sample_t start=0) noexceptkiwi::engine::Ramp
    setEndOfRampCallback(std::function< void()> callback)kiwi::engine::Ramp
    setSampleRate(double sample_rate) noexceptkiwi::engine::Ramp
    setValueDirect(dsp::sample_t new_value) noexceptkiwi::engine::Ramp
    setValueTimePairs(std::vector< ValueTimePair > value_time_pairs)kiwi::engine::Ramp
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_ramp.html b/docs/html/classkiwi_1_1engine_1_1_ramp.html new file mode 100644 index 00000000..14ddcf69 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_ramp.html @@ -0,0 +1,284 @@ + + + + + + +Kiwi: kiwi::engine::Ramp Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Ramp Class Reference
    +
    +
    + + + + +

    +Classes

    struct  ValueTimePair
     
    + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Ramp (dsp::sample_t start=0) noexcept
     Constructor.
     
    void setSampleRate (double sample_rate) noexcept
     Set sample rate. More...
     
    void setEndOfRampCallback (std::function< void()> callback)
     Set the function to call when the ramp reached its final destination. More...
     
    void setValueDirect (dsp::sample_t new_value) noexcept
     Set a new value directly. More...
     
    void setValueTimePairs (std::vector< ValueTimePair > value_time_pairs)
     Resets the value-time pairs of the ramp. More...
     
    dsp::sample_t getNextValue () noexcept
     Compute and returns the next value. More...
     
    +dsp::sample_t getValue () noexcept
     Returns the current value.
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + +
    dsp::sample_t kiwi::engine::Ramp::getNextValue ()
    +     		+noexcept
    +
    + +

    Compute and returns the next value.

    +

    The sampling rate must be set before calling this method.

    + +
    +
    + +
    +
    + + + + + + + + +
    void kiwi::engine::Ramp::setEndOfRampCallback (std::function< void()> callback)
    +
    + +

    Set the function to call when the ramp reached its final destination.

    +

    This callback function will be called by the getNextValue() method.

    Parameters
    + + +
    callbackThe callback function to be called.
    +
    +
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::Ramp::setSampleRate (double sample_rate)
    +     		+noexcept
    +
    + +

    Set sample rate.

    +

    The sample rate is used to compute the step value of the ramp.

    Parameters
    + + +
    sample_rateThe current sample rate.
    +
    +
    +

    Note: this will only affect next value-time pairs.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::Ramp::setValueDirect (dsp::sample_t new_value)
    +     		+noexcept
    +
    + +

    Set a new value directly.

    +
    Parameters
    + + +
    new_valueNew value
    +
    +
    + +
    +
    + +
    +
    + + + + + + + + +
    void kiwi::engine::Ramp::setValueTimePairs (std::vector< ValueTimePair > value_time_pairs)
    +
    + +

    Resets the value-time pairs of the ramp.

    +
    Parameters
    + + +
    value_time_pairsA vector of ValueTimePair.
    +
    +
    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LineTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_LineTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_random-members.html b/docs/html/classkiwi_1_1engine_1_1_random-members.html new file mode 100644 index 00000000..7ed724fd --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_random-members.html @@ -0,0 +1,133 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Random Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Random, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Random)kiwi::engine::Randomstatic
    declare() (defined in kiwi::engine::Random)kiwi::engine::Randomstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    Random(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Random)kiwi::engine::Random
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Randomvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_random.html b/docs/html/classkiwi_1_1engine_1_1_random.html new file mode 100644 index 00000000..ee49b10e --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_random.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Random Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Random Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Random:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Random (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Random::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Random.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Random.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_random.png b/docs/html/classkiwi_1_1engine_1_1_random.png new file mode 100644 index 0000000000000000000000000000000000000000..d8b359b7d97282b2ced19125f3b06ab4d3cb7c5b GIT binary patch literal 997 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GUAo-U3d6^w7^zAjpAz{58Eym94!cRLa0 zX$Q+Dxy@t_-g=K=pPo_E{v}f`eO2_lbd}TB^OKT^>dEfdVx#@r+$Kp)al4#5>%Y&{ z%%;7MZY1sqaSomow`l23?QhRsW$j(Mb4u>anr&uJkEzD|oUmIbyjS4t+21C&JLbQt ziE}T`zmaCl+|_zfr|9?1sA(Hlzluv;zim@ySn1<+$LC$W`YOkCyRP*)Ro`V>_?Ksx zxqV@(mkQ3DXZE-D>>R`7v#b2ITelrQ{6#06_pDLnzk1DCe+6XAx6gmMd|ukywr7Sn zl+XUUX_NZv$Fa8a&o=wot4uJN>!pABY~FSzufkuP4d1Bp zmBZKl^m@18Npm=0zKk?pIz^Aa!JNP0bus_hcJVj9(+A6@Enz-y+I^>P+w`Xa zTCbXSdakaNiszej<=M(-+oF$)MxWj?&E9?U#rL0mv0BOP<)W)`egyW$Jg(Fsdjn)=Nvhq6;X?y#!>;0#zY%Tc9 zwfEzs+RwFbmRVMndS7b%zx3xDR^5|R%I)*k&DQh0uLw#C7pAD_r=6V=w9AI!o(;pg z^R_1P{m~WooQt>ZX@2f&qI{Y05B|_Wl6}OV?RVKER$i@PweT#4xE8erapkjjl5QX0 zekJqlOs;|_UpZ{Av;62to%JjxZiyNNJ(%ES8^jvo9%UyrB9Gh}#;n#@G zCvNV%CRxw7bdlYR*>_BDBp;)`p(NgR-!pYd&98-w1CT&n}$Vg8FOp0(`d br$5Z - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -70,19 +97,33 @@

    This is the complete list of members for kiwi::engine::Receive, including all inherited members.

    - - + + + + + + + + - + + + - - - - - - - - + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Receive)kiwi::engine::Receivestatic
    declare() (defined in kiwi::engine::Receive)kiwi::engine::Receivestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t, std::vector< Atom > const &args) overridekiwi::engine::Receivevirtual
    receive(std::vector< Atom > const &args) override (defined in kiwi::engine::Receive)kiwi::engine::Receivevirtual
    Receive(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::Receive)kiwi::engine::Receive
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Castaway() (defined in kiwi::engine::Beacon::Castaway)kiwi::engine::Beacon::Castawayinlinevirtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    Receive(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Receive)kiwi::engine::Receive
    receive(size_t, std::vector< tool::Atom > const &args) overridekiwi::engine::Receivevirtual
    receive(std::vector< tool::Atom > const &args) overridekiwi::engine::Receive
    receive(std::vector< Atom > const &args)=0 (defined in kiwi::tool::Beacon::Castaway)kiwi::tool::Beacon::Castawaypure virtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Castaway() (defined in kiwi::tool::Beacon::Castaway)kiwi::tool::Beacon::Castawayinlinevirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Receive() (defined in kiwi::engine::Receive)kiwi::engine::Receive
    @@ -90,7 +131,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_receive.html b/docs/html/classkiwi_1_1engine_1_1_receive.html index 72ef8b74..abad848f 100644 --- a/docs/html/classkiwi_1_1engine_1_1_receive.html +++ b/docs/html/classkiwi_1_1engine_1_1_receive.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Receive Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    -Classes | Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::Receive Class Reference
    @@ -76,126 +103,129 @@
    -kiwi::engine::Object -kiwi::engine::Beacon::Castaway +kiwi::engine::Object +kiwi::tool::Beacon::Castaway +kiwi::model::Object::Listener
    - - - -

    -Classes

    class  Task
     
    - - - - - - - + + + + + + + + - - - - - + + + + + + + + + +

    Public Member Functions

    - Receive (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    -void receive (std::vector< Atom > const &args) override
     
    + Receive (model::Object const &model, Patcher &patcher)
     
    +void receive (size_t, std::vector< tool::Atom > const &args) override
     inlets receive.
     
    +void receive (std::vector< tool::Atom > const &args) override
     beacon receive.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::tool::Beacon::Castaway
    +virtual void receive (std::vector< Atom > const &args)=0
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    -

    Member Function Documentation

    - -

    ◆ receive()

    - -
    -
    - - - - - -
    - - - - - - - - - - - - - - - - - - -
    void kiwi::engine::Receive::receive (size_t index,
    std::vector< Atom > const & args 
    )
    -     		-overridevirtual
    -
    - -

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    - -

    Implements kiwi::engine::Object.

    - -
    -
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Receive.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Receive.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_receive.png b/docs/html/classkiwi_1_1engine_1_1_receive.png index f58c54d2ae0bf9374848aba5f08244eb21cd1790..4d68526c6309ac36eb9227c5d3641a079ec0b251 100644 GIT binary patch literal 1436 zcmeAS@N?(olHy`uVBq!ia0y~yV2lB>J2;quDi(^OyoS^OL$D>_;RtFa`>dYi<6>{d^`5))F0-e=gOxe*Iiq+v}oR} z)0vq@_f3~Q-o1-wa&?WU{`IeCbVVyoE+2F=+;PV@b7xfl&))EZOHbT;s(gCwsdKa6 zMTeEIe);j~GuOT53ck-W=JOeEzqr`^B!8{ePJU1B`_p&7iGNouDHSP1X_^%O5ke4!pzyWRrh95SH;s@HVYrkRIAyC9vQ?Z+OH-lVD41>9o zZi6sTs&fMO1D6x51xintECh=ffrc>n0j1TQ^eC1t|GRX`C4nA^qDe~_Hx#L6GN8m% zON?jHqo8*w|85I;W?fu6_n!Ub2N&Me+?aM}@`YcE>st%IYIuIj_`1XNi0{rxU#z=s z+-tC(s_n_{_oVLk(pk24YUOsDraxU(b7^Tx<-eG%CUM+8!N#|4tu~qAKmGGc&F#Xo zWDVIXf1C)Nu>08Y6S>mA8{R&A=9xWTx@h~3)1j8r480v|jo#-!mHU;i?)mECq-wES zi6z1wpC6tzzg0WUbJOvMr=@Ohe=;j$m%sI%qwh4op2^+vJ2J|GckSnwMdwT}UNtOH zx^KF6*R{#dor|Vh>@Iric45lyum9VNPBTTRzE6H}TGw{lks$x%;{SWM7{otm-7a2c zrhGm<&$dV9>x<>BWf|c`{0HMt-t{V9pD7o&{NHWqDBt5*_PRHEpA=hu*V!Unr0;iE z?k)R&pS-Et%3mLtHk)_px^vPWrIy8pr*-e!aC^#a?zK73N=3{fX9h1W-1_(J>}Q%m z_jYVqz5n#m7|&g2ufF*md3j!p=P&z53ftqnCzYHkewvs6?cmJadUBq-p54xCpO}5` z&E`zUNqZ#Jb%F8mNewwE9f{8K((G-R2u@2M3gZ}(4gF4l6H~Uu?#C@Mpwz@}HS2Dn z6W>mTyd!OF#H6D~U#s@IF+a!`=3*c#sm0b`Ht}_4FpyfzB8!$<{U`4ZxyklC|Hew& zyRY-DtCz(z#2fN|e!Wpnqug%aES;R*=_h~aMP4}@>iu}@0h6=;uN``|rDXF}2Htt< z<-t+wP8rVM*7PgI&Ua$;?lrR_jx+Gesb9}9oOjA)kEYi1nBefct#|g`ag7LHclYp_ zP3LRBDbL7i5cBut{_J{=Gj#ptnbjwDE<0b>(jEEx3Gdov$zN4;W1ht9e#*F|a>1P} z>(wQtBF_3L)M->V2#=QG(t>xdX^7mcMo?FU`-&J?DP0-mv`Vx*z9FEhqd7%(DrZu`F%N!tl%s;0=d{%K{Xpnz@;eGytbCWq38P*+9S+!Cer-AHv-gwx-*qQnzLkG^%(*qw>Yt?6YNhhc{fyTt zrZi~2eY!5D)-d!+>&0-ED?iuGir{C+w()H6oO?3$=K^!JVjJc&n_ul0V7QRv>)`il z5kvL6S-NR&jO7p7uthv=j1H(berF&0eXHn)Qnnd(p9Qzo{pGi9$rdx(zlrs)1@jw2 z-Ve>`oGbbscy->rX8&^jO)2@?GW^j#p*~E + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::SahTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::SahTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::SahTilde)kiwi::engine::SahTildestatic
    declare() (defined in kiwi::engine::SahTilde)kiwi::engine::SahTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::SahTilde)kiwi::engine::SahTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::SahTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::SahTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    SahTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::SahTilde)kiwi::engine::SahTilde
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_sah_tilde.html b/docs/html/classkiwi_1_1engine_1_1_sah_tilde.html new file mode 100644 index 00000000..4499b456 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_sah_tilde.html @@ -0,0 +1,335 @@ + + + + + + +Kiwi: kiwi::engine::SahTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::SahTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::SahTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + SahTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    +void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::SahTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::SahTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SahTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SahTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_sah_tilde.png b/docs/html/classkiwi_1_1engine_1_1_sah_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..82e8f89c2c64cbfe9d5da06e347d89abe6ce7c62 GIT binary patch literal 1843 zcmb_dX;4#F7=1xgSF{7AC@45Kh=71~p|VL)5FTQrEI}S&X;H~iP(~7i5EQ9Vv|$NC z6i5{pQ0Ws#6Jin)BB)W3O(beU5Q#zs0$2FgQEO7IlLBHN;{(8xfO$%MdPhP9M}#zF*5PpMRj z&g-^EjrG5V-~bK4}C4{3B^74M$UYz1||=t2y|KUrz7NWzjYUn+Lf$Y4%(hDW5A`G;yEd;YobtgvonI1D6!}Npf;^sYkwweB#Es3#Y~kS3 zjqo{&I$tb}S9KD^Sr)Xop|Hw)o<~w$i2S76m7-TlYl7<JnCw8Wv9Mx*{!T2@~T8oHMo)@HsH|8$$spsdO^}-@dNXSpwqBmbP!20 zG%pD>Sa#UJqg^Df4a|D^A#*G@gvBA0V7xn=L8{v&-sseOHENQQ3ZSGQ*X*W1)n_FQ z{QzQ_(SUo$+_6uVTS>88v!{7Dz`J8^q9cSF4sbcdA)v2W!T|N$f4kiDTxT5ECooPR z96g2{UUz;>(sZcFkZABmYS9H(YNlu^VSVEI5t^bHIx|eoWFGYPj*nx-t1EDz!S==@ z@f;@PKrCJgw+{H!YSTiuFlzM4b`XQtI}obcG;U+4TCof5iAPYHogk_<^NMPxO4p5mb2ijy6ZsU2OA~TK ziboVyJFsLq68>74m0qU4h$&GYsdOilTv%IwQ-~2WwhfJ2Zw~i77sbMcbWZ{cLh`8w^Mz+Q`Ku4w4hh-*_vaB3^*R<2onPVoO? z5>pI=tb}c432FTT7H92b_{V`Fr?r_KLg$#~!tQ+BAy-N5PTufj_rdZuqOr1DxN=9zVv?eUB&V|32MMdj zc|zHQYROn2gu;%G$lm+ILGJE{aua@(=d!J(w+dFE4(&$@{&9D-eyl*s@dl{RHKB}A W$2@m$v;mPH4gdqO0arIA9{vsTc#*^a literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_scale-members.html b/docs/html/classkiwi_1_1engine_1_1_scale-members.html new file mode 100644 index 00000000..8aef53fe --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_scale-members.html @@ -0,0 +1,133 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Scale Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Scale, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Scale)kiwi::engine::Scalestatic
    declare() (defined in kiwi::engine::Scale)kiwi::engine::Scalestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Scalevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    Scale(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Scale)kiwi::engine::Scale
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_scale.html b/docs/html/classkiwi_1_1engine_1_1_scale.html new file mode 100644 index 00000000..35eb818e --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_scale.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Scale Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Scale Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Scale:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Scale (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Scale::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Scale.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Scale.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_scale.png b/docs/html/classkiwi_1_1engine_1_1_scale.png new file mode 100644 index 0000000000000000000000000000000000000000..dd19d9e2664eced4fb1fef89d8ddfcdfefada0e0 GIT binary patch literal 986 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GVfo-U3d6^w7^KAf~#OMvZm|EfLzmE*%j z*jbX#`JKCJHF>FcE2H&+8T*$^x%5}j^U_^TU(ZiUCaNd97g^5yzs+@$)tk9$IkW7S zy)&-m`pOhPPjR z(<7n#C(&nV<&7`rO^c7s$qqBzD{`x^z4Oj{t69IF{Cs~Yt8e;>yLSth$t#`RY(493 z()`S8>7OUOd>;SiOU}OAU(_0xybN%gnHR?rUH8qX*576K;m}>P?`+I}u>K!c?GLSK zO9U6b%=mfr>J$}qr{GC@IDkG)y5^&~^fvQ@v)m8<**JgxTGjI0*d+b5dWD^fv61Y7 z{tGN0luQ_bN*VN>gb#G%=Kf1OJ0)nBy^7~9>xG)0aV^VKDnI%a8~xAiR{1LN&F}MZ z7MVxqmhWAr>A8QgMxWZBt1gp8MLKuRezr-(LHzbMNsla`iE1{qDRs|LbC$el(!id)C5dcK06U zOso7HpWk{e>}8Fqe^C6TxOK|{&K}6$^HS~d{$jJ)EUV^ie4aD+rSJD?=T~Q$U%q}> z)zdbnzSXYcWZe(DvdcErrQSh@|1bUdj#c;M6#x1=G3K$8_Bm&GO%ezB=*%q5r6tu2 zdny_4%umnQ7uWxxrtMkIPnPrT8E(s%e+bTEh-*=65MRjoz%_%Z0yp=l{TfT(%O&+Q z7~c6o74Ery=C9eSnj> zvl$nvd?cgX8NcjUwDa`T)j`v;@>ghoRxM7Rx#%sk#p9-D+hV82{-4-eSG{a@+x}%U zFDI?2JRxPggU8m5(In>nm#0a$Kfc;CckMI9R=#At)Qew5R!RQoHNTrx_cX_hGi15z z)x1rs-^JzU{Q4jAdW+snzJi(gf0tNh#oe-Pus=|2y8eya0r>}eUNYQQfToMIvzfD& c-To|p>w~lVGmD@YU`Ax{boFyt=akR{0BR%Oy#N3J literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_select-members.html b/docs/html/classkiwi_1_1engine_1_1_select-members.html new file mode 100644 index 00000000..1c73fa49 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_select-members.html @@ -0,0 +1,134 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Select Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Select, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Select)kiwi::engine::Selectstatic
    declare() (defined in kiwi::engine::Select)kiwi::engine::Selectstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Selectvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    Select(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Select)kiwi::engine::Select
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Select()=default (defined in kiwi::engine::Select)kiwi::engine::Select
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_select.html b/docs/html/classkiwi_1_1engine_1_1_select.html new file mode 100644 index 00000000..c46440be --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_select.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Select Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Select Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Select:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Select (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Select::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Select.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Select.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_select.png b/docs/html/classkiwi_1_1engine_1_1_select.png new file mode 100644 index 0000000000000000000000000000000000000000..cc5f97d57cf2e4c75ef97874216894eab933454b GIT binary patch literal 986 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GVfo-U3d6^w7^KHRieOMvZm|EfLzmE*%% z*jat^)V4-htA9CofI+t4i@xU4l6sFxCFM@RllE}7!@Mr$+&bs{ed5{eS8rxbQ@(v()pyyK)ra%S z+Tt!Mo{ zYj-*4{aNQ_^Z#$ST>bggg>p_6-*%%@C7%^Ee%?I&MOW}Gr}@jgqT_ar^}ob^eF)U? zRCc<2@ze6%nx1|w%Ty`_XH9x?bj{2lukGvyW{V&ATiN#P^;eGb=^5vy`G2VCNK3J5 zkYC98z%_%ZLU0yCT#H(RIBxEr!?Vys@R3)s(f{0Tm9G-t{65d;v^X-?|M$FQDz)yR zGQK~yJ_|a<^>bBTK;B6{?{L02X`dA{b7e!Br=4Q+zSNg})^}ap)lDJM&e1dFGfnv) zZ}*z?D<*5&Jx}MhmraimL95qRE{=Pdg{IQejoHM*8i7(Xjj5`DJUNys>O2#|$(=+zP^?#^o zdzSN)<$QaF+cM@KgaZf~d`IoqSo&Trsh`2{&JP-}Fm!!keDYkN%y|3n&9_TYSG2dAgdO9eVH#fB| zC2vjemb*)tBns9>_O0G{TleP1RiW0w=BFNC@HZ)r;xWCwCR1v*_WbJ2>*m|P&HHAy zwY=}yak+Ii!7EZ9nA?@C{yDk2c)CMwl*wDQ-M8L-?e_d%yKFiS^NWYS#eUtCKI>mR z{{};z#k*%$m8Bm1e^mW~!CujX5tvaJ^wZ8}&RTZ+v%K3a=it=he^Y=Nk-^i|&t;uc GLK6TQ9^pLz literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_send-members.html b/docs/html/classkiwi_1_1engine_1_1_send-members.html new file mode 100644 index 00000000..b077ca40 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_send-members.html @@ -0,0 +1,134 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Send Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Send, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Send)kiwi::engine::Sendstatic
    declare() (defined in kiwi::engine::Send)kiwi::engine::Sendstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Sendvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    Send(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Send)kiwi::engine::Send
    Send()=default (defined in kiwi::engine::Send)kiwi::engine::Send
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_send.html b/docs/html/classkiwi_1_1engine_1_1_send.html new file mode 100644 index 00000000..72d8332e --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_send.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Send Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Send Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Send:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Send (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Send::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Send.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Send.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_send.png b/docs/html/classkiwi_1_1engine_1_1_send.png new file mode 100644 index 0000000000000000000000000000000000000000..57e38c16dcee1bdb81035a7faa3384fe787c3925 GIT binary patch literal 979 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GUko-U3d6^w7^UYxX9OMvZm|EfLzmF2@j z*jSUaCR;`Q&v~JGh(WgC%d{y$yX;jwcUdpg^o(m+rc${v+wa-_+=)xrmR@f0{X9R@ z%6Egg40D^esfp@KA>FgF8_mPRUn`$onsfR|es=h~m~GnOmMJ^4axUK4>%Y18NA|h< zukYTm-gfg$LsFti_nm*ax~Ff1mga8?kG^TLdRyTO!%e%Q=B|BKmU4XOl9N-)N^hM# z)^YFH{9_@rmOKBCF-|`dvAHXA>4mcD87GRaUeKBR{QT0pZ}KmGEcrdNuFE9b+@ycD z?WHyE&jv5+ufOr(UQPLnc9u!Yf?uZYsualidGpklNgdx>R+pIXOrC$hzLvZ8hsLxe zatmK({Jea3ii)~Z@T5H)zMh|wuK8##z0LgKEcb(dHqM{FR<%4gHc3CNUSa2AY$SW2 z{{qVgB@;%VQU-k|;RD^cx&IQ+qKDu|zha~Rx!o#TUwrfXJfG9zXz%j9%QQXjZ`A&# z_9v=X^ETJd+xr}Ms#@#BT2|y5EKJ*0dPQzSh*`uWzCG7n9_s+WA`QC1K;Y{Skt9K?XTOE1K`p)d%dwyQNweX@|Z+Y>A zUz5Cc&T=x9-T!alY@h#U_f~o=$m*T6xpbNQuI)8(p|fZ1yB9m@%Av2iUk*BdJN$g( z>}M}7>Uy&O(?46zpW(Tz=2ua%ZHebEURZK4%w9I-(p$z4&sYoU=PmqMWqateB>)NzUYZ;GV%$AvlX6u0^dud?DupSKQqH8=jf?UjCcNw8I*zu+Y`m{l<=uGveM) z+Q{I(P9x?j%a5+qS - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -71,33 +98,46 @@ - - - - + + + + + + + + + + - + + + - + - + - + + + + + - - - + + + - - + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::SigTilde)kiwi::engine::SigTildestatic
    declare() (defined in kiwi::engine::SigTilde)kiwi::engine::SigTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::SigTilde)kiwi::engine::SigTilde
    post(std::string const &text) constkiwi::engine::Objectprotected
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::SigTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args) override finalkiwi::engine::SigTildevirtual
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::SigTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    SigTilde(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::SigTilde)kiwi::engine::SigTilde
    warning(std::string const &text) constkiwi::engine::Objectprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    SigTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::SigTilde)kiwi::engine::SigTilde
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_sig_tilde.html b/docs/html/classkiwi_1_1engine_1_1_sig_tilde.html index daa04110..f8659bc8 100644 --- a/docs/html/classkiwi_1_1engine_1_1_sig_tilde.html +++ b/docs/html/classkiwi_1_1engine_1_1_sig_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::SigTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::SigTilde Class Reference
    @@ -75,108 +103,150 @@
    -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener
    - - - - - - + + + + + - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + + +

    Public Member Functions

    - SigTilde (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +
    + SigTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     

    Member Function Documentation

    - -

    ◆ prepare()

    - +
    @@ -211,9 +281,7 @@

    -

    ◆ receive()

    - +

    @@ -229,7 +297,7 @@

    - + @@ -246,22 +314,22 @@

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    -

    Implements kiwi::engine::Object.

    +

    Implements kiwi::engine::Object.

    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SigTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SigTilde.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_sig_tilde.png b/docs/html/classkiwi_1_1engine_1_1_sig_tilde.png index 336541e749f73763c4d143c81e0e894d0b729df4..f3a453cb8fbac91c814ad90cb39cdc521772a1d4 100644 GIT binary patch literal 1838 zcmcIleN>WH7=P8sa@mI!nJ(H2Yl3FSO`Dk73`?9*3its%S0I&!%W62yVb4&9QQ_P+Hj$mSd$z(Fa7q2Fm=WgYg(WferNMISN zmFD4`!=ZQrU|#gG$l8hS05H1=hy96o#6ru{a!b}Pffa1d8#mq2oXPopT;Ua;QM8cQr8*+%*v?3hcEhyJn*qOC|N~ zNxKq_sPmRt)AC9QHFREXd=_-&^<~I6JETLWRd^isy*_ln!5zP&A6j%mK7-=E(&8sX>4 z(zLIjIHnxjetF^zPCY_CWdqeh8IkD7n8wOg9p>|0-A|ebVrI%$U4xUZAo{#awX&Ew z^F~W&B*tl@P@60CxAE!k=78J&;x^t689mA*F|Lmkcwf{HXIG2`#M^tf(>gif4^X&$ z?Yg%C9?PIe1g$=}62CiMcjZ@t%)QLG%Gpk9#su{A+nm1U^Po^!0Prh(S=i8EK9s_!Tv-%+B;rbD1tY*@S4h_F^qr%<&Wc>S% zlW=wo;stxQ@wD#muKzUO8lQIo{yX_CC!JjFLc>z z1;s_F^_1|Zzv9&Wu_JNSeKUtbI=5}hK{9lXVCx}INS+r(ifb^L=wN8~sv!Z5IvQyVnT#9303@ho4<8}waG+nV8tK?pH_y*4(AoTJzxw1lKz>PnY0_G<(_Q@MS6(N8s(m$Z963gu z)RUM%lQx-12jiab%Sqg0IFWr-Q&Dbw=QN$XvTa%d@uE{6QD!@x6MQ?Z=#GE0MYY5y zE3~}8LHfZs)t}AcfC0mA85l%GZ+B7E%7D@SI=E--uHd?0`v(s&WA($)6{17hC(4ta zM>ZJhG~UAb0s9F35ywZ>e7fsmHZ`7yNSsbc($rUCCZiH+nUJ2n^KPs{*T9<<3syVd zK+$%er|gGSCqFYl>!2oZXhMpPb~=iB9n*CqNx1r~l?T;LK;q*2;=jWglIBYdaFFpN zzjSaBNC5MZi?_yb2zEK8ChX_W{}|^xcf<`&eNbBIv?{Cj^?tDQk7;&ONukOcZ(?`BYJ3s_EtRqx?MfC?eC?^hCj;Y4t+O z_h;JHU#pjPxXBDZNCLA-jO=G;&7T{93&3Lq{!!_F16%Nq&j0`b literal 1377 zcmah}drVVT9KH>ppu-0PQ6?a!f*>z3$QU&~D1l3*)k23@C}QhtDvtol#aRtF0hzVC zMVuh$q<}mw43sL;0)uF2i>MIkq@^X&A|R#i0`d&qt=S(loAD&)cfMcF@0XnOecw4b z`^dqT%j}i`0ALA*5UBuwBVah&+yskZ)8&KMvUcCzh#-T(fWhIhsnlz2Tnv4jt*xzQ zIZ8(?HBX_E!vUc6m_|J2 zC)!^V=;eI@bS?Fan>9u!kea1I@fCr4it#ru5kMac2xeKKcnRM%p<{7q6Z|0f{+UMx zmSyD`ghSEp$Vt4QG`w8zMTE&Hu^2BBZ>;ehC`9omZd?{pYIGs0!JG0O?1PKvnUb~A zk{?bHY*=CUUzRaQnc}L()mKe%ZgJ0A$JzIPrx$(Ol5_qlUT+_($V0*nVb8>#P z?lkeySWyo;N*I?ZKEyjJM(Y(z;259V!U@jC>Tw|xqKp&3N`E*q`stH2ZE;upXni{Q zK=RW*nE;W^SQrX7Kp7X|bw51o?aq zCrbAmtC0qC{MD0w8nD~({ZlKOEfnPy@!*px%xQ;*jExm zf2CZ0B}uXb?Cf2M00KAsEveYY1clUmY;qYiqN zRQGt8O)wS=1;I`ELfUKe1msZLaOcM(qoupe&OJK{y)q5TB}odWNp*bfdYwm|`{r*P z1?+=UVd&E>%@xcp02-8Qkgubsy69`RE#?R48#!U!?9{ikk?AWICHy$#{HbK9DUz8_ zZXWJZ@N*Bx&F=2JuPaNBn(eEW3I?5uKFl!$MV?%egval(cA>$lJHEY<(k;9y%-9qO zopT#6q9j+>?hwF}^8ZNXt0~Q+UIP}a{4N3msTkd2-I@=8yAkxq{ArSC4guSLTk#oL zKFj$R1^uT}^HyWo?ww+>OFwDH`qTu`G}VE;$n~{+T7b5*G@V>Bol!A%NO@9bl9ns> zF031>jrG7(Q5;=(Fjid0irAJ=(y-xVfk=G0>P5A?9<@QgKO!sFLc-n*^m>Kka(M?O7lSvisTU!M6SHl}C!#dBZs0@x!t}WDF1@E{fNLNqUyvUDCo#im+XSgonH+K_s zLbo`A8UpAw#onQIy?w`iZ&tJ47?tp`u+~O-x>l8Y9cjm24^ZykZ+Mc^%wW9hz**ml zpCJX*CTW0Bvfl#2T>jqnQ&&rTjW?e(Z#_1<)cr=RUYWSCANvmhFo;a7*>fo4Z!F!H A_W%F@ diff --git a/docs/html/classkiwi_1_1engine_1_1_slider-members.html b/docs/html/classkiwi_1_1engine_1_1_slider-members.html new file mode 100644 index 00000000..0c3ae0b5 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_slider-members.html @@ -0,0 +1,135 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    +

    std::vector< Atom > const & std::vector< tool::Atom > const &  args 
    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Slider Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Slider, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Slider)kiwi::engine::Sliderstatic
    declare() (defined in kiwi::engine::Slider)kiwi::engine::Sliderstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    parameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::engine::Slidervirtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Slidervirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    Slider(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Slider)kiwi::engine::Slider
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Slider() (defined in kiwi::engine::Slider)kiwi::engine::Slider
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_slider.html b/docs/html/classkiwi_1_1engine_1_1_slider.html new file mode 100644 index 00000000..40ebf888 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_slider.html @@ -0,0 +1,303 @@ + + + + + + +Kiwi: kiwi::engine::Slider Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Slider Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Slider:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Slider (model::Object const &model, Patcher &patcher)
     
    void parameterChanged (std::string const &name, tool::Parameter const &param) override final
     Called once the data model's parameters has changed. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Slider::parameterChanged (std::string const & param_name,
    tool::Parameter const & param 
    )
    +     		+finaloverridevirtual
    +
    + +

    Called once the data model's parameters has changed.

    +

    Automatically called on the engine's thread.

    + +

    Reimplemented from kiwi::engine::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Slider::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Slider.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Slider.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_slider.png b/docs/html/classkiwi_1_1engine_1_1_slider.png new file mode 100644 index 0000000000000000000000000000000000000000..000693ee7afcae2f90a56e10b8d9135f88dbdd42 GIT binary patch literal 987 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GU!o-U3d6^w7^z7=|;CE&vEJN5nl6W4iL z);nBz9Wnb#-=#?h7>+mk{S!*=xh@_!X`SBjDJt5Q%Tyv)CbT`l^gtjo#%q%KuE3 zzqXsbG%^&eoyNy_FSm>`PGE8 zCp$tP@h4lIIlQdCZ>CIf-_4_EbhgO%t8KdHYw-HX%im#U*EOZe%in%+PTBm8rP$}2 zWLmu$zn}g8Opn9BT!=z-Uh?9nlYmlY?C7zK;-m|Y`Qb{Q&^iCS8p7dI8;Qaaa zHjhg_r|*6EW5U?J<8$Wy!&8>L4-p6#uIt@7wYIe+RA@?+(BW%Sn~I%q7Y1`8kICkF!-hi}xP6Q=T1Dxa~~N&tx<8!u$EZIMa%b3Kg55 z724cqZZSLc-j}(lFLb=0-?Z7dZ%Nd>tpV#rjoD$F>Jslu3--7Ee8s4{Qgi;kJ3i*Ilj@Xd6H)?BJN9uf zginWt;}(VpMmR)uAZnK)hSZ{OrbjS4H z|7FuQ9ThU({j8$l7zg*6U3I^{-JGMkwfxILr{f&LX9}yY&91YUayXtVp!*{*6}`&6 zxYhjKtKFY{%dcC@K5#jfzc7C9B_6~3w`?2!E1u5j+s9@w>EklyKTgopa7oy>ML=); ae+DU6XJ1 + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::SnapshotTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::SnapshotTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::SnapshotTilde)kiwi::engine::SnapshotTildestatic
    declare() (defined in kiwi::engine::SnapshotTilde)kiwi::engine::SnapshotTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    perform(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::SnapshotTilde)kiwi::engine::SnapshotTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::SnapshotTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::SnapshotTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    SnapshotTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::SnapshotTilde)kiwi::engine::SnapshotTilde
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_snapshot_tilde.html b/docs/html/classkiwi_1_1engine_1_1_snapshot_tilde.html new file mode 100644 index 00000000..72b766f2 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_snapshot_tilde.html @@ -0,0 +1,335 @@ + + + + + + +Kiwi: kiwi::engine::SnapshotTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::SnapshotTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::SnapshotTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + SnapshotTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    +void perform (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::SnapshotTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::SnapshotTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SnapshotTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SnapshotTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_snapshot_tilde.png b/docs/html/classkiwi_1_1engine_1_1_snapshot_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..12f640fc404c4b49e151497a012a623ef3e64cf8 GIT binary patch literal 1861 zcmcIlX;4!~9DjgRih?ItK|wKKg#wDAHG-f(H5?Ji0fr-3s3Zgl6cPkNU_h;SG#V!( z0x5<|AUvY-LNp-6gQ8f0ph+MB!-xnHA}9jNVft`7opJoo>2$g?yZhVO{qW!Y9h)17 z-e+QLVGIC(32MK05CG`mVJtB+fJf5K`cQcKCeR=2qtoeNI5aXrW8FOuqfcETkr?Lo zSi?)Bg(!p5@DjH9u$B#=dU>f+|kKiS$sUlZ^3pkLK$-Vl7C_pBrH^e=;S z5!x(@ipz01vxws8a`o!qM2H5X#bPrp1qUgZI%^~=uF-uh@sQ@dal68aCKED4N8}vy zP|I{_xisyAS04@ZI;m7B?^l;qzqwgq^GLL$gAlz~ca^T0G%sw@h7y8p_}4u=HM0Y% zC(7SIVa_HK?rvwgX&$RXiTJKEG|W~Itgd=I$w+EReg+*Ijwm#V@_7Z4Q)nPNx_l%G zHEkxf05kbAk}JXX;ejunA&{b;no}8!X?pc+n^|Ma{5%0edIEcT8jb~)`na6#~hg{@#~}%KCwqNMFojvyn}oMc!MXq)izGB zR*<5Pky)>DLaoQFVSuSN+zC79vdO z_p0>?v329OWGx?m4hkr-+t1$q{+#?UvVfrRzg8uLbSVV>22$el8d63L54pgf@W}I? zPHEbsIx$l()c(Mhr@mR*m8XT&XbRWy%I*aS^2ORsl(MF>cCA-rV%D6jTf9Tn+$|PN z^u=*X1JIM8_(~w{vyGns9c+z4D3o&F8T-Bu?oHY$}mGnMw;+^KtBti)-g8EWmQ_XDID z=bvs?M)ov$i0VX|PtJao*5kV;ozGlZiMdDUs-SI=yp`N+lqa%W&v2i$3Y$fSN5|sd z9hRk#*0TR7uh_Csc1J*VG+;dIMmi?Fr>1DGS0E=NsREp^pAps?+dXzG!{{j?nAK;` z%V_RK`h`4ZYZT%aliOJeOTlr@(57Zq%cB#>1*25nGJ)9~XudU0Qk3D!aJbW+Z4W7r^8;dVQFGgJVy5_9{jeNg%7vZo z0g8USu`+a`#O<-;F!EbP!=V!4f-W^8E7SY(bR4-BC$uvEF@Ni=Sr=J)U|JY`#}o0; zJ1?OrnS{~U_~8io<>%fQfV8XD2}W*K!%z=`4fcv3c=C5K__0wUX3#ugsbh^!y|h3g zF}bd7Ilkaz{#*M3p= + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Switch Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Switch, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Switch)kiwi::engine::Switchstatic
    declare() (defined in kiwi::engine::Switch)kiwi::engine::Switchstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Switchvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    Switch(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Switch)kiwi::engine::Switch
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_switch.html b/docs/html/classkiwi_1_1engine_1_1_switch.html new file mode 100644 index 00000000..7a59ae8f --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_switch.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Switch Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Switch Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Switch:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Switch (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Switch::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Switch.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_switch.png b/docs/html/classkiwi_1_1engine_1_1_switch.png new file mode 100644 index 0000000000000000000000000000000000000000..0d35a63d2430618c8446e80c003ce3570aa1929d GIT binary patch literal 990 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GVC6mKB%yl|@Fg@~l31WB-#mpZ_X)U%Jcb>-kB^MD=91ukpvG@7x7F^_oZGv6ETh{_J(#nuNF(^!YR9f+4|UH}9iRWM z=w4c}bj0GB(yLl8t|_{G^U||w@vCc3$F0r1n)B=2@^8koS0BBZwJ!SF@kx_1A0O76 z-E7?_w14;Vi+6H=J)gBS>740o%f&)b^8Ch|<9JQ7KYXgxo_$>NRr&WFm&%RL-eNv$ zcQbv~+s!*yfBCFm_A4hYw<_Er=+@T7Ugr8uTkYJZ#&KVKR}lPeS=k%uAItYU$?xk@ zec5rLWXqpSGu4xw7pAD_I|WbLGsC3#+|O?e6`z@Q*q^^pvsdonPoA?UKXK0Ezu4o& z{z2Jm!Vx&w0-uIq98WhSwzVg_@pmF_~(g?|<{S)N%Nt z$={iryDOh3-oHF$$@?23{Y-UhEw`7p7Hv~q@kOM)a)nQv)tM0C+@0C84dmaXc)r?k z4HRV8o;knG;D6>Fb@uMxuL_>YdZyR!z6zJoHIAyAfA-*>_vU|HHisNt_$tA{SrFiGF$aL)7{1R~s%( zU+z80ZO1>Z+7FZdeyDx3tn%BdX-oR{FRlFAG%e-Ua{Ih>v-LdpD}vGjD74hh&MDq! z%W!WG!@KjwCh_atE9{($H`O#fcQ#pkiSZ9{p#%)WNAlNvG?)H%X4+xBkn@3S22(}h z(nzX z|8_-&V=>ubJKyGHe_mL&h5fUtclzp`{EP($mOhi(w{i2zo3gk1%z~QMMOHT$-p`n} z$>PeJ)on)>SY}@PdV2ZUXBsP)C5Jnib**1^_kh~Hd%!T-t^WDZPlk-j=dCH+D|EY; z?O)w(wI}Aws%@9{UuCJ7egE%*otbgzED!!antpcQI>tK%cS{=X3(R7OYf)2Lr5 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_switch_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_switch_tilde-members.html new file mode 100644 index 00000000..826118bd --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_switch_tilde-members.html @@ -0,0 +1,144 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::SwitchTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::SwitchTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::SwitchTilde)kiwi::engine::SwitchTildestatic
    declare() (defined in kiwi::engine::SwitchTilde)kiwi::engine::SwitchTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    performSig(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::SwitchTilde)kiwi::engine::SwitchTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::SwitchTilde)kiwi::engine::SwitchTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(PrepareInfo const &infos) override finalkiwi::engine::SwitchTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::SwitchTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    SwitchTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::SwitchTilde)kiwi::engine::SwitchTilde
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_switch_tilde.html b/docs/html/classkiwi_1_1engine_1_1_switch_tilde.html new file mode 100644 index 00000000..5f4ae628 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_switch_tilde.html @@ -0,0 +1,338 @@ + + + + + + +Kiwi: kiwi::engine::SwitchTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::SwitchTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::SwitchTilde:
    +
    +
    + + +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + SwitchTilde (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void prepare (PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    +void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +void performSig (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    + AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     
    +virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::engine::SwitchTilde::prepare (PrepareInfo const & infos)
    +     		+finaloverridevirtual
    +
    + +

    Prepares everything for the perform method.

    +

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    + + +
    infosThe DSP informations.
    +
    +
    +
    See also
    perform() and release()
    + +

    Implements kiwi::dsp::Processor.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::SwitchTilde::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_SwitchTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_switch_tilde.png b/docs/html/classkiwi_1_1engine_1_1_switch_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..cbb7277209e5fb541ee08b1c48614c5fb6836c2e GIT binary patch literal 1851 zcmb`Idr%Wc9LEn3p;Q4Mhy)QIQ4}AHR74bUC?JMMG(aLA1gr=R#6U475HJCmmWPj` zsSrm9ML>{-3kr9HmywnV5)2A95r~4L0}&2H#TXt!dOFq7na*@N?au7p_jd1(-TQoh z-_6=j^qy~mGXVf#K4GtC008JwFx_NqfQ>Ylh7jzrbiZGamrkd{WGQfdKZ=yQYu@IRe038Nt&%C{b@zICSjQj>U6SPwo43=N)Xr@SNs4 ztAM3zNf8^{K-^^h&DY%io4Wx)k)R~O4qVelgnjrzS`L0^r#*qaS%iq(P#mGRa4Y3e z{d71P!5tC@v$y9D8^AtY>ucZ+A8kvoVxkkYjqGwfVV#%W(i*>PvxlJdQOklx=ex~* z``(I{OC@Ej*o%8a%h!o&uPIkCXSe0HhIu1QGS@kWKo3lK$m*%Cv$hF8h`u&)&~9dt zd!!Xav}IAUQL@IbSo6yLu^P;n$ErYvs&lGJzawcjCfF7tx0lZD6Dns`*Pc*m;n>#| zgR=nCE*RTOw+^8jF>yO=98C4^c+(gQbN_&R+E4|R)!pKp;G>o=Dt=BrdJ!k1$(aWp z*b|~;F1aP)3!u&^5ZWWcPR%PK^G7^I_?|2Zp=uGtKcY?pr=?^4%TwdjbIpN#&kd=0 zs!d^fcixExMWW%0g%IGdB0z5hn-J0ruPuTAc9BIB5!Ua{q5wNPO%B}ol@hJ?P%h>5RQ&5sx4VqCxj84Wdp#CV* zKtM`|wQk-e&whms?38 zBw0m4{MP{=e*Z_Oh>@}B+0kr{(HqfzVT7f8(0ETBUfZf{u?qJ)VoT~^o|IxI?f-z$#R@gU#WxbZ~p3m-{WGVx{LomyvjwV#1gn1dK&cz^ji!j#U{3Jrm4vcma1 zZ@8l_jPK`ajpn7L;%64Ti?vU&G2J06IsUR`+td - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -70,25 +97,42 @@

    This is the complete list of members for kiwi::engine::Times, including all inherited members.

    - - - - - - - - + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    bang() (defined in kiwi::engine::Times)kiwi::engine::Times
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) constkiwi::engine::Objectprotected
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::Timesvirtual
    bang() (defined in kiwi::engine::Operator)kiwi::engine::Operator
    compute(double lhs, double rhs) const override final (defined in kiwi::engine::Times)kiwi::engine::Timesvirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Times)kiwi::engine::Timesstatic
    declare() (defined in kiwi::engine::Times)kiwi::engine::Timesstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_lhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    m_rhs (defined in kiwi::engine::Operator)kiwi::engine::Operatorprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    Operator(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Operator)kiwi::engine::Operator
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Operatorvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    Times(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::Times)kiwi::engine::Times
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~Object() noexceptkiwi::engine::Objectvirtual
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    Times(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Times)kiwi::engine::Times
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_times.html b/docs/html/classkiwi_1_1engine_1_1_times.html index 60e34416..75fc2e8e 100644 --- a/docs/html/classkiwi_1_1engine_1_1_times.html +++ b/docs/html/classkiwi_1_1engine_1_1_times.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::Times Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::Times Class Reference
    @@ -75,120 +103,137 @@
    -kiwi::engine::Object +kiwi::engine::Operator +kiwi::engine::Object +kiwi::model::Object::Listener
    - - - - - - + + + + + + + + + + - + - - - - - + + + + + + +

    Public Member Functions

    - Times (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +
    + Times (model::Object const &model, Patcher &patcher)
     
    +double compute (double lhs, double rhs) const override final
     
    - Public Member Functions inherited from kiwi::engine::Operator
    + Operator (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void bang ()
     
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Attributes inherited from kiwi::engine::Operator
    +double m_lhs
     
    +double m_rhs
     
    -

    Member Function Documentation

    - -

    ◆ receive()

    - -
    -
    - - - - - -
    - - - - - - - - - - - - - - - - - - -
    void kiwi::engine::Times::receive (size_t index,
    std::vector< Atom > const & args 
    )
    -     		-overridevirtual
    -
    - -

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    - -

    Implements kiwi::engine::Object.

    - -
    -
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiEngine/KiwiEngine_Objects.h
      • -
    • Modules/KiwiEngine/KiwiEngine_Objects.cpp
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Times.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Times.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_times.png b/docs/html/classkiwi_1_1engine_1_1_times.png index 7cd19b346f33f318e62e904ff539988c572f086e..01b73bfedcf2ed13bc4d1cd253425a4d2bed94b2 100644 GIT binary patch literal 1286 zcmeAS@N?(olHy`uVBq!ia0vp^%YgU*2Q!e|`TGSEkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~nd<4{7*fIbcJAw<)doCl)6W}M{&%+% zDW15|*CX)RfsnQ40`cNEmFhh;m;QF1v}CvNtVvH?GrT5=uYQ(bm)omidPB;0d*UDC z(5o!jNB13m7{u%AY31r&9Qx+$)vLceinUG~{mjcd)f>FylWO_QeWp$(X6rBODA%p} zTq}8YYvRnaJU4WDo~doWcQ#eZdiA={Z?}WQ&MtblWaD%GZM1XoY@7e{yVC4ke&2nYUUl{In!6Y7 zu>bbhY%@D_nY{gthc|1szue6-scqF4qq}=Jrv1rD{WYzlti8L$d}s3g1Mz=Fe|-qm z@w9cieDTxji&Iq8oq{Lr;qdkRlyt>MbLnm72WPn-{IhZX{I#m(xv`1+Y4r*_7h@yY z1N|3RJ}8+m0+ll8I|(1?#?Ae=AW{ZwC*9g}HKr_ke^U0$YoAI@r2nqV|J9gwu4~=1NhYypbN3v+ z8T0(?|Fs;lt}iWSv9Hw6)J_jxvE=df`z4cK-nX2+n?>u|jiPO5zQlf>bbfP|@#W{2 zRXufM>Rat9PS*XfE4yq{RqB1I@Bh-D?^tzDPVuk56Js7bX`eGFEiBaZjO&@DxwNF3 zVNWIFo%!h*`{MdP)U-Xz_{nmEh*2ei@CDL>^)z7UiPzPnM!Q(tmo7HEBuPJ?2A*j-7Km(HtUUn>CiUggQ^Y?{2-}>pOh1102GevC^POMwbT6l_*3f^Zxc1o>ky2}ie&JcsBHt$G zy}q(KZ@Sg2Qu7Aob(wyV7q6c=TYGlr-O|g;XTOb^xx}I??Q>38^xKUukFtqLNB;g> zbh*}~n?*}(rg81hZS~8R?(|uBw_v_6yT#eERLtq$_|pfP)!GK6Q26JyFrBp7E@wi(^Oymn-XI0(__4Wp@(ABMxng>k{BO8tN zzFvAfOGZO_Yc6lzv**hgj@KKny8goVjqZ)GJ11Yuer0*{*NDa4n)hI3-S@uWW&huX z8m>->D@^`;EM_U&k&l7e;qiMPpNcxV=FRy_SFaX)$!jQ&m3{Z+;q2GP+UurN$=g(0 zc65aNvM%_zPe5>H){LrsVy-UJUT7b@7PZ@vq5mt>jfJrfu4fBZivKu!*ZCgXzj~)| zd4mH|vIYl)aNtzQ&+xnN-tij$zZX}}%RRs#|LT&H>J3|a#`Sv+ z`Sa>Ma@wabUxw+dbCQ2J;6y;K>! zv!TB7vZe=8YyT{)XIkec_F$h}Xv{u+hIg-PbeVK6hBx&ZrZxX#oH|o-tuvp6D=?B7 NJYD@<);T3K0RXuP@~Qv; diff --git a/docs/html/classkiwi_1_1engine_1_1_times_tilde-members.html b/docs/html/classkiwi_1_1engine_1_1_times_tilde-members.html index 3887463d..e8f287ae 100644 --- a/docs/html/classkiwi_1_1engine_1_1_times_tilde-members.html +++ b/docs/html/classkiwi_1_1engine_1_1_times_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -71,26 +98,42 @@ - - - - - - + + + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    AudioObject(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::AudioObject
    error(std::string const &text) constkiwi::engine::Objectprotected
    getBeacon(std::string const &name) constkiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) constkiwi::engine::Objectprotected
    compute(dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) override final (defined in kiwi::engine::TimesTilde)kiwi::engine::TimesTildevirtual
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::TimesTilde)kiwi::engine::TimesTildestatic
    declare() (defined in kiwi::engine::TimesTilde)kiwi::engine::TimesTildestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getNumberOfInputs() const noexceptkiwi::dsp::Processorinline
    getNumberOfOutputs() const noexceptkiwi::dsp::Processorinline
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    m_rhs (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTildeprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::TimesTilde)kiwi::engine::TimesTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::TimesTilde)kiwi::engine::TimesTilde
    post(std::string const &text) constkiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::TimesTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< Atom > const &args) overridekiwi::engine::TimesTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    send(const size_t index, std::vector< Atom > const &args)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    TimesTilde(model::Object const &model, Patcher &patcher, std::vector< Atom > const &args) (defined in kiwi::engine::TimesTilde)kiwi::engine::TimesTilde
    warning(std::string const &text) constkiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    OperatorTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performValue(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    performVec(dsp::Buffer const &input, dsp::Buffer &output) noexcept (defined in kiwi::engine::OperatorTilde)kiwi::engine::OperatorTilde
    post(std::string const &text) const kiwi::engine::Objectprotected
    prepare(dsp::Processor::PrepareInfo const &infos) override finalkiwi::engine::OperatorTildevirtual
    Processor(const size_t ninputs, const size_t noutputs) noexceptkiwi::dsp::Processorinline
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::OperatorTildevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setPerformCallBack(TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))kiwi::dsp::Processorinlineprotected
    shouldPerform() const noexceptkiwi::dsp::Processorinline
    TimesTilde(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::TimesTilde)kiwi::engine::TimesTilde
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~AudioObject()=defaultkiwi::engine::AudioObjectvirtual
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Processor()=defaultkiwi::dsp::Processorvirtual
    @@ -98,7 +141,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_times_tilde.html b/docs/html/classkiwi_1_1engine_1_1_times_tilde.html index 8c123f05..b79506c4 100644 --- a/docs/html/classkiwi_1_1engine_1_1_times_tilde.html +++ b/docs/html/classkiwi_1_1engine_1_1_times_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::engine::TimesTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    Public Member Functions | +Static Public Member Functions | List of all members
    kiwi::engine::TimesTilde Class Reference
    @@ -75,196 +103,173 @@
    -kiwi::engine::AudioObject -kiwi::engine::Object -kiwi::dsp::Processor +kiwi::engine::OperatorTilde +kiwi::engine::AudioObject +kiwi::engine::Object +kiwi::dsp::Processor +kiwi::model::Object::Listener
    - - - - - - + + + + + + + + + + + + + - - + - - - - + - - - - - - - + + + + + + - + - - - - - - - - - - + + + + + + + + + +

    Public Member Functions

    - TimesTilde (model::Object const &model, Patcher &patcher, std::vector< Atom > const &args)
     
    void receive (size_t index, std::vector< Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +
    + TimesTilde (model::Object const &model, Patcher &patcher)
     
    +void compute (dsp::sample_t &result, dsp::sample_t const &lhs, dsp::sample_t const &rhs) override final
     
    - Public Member Functions inherited from kiwi::engine::OperatorTilde
    + OperatorTilde (model::Object const &model, Patcher &patcher)
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    void performValue (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    +
     
    void performVec (dsp::Buffer const &input, dsp::Buffer &output) noexcept
     
    void prepare (dsp::Processor::PrepareInfo const &infos) override final
     Prepares everything for the perform method. More...
     
     
    - Public Member Functions inherited from kiwi::engine::AudioObject
    +
     AudioObject (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~AudioObject ()=default
     Destructor.
     
    - Public Member Functions inherited from kiwi::engine::Object
    +
     Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +
    virtual ~Object () noexcept
     Destructor.
     
    +
    virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +
    void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +
    void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    - Public Member Functions inherited from kiwi::dsp::Processor
     Processor (const size_t ninputs, const size_t noutputs) noexcept
     The constructor. More...
     The constructor. More...
     
    +
    virtual ~Processor ()=default
     The destructor.
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    size_t getNumberOfInputs () const noexcept
     Gets the current number of inputs. More...
     
    size_t getNumberOfOutputs () const noexcept
     Gets the current number of outputs. More...
     
    bool shouldPerform () const noexcept
     Returns true if the processor shall be performed by the chain. More...
     
    + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + +

    Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    -void log (std::string const &text) const
     post a log message in the Console.
     
    -void post (std::string const &text) const
     post a message in the Console.
     
    -void warning (std::string const &text) const
     post a warning message in the Console.
     
    -void error (std::string const &text) const
     post an error message in the Console.
     
    -Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    - Protected Member Functions inherited from kiwi::dsp::Processor
    template<class TProc >
    void setPerformCallBack (TProc *processor, void(TProc::*call_back)(Buffer const &input, Buffer &output))
     Constructs a callback that will bind a processor and its perform method. More...
     Constructs a callback that will bind a processor and its perform method. More...
     
    - Protected Attributes inherited from kiwi::engine::OperatorTilde
    +std::atomic< dsp::sample_t > m_rhs {0.f}
     
    -

    Member Function Documentation

    - -

    ◆ prepare()

    - -
    -
    - - - - - -
    - - - - - - - - -
    void kiwi::engine::TimesTilde::prepare (dsp::Processor::PrepareInfo const & infos)
    -     		-finaloverridevirtual
    -
    - -

    Prepares everything for the perform method.

    -

    You should use this method to check the vector size, the sample rate, the connected inputs and outputs and to allocate memory if needed. Preparing should also set the callback to be called by the chain. Not setting the callback will result in the processor not being called by the chain.

    Parameters
    - - -
    infosThe DSP informations.
    -
    -
    -
    See also
    perform() and release()
    - -

    Implements kiwi::dsp::Processor.

    - -
    -
    - -

    ◆ receive()

    - -
    -
    - - - - - -
    - - - - - - - - - - - - - - - - - - -
    void kiwi::engine::TimesTilde::receive (size_t index,
    std::vector< Atom > const & args 
    )
    -     		-overridevirtual
    -
    - -

    Receives a set of arguments via an inlet.

    -

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    - -

    Implements kiwi::engine::Object.

    - -
    -
    The documentation for this class was generated from the following files:
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1engine_1_1_times_tilde.png b/docs/html/classkiwi_1_1engine_1_1_times_tilde.png index 74c6c852a64e6f42d898f0a81aef5554a2d304de..f0144f06b543ddb165f3d9bbd83b413ca46b7e4a 100644 GIT binary patch literal 2275 zcmcJRc~BE+8i$(*;^4?qa*2RiBM1%yQG|dXI6Ht6BBvx^!le?)L4X|$hX>*us4z^H zI6*ODlm#JRhcP5zI0EP*!y$)+<_Hj!l`CX`RUjm2wwYsV-9Kh(Yj?YA ze$V^$wV;5bTlBW;0RXTC?du%^09rV>R&Lq=Uo#Cn+3;;!(6LY-jYb2P({oF7#^XQ3 z)lX+rQir-Vp+NOevD2j!ZPP>nsr+ZmOwLBmZL*@QB+-SsOvvY{@)D^gA+dR?Ph2AG z3Ws~k(4j%vx`o|*yA z&ClVj+dBCS>zP1rsz4l8(My4sfb*|Q;9X%gbnqS|o>wz;$E6}IZNR2iZ+tQ(Ck!~S zUL-h2Y1Mn%HJM)x1>Ae}Vr=kQbKZ8Dg(RKt4M8BK$hav$fEc`n`|k!X%2qhtGm}!x z^U~uKR&k&WJn#2tMUfTR-F$B*J|0SeIW?D$X4L2k#W!i^zu^=p7!K&hiJLgI%Dn11 zsGp0s=C)H|7EHm3vnXMH!CfvrT_Ypg zf7bKyOO(J93ewiP4iWDzHVQYaq`Y{S0M_LdqZ&U%m{%39NKb-+n{B_$w4#0PM08dW z)Fb+c3SgNx2u}eUKRTfLsM_!O9$f)$@7>u3Ph+2qvWik|H)2n1v*bq~J=b!2Ts6_a zb`qxs_XtPYyVG-gL)c+>>zRFOFEpMP?ez9*9NO(M^5~6X*~vbYD#jPjgY&+@C_S3F zysD^$gJRXNr3!~WXZNcq>oK{8L-UgdhF30X7LD*~@%-T(fQw6};h&hRN9;1$Qbj~m zpreeWla$PP#jU>+EAG`>*vRAqzaJN=BE{VpkagTZ?i{!LkHaYfjNmXnV^NTNoeF%Sp~`0dHft?l-Tgh0Ec>!PU@elW0>(ZYrVi zfl41d%^Wgves!0>I4^M65P_`j>aftrM^*UHq2-pb1Z@9AgaffZUJ0WufzE7l*g72c zSE%$Wti9+Egh{A;ohDk$KZB7UYzf>y5f!|$j~<%tA%d|TYq)1Mqj_Canb?cB$$%r@ z>o#=`?YLN8nW%?gzF}O2DH(#y*ncWyNKwEmlm>_k%|8W_wt_%HLQR^^KG@!bA8`}L zO&9^9{<81?ROk1*L=T*pRp54Z6w~v)?)y{gc?j{8pJ1%GEoW${n(M{1*;&r=;mQ%r zPUDJ!z)Bd?)1GeRr9AHVE&LUEod52Q*{5$)k!FSd?$o{OGGm1kn8V#2M-Pq(2(4ok zp4}il@8IEQ1Jkh%>zG0)Af>dDe&hP;-&5@gQJ>2DhO>$GD4Yq#r(zVp`GT7zPSR`C-_TqqN= zAn!)&DmQ{ltKSu)V7pqmU8Pn+SS?lT`i}IgXX^x~zWUj+%*3gU2Ec7t47SuhN~?3d zsOwMDS%6t4?h5&T^y6Ouo{b#1=n0g*G&=C@`wbpLvdn4EeoGWmOD)7p3Bei?-=qC& z0b(sL%+h};`Y-fH8RbXvj~rH0ZOyVLpH&+@K&?u!Cp09XBrwv0p0pp#>0Bj?v!o$G zvh1BD5>&X1i&Uq{SGANj0+U6-NKx-gB8^Nd84B!;jFe4}Qw91b&Jg6`4d7C6qdr2R z?_jnL2OHK#T!$ln-QA~$$klf!;8Rc+-gWO<$bGo9_arvtsn?<4*s9vv5*qrAeAmJ> zg#vsxU@bscOmZG5>jViFCjex0H9>mRq^V;?M=P`D-!?TH$uK=~Wf7?VQUi3hlx1_x TN5t?S34rzq@aBCM^Tj^^V$)nc literal 1372 zcmah}Yfw{17`-7NU>k5~wJJk-T|fa5v_1w>9g$Qn5Q99_^3sYHAzsr$h+F~`1))GI znD9^(P{A+=Av`o88Xf~}As|$tfF>B7=2f6Uy@;s^m|mP=I{2gR%$_|v-?uy8ob&DG z1@GTSSh;>B000EY-!B9Ja72v%Xokm-tgV$}%i7?eFp|Mw!02Cp&m|Xj7h&w(?CR<= z$(yjnwr2E@{hd>{glhf)LXk2?e5&Hg_+LCp{+uRyewY9?30qNb!w-NP|CrLIuQPwN{6kp@l z)>u)i97QI|1V7yCgzI}w+xj#5($M=p`Ay!l7nEP_oCWJt{xRRL{cNFx>g`iEFy-{k zrgiltFf;dMC~D!*&;rNCbr!)+bvN87tV)g`6^!p4A=~z|YvNMucS5OWwMrXzDkS*? z1>r-bkxrAB)K}i-5Fs6YmotU+HV2c?*`C4*T2fy)5V-N?R+e}Xjb3=22GlB%eGU;Q zlxkkR9#DP`U70RMYv&J9CnO?Gq7A4Zj)$ zHw9F&w3tho-X`OpLrd$*R;<2Vz6rgB%U@H*5;T+@3z*)OKyG&5U~S9KI6Oy2IgTCm zv0?y`k1Jq&)ZG0@m#qsWZqJ)9L=R^qE5j$X`R3I%vD{8L2^p;R3UoO_S80YxUd?Ha zs>h5&?L%qQgD0f%>>+A<39QB|La>VC^DA5-+Jot7H)V-9oF$XjD!5V#OI9l#A3q%l z>8MKV#0elBC3m#MKu{b(`5cVhjV$ ze2Ia2!hK!A*!kAgVV&K>;W4`flBu#rhD}t6jB_eIg7=cYx>yjD?h!|423Khh=5X{DQE5IuRt ui?2JFQlokMP-z>@C( diff --git a/docs/html/classkiwi_1_1engine_1_1_toggle-members.html b/docs/html/classkiwi_1_1engine_1_1_toggle-members.html new file mode 100644 index 00000000..696b0b58 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_toggle-members.html @@ -0,0 +1,135 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Toggle Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Toggle, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Toggle)kiwi::engine::Togglestatic
    declare() (defined in kiwi::engine::Toggle)kiwi::engine::Togglestatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    parameterChanged(std::string const &name, tool::Parameter const &param) override finalkiwi::engine::Togglevirtual
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) override finalkiwi::engine::Togglevirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    Toggle(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Toggle)kiwi::engine::Toggle
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Toggle() (defined in kiwi::engine::Toggle)kiwi::engine::Toggle
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_toggle.html b/docs/html/classkiwi_1_1engine_1_1_toggle.html new file mode 100644 index 00000000..a713008e --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_toggle.html @@ -0,0 +1,303 @@ + + + + + + +Kiwi: kiwi::engine::Toggle Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Toggle Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Toggle:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Toggle (model::Object const &model, Patcher &patcher)
     
    void parameterChanged (std::string const &name, tool::Parameter const &param) override final
     Called once the data model's parameters has changed. More...
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override final
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Toggle::parameterChanged (std::string const & param_name,
    tool::Parameter const & param 
    )
    +     		+finaloverridevirtual
    +
    + +

    Called once the data model's parameters has changed.

    +

    Automatically called on the engine's thread.

    + +

    Reimplemented from kiwi::engine::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Toggle::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+finaloverridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Toggle.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Toggle.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_toggle.png b/docs/html/classkiwi_1_1engine_1_1_toggle.png new file mode 100644 index 0000000000000000000000000000000000000000..b24a635d4ff5ecb81ea9b5b48c72c117c9e8fb0f GIT binary patch literal 991 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GV9o-U3d6^w7^zMZs1i-+xY`>LJ)z3tX< zFg3}W&a{fkFMD~lvB9=+M?I%v%X8-mOO`*LH7TVv+iQ|&WU?$ZAM<3pn!R^DQf2e_{j*W#vH0>m z>o?D2zm#>fclTn> zyuK4|A`}eYb;q3KE zo>C8IwN0}>yG%v$AN4u2;|*<>bi<<4pEf)VV)G6Ud)B7C_R4Pywq3vKu2;PObd|3L zfAvcqt5$!m%~@9Y<<+z$ZU4PLzhTu~nNj|K=ghoaDu3CoPf^j137)iOhN&~h!;cIR zpBXFc-e34r6Zh~Z-`Sg=c<1R~{NlyF;jk&=ngU-2?HJ($T-RAP9Ky-%s*fn1we00j z14bKJs6va2J2zbuROMxmzfbQ8vXDSIYNe0J$ylTviWne%rxmmCd`=83cZ zHhaUjwd)VsEbU~?u(%3LRMW#@og{^_g<0qpgj5V+Vg3_4pV45Iq&^#y>ItK7U#@+ciZmUF_F{0>^}sdX~Qtv g@3M*Qy#EY~{x~PUS@@I}m>U^9UHx3vIVCg!0NU>4zW@LL literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1engine_1_1_trigger-members.html b/docs/html/classkiwi_1_1engine_1_1_trigger-members.html new file mode 100644 index 00000000..1b13c669 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_trigger-members.html @@ -0,0 +1,134 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Trigger Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Trigger, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Trigger)kiwi::engine::Triggerstatic
    declare() (defined in kiwi::engine::Trigger)kiwi::engine::Triggerstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t, std::vector< tool::Atom > const &args) overridekiwi::engine::Triggervirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    Trigger(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Trigger)kiwi::engine::Trigger
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Trigger()=default (defined in kiwi::engine::Trigger)kiwi::engine::Trigger
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_trigger.html b/docs/html/classkiwi_1_1engine_1_1_trigger.html new file mode 100644 index 00000000..b4accacd --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_trigger.html @@ -0,0 +1,261 @@ + + + + + + +Kiwi: kiwi::engine::Trigger Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Trigger Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Trigger:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Trigger (model::Object const &model, Patcher &patcher)
     
    void receive (size_t, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Trigger::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Trigger.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Trigger.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_trigger.png b/docs/html/classkiwi_1_1engine_1_1_trigger.png new file mode 100644 index 0000000000000000000000000000000000000000..ff40f100eca595c8747947c3f012cd239456cb9a GIT binary patch literal 1004 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GWGo-U3d6^w7^zMiy1OMvZie@ESace`~O z;;dILU)?AbZTuu7nek@p(Lbs!0`vGCC(Y~2_L?NRPSZ0?jx}+L4%X6c7c=+pS&n|6CeRTJihF#1hQGLUdpI1CC{;}}g-23CQ z?EBX_%h+${9Bs%6%t+f=vVB|Xn^m)Ro$`;qZL)e_;S0M>zqVLSpLKiM+vk&(E!wKz zo@3_rMW|jPI8)B-@4mD(Gd8A)Ue;Rp_N#`{=jCl_^KAabol3KJ{eAas_%Fpx5xW=e z^#A6uxz3z_s@=b&!{wiIE|;^a__kkL{pFFujaQpPU+xq*ExYd2-W78{vHW{kzi_tu zMwPDxzRsuTrv*>yDe(2&bjVcoWLKndi+~(|gQPzcMN%@D?n@-=hR^WY5Q<8s4gxt{wTNiWarbW9iZFm~Q=6$KJ z_^i(KcR|s5I~VU0iQja^rsur4XIAm5oo}zz9ld6>_G$mkoFldSUoxMK5RE;%He=VU z$~^~n&wSRqe=Se%CX;i|7JN~CTDG+%%c}0LufEn_^Y_ozHLNl%I(u#EzUn`ss(y6Pi}XDxgA(}2-N78{BB->W(Fe`a2( zv%t$HH+0>tRZ6FFLTByuVt + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::engine::Unpack Member List
    +
    +
    + +

    This is the complete list of members for kiwi::engine::Unpack, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    create(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Unpack)kiwi::engine::Unpackstatic
    declare() (defined in kiwi::engine::Unpack)kiwi::engine::Unpackstatic
    defer(std::function< void()> call_back)kiwi::engine::Objectprotected
    deferMain(std::function< void()> call_back)kiwi::engine::Objectprotected
    error(std::string const &text) const kiwi::engine::Objectprotected
    getBeacon(std::string const &name) const kiwi::engine::Objectprotected
    getMainScheduler() const kiwi::engine::Objectprotected
    getScheduler() const kiwi::engine::Objectprotected
    loadbang()kiwi::engine::Objectinlinevirtual
    log(std::string const &text) const kiwi::engine::Objectprotected
    modelAttributeChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    modelParameterChanged(std::string const &name, tool::Parameter const &parameter) override finalkiwi::engine::Objectvirtual
    Object(model::Object const &model, Patcher &patcher) noexceptkiwi::engine::Object
    output_list() (defined in kiwi::engine::Unpack)kiwi::engine::Unpack
    post(std::string const &text) const kiwi::engine::Objectprotected
    receive(size_t index, std::vector< tool::Atom > const &args) overridekiwi::engine::Unpackvirtual
    removeOutputLink(size_t outlet_index, Object &receiver, size_t inlet_index) (defined in kiwi::engine::Object)kiwi::engine::Object
    schedule(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    scheduleMain(std::function< void()> call_back, tool::Scheduler<>::duration_t delay)kiwi::engine::Objectprotected
    send(const size_t index, std::vector< tool::Atom > const &args)kiwi::engine::Objectprotected
    setAttribute(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &parameter)kiwi::engine::Objectprotected
    Unpack(model::Object const &model, Patcher &patcher) (defined in kiwi::engine::Unpack)kiwi::engine::Unpack
    warning(std::string const &text) const kiwi::engine::Objectprotected
    ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
    ~Object() noexceptkiwi::engine::Objectvirtual
    ~Unpack()=default (defined in kiwi::engine::Unpack)kiwi::engine::Unpack
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_unpack.html b/docs/html/classkiwi_1_1engine_1_1_unpack.html new file mode 100644 index 00000000..ff3a0cc2 --- /dev/null +++ b/docs/html/classkiwi_1_1engine_1_1_unpack.html @@ -0,0 +1,264 @@ + + + + + + +Kiwi: kiwi::engine::Unpack Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::engine::Unpack Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::engine::Unpack:
    +
    +
    + + +kiwi::engine::Object +kiwi::model::Object::Listener + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Unpack (model::Object const &model, Patcher &patcher)
     
    void receive (size_t index, std::vector< tool::Atom > const &args) override
     Receives a set of arguments via an inlet. More...
     
    +void output_list ()
     
    - Public Member Functions inherited from kiwi::engine::Object
    + Object (model::Object const &model, Patcher &patcher) noexcept
     Constructor.
     
    +virtual ~Object () noexcept
     Destructor.
     
    +virtual void loadbang ()
     Called when the Patcher is loaded.
     
    +void addOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void removeOutputLink (size_t outlet_index, Object &receiver, size_t inlet_index)
     
    +void modelParameterChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when a parameter has changed.
     
    +void modelAttributeChanged (std::string const &name, tool::Parameter const &parameter) override final
     Called when an attribute has changed.
     
    + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (model::Object const &model, Patcher &patcher)
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::engine::Object
    +void log (std::string const &text) const
     post a log message in the Console.
     
    +void post (std::string const &text) const
     post a message in the Console.
     
    +void warning (std::string const &text) const
     post a warning message in the Console.
     
    +void error (std::string const &text) const
     post an error message in the Console.
     
    +tool::Scheduler & getScheduler () const
     Returns the engine's scheduler.
     
    +tool::Scheduler & getMainScheduler () const
     Returns the main scheduler.
     
    void defer (std::function< void()> call_back)
     Defers a task on the engine thread. More...
     
    void deferMain (std::function< void()> call_back)
     Defers a task on the main thread. More...
     
    void schedule (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the engine thread. More...
     
    void scheduleMain (std::function< void()> call_back, tool::Scheduler<>::duration_t delay)
     Schedules a task on the main thread. More...
     
    +tool::Beacon & getBeacon (std::string const &name) const
     Gets or creates a Beacon with a given name.
     
    void send (const size_t index, std::vector< tool::Atom > const &args)
     Sends a vector of Atom via an outlet. More...
     
    void setAttribute (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's attributes. More...
     
    void setParameter (std::string const &name, tool::Parameter const &parameter)
     Changes one of the data model's parameter. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::engine::Unpack::receive (size_t index,
    std::vector< tool::Atom > const & args 
    )
    +     		+overridevirtual
    +
    + +

    Receives a set of arguments via an inlet.

    +

    This method must be overriden by object's subclasses.

    Todo:
    see if the method must be noexcept.
    + +

    Implements kiwi::engine::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Unpack.h
      • +
    • Modules/KiwiEngine/KiwiEngine_Objects/KiwiEngine_Unpack.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1engine_1_1_unpack.png b/docs/html/classkiwi_1_1engine_1_1_unpack.png new file mode 100644 index 0000000000000000000000000000000000000000..27817e62718860a5692e1f2dc7436185c2aaf942 GIT binary patch literal 997 zcmeAS@N?(olHy`uVBq!ia0vp^%Ye9pgBeIheMkUN5&=FTuK)l42Qpv0`C8h4XabN0 z#s>}@VC}pk59D%`1o;Is02P72)l(rx3=GUAo-U3d6^w7^zMZsKLBO?t`l>zumGj-E z=rd0CO?S_>J}kQ-^TCY^Kc)*f?bydLsif3$nM&kIL)DXBoW+{|ri*#L(kK_pJN-F) z2A{Bs^J|0HRn3~7`YYRK3b+^ZZoGFW=JY9pBW-ifs6N}5`ZnfL(3HB;jJzJI(&()jqAnkvmL^8JU5?Mn?lKl%86X-1#(m3QwfF7wYjdQ0|<*$v|} zzjEY^YX2o&-dwrur7x4`>4iN;dv|br`|~EX%I`=~`|1+?qUC!U_x}>D`m8l=$wZmU z6F#lJI7LMn?nnPKKyUA1So4)($G&%sKP&DueU_Wyf6BVx9?NB8*#mxkoC&JOSvE{c zW{Nmz$hhXo42G~G9|mnpwT7uO!Uw#Nq+i+}<56sR-L2pmK0VoM(o~t?Noz{lc8dJ> z?pFC~@+NlP{zDHRn9u)a>f`y#hqKV+;qe*SH^V#DiY&%xyRF*ZFt*E%W_TV zOC8VNbB4w-SxYyC-3$mn>OE~n`^TM=mhAI0{C+np{EhDA=zkJt`|dxVZFjII((uTg z$!Q%kk4w)vYm)!xwQGjh(n=HcmHL{~!-H2`Ysla8(sfz=^BgnIkhK$wx1Ia4toraNsyUw6mHJa*DP<>OOSv_YZu zvQyHDW4d_5Ryl_2*KG~t`=bl)F@N@~WIs1Mp=ufP4FaKqEdBTRjMJNRu8VUYxcU?t zp1y|3;V%v9mpi`CvgTL~*T%EIG^&?f|X9rY|Gc8zcnbzmL^O4-bb5Xqud(&=DPuFSUzwm0k;dT8R62@iz zhM#%nCryjq^uD6>N&3Y%bIv-J)*0@b;PNhtt52~B;{NGwn{keN? z!yZ%3qmO@PBr^n@ey9EAlTH2R1-#EZbs84^kxMI`&3xud_Y8*nQ=qBiOYwER)0<*q a>lqenIwy8COu7WjlMJ4&elF{r5}E+7p4C49 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_adc_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_adc_tilde-members.html index c3f15755..9a0ac084 100644 --- a/docs/html/classkiwi_1_1model_1_1_adc_tilde-members.html +++ b/docs/html/classkiwi_1_1model_1_1_adc_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,67 @@

    This is the complete list of members for kiwi::model::AdcTilde, including all inherited members.

    - - - + + + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + + + + + - + + + - + + +
    AdcTilde(flip::Default &d)kiwi::model::AdcTildeinline
    AdcTilde(std::string const &name, std::vector< Atom > const &args)kiwi::model::AdcTilde
    boundsChanged() const noexceptkiwi::model::Object
    AdcTilde(flip::Default &d) (defined in kiwi::model::AdcTilde)kiwi::model::AdcTildeinline
    AdcTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::AdcTilde)kiwi::model::AdcTilde
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::AdcTilde)kiwi::model::AdcTildestatic
    declare() (defined in kiwi::model::AdcTilde)kiwi::model::AdcTildestatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::AdcTildevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::AdcTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    outletsChanged() const noexceptkiwi::model::Object
    parseArgsAsChannelRoutes(std::vector< tool::Atom > const &args) const (defined in kiwi::model::AdcTilde)kiwi::model::AdcTilde
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setPosition(double x, double y)kiwi::model::Object
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_adc_tilde.html b/docs/html/classkiwi_1_1model_1_1_adc_tilde.html index dfc2b08f..78de1fcb 100644 --- a/docs/html/classkiwi_1_1model_1_1_adc_tilde.html +++ b/docs/html/classkiwi_1_1model_1_1_adc_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::AdcTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -70,6 +97,8 @@
    kiwi::model::AdcTilde Class Reference
    + +

    #include <KiwiModel_AdcTilde.h>

    Inheritance diagram for kiwi::model::AdcTilde:
    @@ -82,151 +111,237 @@ - - + - - - - - - + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - AdcTilde (flip::Default &d)
     flip Default Constructor
    + AdcTilde (flip::Default &d)
     
    - AdcTilde (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + AdcTilde (std::vector< tool::Atom > const &args)
     
    +std::vector< size_t > parseArgsAsChannelRoutes (std::vector< tool::Atom > const &args) const
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    -
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +

      Detailed Description

      +
      Todo:
      Check better way to get routes.
      +
      The documentation for this class was generated from the following files:
        +
      • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_AdcTilde.h
        • +
      • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_AdcTilde.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_bang-members.html b/docs/html/classkiwi_1_1model_1_1_bang-members.html new file mode 100644 index 00000000..d31454b0 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_bang-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Bang Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Bang, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    Bang(flip::Default &d) (defined in kiwi::model::Bang)kiwi::model::Bang
    Bang(std::vector< tool::Atom > const &args) (defined in kiwi::model::Bang)kiwi::model::Bang
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Bang)kiwi::model::Bangstatic
    declare() (defined in kiwi::model::Bang)kiwi::model::Bangstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Bangvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    Signal enum name (defined in kiwi::model::Bang)kiwi::model::Bang
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    TriggerBang enum value (defined in kiwi::model::Bang)kiwi::model::Bang
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_bang.html b/docs/html/classkiwi_1_1model_1_1_bang.html new file mode 100644 index 00000000..136f9bdd --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_bang.html @@ -0,0 +1,347 @@ + + + + + + +Kiwi: kiwi::model::Bang Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Bang Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Bang:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + +

    +Public Types

    enum  Signal : SignalKey { TriggerBang + }
     
    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Bang (flip::Default &d)
     
    + Bang (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Bang.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Bang.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_bang.png b/docs/html/classkiwi_1_1model_1_1_bang.png new file mode 100644 index 0000000000000000000000000000000000000000..3f0b279a78ec9dc555c7ad4f8a099376dd24a61e GIT binary patch literal 712 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;iEL?K+f19U9R9h|8~6`%J~&*!^uqwoEjVT38=O8PBy_jYoK>srY+g-yQ-5#K zs;I=*XWCA_*3Y)m5s)tP3%%-nWzNa#QL7)tT(VN1k`(?T#!P6FLCVV1!`oVe{AYd4 z<9m8%=gc6@WvRU{e0?i(eOGVJ(B6D#=e#p@yrCz9iWe5mpDMX^^WWNZj+w>jhR-VI zXQup!xt0FfuK#(hn6s*Gdgc7~9ebYQ~nSM1uw=-%5E_3O?rymtPJeX-g6 zoX4@tR=qkbZn->j)-R@le#r&K{1(r5?*GF0-1}ziua?i*kIF0<=ScW5$hQd}Xn)A^ zA<=@d2Eny(by;G};SdgzJU(~fjQY;Y`ddnu1#x&c2y6K@06iE!?WXngFL_)k-L2vLzPcp2(mUTkjqbgSvo8fhW#(sVP`=;Zqm=lQ-@N_-7I_h7}m zx3164G-~wTZZ4aD^|D3p!b#JLw@)li|7}+;$Wr97c1P@Vzq=ooJX-P0j&aY6w>G=| r8N^SqKdP9{_~V1CpWwuOf0%x##I*g}`#J=e>=-;<{an^LB{Ts5>oit? literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_clip-members.html b/docs/html/classkiwi_1_1model_1_1_clip-members.html new file mode 100644 index 00000000..f7e87a17 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_clip-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Clip Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Clip, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    Clip(flip::Default &d) (defined in kiwi::model::Clip)kiwi::model::Clipinline
    Clip(std::vector< tool::Atom > const &args) (defined in kiwi::model::Clip)kiwi::model::Clip
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Clip)kiwi::model::Clipstatic
    declare() (defined in kiwi::model::Clip)kiwi::model::Clipstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Clipvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_clip.html b/docs/html/classkiwi_1_1model_1_1_clip.html new file mode 100644 index 00000000..a50eff03 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_clip.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Clip Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Clip Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Clip:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Clip (flip::Default &d)
     
    + Clip (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Clip.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_clip.png b/docs/html/classkiwi_1_1model_1_1_clip.png new file mode 100644 index 0000000000000000000000000000000000000000..3ea61675be8ad0df19ef10f90e07ad4d6a354f6d GIT binary patch literal 705 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;ahzxOMw z8@jr#6{=h8_C2k8!aZ-|m4B`-ON={aMus2COnY`Xzr1c~%&OB%XRbYU)#HA_xqXX8 z?cc|gsjrvy|F!A!`c+%bo;kPksn5M2v#B$0TEBa{`C-Za?VF94hsHlIJ8|ZX?)FdH zZdYF0e?INrvpD0;=6{YBzxa2k{#50EOWFV0X=!#f6M|iq=reqmV6^(&P%QJ?TfSi5 zl)Fp)E$r3u4|6_nv0$v>P;cOW$nrsP4uf5b@PYOMrXK=+4Z&@R5>|&7thzO|VAZN$ zA65jfI={<3bn8K*2;a%qSHHT&sv#@AeAO$}sB<^VMOHubNsXEuovOjVtoMnQzi0T> zEvgr6jMo2nb?)u0oim<=X==KCJQw@*YKYqNRr#@N=Ukq9^H{*tRWfW*?>BE;RGPp4 z{Ta>TcQI#g&VO!WykGzA=NC5LzyH>0zb0dO{rS$*w^u*kc~T+t=G4V|)?V6GF}pJQ z-1)DTC0~sHo}bh1zwL*9aOl^E&2tVL@YFKyIL>ilCi|SnH{yRad|vuSulCSS!%AsC z2K7Un51g_2c8-$LB}tYA+Q1-qXm0U2^ltgDxzi42MR}dQayjmH8B@%nr#@?)6K~J- z`nl+9Mb@*1O!@U%{xi$APCUPG+o!$7hG*9XUHbHB?(SEszka(Gd~VLwxtYgT=+0iX z*PlP#Z|43&J;BevFWLE@|J<~B-VWcswZ*mbe(%{^F>f{x6VylVDrawJu=i4~fx3_1 e($(eHC-%swn2ZVh7L$PKjlt8^&t;ucLK6Vn{bGUu literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_clip_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_clip_tilde-members.html new file mode 100644 index 00000000..81537fd2 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_clip_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::ClipTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::ClipTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    ClipTilde(flip::Default &d) (defined in kiwi::model::ClipTilde)kiwi::model::ClipTildeinline
    ClipTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::ClipTilde)kiwi::model::ClipTilde
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::ClipTilde)kiwi::model::ClipTildestatic
    declare() (defined in kiwi::model::ClipTilde)kiwi::model::ClipTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::ClipTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_clip_tilde.html b/docs/html/classkiwi_1_1model_1_1_clip_tilde.html new file mode 100644 index 00000000..9a36a3dc --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_clip_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::ClipTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::ClipTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::ClipTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + ClipTilde (flip::Default &d)
     
    + ClipTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ClipTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_clip_tilde.png b/docs/html/classkiwi_1_1model_1_1_clip_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..e4de5b45e2c41a262fb57b7e1808e24be3dc228d GIT binary patch literal 721 zcmV;?0xtcDP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0007DNkl20#W}WBH}1SRn<+w55B7Ebv=?c z*Y#FayYimDxA~2IHt*l^x2R>=iFGM;M;=vetEyhn4SrrjExSrp^_uR)Kj8o9{x^O} zNk9I+OI7uvZsfnq`P=7znE%D9s(MMc-+y-^HHU8OSzSgJB4 z-(|9yT* zx99wB%=7bav&!#M{AcHXJd>;W*XxYmpZ_8MKRN$h_N63;a+d$*@u+JU=6^loAAA2j zf2I8Q{1Y zh~@V)d;V_NARa^9Rpa=F{I2UBzogqI{F + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Comment Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Comment, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const override finalkiwi::model::Commentvirtual
    boundsChanged() const noexceptkiwi::model::Object
    Comment(flip::Default &d) (defined in kiwi::model::Comment)kiwi::model::Comment
    Comment(std::vector< tool::Atom > const &args) (defined in kiwi::model::Comment)kiwi::model::Comment
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Comment)kiwi::model::Commentstatic
    declare() (defined in kiwi::model::Comment)kiwi::model::Commentstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Commentvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const override finalkiwi::model::Commentvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &parameter) override finalkiwi::model::Commentvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_comment.html b/docs/html/classkiwi_1_1model_1_1_comment.html new file mode 100644 index 00000000..fc45b3bb --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_comment.html @@ -0,0 +1,448 @@ + + + + + + +Kiwi: kiwi::model::Comment Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Comment Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Comment:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Comment (flip::Default &d)
     
    + Comment (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    void writeAttribute (std::string const &name, tool::Parameter const &parameter) override final
     Writes the parameter into data model. More...
     
    void readAttribute (std::string const &name, tool::Parameter &parameter) const override final
     Reads the model to initialize a parameter. More...
     
    bool attributeChanged (std::string const &name) const override final
     Checks the data model to see if a parameter has changed. More...
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    bool kiwi::model::Comment::attributeChanged (std::string const & name) const
    +     		+finaloverridevirtual
    +
    + +

    Checks the data model to see if a parameter has changed.

    +

    Only called for saved parameters. Default returns false.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::model::Comment::readAttribute (std::string const & name,
    tool::Parameter & parameter 
    ) const
    +     		+finaloverridevirtual
    +
    + +

    Reads the model to initialize a parameter.

    +

    Saved parameters may infos from the data model.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::model::Comment::writeAttribute (std::string const & name,
    tool::Parameter const & paramter 
    )
    +     		+finaloverridevirtual
    +
    + +

    Writes the parameter into data model.

    +

    If the parameter is saved this function will be called at every attempt to modify the parameter. Never called for non saved parameters.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Comment.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Comment.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_comment.png b/docs/html/classkiwi_1_1model_1_1_comment.png new file mode 100644 index 0000000000000000000000000000000000000000..35311556c255d4b0392623d2bd9da4cc95f5aa54 GIT binary patch literal 699 zcmeAS@N?(olHy`uVBq!ia0vp^jX>PN!3-q77gnqSQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;d^`7x()1(eB|hl8xWupqhL(zOdVEkj7`1=n+1SwBH%A-R3s2cS-|}B} z)2}C+Qj(ibMn=xAS-Z+=i8{+frQ7QQLuIclmMP(|`yA`h@j*bd02DwZ&hVY%jXEvKRSs!G2(DT6m zz+ML?p$QEvDhvrdEGi0&oE{EM`N}hvWfqAp6L2a3y6l3oz~}pYEdoyNrI&OjKRwSQ z%d~~Lwn@NABB+1CoxeKQbRD8Rd zj+u*iZr)3ib~L_bCe9Mg_g&CgAXz*ym(NP>d;Y`HrjUy3EN5r!w$iA3X+EWSvz5iZ znIFA!O5HA8JD8}yC!Bq^6^|od**5VrVJAiI?wxS|3;X#avz4Fe3*4Ez3F14S%O;h? zdrv^HP?Uv1#+6CPgk|MMi|H9apLI{=WpLIq&*NZ7@UU&FFqK>GERg$FZED0vqgMa( zGrkwRnwhF5el7R?{x8=X=jb~JywAS-=vK{no9S&i`J1~g?Rfil_SdNirxVSSWM7&A zy_S*wkDoK>;a;Zz+bWh)rN3=O7uGhPmNEH!7v!~q8j;Q7_iDL!Td_PzNUuIPr7HN7 rfJs`Je;wDnQ=oW=ViFYe|I1Kem%(@LVf#^FN@MVJ^>bP0l+XkKKaM8Q literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_converter-members.html b/docs/html/classkiwi_1_1model_1_1_converter-members.html new file mode 100644 index 00000000..0fe885c7 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_converter-members.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Converter Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Converter, including all inherited members.

    + + +
    process(flip::BackEndIR &backend)kiwi::model::Converterstatic
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_converter.html b/docs/html/classkiwi_1_1model_1_1_converter.html new file mode 100644 index 00000000..dfdddcd4 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_converter.html @@ -0,0 +1,153 @@ + + + + + + +Kiwi: kiwi::model::Converter Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Converter Class Reference
    +
    +
    + +

    Converts a document's backend representation to meet current version representation. + More...

    + +

    #include <KiwiModel_Converter.h>

    + + + + + +

    +Static Public Member Functions

    static bool process (flip::BackEndIR &backend)
     Tries converting current data model version. More...
     
    +

    Detailed Description

    +

    Converts a document's backend representation to meet current version representation.

    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    bool kiwi::model::Converter::process (flip::BackEndIR & backend)
    +     		+static
    +
    + +

    Tries converting current data model version.

    +

    Returns true if the conversion was successful, false otherwise. Call this function after reading from data provider.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Converters/KiwiModel_Converter.h
      • +
    • Modules/KiwiModel/KiwiModel_Converters/KiwiModel_Converter.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_dac_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_dac_tilde-members.html index ce0064b6..627e6694 100644 --- a/docs/html/classkiwi_1_1model_1_1_dac_tilde-members.html +++ b/docs/html/classkiwi_1_1model_1_1_dac_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -69,43 +96,67 @@

    This is the complete list of members for kiwi::model::DacTilde, including all inherited members.

    - - - + + + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + + + + + - + + + - + + +
    boundsChanged() const noexceptkiwi::model::Object
    DacTilde(flip::Default &d)kiwi::model::DacTildeinline
    DacTilde(std::string const &name, std::vector< Atom > const &args)kiwi::model::DacTilde
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &arsg) (defined in kiwi::model::DacTilde)kiwi::model::DacTildestatic
    DacTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::DacTilde)kiwi::model::DacTilde
    DacTilde(flip::Default &d) (defined in kiwi::model::DacTilde)kiwi::model::DacTildeinline
    declare() (defined in kiwi::model::DacTilde)kiwi::model::DacTildestatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::DacTildevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::DacTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    outletsChanged() const noexceptkiwi::model::Object
    parseArgsAsChannelRoutes(std::vector< tool::Atom > const &args) const (defined in kiwi::model::DacTilde)kiwi::model::DacTilde
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setPosition(double x, double y)kiwi::model::Object
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_dac_tilde.html b/docs/html/classkiwi_1_1model_1_1_dac_tilde.html index d54e2894..64594ac3 100644 --- a/docs/html/classkiwi_1_1model_1_1_dac_tilde.html +++ b/docs/html/classkiwi_1_1model_1_1_dac_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::DacTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -70,6 +97,8 @@
    kiwi::model::DacTilde Class Reference
    + +

    #include <KiwiModel_DacTilde.h>

    Inheritance diagram for kiwi::model::DacTilde:
    @@ -82,151 +111,237 @@ - - + + + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - DacTilde (flip::Default &d)
     flip Default Constructor
    + DacTilde (std::vector< tool::Atom > const &args)
     
    + DacTilde (flip::Default &d)
     
    - DacTilde (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    +std::vector< size_t > parseArgsAsChannelRoutes (std::vector< tool::Atom > const &args) const
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &arsg)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    -
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +

      Detailed Description

      +
      Todo:
      Check better way to get routes.
      +
      The documentation for this class was generated from the following files:
        +
      • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.h
        • +
      • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DacTilde.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_data_model-members.html b/docs/html/classkiwi_1_1model_1_1_data_model-members.html index 02ab2006..c781a579 100644 --- a/docs/html/classkiwi_1_1model_1_1_data_model-members.html +++ b/docs/html/classkiwi_1_1model_1_1_data_model-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -69,14 +96,15 @@

    This is the complete list of members for kiwi::model::DataModel, including all inherited members.

    - - + + +
    init()kiwi::model::DataModelstatic
    initialised (defined in kiwi::model::DataModel)kiwi::model::DataModelstatic
    declareObjects()kiwi::model::DataModelstatic
    init(std::function< void(void)> declare_object=&DataModel::declareObjects)kiwi::model::DataModelstatic
    initialised (defined in kiwi::model::DataModel)kiwi::model::DataModelstatic
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_data_model.html b/docs/html/classkiwi_1_1model_1_1_data_model.html index 3fc1bf3c..63954d11 100644 --- a/docs/html/classkiwi_1_1model_1_1_data_model.html +++ b/docs/html/classkiwi_1_1model_1_1_data_model.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::DataModel Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -86,22 +113,24 @@ - - - + + + + + +

    Static Public Member Functions

    static void init ()
     Initializes the model. More...
     
    +static void declareObjects ()
     Declare objects.
     
    static void init (std::function< void(void)> declare_object=&DataModel::declareObjects)
     Initializes the model. More...
     
    -

    Static Public Attributes

    +
    static bool initialised = false
     

    Detailed Description

    The Patcher data model.

    Member Function Documentation

    - -

    ◆ init()

    - +
    @@ -111,7 +140,8 @@

    void kiwi::model::DataModel::init

    - + +
    ()std::function< void(void)> declare_object = &DataModel::declareObjects)
    @@ -123,7 +153,7 @@

    Initializes the model.

    -

    Declares all flip classes.

    +

    By default will declare all objects. Can be overriden to declare custom objects or only a few objects.

    @@ -136,7 +166,7 @@

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_delay-members.html b/docs/html/classkiwi_1_1model_1_1_delay-members.html index 34f5b62b..fdec6e7b 100644 --- a/docs/html/classkiwi_1_1model_1_1_delay-members.html +++ b/docs/html/classkiwi_1_1model_1_1_delay-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::Delay, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Delay)kiwi::model::Delaystatic
    declare() (defined in kiwi::model::Delay)kiwi::model::Delaystatic
    Delay(flip::Default &d)kiwi::model::Delayinline
    Delay(std::string const &name, std::vector< Atom > const &args)kiwi::model::Delay
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Delayvirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Delay(flip::Default &d) (defined in kiwi::model::Delay)kiwi::model::Delayinline
    Delay(std::vector< tool::Atom > const &args) (defined in kiwi::model::Delay)kiwi::model::Delay
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Delayvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_delay.html b/docs/html/classkiwi_1_1model_1_1_delay.html index d3b01eef..f5bbfd20 100644 --- a/docs/html/classkiwi_1_1model_1_1_delay.html +++ b/docs/html/classkiwi_1_1model_1_1_delay.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Delay Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Delay (flip::Default &d)
     flip Default Constructor
    + Delay (flip::Default &d)
     
    - Delay (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + Delay (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Delay.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Delay.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_delay_simple_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_delay_simple_tilde-members.html index 9f6399d3..a9be9b08 100644 --- a/docs/html/classkiwi_1_1model_1_1_delay_simple_tilde-members.html +++ b/docs/html/classkiwi_1_1model_1_1_delay_simple_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::DelaySimpleTilde, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::DelaySimpleTilde)kiwi::model::DelaySimpleTildestatic
    declare() (defined in kiwi::model::DelaySimpleTilde)kiwi::model::DelaySimpleTildestatic
    DelaySimpleTilde(flip::Default &d)kiwi::model::DelaySimpleTildeinline
    DelaySimpleTilde(std::string const &name, std::vector< Atom > const &args)kiwi::model::DelaySimpleTilde
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::DelaySimpleTildevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    DelaySimpleTilde(flip::Default &d) (defined in kiwi::model::DelaySimpleTilde)kiwi::model::DelaySimpleTildeinline
    DelaySimpleTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::DelaySimpleTilde)kiwi::model::DelaySimpleTilde
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::DelaySimpleTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_delay_simple_tilde.html b/docs/html/classkiwi_1_1model_1_1_delay_simple_tilde.html index fc00f861..693210b3 100644 --- a/docs/html/classkiwi_1_1model_1_1_delay_simple_tilde.html +++ b/docs/html/classkiwi_1_1model_1_1_delay_simple_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::DelaySimpleTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - DelaySimpleTilde (flip::Default &d)
     flip Default Constructor
    + DelaySimpleTilde (flip::Default &d)
     
    - DelaySimpleTilde (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + DelaySimpleTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_different-members.html b/docs/html/classkiwi_1_1model_1_1_different-members.html new file mode 100644 index 00000000..13fb4e76 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_different-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Different Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Different, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Different)kiwi::model::Differentstatic
    declare() (defined in kiwi::model::Different)kiwi::model::Differentstatic
    Different(flip::Default &d) (defined in kiwi::model::Different)kiwi::model::Differentinline
    Different(std::vector< tool::Atom > const &args) (defined in kiwi::model::Different)kiwi::model::Different
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_different.html b/docs/html/classkiwi_1_1model_1_1_different.html new file mode 100644 index 00000000..0dd86084 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_different.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::Different Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Different Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Different:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Different (flip::Default &d)
     
    + Different (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Different.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Different.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_different.png b/docs/html/classkiwi_1_1model_1_1_different.png new file mode 100644 index 0000000000000000000000000000000000000000..5e4c33bf9b9b0606a0fa58c1a9bf4c742903ff84 GIT binary patch literal 943 zcmeAS@N?(olHy`uVBq!ia0vp^jX->WgBeJQRDD= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0?L1u^Ln;{G&V4;;i2_e6|3a^O|9iuC zvaxJEKI`n8H!sfxa!A-2Jcze=K4;|vCys*wDhdb1Is5+fevjc*Ecupr;5_H67pvL# z&t7o$&fC?237=NUY>(knY;mu07SPq)EaxoKH5n?F@-q0O`fbR)#_^2B zy1}r?mhn3ir-uWR&;*7CBcTZmEGi0&oORNT-|x-ligP&va$L`Wm8-vXbogA63N_#U zf68l-1?6WrU0mcc-2&X>kM2_K2vb@Tl;_o3IO*lIT}NiUy2f;M+OH!I{hpdSN^hUG z>1fByMY~GYMkv0h`TMqM!J3B>fk!lVbF99e@af3k=pS|HMwezpK(xz)mDis6-E0;(*>ck%3sn}8W#dFo(WW!ef;ydd%daqfT zryKBc`a-_@fqB!-8k8~~UklnMVHg}TeVwQ_%h`z@?dPuE7M@}%qugbY`uTPy@2`!= zEaraab@bZ9-85(B)80FRTYf-1dBNAQx6;?ZEMD--`m#IRlW*E7zxWhzWNyw@@hf4P znfKne#`x8}{kzWiBWD3k( N44$rjF6*2UngISkr-1+f literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_different_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_different_tilde-members.html new file mode 100644 index 00000000..9517a31a --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_different_tilde-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::DifferentTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::DifferentTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::DifferentTilde)kiwi::model::DifferentTildestatic
    declare() (defined in kiwi::model::DifferentTilde)kiwi::model::DifferentTildestatic
    DifferentTilde(flip::Default &d) (defined in kiwi::model::DifferentTilde)kiwi::model::DifferentTildeinline
    DifferentTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::DifferentTilde)kiwi::model::DifferentTilde
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_different_tilde.html b/docs/html/classkiwi_1_1model_1_1_different_tilde.html new file mode 100644 index 00000000..7ea1b303 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_different_tilde.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::DifferentTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::DifferentTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::DifferentTilde:
    +
    +
    + + +kiwi::model::OperatorTilde +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + DifferentTilde (flip::Default &d)
     
    + DifferentTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DifferentTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DifferentTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_different_tilde.png b/docs/html/classkiwi_1_1model_1_1_different_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..5ea9ae21a9a22f93dd49dc60c6c7f23efcfea226 GIT binary patch literal 1176 zcmeAS@N?(olHy`uVBq!ia0vp^bAb2&2Q!d7ruFMHkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~QTKFl45?szJNNaZ*BU%*v(JZK{JsC9 znwi80UCE=n+cz(kv^wVC!am{e^eI77qLXIcoY698=FIj9#>SsNti7YX{8{!s)6MH@ zME`p441J?>N`A`f*HhJU)QfQ-dx`cvdLgqjF%=a z*MVLe2Dj9doyU_Cc29gdFYoa!US08v!v zFxy(bRAlG6wfj9T30^Ns4c<1{bET%Z@iy)9554QReSKbZ`se;>uaDIfKD##I^nZ8l z^0H^&qHDdKzRWrKH9c?o+U@gq`dWEphM(KC)$^H7#f-H-UwB-a_x~5~$HngHCo1n- z*1zwLpY%^fQQcF{ZTjqGnNlJR(v=K7r%n|0A3sp0eA@Qzv8~ckdYeQKxMTG`X4pJ5 zKk0kfq?c>5O0Op*BeqTHYVZd$Q_M z)alfDYg{yZ-`#4-9Y}l_!O89*jOL9$uTT8 z+H~i!;fA{>iu|`1zHOVTP!zWj@T=xhzF)hvfdL%s+r>>RH}5W{ah=e>?BQc-=@l{JLM;dvg2P^1U&9 zpQJW^nRawexDk8atJi00FU*YzjmqA6=A&27r7QQ=8gKd9msVrEYvSwXyr*W&zg1r@ zyA!`n+r7#7*7~o-+v5L3<#{$_@0_FJ`?ojd-?r z-Y`#I@$|!)+)w9suN6ZD bz(2+VR&(adah?(Y79$Lvu6{1-oD!M + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Divide Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Divide, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Divide)kiwi::model::Dividestatic
    declare() (defined in kiwi::model::Divide)kiwi::model::Dividestatic
    Divide(flip::Default &d) (defined in kiwi::model::Divide)kiwi::model::Divideinline
    Divide(std::vector< tool::Atom > const &args) (defined in kiwi::model::Divide)kiwi::model::Divide
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_divide.html b/docs/html/classkiwi_1_1model_1_1_divide.html new file mode 100644 index 00000000..3b0c807d --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_divide.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::Divide Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Divide Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Divide:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Divide (flip::Default &d)
     
    + Divide (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Divide.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Divide.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_divide.png b/docs/html/classkiwi_1_1model_1_1_divide.png new file mode 100644 index 0000000000000000000000000000000000000000..5595c7bdf572898908f3c6836e8eb91233741161 GIT binary patch literal 923 zcmeAS@N?(olHy`uVBq!ia0vp^jX->WgBeJQRDD= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0wLD!MLn;{G&V4^^u>#N0{6m(X{^jpE zb-!Uj$(_tych5ZGV&Snj+!*iZvP5gb_j}r>IC>tmv$+3jGvnR+y?3v~htj4^zuz3Y zueQS9?{{X(j1n#P$-nMZ?_Z+M(x?=9z2g1fMRIcwHas|+zfj=FlPfAOmhbsq7wVto zsLB82dqM>F#n*ekXIK66t*QCH-~Ypp^rLmsy$_N(Iyy{P8Tz*{HmthBxy@JFac%;8 zfZGN24N(S6%3#EBsOJC&1nuiRVEH_R_4t`J8p;Muf{dN3zZe+vho~Ply7j;1wa9|f z9?lsvr<*8g>^`4#SBT}bV3NM?(UTu0Z0z(tLA~Oo(291TN7B^z=)wmvQbb1jB2ET%2#sr&5R5L%JHK3ZN|*! zQa|paD3K^O;#nzKYsN5Hr3%&-nfSC)N7$D53PTF4Kf#CDZPKm zTTDr<>(QjeIWrenDP?ZoQ4!r#(^l(}CS;c9mww^h)#I6a{5g^y#R@Drb0+^u--2WP z|Gm= + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::DivideTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::DivideTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::DivideTilde)kiwi::model::DivideTildestatic
    declare() (defined in kiwi::model::DivideTilde)kiwi::model::DivideTildestatic
    DivideTilde(flip::Default &d) (defined in kiwi::model::DivideTilde)kiwi::model::DivideTildeinline
    DivideTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::DivideTilde)kiwi::model::DivideTilde
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_divide_tilde.html b/docs/html/classkiwi_1_1model_1_1_divide_tilde.html new file mode 100644 index 00000000..223088c8 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_divide_tilde.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::DivideTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::DivideTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::DivideTilde:
    +
    +
    + + +kiwi::model::OperatorTilde +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + DivideTilde (flip::Default &d)
     
    + DivideTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DivideTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_DivideTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_divide_tilde.png b/docs/html/classkiwi_1_1model_1_1_divide_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..384893c7b558da7136d57a5ec8786c8cd6ae2e67 GIT binary patch literal 1143 zcmeAS@N?(olHy`uVBq!ia0vp^bAb2&2Q!d7ruFMHkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~Ve@ox45?szJNMzV#aaSv-RFxhz5jn~ zwuX|1)y%%{dYdmBhq%mg;4Jy$?WNhvb@EJ(kJGs`XPi&WoLTuJ0!pk{O0==-__pzqqKAO{mcKqbl*So#$Nf!nKL#$deeiv znwbie`5OWyBj0_LxRIB#bNTHZWzMHvw=wv@WPhOegu$jorlEZT^9O+<2016b z1I{NHE084rsO`+0wJb1k(h@^XOV3XNMU$R94AKjoU)rrwdZQ_H`u47urhPn=}W2mR`1GXp6c=Q*y_ra-j^ooKQUVxbUJmO z4)?TWzw&ff$6US^r?T?+);qg2f1g|uGPPUs_0-ojj~D0u-FK(x-}n%BunnH&8G6Qo>rgg_bcxEdRemQ zUirE6wI97N-B)>{a`NztqRS?}GzpM}Czih2oHua^U-X7o)8^GrD)E!9`&wW7^yVz) z+!}Rt&-{y%XJ=o3EVC&4@bseM%2si&<8Lp1I;F!u`~9lC+YZ_L-~7(1zPi1?YE|iv zv>S8pEDOond1mrjou(IVUhAG}?cMP>Pa{+NuJQKs z*Um}pRWGl4R`yb1sk7zjYg#j}yX0&(y*~ZhuCHfvrY_n2<5~VPl~Pc2e=v^wGs#3s zQQcF{ZTjqGnNlJR(v=K7r%n|0A3sp0eA@Qzv8~ckdYeQKxT7W;oN4Nz`N^eIF0Gir za7+c7^!DB<3f~@kD*s?m^rbc8*}HXi?%-#PetDX4kE{Q?k{S1u>%;T()?aJQy7txc z`qGnkpY0A?*RwhH)w$csB~IZ*vx8PX{j^5>;H8lJQ(yKK@K-fWAyXeu+N-(Uf41L?*DV>Ale5p? z(TnES{_=C??WN31Kw(q5=!$v3g6Vus!9k-aMzmJ?TdUu#{l%boFyt I=akR{0PVpnPXGV_ literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_document_manager-members.html b/docs/html/classkiwi_1_1model_1_1_document_manager-members.html new file mode 100644 index 00000000..8a1ca5e9 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_document_manager-members.html @@ -0,0 +1,123 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::DocumentManager Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::DocumentManager, including all inherited members.

    + + + + + + + + + + + + + + + + + +
    canRedo()kiwi::model::DocumentManager
    canUndo()kiwi::model::DocumentManager
    commit(flip::Type &type, std::string action=std::string())kiwi::model::DocumentManagerstatic
    commitGesture(flip::Type &type, std::string label)kiwi::model::DocumentManagerstatic
    connect(flip::Type &type, const std::string host, uint16_t port, uint64_t session_id)kiwi::model::DocumentManagerstatic
    DocumentManager(flip::DocumentBase &document)kiwi::model::DocumentManager
    endCommitGesture(flip::Type &type)kiwi::model::DocumentManagerstatic
    get(flip::Ref const &ref)kiwi::model::DocumentManagerinline
    getRedoLabel()kiwi::model::DocumentManager
    getUndoLabel()kiwi::model::DocumentManager
    isInCommitGesture(flip::Type &type)kiwi::model::DocumentManagerstatic
    pull(flip::Type &type)kiwi::model::DocumentManagerstatic
    redo()kiwi::model::DocumentManager
    startCommitGesture(flip::Type &type)kiwi::model::DocumentManagerstatic
    undo()kiwi::model::DocumentManager
    ~DocumentManager()kiwi::model::DocumentManager
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_document_manager.html b/docs/html/classkiwi_1_1model_1_1_document_manager.html new file mode 100644 index 00000000..6342ba9e --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_document_manager.html @@ -0,0 +1,315 @@ + + + + + + +Kiwi: kiwi::model::DocumentManager Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::DocumentManager Class Reference
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + DocumentManager (flip::DocumentBase &document)
     Constructor.
     
    + ~DocumentManager ()
     Destructor.
     
    +bool canUndo ()
     Returns true if there is an action to undo.
     
    +std::string getUndoLabel ()
     Returns the label of the last undo action.
     
    +void undo ()
     Undo the last action.
     
    +bool canRedo ()
     Returns true if there is an action to redo.
     
    +std::string getRedoLabel ()
     Returns the label of the next redo action.
     
    +void redo ()
     Redo the next action.
     
    +template<class T >
    T * get (flip::Ref const &ref)
     Returns the object's pointer or nullptr if not found in document.
     
    + + + + + + + + + + + + + + + + + + + + + + +

    +Static Public Member Functions

    static void commit (flip::Type &type, std::string action=std::string())
     Commit and push. More...
     
    +static void connect (flip::Type &type, const std::string host, uint16_t port, uint64_t session_id)
     Connect the DocumentManager to a remote server.
     
    +static void pull (flip::Type &type)
     Pull changes from remote server.
     
    static void startCommitGesture (flip::Type &type)
     Starts a commit gesture. More...
     
    static void commitGesture (flip::Type &type, std::string label)
     Commit a gesture. More...
     
    static void endCommitGesture (flip::Type &type)
     Ends a commit gesture. More...
     
    +static bool isInCommitGesture (flip::Type &type)
     Returns true if the document is currently commiting a gesture.
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::model::DocumentManager::commit (flip::Type & type,
    std::string action = std::string() 
    )
    +     		+static
    +
    + +

    Commit and push.

    +
    See also
    startCommitGesture, endCommitGesture.
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::model::DocumentManager::commitGesture (flip::Type & type,
    std::string label 
    )
    +     		+static
    +
    + +

    Commit a gesture.

    +
    Parameters
    + + +
    labelThe label of the current gesture.
    +
    +
    +
    See also
    startCommitGesture, endCommitGesture.
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::model::DocumentManager::endCommitGesture (flip::Type & type)
    +     		+static
    +
    + +

    Ends a commit gesture.

    +

    Each call to this function must be preceded by a call to startCommitGesture.

    See also
    startCommitGesture.
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    void kiwi::model::DocumentManager::startCommitGesture (flip::Type & type)
    +     		+static
    +
    + +

    Starts a commit gesture.

    +

    Each call to this function must be followed by a call to endCommitGesture.

    See also
    endCommitGesture, commitGesture
    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_equal-members.html b/docs/html/classkiwi_1_1model_1_1_equal-members.html new file mode 100644 index 00000000..b997de0c --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_equal-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Equal Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Equal, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Equal)kiwi::model::Equalstatic
    declare() (defined in kiwi::model::Equal)kiwi::model::Equalstatic
    Equal(flip::Default &d) (defined in kiwi::model::Equal)kiwi::model::Equalinline
    Equal(std::vector< tool::Atom > const &args) (defined in kiwi::model::Equal)kiwi::model::Equal
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_equal.html b/docs/html/classkiwi_1_1model_1_1_equal.html new file mode 100644 index 00000000..c273bca7 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_equal.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::Equal Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Equal Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Equal:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Equal (flip::Default &d)
     
    + Equal (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Equal.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Equal.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_equal.png b/docs/html/classkiwi_1_1model_1_1_equal.png new file mode 100644 index 0000000000000000000000000000000000000000..a91cd52361eb83ae301092bb010958a9ca73f4da GIT binary patch literal 936 zcmeAS@N?(olHy`uVBq!ia0vp^jX->WgBeJQRDD= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0%{^TlLn;{G&V9XYu>wzP`Jt#!|MG37 zWe4o}vcu}-oSV7Z5)OP|bo}q+awK$uL~@A;r^g59rtp8uHr+WU!Cr0r;5SR|m&NS% zz8BKyIBl|F=8%_&nGCUX>qGOoD>`j0co;86IerH>G}bD^QPM zoFn*$vqH?nfk|jW0}DgX#0C}>1xBEAZgV(s91P`HwW?2vku!}YY2CHOtE>X^P41@r zmAtNZ;KdB#6|3%D>RHfRC-QodLS*lR?4_FK%RHYcm3x*ii{`%)bxT;ke4V`Tm%`|^ z5nT})vrgX&UCq**uj9w@N-9rzRoBMJ8_Iaq{A1o9`pshb@f>HHU3le%d8hwJXBSLi z|2=o-{LaOF9LH>K%x#_j^q?AlXllB9`azkgPKLJJsmuRAvi|r;^s~J{%-+m6CslsrvM9DZ&|(Pi8^^e2$RN{7knASTduo)MfL8? zJllY`;S1vSh3}33#n85(|8~~Vpd(HfW4^76Qhm|qv+L!ZJ<5);hjU#*4bAk+vJLvS z_8M2r7kF~ST2W(WWcib>1;@`re0f;p%#7zOx1Sj|6=rWwPc*t+&EhP#>eRWub4`|7 zre}|D4tRAlfA9P%^?hIS6d6HLsMI9j^g)Ed<`NUbx+3)mv3!>DCeZ_u2j@4WH$ozg z;eZ4u)T8@*9f0XefS~}Gyb2s9$X=`Ex+xvK_K5|<8xzTQ4Gau>$ld~~T^j_xqPnZ=wXX9l}NBQknyVibn1AA?@cXu)u!`(EN%CZIt>FMc0r7yxh zCCoYL&iSk1uwKr!qBkYU;z3K_|2Zmk=2L<~MY{MK<}zMJL$kBZvW}j!w{y1Hu%rN^ zaADBY?~c;@%dBFG7=BF9J3P7JzMD{uU}Hze@_!6*I*ks3#fM6P*^0r_)z4*}Q$iB} DPePlr literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_equal_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_equal_tilde-members.html new file mode 100644 index 00000000..60dc5ec3 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_equal_tilde-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::EqualTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::EqualTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::EqualTilde)kiwi::model::EqualTildestatic
    declare() (defined in kiwi::model::EqualTilde)kiwi::model::EqualTildestatic
    EqualTilde(flip::Default &d) (defined in kiwi::model::EqualTilde)kiwi::model::EqualTildeinline
    EqualTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::EqualTilde)kiwi::model::EqualTilde
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_equal_tilde.html b/docs/html/classkiwi_1_1model_1_1_equal_tilde.html new file mode 100644 index 00000000..a3486ea7 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_equal_tilde.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::EqualTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::EqualTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::EqualTilde:
    +
    +
    + + +kiwi::model::OperatorTilde +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + EqualTilde (flip::Default &d)
     
    + EqualTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_EqualTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_EqualTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_equal_tilde.png b/docs/html/classkiwi_1_1model_1_1_equal_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..6b7d2da816bb502e4778d582824e1738de0c67c8 GIT binary patch literal 1164 zcmeAS@N?(olHy`uVBq!ia0vp^bAb2&2Q!d7ruFMHkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~k@j?P45?szJ2!XwVhsT|{r=}I|Nr-! zYpw6{TlVOk!R@POLs^3EFo^CKa^l$R)M0qcvT&zF@|FihhQ~4KE~+L^rP1s1I1TF1%uW;y0h{o%e!lk4f;_sBPz5ROH=xbf59{f9H5Nm*)2xx^eUGSDaUS_m9HP_WPIrzZS3WG5nXkBc{hNYDTPH zi+~#I1IIXq%|@H=yf)o<_e@d#_R6=*rhU#~-SDu8K`e&vK+|c)hyqInZawydgHIWB zcE~iaPG{cm03rFqv*`3Doy~`oJc}O{O-ecVRORHMwJ{m%a=TS{SIj-T;lsb|S$>S~ zl?B2X(xqm+&A&I7vH|?LD%o?)ID2wyFJJM>;|b7U#9r4Ia?h&>D(Wuby`!S zv~H((ZZO&EzcXd$y0!Z~FLhM!+@pE?PsPsN`8mvfl7MY^(chWYsjnZWznj1pWHEJhPVOX2PQJ~iva+65pX2u{*1cYS z`RSVXbM}8fs_$7ZG<~uP_vX{Or#Ja<9cbRekd~UZ^LlpD?wL>T<$b>8tNZ*WSHfYe zzQ+uj50jrvON~rxb)EF=2rw*~PJ2#jRT7_-eOt+sIV;^*XU~6?m$UX&%kHmxa(9;1 zuYb*RRBDfSU)s3HaJlVZ%?boWz<)oNITvv;=o_4c<<`40b5efel!{_?4>P5TOGU8}pc z?Y}oDkWMURIT`(DVT|wU%iHp%nl%E0@$;m+>to(YOiSS8cgP_xKVx?O-|Y02OGB6~KF-^amLydy`ag*8fwEf>gLqDDWrJs) zcJ^^ULYZ=ae^sNA9k`LSW{$PA| k0GMvh=!rXVO#Z|lbahVI0>g9Sz@me})78&qol`;+013iApa1{> literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_error-members.html b/docs/html/classkiwi_1_1model_1_1_error-members.html new file mode 100644 index 00000000..1e4f2825 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_error-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Error Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Error, including all inherited members.

    + + + + +
    Error(const std::string &message)kiwi::model::Errorinlineexplicit
    Error(const char *message)kiwi::model::Errorinlineexplicit
    ~Error() noexcept=defaultkiwi::model::Errorinlinevirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_error.html b/docs/html/classkiwi_1_1model_1_1_error.html new file mode 100644 index 00000000..79b0cd0f --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_error.html @@ -0,0 +1,142 @@ + + + + + + +Kiwi: kiwi::model::Error Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::model::Error Class Reference
    +
    +
    + +

    A generic exception for engine failures. + More...

    + +

    #include <KiwiModel_Error.h>

    +
    +Inheritance diagram for kiwi::model::Error:
    +
    +
    + + +kiwi::model::Object::Error + +
    + + + + + + + + + + + +

    +Public Member Functions

    + Error (const std::string &message)
     The std::string constructor.
     
    + Error (const char *message)
     The const char* constructor.
     
    +virtual ~Error () noexcept=default
     The destructor.
     
    +

    Detailed Description

    +

    A generic exception for engine failures.

    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_error.png b/docs/html/classkiwi_1_1model_1_1_error.png new file mode 100644 index 0000000000000000000000000000000000000000..4a8b7eab63182583cfac3a636a7e794b485b91a8 GIT binary patch literal 878 zcmeAS@N?(olHy`uVBq!ia0vp^(}B2ygBeKPJ=n<#q$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0{(8DNhEy=VoqKW9Y6Tt!^TK66|J(1= zQd*F4`SQH#8JSVnxZENXuY|j}u(22#OZR;+GX5+amzGv{@58M8KYP=w&YwQ>ro5o~ z--&YmKh%U3u`#n|b2T zR#&{WPYRnp@A}3^vhRxHPA`u;W)fQeJ~eIWlUx5kt-5^1=hmn2*EiCB#GUm0`#0j9 z?(?*??=`2ZGtQPjuWy`rQ}p9KGpJJzoj!Bs{2NszBRPioj~ERUnyYN(lDl|cnP&59 znym_d?H;tlgZFnth?W2igCeZaqh@dqbDvZi%<$B707hQopo z>GONTcZIp%v2)$IV}9;z?gy$iaSVD@aSZkkR$h;qHp9gB%$J*wZX z`|sq5^XujIY%`kwKCe1B_Oz=0i?SQPt0oC;kGnltamppX)YPIMnV+@4UtzfL{BfM; z;_ZD6G7K*sM<4&XB<0HFpSw=zJMb}l`S`SU`S!l>+41||Ture(u`=fE@i$dx)^Cz$ zT-Whk0NDdn^Z0cW-^=Y4K9@~uIn+Y0KIG634Yhx`bk(c$?~`6dY+tdeOhbIN!A$$m z%PX7rCUW{LT(!!UFK*Q;U})^V92$SrJM`DVJH5N|#;Mge-lRuI9>00#+p=BLyuW4LTIU>`ayK$7W6vk8lDvH~PbI<@ zoi8u>ygKq%)wlZ}y=w1Qn;Jgy9<8IHd4z=C3d)4Es&#q@q_^n=f zb@j=rP|K;S|3>6q-?Osn_r^E#itDES{qg(%cm02=tFkoXUwrMm_TznS=+#EBznH6i eFPropw|@{)zGbb!0!?7%VDNPHb6Mw<&;$VVR - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,68 @@

    This is the complete list of members for kiwi::model::ErrorBox, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args)kiwi::model::ErrorBoxstatic
    declare() (defined in kiwi::model::ErrorBox)kiwi::model::ErrorBoxstatic
    ErrorBox(flip::Default &d)kiwi::model::ErrorBoxinline
    ErrorBox(std::string const &name, std::vector< Atom > const &args)kiwi::model::ErrorBox
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::ErrorBoxvirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::ErrorBox
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::ErrorBox
    ErrorBox()kiwi::model::ErrorBox
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getError() const kiwi::model::ErrorBox
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::ErrorBoxvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setError(std::string const &error)kiwi::model::ErrorBox
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::ErrorBox
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::ErrorBox
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_error_box.html b/docs/html/classkiwi_1_1model_1_1_error_box.html index 49c73e23..f6fbefad 100644 --- a/docs/html/classkiwi_1_1model_1_1_error_box.html +++ b/docs/html/classkiwi_1_1model_1_1_error_box.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::ErrorBox Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,241 @@ - - - - + + + - - - + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    +
     ErrorBox (flip::Default &d)
     flip Default Constructor
     
    - ErrorBox (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    + ErrorBox ()
     Constructor.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Set the number of inlets. More...
     
    void setOutlets (flip::Array< Outlet > const &outlets)
     Set the number of inlets. More...
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    +void setError (std::string const &error)
     Sets the message error that caused the errorbox construction.
     
    +std::string getError () const
     Returns the error that caused the errorbox construction.
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     The error box construction method.
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     

    Member Function Documentation

    - -

    ◆ setInlets()

    - +
    @@ -250,9 +367,7 @@

    -

    ◆ setOutlets()

    - +

    @@ -277,15 +392,15 @@

    KiwiModel_Objects.h -
  • Modules/KiwiModel/KiwiModel_Objects.cpp
    • +
  • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ErrorBox.h
    • +
  • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_ErrorBox.cpp
    • Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_factory-members.html b/docs/html/classkiwi_1_1model_1_1_factory-members.html index 765ddeb5..2a3c6f6c 100644 --- a/docs/html/classkiwi_1_1model_1_1_factory-members.html +++ b/docs/html/classkiwi_1_1model_1_1_factory-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    - + - - - - + +
    @@ -69,19 +96,22 @@

    This is the complete list of members for kiwi::model::Factory, including all inherited members.

    - + - + - - - + + + + + +
    add(std::string const &name)kiwi::model::Factoryinlinestatic
    add(std::unique_ptr< ObjectClass > object_class, flip::Class< TModel > &data_model)kiwi::model::Factoryinlinestatic
    copy(model::Object const &object, flip::Mold &mold)kiwi::model::Factorystatic
    create(std::string const &name, std::vector< Atom > const &args)kiwi::model::Factorystatic
    create(std::vector< tool::Atom > const &args)kiwi::model::Factorystatic
    create(std::string const &name, flip::Mold const &mold)kiwi::model::Factorystatic
    getClassByName(std::string const &name, const bool ignore_aliases=false)kiwi::model::Factorystatic
    getNames(const bool ignore_aliases=false, const bool ignore_internals=true)kiwi::model::Factorystatic
    has(std::string const &name)kiwi::model::Factorystatic
    getClassByName(std::string const &name, const bool ignore_aliases=false)kiwi::model::Factorystatic
    getClassByTypeId(size_t type_id)kiwi::model::Factorystatic
    getNames(const bool ignore_aliases=false, const bool ignore_internals=true)kiwi::model::Factorystatic
    has(std::string const &name)kiwi::model::Factorystatic
    toKiwiName(std::string const &name) (defined in kiwi::model::Factory)kiwi::model::Factorystatic
    toModelName(std::string const &name) (defined in kiwi::model::Factory)kiwi::model::Factorystatic
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_factory.html b/docs/html/classkiwi_1_1model_1_1_factory.html index 07dd0533..064b7a45 100644 --- a/docs/html/classkiwi_1_1model_1_1_factory.html +++ b/docs/html/classkiwi_1_1model_1_1_factory.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Factory Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -81,44 +108,46 @@ struct  isValidObject  isValidObject type traits More...
      -class  ObjectClass - ObjectClass. More...
    -  -class  ObjectClassBase - ObjectClass base class. More...
    -  - - - - - - - + + + + + + + - - - + + + + + + + + + +

    Static Public Member Functions

    template<class TModel >
    static ObjectClass< TModel > & add (std::string const &name)
     Adds an object model into the Factory. More...
     
    static std::unique_ptr< model::Object > create (std::string const &name, std::vector< Atom > const &args)
     Creates a new Object with a name and arguments. More...
     
    template<class TModel >
    static void add (std::unique_ptr< ObjectClass > object_class, flip::Class< TModel > &data_model)
     Adds an object model into the Factory. More...
     
    static std::unique_ptr< model::Object > create (std::vector< tool::Atom > const &args)
     Creates a new Object with a name and arguments. More...
     
    static std::unique_ptr< model::Object > create (std::string const &name, flip::Mold const &mold)
     Creates a new Object from a flip::Mold. More...
     
    static void copy (model::Object const &object, flip::Mold &mold)
     Make a mold of this object. More...
     
    static ObjectClassBase * getClassByName (std::string const &name, const bool ignore_aliases=false)
     Returns a ptr to an object class thas has this name or alias name. More...
     
    static ObjectClass const * getClassByName (std::string const &name, const bool ignore_aliases=false)
     Returns a ptr to an object class thas has this name or alias name. More...
     
    +static ObjectClass const * getClassByTypeId (size_t type_id)
     Returns the object's class filtering by type id's hash code.
     
    static bool has (std::string const &name)
     Returns true if a given string match a registered object class name. More...
     
    static std::vector< std::string > getNames (const bool ignore_aliases=false, const bool ignore_internals=true)
     Gets the names of the objects that has been added to the Factory. More...
     
    +static std::string toModelName (std::string const &name)
     
    +static std::string toKiwiName (std::string const &name)
     

    Detailed Description

    The model Object's factory.

    Member Function Documentation

    - -

    ◆ add()

    - +
    @@ -128,11 +157,21 @@

    - + - - + + + + + + + + + + + +
    static ObjectClass<TModel>& kiwi::model::Factory::add static void kiwi::model::Factory::add (std::string const & name)std::unique_ptr< ObjectClass > object_class,
    flip::Class< TModel > & data_model 
    )
    @@ -152,9 +191,7 @@

    -

    ◆ copy()

    - +
    @@ -198,9 +235,7 @@

    -

    ◆ create() [1/2]

    - +

    @@ -210,19 +245,9 @@

    std::unique_ptr< model::Object > kiwi::model::Factory::create

    - - - - - + + - - - - - - -
    (std::string const & name,
    std::vector< tool::Atom > const & args) std::vector< Atom > const & args 
    )
    @@ -236,7 +261,7 @@

    Parameters
    - +
    nameThe name of the Object.
    argsA list of arguments as a vector of Atom.
    argsA list of arguments as a vector of Atom.
    @@ -244,9 +269,7 @@

    -

    ◆ create() [2/2]

    - +
    @@ -290,9 +313,7 @@

    -

    ◆ getClassByName()

    - +

    @@ -300,7 +321,7 @@

    - + @@ -332,13 +353,11 @@

    Returns
    A ptr to an ObjectClassBase.
    +
    Returns
    A ptr to an ObjectClassBase.
    - -

    ◆ getNames()

    - +
    Factory::ObjectClassBase * kiwi::model::Factory::getClassByName ObjectClass const * kiwi::model::Factory::getClassByName ( std::string const &  name,
    @@ -382,9 +401,7 @@

    -

    ◆ has()

    - +

    @@ -426,7 +443,7 @@

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_float-members.html b/docs/html/classkiwi_1_1model_1_1_float-members.html new file mode 100644 index 00000000..40b340ca --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_float-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    +

    + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Float Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Float, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Float)kiwi::model::Floatstatic
    declare() (defined in kiwi::model::Float)kiwi::model::Floatstatic
    Float(flip::Default &d) (defined in kiwi::model::Float)kiwi::model::Floatinline
    Float(std::vector< tool::Atom > const &args) (defined in kiwi::model::Float)kiwi::model::Float
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Floatvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_float.html b/docs/html/classkiwi_1_1model_1_1_float.html new file mode 100644 index 00000000..e7209d00 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_float.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Float Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Float Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Float:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Float (flip::Default &d)
     
    + Float (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Float.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_float.png b/docs/html/classkiwi_1_1model_1_1_float.png new file mode 100644 index 0000000000000000000000000000000000000000..564793e3cba2e22106c02d85e41e43b34dc30c36 GIT binary patch literal 713 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;CQ@5mnEA8j5n{7@-a4+|NHjL%_46}`Lk;}R?pmb&}YxJ zp8M%}yC;9|3$MBJGv>&ynKyUl8H(ri#3rVFoBHnU=0hd+w~z2_dv*Fw`OKNME2HxD>ugZTCTF0jwY zPbq&Pe5U{7+XNimWKFDHm)xp214u?vfDdT1P) z@KjTJo2r*>=CM06uPlp|mqzudx<6UA>`!Lz)W|JUT@S|ir_FZ`-ISrG^*wTCp!Mzd z#?7hcW*(jKxOUmZhsBxm*Z#Jd_kCu&*VY+NYvpRHzuJ}a1x~{coK1`K(#p>5$OcFOFw2XD!>uv}3urL%QvOn!UfAdt*l%xNyTVZ_oki#a8{sog( zNrlIATIj{5nGy9oCjtcD=KfgU# scxQVzdnz@OCB@#U)gg|L_^?taxXz;wsp>FVdQ&MBb@0A2f7H2?qr literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_gate-members.html b/docs/html/classkiwi_1_1model_1_1_gate-members.html new file mode 100644 index 00000000..61f6f59d --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_gate-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Gate Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Gate, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Gate)kiwi::model::Gatestatic
    declare() (defined in kiwi::model::Gate)kiwi::model::Gatestatic
    Gate(flip::Default &d) (defined in kiwi::model::Gate)kiwi::model::Gateinline
    Gate(std::vector< tool::Atom > const &args) (defined in kiwi::model::Gate)kiwi::model::Gate
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Gatevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_gate.html b/docs/html/classkiwi_1_1model_1_1_gate.html new file mode 100644 index 00000000..ebf526df --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_gate.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Gate Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Gate Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Gate:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Gate (flip::Default &d)
     
    + Gate (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Gate.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_gate.png b/docs/html/classkiwi_1_1model_1_1_gate.png new file mode 100644 index 0000000000000000000000000000000000000000..7e6117f3ad6bb975228c35cbd80aadec845fe87e GIT binary patch literal 717 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;AP}x%@t5*FgSRLGTev@nH z)`Qm~c_u%PzgRLu!Sv0XRjcGL7Ny1KuWK_tQsuv9>AD+|VnW>(Dlwvmw{;fz?|Xbz z=JnEIL+o1qTJ?+P#*1T(RFhy%!Ai0t+=+?+bP>`Y$%JHr+gHX^>^RP{0hsm}JYD@<);T3K0RZECSf~I1 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_gate_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_gate_tilde-members.html new file mode 100644 index 00000000..5a1832b1 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_gate_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::GateTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::GateTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::GateTilde)kiwi::model::GateTildestatic
    declare() (defined in kiwi::model::GateTilde)kiwi::model::GateTildestatic
    GateTilde(flip::Default &d) (defined in kiwi::model::GateTilde)kiwi::model::GateTildeinline
    GateTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::GateTilde)kiwi::model::GateTilde
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::GateTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_gate_tilde.html b/docs/html/classkiwi_1_1model_1_1_gate_tilde.html new file mode 100644 index 00000000..b2568191 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_gate_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::GateTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::GateTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::GateTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + GateTilde (flip::Default &d)
     
    + GateTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GateTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_gate_tilde.png b/docs/html/classkiwi_1_1model_1_1_gate_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..00aa519f7d5ce71edc861e09ecd37e0a67bbcac0 GIT binary patch literal 734 zcmeAS@N?(olHy`uVBq!ia0vp^%|P72!3-onx2%{Bq$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0ay?xfLn;{G&V4;;i2_fn|Ate0{!6dt z<=|Y9+rPW{YIR!Ctkn;hh5m92PCVJPVwIn$CsF>KulfuBDZ#1Eihv9*1+xn!4X{j@HbQD_*LQ@nDYc|h_ zzb)*7&l|fNtwfYPJI8n`u)lB z^>hBWJbXKQ`h8y`n+b`L(^A(lJeU{8Fk=n7!J5}K9qa}<9G4a69XPND=)+{7HzgSk zbfbE=Mzp!(M2aIr!m1MvZHmrXIu|r!WKAw7^?YYm`*k;oorj^oQ@Jfd`q0#0(QO&) z(}M20-*mi}e(uE;qswQGz3o5f-9K}=G}w!`U$rhSxf%8`UTjV5*OE1dtx_asW!_s} zd{eyiWo_|tp1c=w&Rhqd=^35e_wetxsy3+ucVmxq^(H#>d}Y62{9|{<-nX$>zm-He_z*KVtFEK%XID(g_DPBZh|S&Jr#z&tCB}U(ejvBz;l^m>3y6 MUHx3vIVCg!0GU%#Z~y=R literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_greater-members.html b/docs/html/classkiwi_1_1model_1_1_greater-members.html new file mode 100644 index 00000000..2dc858f4 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_greater-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Greater Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Greater, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Greater)kiwi::model::Greaterstatic
    declare() (defined in kiwi::model::Greater)kiwi::model::Greaterstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    Greater(flip::Default &d) (defined in kiwi::model::Greater)kiwi::model::Greaterinline
    Greater(std::vector< tool::Atom > const &args) (defined in kiwi::model::Greater)kiwi::model::Greater
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_greater.html b/docs/html/classkiwi_1_1model_1_1_greater.html new file mode 100644 index 00000000..6fd9de82 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_greater.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::Greater Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Greater Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Greater:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Greater (flip::Default &d)
     
    + Greater (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Greater.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Greater.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_greater.png b/docs/html/classkiwi_1_1model_1_1_greater.png new file mode 100644 index 0000000000000000000000000000000000000000..fb75e13ce7811a9b02badb37417339dfb3264513 GIT binary patch literal 944 zcmV;h15f;kP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0009&Nklyo4(422J&O5XpCSGfiRwa1#x?Cj~zQ4APAAkn{Y&N)-Tg%E5^OJ5Z$1f8!xT@aKt93zT2Wfx)f8cgoE--XW!QsP|`bYt%Fpx&4M zkJez72j`u6o{7Cy1brTyYT;{nFyx_#JK3rhRHV?$7+k$QL0Q8wqKH#AKb_W~ zf7TeM^S&WSiFZMeGqdc-9YKqq{*TsRl?UAv)HAOM#_lVEerv~Cn9TMWL6?Uj?qsW4 zP^D7Rysw4aPJZqEu6N=`?-mm9+em^RMBu&mmI8oR+5o^*<^I>8Jj75nq#ixbft#%HQ3CN zH7IL%j@Wsor@97hS=90j1j}9coFFCMunTRfnWhY?j&&Z?`04*>4bFLRp8qhR3xaW} zt_X&m*4xlWnB>7#HR?PB+{sq8pi8AbMAbsfuOE0X|#G7^v=6FBFbrTzfr!hus3 Shw+yH0000 + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::GreaterEqual Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::GreaterEqual, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::GreaterEqual)kiwi::model::GreaterEqualstatic
    declare() (defined in kiwi::model::GreaterEqual)kiwi::model::GreaterEqualstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    GreaterEqual(flip::Default &d) (defined in kiwi::model::GreaterEqual)kiwi::model::GreaterEqualinline
    GreaterEqual(std::vector< tool::Atom > const &args) (defined in kiwi::model::GreaterEqual)kiwi::model::GreaterEqual
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_greater_equal.html b/docs/html/classkiwi_1_1model_1_1_greater_equal.html new file mode 100644 index 00000000..7d060564 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_greater_equal.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::GreaterEqual Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::GreaterEqual Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::GreaterEqual:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + GreaterEqual (flip::Default &d)
     
    + GreaterEqual (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GreaterEqual.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GreaterEqual.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_greater_equal.png b/docs/html/classkiwi_1_1model_1_1_greater_equal.png new file mode 100644 index 0000000000000000000000000000000000000000..c7f9e0032507737aed7dd2c7c463d4609d48f937 GIT binary patch literal 1157 zcmeAS@N?(olHy`uVBq!ia0vp^Gl2L22Q!d7e=w>ONJ#|vgt-3y{~ySF@#br3|Dg#$ z78oBmaDcV*jy#adQ4-`A%m7pb0#{Fk7%?!gh{w(r&rGG`qaB| zziQahbH{$DZY-U9sraqf@l9>(ombADxpSvy&NS`RVguvf4ZFkMIOO!KU6W)f&n9v^ z&dB(8%j``>Yb3JoC$~q=j6Qqj&z)b-_J3CXq<$pt@2h|Q_K(ui>|Hu$&a9M()LA-( zjpc!v9D}masvD0DSKM5Y%{isxg&q)AT{kEonH+!~QpcU#QUDq-)967Tc-mt~qC_}LNP z<#{PurZaTq=8bluvriiptefin^U)rapA&YUN%!4ex}a+5y^mSvNNOUB}((N zi|abGt?Ay8M|N%dr{Gz=?#Q&>8-6NFm&Kg9w(iD3S^4~>@jAzUZH>78{IJC8!%zQj z4|}6??Az_%Zy&t36n>qYGkxmzV>i^kEZw4=9(hwGccS%~Q$l)^wmiLG``J3KSMk~3 zX@A7+A5HpF-7-T37#umXmSs9HX!{^ke8lUDn!ooeJC@+2#`dfOD&oZJ)q z8(zjltCl_u$hq0^)+H$G)W^i_NqY~K%~|)A{YcT8_>QS55!=2xZ!Ep_=l`{?xkn?u zr}Un3PrAK(-H~4#Zl*mwc&o;H4R@{P+f$KYW}drMV&+d>I`8)FFwfkdFU|LVo-2{` z7#LyhprGL}^!)TeWcIR5DS?LD6%0KmRwVTwUyue2q`k*Xq{DPJ2_0}JluV$Z^f13; z>6A+y6Bv#uLsOI1H2$?umwv3;_|i;W_&}d;@k#3j*{jQinJc=LH|{L6ITyzBpoMwk z&OLs{U*Ca3s6R5!=;xZ3*Y0ol68p;A+5AhXd9L?7yXRkgh znpgKWitT>c+oQl_<9}tVjNGfPwfuK&Yt*kDiP$f;y>o4I{-x#TVuh35-pk4{Un!fv zeX1(ky_k))J#WLaKhIg7lpeh^{yq0bUy-fVH~R|&lJ`b*-t*q5_eBvDX4^cYpXY8W z@|$O>J^Opa)u>~)-zXf&FZ?x+*RX-PO_bR}0qVi)yY-h&IrdmSrfJ5_e!WI*V41<- M>FVdQ&MBb@0J%pfW&i*H literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_greater_equal_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_greater_equal_tilde-members.html new file mode 100644 index 00000000..4bcb7715 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_greater_equal_tilde-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::GreaterEqualTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::GreaterEqualTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::GreaterEqualTilde)kiwi::model::GreaterEqualTildestatic
    declare() (defined in kiwi::model::GreaterEqualTilde)kiwi::model::GreaterEqualTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    GreaterEqualTilde(flip::Default &d) (defined in kiwi::model::GreaterEqualTilde)kiwi::model::GreaterEqualTildeinline
    GreaterEqualTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::GreaterEqualTilde)kiwi::model::GreaterEqualTilde
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_greater_equal_tilde.html b/docs/html/classkiwi_1_1model_1_1_greater_equal_tilde.html new file mode 100644 index 00000000..9ec9c114 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_greater_equal_tilde.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::GreaterEqualTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::GreaterEqualTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::GreaterEqualTilde:
    +
    +
    + + +kiwi::model::OperatorTilde +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + GreaterEqualTilde (flip::Default &d)
     
    + GreaterEqualTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_greater_equal_tilde.png b/docs/html/classkiwi_1_1model_1_1_greater_equal_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..614396802f86bc610cb5b9ceebffc724673baa5c GIT binary patch literal 1258 zcmeAS@N?(olHy`uVBq!ia0vp^n}PTM2Q!eYs9CfQNJ#|vgt-3y{~ySF@#br3|Dg#$ z78oBmaDcV*jy#adQ4-`A%m7pb0#{Fk7%?!gRC>BNhEy=Vo%?#yVg&&={`sK~|K6|I z+t9FRa`btfP}|d;Tpa3imwne)Y%!2%kw})|D(^FNtG;7-Oycd&WuJ?dT+goRF*JJ{ zZC!h@^84PXkN=DHF7g&1*<9E4r^xfW;jtf*YUfs$XSI9x7}j<9&apoCzc%m9x!W6M zPXDwJN$!zP4l-{$`FxjM`RilXq=EdTAO9EJJ@oF6^r>luK%0cYHWfaXNZyiO#;4e_ zkzvC_Mgs|ED|@-ep8PLtwE5L-7j3@I+i?HDT*fzr=?v9(BoD}yvu!wzkLxviS*8?^ znx_<3`81X4JCT##RNk@-nP1wkQmWB>b&J9O(AedydEqs;BPY#U^nB0nxV5Pd_H5hp zyli^gwu7b@^Wjw^-l_9RY}UT>Z6{_ft+nVKeP}-A^TRb{6G* z{uyFkr#+uvJ%DR@S*ZD{O_TQQE>(UyU*+zn>HqonMSQv&IVtXW>{I*R%_@7Ft-UAN zzSHsicIMn=6W?UUgu~1U25cpDHpeE*U8oF`^Q&@6UoXwDztNic#^ZAg-*y-`*uLXQ z=*P#MV&;3saUESQv8Sg5tSLU9Mmj3-)RY0>ZI^$BX=~|sB&zG*>_(k{o)5Z6+^zZ9v zugt7{p0w-!(rs2xT8qQ~Zpoj$%geneQ~mwk-s0VBmMkls%b&lUF=v}~ykBA7+rHN! zd*816x?{<%+LM*mMds&T`aH9#ytK1^()*(1y({}SiL5H)`%pXQvxB;M-Xk4P_IKwV z{8SGO$h=!)cdggYWqxs;DRO9fJ4Ksc`g<+@dtI2h%FF0I5wBHWx&xy>%B^JDlKjW# zCZ+U)0(J9e6W_}b3^zV7Nc1qymGA$!guP_m)b`187jM31JCOf?$iM^z_0m>>LkR*5 zZHJ)AvF!QVp!&w!`oV0gGhfeSvnYJwcU=C#k(`iK&dTKvc|L$bbKU-P7bPDwrA?Ke zdwrWt-W%c5=6(k~MT@FeE!(R9Wam%2aue_8%MVxmOn$x2jsM)ylKtMfKX-l;Edqw; z`u(#*7GEt0T5)(r?=17I=VjZk{WMt1o3J@Iy?>8CXXs}4$1zWfrI&d>|MiuB?&*E) z!F#gbKHucC-rWA*mejp{#gc+P$AV^U7KSw&vNH zpS-y4!pY~?Eay)7{^@4{lj59Pp?6oD_Okr7G;dA%jw`*Z?A{-%-23En%w2{b!g2TS u&t;5DbxCiyUI59P^OoLe7dRB~huM~S3qNZ`k|wZVV(@hJb6Mw<&;$VA%y+f` literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_greater_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_greater_tilde-members.html new file mode 100644 index 00000000..6ab02d9e --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_greater_tilde-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::GreaterTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::GreaterTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::GreaterTilde)kiwi::model::GreaterTildestatic
    declare() (defined in kiwi::model::GreaterTilde)kiwi::model::GreaterTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    GreaterTilde(flip::Default &d) (defined in kiwi::model::GreaterTilde)kiwi::model::GreaterTildeinline
    GreaterTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::GreaterTilde)kiwi::model::GreaterTilde
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_greater_tilde.html b/docs/html/classkiwi_1_1model_1_1_greater_tilde.html new file mode 100644 index 00000000..31bc2203 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_greater_tilde.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::GreaterTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::GreaterTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::GreaterTilde:
    +
    +
    + + +kiwi::model::OperatorTilde +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + GreaterTilde (flip::Default &d)
     
    + GreaterTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GreaterTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_GreaterTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_greater_tilde.png b/docs/html/classkiwi_1_1model_1_1_greater_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..44ce02e2d24a21bd357dd9a7e523d6ec659d5a45 GIT binary patch literal 1178 zcmeAS@N?(olHy`uVBq!ia0vp^bAb2&2Q!d7ruFMHkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~(e!k245?szJNMzV#aaSv-RFxB{oemk zjfkT?c2ldbUa9ikZg^~2 z?UcXHJC(|&J=H(;_O>0L~qxR{oluzzq%bOg{8f+bt)N}Djt+x4u+3C^Ucfyn> zpOS3{3LVS6YIT3+>iXwxS9iH4_gp-5Hov1f-h98uyJz3O*#CXhZ+PrK57@@dr&|RM zEn&EGf;k~9ZCbUB+P2w|?_Qd%zk8)9ZY_gZ4BvsK(~J=XmJHl_>-?Wwn>IOrugMnPb>5p}w`snPHO=)8aXY0R_i(Mgr)~U+w_Z!9-}<#d zCBo@zY+mHL&aL8}QiZzH&7b}-&?udCSnJi-R?V3FU_;d9ixZd3`~REwL!c zu6x%VKk1*Ep1P-4+VtpYsWU|yq$?TDoH|p~fBZ<9@oC$;&$iBvI=5Q%KpQb(0Su^z z<|lPeZ#u)(t#Y>WwC5z&>62BsUG+lhUw5eR-e6yy`S7Rzq;r|=@t@=6E8Q+TSl3OM zykxt?$+df5+uY6ItI^!P?fM6|nLFyYZZWz&-M9Se7Tdsi(`({4hS&cOw%1yoe@X61 z+0skixwR4JCOChMJvra0TETY9+?YkZF|)T#wf4!LzU1WX_+3-8P5UZWW&FNU^~ZVV z+duIqmNK1;{*nriSQ4O@F8F`Lf$xE?TTyoYoaNom4%{xvu5L9u_28fAsp<{`LlmzH2P0u&Mr|e+8y+A>9;rH2ZdI>KUMr`+ttNa3xYDA-YQAndH742 z=d3?}m#(?9Z^qTld_`vkUtGGYx_$2d!`t3*PjUIYM95-t_UX(WYqOW@sc?k8p8m#X zUDUZ}yW`g031_{yv^`+!!w<4twkP%m ou4OQOh{!ZEV)a@C)SmKxJu#>A^|x?uU_rv*>FVdQ&MBb@0KGy%3;+NC literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_hub-members.html b/docs/html/classkiwi_1_1model_1_1_hub-members.html new file mode 100644 index 00000000..944a4a56 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_hub-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Hub Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Hub, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const override finalkiwi::model::Hubvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Hub)kiwi::model::Hubstatic
    declare() (defined in kiwi::model::Hub)kiwi::model::Hubstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Hubvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    Hub(flip::Default &d) (defined in kiwi::model::Hub)kiwi::model::Hub
    Hub(std::vector< tool::Atom > const &args) (defined in kiwi::model::Hub)kiwi::model::Hub
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const override finalkiwi::model::Hubvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &parameter) override finalkiwi::model::Hubvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_hub.html b/docs/html/classkiwi_1_1model_1_1_hub.html new file mode 100644 index 00000000..3ae608c6 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_hub.html @@ -0,0 +1,448 @@ + + + + + + +Kiwi: kiwi::model::Hub Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Hub Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Hub:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Hub (flip::Default &d)
     
    + Hub (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    void writeAttribute (std::string const &name, tool::Parameter const &parameter) override final
     Writes the parameter into data model. More...
     
    void readAttribute (std::string const &name, tool::Parameter &parameter) const override final
     Reads the model to initialize a parameter. More...
     
    bool attributeChanged (std::string const &name) const override final
     Checks the data model to see if a parameter has changed. More...
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    bool kiwi::model::Hub::attributeChanged (std::string const & name) const
    +     		+finaloverridevirtual
    +
    + +

    Checks the data model to see if a parameter has changed.

    +

    Only called for saved parameters. Default returns false.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::model::Hub::readAttribute (std::string const & name,
    tool::Parameter & parameter 
    ) const
    +     		+finaloverridevirtual
    +
    + +

    Reads the model to initialize a parameter.

    +

    Saved parameters may infos from the data model.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::model::Hub::writeAttribute (std::string const & name,
    tool::Parameter const & paramter 
    )
    +     		+finaloverridevirtual
    +
    + +

    Writes the parameter into data model.

    +

    If the parameter is saved this function will be called at every attempt to modify the parameter. Never called for non saved parameters.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Hub.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Hub.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_hub.png b/docs/html/classkiwi_1_1model_1_1_hub.png new file mode 100644 index 0000000000000000000000000000000000000000..1936c2f4d05f4ab85fbc2f7dc298c57785f504a5 GIT binary patch literal 706 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;%THS1^0{Q1GvPjKQshL~iw7iW0SRld{Td+=vK z+4Or4|IFGW>&KwpCVZg%A%vU^M$yL#&9QlnCyP)#r63sv*2wZEPF_WaxoqvPkU&Ust= zZ05)BYiqZ?E3UrhZn!j4|tvYYrf^| z{B0j&m#unrSln`X=B!^#1-+6BjLj{c@7(`|?YZ;K*sAu=*`LZR80Vn+56Qb0F2D%k za0mx^{{DlWwVU35sE=a%94wo-yY4>c2eJ7@ZJ*xsiX42D@WbOc$a8CrzuKvV-dbC1 z_;h*5p;tx`9bsEGWj#Gp>zjUu(IfDhdqBjhRW<9cKAvBy*LLjYJge?(jl2&j^N)Y8 ze5dpL>d8Rs)yj7)4*&RB8z#xJNptO - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    - + - - - - + +
    @@ -70,7 +97,7 @@

    This is the complete list of members for kiwi::model::Inlet, including all inherited members.

    - + @@ -79,7 +106,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_inlet.html b/docs/html/classkiwi_1_1model_1_1_inlet.html index 932609ce..3ec3ac4d 100644 --- a/docs/html/classkiwi_1_1model_1_1_inlet.html +++ b/docs/html/classkiwi_1_1model_1_1_inlet.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::model::Inlet Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    declare() (defined in kiwi::model::Inlet)kiwi::model::Inletstatic
    hasType(PinType type) constkiwi::model::Inlet
    hasType(PinType type) const kiwi::model::Inlet
    Inlet(std::set< PinType > types)kiwi::model::Inlet
    Inlet(flip::Default &) (defined in kiwi::model::Inlet)kiwi::model::Inlet
    ~Inlet()=defaultkiwi::model::Inlet
    - + - - - - + +

    @@ -86,25 +113,25 @@ - - - - - - + + +

    Public Member Functions

    +
     Inlet (std::set< PinType > types)
     Initializes the Inlet with multiple types.
     
    +
     ~Inlet ()=default
     The destructor.
     
    -bool hasType (PinType type) const
     Checks if the inlet is compatible with type.
     
    +
    +bool hasType (PinType type) const
     Checks if the inlet is compatible with type.
     
     Inlet (flip::Default &)
     
    -

    Static Public Member Functions

    +
    static void declare ()
     
    @@ -119,7 +146,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_less-members.html b/docs/html/classkiwi_1_1model_1_1_less-members.html new file mode 100644 index 00000000..80da0d60 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_less-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Less Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Less, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Less)kiwi::model::Lessstatic
    declare() (defined in kiwi::model::Less)kiwi::model::Lessstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Less(flip::Default &d) (defined in kiwi::model::Less)kiwi::model::Lessinline
    Less(std::vector< tool::Atom > const &args) (defined in kiwi::model::Less)kiwi::model::Less
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_less.html b/docs/html/classkiwi_1_1model_1_1_less.html new file mode 100644 index 00000000..2e5d2769 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_less.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::Less Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Less Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Less:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Less (flip::Default &d)
     
    + Less (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Less.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Less.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_less.png b/docs/html/classkiwi_1_1model_1_1_less.png new file mode 100644 index 0000000000000000000000000000000000000000..1f77a0e0a44166519901dd52bac9bb52c1853f96 GIT binary patch literal 917 zcmeAS@N?(olHy`uVBq!ia0vp^jX->WgBeJQRDD= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0RXklBLn;{G&V9XYu>wzP`Jt#!|MG24 znJQ?ky*&Bc%q=&Y7!Rwn{NYwo3T@o;Juc8KfhAu^=BMVR3@$-MXgOAU5)k^n1$mZziFkxlr-@@3i>I&yJUunm=3G4xG z7t}ZGO<(~!0Eie`BpU@K!03+|)AKpOqB6#t7xf(AaAQ$fcj@pMn}A%AyBYsEuWLHI zmJl{D*3WbaaGQU0mnz3JygV?Ual;cXMbzPxx@;uht$v0pa(v7Q8H;&i-`gkN8>5k#cjw(`<#K z&vM+dv3T41{nLWe&S_RRbM!mbPSR+rR$Tjqe_p4#`4b8`JA z#UvE|GBHhVg;`hLmj5$mK9@2nXE}4mTS~CyR_Pq+rUdu-D=t}wB>(u)_uI6DvwTrB z@08!FD-M@mdA*cRf#cPVrPFj=d_<0_zTcGE^r~Y??DI#toS$UA3C{GqvBTo5qji}4 z@{e|k9i8Ql6O4@4pOAIzmH+QuY;d~yndp%j*I8;mi#qP!@;6Rm&s!Z%cB6r8y1A48XEqx>?njf}uN#Ng@b=d#Wzp$Pyh?vCC7 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_less_equal-members.html b/docs/html/classkiwi_1_1model_1_1_less_equal-members.html new file mode 100644 index 00000000..c3ed99f8 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_less_equal-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::LessEqual Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::LessEqual, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::LessEqual)kiwi::model::LessEqualstatic
    declare() (defined in kiwi::model::LessEqual)kiwi::model::LessEqualstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    LessEqual(flip::Default &d) (defined in kiwi::model::LessEqual)kiwi::model::LessEqualinline
    LessEqual(std::vector< tool::Atom > const &args) (defined in kiwi::model::LessEqual)kiwi::model::LessEqual
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_less_equal.html b/docs/html/classkiwi_1_1model_1_1_less_equal.html new file mode 100644 index 00000000..38e0fa5c --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_less_equal.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::LessEqual Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::LessEqual Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::LessEqual:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + LessEqual (flip::Default &d)
     
    + LessEqual (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessEqual.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessEqual.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_less_equal.png b/docs/html/classkiwi_1_1model_1_1_less_equal.png new file mode 100644 index 0000000000000000000000000000000000000000..b8be892ca8073993df7e0b69ced5d02843e6d127 GIT binary patch literal 1075 zcmeAS@N?(olHy`uVBq!ia0vp^?Ld5hgBeIlrZl_(QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;k*fED$z>-~|h|l4POv4FFhKX>AI#Kr? zL%)PYGjF~v<1-evY@gZ5Cga!_m7Hc)kUb^u;m66V4l}fO1@jqi_LeIQY1_O}uV~G! zV<(qhnj(Fj{oL|9se32o;oiITW<|OV;IM7qyJuuPa_FTbQ$Ym;7~|j$_LYSA8*l zcl>3R{qqxvKbsaGdArU1y2UM>pY@rx=N>Jt7MS^y>-fIQ+I@AWzyCC<_*8DOOT(0# zeeTolC6}jh)$W^8wC?(?{lD#MKgT|iNn7^m{o0wGa}J+z5iUF;@%S&>k1N~gn`>{b-Ept( z#`LWhlpeKzl{j+TuIYE}#mZx^7xwNd6L2~F!{X-j&p#~g-Fv#$O|u1Qottxb|8|CCYj%ZM9m*{N@4nY>T-)Akvb9bCn8O)7UHx3vIVCg! E0OKkMMF0Q* literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_less_equal_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_less_equal_tilde-members.html new file mode 100644 index 00000000..f1affd5e --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_less_equal_tilde-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::LessEqualTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::LessEqualTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::LessEqualTilde)kiwi::model::LessEqualTildestatic
    declare() (defined in kiwi::model::LessEqualTilde)kiwi::model::LessEqualTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    LessEqualTilde(flip::Default &d) (defined in kiwi::model::LessEqualTilde)kiwi::model::LessEqualTildeinline
    LessEqualTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::LessEqualTilde)kiwi::model::LessEqualTilde
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_less_equal_tilde.html b/docs/html/classkiwi_1_1model_1_1_less_equal_tilde.html new file mode 100644 index 00000000..51d24c9b --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_less_equal_tilde.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::LessEqualTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::LessEqualTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::LessEqualTilde:
    +
    +
    + + +kiwi::model::OperatorTilde +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + LessEqualTilde (flip::Default &d)
     
    + LessEqualTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessEqualTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessEqualTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_less_equal_tilde.png b/docs/html/classkiwi_1_1model_1_1_less_equal_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..0b0b675135157a32404f8fc4c06973a55ff83abf GIT binary patch literal 1205 zcmeAS@N?(olHy`uVBq!ia0vp^i-7n52Q!e|AmC8}q$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IYLTs&PILn;{G&b?T+Sxdmpe13N7z5l)a zfi3|)ll%T_#?GC#mV?8ZdGeh}L0-wuM#j=J15AuR3w5QX#pMOmsNF3(-=B6(%>wio~Ph>FIFXVWjD#Ey@MX6zW0LurVE`~TK!2{kJOck82 z4Ejit_A4!XFPoV8OfoTAsNoss6gX*5&C(gGvhON+%6>bS6*24os%4j1^wVp?11H^E zv^?U=x@VuX^-`mg);?XgwV3mARdliO!^)<=3_Svz&S)6QNB zvCmBn&bf7Kwo2@WrH{7x9#>r&GFANbwZJ!f3J<&0uiKG!Jo{)`&u^V+o!9?wUsO>l zc7Aq!@~$m0n%mMpPPzF1g^t`LSFhzoQ!j=dNrW4_zZEcLiSm4@ ze=Z`bFNHzQZds&KIa73b=Bzfh2XS%?$;SI0JvQ9)_(#{~hcEi}I~W>C9q`BWKi0r` z>aXQ@*`$|uvP!RyhS#L&0aH};w!64dry-q=0!?}MK!rMCHR={Mk{a3tmFPmR3 z6D{8ubUHP%Xm)z`s`;n1c4p?E@ZR3+oxS*m-|b)5F&CY^pzVzvI#C63h4flfGTD?LOY~ z?#OG~qx$C_DMl_S(F&K0RsAz_16R9fi331}J& z61g7z_V=aQ_c~i&f3!4Y^gF{;ea}o!yo(|K<4mOktlsy{9(W&JY9k-MYU_6X8Oam( zue!E;@*}&9-S3>|=}!~=w(spGv+%v_M`PDqDXPqKo0$j-xj#=+g?u#=HMB#vM{S(D zC)9=~`|#%NCHco=wa)&Wbv{YD#rx>1XQ6kl=ZX|(m6-k7;Q#xz>`~i;e$snGUVUi_ znOgj#D$u6JvqW^g`L4)4ll64NyWU3bx$)xl=8BrXXE#@Ph^F+2`v6-LAXeLGXbwG;hrm4fe{+_{Yp*uxMu*pS>usjA8I}^>bP0l+XkK D;ITl% literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_less_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_less_tilde-members.html new file mode 100644 index 00000000..614d4908 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_less_tilde-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::LessTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::LessTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::LessTilde)kiwi::model::LessTildestatic
    declare() (defined in kiwi::model::LessTilde)kiwi::model::LessTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    LessTilde(flip::Default &d) (defined in kiwi::model::LessTilde)kiwi::model::LessTildeinline
    LessTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::LessTilde)kiwi::model::LessTilde
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_less_tilde.html b/docs/html/classkiwi_1_1model_1_1_less_tilde.html new file mode 100644 index 00000000..62501694 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_less_tilde.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::LessTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::LessTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::LessTilde:
    +
    +
    + + +kiwi::model::OperatorTilde +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + LessTilde (flip::Default &d)
     
    + LessTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LessTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_less_tilde.png b/docs/html/classkiwi_1_1model_1_1_less_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..60dc2fdc26291e452e57a7c62ee96edfccb0df3a GIT binary patch literal 1147 zcmeAS@N?(olHy`uVBq!ia0vp^bAb2&2Q!d7ruFMHkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~;qr8G45?szJNMzV)vJWqy3cRD^#1=b zb1fx}UBYJcir6OcJ_>o&7Zc4Z>68RpUBnu|6d;eCoS#2xzo8bXAZw8 z(p+ky!NC8CNn+~6r*Z2W-?~k!-rbvRz9l9_yPy6}_!Ze7 zC_Z7ZX_0AYM@SydpEP?}rj)3fr_|&LlU4W?)jj3%o(6r5bXQq<_+CV*_xt@?B~lOa zj_^NGd8u4gpmX|zx}It=hr{?Pn*{6vnWnI z@%8`Wsk^O;pRcV`QH)ym`hv>oz;j;4eXVSJ*Q3-t-pStO!@TQyT`UlN9k=6J>ZTn6p(`G zq4`PQ%O<^ClT~^>Pk2sh2L+0&Ug-Q%mq}J{dPBE=`8Rn<_N`|-|Nl8*Jxlu5x8^x2 zwJ!d7EARFfXWeD0pAvoQ&YmEvck#OG&-_aL9D6laKI8TD+UGZ7?%Tgwx$WWXME;`P zK`Wnb^4ZqAq4m{nqdLB~jW(ILce+ULEV~i*?!wyGNojXJKiyKa_E_N@ty|}!w%2QJ zpZ8yS=NyIGV)Yu^mtW0{p6)f*A!ya9%9HQH^Ri#$ygqv>R`p1w`IIfw-_5j6%TDjL zo4nhmxV>b;rIj(M*;CI%D{Z?u>vi^?zPcG}Cw&pI|8sWA5>jW{3wvvJf=& zh3D~J<=uWiAzx?f>3^Y8&+N>d@1J0-IpY6hmD&C~LC=;=&ARs1`uzR+ooiyJ?Vfz+ z-pZP1%Ris^dYOS&92``i)`=e!TJ`?ak*A45)tOIjEoYSaRn-3cw(3pgyQd3Jd+oS+ z?w$ezum4Hi<$rXxx9M-+S}V2SVHqftA}6dWiraMW)Z99TU)t;iPt2exYvWq}c{`o0 w9IU3U&bhnn&bQAWb66!Bk#YqjbNy!y^q3R+Nz3#Du%uw{boFyt=akR{0Q%rEU;qFB literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_line_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_line_tilde-members.html new file mode 100644 index 00000000..b7b56820 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_line_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::LineTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::LineTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::LineTilde)kiwi::model::LineTildestatic
    declare() (defined in kiwi::model::LineTilde)kiwi::model::LineTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::LineTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    LineTilde(flip::Default &d) (defined in kiwi::model::LineTilde)kiwi::model::LineTildeinline
    LineTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::LineTilde)kiwi::model::LineTilde
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_line_tilde.html b/docs/html/classkiwi_1_1model_1_1_line_tilde.html new file mode 100644 index 00000000..a67139b3 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_line_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::LineTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::LineTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::LineTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + LineTilde (flip::Default &d)
     
    + LineTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LineTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_LineTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_line_tilde.png b/docs/html/classkiwi_1_1model_1_1_line_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..652ddfc4c7518e9fc1df04fec8c18ef8e2f22526 GIT binary patch literal 705 zcmV;y0zUnTP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0006|Nklz17$425@aE%W|wT;*m!P|vtJnNIgKyFdc*6N2Y2L_}N#QB`#m2}tlog1vrY zn}@2}*oO%}C#X-KE&SUA$D7Nx8wDos%HHI@s_G-XA&3;&x<*y?ph=_O!0A6VY09Uya ztgAPIJHZCvjNnheyFdaGkbndv0AP#+Bp?9^NI-($MzAc);wmg5gy1L=kYGe0=6~x6 zA%uaBpqVDypK+ZMw2m=B2q8Suh@d`wmg|-vTFH=lIh2C&B~z28#F3eHB&w0RVt1$h zoZxtF?PZG@GevdTQL#eM_}b=zpzL9vF$6Jok=E|PV8#6@d`^%G@0y^Qb5{p-UHbQE z4`y|6KAGp0*lI@5*1_p6e60?;It)QhHoFVvs$`1cUC1Z>jo-wZPt5;7aQBtvZzBnQ z48gK2i>CnKl~w?7l{>+@dLy_KYyi#({sg=WBp?9^NI(Jr#z;T{5|DrdB=~IvA|kGW z0Dz-NK!S!KH5TU*?FiOhljwBUcK>ijM*skiG$#OnP9<_n5N#hOnbd`Uf0x*#DRDH| zgDq^Q=e0SnUE2{H&#k>|F=NS4Ty|9RXV>8<54ZDd$P#qZ+Lvomo}1GiToE*(cLcG( zt_aeEAwdZZP9b(|zQ` literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_link-members.html b/docs/html/classkiwi_1_1model_1_1_link-members.html index 11736430..94135297 100644 --- a/docs/html/classkiwi_1_1model_1_1_link-members.html +++ b/docs/html/classkiwi_1_1model_1_1_link-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -70,13 +97,13 @@

    This is the complete list of members for kiwi::model::Link, including all inherited members.

    - - - - - - - + + + + + + + @@ -85,7 +112,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_link.html b/docs/html/classkiwi_1_1model_1_1_link.html index 0b497d59..697802a2 100644 --- a/docs/html/classkiwi_1_1model_1_1_link.html +++ b/docs/html/classkiwi_1_1model_1_1_link.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::model::Link Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    declare() (defined in kiwi::model::Link)kiwi::model::Linkstatic
    getReceiverIndex() constkiwi::model::Link
    getReceiverObject() constkiwi::model::Link
    getSenderIndex() constkiwi::model::Link
    getSenderObject() constkiwi::model::Link
    isReceiverValid() constkiwi::model::Link
    isSenderValid() constkiwi::model::Link
    isSignal() constkiwi::model::Link
    getReceiverIndex() const kiwi::model::Link
    getReceiverObject() const kiwi::model::Link
    getSenderIndex() const kiwi::model::Link
    getSenderObject() const kiwi::model::Link
    isReceiverValid() const kiwi::model::Link
    isSenderValid() const kiwi::model::Link
    isSignal() const kiwi::model::Link
    Link(model::Object const &from, const size_t outlet, model::Object const &to, const size_t inlet)kiwi::model::Link
    Link(flip::Default &) (defined in kiwi::model::Link)kiwi::model::Linkinline
    ~Link()=defaultkiwi::model::Link
    - + - - - - + +
    @@ -89,45 +116,45 @@  Link (model::Object const &from, const size_t outlet, model::Object const &to, const size_t inlet)  Constructs a Link. More...
      - +  ~Link ()=default  Destructor.
      - -model::Object const & getSenderObject () const - Gets the Object that sends messages.
    -  - -model::Object const & getReceiverObject () const - Gets the Object that receives messages.
    -  - -bool isSenderValid () const - Checks if the sender object is still in document.
    -  - -bool isReceiverValid () const - Checks if the sender object is still in document.
    -  - -size_t getSenderIndex () const - Returns the sender outlet index.
    -  - -size_t getReceiverIndex () const - Returns the receiver inlet index.
    -  - -bool isSignal () const - Returns true if it is a signal link.
    -  - + +model::Object const & getSenderObject () const + Gets the Object that sends messages.
    +  + +model::Object const & getReceiverObject () const + Gets the Object that receives messages.
    +  + +bool isSenderValid () const + Checks if the sender object is still in document.
    +  + +bool isReceiverValid () const + Checks if the sender object is still in document.
    +  + +size_t getSenderIndex () const + Returns the sender outlet index.
    +  + +size_t getReceiverIndex () const + Returns the receiver inlet index.
    +  + +bool isSignal () const + Returns true if it is a signal link.
    +  +  Link (flip::Default &)   -

    Static Public Member Functions

    +
    static void declare ()
     
    @@ -135,9 +162,7 @@

    The Link is used to create a connection between two objects.

    The Link holds a reference to the sender Object, to the receiver Object and inlet and outlet indexes.

    Constructor & Destructor Documentation

    - -

    ◆ Link()

    - +
    @@ -195,7 +220,7 @@

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_loadmess-members.html b/docs/html/classkiwi_1_1model_1_1_loadmess-members.html index cc766ea1..862eb047 100644 --- a/docs/html/classkiwi_1_1model_1_1_loadmess-members.html +++ b/docs/html/classkiwi_1_1model_1_1_loadmess-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::Loadmess, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Loadmess)kiwi::model::Loadmessstatic
    declare() (defined in kiwi::model::Loadmess)kiwi::model::Loadmessstatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Loadmessvirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Loadmess(flip::Default &d)kiwi::model::Loadmessinline
    Loadmess(std::string const &name, std::vector< Atom > const &args)kiwi::model::Loadmess
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Loadmessvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Loadmess(flip::Default &d) (defined in kiwi::model::Loadmess)kiwi::model::Loadmessinline
    Loadmess(std::vector< tool::Atom > const &args) (defined in kiwi::model::Loadmess)kiwi::model::Loadmess
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_loadmess.html b/docs/html/classkiwi_1_1model_1_1_loadmess.html index fadf94f0..266c36f5 100644 --- a/docs/html/classkiwi_1_1model_1_1_loadmess.html +++ b/docs/html/classkiwi_1_1model_1_1_loadmess.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Loadmess Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Loadmess (flip::Default &d)
     flip Default Constructor
    + Loadmess (flip::Default &d)
     
    - Loadmess (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + Loadmess (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Loadmess.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Loadmess.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_message-members.html b/docs/html/classkiwi_1_1model_1_1_message-members.html new file mode 100644 index 00000000..59eb910f --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_message-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Message Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Message, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const override finalkiwi::model::Messagevirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Message)kiwi::model::Messagestatic
    declare() (defined in kiwi::model::Message)kiwi::model::Messagestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Messagevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Message(flip::Default &d) (defined in kiwi::model::Message)kiwi::model::Message
    Message() (defined in kiwi::model::Message)kiwi::model::Message
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    outputMessage enum value (defined in kiwi::model::Message)kiwi::model::Message
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const override finalkiwi::model::Messagevirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    Signal enum name (defined in kiwi::model::Message)kiwi::model::Message
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &parameter) override finalkiwi::model::Messagevirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_message.html b/docs/html/classkiwi_1_1model_1_1_message.html new file mode 100644 index 00000000..465cfa4e --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_message.html @@ -0,0 +1,452 @@ + + + + + + +Kiwi: kiwi::model::Message Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Message Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Message:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + +

    +Public Types

    enum  Signal : SignalKey { outputMessage + }
     
    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Message (flip::Default &d)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    void writeAttribute (std::string const &name, tool::Parameter const &parameter) override final
     Writes the parameter into data model. More...
     
    void readAttribute (std::string const &name, tool::Parameter &parameter) const override final
     Reads the model to initialize a parameter. More...
     
    bool attributeChanged (std::string const &name) const override final
     Checks the data model to see if a parameter has changed. More...
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    bool kiwi::model::Message::attributeChanged (std::string const & name) const
    +     		+finaloverridevirtual
    +
    + +

    Checks the data model to see if a parameter has changed.

    +

    Only called for saved parameters. Default returns false.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::model::Message::readAttribute (std::string const & name,
    tool::Parameter & parameter 
    ) const
    +     		+finaloverridevirtual
    +
    + +

    Reads the model to initialize a parameter.

    +

    Saved parameters may infos from the data model.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::model::Message::writeAttribute (std::string const & name,
    tool::Parameter const & paramter 
    )
    +     		+finaloverridevirtual
    +
    + +

    Writes the parameter into data model.

    +

    If the parameter is saved this function will be called at every attempt to modify the parameter. Never called for non saved parameters.

    + +

    Reimplemented from kiwi::model::Object.

    + +
    +
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Message.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Message.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_message.png b/docs/html/classkiwi_1_1model_1_1_message.png new file mode 100644 index 0000000000000000000000000000000000000000..c4274ea92e569a07422ba8e6c4a5a67bd7ff5450 GIT binary patch literal 710 zcmeAS@N?(olHy`uVBq!ia0vp^jX>PN!3-q77gnqSQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;|Ar*{o=f0lwM1iA~KT7o8|6cR8 zZU-~eC9`MWi%he48*49mCSE{rCfAWOIU4E(P4Yr}{+KUadg9C}Ilmus7ObxKLW~TFeh*k6Xn(K5F$v#R2`7%WA|`bS!3jU6nku#!1Z0cc&G;`Ix}3A*=nRDx zfxJwYfbjWeOFbvNnW6aHD>%<*_8HH2le`v1&t9?Zis1TJbLI7PM6|G3C zHwpozR+Y{La}w>7IaJ=9-SUZtO?h4ZLrcf9J>OYYou4XyrSRwfYm#UFJg71LZX1~G zw&3pr5pMg>&FA=?7fe2zr6Z{C6n$dg|Bqi=6w~fbP{L!FvrI zCqfh$45k2mu5_aFNM-jmsqA+rZ0-cPGcas7QPP+lq2TdNE3NbF(_>%Crnm-850Mhu z()Z}Q%{JwX*Vke;+Qw^UP1Vu-m3X;gjoOJ82F}aJmD65Ms^eef89PI6x7UPuSJvI$ zc(%y-mzZC2`}PS&Z=dO(ThPr~SbEC;IlK7>m$j0O- + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::MeterTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::MeterTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::MeterTilde)kiwi::model::MeterTildestatic
    declare() (defined in kiwi::model::MeterTilde)kiwi::model::MeterTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const override finalkiwi::model::MeterTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    MeterTilde(flip::Default &d) (defined in kiwi::model::MeterTilde)kiwi::model::MeterTilde
    MeterTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::MeterTilde)kiwi::model::MeterTilde
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    PeakChanged enum value (defined in kiwi::model::MeterTilde)kiwi::model::MeterTilde
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    Signal enum name (defined in kiwi::model::MeterTilde)kiwi::model::MeterTilde
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_meter_tilde.html b/docs/html/classkiwi_1_1model_1_1_meter_tilde.html new file mode 100644 index 00000000..0ee78bd7 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_meter_tilde.html @@ -0,0 +1,347 @@ + + + + + + +Kiwi: kiwi::model::MeterTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::MeterTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::MeterTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + +

    +Public Types

    enum  Signal : SignalKey { PeakChanged + }
     
    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + MeterTilde (flip::Default &d)
     
    + MeterTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override final
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_MeterTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_MeterTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_meter_tilde.png b/docs/html/classkiwi_1_1model_1_1_meter_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..3cdc019d950c639373cda084917c38f22bdec976 GIT binary patch literal 816 zcmeAS@N?(olHy`uVBq!ia0vp^T|nHy!3-q%CpO0dDTx4|5ZC|z{{xvX-h3_XKQsZz z0^HD_H|4jNn>r{H(u}9M*L$3+}?GlUE(p>t4sp0n- z2D=Z7jn3!A{8?e+vuB4zP^U0Ufm#TI&O)XHPEiK$6$}whtOta&7^VdtD+WPUJhDV5)2TFEn;J!`zN!QNfAcUqZT$ zX=dPLBYMHK=R`&P>lpfgR_nqabionFhe=c7Cc53;n{lPoG{OyZR1G;xb zM@K{r$R9fy9@rT-@c&tHX0x=oy%xW)zFuF*BNoOv_yYkNKA(y~!O1Mtzzz+pMVmsm zUJpK=ykW~XxAYZutGx3+pK0VepjxF>X{tPR^V^72-P2Fqw%(~#JiTb!^0mR&Rn{Azah{5dm%7+GkCiCxvX - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::Metro, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Metro)kiwi::model::Metrostatic
    declare() (defined in kiwi::model::Metro)kiwi::model::Metrostatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Metrovirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Metro(flip::Default &d)kiwi::model::Metroinline
    Metro(std::string const &name, std::vector< Atom > const &args)kiwi::model::Metro
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Metrovirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Metro(flip::Default &d) (defined in kiwi::model::Metro)kiwi::model::Metroinline
    Metro(std::vector< tool::Atom > const &args) (defined in kiwi::model::Metro)kiwi::model::Metro
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_metro.html b/docs/html/classkiwi_1_1model_1_1_metro.html index 9aee92d8..bd046d65 100644 --- a/docs/html/classkiwi_1_1model_1_1_metro.html +++ b/docs/html/classkiwi_1_1model_1_1_metro.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Metro Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Metro (flip::Default &d)
     flip Default Constructor
    + Metro (flip::Default &d)
     
    - Metro (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + Metro (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Metro.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Metro.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_minus-members.html b/docs/html/classkiwi_1_1model_1_1_minus-members.html new file mode 100644 index 00000000..36f4e0d6 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_minus-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Minus Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Minus, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Minus)kiwi::model::Minusstatic
    declare() (defined in kiwi::model::Minus)kiwi::model::Minusstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Minus(flip::Default &d) (defined in kiwi::model::Minus)kiwi::model::Minusinline
    Minus(std::vector< tool::Atom > const &args) (defined in kiwi::model::Minus)kiwi::model::Minus
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_minus.html b/docs/html/classkiwi_1_1model_1_1_minus.html new file mode 100644 index 00000000..31d22708 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_minus.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::Minus Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Minus Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Minus:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Minus (flip::Default &d)
     
    + Minus (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Minus.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Minus.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_minus.png b/docs/html/classkiwi_1_1model_1_1_minus.png new file mode 100644 index 0000000000000000000000000000000000000000..1eb2ffed4b1522db03c09883afcc7abeb1ee7119 GIT binary patch literal 927 zcmeAS@N?(olHy`uVBq!ia0vp^jX->WgBeJQRDD= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0^*mi1Ln;{G&V9RWjRHqoe8Jj1|E=ww zs?VCX*}8g$al533^C5TE-`q+{p{$kf_b!rZ6#O&c!HN3?{{8oUyT$SRuyT~F{q`td z_{z-7`=lh*)}AW#&V9c({*pRNqmpO&=X<|hYqzj5H<`b8QtUXn((^)j<@>*@>{hZa zwVCkz;0CcpSF7J&|MGL@j~{>Q=Rf$Eeso{2+Xq7y7nfOF4E-g{456XwH_UQbN}FUI zBpv4;$U4Z;a{z=GI1HJT4Z!G!8PoGQ!J!suX|ASB$`XPTc6f0ce|E@TUa3aA)qOZ@DH-{fY(WEPYuU z+;=fHtXd_UGuy1m>LA~Oo(291TN7B^z=)wmqEQfnYNQ*B&#lywG2RRcc@q|ub(apE zvAJ+d^G?QpL*w(M7w!rg80)|6P}s8W@f`sc%bG=E?=SQ`d@S=lyMWXG&|0=rb)2s@ z$iA&w$;{DYm6xf?DJbk}cyhVU%mq?Pna^X^=sLz7wo@|Zl)UekeWCB_@ys>;97&I2 z1(uvSV_oDP@c8)uOHyY(EtuIP@p;yQ_xqGGwr^YCdNAiY$1IzaWs}cjIZpBN`@Bso z$okgOuiMWZnSM@8c|-nU!5RUeyEC;IY%cLKgoMsbxV=U23TGKZDoZWXYF22xF(@2? zMrO~0+Z-JoA)+h{U0Ez{1}Yu>mnu3Vti83(zx_V-MvaAG12FbXI*)oNHz~ARu9^`u z?^@u|!U+$A=DD#L2JxCck`lO5=&kM9F-@b()6Vouulr+`1*c{zoa0kaeEX@R;O^S_ zhwr?6FVwPlYw_$K`!;be3@rbb#=9$OhVYs~<$?@fqg^Kcm&H t!nM2qbnj+h$PWcM_lE+Ll9KOV=8zeUHk-7sS^{$ugQu&X%Q~loCIDIUlr8`O literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_minus_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_minus_tilde-members.html new file mode 100644 index 00000000..1c0bbf9e --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_minus_tilde-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::MinusTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::MinusTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::MinusTilde)kiwi::model::MinusTildestatic
    declare() (defined in kiwi::model::MinusTilde)kiwi::model::MinusTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    MinusTilde(flip::Default &d) (defined in kiwi::model::MinusTilde)kiwi::model::MinusTildeinline
    MinusTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::MinusTilde)kiwi::model::MinusTilde
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_minus_tilde.html b/docs/html/classkiwi_1_1model_1_1_minus_tilde.html new file mode 100644 index 00000000..2508f42d --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_minus_tilde.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::MinusTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::MinusTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::MinusTilde:
    +
    +
    + + +kiwi::model::OperatorTilde +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + MinusTilde (flip::Default &d)
     
    + MinusTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_MinusTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_MinusTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_minus_tilde.png b/docs/html/classkiwi_1_1model_1_1_minus_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..6577047eda94c1fd53c527135123d01eecb120cd GIT binary patch literal 1158 zcmeAS@N?(olHy`uVBq!ia0vp^bAb2&2Q!d7ruFMHkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~5%qL&45?szJNMzV)vJWqy3cRD^#1=b zb1klpUBTN7Tj{^7Hk*NgT&*)?-!^YJHQ2V?lejg7_6uf5ZG$Kv*`(`zk_ zR@~Wm`plW*$v3U;&0Jmo+;4MfuBq|o4>{3ZcCp;EbHs`u6OyGowwQ_f{YRQ(V2jcwT7 zA%DX2lKY&KZ({)>mBWHcx#25K)Rif&JdzTJo^Q>}j<3%~uVc<0wY_fMN9@3Sbb zKJoSc;;Fl>ivNb$PZH1#FM2!k^`@^MjmtgQHA|mrMXydd*R=fRto}ZguYWG*cgX)O zX`AzX?&tTlAH6T#S9zjx^6-nI%O<|fOdk~V8v-RG-+h(3k(aV_`|TZN&Zk|sG5sJI z63}4!qqZ}1*0R9FNlOelEj>R86is@PI2|QGJTIB%ez&RncWSq3`If)zmY%;ljCU?A zlVAS&uGBw`?NfGEr^-jj>8?NXYs1fVQejNFk2k%)V|M+tyX{r6eVo-3w7sfzr>Abx zJ#;PP{@ahm!I>u}Z)^U3&21g;?NhRCTfHwGd8>c-)K;nE7NObJ*?0dhy;Jos|4C6( zPV}FJF`ldQqNjV!bqHGJwLj&%_V&^_Ij_&2idA*lFYTrE^vfC9&0kY`?I!QGDQ+*B z5EQ;{(^ju%x`MZJ&VJpxH}9`OwCYREx*xMOJ(q)G`bYVmAF7!qpos6$Gxxo0qQSub ziAiGW#HVrV8{Yy`)$ZPG^DQwc+711fDF>mWvi+=umrxeQn!FlJ>GiSB0PRcoNW&hpkzfsCg>&el| zQv;T6j=H7B6>zFECh%7FP95P~#qG;}t*hLS=3=~JV)kN&rC*BL-*0VyX>s{sQO%yy zj&D`2vT8i#-1)RbzAd)L_U1J+pysFB^rl)ZRtQ}h-+TUv-}bLs8})@3J@r~=TYPkr zZPMMB#q)PMTRFTs6}qjA|Ju9f-*0jma3T5a;?p3n%z%IFZV_{e&M&&R0$6A;c)I$z JtaD0e0sti^Ho5=+ literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_modulo-members.html b/docs/html/classkiwi_1_1model_1_1_modulo-members.html new file mode 100644 index 00000000..9b4d9215 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_modulo-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Modulo Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Modulo, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Modulo)kiwi::model::Modulostatic
    declare() (defined in kiwi::model::Modulo)kiwi::model::Modulostatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Modulo(flip::Default &d) (defined in kiwi::model::Modulo)kiwi::model::Moduloinline
    Modulo(std::vector< tool::Atom > const &args) (defined in kiwi::model::Modulo)kiwi::model::Modulo
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_modulo.html b/docs/html/classkiwi_1_1model_1_1_modulo.html new file mode 100644 index 00000000..8247c666 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_modulo.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::Modulo Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Modulo Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Modulo:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Modulo (flip::Default &d)
     
    + Modulo (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Modulo.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Modulo.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_modulo.png b/docs/html/classkiwi_1_1model_1_1_modulo.png new file mode 100644 index 0000000000000000000000000000000000000000..1b823abba9e0f8233b1d75afbcde1ba193d0e12c GIT binary patch literal 920 zcmeAS@N?(olHy`uVBq!ia0vp^jX->WgBeJQRDD= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0)jeGtLn;{G&V9dau>#K#^@lQ*|IOoA zr!@Rnetoa+cI(__NgWT_*?x&CDXnWdBC&X}heMORkj~fH>z`P-@$tCM>^&YL&Cvw!~o@0@b~*M8VPkwxBFLFthuL&XwKhM1>*2EO+=-mw@r z7&qB7erMwJa9|Rez|deQG@*e-MS+oXU#~)oKuqg`Rj)LJCM38hJiA^M63V`6uA0xY z{=&CHTlx$eSH05h<=A$yzbIBnCEEB&*vnIMGbjC=%oT`SY#UpB{onzt^o z77i0$TgaOAQTOeyV0HsE|An}#y=^kj_lA10SAVx@#_?C5P420)?EK)z;gz~B|4G+^ zXXo!nXBUL9pA|VX<2g(1cS*FM%UrFFuAUp6ox9~cFOxqf!-HvVEU7~L9Fug{=@{?4GxJ=(kq4J& zxpR}+1{cZyjE=J9*`l*=$F5SHxHJ33dFI{XxtvBO3de3e%~ZP_^UG3(^SgQuXWrmE+=$j!nPydSl+%~tMS|L_Gwnf;P!?$Z!+|GUhF<#UCqdFPY;yB fgTe~DWM4f9lelC literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_mtof-members.html b/docs/html/classkiwi_1_1model_1_1_mtof-members.html new file mode 100644 index 00000000..0328f649 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_mtof-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Mtof Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Mtof, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Mtof)kiwi::model::Mtofstatic
    declare() (defined in kiwi::model::Mtof)kiwi::model::Mtofstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Mtofvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Mtof(flip::Default &d) (defined in kiwi::model::Mtof)kiwi::model::Mtofinline
    Mtof(std::vector< tool::Atom > const &args) (defined in kiwi::model::Mtof)kiwi::model::Mtof
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_mtof.html b/docs/html/classkiwi_1_1model_1_1_mtof.html new file mode 100644 index 00000000..1512598b --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_mtof.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Mtof Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Mtof Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Mtof:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Mtof (flip::Default &d)
     
    + Mtof (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Mtof.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Mtof.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_mtof.png b/docs/html/classkiwi_1_1model_1_1_mtof.png new file mode 100644 index 0000000000000000000000000000000000000000..eb26fb14bf02f80fc0b4247524d43d0b972f0e81 GIT binary patch literal 714 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;`QZ3tup&l_Iys!KdJoCts3RZwGVvuEta%@ z9}}*Axl6n@=4VZ3Y3S8rIm^A~)6Tkve(g$sy~g6~cQZ@psI8@WyF)_tE2nHfd(QZO zUD#){Evr_=eGq@Y@VW4R&F7!Lm;8?n4Bh&$dybM)E@QAE~U)o;bobr)WW3+W|x>_6SMwlTwqm15off_qnL?vFn8Naxlm?}ssEY0`%+Po7F#P&9X{hCt@l27KmITd&>EmL;y)jhq>(|^fX{hIYJ{oG;m z=>NLK=Paf7ov`FNd_k-sy@#Q<@}Onk+ok#z>Z!#qrO&NDdHWrU!6FP#LjC+eL~!CU z1qR=jz!0cwG`{o1cX|JovSqh|X0E$=MKfG~4#V~pmXDLg&l$bB_ww`|i4$TQT4wG~ zR9qwf=)IQT{f%{VEW(3V9W`=~+ynHY_B?aboU)ydc(fT#dhKMboa1#x&F{a_ZJyP= zd+$WYNBVzAnmc>X-y1V~ePk?8e~x*2RPuhIm?X<4ZTHIE)%Q$O{pT_~D^YLYy~~+! g*xOHV;!$ebSjO023aAr>mdKI;Vst01qcolmGw# literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_new_box-members.html b/docs/html/classkiwi_1_1model_1_1_new_box-members.html index 9c1f5694..cd674dab 100644 --- a/docs/html/classkiwi_1_1model_1_1_new_box-members.html +++ b/docs/html/classkiwi_1_1model_1_1_new_box-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::NewBox, including all inherited members.

    - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    declare() (defined in kiwi::model::NewBox)kiwi::model::NewBoxstatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::NewBoxvirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args)kiwi::model::NewBoxstatic
    declare()kiwi::model::NewBoxstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::NewBoxvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    NewBox(flip::Default &d)kiwi::model::NewBoxinline
    NewBox(std::string const &name, std::vector< Atom > const &args)kiwi::model::NewBox
    NewBox()kiwi::model::NewBox
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_new_box.html b/docs/html/classkiwi_1_1model_1_1_new_box.html index 1371a86b..5ab2a9bd 100644 --- a/docs/html/classkiwi_1_1model_1_1_new_box.html +++ b/docs/html/classkiwi_1_1model_1_1_new_box.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::NewBox Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,236 @@ - - + - - - - - - + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    +
     NewBox (flip::Default &d)
     flip Default Constructor
     flip Default Constructor.
     
    - NewBox (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + NewBox ()
     Constructor.
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + + + + -

    Static Public Member Functions

    -static void declare ()
    +static void declare ()
     Declaration method.
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     The object's creation method.
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NewBox.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NewBox.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_noise_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_noise_tilde-members.html new file mode 100644 index 00000000..dfc6cb6f --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_noise_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::NoiseTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::NoiseTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::NoiseTilde)kiwi::model::NoiseTildestatic
    declare() (defined in kiwi::model::NoiseTilde)kiwi::model::NoiseTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::NoiseTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    NoiseTilde(flip::Default &d) (defined in kiwi::model::NoiseTilde)kiwi::model::NoiseTildeinline
    NoiseTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::NoiseTilde)kiwi::model::NoiseTilde
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_noise_tilde.html b/docs/html/classkiwi_1_1model_1_1_noise_tilde.html new file mode 100644 index 00000000..438d8fe8 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_noise_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::NoiseTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::NoiseTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::NoiseTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + NoiseTilde (flip::Default &d)
     
    + NoiseTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NoiseTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NoiseTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_noise_tilde.png b/docs/html/classkiwi_1_1model_1_1_noise_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..1fb30b2a59972e3c29b4504d41b4cc11ada60c11 GIT binary patch literal 797 zcmeAS@N?(olHy`uVBq!ia0vp^oj}~d!3-pyEVGCMQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;XLn;{G&dr^?SV4eo_C~GG|Nnnf zU38*(hG}88^V76`yExfsnKR)*UYQ&o@7^&BsJ(mVHDkwa?fh9bMYZduuiNcisr;f^ z?dYQykM}8;CZu$4iF{U$fr(Ftp_fEf{(%(u=zRLQjiuy+mwYO7t z|JIJNwU$3O`B(KNTkFazcmLY#|J?g`s>J=&PuljeAEV#ATi4RLd$-XPPcO}0h6Aa2 z49*5UC*PWNoib1>pXeBJ%&>Da^93O_2Co?m8i`B`S~weUaB60sH1WMGU@&tgufvQP zGc^;F(w2Sk3Hn-Zo0N7farT;NOMl0kZsFe0Uy+lPR@ODobE8F9>8%vK>?L=imVJ8i z=fciY-p}H;=5U9kof7STc<0~El->22x~YA8ZcJIYYx}gTF2}YQZC+L4du?y7^6aIn zY&hfJdp_^_od3LZ@|*?deN)cfw9&l&yngw&CmR0W^51;z3GMSS@h?k%9yQP8XV$c` zr!U@wxMy#CId85iv)zYY+mD^U?)#jp+4^|d&m+wPt3-_3+Aab>CV1|4WAj%$?IBbDrrDU@v<*_f5_n9j{r0_jYj@5sps?V|4DUO4PES*B mu53d;A~tzaCk1&af8dui&0AJe?b8QL%M6~belF{r5}E*i>17ZA literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_number-members.html b/docs/html/classkiwi_1_1model_1_1_number-members.html new file mode 100644 index 00000000..3b16d3c8 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_number-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Number Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Number, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Number)kiwi::model::Numberstatic
    declare() (defined in kiwi::model::Number)kiwi::model::Numberstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Numbervirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Number(flip::Default &d) (defined in kiwi::model::Number)kiwi::model::Number
    Number(std::vector< tool::Atom > const &args) (defined in kiwi::model::Number)kiwi::model::Number
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    OutputValue enum value (defined in kiwi::model::Number)kiwi::model::Number
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    Signal enum name (defined in kiwi::model::Number)kiwi::model::Number
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_number.html b/docs/html/classkiwi_1_1model_1_1_number.html new file mode 100644 index 00000000..b18455db --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_number.html @@ -0,0 +1,347 @@ + + + + + + +Kiwi: kiwi::model::Number Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Number Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Number:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + +

    +Public Types

    enum  Signal : SignalKey { OutputValue + }
     
    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Number (flip::Default &d)
     
    + Number (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Number.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Number.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_number.png b/docs/html/classkiwi_1_1model_1_1_number.png new file mode 100644 index 0000000000000000000000000000000000000000..2915b154cbb2c3c43db53fca41b098692f38b270 GIT binary patch literal 735 zcmeAS@N?(olHy`uVBq!ia0vp^RY2Uq!3-qj@A4l3QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;U2N3nNje)=U6JGFVyVzh8BO1KfG^JvNi ztz~QbK6%7_eAoAtt%~(o)TReo4~xTZM&&r>|Jvrty;tV?y{W52${wx1Q<{AAWaEAJ z<7=$k^PkBav(oRl@4efut5mjyJ9FDr!7Az3T8HzGRZUM>6?8MOO($3* z*1NU-MSpqu*W%yK5TFCMz5u#dkEvpv>-GDoU5!IUM*wD*myS=$v|PQM;_v;CdGS^S-i-2Jfte&Tl2HZtRu}%~9uTvsQ3C zH08oAzvyLp`zEbE`>MuHaxYV{Ze&FCFP?o}*S>9>uB3lD_>%DZ^1U+QnYWo&mVJG^ z<=Un_4}?p0@NCcAWs2PJ`PmY;rmf+g?j6G#wz@W4 zKYV72!c^JR3dsdiJeXSF8r8%sVR#3Mty;M44$rjF6*2U FngA3>S&sk! literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_number_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_number_tilde-members.html new file mode 100644 index 00000000..9e2a576d --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_number_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::NumberTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::NumberTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::NumberTilde)kiwi::model::NumberTildestatic
    declare() (defined in kiwi::model::NumberTilde)kiwi::model::NumberTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::NumberTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    NumberTilde(flip::Default &d) (defined in kiwi::model::NumberTilde)kiwi::model::NumberTilde
    NumberTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::NumberTilde)kiwi::model::NumberTilde
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_number_tilde.html b/docs/html/classkiwi_1_1model_1_1_number_tilde.html new file mode 100644 index 00000000..67200b02 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_number_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::NumberTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::NumberTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::NumberTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + NumberTilde (flip::Default &d)
     
    + NumberTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NumberTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_NumberTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_number_tilde.png b/docs/html/classkiwi_1_1model_1_1_number_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..c7aafa6853d804f307b573902054d4aca8490adc GIT binary patch literal 837 zcmeAS@N?(olHy`uVBq!ia0vp^Q-QdHgBeKPG>NnTQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;HkwgC@Ac#_($|Mq!F z2W})3c{x>QxrOKR-Z&wxd{A3S>7m1!Gffl2($efMojP;oxO-TCmge80thCr_>o4kI zS6}EH$&bjjR{0(q%{u*Vb;;?CGjDdsB!`}vw(a$qGjY!r?UjmPt!TQMrPq)V_FK_- z^Yxv}*qEP&{@y2b?Lp1eGjBrI)ohQKczJuR-k$|^53k=m^Je`7kZp&eIy+pLA1LK9 zJmknM-R*jXE3*VGMScxDL1@ zBp?4?yDW3op@U0SN%d?A3jI1UY}G2eb8DCU+`o6xDyszPoMk8fuHRY0Q6TnFT{|>X zTzPd?iP&r1)t9cV_uE-dtIW!l!AR~9dw8Y;HA zYNc)T?X0V@udPF`+WN1#_V@n!MOwbqn?iPnH(TGUZdxCG_T=9?t7d=pi@O@}+5URm z+^1JRuB@B();2w?HcmF{!>&EIp6*&Db1Rb9Om)``-t2;tLZMgZ)&I&X-_LaU)c>tN z?(aLdYSn(%sFkaJab%nNUKZhP=-$EDqP*nlTd_dxC0Ap$7KHh%UgOB1Pbe&40rh^n zkRT^JlRytN#8zFsv$e~=bo;@olAZ#o6)U&o{S?+_00u?TlTBHA|1v^vJuX>xv*oL~ zZQcDnbu)v`{mOiO#q^rcs@=QS1*&iPSQa+h+cqkS^R{02w9IqA; - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,42 +96,64 @@

    This is the complete list of members for kiwi::model::Object, including all inherited members.

    - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + - + + +
    boundsChanged() const noexceptkiwi::model::Object
    declare() (defined in kiwi::model::Object)kiwi::model::Objectstatic
    Factory (defined in kiwi::model::Object)kiwi::model::Objectfriend
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) constkiwi::model::Objectvirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    declare() (defined in kiwi::model::Object)kiwi::model::Objectstatic
    Factory (defined in kiwi::model::Object)kiwi::model::Objectfriend
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const kiwi::model::Objectvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setPosition(double x, double y)kiwi::model::Object
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_object.html b/docs/html/classkiwi_1_1model_1_1_object.html index 6f15a2d6..42b9a9e9 100644 --- a/docs/html/classkiwi_1_1model_1_1_object.html +++ b/docs/html/classkiwi_1_1model_1_1_object.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Object Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    +Classes | +Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | @@ -84,158 +113,549 @@ kiwi::model::AdcTilde -kiwi::model::DacTilde -kiwi::model::Delay -kiwi::model::DelaySimpleTilde -kiwi::model::ErrorBox -kiwi::model::Loadmess -kiwi::model::Metro -kiwi::model::NewBox -kiwi::model::OscTilde -kiwi::model::Pipe -kiwi::model::Plus -kiwi::model::PlusTilde -kiwi::model::Print -kiwi::model::Receive -kiwi::model::SigTilde -kiwi::model::Times -kiwi::model::TimesTilde +kiwi::model::Bang +kiwi::model::Clip +kiwi::model::ClipTilde +kiwi::model::Comment +kiwi::model::DacTilde +kiwi::model::Delay +kiwi::model::DelaySimpleTilde +kiwi::model::ErrorBox +kiwi::model::Float +kiwi::model::Gate +kiwi::model::GateTilde +kiwi::model::Hub +kiwi::model::LineTilde +kiwi::model::Loadmess +kiwi::model::Message +kiwi::model::MeterTilde +kiwi::model::Metro +kiwi::model::Mtof +kiwi::model::NewBox +kiwi::model::NoiseTilde +kiwi::model::Number +kiwi::model::NumberTilde +kiwi::model::Operator +kiwi::model::OperatorTilde +kiwi::model::OscTilde +kiwi::model::Pack +kiwi::model::PhasorTilde +kiwi::model::Pipe +kiwi::model::Print +kiwi::model::Random +kiwi::model::Receive +kiwi::model::SahTilde +kiwi::model::Scale +kiwi::model::Select +kiwi::model::Send +kiwi::model::SigTilde +kiwi::model::Slider +kiwi::model::SnapshotTilde +kiwi::model::Switch +kiwi::model::SwitchTilde +kiwi::model::Toggle +kiwi::model::Trigger +kiwi::model::Unpack
    + + + + + + +

    +Classes

    class  Error
     an error that object can throw to notify a problem. More...
     
    class  Listener
     
    + + + +

    +Public Types

    +using SignalKey = uint32_t
     
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    -virtual std::string getIODescription (bool is_inlet, size_t index) const
     Returns inlet or outlet description.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +virtual std::string getIODescription (bool is_inlet, size_t index) const
     Returns inlet or outlet description.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    -

    Static Public Member Functions

    +
    static void declare ()
     
    - + + + + - - - + + + + + + + + +

    Protected Member Functions

    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    -

    Friends

    +
    class Factory
     

    Detailed Description

    The Object is a base class for kiwi objects.

    objects can be instantiated in a Patcher.

    -
    The documentation for this class was generated from the following files:
      +

      Member Function Documentation

      + +
      +
      + + + + + +
      + + + + + + + + +
      bool kiwi::model::Object::attributeChanged (std::string const & name) const
      +       		+virtual
      +
      + +

      Checks the data model to see if a parameter has changed.

      +

      Only called for saved parameters. Default returns false.

      + +

      Reimplemented in kiwi::model::Message, kiwi::model::Comment, and kiwi::model::Hub.

      + +
      +
      + +
      +
      + + + + + + + +
      std::set< std::string > kiwi::model::Object::getChangedAttributes () const
      +
      + +

      Returns a list of changed attributes.

      +

      Use this function in the observation to check which values shall be updated.

      + +
      +
      + +
      +
      +
      +template<class... Args>
      + + + + + +
      + + + + + + + + +
      auto& kiwi::model::Object::getSignal (SignalKey key) const
      +       		+inline
      +
      + +

      Returns the object's signal referenced by this key.

      +

      Throws an exception if no signal is referenced for key.

      + +
      +
      + +
      +
      + + + + + +
      + + + + + + + + + + + + + + + + + + +
      void kiwi::model::Object::readAttribute (std::string const & name,
      tool::Parameter & parameter 
      ) const
      +       		+virtual
      +
      + +

      Reads the model to initialize a parameter.

      +

      Saved parameters may infos from the data model.

      + +

      Reimplemented in kiwi::model::Message, kiwi::model::Comment, and kiwi::model::Hub.

      + +
      +
      + +
      +
      + + + + + + + + +
      void kiwi::model::Object::setHeight (double new_height)
      +
      + +

      Sets the height of the object.

      +

      Height will not be lower than minimal height. If ratio was previously set proportions will be kept intact by changing width.

      + +
      +
      + +
      +
      + + + + + +
      + + + + + + + + +
      void kiwi::model::Object::setMinHeight (double min_height)
      +       		+protected
      +
      + +

      Sets the minimal height that the object can have.

      +

      Will recompute height and width if needed.

      + +
      +
      + +
      +
      + + + + + +
      + + + + + + + + +
      void kiwi::model::Object::setMinWidth (double min_width)
      +       		+protected
      +
      + +

      Sets the minimal width that the object can have.

      +

      Will recompute height and width if needed.

      + +
      +
      + +
      +
      + + + + + +
      + + + + + + + + +
      void kiwi::model::Object::setRatio (double ratio)
      +       		+protected
      +
      + +

      Sets the ratio height/width.

      +

      If width was previously set. Height will adapt to ratio.

      + +
      +
      + +
      +
      + + + + + + + + +
      void kiwi::model::Object::setWidth (double new_width)
      +
      + +

      Sets the width of the object.

      +

      Width will not be lower than minimal width. If ratio was previously set proportions will be kept intact by changing height.

      + +
      +
      + +
      +
      + + + + + +
      + + + + + + + + + + + + + + + + + + +
      void kiwi::model::Object::writeAttribute (std::string const & name,
      tool::Parameter const & paramter 
      )
      +       		+virtual
      +
      + +

      Writes the parameter into data model.

      +

      If the parameter is saved this function will be called at every attempt to modify the parameter. Never called for non saved parameters.

      + +

      Reimplemented in kiwi::model::Message, kiwi::model::Comment, and kiwi::model::Hub.

      + +
      +
      +
      The documentation for this class was generated from the following files: @@ -244,7 +664,7 @@
      Generated by   doxygen - 1.8.13 + 1.8.11
      diff --git a/docs/html/classkiwi_1_1model_1_1_object.png b/docs/html/classkiwi_1_1model_1_1_object.png index 77cec6170b25e2f588180bbca15c76d80614e3fb..2f8278fe632661fc7347a8ea9a65d4adb7a291d3 100644 GIT binary patch literal 17825 zcmdUX3s})KjBTCG z$`qL^OH#X7C<;_g-691u#8M!03Zh5~NP@us!^K-?&;S2C|L2_FQ#?=4*Y7t|_*`D^ z_v`ZM?CxEDix%1~G&3_>^z~O?>@_npk2Nz}@Or)lctYsjQ2{Q?ckc}RQm4~_FGYij z6vCtL!B>Vq4<0<2bG8ctZs#ZO-4$R4zDfV$JPzDwX7=TVufNzHc-&mVll=J0zLGiJ zo6g=E(w#?~{j_-BA!YjhHgVbi{6uhq%Bp$ey+^mKjQli2q_0Mmy zZTbwG>1n-!U{l{`A5j?&PxQd?=e;2*bBfX{v2B|l`FC&wm?g~A6On~s4D<1hP9J3E z8_Ln6`;NdxPBHSvwbbNsH~H9erK>z{Cn-O-@o-G!Pxwo%gm#g-_g6OMGTC8!C0EqT zNXnd*nm4y&aCFc7oLWiMM?0BMGO8|8g((N>Sc*0Ih;X`D76h9Xo25&{E2TDeFA3{5 zJ}{&NqEyF&IfQAC-32JT=3DnfU6^ zIo~;zL_%xO*5^)qvztYYMmm4T$BimJ) zf__0)R_Z5UHMBY|5jO{i{W_&qnN9EB=X}@wvJx%3eCxMJr&VETyK#Xe+qL5rJL_U1nYv@JNj;3nY%Eyc+qTVNU&cCyoV>u9vI;WfJ#~yG~IZ)%P#L*Oj zH?%9ElsI1XBiqAkl+EE`SR+*Ut64JvuvBbHZJ}ll8Z3pR1jX`S{%b4;8*2EFBw%l z8xh@!5C}hRD-ug_v*nKto2OxqsU@g9y8TrZHk*GMR*!OCrCVtnW{AtGo|d|Gx{W22 zc2RSBr3y=wZwOb;S4BV8TJhXeb1{lfpVjkHLziAV6b%dYl2zoF3Vz#E<{Ij@hZK}n z5nmPe%VFpq%{_1O+;vrP#Zwo|AyL%wGu#E=5=L|8#%9m`>OZ%Pr*Pvhe`Xb2zQL;A za?UM3^H@&)jj1ILR=UWi*gBWnyMmL~mzx`vBW1`gLEvO+tKW7qjAJ9OR^~s3%z>iX z{&i*a+74Tq?3@O`OwAL4{qR7!cIWuP83P>){ekNfNE8PY+rq~asy~r5caENOt`aBU z&2gEdG&AE63)W8zF+RM+vm^)|HqZs@MUlAi^1YavJGP;UYn^^1hoSpzai2T6%32Q; zZms-;>neO$hEROWF4MJXch<1W@Ii)^qCno9`FVaKm&1H0^KjWIGlLCOo+lAl4qBBku6QPo2q$}xG7-w2!;e6oz>$J< zrO?~3>o5SC2qU&=gpTjSnol6jSo3g>P?at!@G-6UaU9GR)3r;d7FK-FGqiu$>mUQ! z^l?w?fsO;wF7Q)Y+iS;7(!bRWz?|?ce8?ksj*x4@pmN1K5<`OUk>Hyo>o!$_eN~UX>eY0&P zHm8j!E*leo>Tb>}Rm#qGuAphJi%a-6p$cT#3?Q1;Nkp!|EI-qoGOMFRLoyE~nSb=(X(#^z zmL%5t!tQN8xW_D1ap^iya0{!%0SVg$UDw!UX}G)R zI?oEbykBP|Ua1mNWZw_RF2W^6-7W=1(F`h!R9=%{b^pXc?|D&=a9wi)WCdb0&P?8$ zkGDumI;I9IpKH6Y-1$Bu3kDzGTr9NY(qe1}HN}Lco(0iw6z zWTnc7DAU(k49(Z2*cJi`M}(=P`RQB3(sxawdLfr9wcloIXUB3h>#D?Bs3bg=!x%~z zdXv|@_4(e-daIbi9xkoEU)sb%SZqes(f?3hmo90mQHat`1mnt_LHyQm-#b~XrJs^cCi7rBIuSA4ve>&w%A(FU6-A_#=ba5a9~R-cX}VB9pHGY#d&aFl(0S#yy{js^d0#UZ{L?&XN)IHX*3^e$ z7FFF|Ic}y&kC!)>?6ywp?Cr;Ap7-~&{E=xrj*03Dt6qcfUP8t9@3yvgf{jDGAz)WkKq<*P zEyWjHRS)gT9X5-f-c}KjtzKD?m96;2npW$2g<(<--@EwprLoxICv_1el|8oc^0BUY zK4k5VneF$~9U#hjnzYLdTLs^=&2iJVU%V}5uiLb(_`iSA7`nMnv!DyNk?A{UE(xL; zZeN`<>pE%^vTkTqBO{NcIlelD51SXNxN*N2!n?tCx9dsWyOr`m-IKP&#v;C+ocW6e z9<;4xsmmCO6*H(=3G@D&$0&XvUb?!N6|mbnHv#(GeLT3nWrzIL(~}Vje?9!akzv@ZDKf0r zBd{YfP#-=p6bk~jK#(O~f?Ejq*zuMKQX}u~tMtZ9#(6N@4YwMeMAEOrI62$iTH@!kvsbOVJjIg(( zDi)RP=PO#v2(>u+|uDV!Tx+LGS$09lME+B-fi-U9nGx`10o#@@<3~6t1 zhRtWL>>^fV5HGf9jt>xkU;(N`B3fo&J!FfyjOwW>xE%9mit{elQ7_L@{lG7cq_3x+ zk~P^7gLy+ZBW1uzk+&;LfA$OcjV#WHD-ts8Tk-=bm@tuju3Oh*i8f)BwzCaF3IPw- z$rY0E!P@;EYlfK5XzMpC*#m1!#Z*&0C<^sxEKCp59`Y4bwo>9BtG3n*`|Re4d4}c{ zC`FtXt!}Ci5yyZyhZex#cHm8QK?|$HmqUuVZdh}gwo05TU0AL%afkOumzX~t^szY* zcqOJy&zFNpItYOJR{(LmkmH$KccO)WHbCXcqgXa%Ki*3I1j{S9|HF~bwtVD#zJl&3 z8raGasF#Xl;hg#dVTjQ=fG;QK3`<9;;(%qU59Lo(-}b)=F||w46YY{lX2)Amj%oYn zvAimC++FXk?F4SEFPU#@P(z*c!UPq+JQ7kUY%OES^^`ebCUQ>Qy$=kbtwqwbSjcD_ zo3}bpib;y)lwz#F=kNW7#L_7Nz=O(K_oT7yiBWyaTcN?FZ_Q8*CJTCFf*^8}0Own6 z`K%X6L65f-UPgqU%kTL)KhPbE6xrt~0wez5F?h`)Vli0u?vC>D&9I)#lQ8R!)AaDY zJfM&E3?J{hC)77U6Ow3NO=g-Ur-`PiKgwGzQrKx?b~Ke%wz?bjH>5#-vwXnZdyH0J z<+Z+;OANvR*7N?ASm}akB^J6;*OM0rk+&G=epZgg3W{3$Qxmp0%}Vg>9p)L7{vbdFQ8&>C~}UNb~> z$p16BJXM9Yf+C@!xG$KV5DB`7_T=)mp`fSeHqBCe;`!0CYe8Oi?4B z_bPxZDljTX)_7F|%g>(tXp?BXb{{M#g!0BZe{oiX+B{SNA-`utEo?ebyCdrn0*S4e zWYCOM6#zhQp^FkdKQ9d1$&ocId1aW01aFpwZKYDb?%rxHgON}Bu1Z*CFcFT#lKC6v zz;>TInu6qrpT_;PA0MpPo?Rr^g{RazUq}rNZr{#z3OFElUfq&Zc^T^DfkzfQ#afjO)j{Ok{8WvLOJ=#*#1YD%|Y z&>iooDV>#Z7MMuK`$Jc$dq}J$BXyf^o{8ua_dcysF2_(SFoH~WQ_pa9Ji~cHTMYp` zi?;t}qwKn5MLCt{3AaMyC7r-4z}&A>ugeVefFK&1<*(j#yLo&hzuKAVpOvynk2Hz;grK$_bMnbGnH3};#Nod1zax$Q>!U!U%gPH zI}OwD7T4~4GjJ6@*T@H~Cwo+~8|EHA+&RUU%uM*Q=Gt>T1xvdb;SoqNcB!6D3-qLb zm$`_!BVQV&x*~R=!K=jZY4*ny|I$CCZPaV{1G8`WseLS}ye&QCs6hXB^QjEwyGkSjX%~&IN?CK@I=26 zI##t@6jb&ADais;w}EjT)>dj{2A-`ExAdJU*`*)zD*D4cn%mYVV5}fOrWD^HUnT4Y z3L95DOC?Y9JQ9CX>^h;`*-qMG96OEF+hXtq(#whqJqgD9?wdHC-h41=NSp(D4XLxT zTLlfTD1&igwvn|>GY5I!W*;-G z@ur%sKj<+>ack^Rb6&6ze+VBh+TS}(Fjeh%QQi7#ToD$4d*{ zqpS;#IKqKA%10!F6wLCXwOYlaSH8@KKN+WC4uqx%Z0bZu3N+Gu=9napn%osvfvH|| z#AOxPa=^a4eTbF0yn^^Grn+-i?xSC~LU`-lm{GFs-lW_yP_^981Z&c!VaiO$KE}gGmFS4d={-t=|WcTB)c^;)%q%GhAuJ66&5z+c4tgi||u$}l5p+_V{ylBD$8d11hUZnv&avF4tZTs%_*}R;0j3Uvq*r-1lu#R!pB1M!l;$=rA?L2C2)jN^FgbKiBzn zZ`XmcBA24|r3N7zI=E4Otg=6tjL4KYCZj3|8CRbT~s=g>yTeNy z&e+3;%iW@|{TI1Cr&>BSv>?2wnG|B;2|DARXzLj&&XtVZW{&)-3Xocrt5`EpcG}%L zDub?=&WQ0jIqn`;bh|>X<-*4gq8FIJDS(}OfjA$ED%JHQ<=((tN-y1ie9fwybAAI+ z`J{ZTKP42WQlZ1=t(TTk#S)XRym!aLJ*dPg?T^lAE+HZ(d>@xRpuSOoaTgWnWQtd{ zzfkemO-BX}GVf)`sMHq=p)eL$?ww~DpKCvtCr3misJ9!0QB76yIZs*HIP)AR42*4+ z4){*sdER%&E$3^0gWO!uxudDh0g}ugl4|~#(60Nr(8DeI7=^srQ*@v<<4C5JGl{DV zh)_fWN*z5#qNmLdc=+y9YTNq70(==k-8&-OX7W5`xP`dCEvGDLsBwH;jScobox&trtl(1aL_-$aw&b*x{DneXgd|&X8dl&d|NDv0`n!+s_tk#*7mS+Yey><^j=%fO0t{`?`KoR1$adNdcA9ac2z2^D zOKwVZ=(=6Xnw2c%gEypM$9-3VctZ)mg$~gixUP!N4%S>Xln`YMdYrGr9fuY zhOi=ZrNYnLn>%EGzjEFX`fBtaEln!bj2#+7M4%Yda%u;EA*PQu5TCq5^?Zt2|7zE-naV!?uYV#HA;v)NQ?Y@lR%LGf-yr zvekJYTeSk&>WQd8k%<#>(u%1O#$DF^ba;up{a`@E5fk^NzLvtERUATQr){n!_E+ z2hymv-y!hVAWZ;59Z=eMW-0R@dRc^d#S6q%oil`=sWqt%cZwdk$`3s|^!n9HjE)Hn zQSPPnFEVAEl5H>QGfrL?gz=Pomz(h-1uYPbfrI+5Rs_=S)uz{ml?cC#ic||_1NgYH zFRxcP%IAQ|Sifhj@{tpFTsdl}e4=P1R?V zt}KbbB^9A=>|ejiwrT7Fg*|}1!I!6k+JE3ZtNk(CW&~~oXd<9{YmIdU+2vbE(ercT zlz=3$Axya+@zPR0wwXCxhLC?|YL6)k3{dnO<*e)W9{HF}UXY$$3$4+l*7{Zo0*N=+ z*2Sz_16L2mpZ+U;Uh9Uz-XUxGF;EloDA@pc+)a8&xxpmmIk^du4Vzvg)+qG!oTaLF zD*;hIV}3|MET19VzN5AsA!{<~7pYua%79dmwO#X!gFTv{&%>YziJmoA!sZvboWC$S zZqUtrh!sWB6ii`EjhFy}ttO-B5xoeM?fdd>qJRQChnG|_ zYZ=B~Wrfv^tLKr7shW)bi@_ahW8^%&Nu&yJd>l_G=Ef(JbXF5!WAKMwgvSLto)ZV) zW><;v5$_qYx4eby7%m}gFHK@(e5&q*g|tS{%08~iemVAP%VCzuh3g&fd&w*hgpBIh z-j9ERaPS58WH{LUlnZ4qt}D#P<%-Qw%36wGs9gk^3wOP0Nh`XudN8iPdi@67dSiaI z4KzS^Bfr64Yz>Q-*QX0s(4K}Xi~(WVy<#9EP7=H?qx6y!2*(`HOe8lyEF)lJVmbJ? zqM=i=$2%%`=S>&9>-!NYWC;2ibx2|$*eVxP36+EOA#{E%o}LsFIjB71hBxz~689^j z(2HiK#k?#0cp1?WpaG?wiQMA!5`{o9%G*VXF>f+c;sQW~eDz?cosH1ek2^=Gym!#l zdB#l2t6<<&<8cSzZUyi^O~wN~hp!FpYq}~%(A?!>BZA*GAox(!7D8xUGdo{aW{o`v zCZKd`$Y&}Y@8|^JrY0blCS}yx7wLBSwcUfD)t~F@syTGX%LC4^Rn--)Y;pS4S(bSD zj&Oy?D&C1m7DA>TnR5kx=gqI6rCecbDPvPfR6QM7=5j0d;~gT!+8~Ick?rm6uv>uLN|bWlKdzh?zh?K4?GZLxqmlQZjb#Z-f}ut=0B9D2K%+-f|J z(9S0B;bIe>By;j$<}>^G;kuK8$V|)uygo0#+( zZ;FvkyA|9CeXo8pwB25RG*R1UAE3F)N;kz+r6l0Hp(auQvkk`+z`!E~KU;tR3;;*n z#L1SaF1%HTgdC>l-d!{UqzkH8~kqtts z?U`iRz=t|FBhV9_Cd@R7!x`C_;vX%ddwpg9e%|JuA)U(M^p7ZP$V(7kGoXMjO(RHC zw!%B?SW4SXe090BL|yXqm{0@L-p&Y#3x-jnKWNVcpL4jMv?p+2k zqlaVPyv7j2PTt@GmwkU2p-_U{*a#E(ynK!N1b;5r3*%~bj0Z+wf2Gf802&4H7OYs;|Inq2ef|Fq5M<_{%FQVDQEEkY6cG z<)+u)c)mS#Y2sbVk9;?=(c@^uKcD_~TevT~zCImrbA!^f>mTyei>sH}hnH*S*;4;u)s z|2*ziT+*rDwP2e_NG{(v)^ff>viWu8sAKGcg#Jp^!EE{xeR0OjqX{O=19+%MOZ>oH zR}3f^b=zaA#AVBRFCVf1)>|bhpNI1-gDcJ1WMdf2c#Kdib{c(?9exIkIglzQkNM7Q zhTc(Vf={yu05nBEk=$zgzU}(hQ-bcX+8cN{bLG`ZNdedy>-&79^#v%vU! zeNtKy_ON$RQ@Zc(-_XP|G{~4J~$Ze*ttkP;=^@`AG_y_27hhu zEieP6^KxM|SA!MGXad|JmUP;wBDH zv6-9Oa|p;1v_rN&2LK;AeCZM)I0Sv$uZejJP=Y*=>4XDPcI!POWzAEhET2|ChEUKU z(yPuCLoORDf=Ks>K53{f{Hi4)v5_|%d-=8@^defUN@e%9S(nyQyZ8j0Rhwza1PLzYD$?t8n}s;$dqz z#yoKX8#J!(Xb?uaXcCC(23NJ<5gEaXQWyw#-WVe37} zaOUO|EW!&J$tZ-YexnQz&CJ~~l^e=Gb}z9x)r8{^F-amz&I_Z)@1cu*9YEeeLJxv7 zv};MF^Li)j{&_o^s(u6B7lkW=^xd6=3Z#$ms1swt)#68%;O)kV&a2GSqvNJPHf@pSC3DOLat1tG zYLbJhtae&H$f%-HRfC6Kk1220fzpLuRIY+cZgBP~=m18;3__?v09?pvEvtzgm+CCe aepg?L%$O4a{y!D7ufN>&MTPgbC;t!KwlOjQ literal 7305 zcmdT}dpw)zo{y?aU211KD2kb#+3K`KPt|1*ahYK{y=d#!aSPKb9mJ(Xgh+4X%o;K~ zJyV@3NyeZkp{^AX9S1woHVKWC2sNpS1gT1*!kg@yV9V+G?EbSo+vD?*C(oOg_s#G5 zJ>T2=-HGFVhI;0D5D3KZ@Ry&TfeBjd)Eb=Xrky$-00B=@{jmE34?-Zjb{_uRD-fkI%M+#kF|8X-3*PwkMDddn6?RlgTc-#`auXoJn>qIi3_i@~<5H^u*tL#gPeg z1sd&I63nG7h(ADk=g2y|3CAl3l{|O65&XjPxttRI6i@mp&9y{9(1ZHG>&aZ+oN7kX zquyXyFe6-%xmM%&+~W@fZ02;DD?k9y0#-`4CbB>qC4gV<-2cJHvKZJ+d`PdpvL6;G z7@Tezk)ii@Wd+Aw^j!Y)%(HOtP}*0j57PABe3d+6;<_hZcxW{BFy13-%!H9NWMb5v zLtS&m=26PdTl);_Gjg^69C+@cXRfwxAoxH3kB4CHM6yfANr-qj3#c?T|L_D!V~g?X zfN_{pbcv zS?ev9#kgQ#9#87a7++-8Wa&}E4?WUZs9x#*KBvVOW@nSz$qAPlpsBw0%944*CywS( zjmse)?XqfF_$oQ#-1Eks$CjM$=ocz*qn#jPEuL&^S#%{cND=L8AN#!NLz+`r5N(V{g!<+o4hqY*?Y*7 z=&iZ+?GGc?=$&~J1zVn!L7Ifzz&N&NZm{9nAZcLYdZu3fyU=&xX@~iD>ufMnM6UJ_T_A~Fh62(%@7~J_pS0F)DJ9D9crz&TldaUW z6$o`{EO06jCg9JbMw>a;3+eYe_9_pQIdcRLs}wJ`vXkVmiYD4)nIcE@?66~~^!y^( z8|t1g1zQpwbRgJnO%mPDghjRySn6w?Aq6QbUU%49qpkN_2?-aybIj%R`t-gHjPr1PuLH^|3lFVL{%lxM?1BI0N>-1rBIU*|MSNR2+#-`@ywM_T_G0+hJ zRKX#bWjgH&h0;b1V+f?4BzBL?h}c&&t}SstU`cI{66;{xt?(2X?nvKcROCl&j23D_0cqGwl9Qu6XyG3XBrSj22n5q0OuVNIHX4(FbEc%OO z?5H%s5aV3$61wd;e#Q0lxSP_WH@=3%xTxL?NY;(Bb>L>u?_0jqgE&OZdL|St+=46k z3rs)HaX?vHDZI|*x$`bZ!rOp-IuVF*A2Lnp266;fy-JB5GjsT7EeD|94Dv8Q#P{)2 zICH8U^0JnU>uLGyjPp4O?`FeIGWe$!G)@8b1%G|r9GShTFAOE(urhIEE*kX&k))i5 zBB5bFj4HY+FVR`4xnrlxLKero$jWlY#b6$}$C}puq;&gj1PBe4&?ykiXl&=3xxs+` zzSo`l?ylwrCIMG-=_F6c^CBiVC@ze)JWWqV}BWSd3Oy<1Rk zxEO{F7t^4L@*&2IwZSTvi%`F(LP_biV)*z7Yi0+W(|1;v()eZPnxrkl zec&yP{ZG7;cdf`>!ZY}`MU6Uw>53j|82*MwP^&yp@N)FrcR5rd9mDyp3^~f@)M&PX!vgsPhEs5^=oo*z z=Vfg>`mflwG|0?|GqW1|^=q2^8`6BF!gBGBE~{B1L#CeL54V|+OL~U?^7e-~tO`k; z^`h`wnAM;$*r+v_Q$E%v1p2;ei-%VRS+h}RzLYlS=&KP7jtv1Je8jXr#*P2IZH3SU z<=ZjW8)g?<%q$|!^IuNpb_y4AG$jw*EF)UU{B2q7P3~d9kHJ24w;-(0)DwRp$S6M% zIvkQy!vo0QV*E%-f58F+NNn8(GXxx0#S>V#@a@lomT+d&(6SKG!^GPTp%I9E{f-Z{ zCFp{jsM!HhI}fNiVPwS3JltmIurLgeqd!YqhKAEB z-Mg_;v?g8c)}^G7uoLIBeWS(D{A-hS7LioWAU1)O`T-Z&@E) z48|017Iq#c^7>cdktca^R^g+_SMrk~+@+DFmz=KjnRN?sxpP;d`xLTjUB4E4KA%RF zH1M}lOKlOw$X2cib~nfGPG`0J&Km-jSKjjp+#}KI6mM=#!G5vWMk!`xhyeNTHRG3r z$lTHlK1Dn|FmEXtiVuiLSoX38Il7M8vc467vjt-}ghu`+fC@a;tS(EN8d)axr1;i& zh*kyFiVaq6?pz&gb-|m-mrAZqUI`?Cy1W`2@J|Ln;)@$-0F<$n;wlf3vsX>$V-pDs z^}TBnO&e5C&!2(n$y~?&8gjIt^^VO8Lv;3ompN=xxh>N{oR-G3Lxjvs54@ad;Tb9? zyk8z6hU`eaOrf<=Dey9m8#`pLWQX8ABsDF8N0NWFR&d}-IY0FPxgYjGfOAA=-K|lK ziqUK3wkCn)Mj(}|gsZP2Tv`3&@3F=l3+35U%I$G%Y%MI@L9bTszuNGM=FQvu9d&MQ z#Q(O=YWX^yRn3qeV^-TYYhi#rO~OH6Qg`n8gpW{si^>@eq9X=+$&@+hqtFFfJsBMv zP$zRYnW#)gE8iD14-Uko$6Uyu`HmY^DZ)tvPkgsk09URc8kH>-tY8|r4e!lwOa6nb_(BbCyz zQYXCjHz~zKhfFPMTU$rceDMi2z8o3~kdBEFs^S|aD)jV#gA!dzr0Y;2{z#vkQtdxt zBuBYhWz05jXmxqcZ;1VtT>GQx&6pK>GS5LEHK%G}sAcg@?IUw=mF|Cpo#(`y^T;~= zZC!k?Y@k7*x)qa9X;Ss3BxZw89y3$r1sE_d07x34B#rmqk|o}d#I0Rn)<{M3z8W(p zA)(U54fF%r4!QB>q$1m)PL84Js#l=ZIv_5+0h1Zt(nwbc&5olZDb8c5pJiS3z!x%H zv5y+VrQDottNKQN*jS}+D2bf>nk?5cb`P?oMy)YBiBxVaM_|LR9uE;D3f_~=1B<5K zYCs2;22vuT;kQ^u@oBM5!i?HImFh^yTWKZ{t{P)?yC+`7IfOx`U!(zsOAVZec2i6pb|OfK!GrSvL!1i_GsHWp4qyD5j^DyW%= zaT#xZ@{rjo0xuX9$EH=T#Vc&7hMl?#c(Gh0|wJX5|L#N{rJcF<<nZD~*0A(!_DVn)^yQG5G!S(!vNz?QPA z$7L4l34^UF54Bj&L+4a^Xp4DCr`uS=)ky3SX(qv-R!)`;n3LL1f-NK{mwHJLgEpi* zWJrf?vzcPS8PiQI^!y=NO|V0r`wn^j@(&3|Rq-pJ4h8pIgz9BE`5kw}%n%@S|}<~oUT z@7L+vS!Xbse%R|zQyqn%OA8mBYW5XVaAv?OEw<@iN#2V|-Xc_jqQe{3xOQS7<+B^6 z!`9~{jgIo@`{2U^;yt06%1cF0?~%NJerZ+F=&2(F>A}%gmxcNmk0v4f&G31x+V7~6 z`H$DgJ}Wq&a0f=dSwYiVm0dU=P&@2jQfci1PDO;ZFCXhM=I?Im=+;X+Lg#FLwqJ3dG6DipZ0leEx zj#=gsMQMWWh&eNT8s?K;widAEM7rAPEd1-T`oYY&vaaQNAqA$xrXa6qKWQbbKMgRw zUPy~C0FNY*LRRx=nnaaHLvi7l2}Cwvz%KB3AEeou|Al7d)~5Yq4SDzW9s-{mLJog% L{PQ~RsLTHa3vXAJ diff --git a/docs/html/classkiwi_1_1model_1_1_object_1_1_error-members.html b/docs/html/classkiwi_1_1model_1_1_object_1_1_error-members.html new file mode 100644 index 00000000..9eab35ff --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_object_1_1_error-members.html @@ -0,0 +1,111 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +
      kiwi::model::Object::Error Member List
      +
      +
      + +

      This is the complete list of members for kiwi::model::Object::Error, including all inherited members.

      + + + + + +
      Error(std::string const &message)kiwi::model::Object::Errorinline
      kiwi::model::Error::Error(const std::string &message)kiwi::model::Errorinlineexplicit
      kiwi::model::Error::Error(const char *message)kiwi::model::Errorinlineexplicit
      ~Error()=defaultkiwi::model::Object::Errorvirtual
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_object_1_1_error.html b/docs/html/classkiwi_1_1model_1_1_object_1_1_error.html new file mode 100644 index 00000000..95f1698e --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_object_1_1_error.html @@ -0,0 +1,148 @@ + + + + + + +Kiwi: kiwi::model::Object::Error Class Reference + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +Public Member Functions | +List of all members
      +
      +
      kiwi::model::Object::Error Class Reference
      +
      +
      + +

      an error that object can throw to notify a problem. + More...

      + +

      #include <KiwiModel_Object.h>

      +
      +Inheritance diagram for kiwi::model::Object::Error:
      +
      +
      + + +kiwi::model::Error + +
      + + + + + + + + + + + + + + + +

      +Public Member Functions

      + Error (std::string const &message)
       Constructor.
       
      + ~Error ()=default
       Destructor.
       
      - Public Member Functions inherited from kiwi::model::Error
      + Error (const std::string &message)
       The std::string constructor.
       
      + Error (const char *message)
       The const char* constructor.
       
      +

      Detailed Description

      +

      an error that object can throw to notify a problem.

      +
      Todo:
      Check if object's id shall be added to error.
      +
      The documentation for this class was generated from the following file: +
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_object_1_1_error.png b/docs/html/classkiwi_1_1model_1_1_object_1_1_error.png new file mode 100644 index 0000000000000000000000000000000000000000..91a5a295119e9c1e76fdc31ecbb970418cdbd3ad GIT binary patch literal 874 zcmeAS@N?(olHy`uVBq!ia0vp^(}B2ygBeKPJ=n<#q$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0etNn%hEy=Vo%?XoVg&)V+2>cC`Mv+6 zs!~%|+NP8Df~IG6+sC#Jf7ym;Zu`K`TQp?zGH#XL-}o zuJ193znX2Ux_R4|J>Nv%7tH@$RdXx#Oz_w5acN=REC1@RH#>Xg(zZWWt@4a()=pXW zuWrrxYuUz|v-dr`K^Zo;8-t<)D&z|{{Q{ULw{$Xm`v*+)o26;VZ{Gge~z-+YQ z`dhPQHx|T|uT?zi_O4R__L){_n1O63^KRERn?2#nb zf0(r_Q%XS1Q>yR7Bo+IIs-AW0_68N_M60ZH-n%ny=}%?P^$$NzQW3Y+_x#1^zxUav zj(M4EXUv~#o?Lz>b)D?qY5)2UU;2OP=gjb}k?W@w?T@>AZP~UkugD8eHyqnF=ahQf zY5m|J-P)93RpGzmjPrAhC`ReiM z-+o*AuAA+zyO}-tYmn8H&3_|ezW)sUzF1|h;Cn^SPr`ANo~Z9pIq6^FIcfgx>n6UJ zD;R3Jqz^Rkyei$@t7*34dTh4G#=yNv_Dp-6Fg=VlG@fhk3G&Kx@L)JB2nnh4ucrF1 zeX_J*@6D3g-ve{4SR$mS>9Q9bI>&v$^?Y`zRd?uK2EEL^&w?JAaofZ{bDaJ&V%OQN ze-kWENiDPam=U);Lw?siox^5vSJU=Jow7OiXq(yAtwCMam%ZJS{q82)XN%hyiiL0o*cQErKFk>)yy85}Sb4q9e05BE1Q~&?~ literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_object_1_1_listener-members.html b/docs/html/classkiwi_1_1model_1_1_object_1_1_listener-members.html new file mode 100644 index 00000000..ba7f3502 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_object_1_1_listener-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +
      kiwi::model::Object::Listener Member List
      +
      +
      + +

      This is the complete list of members for kiwi::model::Object::Listener, including all inherited members.

      + + + + +
      modelAttributeChanged(std::string const &name, tool::Parameter const &param)=0kiwi::model::Object::Listenerpure virtual
      modelParameterChanged(std::string const &name, tool::Parameter const &param)=0kiwi::model::Object::Listenerpure virtual
      ~Listener()=default (defined in kiwi::model::Object::Listener)kiwi::model::Object::Listenervirtual
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_object_1_1_listener.html b/docs/html/classkiwi_1_1model_1_1_object_1_1_listener.html new file mode 100644 index 00000000..74d55bda --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_object_1_1_listener.html @@ -0,0 +1,165 @@ + + + + + + +Kiwi: kiwi::model::Object::Listener Class Reference + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +Public Member Functions | +List of all members
      +
      +
      kiwi::model::Object::Listener Class Referenceabstract
      +
      +
      +
      +Inheritance diagram for kiwi::model::Object::Listener:
      +
      +
      + + +kiwi::engine::Object +kiwi::ObjectView +kiwi::engine::AudioObject +kiwi::engine::Bang +kiwi::engine::Clip +kiwi::engine::Comment +kiwi::engine::Delay +kiwi::engine::Float +kiwi::engine::Gate +kiwi::engine::Hub +kiwi::engine::Loadmess +kiwi::engine::Message +kiwi::engine::Metro +kiwi::engine::Mtof +kiwi::engine::NewBox +kiwi::engine::Number +kiwi::engine::Operator +kiwi::engine::Pack +kiwi::engine::Pipe +kiwi::engine::Print +kiwi::engine::Random +kiwi::engine::Receive +kiwi::engine::Scale +kiwi::engine::Select +kiwi::engine::Send +kiwi::engine::Slider +kiwi::engine::Switch +kiwi::engine::Toggle +kiwi::engine::Trigger +kiwi::engine::Unpack +kiwi::BangView +kiwi::EditableObjectView +kiwi::MeterTildeView +kiwi::SliderView +kiwi::ToggleView + +
      + + + + + + + + +

      +Public Member Functions

      +virtual void modelParameterChanged (std::string const &name, tool::Parameter const &param)=0
       Called when a parameter has changed;.
       
      +virtual void modelAttributeChanged (std::string const &name, tool::Parameter const &param)=0
       Called when an attribute has changed.
       
      +
      The documentation for this class was generated from the following file: +
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_object_1_1_listener.png b/docs/html/classkiwi_1_1model_1_1_object_1_1_listener.png new file mode 100644 index 0000000000000000000000000000000000000000..cdba772f13c3b43e34e52da6ede1e52a5742a638 GIT binary patch literal 16987 zcmeHv3sh5Q*0$4*I-gXXj;*w#K&z=(6{6LG$|Ym1ZPN5dBm!~`Bx5b5 zEiGsmLAfNYtv{aMT7 zAvq@}dH3GWe)hBX$tQ0Izdm=)pXbb&F=H$lP(YV^ACsK3EnmX4niO8P4B)mW5%Wt{HvSZ zP5qs!yEozXEne1*Ui@*n{TStmS(r;#Ge7WNMcw%4zwtl(;i9RzgZRv#3Ld&mo7^~A zA)TZzi@cut>?Y~U_m0N6%sjF#bony_+>h&#m+}PPmJqzXsb+0rQgbM=ruGhdyHDsh zSWXtD`nc*v8C$K3KGV8zj&Qg{Wm_MUGBuetaxg(u>fST2aFi~n%(89BtZ5xzWxeZ04QIRWBy(`4FcsA;R=!Uc;ebul;mT(@X)qN$z2n(G_-O{mP> zW4thKoVT7V3a22Q@~QXt3Qdv~h|cwkJDp}Z*E(ek<&_^Ghow(ZJ42ZC1H88n_Wu3* z7kTw8ii$_1d|5uJiK6y5HORZ+tHo_cCVDfl$l$dqVO#v{x&FJX!(fCPirOA3_&G=@8LbFN;OZ8r~V2OLGBF3d1_P=iZ zGYqNfnaoE5Zkf^T!j=n&DtUf~(e~^CMr}=_Y*}OZ0UmzhV5<+F*G9@8=q-w4 zkjmic`j-)mESMX_$cEQBrK|!K(w9`t!0&gk z+|a7pZ4668UbBAc!wv{u)uRK@m%(OX#fb?Yu%ho`JQVA>nB1DC+vm z*hz)P7qJ(qbffdkO4ER*RqtP3&kF6YDGcLpKmTGmCoIiH|i1UZ% z{TsdXf8pT2bSk;6Qk^X5Rvu|RBrI-8K`O!9i%a6b@&BRaW8Qc9O#Mg;E2}-zZdp|! zNHS8I^^!5%8QtJnf?Qy?ufPi@mU4m^^vUF;a-F6uN@Q9@kK^GJqK#O8{Emu50>d6f z>{=r`c-=pjb1X^%NFfwiiNNf zA!xAFR~TnMlj{B1ZDnnhbU*A_`NBj(4<|v%>9>DVF1pk4xTY|QnleSS5vop1j?BYP z%x&X_x5TbF-*7EW$BWoW%rK0In5HCI&$BkM^!;tN^dr|pC9g9w>gP-JtE;h_!=BJv z5PFl|;<^r5M7A@=8Vvl#qb8Ua>o473+ZRH1_voq~{ zk{lks`55^GzgJ$Q*v?agW_mAcBnHXjD1jNmySf!ubFOw4hRaQf=BmF=wg->v@tfK>Y|pLaz6?#=xXl2O~sFAaJDaT3jzb%Isl(*|RYm z0>t)}*h-jsS)dw^WMS-Tis5}Q&S0c{0WAoy&mMC>kVxp>W;CRfgp2T>0}{Us{0@xi z2)VoqY#thGvtk4QquBXAZAMA+LR$6xkoi|Z_%C_*zcz6^a@Dwv9o=L;HS_#QNlLzv z?AL)wOUeh#0VeXxspEdE;npDh24%tvc(So?6cG~`mie?`Udl(+9^We{^qzTQ)2Vht zAXXUvetgbgHl|vofK%;J8~QOuENwSxvYJ7vjCsx2?p6p^2*9mFtnno`dfSFsmdL@? z4c2e#8(1!``Ep`rzaKt9oY$l;kM!ns_dkK_DQMfBtH}`LY|GJ<+6xxB-~thC27x6Z zR9Zg{c2V*N`_(5@tr|?D8}3C!Q136fEBP=a&&m!CUna2lPK0v8f6sRxQ*8<-sH@hn z9<%l_FxA7eqp7hcSPORNjZ5~~(?>QU%_41K40XfZ=77Gik^TH`whw|(FQsFvUOv}w zoqdLuHc}<3AlO9FW|Rk<#8fLM_Zg=SW_)vQStf-a-ZhkS&S;bgMIsSpS!3Unc{SV6 zfK9$rEKr%~O^|uy_Ufs&6l6P5IoqzoO<{{I@Z?7&7+>ob-Fn+o=-Q`$mfc=ItC~67J0Z1d z`)&?6c_zv1OaQ{#2(PORpX8LtlSc4Fy3Kghz^82+bA$Nt!_k(?; zxb5a+z16S~)r@`>xL_kkBU(o|f=yU0DK*+W!aBBcnr)q|H~HpUUi4VSF z)E>v`AxC8VRsT7dqL@a89F-Hhg$f5#*i z$k(f9WPiz$Vn;>%oo_G>;Cv8m*pH~1y}C({nAP)J;bRoKDDfWrBhkjPzeZG9To?ld ztRhvz(T(4miQcw{?w3+G{i-$b>=KgV~`;`y(xJ^ zWy4bx4KHUATWB%5!cyUq_;tpoOs6`F2^9@jrFM&k@;e-jZ&kicA^+Z&8}2_=!1kpu zF|M#4iq_r)Mww@4FTeSD4}!-~twkq2Eic!LW6bSucP_A&C>3Q&5-ywOFRI-$ew=tB zj*)@*ZnMmHwV_mai$zbe>!lkTjr+iOb7)pFHT~@u8i^=Hn<)x}Z7l>5@~CBhhJhcJ zplL1Op(5uk`X-)XmTf~lF0j-4+98vge&P^AJ6?}cIIc)) zpy&|*v6bRyy*CDP)>q^MeY@isEx-lZkJD)zt^K&Oi-)RlNmWycy&V|@;_fa=ys@{L zsA>@{McA`wmV=AC6w2D(5KS$X$=(Sv zK4CZ{$~<@p$3N2WZee5vBYc^CCHUY;;qtMGxVnRtNW`@aUEZCE4JQUNEFY0X?o&%7 z$~7LMWUXE7TW)oe(JWn!`hzA!7SZj6_qLcw`TT~;#oG9#ftl8I(z4ilsU|sHl991K zptbPD9we@?-gb>F5QZ|sZmqu;F20tyJA8M7;=iy^_o$)nvGplNc_D;Ti)J!?T0#lz z@?#1wejdBX9xhN>4=cQK`um!;)TO<(gE7FSy~9(?y_4`(KtSm{QFyK;)wEh&&n|CI z;x-H1DuNit<;PTYhq3k~dW3#MXAY@QDZ&C(<5BWF@ite{b70FNd7+AK3Ms|dbI_nL zW(ib^%`f78AlF3siB?1U*!`38=D#!h|4%3XH|azXeLtO)WSXap`XI*HTozN+xw%Ig z_i}adX8-OxqE=lQnnt4N#SL{uDt@*_*SHAsJKeApihPfy8+JZ%Ks48~Ys0JeLL@AY zxI6Prh97Mck2ue`zGm>KlpA;so4G18H7XLVN?8G&AOMMY`c5Q0)+JV!}p@5c_ zOQgJQg5_fgTj|5&ukn;w7~>ClQoZtdVl*|eqf-_khp-+KaI90+`KsQ@XkHH14QEZ_ z0bL>GZ4Mk|EB_0(;hvYfm5E!$+5PngPWE+oCkL1jWK?k}e_-XJdx2ss_S=jGM^(f7 zS6KWv8KSAf0#$454cEGeXhCp>6+=Bqid-v4;zaHf+j-*W*`mbCHCV)_*#a#^^;X^GBjpMA(}qz;$5DNUZM>U z6mR^~L9tcPO*WYB-0%U3YL0u^&xln|Jy61aNzeM#4IxGXU@oc z9@z{v%7k7Kg)8w1&91R>J*U? zZXcoq*x1~0?A)`f*ihH&1pYPiFzKNIh6!x-s1MC0#Z(K6y%_ zHQ7{BmM8@wMV|0s+YF2m+S&6@wig@U-e@lcxhs`b>=0cX2LBowmbtUkhB>w0O|EFRV#VDT!8ZD)dwI1) z^IG5@#z=sZ*T(X#Lu+w(TRyzd(g@PT_uwKisGmHviE}J%A-c36Oh4rx z?9`us^?3asEPSsYabF9Ut#kNdCio(%p@8hXdMh{Xkxh%1n;BZ`9Rh^{Rua)OWD6?t zYSFELGjRKPW1+RLLXGkj_sAA1g|*Ur8pkdJCE0szKnXD-ACm&HG4!;fKXGWIo}$Ro zAxlh365)W;G!f4s_18|;dgW^8)ii0BDB6}$Z>8aAWY$&&dmWs4kz4n4U&7{YR-mUX zx(z>Z9G1Ekt;K<&45=31?vn;v^FI>onkK$K*i7fbzWW6IA(XBwBM7MF8EAj^l z(34)}DclSRZ&^Rq)Y7_gq%O+l&O#MoSz{)OIy49BuUvx{o&%d7;RL8F@e_Z6S596) zgqhk(5X?Klta$j!{l5T$U~)&fyy^1dVp!;zd2RO^7yqnPe$=7(H9W+pHQ7PdpK7TD z%?zqouP53_#gA;X_6OQ(yuKOREdnNr#&tf*!G9q2cBa1uc3#RplDLoZBSSANtPm#9 z{JJfBjFUx}mFQ}|@>2|_1BUY~O+xJ=d6g^<;?ZUYAkP3GpE`9pr^K~*bPH&dLtf?m z7T2zx1I1pSY2UdQ>M^`Rxj(rso04HG<=2C2woFI+729y;^^q|}x!dFr5QA2^&)s%k zHK_`&Z?wzfLgrh_XWKUl%Sm?TR4B)PqM-d4<^cNPUUT|Efd3DK`L^b3d1Zz)nk_kX zl3wd}D%_XqPo)7f28XeTP^?e(yMRe6LH&o!69+(u-vl>s?TN#&#_*ie=<^3*P3>QR z*R(hL0yV$XA(2kH1?rxSRQR2PxM6UhqwG)JXd$#mZp$)4we=Ww{q5_K#q!crI_mE zu4M*~V8LKQSuG!_F#M1+DqW=3!7IKfn!G4bjZ|lj-w}-hJTxC*n}n8Yd)k5+Z=sF> z)e;I20sf1MjmB7$c(Q{DyAL6CBtMC(U zbkP=Y?FcI0YP!J$@x3$DiC;mCbH7!@xJi;PWH%qjR1fBG#e>>mGav6X#$#w|NHe#H zWLMZ@qa=g)_2}6-6Z)rZyY3Ue+DQwKh^rmN62l6d#%Yu>_XcEcbjuz^#osNH%}7aS zUWhG8fku5IH-J=vItOkD`%-P?!R_{j;TRX(_sucWUa_sOEHhnq5uUp-jS#v0KGpVv zx4j4g)w!UQ%JWsN8<6%+;3lt1yW>Q(Q$z#MzQK#W!9XAnGfP!z;<~PPa2o^ISbkgk zaPu4UmEzA0V+R-+-$GmyK=Tr+*wz;s9kITaW0lkgLX`}T^DGCU^`lJ;)E%Ax8sPK8 zFGSOSIt^(15e;xJwAW%QQU!E&jLU+$Hvj|)fsb2L{p91J1~M3IWfX`rfAZTI#m^g; zHqnNq%Hcj~*5GL|-#TJ^0k1|Q-X)5ftD77?G%A-&Tl{SB3-=Oo_UCKULKiDyEj5?R zm%DcQgigH>u@T8*`N`aaS$`5$5?oJ)d&G^TsXR z$+}CT)G?wy{prEMi>(W3!jS9w+Wv?F!;Rsz%*xUV0$U&#XPRQ1u!a`Va{ak^`2#o< zaY{&{x=g5|QC7D}pz6KM!puj}ZxeX;tY65Yz@AWGod94B0+RQE`2P*Q-yfQ|&pnDA znTS0fGLa7mJ4xWUKUbZk1@kC5or7;Ox+WTAN@Ou1!-8paVCP9RrZ;?@wi2phr;gJfhFVG5feG* zda;+~IaFpwKtEhaFx0bjWa@#o@KvkGi7omJM5_rQ5*Ut5{{vajyZ`&cV*l)k>sdXSW~fXJCV0+=>4O)AOU|duVdy zf5{84pK%D+$|E0a-~q5jgu@psLYdh^8|L5dx7*|OCLeiCC_{@bKpEO*8i=E_ApbXM z(fpt0RVZZ# zKOf`k#Z*J#*R7u}{IIeL%}GoMYUH!s`jKa8l}Efc*BZNUid27lK}nuc^cwZ)239M@&4g9a(bF9a)EuTX{^9mTcYHbB5)07Sb)@{#->xRdNzvCvzs+M zR-O?fdkyst=o`pjWa;4rbgU=ONxawHfBm|Y-3}fYBiKl_BxN>BIr&j&{Y7ZhPaP7iI=Bnje!BVh z>|`YA3s-@u!N6FRhZtt6by4xU$14yW${4B0b1~8~Zqlrf4 z31VE@EE6O<^i(5H$V*kPgByQjY?rCaQ9{F;ZXJEF;Wr@p1=1K%gSK-Jak@XDX+kC+ z8i|1Q{aO(VEMSh`dVcb)zu3<%KGntA7>25TlT#Dbsg{wHCUhy# z|1)EN3DyR=Y0JT!#|XuW&-uD5`}YQ_>J-#fJeWUt1&uqW?k8BDWQAf3hfGtyiuy#0 z_OQ@C_)-H^pz8Apab=O27z2tyGAIEKi)c>KuboWgj$^970-pmh3Wx#uTXVLhF&-O; z?fOQ$H=a1vF8Tmd?I3^-9mp>av>yt5&$TZg8dV8?f(XC`(jPTd?b&z)-QSA#<$tT` z;KvGqs$an-20KfqV;~N*Mk!iccR4I28>GMWVp>rZEbkrhb$Fs2$kSt?DwNMO$KSAS9Nk4=b3HpU*Xb`?>W!3->FzSG=*ucxAU ztkcXt;pBHm4ly!N8ZpfWM5$=-b9>?_aWy$v4RIAHc%w{Cn}W12$b29RnF{a;1k`<= zN3^-r>eFi0gr~S}s`k9lGRb~VWJ}xVB&cmr8&k|XvgI}3$gb>6!f$0bjK=vL~J|-FL-ByJZ79)_ z=#Tal%G}=y=rCuBj`phT@?(2ylqJQ!s?HogE@e=4TP_&YVu~ zua_xw4sn-ATZvE(p>Q1QVEU!4pyQ+BEvUMvj=vcVUlCmo*d;kdfwAYJkp?frvx-9z*(DaTbC z$BVxNZ>VGzPS^8AeryjzAMnkIw!S_Z%LB{a%5aF3?*Ms;BYGBM?BBr`U^7+mj|Va0 z(5nunAocly&N9AG3iUi%^gX2LJO2Dnujdmv4`h8|CKP&J2F)!}q1c5 z6+kEF4fUPH^2o=n+#lh2f3u=*L^XDC5TLsQ4XWs$mh)w#&f^u{yE=-U1=rUk*UMgW z{NtGNtz%N}^sb$*hJCy-Ze0W~`zdJiac@R{(X0vUiHzTfC!?S}oy!ZPCG$M=qO3!;e8ejta;!q(||vhq^%qy`l?sV{{$gfTim#-ZW0#Mx7E8`KSo ztmv<^<$TyyGU?(--Ql!uSwm^wl8ab+mzuHyf^s%6N+X;1EZ^34YTu z-rD;z9$O-`8mklAt;If}Cm=;Tse1-UdbqB9baW)#ZB-va`2xzhzdFmgsvE=Oer0WD ze*2CRjDyN`k))N(z|veRk``&@eQZ0QTGL>f9QVQtQDiTRp=Q*w->-XP?6uQnd|fFy zA}K!7SyPqYlWyB3byJc)1YDv7oorWO8asO=0q(Z5DM)Cs`kcbH#8yr~9i~jpE1zu} zxlBi^IOSE*r)JJLW*6GZ2ls~KobtVT?6$7(CQ%p{M?8G;QfDgcW>anR$tDg&}oc;CMyDT=k5#B zWUdvc-Bi3|O5+>loi5o!SWlJX8GdL4P5z9z8&Vhpjs}mPGtgIDZiZUT6znU4{x6zQ zv*7kJ#~jf63ZWIcG-$y!&DjM#l26ljV23p;+31HZ6;P}6sSOiMd;;h+s|k{y&S%WeY0i@76acEDlMw#CNJGDMaqs@w;e%<%w0rUc zx`&6Jrk6v&t-}_p#L`mI{IU=~gK8yI3G1e-tcF z8DsPS6USVKc^ts`*HL&l3iCKi0pov8@&1pW$9ZrE#|S!)lcSV~@OO zJE?az6`dsi>g-HQ?!MQ;-`*2=uyh-bQRn+O)9X3!|Ij9?j?9KYRm;_s0&yT z3=10-VxC7tniKd55$Y-*ck9P$35>a@{a*zk<|H`9Z&H^pyr;`|1)7tm@Qecn3J~`* zXjyB&t6T(7{t2@Pf_$IyPM9nb2Cz6plQz8urlZsIZDD?4R9jQSMSKEU*-Be}8s&L1 z?+$W!u~YtDzzrDUeW$xXub8O4o>tnoh36|`IA1z&FMVsG1wtRZH;VJqy}0B2#4v{- zzvI)KtoF}s9AsHzCz?F2LPPG4#DEsc=t!Y+i4^8Vx^f@_sPfnX9f+rr@agnK)qAeNL?r;^4FG@^HVw^><@WQ>c zp2D%#LdTUb;he%SUO_fgIvR83R~xR3yq1!JG|ZhA0{DRQ*Bm(Cq?eGXwNrg+e8M)g z%slC=*a><1dP*Vm<1~q3(dM*qV_ZDmsS=dI)QLQqFTj-dYx^{`GB7fmr6RH>e7$X0 zxY=oS%ip^7T09Hx%}pDpPr;B~_d@R!q&ZRH=k24wRHNsH+`AD%zQ+AI}Ty_+2SYY`f5oefDkTky0z_fNemVeW_*J`;WBEc;S+QRm^ zdXWk%3(3$?mf$;zyl(PQ91xg~+F9Nt_`!j}CuO#1wqp$FDT~IPgSay%@e?V~WV5Br vN2fC3w-})B`qQ6eh;oj^k^146As9Eb_1W+J0KWt=1HUEs)rwc%`{4foD_5LU literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_object_class-members.html b/docs/html/classkiwi_1_1model_1_1_object_class-members.html new file mode 100644 index 00000000..de81ed87 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_object_class-members.html @@ -0,0 +1,127 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +
      kiwi::model::ObjectClass Member List
      +
      +
      + +

      This is the complete list of members for kiwi::model::ObjectClass, including all inherited members.

      + + + + + + + + + + + + + + + + + + + + + +
      addAlias(std::string const &alias)kiwi::model::ObjectClass
      addAttribute(std::string const &name, std::unique_ptr< ParameterClass > param_class)kiwi::model::ObjectClass
      addParameter(std::string name, std::unique_ptr< ParameterClass > param_class)kiwi::model::ObjectClass
      ctor_t typedefkiwi::model::ObjectClass
      Factory (defined in kiwi::model::ObjectClass)kiwi::model::ObjectClassfriend
      Flag enum namekiwi::model::ObjectClass
      getAliases() const noexceptkiwi::model::ObjectClass
      getAttribute(std::string const &name) const kiwi::model::ObjectClass
      getModelName() const kiwi::model::ObjectClass
      getName() const kiwi::model::ObjectClass
      getParameter(std::string const &name) const kiwi::model::ObjectClass
      getParameters() const kiwi::model::ObjectClass
      hasAlias() const noexceptkiwi::model::ObjectClass
      hasAlias(std::string const &alias) const noexceptkiwi::model::ObjectClass
      hasAttribute(std::string const &name) const kiwi::model::ObjectClass
      hasFlag(Flag const &flag) const kiwi::model::ObjectClass
      hasParameter(std::string const &name) const kiwi::model::ObjectClass
      ObjectClass(std::string const &name, ctor_t ctor)kiwi::model::ObjectClass
      setFlag(Flag const &flag)kiwi::model::ObjectClass
      ~ObjectClass()kiwi::model::ObjectClass
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_object_class.html b/docs/html/classkiwi_1_1model_1_1_object_class.html new file mode 100644 index 00000000..8507d79f --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_object_class.html @@ -0,0 +1,313 @@ + + + + + + +Kiwi: kiwi::model::ObjectClass Class Reference + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +Public Types | +Public Member Functions | +Friends | +List of all members
      +
      +
      kiwi::model::ObjectClass Class Reference
      +
      +
      + +

      The static representation of an object. + More...

      + +

      #include <KiwiModel_ObjectClass.h>

      + + + + + + + + +

      +Public Types

      enum  Flag { Internal, +Flag::ResizeWidth, +Flag::ResizeHeight, +Flag::DefinedSize + }
       A list of flags that defines the object's behavior. More...
       
      +using ctor_t = std::function< std::unique_ptr< model::Object >(std::vector< tool::Atom > const &)>
       The construction method.
       
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Public Member Functions

       ObjectClass (std::string const &name, ctor_t ctor)
       The ObjectClass constructor. More...
       
      + ~ObjectClass ()
       Destructor.
       
      +std::string const & getName () const
       Retrieves the object's class name.
       
      +std::string const & getModelName () const
       Retrieves object's data model name.
       
      +bool hasAlias () const noexcept
       Returns true if this object class has aliases.
       
      +std::set< std::string > const & getAliases () const noexcept
       Returns a set of aliases for this object.
       
      +bool hasAlias (std::string const &alias) const noexcept
       Returns true if this class has this alias name.
       
      +void addAlias (std::string const &alias)
       Adds a creator name alias to the class.
       
      +void addAttribute (std::string const &name, std::unique_ptr< ParameterClass > param_class)
       Adds an attribute to the class definition.
       
      +bool hasAttribute (std::string const &name) const
       Returns true if attributes exists.
       
      ParameterClass const & getAttribute (std::string const &name) const
       Returns an attributes static definition. More...
       
      +void addParameter (std::string name, std::unique_ptr< ParameterClass > param_class)
       Adds a parameter to the class definition.
       
      +bool hasParameter (std::string const &name) const
       Returns true if parameter exists.
       
      ParameterClass const & getParameter (std::string const &name) const
       Returns a parameter's static definition. More...
       
      +std::map< std::string, std::unique_ptr< ParameterClass > > const & getParameters () const
       Gets the list of parameters static definition.
       
      +void setFlag (Flag const &flag)
       Adds the flag to object static definition.
       
      +bool hasFlag (Flag const &flag) const
       Checks if the flag is set.
       
      + + + +

      +Friends

      +class Factory
       
      +

      Detailed Description

      +

      The static representation of an object.

      +

      Member Enumeration Documentation

      + +
      +
      + + + + + +
      + + + + +
      enum kiwi::model::ObjectClass::Flag
      +       		+strong
      +
      + +

      A list of flags that defines the object's behavior.

      + + + + +
      Enumerator
      ResizeWidth  +

      Internal objects are hidden from objects's dionnary.

      +
      ResizeHeight  +

      Set this flag to resize object horizontally.

      +
      DefinedSize  +

      Set this flag to resize object vertically.

      +

      If the object has a predefined size.

      +
      + +
      +
      +

      Constructor & Destructor Documentation

      + +
      +
      + + + + + + + + + + + + + + + + + + +
      kiwi::model::ObjectClass::ObjectClass (std::string const & name,
      ctor_t ctor 
      )
      +
      + +

      The ObjectClass constructor.

      +

      Used in the object declaration.

      + +
      +
      +

      Member Function Documentation

      + +
      +
      + + + + + + + + +
      ParameterClass const & kiwi::model::ObjectClass::getAttribute (std::string const & name) const
      +
      + +

      Returns an attributes static definition.

      +

      Throws if no attributes refered by name.

      + +
      +
      + +
      +
      + + + + + + + + +
      ParameterClass const & kiwi::model::ObjectClass::getParameter (std::string const & name) const
      +
      + +

      Returns a parameter's static definition.

      +

      Throws if no parameter refered by name.

      + +
      +
      +
      The documentation for this class was generated from the following files: +
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_operator-members.html b/docs/html/classkiwi_1_1model_1_1_operator-members.html new file mode 100644 index 00000000..e1a43e7f --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_operator-members.html @@ -0,0 +1,160 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +
      kiwi::model::Operator Member List
      +
      +
      + +

      This is the complete list of members for kiwi::model::Operator, including all inherited members.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      addListener(Listener &listener) const kiwi::model::Object
      addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
      attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
      boundsChanged() const noexceptkiwi::model::Object
      declare() (defined in kiwi::model::Operator)kiwi::model::Operatorstatic
      getArguments() const kiwi::model::Object
      getAttribute(std::string const &name) const kiwi::model::Object
      getChangedAttributes() const kiwi::model::Object
      getClass() const kiwi::model::Object
      getHeight() const noexceptkiwi::model::Object
      getInlet(size_t index) const kiwi::model::Object
      getInlets() const kiwi::model::Object
      getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
      getMinHeight() const noexceptkiwi::model::Object
      getMinWidth() const noexceptkiwi::model::Object
      getName() const kiwi::model::Object
      getNumberOfInlets() const kiwi::model::Object
      getNumberOfOutlets() const kiwi::model::Object
      getOutlet(size_t index) const kiwi::model::Object
      getOutlets() const kiwi::model::Object
      getParameter(std::string const &name) const kiwi::model::Object
      getRatio() const kiwi::model::Object
      getSignal(SignalKey key) const kiwi::model::Objectinline
      getText() const kiwi::model::Object
      getWidth() const noexceptkiwi::model::Object
      getX() const noexceptkiwi::model::Object
      getY() const noexceptkiwi::model::Object
      hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
      inletsChanged() const noexceptkiwi::model::Object
      Object()kiwi::model::Object
      Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
      Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
      Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
      outletsChanged() const noexceptkiwi::model::Object
      positionChanged() const noexceptkiwi::model::Object
      pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
      pushOutlet(PinType type)kiwi::model::Objectprotected
      readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
      removeListener(Listener &listener) const kiwi::model::Object
      setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
      setHeight(double new_height)kiwi::model::Object
      setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
      setMinHeight(double min_height)kiwi::model::Objectprotected
      setMinWidth(double min_width)kiwi::model::Objectprotected
      setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
      setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
      setPosition(double x, double y)kiwi::model::Object
      setRatio(double ratio)kiwi::model::Objectprotected
      setWidth(double new_width)kiwi::model::Object
      SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
      sizeChanged() const noexceptkiwi::model::Object
      writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
      ~Object()=defaultkiwi::model::Objectvirtual
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_operator.html b/docs/html/classkiwi_1_1model_1_1_operator.html new file mode 100644 index 00000000..1c0603ee --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_operator.html @@ -0,0 +1,349 @@ + + + + + + +Kiwi: kiwi::model::Operator Class Reference + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +Public Member Functions | +Static Public Member Functions | +List of all members
      +
      +
      kiwi::model::Operator Class Reference
      +
      +
      +
      +Inheritance diagram for kiwi::model::Operator:
      +
      +
      + + +kiwi::model::Object +kiwi::model::Different +kiwi::model::Divide +kiwi::model::Equal +kiwi::model::Greater +kiwi::model::GreaterEqual +kiwi::model::Less +kiwi::model::LessEqual +kiwi::model::Minus +kiwi::model::Modulo +kiwi::model::Plus +kiwi::model::Pow +kiwi::model::Times + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Public Member Functions

      + Operator (flip::Default &d)
       
      + Operator (std::vector< tool::Atom > const &args)
       
      +std::string getIODescription (bool is_inlet, size_t index) const override
       Returns inlet or outlet description.
       
      - Public Member Functions inherited from kiwi::model::Object
      + Object ()
       Constructor.
       
      +virtual ~Object ()=default
       Destructor.
       
      +std::vector< tool::Atom > const & getArguments () const
       Returns the arguments of the object.
       
      std::set< std::string > getChangedAttributes () const
       Returns a list of changed attributes. More...
       
      +tool::Parameter const & getAttribute (std::string const &name) const
       Retrieve one of the object's attributes.
       
      +void setAttribute (std::string const &name, tool::Parameter const &param)
       Sets one of the object's attribute.
       
      +tool::Parameter const & getParameter (std::string const &name) const
       Returns one of the object's parameters.
       
      +void setParameter (std::string const &name, tool::Parameter const &param)
       Sets one of the object's parameter.
       
      virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
       Writes the parameter into data model. More...
       
      virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
       Reads the model to initialize a parameter. More...
       
      virtual bool attributeChanged (std::string const &name) const
       Checks the data model to see if a parameter has changed. More...
       
      +void addListener (Listener &listener) const
       Adds a listener of object's parameters.
       
      +void removeListener (Listener &listener) const
       Removes listenere from list.
       
      +std::string getName () const
       Returns the name of the Object.
       
      +ObjectClass const & getClass () const
       Returns the object's static definition.
       
      +std::string getText () const
       Returns the text of the Object.
       
      +flip::Array< Inlet > const & getInlets () const
       Returns the inlets of the Object.
       
      +Inlet const & getInlet (size_t index) const
       Returns the inlets at index.
       
      +size_t getNumberOfInlets () const
       Returns the number of inlets.
       
      +bool inletsChanged () const noexcept
       Returns true if the inlets changed.
       
      +flip::Array< Outlet > const & getOutlets () const
       Returns the number of outlets.
       
      +Outlet const & getOutlet (size_t index) const
       Returns the outlets at corresponding index.
       
      +size_t getNumberOfOutlets () const
       Returns the number of outlets.
       
      +bool outletsChanged () const noexcept
       Returns true if the outlets changed.
       
      +void setPosition (double x, double y)
       Sets the x/y graphical position of the object.
       
      +bool positionChanged () const noexcept
       Returns true if the object's position changed.
       
      +bool sizeChanged () const noexcept
       Returns true if the object's size changed.
       
      +bool boundsChanged () const noexcept
       Returns true if the position or the size of the object changed.
       
      +double getX () const noexcept
       Returns the x position.
       
      +double getY () const noexcept
       Returns the y position.
       
      void setWidth (double new_width)
       Sets the width of the object. More...
       
      void setHeight (double new_height)
       Sets the height of the object. More...
       
      +double getRatio () const
       Returns the aspect ratio.
       
      +double getWidth () const noexcept
       Returns the object's width.
       
      +double getHeight () const noexcept
       Returns the object's height.
       
      +double getMinWidth () const noexcept
       Returns the minimal width for this object.
       
      +double getMinHeight () const noexcept
       Returns the minimal height for this object;.
       
      +bool hasFlag (ObjectClass::Flag flag) const
       Checks if the object has this flag set.
       
      template<class... Args>
      auto & getSignal (SignalKey key) const
       Returns the object's signal referenced by this key. More...
       
      + Object (flip::Default &)
       
      + + + + + + +

      +Static Public Member Functions

      +static void declare ()
       
      - Static Public Member Functions inherited from kiwi::model::Object
      +static void declare ()
       
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Additional Inherited Members

      - Public Types inherited from kiwi::model::Object
      +using SignalKey = uint32_t
       
      - Protected Member Functions inherited from kiwi::model::Object
      +template<class... Args>
      void addSignal (SignalKey key, model::Object &object)
       Adds a signal having singal key.
       
      +void setInlets (flip::Array< Inlet > const &inlets)
       Clear and replace all the object's inlets.
       
      +void setOutlets (flip::Array< Outlet > const &outlets)
       Clear and replace all the object's outlets.
       
      +void pushInlet (std::set< PinType > type)
       Adds an inlet at end of current inlet list.
       
      +void pushOutlet (PinType type)
       Adds an outlet at end of current outlet list.
       
      void setRatio (double ratio)
       Sets the ratio height/width. More...
       
      void setMinWidth (double min_width)
       Sets the minimal width that the object can have. More...
       
      void setMinHeight (double min_height)
       Sets the minimal height that the object can have. More...
       
      +
      The documentation for this class was generated from the following files:
        +
      • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Operator.h
        • +
      • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Operator.cpp
        • +
      +
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_operator.png b/docs/html/classkiwi_1_1model_1_1_operator.png new file mode 100644 index 0000000000000000000000000000000000000000..3997213dab5879c1a7c94a12b63073cd7672c7f0 GIT binary patch literal 5499 zcmdT|eN<9;{>Iv-snmA2QQPrtW?!cHjj3hRVjx<(nb{;vzNUy~{nD`}7z-p(q-~}g zrwMj{O_}0LWlExgGp39e0Y^uj9aBpJEWDtS3L=;xY9O)~Z8GNU%Q<`cqaWu0_kQm^ z-}AlC=ef`Ge7^Y~qQjilzPT0#gE@uo-5m*oIUr!LmG8d35*qo)b3g|DZTxV5bg0#8 zg$~sdMiQg-uh7xrx22_JRsMiCbox3m5*-DDZnAwOKSl?@U@mLJckhZm?VtmPuH4wW zV%5-=z%YgNBJYjR4{JEWYVk4fp=0RIR14y5>o;;;CU;}Y1)h6nMvh<~oUYm!17vt~ z-s-!k3fyxU@6ow+T&!{S8Je<8L&K7}5RPStxJ@oN{uOjBqr59oPVE-e52t&1DbR9N zAe{zsuOpw7bV%fZ^domC3rX%oK}u(a2Ty*J8B4d#s+d&Nm{b4m*_kmPFG@Y9tA{3< zA{6O+_&yW2$Ew;Arut`}vg9?XaZgT}I=3CC8#Q(dGMCZ^j@bw|JFu z-=u={O0!){g0+g2Hx&{Ql%=Vc$ z><~P4f>X!JJ3CGyM6gVQdQ5;MrXtF%oX8HRy&Z>;)bv&Dxs2Y~{%^+o(BT&lmYNSZnJ`+i2G+XvWkUR{X2vdcCLh$htUNuHG;KX% zS4hDo@OE00Rj$m~@ok{4_xK|#dE;Oinc+MbcH*8VPblhP^?7y<{cu00C*#z~!c>V& zJN1={)t+9kuA~>4?lt4t=D3+(E)_yjcWhPC3 z(m|XK`W2)8F>xphi=*=@_-DGYtc>}FO~NeM6LHq&*&1xIC^9x82Xig)ysUDt zTwWAxSZmhe`>R9$M24#rYqLj-3&iUzM`b5NgNLeZ6=qujJGL*s&`=TDwmAB4Y-yu7 zd$x4Oy)*^+50X^+XSieA<1ZY7YBt@g5+*@!;0tR~5c%!elZ^2_1)mzE`p3Mi3Aqn- z?V`N!vkQA!NP1gual+O8s~H=PQ<&%-xe4NKSyQtwCKgnK8oxsZX?o6y-W&sGg!Mpk z1yB8Ed=CLl7AiUKax(EED#Y?l)%a=@#Kcqq$>}TpVaUZeorKC)7RFeT{jGEf7HpXV_WUTxDm}Mp8Lzc9mOy zItrZ7X)2%I>ELF~&22S&sub+`wwji|zL*3j zOUT4HO#O%_U)b7Fk0zD#DzU!52Kc|3jqM*<5v1K5+ph{Z6`vAA$WBH`XbH=az)oDA zTWJa^&v{Sr0WvOL|Eioy@gg)9(OqnA8+TD)0KPJ)O@Dk;plj z-st(ZDni(zqSLW*SyN?{K#a9Hs`cspc{81Psq6h1VG@Jo5#o!+(uQ*MS?1;=B#nW^ z)Cyd{RUa!57rDAZf}&xb=;ij;_IvF^Yt$#lHN!HN(A};m!<*l^>jDnP^A=>LP+~zD zt>Nw+grP5E2Xzezb+15{y=776g+`}rimT-lDHyE9rwvF%-{XK;K?-4#O;B@6Q@fCv z)N>cpz#{$h8`M*PI(4va3XJ`c1_cV zO%!YoAkl{?zZYGC3}qKww-5%OSh800^6MZ!Eyel2B^o@BW8VSGu_0RhK%Hn5lK#DF zed+)5U&v8SNQ4AQeGSa;$o=tt>;FPI zCRi*d{x~Ie0!MBdv?E`&xs6#{P5sEF2s!t#^yyNBbRE!0u3EE3t*yg4P*WLxV^R7q zdQ(Xci}X)^fkJ7e)<99Ae)#JfNZ&Q?@CiwC63w!MXtv~9=kB*39N5cR-3K{9N4=in z5U;H3vi5Y|0Y)a{712vRP~twbP>Kw&+5KAr}fKvbk~gYuW+gr+|TS z;NHk!Gf6Q=vCdSpwZUf>?Vx1Z`edK?F0x0ScW}d1^jQ9FX5x|powyef2PBTKzed0; zS-}sV4BM=rwm&Yd1|12GLq&MzzvtQ{^6d+jOVI=qm6#{eiuJ|jGDY1Y^3gmdLDJSS zqM6CFB^m|Gtai^th2!@Nv!ysk8KaTODjnZ5iFuAWd_s#fisKGSXfbw=v21a#q~0G{ z*841N^VbWCj(j#;fLhFuNR4$5l-%cAs@jP~&Rz%6i~T8+SiJ$0<~viJWRw!!>aw)& z3mdtP&MPipd}byw&G4s+LVVFX5I2pVB}SCl5Eg9sfJ{NoYoEhiu-U)!(c2PH}6)))?iiKB!+>>QY}bOY*%1t?Y%aXT9~$ zRpph;Gn?){&oez(ew(sP$l`R2-K|=<*LvvvxI}EDiJ_g zkS6%NetbwMu7;9^K=|Dl(@KUa{ptTFzVgM-`C7`$6f0+wqXe35He`K4WwPp1HC^@C zz)JmGH993uiS<<4!Uadu6W3%qJ6@tF)35j=p`=4LQ?qq4As4s>T5O}G`hcSxn(kQd zsJy#|ZyU;e8_bBAE5##5M1mBEvI|pHigaPjdiR1niTC1mRrd*#60CzUCO36`4`dUy zY2bQ%|9aN*jLkfHShbE#rjVg<{lb2mohCdJ+X>pvGRw(CpPedbrxX?*ir&rn)1kBf E02&^v&;S4c literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_operator_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_operator_tilde-members.html new file mode 100644 index 00000000..d7e3e012 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_operator_tilde-members.html @@ -0,0 +1,160 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +
      kiwi::model::OperatorTilde Member List
      +
      +
      + +

      This is the complete list of members for kiwi::model::OperatorTilde, including all inherited members.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      addListener(Listener &listener) const kiwi::model::Object
      addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
      attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
      boundsChanged() const noexceptkiwi::model::Object
      declare() (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildestatic
      getArguments() const kiwi::model::Object
      getAttribute(std::string const &name) const kiwi::model::Object
      getChangedAttributes() const kiwi::model::Object
      getClass() const kiwi::model::Object
      getHeight() const noexceptkiwi::model::Object
      getInlet(size_t index) const kiwi::model::Object
      getInlets() const kiwi::model::Object
      getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
      getMinHeight() const noexceptkiwi::model::Object
      getMinWidth() const noexceptkiwi::model::Object
      getName() const kiwi::model::Object
      getNumberOfInlets() const kiwi::model::Object
      getNumberOfOutlets() const kiwi::model::Object
      getOutlet(size_t index) const kiwi::model::Object
      getOutlets() const kiwi::model::Object
      getParameter(std::string const &name) const kiwi::model::Object
      getRatio() const kiwi::model::Object
      getSignal(SignalKey key) const kiwi::model::Objectinline
      getText() const kiwi::model::Object
      getWidth() const noexceptkiwi::model::Object
      getX() const noexceptkiwi::model::Object
      getY() const noexceptkiwi::model::Object
      hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
      inletsChanged() const noexceptkiwi::model::Object
      Object()kiwi::model::Object
      Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
      OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
      OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
      outletsChanged() const noexceptkiwi::model::Object
      positionChanged() const noexceptkiwi::model::Object
      pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
      pushOutlet(PinType type)kiwi::model::Objectprotected
      readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
      removeListener(Listener &listener) const kiwi::model::Object
      setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
      setHeight(double new_height)kiwi::model::Object
      setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
      setMinHeight(double min_height)kiwi::model::Objectprotected
      setMinWidth(double min_width)kiwi::model::Objectprotected
      setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
      setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
      setPosition(double x, double y)kiwi::model::Object
      setRatio(double ratio)kiwi::model::Objectprotected
      setWidth(double new_width)kiwi::model::Object
      SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
      sizeChanged() const noexceptkiwi::model::Object
      writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
      ~Object()=defaultkiwi::model::Objectvirtual
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_operator_tilde.html b/docs/html/classkiwi_1_1model_1_1_operator_tilde.html new file mode 100644 index 00000000..b4580ed4 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_operator_tilde.html @@ -0,0 +1,347 @@ + + + + + + +Kiwi: kiwi::model::OperatorTilde Class Reference + + + + + + + + + + +
      +
      + + + + + + +
      +
      Kiwi +
      +
      +
      + + + + + + +
      +
      + + +
      + +
      + + +
      +
      +
      +Public Member Functions | +Static Public Member Functions | +List of all members
      +
      +
      kiwi::model::OperatorTilde Class Reference
      +
      +
      +
      +Inheritance diagram for kiwi::model::OperatorTilde:
      +
      +
      + + +kiwi::model::Object +kiwi::model::DifferentTilde +kiwi::model::DivideTilde +kiwi::model::EqualTilde +kiwi::model::GreaterEqualTilde +kiwi::model::GreaterTilde +kiwi::model::LessEqualTilde +kiwi::model::LessTilde +kiwi::model::MinusTilde +kiwi::model::PlusTilde +kiwi::model::TimesTilde + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Public Member Functions

      + OperatorTilde (flip::Default &d)
       
      + OperatorTilde (std::vector< tool::Atom > const &args)
       
      +std::string getIODescription (bool is_inlet, size_t index) const override
       Returns inlet or outlet description.
       
      - Public Member Functions inherited from kiwi::model::Object
      + Object ()
       Constructor.
       
      +virtual ~Object ()=default
       Destructor.
       
      +std::vector< tool::Atom > const & getArguments () const
       Returns the arguments of the object.
       
      std::set< std::string > getChangedAttributes () const
       Returns a list of changed attributes. More...
       
      +tool::Parameter const & getAttribute (std::string const &name) const
       Retrieve one of the object's attributes.
       
      +void setAttribute (std::string const &name, tool::Parameter const &param)
       Sets one of the object's attribute.
       
      +tool::Parameter const & getParameter (std::string const &name) const
       Returns one of the object's parameters.
       
      +void setParameter (std::string const &name, tool::Parameter const &param)
       Sets one of the object's parameter.
       
      virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
       Writes the parameter into data model. More...
       
      virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
       Reads the model to initialize a parameter. More...
       
      virtual bool attributeChanged (std::string const &name) const
       Checks the data model to see if a parameter has changed. More...
       
      +void addListener (Listener &listener) const
       Adds a listener of object's parameters.
       
      +void removeListener (Listener &listener) const
       Removes listenere from list.
       
      +std::string getName () const
       Returns the name of the Object.
       
      +ObjectClass const & getClass () const
       Returns the object's static definition.
       
      +std::string getText () const
       Returns the text of the Object.
       
      +flip::Array< Inlet > const & getInlets () const
       Returns the inlets of the Object.
       
      +Inlet const & getInlet (size_t index) const
       Returns the inlets at index.
       
      +size_t getNumberOfInlets () const
       Returns the number of inlets.
       
      +bool inletsChanged () const noexcept
       Returns true if the inlets changed.
       
      +flip::Array< Outlet > const & getOutlets () const
       Returns the number of outlets.
       
      +Outlet const & getOutlet (size_t index) const
       Returns the outlets at corresponding index.
       
      +size_t getNumberOfOutlets () const
       Returns the number of outlets.
       
      +bool outletsChanged () const noexcept
       Returns true if the outlets changed.
       
      +void setPosition (double x, double y)
       Sets the x/y graphical position of the object.
       
      +bool positionChanged () const noexcept
       Returns true if the object's position changed.
       
      +bool sizeChanged () const noexcept
       Returns true if the object's size changed.
       
      +bool boundsChanged () const noexcept
       Returns true if the position or the size of the object changed.
       
      +double getX () const noexcept
       Returns the x position.
       
      +double getY () const noexcept
       Returns the y position.
       
      void setWidth (double new_width)
       Sets the width of the object. More...
       
      void setHeight (double new_height)
       Sets the height of the object. More...
       
      +double getRatio () const
       Returns the aspect ratio.
       
      +double getWidth () const noexcept
       Returns the object's width.
       
      +double getHeight () const noexcept
       Returns the object's height.
       
      +double getMinWidth () const noexcept
       Returns the minimal width for this object.
       
      +double getMinHeight () const noexcept
       Returns the minimal height for this object;.
       
      +bool hasFlag (ObjectClass::Flag flag) const
       Checks if the object has this flag set.
       
      template<class... Args>
      auto & getSignal (SignalKey key) const
       Returns the object's signal referenced by this key. More...
       
      + Object (flip::Default &)
       
      + + + + + + +

      +Static Public Member Functions

      +static void declare ()
       
      - Static Public Member Functions inherited from kiwi::model::Object
      +static void declare ()
       
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      +Additional Inherited Members

      - Public Types inherited from kiwi::model::Object
      +using SignalKey = uint32_t
       
      - Protected Member Functions inherited from kiwi::model::Object
      +template<class... Args>
      void addSignal (SignalKey key, model::Object &object)
       Adds a signal having singal key.
       
      +void setInlets (flip::Array< Inlet > const &inlets)
       Clear and replace all the object's inlets.
       
      +void setOutlets (flip::Array< Outlet > const &outlets)
       Clear and replace all the object's outlets.
       
      +void pushInlet (std::set< PinType > type)
       Adds an inlet at end of current inlet list.
       
      +void pushOutlet (PinType type)
       Adds an outlet at end of current outlet list.
       
      void setRatio (double ratio)
       Sets the ratio height/width. More...
       
      void setMinWidth (double min_width)
       Sets the minimal width that the object can have. More...
       
      void setMinHeight (double min_height)
       Sets the minimal height that the object can have. More...
       
      +
      The documentation for this class was generated from the following files:
        +
      • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.h
        • +
      • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_OperatorTilde.cpp
        • +
      +
      + +
      +Generated by   +doxygen + 1.8.11 +
      + + diff --git a/docs/html/classkiwi_1_1model_1_1_operator_tilde.png b/docs/html/classkiwi_1_1model_1_1_operator_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..1e501ba52d9dde3086bb0a7e59d234138f0fcfc0 GIT binary patch literal 5367 zcmdT|dsI?cqX*F_HNDMbW@FN=>1&!wru+(DNHb;jluC_Ck@2?Fa`KTcR1mDbbXra^ zO*3hk(%TXP%kqhUIx~J{NM&Y9JhXg)z$xP;9Jq(HZZ&h)_s4D4`YvmowfAA4wa-5L zw||elk8TYOneI5p5e9=z->`n|b{Gtv0)yGrO+`Te?EZPj2B?_5b#r*I)oO*R!=u^^ zM$3;-?e!%P2po<+MM1Yy)3=9)!Jvn1zplICD`2ph`5V@L9i9bONmQw<^)*xaK0o@S z+IpO^kXHfgDLehxf0@~Ty%W5Jg7ZdORyel;F>q>9D@fzh!{L0HM&DvbgNh>#W~gv- zGC&RPvjB&FrPAonZ<1*wIy`tO4^zfS=BQ@_^qJJi?$++zq|u?3)~wTdjot*(m&hr= zqH(S&T5Y>qCNFTK*_EBxZWn|NK}6TLG=@QcTX62c?`b*P$I$>7Fz>!}pmBWrWc%G|*x}KGi*J9_g zb*BLC=;ZrULEgYt}62bA#qm zJ=vdrc<9QhpGMAHngJ)!0He%DKgnmN~RyMsF^8#cJEP+ zu*QDKEpXXgBQdQf^Ws2*kqr3ip2&E&aS8Rg8(#7pn5YZwS;mD1<3;_=1q1cf zTU4kW29}2u{C!S8iJg*1EXv*MwFr(7XZp8_OIEF+z%oIYr994{J~6E|hGMQ4J&UJw z-($wk4n*A)4zyd+x!B%A`dWtuRjM3j4cF9B1n_8x3~U>XvaRO#m%J$*h?$))a-0WG zmq5(f0!Lm|W)}Lc-es$_2lT@tAe!7t`KUDckbPeY+75W)mgech?bzen-dRu(f1YRs z1%njITJ0s(^9D>H@6-ZD(@3deLu)$Ny^^tnZazwIcugT;V|l%zy_aSE(vTK;^-5Fh za_`k+pOm2~JZ1AxNg%tp!@JN@-#_#j#-zlnlPh{Nf`Mb%l9Jl;2mLoa6J*yDR5U_b zZdwLHDht1@JS1x(=LMNx`zH>HkvG!Ny+=&hL-ju}~HL{T;O?A^P_hkO5lVKGF-p&)Gy3N19 zDd;6H>6^jj*CAxg?bvi8P`Z|%&QR7+jB!Ww?waOC=y^L{(`MH@VSoyMnQxd$^}C!i zTq=h^(GAkP7K=&~6RcG&Bq6ZCV0n;}x>0+70CgspBQSYL!@NR5;_4La3HdW9U&GNX z-g0cfM->tYfQ!4<6hZ3?W0SXc)cl<;CuWT zBzR>T1rfN4NgbXXXyaFg`_yE{)v{ZqQTqI$BE^lEAd|L%)-N_$A$KBWOks~-7^)vQ zlqa%+L%MH^6Fx7B_2bC*o$t^bmy0@;xiy8Sk~{kbD;3#AQ)I>6P1zLZe?%nsJ>o^q zb$_T05^i#m%D&NZmmJpkj$dw^>z6wcmt`%aOp|i2mbnAE*fG_*yJ~c7c6L$bKH5&*JU1{_{~^6?UBR`$Hb+hM~@AR5Q9x)|?c^wsu3{Nc!52aL}b4v?exFiEjF& zPQmd<(AA}~cvlD~wRiUvdJ@Abel*U1`nZ?7w7d($|IS;9tBPtIMI##`(V9$sByUSW zNj1T40xR<`94k1m)s*zxE{~FG;YbgMC~%6`ADzXu?sK=3fhf~u@##|7vi0KmiFuiF zp|ghGhHe%!tg*oKMEw)umTu%oX7-X=>&0F**^Y;elTD*FN|KV3Fxv+`Ozm#8vwdw{ zO(w9(o{rrwFAmbsYy4D&~67p*NTx2@oifY=E zD3kf{>HKee6h#L+gM7<3k>w!1(WOpd-6X8s3I@XoAjg)OppxMJKJl0?K~Tin1?QGK zrsP4UHvZQ__(33awCS#^lN|d?9*Y+K{#wi20Gu~Uy|!WZ1@uI%qUK)nQo7>Ul&JBH z^q?0iQNxP2cn+nc`vK*)e8CU8J%9hE1JTW${byw>i?pbnY@)6Rp=9h#5=%leWWmjt z!Hi@nPe*vAg>bwbxo#b$#t%EDlY^>oJ@Hd&$bGb=W7Key4J1Cm&;o!Yvu9Fy16n?I z^X%V#dvPP66K`k_RvskCIjDM#JztVki_wGYv(@{dw}G5Z z;c!r8q>8qD<7l@sr_jA9dPbC%0LIHJ&^cw1-iAGLk?IAr6w=4vFr3bPejOSYxj498 zullJC+0Cpfo#36KhB%$NCt5$KdJ)ghSqk|U>+yIDvM~|7%*LJ1-q&m@VTm)B0}^@z zsX=_Avj_~_=_-;9c}T4rNry0KMGcq@Y`KA8qJCVoAXbmLm20*)KVNPN1;naMN*elY zh(GDUqo36+xD5K?uBY4nx+2@f~mC#Tw?&uR8XD-EntTZ5}-F z@Q2fb%|@!^upUFGwdti>snD^DG&7~kdTYWuM39{RS)$LvyUAgT?IJi(7lG7Iyqe2f(IFdck2QU2&TN!OpQ1zFY_VRWQ})Bp zYIVgBc&s2!wgjN%^JgzU-B-cs#jVKj-Oup*N_133Y^}TZQ(UpYmr@sX5g!mA9n_PzVU;cNfI^zDMw^K? zk$Tz-$59WVkl_Xl4jAp95_SE(Cr><-1#2tGhh#~$;u6zuZ&Xey1T+GC$VPowID=@N z3>hU<+)dZcKp!q*Lg3nDR$I(4k=iVhR2A*gE880zpg{4zguZ|8Y~hZ4n=O=5z~E0) zXB(8icJ~?Y)nY7rpunVXrdl$&ovEM8v3JuV9}h!k4!dWUFEndc5Fet4r%;@xNFl4Pq_pfoa6>1RaTyd3!tXKCdpx63~f@?EBERTN{kk-igMy? i2o1u&(yDRXwX&&O4`jSxL8p|k4Z)#n+24G7=)VE3KM+I! literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_osc_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_osc_tilde-members.html index 8efe5bc6..ca2f53f6 100644 --- a/docs/html/classkiwi_1_1model_1_1_osc_tilde-members.html +++ b/docs/html/classkiwi_1_1model_1_1_osc_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::OscTilde, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::OscTilde)kiwi::model::OscTildestatic
    declare() (defined in kiwi::model::OscTilde)kiwi::model::OscTildestatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OscTildevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OscTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    OscTilde(flip::Default &d)kiwi::model::OscTildeinline
    OscTilde(std::string const &name, std::vector< Atom > const &args)kiwi::model::OscTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    OscTilde(flip::Default &d) (defined in kiwi::model::OscTilde)kiwi::model::OscTildeinline
    OscTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OscTilde)kiwi::model::OscTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_osc_tilde.html b/docs/html/classkiwi_1_1model_1_1_osc_tilde.html index bfabd08a..b404ae9f 100644 --- a/docs/html/classkiwi_1_1model_1_1_osc_tilde.html +++ b/docs/html/classkiwi_1_1model_1_1_osc_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::OscTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - OscTilde (flip::Default &d)
     flip Default Constructor
    + OscTilde (flip::Default &d)
     
    - OscTilde (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + OscTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_OscTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_OscTilde.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_outlet-members.html b/docs/html/classkiwi_1_1model_1_1_outlet-members.html index 7f862e7c..92e33c85 100644 --- a/docs/html/classkiwi_1_1model_1_1_outlet-members.html +++ b/docs/html/classkiwi_1_1model_1_1_outlet-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -70,7 +97,7 @@

    This is the complete list of members for kiwi::model::Outlet, including all inherited members.

    - + @@ -79,7 +106,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_outlet.html b/docs/html/classkiwi_1_1model_1_1_outlet.html index be0c277e..77b0a857 100644 --- a/docs/html/classkiwi_1_1model_1_1_outlet.html +++ b/docs/html/classkiwi_1_1model_1_1_outlet.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::model::Outlet Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    declare() (defined in kiwi::model::Outlet)kiwi::model::Outletstatic
    getType() const (defined in kiwi::model::Outlet)kiwi::model::Outlet
    getType() const (defined in kiwi::model::Outlet)kiwi::model::Outlet
    Outlet(PinType type)kiwi::model::Outlet
    Outlet(flip::Default &) (defined in kiwi::model::Outlet)kiwi::model::Outlet
    ~Outlet()=defaultkiwi::model::Outlet
    - + - - - - + +
    @@ -86,24 +113,24 @@ - - - - - + +

    Public Member Functions

    +
     Outlet (PinType type)
     Initializes the Inlet with one type.
     
    +
     ~Outlet ()=default
     The destructor.
     
    -PinType const & getType () const
     
    +
    +PinType const & getType () const
     
     Outlet (flip::Default &)
     
    -

    Static Public Member Functions

    +
    static void declare ()
     
    @@ -118,7 +145,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_pack-members.html b/docs/html/classkiwi_1_1model_1_1_pack-members.html new file mode 100644 index 00000000..a20b2dc3 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_pack-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Pack Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Pack, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Pack)kiwi::model::Packstatic
    declare() (defined in kiwi::model::Pack)kiwi::model::Packstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Packvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    Pack(flip::Default &d) (defined in kiwi::model::Pack)kiwi::model::Packinline
    Pack(std::vector< tool::Atom > const &args) (defined in kiwi::model::Pack)kiwi::model::Pack
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_pack.html b/docs/html/classkiwi_1_1model_1_1_pack.html new file mode 100644 index 00000000..0c797c08 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_pack.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Pack Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Pack Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Pack:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Pack (flip::Default &d)
     
    + Pack (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pack.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pack.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_pack.png b/docs/html/classkiwi_1_1model_1_1_pack.png new file mode 100644 index 0000000000000000000000000000000000000000..209ffdb09b81e028a9c0cccf9e18ac931be74544 GIT binary patch literal 719 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;qn0yZKRx{p}|_saLP>oNr|O`^4H^ zZ>OFA^E-0wZ2?o`-v{*XIe(Y`6L0x`|MKJiMU9Q+_npvGx+LCEeTHFfSUN-Tan-~=O_Ef>DRlh#02;Q{6 z(j|23A+wox)z;6~DTz>EEAtDz>V0L-$?H+8AI04IB~)^0xclzjK~`uDF+O8gi*<+E1G+Z?D$8)A9)ATN}DPGSWSNYhLodnETFa*T1xX zmb35XvHwP)p+JvX`d+?5mQR(G<~lO$G6DvJ%{!jMf1KykEyy+Mb&6ziz3r;y*8ue5 z)l@r+>EHNRHyu6nWYg3Otzopr E02Mf7Gynhq literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_parameter_class-members.html b/docs/html/classkiwi_1_1model_1_1_parameter_class-members.html new file mode 100644 index 00000000..4d07b337 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_parameter_class-members.html @@ -0,0 +1,113 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::ParameterClass Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::ParameterClass, including all inherited members.

    + + + + + + + +
    getDataType() const kiwi::model::ParameterClass
    getType() const kiwi::model::ParameterClass
    ObjectClass (defined in kiwi::model::ParameterClass)kiwi::model::ParameterClassfriend
    ParameterClass(tool::Parameter::Type type)kiwi::model::ParameterClass
    Type enum name (defined in kiwi::model::ParameterClass)kiwi::model::ParameterClass
    ~ParameterClass()kiwi::model::ParameterClass
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_parameter_class.html b/docs/html/classkiwi_1_1model_1_1_parameter_class.html new file mode 100644 index 00000000..b23144aa --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_parameter_class.html @@ -0,0 +1,154 @@ + + + + + + +Kiwi: kiwi::model::ParameterClass Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +Friends | +List of all members
    +
    +
    kiwi::model::ParameterClass Class Reference
    +
    +
    + +

    This is a parameter static informations. + More...

    + +

    #include <KiwiModel_ObjectClass.h>

    + + + + +

    +Public Types

    enum  Type { Attribute, +Parameter + }
     
    + + + + + + + + + + + + + +

    +Public Member Functions

    + ParameterClass (tool::Parameter::Type type)
     Constructor.
     
    + ~ParameterClass ()
     Destructor.
     
    +ParameterClass::Type getType () const
     Sets the attributes type. Only used by factory.
     
    +tool::Parameter::Type getDataType () const
     Returns the parameter's data type.
     
    + + + +

    +Friends

    +class ObjectClass
     
    +

    Detailed Description

    +

    This is a parameter static informations.

    +

    Attributes and Parameters share the same static representation.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_patcher-members.html b/docs/html/classkiwi_1_1model_1_1_patcher-members.html index 8ed8de2a..d710e1f2 100644 --- a/docs/html/classkiwi_1_1model_1_1_patcher-members.html +++ b/docs/html/classkiwi_1_1model_1_1_patcher-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -70,43 +97,42 @@

    This is the complete list of members for kiwi::model::Patcher, including all inherited members.

    - + - + - - - - - + + + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - + + + + +
    addLink(model::Object const &from, const size_t outlet, model::Object const &to, const size_t inlet)kiwi::model::Patcher
    addObject(std::string const &name, std::vector< Atom > const &args)kiwi::model::Patcher
    addObject(std::unique_ptr< model::Object > &&object)kiwi::model::Patcher
    addObject(std::string const &name, flip::Mold const &mold)kiwi::model::Patcher
    declare() (defined in kiwi::model::Patcher)kiwi::model::Patcherstatic
    getLinks() const noexceptkiwi::model::Patcher
    getLinks() const noexceptkiwi::model::Patcher
    getLinks() noexceptkiwi::model::Patcher
    getName() constkiwi::model::Patcher
    getObjects() const noexceptkiwi::model::Patcher
    getObjects() noexceptkiwi::model::Patcher
    getUsers() const noexceptkiwi::model::Patcher
    getUsers() noexceptkiwi::model::Patcher
    getObjects() const noexceptkiwi::model::Patcher
    getObjects() noexceptkiwi::model::Patcher
    getUsers() const noexceptkiwi::model::Patcher
    getUsers() noexceptkiwi::model::Patcher
    hasSelfUser() const kiwi::model::Patcher
    Links typedef (defined in kiwi::model::Patcher)kiwi::model::Patcher
    linksChanged() const noexceptkiwi::model::Patcher
    nameChanged() const noexceptkiwi::model::Patcher
    Objects typedef (defined in kiwi::model::Patcher)kiwi::model::Patcher
    objectsChanged() const noexceptkiwi::model::Patcher
    Patcher()kiwi::model::Patcher
    removeLink(model::Link const &link, Patcher::View *view=nullptr)kiwi::model::Patcher
    removeObject(model::Object const &object, Patcher::View *view=nullptr)kiwi::model::Patcher
    setName(std::string const &new_name)kiwi::model::Patcher
    signal_get_connected_users (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Signal_GET_CONNECTED_USERS enum value (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Signal_RECEIVE_CONNECTED_USERS enum value (defined in kiwi::model::Patcher)kiwi::model::Patcher
    signal_receive_connected_users (defined in kiwi::model::Patcher)kiwi::model::Patcher
    signal_user_connect (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Signal_USER_CONNECT enum value (defined in kiwi::model::Patcher)kiwi::model::Patcher
    signal_user_disconnect (defined in kiwi::model::Patcher)kiwi::model::Patcher
    linksChanged() const noexceptkiwi::model::Patcher
    Objects typedef (defined in kiwi::model::Patcher)kiwi::model::Patcher
    objectsChanged() const noexceptkiwi::model::Patcher
    Patcher()kiwi::model::Patcher
    removeLink(model::Link const &link, Patcher::View *view=nullptr)kiwi::model::Patcher
    removeObject(model::Object const &object, Patcher::View *view=nullptr)kiwi::model::Patcher
    replaceObject(model::Object const &old_object, std::unique_ptr< model::Object > &&object)kiwi::model::Patcher
    signal_get_connected_users (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Signal_GET_CONNECTED_USERS enum value (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Signal_RECEIVE_CONNECTED_USERS enum value (defined in kiwi::model::Patcher)kiwi::model::Patcher
    signal_receive_connected_users (defined in kiwi::model::Patcher)kiwi::model::Patcher
    signal_user_connect (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Signal_USER_CONNECT enum value (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Signal_USER_DISCONNECT enum value (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Users typedef (defined in kiwi::model::Patcher)kiwi::model::Patcher
    usersChanged() const noexceptkiwi::model::Patcher
    useSelfUser()kiwi::model::Patcher
    ~Patcher()kiwi::model::Patcher
    signal_user_disconnect (defined in kiwi::model::Patcher)kiwi::model::Patcher
    Users typedef (defined in kiwi::model::Patcher)kiwi::model::Patcher
    usersChanged() const noexceptkiwi::model::Patcher
    useSelfUser()kiwi::model::Patcher
    ~Patcher()kiwi::model::Patcher
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_patcher.html b/docs/html/classkiwi_1_1model_1_1_patcher.html index d5106330..137d2690 100644 --- a/docs/html/classkiwi_1_1model_1_1_patcher.html +++ b/docs/html/classkiwi_1_1model_1_1_patcher.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Patcher Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -98,36 +125,39 @@ - - - -

    Public Types

    enum  { Signal_USER_CONNECT = 0, +
    enum  { Signal_USER_CONNECT = 0, Signal_USER_DISCONNECT, Signal_GET_CONNECTED_USERS, Signal_RECEIVE_CONNECTED_USERS }
     
    +
    using Objects = flip::Array< model::Object >
     
    +
    using Links = flip::Array< model::Link >
     
    +
    using Users = flip::Collection< User >
     
    - - - - - - + + + + + + @@ -140,85 +170,75 @@ - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + - - - - + + + - - - - + + + + + +

    Public Member Functions

    +
     Patcher ()
     Default constructor.
     
    +
     ~Patcher ()
     Destructor.
     
    model::Object & addObject (std::string const &name, std::vector< Atom > const &args)
     Try to create an Object with a text. More...
     
    +
    model::Object & addObject (std::unique_ptr< model::Object > &&object)
     Adds an object to the patcher model. More...
     
    model::Object & replaceObject (model::Object const &old_object, std::unique_ptr< model::Object > &&object)
     Replaces an object by another one. More...
     
    model::Object & addObject (std::string const &name, flip::Mold const &mold)
     create an Object from a flip::Mold.
     
    void removeLink (model::Link const &link, Patcher::View *view=nullptr)
     Removes a link from the Patcher. More...
     
    -bool objectsChanged () const noexcept
     Returns true if an Object has been added, removed or changed.
     
    -bool linksChanged () const noexcept
     Returns true if a Link has been added, removed or changed.
     
    -bool usersChanged () const noexcept
     Returns true if a User has been added, removed or changed.
     
    -bool nameChanged () const noexcept
     Returns true if the Patcher name changed.
     
    -std::string getName () const
     Returns the Patcher name.
     
    -void setName (std::string const &new_name)
     Sets the Patcher name.
     
    -Objects const & getObjects () const noexcept
     Gets the objects.
     
    +
    +bool objectsChanged () const noexcept
     Returns true if an Object has been added, removed or changed.
     
    +bool linksChanged () const noexcept
     Returns true if a Link has been added, removed or changed.
     
    +bool usersChanged () const noexcept
     Returns true if a User has been added, removed or changed.
     
    +Objects const & getObjects () const noexcept
     Gets the objects.
     
    Objects & getObjects () noexcept
     Gets the objects.
     
    -Links const & getLinks () const noexcept
     Gets the links.
     
    +
    +Links const & getLinks () const noexcept
     Gets the links.
     
    Links & getLinks () noexcept
     Gets the links.
     
    -Users const & getUsers () const noexcept
     Gets the users.
     
    +
    +Users const & getUsers () const noexcept
     Gets the users.
     
    Users & getUsers () noexcept
     Gets the users.
     
    +bool hasSelfUser () const
     Returns true if current user is already in added to the document.
     
    User & useSelfUser ()
     Returns the current User. More...
     
    -

    Static Public Member Functions

    +
    static void declare ()
     
    - - - -

    Public Attributes

    +
    flip::Signal< uint64_t > signal_user_connect
     
    +
    flip::Signal< uint64_t > signal_user_disconnect
     
    +
    flip::Signal signal_get_connected_users
     
    +
    flip::Signal< std::vector< uint64_t > > signal_receive_connected_users
     

    Detailed Description

    The Patcher manages a set of Object and Link.

    Member Function Documentation

    - -

    ◆ addLink()

    - +
    @@ -268,46 +288,32 @@

    -

    ◆ addObject()

    - +

    - - - - - + + - - - - - - -
    model::Object & kiwi::model::Patcher::addObject (std::string const & name,
    std::unique_ptr< model::Object > && object) std::vector< Atom > const & args 
    )
    -

    Try to create an Object with a text.

    -

    This function will first parse the input string in a vector of atom to find a registered name object as first atom. the last atoms are passed to the created object as arguments.

    Parameters
    +

    Adds an object to the patcher model.

    +
    Parameters
    - +
    textA string composed by the name of the object optionnally followed by a space and a list of argument values (ex : "plus 42")
    Theobject to add in the text.
    -
    Returns
    An Object.
    +
    Returns
    A reference to the object added.
    - -

    ◆ removeLink()

    - +
    @@ -341,9 +347,7 @@

    -

    ◆ removeObject()

    - +

    @@ -377,9 +381,36 @@

    -

    ◆ useSelfUser()

    + +
    +
    +

    + + + + + + + + + + + + + + + + + +
    model::Object & kiwi::model::Patcher::replaceObject (model::Object const & old_object,
    std::unique_ptr< model::Object > && object 
    )
    +
    + +

    Replaces an object by another one.

    +

    This function will rewire the new object.

    Returns
    A reference to the newly added object.
    +
    +
    +
    @@ -406,7 +437,7 @@

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_patcher_1_1_user-members.html b/docs/html/classkiwi_1_1model_1_1_patcher_1_1_user-members.html index 5d1df573..10ef1c30 100644 --- a/docs/html/classkiwi_1_1model_1_1_patcher_1_1_user-members.html +++ b/docs/html/classkiwi_1_1model_1_1_patcher_1_1_user-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    - + - - - - + +
    @@ -71,9 +98,9 @@ - - - + + + @@ -83,7 +110,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_patcher_1_1_user.html b/docs/html/classkiwi_1_1model_1_1_patcher_1_1_user.html index c9daac40..1227837c 100644 --- a/docs/html/classkiwi_1_1model_1_1_patcher_1_1_user.html +++ b/docs/html/classkiwi_1_1model_1_1_patcher_1_1_user.html @@ -3,8 +3,7 @@ - - +Kiwi: kiwi::model::Patcher::User Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    addView()kiwi::model::Patcher::User
    declare()kiwi::model::Patcher::Userstatic
    getId() constkiwi::model::Patcher::User
    getNumberOfViews() const noexceptkiwi::model::Patcher::User
    getViews() const noexceptkiwi::model::Patcher::User
    getId() const kiwi::model::Patcher::User
    getNumberOfViews() const noexceptkiwi::model::Patcher::User
    getViews() const noexceptkiwi::model::Patcher::User
    getViews() noexceptkiwi::model::Patcher::User
    removeView(View const &view)kiwi::model::Patcher::User
    User()kiwi::model::Patcher::User
    - + - - - - + +
    @@ -86,42 +113,42 @@ - - - - - - - - + + + - - - - - - + + + + + +

    Public Member Functions

    +
     User ()
     Constructor.
     
    +
     ~User ()=default
     Destructor.
     
    +
    View & addView ()
     Add a new View.
     
    +
    flip::Collection< Patcher::View >::iterator removeView (View const &view)
     Remove a View.
     
    -flip::Collection< Patcher::View > const & getViews () const noexcept
     Get views.
     
    +
    +flip::Collection< Patcher::View > const & getViews () const noexcept
     Get views.
     
    flip::Collection< Patcher::View > & getViews () noexcept
     Get views.
     
    -size_t getNumberOfViews () const noexcept
     Get the number of active views.
     
    -uint64_t getId () const
     Get the User id.
     
    +size_t getNumberOfViews () const noexcept
     Get the number of active views.
     
    +uint64_t getId () const
     Get the User id.
     
    - @@ -137,7 +164,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_patcher_1_1_view-members.html b/docs/html/classkiwi_1_1model_1_1_patcher_1_1_view-members.html index 276ee37f..ff66d20f 100644 --- a/docs/html/classkiwi_1_1model_1_1_patcher_1_1_view-members.html +++ b/docs/html/classkiwi_1_1model_1_1_patcher_1_1_view-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

    Static Public Member Functions

    +
    static void declare ()
     flip declare method
     
    - + - - - - + +
    @@ -70,16 +97,16 @@

    This is the complete list of members for kiwi::model::Patcher::View, including all inherited members.

    - + - - - - + + + + - + @@ -89,14 +116,14 @@ - +
    declare() (defined in kiwi::model::Patcher::View)kiwi::model::Patcher::Viewstatic
    getLock() const noexceptkiwi::model::Patcher::View
    getLock() const noexceptkiwi::model::Patcher::View
    getPatcher()kiwi::model::Patcher::View
    getSelectedLinks()kiwi::model::Patcher::View
    getSelectedObjects()kiwi::model::Patcher::View
    getZoomFactor() const noexceptkiwi::model::Patcher::View
    isSelected(model::Object const &object) constkiwi::model::Patcher::View
    isSelected(model::Link const &link) constkiwi::model::Patcher::View
    lockChanged() const noexceptkiwi::model::Patcher::View
    getZoomFactor() const noexceptkiwi::model::Patcher::View
    isSelected(model::Object const &object) const kiwi::model::Patcher::View
    isSelected(model::Link const &link) const kiwi::model::Patcher::View
    lockChanged() const noexceptkiwi::model::Patcher::View
    selectAll()kiwi::model::Patcher::View
    selectionChanged() constkiwi::model::Patcher::View
    selectionChanged() const kiwi::model::Patcher::View
    selectLink(model::Link &object)kiwi::model::Patcher::View
    selectObject(model::Object &object)kiwi::model::Patcher::View
    setLock(bool locked)kiwi::model::Patcher::View
    unselectObject(model::Object &object)kiwi::model::Patcher::View
    View()kiwi::model::Patcher::View
    View(flip::Default &) (defined in kiwi::model::Patcher::View)kiwi::model::Patcher::Viewinline
    zoomFactorChanged() const noexceptkiwi::model::Patcher::View
    zoomFactorChanged() const noexceptkiwi::model::Patcher::View
    ~View()kiwi::model::Patcher::View
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_patcher_1_1_view.html b/docs/html/classkiwi_1_1model_1_1_patcher_1_1_view.html index eeb9f008..c3f1f008 100644 --- a/docs/html/classkiwi_1_1model_1_1_patcher_1_1_view.html +++ b/docs/html/classkiwi_1_1model_1_1_patcher_1_1_view.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Patcher::View Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -87,93 +114,93 @@ - - - - - - - - - - - + + + + + + - - - - - - - + + + + + + - - - - - - - - - - - + + + + + + + + + - + - - + - - - - - + -

    Public Member Functions

    +
     View ()
     Constructor.
     
    +
     ~View ()
     Destructor.
     
    +
    Patcher & getPatcher ()
     Return the parent Patcher object.
     
    +
    void setLock (bool locked)
     Set the lock status.
     
    -bool getLock () const noexcept
     Returns true if the view is locked.
     
    -bool lockChanged () const noexcept
     Returns true if the lock status changed.
     
    +
    +bool getLock () const noexcept
     Returns true if the view is locked.
     
    +bool lockChanged () const noexcept
     Returns true if the lock status changed.
     
    void setZoomFactor (double zoom_factor)
     Set zoom factor.
     
    -double getZoomFactor () const noexcept
     Returns the current zoom factor.
     
    -bool zoomFactorChanged () const noexcept
     Returns true if the zoom factor changed.
     
    +
    +double getZoomFactor () const noexcept
     Returns the current zoom factor.
     
    +bool zoomFactorChanged () const noexcept
     Returns true if the zoom factor changed.
     
    std::vector< model::Object * > getSelectedObjects ()
     Return the selected Objects.
     
    +
    std::vector< model::Link * > getSelectedLinks ()
     Return the selected Links.
     
    -bool isSelected (model::Object const &object) const
     Return true if the given Object is selected in this view.
     
    -bool isSelected (model::Link const &link) const
     Return true if the given Link is selected in this view.
     
    -bool selectionChanged () const
     Returns true if selection has changed.
     
    +
    +bool isSelected (model::Object const &object) const
     Return true if the given Object is selected in this view.
     
    +bool isSelected (model::Link const &link) const
     Return true if the given Link is selected in this view.
     
    +bool selectionChanged () const
     Returns true if selection has changed.
     
    void selectObject (model::Object &object)
     Select an Object.
     Select an Object.
     
    +
    void selectLink (model::Link &object)
     Select a Link.
     Select a Link.
     
    +
    void unselectObject (model::Object &object)
     Unselect an Object.
     
    +
    void unselectLink (model::Link &object)
     Unselect a Link.
     
    +
    void unselectAll ()
     Unselect all objects and links.
     
    +
    void selectAll ()
     Select all objects and links.
     Select all objects and links.
     
    +
     View (flip::Default &)
     
    -

    Static Public Member Functions

    +
    static void declare ()
     
    @@ -188,7 +215,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_patcher_validator-members.html b/docs/html/classkiwi_1_1model_1_1_patcher_validator-members.html index 10ba908f..19f14644 100644 --- a/docs/html/classkiwi_1_1model_1_1_patcher_validator-members.html +++ b/docs/html/classkiwi_1_1model_1_1_patcher_validator-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -77,7 +104,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_patcher_validator.html b/docs/html/classkiwi_1_1model_1_1_patcher_validator.html index 344ad3e7..92120e9b 100644 --- a/docs/html/classkiwi_1_1model_1_1_patcher_validator.html +++ b/docs/html/classkiwi_1_1model_1_1_patcher_validator.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::PatcherValidator Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -80,7 +107,7 @@ -

    Public Member Functions

    +
    virtual void validate (Patcher &patcher) override
     
    @@ -93,7 +120,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_phasor_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_phasor_tilde-members.html new file mode 100644 index 00000000..246d9151 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_phasor_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::PhasorTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::PhasorTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::PhasorTilde)kiwi::model::PhasorTildestatic
    declare() (defined in kiwi::model::PhasorTilde)kiwi::model::PhasorTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::PhasorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    PhasorTilde(flip::Default &d) (defined in kiwi::model::PhasorTilde)kiwi::model::PhasorTildeinline
    PhasorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::PhasorTilde)kiwi::model::PhasorTilde
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_phasor_tilde.html b/docs/html/classkiwi_1_1model_1_1_phasor_tilde.html new file mode 100644 index 00000000..9ed89a7f --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_phasor_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::PhasorTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::PhasorTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::PhasorTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + PhasorTilde (flip::Default &d)
     
    + PhasorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_PhasorTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_PhasorTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_phasor_tilde.png b/docs/html/classkiwi_1_1model_1_1_phasor_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..f54ec12e4a074d2a3b452b216739817fab158118 GIT binary patch literal 830 zcmeAS@N?(olHy`uVBq!ia0vp^6M?vcgBeI(xc}1$NJ#|vgt-3y{~ySF@#br3|Dg#$ z78oBmaDcV*jy#adQ4-`A%m7pb0#{Fk7%?y~o%M8a45?szJNIqTY6SrY{?|U={@(wg z_DOL?PSWcw)_ZRkH8JU_Ztw`FdnXTKYFELkUU z`Ac@mrz2lucjrwJzG)_PEavQDG4=oTTiiC=SiO64-MBg>&E(m|himRmcHg~6%(LCd zI{R**PT2DFwJB{KJWtv0-<03?=wJF`|9aL(+v8o1sP(wGG` zmx_wuqVz8!Ma!O?*ElD2z?z7l04jN=FAWS+Z4U-uY%HO_qFqJEY-7D21?d!%YN-zFQicVbccoUV#f!QO=qQk`}eYVv0=Z?;^aI1pEIUk zpTL(|cI{Z~yRx-@H|B2rTb)#QjUh(BjlnFDB|#WS>GcMAofQ7h@O4+I$uk8u7GPp$ N@O1TaS?83{1OS~;hN1uf literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_pin_type-members.html b/docs/html/classkiwi_1_1model_1_1_pin_type-members.html index c2d08d57..aa098f52 100644 --- a/docs/html/classkiwi_1_1model_1_1_pin_type-members.html +++ b/docs/html/classkiwi_1_1model_1_1_pin_type-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -71,8 +98,8 @@ - - + +
    declare() (defined in kiwi::model::PinType)kiwi::model::PinTypestatic
    IType enum name (defined in kiwi::model::PinType)kiwi::model::PinType
    operator<(PinType const &other) constkiwi::model::PinType
    operator==(PinType const &other) constkiwi::model::PinType
    operator<(PinType const &other) const kiwi::model::PinType
    operator==(PinType const &other) const kiwi::model::PinType
    PinType(IType type) (defined in kiwi::model::PinType)kiwi::model::PinType
    PinType(flip::Default &) (defined in kiwi::model::PinType)kiwi::model::PinType
    @@ -80,7 +107,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_pin_type.html b/docs/html/classkiwi_1_1model_1_1_pin_type.html index 57dc7a47..ac8066a3 100644 --- a/docs/html/classkiwi_1_1model_1_1_pin_type.html +++ b/docs/html/classkiwi_1_1model_1_1_pin_type.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::PinType Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -87,31 +114,31 @@ -

    Public Types

    enum  IType { Control, +
    enum  IType { Control, Signal }
     
    - - - - - - - - + + + + + +

    Public Member Functions

    +
     PinType (IType type)
     
    -bool operator< (PinType const &other) const
     Comprison operator.
     
    -bool operator== (PinType const &other) const
     Equality comparator. Consistent with comparison operator.
     
    +
    +bool operator< (PinType const &other) const
     Comprison operator.
     
    +bool operator== (PinType const &other) const
     Equality comparator. Consistent with comparison operator.
     
     PinType (flip::Default &)
     
    -

    Static Public Member Functions

    +
    static void declare ()
     
    @@ -127,7 +154,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_pipe-members.html b/docs/html/classkiwi_1_1model_1_1_pipe-members.html index 05320433..0c8bb990 100644 --- a/docs/html/classkiwi_1_1model_1_1_pipe-members.html +++ b/docs/html/classkiwi_1_1model_1_1_pipe-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
    - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::Pipe, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Pipe)kiwi::model::Pipestatic
    declare() (defined in kiwi::model::Pipe)kiwi::model::Pipestatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Pipevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Pipevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    Pipe(flip::Default &d)kiwi::model::Pipeinline
    Pipe(std::string const &name, std::vector< Atom > const &args)kiwi::model::Pipe
    positionChanged() const noexceptkiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    Pipe(flip::Default &d) (defined in kiwi::model::Pipe)kiwi::model::Pipeinline
    Pipe(std::vector< tool::Atom > const &args) (defined in kiwi::model::Pipe)kiwi::model::Pipe
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_pipe.html b/docs/html/classkiwi_1_1model_1_1_pipe.html index 05b50de8..af7b112f 100644 --- a/docs/html/classkiwi_1_1model_1_1_pipe.html +++ b/docs/html/classkiwi_1_1model_1_1_pipe.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Pipe Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Pipe (flip::Default &d)
     flip Default Constructor
    + Pipe (flip::Default &d)
     
    - Pipe (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + Pipe (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pipe.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pipe.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_plus-members.html b/docs/html/classkiwi_1_1model_1_1_plus-members.html index 6d8b61c9..5c897ec6 100644 --- a/docs/html/classkiwi_1_1model_1_1_plus-members.html +++ b/docs/html/classkiwi_1_1model_1_1_plus-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,68 @@

    This is the complete list of members for kiwi::model::Plus, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Plus)kiwi::model::Plusstatic
    declare() (defined in kiwi::model::Plus)kiwi::model::Plusstatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Plusvirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    Plus(flip::Default &d)kiwi::model::Plusinline
    Plus(std::string const &name, std::vector< Atom > const &args)kiwi::model::Plus
    positionChanged() const noexceptkiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    Plus(flip::Default &d) (defined in kiwi::model::Plus)kiwi::model::Plusinline
    Plus(std::vector< tool::Atom > const &args) (defined in kiwi::model::Plus)kiwi::model::Plus
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_plus.html b/docs/html/classkiwi_1_1model_1_1_plus.html index 1e4abc35..7497323f 100644 --- a/docs/html/classkiwi_1_1model_1_1_plus.html +++ b/docs/html/classkiwi_1_1model_1_1_plus.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Plus Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -76,157 +103,250 @@
    -kiwi::model::Object +kiwi::model::Operator +kiwi::model::Object
    - - + - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Plus (flip::Default &d)
     flip Default Constructor
    + Plus (flip::Default &d)
     
    - Plus (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + Plus (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + + + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Plus.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Plus.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_plus.png b/docs/html/classkiwi_1_1model_1_1_plus.png index 834e0eca326e584d6ff20abba2625904d48dbcc8..f5cda5c7663e63652c0b8b4e5a3aac3296c61928 100644 GIT binary patch delta 875 zcmV-x1C;#61(pXPiBL{Q4GJ0x0000DNk~Le0001i0002M2m=5B02F%gtC1l(e*+~+ zL_t(|0qvb(mZTsIge&1ax&MvV285uX_P8_YovrSaV8HMJLH|NT#8r?OV{{Y=Nbp61 zSN^85+{PF?do$qs1awb?oSp>xrWj+qt0!l{DG%)Xe_(hPvNy&U@9FtF@$vKjKEdP93crmc_!t5a5l;cY zBP{^nDtCfq@kVebSOJ_7{0Vp#NI(J-kbndLjFEr@Bp?9^NbuVTLI}ZC2&$@%A^{0T z1Y)k%qpCVkYc$i*-qmY>SXJu+_uFnbDxV2U+MJyE6W$!lI2s&S1oDghlxR0nR#!kZ8H5fc`y$kOX_;B4~{!?KNEY+2>LuYoQ1FD!7dL~&jJZZKmrnw0Dv(PkbndvAOQ(} z8$k#mxC%j4)lnoMK}R6wYCWo|1GPreP1c{P>Rf~79f7LqEsY3L?L5u}L9$n$tlB$O zbND>R^_se*JJYQN+WHl!m+w_?mo|VQXyeveu@tdTRF}QmY$Irne@wdTT)jQPwubwN zs$y(h9M+&8YagfcJ|W17cS2AybK8+Cf)+pjZ>_;B54tIsG0zG1&1VGt*6z>3V7B)N zx;#{sgU!x@IVxM4_h+Hhv)_8Z>z(-4yM+Y&Hj?0j2to+KQvmQt3jnyvonTqK5!?w@ z0A~b$0-gmDkbndve;@$>V^iwtjHOQD|M$pEswPI_%QdF0{Yjf`iW(zVQ z=mXe?JI}D#=fS=SfVICykVouyq3iLrT}YL-^A~Gy$b+8XLA_n*;dh}A+dJBYzWe)m zu**Y04mLXr{a|JJ-`)iP_$iTq1SI$%0ud2U{Q<6#fgx5^BAx&M002ovPDHLkV1nJl Bg$Dot delta 665 zcmV;K0%rY|2gU^-cD9MY+1u2hQX>TJiJFH9DChUi2~YR~6f4X6M{;&fZuym6_Q)?!{Sgx}R-w zhO}zy+zy$Uz2#QkHoMRK_gT%`f6!}Y_J+TB58Yq*PdV?ur~BU(GczB)$SESy7Jz$< z0F8OTIgah64>%`fbLkV#ugTl)1aP7|0et9A03W&&z=!Sx@S!^aeCSR9AG#CZlwlZ# z#xSU=Hl;gNRegBWDcNVid?8;HzW@#P0)x3@O z=lUKx`kDS`&ciob|68W2f9k^*Ifr2w+5&Ko5uh;-ILEQQ^a1CjY%YDm`89dlod8aB zCx8##3E)F_0{GCK06uglfDhdX;6rx;oFXF97zCgx-3j2sFK~v3yzBHUt%Io*67zIj z)d_HknlpZUte?(Va6zB}9U3vM>sT~qCB%js9{bCW?J zyK - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,68 @@

    This is the complete list of members for kiwi::model::PlusTilde, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::PlusTilde)kiwi::model::PlusTildestatic
    declare() (defined in kiwi::model::PlusTilde)kiwi::model::PlusTildestatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::PlusTildevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    PlusTilde(flip::Default &d)kiwi::model::PlusTildeinline
    PlusTilde(std::string const &name, std::vector< Atom > const &args)kiwi::model::PlusTilde
    positionChanged() const noexceptkiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    PlusTilde(flip::Default &d) (defined in kiwi::model::PlusTilde)kiwi::model::PlusTildeinline
    PlusTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::PlusTilde)kiwi::model::PlusTilde
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_plus_tilde.html b/docs/html/classkiwi_1_1model_1_1_plus_tilde.html index d7509913..ff739099 100644 --- a/docs/html/classkiwi_1_1model_1_1_plus_tilde.html +++ b/docs/html/classkiwi_1_1model_1_1_plus_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::PlusTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -76,157 +103,250 @@
    -kiwi::model::Object +kiwi::model::OperatorTilde +kiwi::model::Object
    - - + - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - PlusTilde (flip::Default &d)
     flip Default Constructor
    + PlusTilde (flip::Default &d)
     
    - PlusTilde (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + PlusTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + + + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_PlusTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_PlusTilde.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_plus_tilde.png b/docs/html/classkiwi_1_1model_1_1_plus_tilde.png index 032247fada19c204565360dfecb4273c74ce5649..0799bffa220328ddf357f19d6869be6b693855b7 100644 GIT binary patch literal 1146 zcmeAS@N?(olHy`uVBq!ia0vp^bAb2&2Q!d7ruFMHkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~;q-KI45?szJNNap*;YJm+wHG)-TU9` z&%~CKcUEJ|V#~$XtR-#=T5mJ`vvf+(A}2%RZqHLQXI6Sx8XNP^Keab2YtOZ4u2>R?fz-|cYoc-*)#u|2Aw-|#<^r? zkQXP{fnFPiMM9D9K62!UN4|S0c3p2vOqg~<{}kpA6N(t*g7^+NpJJ@=uw>xZWPhOe zl)+|+OhY?D@^Jnn>9)iUu4a{^Do<5TI-l~K)b73WQq49&PpbskoMls=?^oO6T`=_{ zucc>IxAIQcH#*nVi;`zg_TOt|!rSL<9J@^OajbE!@0K2&`xULr_o=-7*?ec!mM>Y- z@?osg1FFrpN3QGsD(-3ZC@SyXl(&bMT-wsDzD>LQLvR1Kudj+^TkMdjNU&n}v9YTew>?BFw@A2vk2zBqA-?f+lAAD7zC z)qGz2{LdZn{VKKUn(Cf%i%#<%Heg|W;3mfq*s1fqf@NE`&i9h;Z1E_))uIR7@r43X z5IrGADcYzP8zY(ei`)&W(H9)Ted6_Ft`S{P#xHb)RVAv!7SJ*Z%fuz5Lt7&%VUo z>V*c6S^5m;w|6J)Z@cDDn_*wsSyohgD=yD?ZTuv?_y0CU?~F^Hy}a|Af9`SnDYMW0 zZ;jENP}zNdO7!Wh?Q4^l>nf}?$=#oFUE7>rCg=6hQ*%X+)R~8D*>>1?``T;Grd9s$ zzMRQD<*2p0ENrc>;rZ4Z;n{EfKbrkY+v;^Gw&r90G8I{n_a3J2`Jt*QMb+S&8srtC z!C>eKNpcS(^18MvPq$B$jj0OW_;%m*kVM&?UNx%hAH>{?z9!Gl?5j~S-}ZC6`Q~f! zwz_9O8~MHzUo|m$lF4tw_S^57zRWqf*2{bSw)A?z7^k;)cO}h@5zcvT`i((Wy=XSi z-$^<1ckawNe<$rlz;FH2zD9qyeLH_IKl^`d!@SqIvevn|j+wXWV%I(4+x~S&#yzc$ zdB!{cosm6xRnmO!PG3uhn_D+$z3q1lpZq;U+kpWouUvfUrKzg%pRsnwobVO%E delta 658 zcmeyxv7c43Gr-TCmrII^fq{Y7)59eQNH+p;2M05d{9ahGYNDc5J(HiOi(^OyiY!ZR*4+I`%PThY>!f)CYebIDati&rNbc>yh6nBb3x%FM z=~2m;9TK|!)yY_nQ_R2ZB<|I>z6lN8yX^Vi;4mxCxe7CBd3Q0lhA|*+Xa0to3wHTdug(Ev8YH0 zcKqBrZ%U90ID@=iPI6-@{kAw_Im_x?!J@S$Pmh&O+<79l{+jyb zT>g;gR~^%>ulI9)tIS?|Luz9{$n@G24X7{~3;jJ~tr=EWze^~x%{@8dpI6~X3n9=as`VX=P zKZwlAd24j>b;p6{2Rjyg*)f^jSB~k@&5N-gmOnH4cPy5nL0}> + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Pow Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Pow, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Pow)kiwi::model::Powstatic
    declare() (defined in kiwi::model::Pow)kiwi::model::Powstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    Pow(flip::Default &d) (defined in kiwi::model::Pow)kiwi::model::Powinline
    Pow(std::vector< tool::Atom > const &args) (defined in kiwi::model::Pow)kiwi::model::Pow
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_pow.html b/docs/html/classkiwi_1_1model_1_1_pow.html new file mode 100644 index 00000000..e18283a8 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_pow.html @@ -0,0 +1,352 @@ + + + + + + +Kiwi: kiwi::model::Pow Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Pow Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Pow:
    +
    +
    + + +kiwi::model::Operator +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Pow (flip::Default &d)
     
    + Pow (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pow.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Pow.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_pow.png b/docs/html/classkiwi_1_1model_1_1_pow.png new file mode 100644 index 0000000000000000000000000000000000000000..88a07bae98729355e27b4080752cb82b097bb51b GIT binary patch literal 922 zcmeAS@N?(olHy`uVBq!ia0vp^jX->WgBeJQRDD= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0H9cJ%Ln;{G&P|-QM1iM8`=Ra5|Gn4Q zS{5w$w!`@4+_mqfI2`!E>GEQZ zt7Z7>z0S%pNDYm1U3pyMv97J6hse<~*B--rR~DN}2>kh=7t%Cm&ODai>m-u*tX5Ay zsLB84cS42OCi7zw?_d73{`m3lf4hT^&vWhXRrw*oBq-?5ctBZ~;el3pQ|d>z0`&;S zIf8#UE5tk;n1m)YurTyYY+zAQU<5knHir|(!BCD>tNN4}Io(*2)?Hh?$|~Ts$>Eg0 zlGha--b)CtSat7G$AWWq-KCxra=IsEFV!wz)_%rSZc}&6?b#Zp z!Vw*O~;J zK8P^bTw-EaSEL>xmd{e&Bzi#d;QWU4Mu>+P4oGl9eYw9^p+z93b-}7v8bT8mC<_#C zl?%Pv7`0qd?X`bs={m>neGZ{tr@67LER%cQq;NCaCrozkD$AO>V_#>rEtw{HjVbpr z*Ok-XS8ey6eL!GKW%k;Lt_Y1)r?;8i=9r~C`5jw$zW;``5A7DMl8_c}H+}K^*728n z{5gPr6qs`6PT7;L1xL^SkIptY-TY4Q%$(;ezuy@*)n$KAPyDduJI5}Ykg3gQ&ox{T^7KM#Ng@b=d#Wzp$Py6W||%V literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_print-members.html b/docs/html/classkiwi_1_1model_1_1_print-members.html index e719cb52..b43c12c9 100644 --- a/docs/html/classkiwi_1_1model_1_1_print-members.html +++ b/docs/html/classkiwi_1_1model_1_1_print-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::Print, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + - - - + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Print)kiwi::model::Printstatic
    declare() (defined in kiwi::model::Print)kiwi::model::Printstatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Printvirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Printvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    Print(flip::Default &d)kiwi::model::Printinline
    Print(std::string const &name, std::vector< Atom > const &args)kiwi::model::Print
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    Print(flip::Default &d) (defined in kiwi::model::Print)kiwi::model::Printinline
    Print(std::vector< tool::Atom > const &args) (defined in kiwi::model::Print)kiwi::model::Print
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_print.html b/docs/html/classkiwi_1_1model_1_1_print.html index b8c9a31a..f5790f77 100644 --- a/docs/html/classkiwi_1_1model_1_1_print.html +++ b/docs/html/classkiwi_1_1model_1_1_print.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Print Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Print (flip::Default &d)
     flip Default Constructor
    + Print (flip::Default &d)
     
    - Print (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + Print (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Print.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Print.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_random-members.html b/docs/html/classkiwi_1_1model_1_1_random-members.html new file mode 100644 index 00000000..8b660307 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_random-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Random Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Random, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Random)kiwi::model::Randomstatic
    declare() (defined in kiwi::model::Random)kiwi::model::Randomstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Randomvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    Random(flip::Default &d) (defined in kiwi::model::Random)kiwi::model::Randominline
    Random(std::vector< tool::Atom > const &args) (defined in kiwi::model::Random)kiwi::model::Random
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_random.html b/docs/html/classkiwi_1_1model_1_1_random.html new file mode 100644 index 00000000..76108e7d --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_random.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Random Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Random Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Random:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Random (flip::Default &d)
     
    + Random (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Random.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Random.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_random.png b/docs/html/classkiwi_1_1model_1_1_random.png new file mode 100644 index 0000000000000000000000000000000000000000..5becf2c772bb88c748062d74302776d89d2056dd GIT binary patch literal 721 zcmV;?0xtcDP)IQ0000OP)t-s|Ns90 z008Lh^>vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0007DNklyo4(3`S34m3jX+-fr-M3a)n7hM6_f`34CgMNm09 z<(b;4Yi1j}lkFyZ;kIV|JNCL-dF{Y_8`Dm_o9Wuj?C<)Ro%oaO8Z)yi`h49Lw%eXB z>|B0**!v+fvrGE8&fU+ue7>u7p1o#f7xd+O?Yqgpmi^tgAiiT}X1;nbTSTOf06y0U z&`BNHW z5`(I07X@2Y)mJ};Eye%RqpDibI#`6s>#uMf5)_UKTUGUvYV3vE%5}m{HqXsh(@-8v z3(HLoNxdR$O|*>u#O*@f@zy+Ey+0_Ph^ue)qh0m8L2OYt?!27)<G;&$5d5)^hk6>I=s1slLu!3OYEumOA(Y=GMm5$PlZpo@YH;Hw|O&P{nEr#H0@E?2p90rqNS z+OYvHsm5-mxxh~L?q(H9^I%$9ZgNQK9oe(L8a$`kvR7gm^|q8|nzXpe-fT;|hU|jp zR9kj2waB%1)|cMOgkv{qZ(GFuK#JJp!00000NkvXXu0mjf Ddq`-+ literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_receive-members.html b/docs/html/classkiwi_1_1model_1_1_receive-members.html index 16beda98..7aeb48c8 100644 --- a/docs/html/classkiwi_1_1model_1_1_receive-members.html +++ b/docs/html/classkiwi_1_1model_1_1_receive-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::Receive, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - - - + + + + + + + + + + + - - - + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Receive)kiwi::model::Receivestatic
    declare() (defined in kiwi::model::Receive)kiwi::model::Receivestatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Receivevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Receivevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    Receive(flip::Default &d)kiwi::model::Receiveinline
    Receive(std::string const &name, std::vector< Atom > const &args)kiwi::model::Receive
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    Receive(flip::Default &d) (defined in kiwi::model::Receive)kiwi::model::Receiveinline
    Receive(std::vector< tool::Atom > const &args) (defined in kiwi::model::Receive)kiwi::model::Receive
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_receive.html b/docs/html/classkiwi_1_1model_1_1_receive.html index 1d06503b..b9432809 100644 --- a/docs/html/classkiwi_1_1model_1_1_receive.html +++ b/docs/html/classkiwi_1_1model_1_1_receive.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Receive Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Receive (flip::Default &d)
     flip Default Constructor
    + Receive (flip::Default &d)
     
    - Receive (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + Receive (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Receive.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Receive.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_sah_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_sah_tilde-members.html new file mode 100644 index 00000000..4726211c --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_sah_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::SahTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::SahTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::SahTilde)kiwi::model::SahTildestatic
    declare() (defined in kiwi::model::SahTilde)kiwi::model::SahTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::SahTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    SahTilde(flip::Default &d) (defined in kiwi::model::SahTilde)kiwi::model::SahTildeinline
    SahTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::SahTilde)kiwi::model::SahTilde
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_sah_tilde.html b/docs/html/classkiwi_1_1model_1_1_sah_tilde.html new file mode 100644 index 00000000..0f073005 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_sah_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::SahTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::SahTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::SahTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + SahTilde (flip::Default &d)
     
    + SahTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SahTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SahTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_sah_tilde.png b/docs/html/classkiwi_1_1model_1_1_sah_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..6dccad49bf4693ae39123893ea548059d8c40755 GIT binary patch literal 728 zcmV;}0w?{6P)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0007KNklt)(A zPgPaz(r58L<`?#C-rwcdUCVJ2c`4~cURf%usy@*I|6D^#mrPalnO62c;Q#3P7k;#) z9sk;;s`^k1{x`Y*_W2+BKeno>KGO30Z*}@V&R_la@c%#OtEyV*;ERaZ31CG#fT4`} z`)<1cWB!3RU4S+J*Zbf30ETitfSsHVU?=AT*va_-c5*&|otzI~C+7n!Xxp~UP;4QD zU?%4~zxhb>+qQ%d!a%jN879Z4X}SgI8ixE3LU^PRzp!VqzTlrJ&yS_l6+6!j#w-pw zYt674sPvQ>ujW{u@hi2IQaa*~0Ssl#-*?*u81oOj=>n|zzuy1O2QZZL0qo>_ z06RG!z)sEwu#@uv?Bsj^J2@X1F3jd*kvBG~ok0 z(tv*!X6-ef^Uw6EMl}KQ>eB|(QyXhHPH9i4k=GTcG&3*!N-d?7&QLi*Zfa{Kc;+=j zT7EyX=U;~P8*3n=tnR#wRV)zT;P?-p>Clw0;F?(tYDM|6MmZ-v7*h zy=MIW{y*VQ@BiXHkXxGhzxI}=q=tIve*gnH-}wMma=wU&q5c3-4Q6j@3>Fmt0000< KMNUMnLSTXeId*0M literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_scale-members.html b/docs/html/classkiwi_1_1model_1_1_scale-members.html new file mode 100644 index 00000000..aa5acb06 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_scale-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Scale Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Scale, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Scale)kiwi::model::Scalestatic
    declare() (defined in kiwi::model::Scale)kiwi::model::Scalestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Scalevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    Scale(flip::Default &d) (defined in kiwi::model::Scale)kiwi::model::Scaleinline
    Scale(std::vector< tool::Atom > const &args) (defined in kiwi::model::Scale)kiwi::model::Scale
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_scale.html b/docs/html/classkiwi_1_1model_1_1_scale.html new file mode 100644 index 00000000..318c0088 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_scale.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Scale Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Scale Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Scale:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Scale (flip::Default &d)
     
    + Scale (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Scale.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Scale.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_scale.png b/docs/html/classkiwi_1_1model_1_1_scale.png new file mode 100644 index 0000000000000000000000000000000000000000..532a64af68d5506bbadd751263117fdb5af9994e GIT binary patch literal 722 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;ahzxOMm z9a&gk?-IUq_tHu8gr=QrLBGWXC!TXUb7ohT!Pzr4U$z_H*WKRp@zNQt-Lqbr&*;3q z>+$oM(WReORUAEj>b~=w*)!+97At<}cAGaXZGOr6b6l5e^M#GKgvLL!OG*0{xc%3* z+m+AmpU=9_wtnVK_P+gvXrkV>d%|gkB2C_ki5%Y3 zR_ENDrr~-?Hottv^E16u(k@PunK(P<=hZCj%^#*ZAB-tao9`TIl&z-qdd;1{+qdth zw@tH57t8K@J~OOszjx`jbDwwIPqz(ObyVm4=L_4z&lg{JTvfCo?0#CV?9QwEdY?c4 zC6`s}``tEg`Fj-_` z_2q-b2U#qpc6g*KGQ^q!!=P%0q}osAIdP?!ROQ9y~<#^CoAKVFeCA5 z>!wWs9C}k*6m=rk_4&^YTN+dO_xF+Nv@O?d3MXstj|x`*W*76u`&&Wf)|H#~ZnhKg z?3z_KOR{R2&4x1*4;3a>=TARb)+GOG&DVfu_ibxdw|i}!@w8HIrZ~up3hdcm--_w( qw$6*#oX@xm7BN*Fno5_#_cPpI5mVn1Agu;WfDE3lelF{r5}E+3C{(oo literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_select-members.html b/docs/html/classkiwi_1_1model_1_1_select-members.html new file mode 100644 index 00000000..dd94cd01 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_select-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Select Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Select, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Select)kiwi::model::Selectstatic
    declare() (defined in kiwi::model::Select)kiwi::model::Selectstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Selectvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    Select(flip::Default &d) (defined in kiwi::model::Select)kiwi::model::Selectinline
    Select(std::vector< tool::Atom > const &args) (defined in kiwi::model::Select)kiwi::model::Select
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_select.html b/docs/html/classkiwi_1_1model_1_1_select.html new file mode 100644 index 00000000..6b0b7099 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_select.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Select Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Select Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Select:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Select (flip::Default &d)
     
    + Select (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Select.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Select.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_select.png b/docs/html/classkiwi_1_1model_1_1_select.png new file mode 100644 index 0000000000000000000000000000000000000000..131e967e99b9192cc4cb76fecfd671a69b2ebeb5 GIT binary patch literal 721 zcmV;?0xtcDP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0007DNkl; z+)}TXW>%D|k$&KezSbRo-kDY>uN80lb>;7BZJU{$bIZAS*Rre3%sz2%ofW71-bQCg ztG>?tkeS&>Zsl#a^US}W)w~V8W@aDwjrY*~8~-Wi{rB|vT`@EB;ftIiB7Fh4#|+S! z2b}ZVU;2RarR*+!!ud6MJDdPc3@3mO!wKNSa02)+oB%!yCx8#b3E;zU0-Q2U)6^Lz zRn@Kxr>d$Ck2)p$pZBP$R!D={GudU-Ih${`@mr><>cbZ~r)iq{0&tHRpfe9R=efW10q0BEUHXLcYw~tD0h}0403U`E zz=z=k@L@Osd>BpuABGdahv5V`MMR`C2tZec6TpXOouSU3;Ph$IVAgu)Wc&7HDxCnA zs5qBK?OD#8OL<=hvS49wSxKnEl;x^)rder5sNyE%&SZ+MwY=KV8@uwW%@EyLXHo5( z+tw6eiY=(b$fs>Vs?Pe}{@fXIraZTzznoD!&loX$F0HecL#e-<(axcgma{z1qx0f< z?lK7EP+EDLMzieR=k1na<9!R@#Bc)m@I_7$k-q!_DqUQQm6txB00000NkvXXu0mjf DTl8ne literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_send-members.html b/docs/html/classkiwi_1_1model_1_1_send-members.html new file mode 100644 index 00000000..b130a8a4 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_send-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Send Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Send, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Send)kiwi::model::Sendstatic
    declare() (defined in kiwi::model::Send)kiwi::model::Sendstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Sendvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    Send(flip::Default &d) (defined in kiwi::model::Send)kiwi::model::Sendinline
    Send(std::vector< tool::Atom > const &args) (defined in kiwi::model::Send)kiwi::model::Send
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_send.html b/docs/html/classkiwi_1_1model_1_1_send.html new file mode 100644 index 00000000..dc88b1a0 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_send.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Send Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Send Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Send:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Send (flip::Default &d)
     
    + Send (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Send.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Send.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_send.png b/docs/html/classkiwi_1_1model_1_1_send.png new file mode 100644 index 0000000000000000000000000000000000000000..8aac2ffed1a7059f181d37096bcb43cfd3558dfb GIT binary patch literal 718 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;K@{iDq1|Mh#; zE@)a*dRO|+-DlHwDzGf`*s{K(qlC@S__deC*)ugiZqI!`W%jF@%(T#*yDsHhh~K~1 zGrxS@?#b8t(rfSi+J>{Dmn2!H=}vtZZ#+ec?!TD88|IwkGf#OTV~ zZ*5LL-#l~s%Ijy|FxP*O+hzZ8e$l;p|KsnwX3pe~e_}u!Fw+omo1pOG~4{<(lwqUH`P;cOW$nrsP4uf5b@PjFd5^d)UR;(&howI6{ zoz1H$kLqtOUUe%$R_D-@ui+(c#ZJgdFJJXaHR{~a@-1P9EvHucWj$SJVv(y7s+qD& z>(I5YMYm^4+IzuPXD5JVMK!YUFosId?DZ-m}le zwfwTS%l^;&{Nb$F{#2k7YbF*;v@O(U_%6X{^|_%~=C`+e!M-VXm-<`mSIa-l`M?F; ziwD{Zn0^TOH3Yl3ST!@0r~>_M^Umk&C+|6R3rja-?7b|M;Jx&wC8OTO0>9p8M(XEQ z?%6GLG%2&-mglOV6D6V6*H?u5NZu)1w`}Ru(wX{^x(rR0HU{%~PFS|GTG4ZuIS2TfBMV++y*XA8V#avTV|J vuiV`yc5`pRob3#<(D-<$xV*z7zK-!sbWC->(_T$r;$!f1^>bP0l+XkKNDWz) literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_sig_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_sig_tilde-members.html index baa3ee29..8c10b562 100644 --- a/docs/html/classkiwi_1_1model_1_1_sig_tilde-members.html +++ b/docs/html/classkiwi_1_1model_1_1_sig_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,66 @@

    This is the complete list of members for kiwi::model::SigTilde, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - - + + + + + + + + + - - - - - + + + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::SigTilde)kiwi::model::SigTildestatic
    declare() (defined in kiwi::model::SigTilde)kiwi::model::SigTildestatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::SigTildevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::SigTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    SigTilde(flip::Default &d)kiwi::model::SigTildeinline
    SigTilde(std::string const &name, std::vector< Atom > const &args)kiwi::model::SigTilde
    sizeChanged() const noexceptkiwi::model::Object
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    SigTilde(flip::Default &d) (defined in kiwi::model::SigTilde)kiwi::model::SigTildeinline
    SigTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::SigTilde)kiwi::model::SigTilde
    sizeChanged() const noexceptkiwi::model::Object
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_sig_tilde.html b/docs/html/classkiwi_1_1model_1_1_sig_tilde.html index 04b1f1db..5e4e106e 100644 --- a/docs/html/classkiwi_1_1model_1_1_sig_tilde.html +++ b/docs/html/classkiwi_1_1model_1_1_sig_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::SigTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -82,151 +109,232 @@ - - + - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - SigTilde (flip::Default &d)
     flip Default Constructor
    + SigTilde (flip::Default &d)
     
    - SigTilde (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + SigTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SigTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SigTilde.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_slider-members.html b/docs/html/classkiwi_1_1model_1_1_slider-members.html new file mode 100644 index 00000000..4d22fee8 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_slider-members.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Slider Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Slider, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Slider)kiwi::model::Sliderstatic
    declare() (defined in kiwi::model::Slider)kiwi::model::Sliderstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Slidervirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    OutputValue enum value (defined in kiwi::model::Slider)kiwi::model::Slider
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    Signal enum name (defined in kiwi::model::Slider)kiwi::model::Slider
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    Slider(flip::Default &d) (defined in kiwi::model::Slider)kiwi::model::Slider
    Slider() (defined in kiwi::model::Slider)kiwi::model::Slider
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_slider.html b/docs/html/classkiwi_1_1model_1_1_slider.html new file mode 100644 index 00000000..ddb85cd7 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_slider.html @@ -0,0 +1,344 @@ + + + + + + +Kiwi: kiwi::model::Slider Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Slider Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Slider:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + +

    +Public Types

    enum  Signal : SignalKey { OutputValue + }
     
    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Slider (flip::Default &d)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Slider.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Slider.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_slider.png b/docs/html/classkiwi_1_1model_1_1_slider.png new file mode 100644 index 0000000000000000000000000000000000000000..15c12894c5821617caedf75d9e1653809105bf8b GIT binary patch literal 721 zcmV;?0xtcDP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0007DNklhh)8D;GqbLQ)6C3=zuoyx zxv9>VW>%G}k$&J@e62hFd*`}3d98TX=as*!+%_{i=azHw=CY~G%sz2%od-_$yE9wR_! z9&nChf9V6xm$JL`3Fp`3Z8!m(2q%CK;RNs@oB%$A6TpXX0{9S403X5$aLOSRaGAzbxQHK>`_%cU>z)`$?K=++6BlR8>g!3C61hnuNCXSIhFaI)XGC?a9T*J z(v<0{n6?I5MwUC?-KkwVSJTqUWr~r#OILX{m)TkM)m7!3cV-(yRf^IKRIl^kj-$Q( zxih8AxwD$HKhI@m`n|Ny)_Lyt`z(iQTF&}BcX@mDJU1DnD!bCk+aj&A_b_ks`MG|F zTCeFp=4^i1;(wW{st;e}9EM@&3&1@_fX+PN9LN6B2b?cucj*((ugTkR0yq&)03X5$ z;6pe8dO8qV!joH^_BY&fg) zY`rUG27&BKD{t4)awj%<8{b<1U&0CC!xuS4MEddv3x-^U*wpor00000NkvXXu0mjf DS=L-Q literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_snapshot_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_snapshot_tilde-members.html new file mode 100644 index 00000000..baf9cf89 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_snapshot_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::SnapshotTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::SnapshotTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::SnapshotTilde)kiwi::model::SnapshotTildestatic
    declare() (defined in kiwi::model::SnapshotTilde)kiwi::model::SnapshotTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::SnapshotTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    SnapshotTilde(flip::Default &d) (defined in kiwi::model::SnapshotTilde)kiwi::model::SnapshotTildeinline
    SnapshotTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::SnapshotTilde)kiwi::model::SnapshotTilde
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_snapshot_tilde.html b/docs/html/classkiwi_1_1model_1_1_snapshot_tilde.html new file mode 100644 index 00000000..29a68cfb --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_snapshot_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::SnapshotTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::SnapshotTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::SnapshotTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + SnapshotTilde (flip::Default &d)
     
    + SnapshotTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SnapshotTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SnapshotTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_snapshot_tilde.png b/docs/html/classkiwi_1_1model_1_1_snapshot_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..04313d3397ce52ae7cd44ea2cbed80776357b7ac GIT binary patch literal 862 zcmeAS@N?(olHy`uVBq!ia0vp^bAh;ngBeJkdMtScNJ#|vgt-3y{~ySF@#br3|Dg#$ z78oBmaDcV*jy#adQ4-`A%m7pb0#{Fk7%?y~z4df)45?szJNI_p8Ur4N<8D#^|I5oy zYl+!Wnw{alWY<{{k0xVN!#zq$MmilcZ!Tz=J9B3L24myTg}2|uMxHi|pA~sMuXTTR z_?dHu{`l{nWjJ&5j;?1p`}lv}IdkSp=4!hPKp< z-Pf~I_AY#zwzKi;v2ES6SU(7rG1wjAJK%nU@dt-BgM1?U1LZdiH7&9Y{TrA+2qGkZ zM3-GQ@jZNK$to+2#O14ADZdE`t&O?u`FZ=>z);%-d}fzZ{$=heV_c_Hm$ZDF!>-_TuG8Ij?5#qDzXtk?UqNDrH&R!6+PZI9 zxvOKZUzZOF?f-EouU7B&)sUr`;@;bKTJLy#Z}Q)Lv06>pyYtS?tqo6FcE7)Px!QDQ*q(lfbIC4TlZ}E+#&a10d#* z{<@Tx`Tn%a<~P6gKYjA#d%&(&Z;QNMJ*nC%o0WI|Rn_D-}TD$n} z-_u)s&u%N+2lTo9!L=WNso?SPw+wfn$>3vMWLF2zDf^`#>Sf-F)vg6*1_n=8KbLh* G2~7YD3bru- literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_switch-members.html b/docs/html/classkiwi_1_1model_1_1_switch-members.html new file mode 100644 index 00000000..f0e0052a --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_switch-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Switch Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Switch, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Switch)kiwi::model::Switchstatic
    declare() (defined in kiwi::model::Switch)kiwi::model::Switchstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Switchvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    Switch(flip::Default &d) (defined in kiwi::model::Switch)kiwi::model::Switchinline
    Switch(std::vector< tool::Atom > const &args) (defined in kiwi::model::Switch)kiwi::model::Switch
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_switch.html b/docs/html/classkiwi_1_1model_1_1_switch.html new file mode 100644 index 00000000..d4bf569d --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_switch.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Switch Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Switch Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Switch:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Switch (flip::Default &d)
     
    + Switch (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Switch.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Swith.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_switch.png b/docs/html/classkiwi_1_1model_1_1_switch.png new file mode 100644 index 0000000000000000000000000000000000000000..0fa1d92c54abc1e7cf1fd22da87b6d03e910e06f GIT binary patch literal 728 zcmeAS@N?(olHy`uVBq!ia0vp^#X#J_!3-oHpHSfgQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;7Fi*Ar*{o=f0k{M2p9*{87}izxOLv zu^1{uZL2+C8C>!_J5TYp!E8W|U zblfp{>b`pInH;@*qi0n{sXU>DWfB_aH*Z>8w#`1hZIWern%(c;KJy-a51QxxeW(5V z%~GdIkDPg59KJpL{pJ-4p*L>^-rcpS?@rd;W52V1$y!zU{x^K~aC+_^{ov5t#rjEp zmrcHk9=v~%axZ?pr#kcZl{;Q)2UJ6wbmuCaaetQdK5+u~HoHO}m3@hcQ;e^lO}zeS z{^>bP0l+XkK@OoPu literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_switch_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_switch_tilde-members.html new file mode 100644 index 00000000..0c06e919 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_switch_tilde-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::SwitchTilde Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::SwitchTilde, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::SwitchTilde)kiwi::model::SwitchTildestatic
    declare() (defined in kiwi::model::SwitchTilde)kiwi::model::SwitchTildestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::SwitchTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    SwitchTilde(flip::Default &d) (defined in kiwi::model::SwitchTilde)kiwi::model::SwitchTildeinline
    SwitchTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::SwitchTilde)kiwi::model::SwitchTilde
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_switch_tilde.html b/docs/html/classkiwi_1_1model_1_1_switch_tilde.html new file mode 100644 index 00000000..7dee8e0c --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_switch_tilde.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::SwitchTilde Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::SwitchTilde Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::SwitchTilde:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + SwitchTilde (flip::Default &d)
     
    + SwitchTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_SwitchTilde.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_switch_tilde.png b/docs/html/classkiwi_1_1model_1_1_switch_tilde.png new file mode 100644 index 0000000000000000000000000000000000000000..6571081da9c962a0f20e5af38eae05920f650263 GIT binary patch literal 820 zcmeAS@N?(olHy`uVBq!ia0vp^eL&p7!3-qXs+84%lth3}i0l9V|AEXGZ@!lHADRGU zf$@O@2Ut7r$OE|?B|(0{3_wL7aP?G(5d#C$VNVywkP61Pb1!aMtia>IU%2e&fBSo3 z0nD@3Z98}O%-uUrbu>(Dlbqr;mrk(=2nk(0!D`hixs{7oz52NE+-ja@`(jsRUAN=@ zz4F|uN40<4OSjo-p0ABMbE|IeF0-)Ey@$SAZ4SzIUcRcTSGw%E!}IukYeJW&l}pSm z^a}l|bU!?-<<7?E=Mqz|?q0QO`i|Ej`(Eb!pKDeA_rp{DU8`2Pzgn@X>d0lF)dmcA z4l*n7Z7h-N53t)@B z7n{D)uAles2?|;!%r-fF>ht+Kw^%KDe)ze&JP~oXTHPi7de*r+(+WzjEPM6j&yTIE zy`O1s&f(s2Zq59PyX%q#H=ezGQ{`GvRb8vDbm`#>ooL%Oam{6W zfAa0NW}m;~$EJ0!ubin}e|hcBDc0E&e!ai)u43or`bPO>Mg7Y!KR>r_Q{IWWiW6N= zt*e}x%C%loHZ07WLvZ8U<9<(z-EY>fD*iO*e0+(ZVE+|C!H*rwjeReRur*j$FdR{w zcJ8s@DfMaRE~`!QH<-IdhhhE|#t$B{4E+SCA4{#4P7z|~au5k(KcHO7U=ud?R^;~W z^KLJZ+^e-X-dNB0>*d<@i3Ow1 ziI>@AFW0UP4lb|xDRS(a`P{W^W%{f4ecrsgc*-fW126A>4BC18^2_4%6*`9xN?Xpf zc2;t}X}W&Xwwr+`!>+|W_f2K|Qw?=9h??i8xwPdWzfxz>p~(^P0>C8B;OXk;vd$@? F2>{^}ic|mq literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_times-members.html b/docs/html/classkiwi_1_1model_1_1_times-members.html index 416c8c64..6863544e 100644 --- a/docs/html/classkiwi_1_1model_1_1_times-members.html +++ b/docs/html/classkiwi_1_1model_1_1_times-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,68 @@

    This is the complete list of members for kiwi::model::Times, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + - - - + + + + + + + + + - - - - - + + + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Times)kiwi::model::Timesstatic
    declare() (defined in kiwi::model::Times)kiwi::model::Timesstatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Timesvirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Operatorvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    Operator(flip::Default &d) (defined in kiwi::model::Operator)kiwi::model::Operatorinline
    Operator(std::vector< tool::Atom > const &args) (defined in kiwi::model::Operator)kiwi::model::Operator
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    Times(flip::Default &d)kiwi::model::Timesinline
    Times(std::string const &name, std::vector< Atom > const &args)kiwi::model::Times
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    Times(flip::Default &d) (defined in kiwi::model::Times)kiwi::model::Timesinline
    Times(std::vector< tool::Atom > const &args) (defined in kiwi::model::Times)kiwi::model::Times
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_times.html b/docs/html/classkiwi_1_1model_1_1_times.html index 6cbeecad..b878bbd8 100644 --- a/docs/html/classkiwi_1_1model_1_1_times.html +++ b/docs/html/classkiwi_1_1model_1_1_times.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Times Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -76,157 +103,250 @@
    -kiwi::model::Object +kiwi::model::Operator +kiwi::model::Object
    - - + - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - Times (flip::Default &d)
     flip Default Constructor
    + Times (flip::Default &d)
     
    - Times (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + Times (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::Operator
    + Operator (flip::Default &d)
     
    + Operator (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + + + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Operator
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
      -
    • Modules/KiwiModel/KiwiModel_Objects.h
      • -
    • Modules/KiwiModel/KiwiModel_Objects.cpp
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Times.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Times.cpp
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_times.png b/docs/html/classkiwi_1_1model_1_1_times.png index 7480c926a000903c7d60a58e062aeab8921dd771..50d05e281330cb890119bcce4a8a8542919e7ae7 100644 GIT binary patch literal 917 zcmeAS@N?(olHy`uVBq!ia0vp^jX->WgBeJQRDD= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0RXklBLn;{G&V4;?i2_fH_CuM<|K@S5 zPZlk(c;{13iQYCJ8-XAJ%no)6`#drR0n-h;8)o1a#RTkWv`O_!I zR4L>0gA%cQ)7aZ>LZ(jcJ?B&!BINpAXUW`u2g@Iw)qYm5u%r6)r`sM){fY(WEXnhm z2}@9HcK@m@_oW+OslE0OEnVaHxzQoC)XTOhU{_zUvp~*k;i=W_Nj&oN3-`9^EetEw zZv0lqne{pMX_2OI2utd{7%wp;wXQd-vUk5_IV$MMKX>zX)f?A8NCbvzy}s|4ec@bb z&*h5y0!NPQR`8g)^Zf}~$4>eG!Py3JeVrRU@+D4;HC)W8NzEAj&XcrvEf!x07o9f z)QJr&VD^XG94;;NhU%3*mg*^o85nxMa-7<;b4rfx^946Uub+Byn2|y1wZIg13%)FyySFoW&oMKY zd<*ArdK4>sMDKi=qR1(?dutAA@cU)kZ{{xjutv~vHoNd{1NRG06cyB^=e7o`m9a5o l^yH_4l9^~@N5|5C3>tNfChCj+u>$iDgQu&X%Q~loCIGABiyZ&} delta 653 zcmV;80&@M82f76ziBL{Q4GJ0x0000DNk~Le0001U0001p2m=5B0OQCc4v`@`e*#HK zL_t(|0qvdJmYXmP07v2+^#6a{1aq;$CX}vB+bHW<-#yq?$SWcuok7gZx)M$^GavqT z=R4%4e6E^Vk*==v8_w0&n(_0_ZFln8@uHu1{?6vInb|qFoRfD>yUfh&6ZiI6ak`)F z>P%tP*SYU9GyBM`xb1eI`S-ILf48aC%Xm3E)FG0elE2fDhpW@FAQ4K7H|b|svusy;mGl&%A9>ytGd7ML4$PF2-Q)SRoYwN}MBf2CzkD$QM~ zbJ|GC(vYc^4ciu4d)686=2Xs|n`tf0Xm&< z8MU+heP;@pb7wK;c%SRY^ml2Wt@}Kl_gM^;w4CLA9^&@ueeNPiRSu~Yw^>-v-fG;= z_viW^YJE-rGiUS77Qbbxf2uxwk#iV^p)UaU7y&x-fO8!COCNB)l-;FIIKL)t!wKL- zI01YJCx8#(1n?o806v5hz=v=G_z+HjQ$$2Mg8+0ToB%#N>`aCH5l$ax>s(4#qw?Sc zxWv(Ub&b+FrFTOj>q?!|UQ(8ZOtrmpS!Fk&?%YgkX-=>5y3E>?W7jrab3)a*J>-5^ z(NfJ0`#etgA?Fk_=gu_b)7egi?Lt26vvr@96FrHcl9sc)&kJYUauyK;a!9SXJ;YFD nLcDJQoCzm@4`1XI5$Ve>->F=E(T`d=00000NkvXXu0mjf*Q`F? diff --git a/docs/html/classkiwi_1_1model_1_1_times_tilde-members.html b/docs/html/classkiwi_1_1model_1_1_times_tilde-members.html index bf7e202d..669add52 100644 --- a/docs/html/classkiwi_1_1model_1_1_times_tilde-members.html +++ b/docs/html/classkiwi_1_1model_1_1_times_tilde-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -69,43 +96,68 @@

    This is the complete list of members for kiwi::model::TimesTilde, including all inherited members.

    - + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + - - - + + + + + + + + + - - - - - + + + + + + + +
    boundsChanged() const noexceptkiwi::model::Object
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::TimesTilde)kiwi::model::TimesTildestatic
    declare() (defined in kiwi::model::TimesTilde)kiwi::model::TimesTildestatic
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) constkiwi::model::Object
    getInlets() constkiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::TimesTildevirtual
    getName() constkiwi::model::Object
    getNumberOfInlets() constkiwi::model::Object
    getNumberOfOutlets() constkiwi::model::Object
    getOutlet(size_t index) constkiwi::model::Object
    getOutlets() constkiwi::model::Object
    getText() constkiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::OperatorTildevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    OperatorTilde(flip::Default &d) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTildeinline
    OperatorTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::OperatorTilde)kiwi::model::OperatorTilde
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setWidth(double new_width)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    TimesTilde(flip::Default &d)kiwi::model::TimesTildeinline
    TimesTilde(std::string const &name, std::vector< Atom > const &args)kiwi::model::TimesTilde
    ~Object()=defaultkiwi::model::Objectvirtual
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    TimesTilde(flip::Default &d) (defined in kiwi::model::TimesTilde)kiwi::model::TimesTildeinline
    TimesTilde(std::vector< tool::Atom > const &args) (defined in kiwi::model::TimesTilde)kiwi::model::TimesTilde
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_times_tilde.html b/docs/html/classkiwi_1_1model_1_1_times_tilde.html index f527d7a5..995e1ba0 100644 --- a/docs/html/classkiwi_1_1model_1_1_times_tilde.html +++ b/docs/html/classkiwi_1_1model_1_1_times_tilde.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::TimesTilde Class Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
    @@ -76,157 +103,250 @@
    -kiwi::model::Object +kiwi::model::OperatorTilde +kiwi::model::Object
    - - + - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + +

    Public Member Functions

    - TimesTilde (flip::Default &d)
     flip Default Constructor
    + TimesTilde (flip::Default &d)
     
    - TimesTilde (std::string const &name, std::vector< Atom > const &args)
     Constructor.
     
    -std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    + TimesTilde (std::vector< tool::Atom > const &args)
     
    - Public Member Functions inherited from kiwi::model::OperatorTilde
    + OperatorTilde (flip::Default &d)
     
    + OperatorTilde (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    +
     Object ()
     Constructor.
     
    +
    virtual ~Object ()=default
     Destructor.
     
    -std::string getName () const
     Returns the name of the Object.
     
    -std::string getText () const
     Returns the text of the Object.
     
    -flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    -Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    -size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    -bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    -flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    -Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    -size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    -bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    -bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    -bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    -bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    -double getX () const noexcept
     Returns the x position.
     
    -double getY () const noexcept
     Returns the y position.
     
    -void setWidth (double new_width)
     Sets the width of the object.
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    -void setHeight (double new_height)
     Sets the height of the object.
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    -double getWidth () const noexcept
     Returns the object's width.
     
    -double getHeight () const noexcept
     Returns the object's height.
     
    +
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
     Object (flip::Default &)
     
    - + + + + + -

    Static Public Member Functions

    +
    static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::OperatorTilde
    +static void declare ()
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +
    static void declare ()
     
    + + + - + + + + - - - + + + + + + + + +

    Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +
    void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +
    void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +
    void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    The documentation for this class was generated from the following files:
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/classkiwi_1_1model_1_1_times_tilde.png b/docs/html/classkiwi_1_1model_1_1_times_tilde.png index 1b0a9834cd8ea4e0d352cb127f77872d459be798..340cca34cdb8647fdbb64c0adb6d1d38fa1e9c33 100644 GIT binary patch literal 1142 zcmeAS@N?(olHy`uVBq!ia0vp^bAb2&2Q!d7ruFMHkdg@S332`Z|38rV;?396{zDUh zEHFNB-~emq9eE&^qa?^Lm;tB=1g@S6F=Aj~VfA!z45?szJNIGPVk;iD4a0tTdue{N3i9hDik-zB6yd$e<^^@P{YH?Aux?k&;U zE^lP~`D4V^Z`+@ry1(;q*4)KuX>xLP&Njby{d6tj-@p9-OY!|PZ`QkkYjTF)hP{_I-+6s?W9<2&{OxsbcTMZgV*Mak#31Lycfk1sV+DsL1HU5s1H~r{HZ3v@ z?GuD;Msdf!LwGVXwnnKCn_foFOAW%JKdooyMb5i@}=MFIZQd%8Qq&O zc}cX)$+b!8JMAXUzBQ@l-P47Y1yQqp8u-sV*OeK)s5E7763_Ws&#a$LdBIWDJAKVh zH)XG|iN2*2e)Ltdifp0ocAF`G&n^ks(rrCWyS(72d;izpMW6repSJp0&4%aKrhNXt zcB=L5;Zem@;?3rZUf$+%de0l{W5@n|3%r-*8Nc-I$y~2& z{p~N)yxUYm=B@o%oWcEM_O;2^GgQNuuYFo}`IYL*Putqlo@Vvd&QprIzf}g9ithav zFWTua&Alc#PkZ&Vjec`CH2}l0?Bu%eJV}d+HR9UkVFGV22VA3#zdQfYsA_YR>PyXiKWA%twu3zPLsGxa^HuMJ$twJNPxBr& zDB(KLyoaG`Y5LCVtCM%ndwMVL@2yf@@vB@9l(8lr%n@3%5V<`U}}OSKyCB+ z(=U4e%`JFY8=85vVqTHeXBWN)Vr%d8%DnzwaKbmY=lmMuZTZ%9pI?HK(zhb-X?Iz_ z{?KC&*rL4CH}mb&Z|~NBk9K}~v+Vw5?y{m%z6BZVMZ2}TyH}lfxG-|(x2Cc^77VV{ zE_t`^UoZMRrTKW&bB3<6e-X?5B7-M%U0ZiNTsxe9?i$SvTR%6gu$;X5`<>q7za9cZ yhk41exuLI5o}Irsticb-CtviY2YJo?#4hl9PL{Oe*+sxYg2B_(&t;ucLK6V#0W)9# delta 742 zcmeyyF^NsFGr-TCmrII^fq{Y7)59eQNOuBp2M05de6q|UZla=9J<~!@7srqa#?&_Vga{IHPlP{*}#Xf!ak8S$* zl;cml^Ow)^@sv5ZM82rJzI}Cl`t#G3m+Jh>&Y!#T`d!_;`9F{S^XS>1`bpV7_Gk1P zh($uDmP`p!Vknp??Z9zp#+|&t5FqK=wBm^2$<53cCaW=c&0^5VWLmIZwg zni&~f<~wcgTjkkPm)UUMe|Pd+*XR7_wUad+=g&SdXLDuHb^rf znHlrybIzUHYV-2b)ipV%F5b-SyOy)Ly6hRxk3;6)j;Oz?H@5tI_1yg=V`Ej2s{_;y z8}JA+>^Q@#z>?^bw_QUk(dV6#W5}Z!Pi`{4@DyfH^<|i1!WeLg#Q_KB-z-nfr7aCi z0u2ylE9=#QuV&eX#;{Mnwp#c?&uLwL9|pgTrj~+>z4jYPo_<`k$S-F8@ZFe}nTVn3Xs{glUo!%SUe0|-wti2~6Hl1@xUg2rJwld=7&9!FLn_@S}=C4|< zmds>lK6BZdJ+i$Uf0rF|oBc3g)~4D^;nj`W9zVXz=PMc>ZJGX!Kn^*FaD>b<9 s+_{5u?QE + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Toggle Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Toggle, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Toggle)kiwi::model::Togglestatic
    declare() (defined in kiwi::model::Toggle)kiwi::model::Togglestatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Togglevirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    OutputValue enum value (defined in kiwi::model::Toggle)kiwi::model::Toggle
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    Signal enum name (defined in kiwi::model::Toggle)kiwi::model::Toggle
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    Toggle(flip::Default &d) (defined in kiwi::model::Toggle)kiwi::model::Toggle
    Toggle(std::vector< tool::Atom > const &args) (defined in kiwi::model::Toggle)kiwi::model::Toggle
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_toggle.html b/docs/html/classkiwi_1_1model_1_1_toggle.html new file mode 100644 index 00000000..5895714a --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_toggle.html @@ -0,0 +1,347 @@ + + + + + + +Kiwi: kiwi::model::Toggle Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Toggle Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Toggle:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + +

    +Public Types

    enum  Signal : SignalKey { OutputValue + }
     
    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Toggle (flip::Default &d)
     
    + Toggle (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Toggle.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Toggle.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_toggle.png b/docs/html/classkiwi_1_1model_1_1_toggle.png new file mode 100644 index 0000000000000000000000000000000000000000..ffda3d26340cd230941bfce4e60dcddeab59998a GIT binary patch literal 726 zcmeAS@N?(olHy`uVBq!ia0vp^B|zN4!3-oBMeNIglth3}i0l9V|AEXGZ@!lHADRGU zf$@O@2Ut7r$OE|?B|(0{3_wL7aP?G(5d#BLs;7%%NCo5Dxo;;eRuEvQKBo2j@BJS_ zjEqw=Hd$AcCr;;+XVNuz74PCw)jVV7*Hn+QXYTxXz4ZK!=uZ)*o3&!+z2tqVmD5`= z;n~-d$!AZ>U;lR|>E@X?E&WTnEtdJFrInpZ*S4MTEC0O~@5ZZBH2 z>E~Yzs+?EPyeVm4p-X^`_7&;<>w9L-l#W*w6@1Bap#2QP-kr`?=glMDPq3Tw zckOnM{Tfy6A_w{vSqqXq81F~~F_^cB9O#8}8-$l-&Z;`RWYw+dilL#UkK`(1p z^@{Ol(nVjnde_T&O;3MTTzSwl7E3b0V*Hc!H zZpxgRYO?xTkk4tAz&&PDw@#U~C2RHOs99#|)}5 z;B$T5!~d7OqSJTX|1`ZZASk`olf7ysT_K9Y1kLBgR)24FG}}c_}+V^=F5Nc z%-^!+cDbuo<<(3rnYC=CF@wAj^Ot9QFKzB8>~;QC@NN4&rN4__$ObXkqxcWmyM6+K zFL{|ROb2@Yaa`t!Q`Qxg=0B6PmL6ca5on&jgkky(@Az{Ur|G?n{ZUZ2b|-(- zinmK{`(>8gYjc_vnytCa-ICweH&yp;@UN9tOLguiOj{=S)#moG$7^CTS6|lmbiNZa z?U}*t-1k8zmRD@L)NEY4^-`F^)h$cD&NN#hey&8=O=0(yu6tS&?sdjB++X&Ut6=iA vbS{yT`Ac8xy=Q%VneD-`a8FkktIzB=cEn}}Olf2VCPD^JS3j3^P6 + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Trigger Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Trigger, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Trigger)kiwi::model::Triggerstatic
    declare() (defined in kiwi::model::Trigger)kiwi::model::Triggerstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Triggervirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    Trigger(flip::Default &d) (defined in kiwi::model::Trigger)kiwi::model::Triggerinline
    Trigger(std::vector< tool::Atom > const &args) (defined in kiwi::model::Trigger)kiwi::model::Trigger
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_trigger.html b/docs/html/classkiwi_1_1model_1_1_trigger.html new file mode 100644 index 00000000..8d9f2532 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_trigger.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Trigger Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Trigger Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Trigger:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Trigger (flip::Default &d)
     
    + Trigger (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Trigger.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Trigger.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_trigger.png b/docs/html/classkiwi_1_1model_1_1_trigger.png new file mode 100644 index 0000000000000000000000000000000000000000..5a17eb2e2aac6605447083c82dc5c6a577663d36 GIT binary patch literal 733 zcmeAS@N?(olHy`uVBq!ia0vp^CBl~*#&3Myn3BqAnz7a9B;bWdDs4H-gge@oLzbN zZn@^^bKBiNsDC(7bMwrbnfIQo%b7pv%$YYk@7>LByZvMi^YzHJw&rh*jCU_I|9i(| z-^bsxzi!SpHLhOO|8BMavVV^6)XjhYkefO4>UHrVSC?Dd4`Rg!kT9YTNmqeDWCZ&@!+-1KMB zvdc^hA07z}-MduA+`v0qbVv5BXFDgoFPi(hE#_ImJ`+sJSjT^Re8mzMGx9=LYTSTjlaHX=BCynUYJ3>*l`BDLHG~bMm-(Pg(u;Z_!=v zf4-Uj^VJHW?-KVX&yVlSf20*^xpdNe<=xd~*UsBbyZV0hr>P(GcZ!=o_`$bo)it13 zmuJo*)32&ZmmE19ih1=MYD=H*(y8k>&3?;z`=w`>pBEd)G(=k!$44taTlX@slxy{x zqg$VSe|+CA+`3SH?z-PIcCNg*V8w)j+Ne{Fva=rD`WEr;z~sP-54P4k$usWvUfTOp z=VpH8hj(rKJI=Y8@4Q!>{?6_K`-^jRpFi%kn95^r+o%1`aGz?P-oBmRHOfR!Xiohz z=SSA|fOF?{->v?1H=uvEgk(qX(Z6jAo^U+2<_L(7KOriZxn4f?b^M(>jXiIGX_3Lx L)z4*}Q$iB}sp53~ literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1model_1_1_unpack-members.html b/docs/html/classkiwi_1_1model_1_1_unpack-members.html new file mode 100644 index 00000000..edf7d391 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_unpack-members.html @@ -0,0 +1,161 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::model::Unpack Member List
    +
    +
    + +

    This is the complete list of members for kiwi::model::Unpack, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    addListener(Listener &listener) const kiwi::model::Object
    addSignal(SignalKey key, model::Object &object)kiwi::model::Objectinlineprotected
    attributeChanged(std::string const &name) const kiwi::model::Objectvirtual
    boundsChanged() const noexceptkiwi::model::Object
    create(std::vector< tool::Atom > const &args) (defined in kiwi::model::Unpack)kiwi::model::Unpackstatic
    declare() (defined in kiwi::model::Unpack)kiwi::model::Unpackstatic
    getArguments() const kiwi::model::Object
    getAttribute(std::string const &name) const kiwi::model::Object
    getChangedAttributes() const kiwi::model::Object
    getClass() const kiwi::model::Object
    getHeight() const noexceptkiwi::model::Object
    getInlet(size_t index) const kiwi::model::Object
    getInlets() const kiwi::model::Object
    getIODescription(bool is_inlet, size_t index) const overridekiwi::model::Unpackvirtual
    getMinHeight() const noexceptkiwi::model::Object
    getMinWidth() const noexceptkiwi::model::Object
    getName() const kiwi::model::Object
    getNumberOfInlets() const kiwi::model::Object
    getNumberOfOutlets() const kiwi::model::Object
    getOutlet(size_t index) const kiwi::model::Object
    getOutlets() const kiwi::model::Object
    getParameter(std::string const &name) const kiwi::model::Object
    getRatio() const kiwi::model::Object
    getSignal(SignalKey key) const kiwi::model::Objectinline
    getText() const kiwi::model::Object
    getWidth() const noexceptkiwi::model::Object
    getX() const noexceptkiwi::model::Object
    getY() const noexceptkiwi::model::Object
    hasFlag(ObjectClass::Flag flag) const kiwi::model::Object
    inletsChanged() const noexceptkiwi::model::Object
    Object()kiwi::model::Object
    Object(flip::Default &) (defined in kiwi::model::Object)kiwi::model::Object
    outletsChanged() const noexceptkiwi::model::Object
    positionChanged() const noexceptkiwi::model::Object
    pushInlet(std::set< PinType > type)kiwi::model::Objectprotected
    pushOutlet(PinType type)kiwi::model::Objectprotected
    readAttribute(std::string const &name, tool::Parameter &parameter) const kiwi::model::Objectvirtual
    removeListener(Listener &listener) const kiwi::model::Object
    setAttribute(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setHeight(double new_height)kiwi::model::Object
    setInlets(flip::Array< Inlet > const &inlets)kiwi::model::Objectprotected
    setMinHeight(double min_height)kiwi::model::Objectprotected
    setMinWidth(double min_width)kiwi::model::Objectprotected
    setOutlets(flip::Array< Outlet > const &outlets)kiwi::model::Objectprotected
    setParameter(std::string const &name, tool::Parameter const &param)kiwi::model::Object
    setPosition(double x, double y)kiwi::model::Object
    setRatio(double ratio)kiwi::model::Objectprotected
    setWidth(double new_width)kiwi::model::Object
    SignalKey typedef (defined in kiwi::model::Object)kiwi::model::Object
    sizeChanged() const noexceptkiwi::model::Object
    Unpack(flip::Default &d) (defined in kiwi::model::Unpack)kiwi::model::Unpackinline
    Unpack(std::vector< tool::Atom > const &args) (defined in kiwi::model::Unpack)kiwi::model::Unpack
    writeAttribute(std::string const &name, tool::Parameter const &paramter)kiwi::model::Objectvirtual
    ~Object()=defaultkiwi::model::Objectvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_unpack.html b/docs/html/classkiwi_1_1model_1_1_unpack.html new file mode 100644 index 00000000..263bbf59 --- /dev/null +++ b/docs/html/classkiwi_1_1model_1_1_unpack.html @@ -0,0 +1,340 @@ + + + + + + +Kiwi: kiwi::model::Unpack Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::model::Unpack Class Reference
    +
    +
    +
    +Inheritance diagram for kiwi::model::Unpack:
    +
    +
    + + +kiwi::model::Object + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Unpack (flip::Default &d)
     
    + Unpack (std::vector< tool::Atom > const &args)
     
    +std::string getIODescription (bool is_inlet, size_t index) const override
     Returns inlet or outlet description.
     
    - Public Member Functions inherited from kiwi::model::Object
    + Object ()
     Constructor.
     
    +virtual ~Object ()=default
     Destructor.
     
    +std::vector< tool::Atom > const & getArguments () const
     Returns the arguments of the object.
     
    std::set< std::string > getChangedAttributes () const
     Returns a list of changed attributes. More...
     
    +tool::Parameter const & getAttribute (std::string const &name) const
     Retrieve one of the object's attributes.
     
    +void setAttribute (std::string const &name, tool::Parameter const &param)
     Sets one of the object's attribute.
     
    +tool::Parameter const & getParameter (std::string const &name) const
     Returns one of the object's parameters.
     
    +void setParameter (std::string const &name, tool::Parameter const &param)
     Sets one of the object's parameter.
     
    virtual void writeAttribute (std::string const &name, tool::Parameter const &paramter)
     Writes the parameter into data model. More...
     
    virtual void readAttribute (std::string const &name, tool::Parameter &parameter) const
     Reads the model to initialize a parameter. More...
     
    virtual bool attributeChanged (std::string const &name) const
     Checks the data model to see if a parameter has changed. More...
     
    +void addListener (Listener &listener) const
     Adds a listener of object's parameters.
     
    +void removeListener (Listener &listener) const
     Removes listenere from list.
     
    +std::string getName () const
     Returns the name of the Object.
     
    +ObjectClass const & getClass () const
     Returns the object's static definition.
     
    +std::string getText () const
     Returns the text of the Object.
     
    +flip::Array< Inlet > const & getInlets () const
     Returns the inlets of the Object.
     
    +Inlet const & getInlet (size_t index) const
     Returns the inlets at index.
     
    +size_t getNumberOfInlets () const
     Returns the number of inlets.
     
    +bool inletsChanged () const noexcept
     Returns true if the inlets changed.
     
    +flip::Array< Outlet > const & getOutlets () const
     Returns the number of outlets.
     
    +Outlet const & getOutlet (size_t index) const
     Returns the outlets at corresponding index.
     
    +size_t getNumberOfOutlets () const
     Returns the number of outlets.
     
    +bool outletsChanged () const noexcept
     Returns true if the outlets changed.
     
    +void setPosition (double x, double y)
     Sets the x/y graphical position of the object.
     
    +bool positionChanged () const noexcept
     Returns true if the object's position changed.
     
    +bool sizeChanged () const noexcept
     Returns true if the object's size changed.
     
    +bool boundsChanged () const noexcept
     Returns true if the position or the size of the object changed.
     
    +double getX () const noexcept
     Returns the x position.
     
    +double getY () const noexcept
     Returns the y position.
     
    void setWidth (double new_width)
     Sets the width of the object. More...
     
    void setHeight (double new_height)
     Sets the height of the object. More...
     
    +double getRatio () const
     Returns the aspect ratio.
     
    +double getWidth () const noexcept
     Returns the object's width.
     
    +double getHeight () const noexcept
     Returns the object's height.
     
    +double getMinWidth () const noexcept
     Returns the minimal width for this object.
     
    +double getMinHeight () const noexcept
     Returns the minimal height for this object;.
     
    +bool hasFlag (ObjectClass::Flag flag) const
     Checks if the object has this flag set.
     
    template<class... Args>
    auto & getSignal (SignalKey key) const
     Returns the object's signal referenced by this key. More...
     
    + Object (flip::Default &)
     
    + + + + + + + + +

    +Static Public Member Functions

    +static void declare ()
     
    +static std::unique_ptr< Object > create (std::vector< tool::Atom > const &args)
     
    - Static Public Member Functions inherited from kiwi::model::Object
    +static void declare ()
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Additional Inherited Members

    - Public Types inherited from kiwi::model::Object
    +using SignalKey = uint32_t
     
    - Protected Member Functions inherited from kiwi::model::Object
    +template<class... Args>
    void addSignal (SignalKey key, model::Object &object)
     Adds a signal having singal key.
     
    +void setInlets (flip::Array< Inlet > const &inlets)
     Clear and replace all the object's inlets.
     
    +void setOutlets (flip::Array< Outlet > const &outlets)
     Clear and replace all the object's outlets.
     
    +void pushInlet (std::set< PinType > type)
     Adds an inlet at end of current inlet list.
     
    +void pushOutlet (PinType type)
     Adds an outlet at end of current outlet list.
     
    void setRatio (double ratio)
     Sets the ratio height/width. More...
     
    void setMinWidth (double min_width)
     Sets the minimal width that the object can have. More...
     
    void setMinHeight (double min_height)
     Sets the minimal height that the object can have. More...
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Unpack.h
      • +
    • Modules/KiwiModel/KiwiModel_Objects/KiwiModel_Unpack.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1model_1_1_unpack.png b/docs/html/classkiwi_1_1model_1_1_unpack.png new file mode 100644 index 0000000000000000000000000000000000000000..08bd459772130eee6eb04aa218c58265b006a12d GIT binary patch literal 726 zcmeAS@N?(olHy`uVBq!ia0vp^6+qm8{z>tg@AZ#8 z88%n=8;M@#)Q!JcDmdw7yo*Z}hoSN3>kPAJ?tC%5Vg5~tS656oFWZywTD71}?(I*- zf{(#+`}EU2%0H|Lx_#zNP<|7$&D7A;v@+-SRePAf?R>@4_wyR#o_R*byBC{pzGZ&w zYx$npR|~J4c@rhSH)g&~)qbHr7q#vGS? zT3oRCnZmKk%0GLbehlo{e!YHX%-X&Kxjp8Qe}j6$S1#3>T{Put=q2?Zd11>7{{1;! z`pM+a{0E!27yOA12`#-C-n2Y(mKDc?+_Ma}SGaA?&pomC0Dqo*k@*Mlw66@zKQbB^ zW3c;ohpym6IVXlcrohm6#orfN+jUuZ>d8A?z1-%na(N{lO#7#0F(uu6)g}q`!{+j< zcc^?ZdvH9(=)ybCZsYZtYYwbrkfb)l+Ye^g~m_|=4E zHC%lB_f>a9Ze?GWzu4vLp~rtE=Ih>zE3G~=^{DBN-j8-a9&EV%BrBLZCAe?Xt}|xU x-d4vCnDG6*bGr1WE5AWQGbn0oK{5G-ee$k^m6HysHvtnNgQu&X%Q~loCIHvNPPza9 literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_body-members.html b/docs/html/classkiwi_1_1network_1_1http_1_1_body-members.html new file mode 100644 index 00000000..71528a68 --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_body-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::network::http::Body Member List
    +
    +
    + +

    This is the complete list of members for kiwi::network::http::Body, including all inherited members.

    + + + + +
    Body()=default (defined in kiwi::network::http::Body)kiwi::network::http::Body
    Body(std::string const &body) (defined in kiwi::network::http::Body)kiwi::network::http::Body
    content (defined in kiwi::network::http::Body)kiwi::network::http::Body
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_body.html b/docs/html/classkiwi_1_1network_1_1http_1_1_body.html new file mode 100644 index 00000000..276eae18 --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_body.html @@ -0,0 +1,125 @@ + + + + + + +Kiwi: kiwi::network::http::Body Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Public Attributes | +List of all members
    +
    +
    kiwi::network::http::Body Class Reference
    +
    +
    + + + + +

    +Public Member Functions

    + Body (std::string const &body)
     
    + + + +

    +Public Attributes

    +std::string content
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h
      • +
    • Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_parameters-members.html b/docs/html/classkiwi_1_1network_1_1http_1_1_parameters-members.html new file mode 100644 index 00000000..fac08dd3 --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_parameters-members.html @@ -0,0 +1,111 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::network::http::Parameters Member List
    +
    +
    + +

    This is the complete list of members for kiwi::network::http::Parameters, including all inherited members.

    + + + + + +
    AddParameter(Parameter const &parameter) (defined in kiwi::network::http::Parameters)kiwi::network::http::Parameters
    content (defined in kiwi::network::http::Parameters)kiwi::network::http::Parameters
    Parameters()=default (defined in kiwi::network::http::Parameters)kiwi::network::http::Parameters
    Parameters(const std::initializer_list< Parameter > &parameters) (defined in kiwi::network::http::Parameters)kiwi::network::http::Parameters
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_parameters.html b/docs/html/classkiwi_1_1network_1_1http_1_1_parameters.html new file mode 100644 index 00000000..47c55ce7 --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_parameters.html @@ -0,0 +1,134 @@ + + + + + + +Kiwi: kiwi::network::http::Parameters Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +Public Attributes | +List of all members
    +
    +
    kiwi::network::http::Parameters Class Reference
    +
    +
    + + + + +

    +Classes

    struct  Parameter
     
    + + + + + +

    +Public Member Functions

    + Parameters (const std::initializer_list< Parameter > &parameters)
     
    +void AddParameter (Parameter const &parameter)
     
    + + + +

    +Public Attributes

    +std::string content
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h
      • +
    • Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_payload-members.html b/docs/html/classkiwi_1_1network_1_1http_1_1_payload-members.html new file mode 100644 index 00000000..6ee05273 --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_payload-members.html @@ -0,0 +1,112 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::network::http::Payload Member List
    +
    +
    + +

    This is the complete list of members for kiwi::network::http::Payload, including all inherited members.

    + + + + + + +
    AddPair(Pair const &pair) (defined in kiwi::network::http::Payload)kiwi::network::http::Payload
    content (defined in kiwi::network::http::Payload)kiwi::network::http::Payload
    Payload()=default (defined in kiwi::network::http::Payload)kiwi::network::http::Payload
    Payload(const It begin, const It end) (defined in kiwi::network::http::Payload)kiwi::network::http::Payload
    Payload(std::initializer_list< Pair > const &pairs) (defined in kiwi::network::http::Payload)kiwi::network::http::Payload
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_payload.html b/docs/html/classkiwi_1_1network_1_1http_1_1_payload.html new file mode 100644 index 00000000..004ad46f --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_payload.html @@ -0,0 +1,139 @@ + + + + + + +Kiwi: kiwi::network::http::Payload Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +Public Attributes | +List of all members
    +
    +
    kiwi::network::http::Payload Class Reference
    +
    +
    + + + + +

    +Classes

    struct  Pair
     
    + + + + + + + + +

    +Public Member Functions

    +template<class It >
     Payload (const It begin, const It end)
     
    + Payload (std::initializer_list< Pair > const &pairs)
     
    +void AddPair (Pair const &pair)
     
    + + + +

    +Public Attributes

    +std::string content
     
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_query-members.html b/docs/html/classkiwi_1_1network_1_1http_1_1_query-members.html new file mode 100644 index 00000000..c497b723 --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_query-members.html @@ -0,0 +1,113 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::network::http::Query< ReqType, ResType > Member List
    +
    +
    + +

    This is the complete list of members for kiwi::network::http::Query< ReqType, ResType >, including all inherited members.

    + + + + + + + +
    cancel()kiwi::network::http::Query< ReqType, ResType >
    executed()kiwi::network::http::Query< ReqType, ResType >
    Query(std::unique_ptr< Request< ReqType >> request, std::string port)kiwi::network::http::Query< ReqType, ResType >
    writeQuery(Timeout timeout=Timeout(0))kiwi::network::http::Query< ReqType, ResType >
    writeQueryAsync(std::function< void(Response< ResType > const &res)> &&callback, Timeout timeout=Timeout(0))kiwi::network::http::Query< ReqType, ResType >
    ~Query()kiwi::network::http::Query< ReqType, ResType >
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_query.html b/docs/html/classkiwi_1_1network_1_1http_1_1_query.html new file mode 100644 index 00000000..8150f666 --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_query.html @@ -0,0 +1,229 @@ + + + + + + +Kiwi: kiwi::network::http::Query< ReqType, ResType > Class Template Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::network::http::Query< ReqType, ResType > Class Template Reference
    +
    +
    + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Query (std::unique_ptr< Request< ReqType >> request, std::string port)
     Constructor.
     
     ~Query ()
     Destructor. More...
     
    Response< ResType > writeQuery (Timeout timeout=Timeout(0))
     Call request on the network. More...
     
    void writeQueryAsync (std::function< void(Response< ResType > const &res)> &&callback, Timeout timeout=Timeout(0))
     Calls the request on a specific thread. More...
     
    void cancel ()
     Cancels the request. More...
     
    +bool executed ()
     Returns true if the query was executed or cancelled.
     
    +

    Constructor & Destructor Documentation

    + +
    +
    +
    +template<class ReqType , class ResType >
    + + + + + + + +
    kiwi::network::http::Query< ReqType, ResType >::~Query ()
    +
    + +

    Destructor.

    +

    Wait for asynchronous operation to terminate.

    + +
    +
    +

    Member Function Documentation

    + +
    +
    +
    +template<class ReqType , class ResType >
    + + + + + + + +
    void kiwi::network::http::Query< ReqType, ResType >::cancel ()
    +
    + +

    Cancels the request.

    +

    Once cancel is called query is executed and cannot be invoked again. If query was launched asynchronously callback will be called with a timeout error.

    + +
    +
    + +
    +
    +
    +template<class ReqType , class ResType >
    + + + + + + + + +
    Response< ResType > kiwi::network::http::Query< ReqType, ResType >::writeQuery (Timeout timeout = Timeout(0))
    +
    + +

    Call request on the network.

    +

    If query is already executed query will not be sent again. Previous reponse will be returned.

    + +
    +
    + +
    +
    +
    +template<class ReqType , class ResType >
    + + + + + + + + + + + + + + + + + + +
    void kiwi::network::http::Query< ReqType, ResType >::writeQueryAsync (std::function< void(Response< ResType > const &res)> && callback,
    Timeout timeout = Timeout(0) 
    )
    +
    + +

    Calls the request on a specific thread.

    +

    If an asnchronous read is currently running, it will not be updated or relaunched.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_response-members.html b/docs/html/classkiwi_1_1network_1_1http_1_1_response-members.html new file mode 100644 index 00000000..56babd82 --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_response-members.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::network::http::Response< BodyType > Member List
    +
    +
    + +

    This is the complete list of members for kiwi::network::http::Response< BodyType >, including all inherited members.

    + + +
    error (defined in kiwi::network::http::Response< BodyType >)kiwi::network::http::Response< BodyType >
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_response.html b/docs/html/classkiwi_1_1network_1_1http_1_1_response.html new file mode 100644 index 00000000..6f7f42df --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_response.html @@ -0,0 +1,125 @@ + + + + + + +Kiwi: kiwi::network::http::Response< BodyType > Class Template Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Attributes | +List of all members
    +
    +
    kiwi::network::http::Response< BodyType > Class Template Reference
    +
    +
    +
    +Inheritance diagram for kiwi::network::http::Response< BodyType >:
    +
    +
    + + + +
    + + + + +

    +Public Attributes

    +Error error
     
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_response.png b/docs/html/classkiwi_1_1network_1_1http_1_1_response.png new file mode 100644 index 0000000000000000000000000000000000000000..a2690cc73d8f8a0718177afe7d23129cd9e11326 GIT binary patch literal 879 zcmV-#1CacQP){002-30{{R3=y&tE0000OP)t-s|Ns90 z008Lh^>vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d00091Nkl(fhygNyDE2VLNF$O^@jCjYBa)DQ2v#YAc(`Hvy zji(d#gT=a(f7~DM4&$R4tEw68)byvS`l>#geRjdlzI)s$dkSriaDCLD^_`rCvY{?@ zn+AJrW{i96%|woHi%Omij;gAj>Wn>|RS!^=d5CHoc2Z{E^1QQV(nNJScga2)F=kX% zJzco-y~%pDyF2d?n5BM`7fbuD*`6!f-8JUjJN}sdB71S7Jf2}6H_e__+kM42c{is_ z%hu6L^w;xlQqwoK3wiIZjF%;2&*t6TmAZ)8I^C`}<^8bUJ@(Fl-mAIZ{ivPPyU+d; z^*;6a>OpC`t=qId-<9P-pSLCM^!ajwyFTAt!xo{p_jy&-r*vZNJ%>4;{8tSBMRo^0 z3cH8?5$vj}e?^;JRW+VAyQ*qD-PuJ%VhZ5*bOQ*g!0fkMT=>B3cl5CEk=b{j2Z*T6 z4iHb99Uz`IJ3u^bc7S-=>;Un!*#Y8dvjfD_W(SC;%?=Pxn;jsYHakE(ZFYcPk%&l8 zApjw@*#Y8dvjfCaWls+qh(%CVv2wQFALHApzXH50$3&f$1`cqlfgRvP-(-L4EPzRl zi3=$M7-ZQW<7=AKf_V>T4r+>QeI@-Xy=+0#j`|TbiKvd3o%yVGfSI-bx$MnEKD$Mw zxVJPius7oRE06li3s3UG%(@-Z#N3C~0RncEaxCsUCYJ1@5o5-(8fFx9v!*14g8m~pM% zefEp>J_ZY+4bxZq#!^dVY>?Tf*5~_Pci87`5jlOn+~BUy+k0subg9n+{EW^Ic#jLt zC;!;+|HJN}M`8ESf1e%TBemH9;%T!3#M9T;UqmFN{sH;9lGpbbc9Q@A002ovPDHLk FV1kxN!TkUL literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_session-members.html b/docs/html/classkiwi_1_1network_1_1http_1_1_session-members.html new file mode 100644 index 00000000..c102c31b --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_session-members.html @@ -0,0 +1,130 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::network::http::Session Member List
    +
    +
    + +

    This is the complete list of members for kiwi::network::http::Session, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + +
    Callback typedef (defined in kiwi::network::http::Session)kiwi::network::http::Session
    cancel() (defined in kiwi::network::http::Session)kiwi::network::http::Session
    Delete() (defined in kiwi::network::http::Session)kiwi::network::http::Session
    DeleteAsync(Callback callback) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    executed() (defined in kiwi::network::http::Session)kiwi::network::http::Session
    Get() (defined in kiwi::network::http::Session)kiwi::network::http::Session
    GetAsync(Callback callback) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    getId() const (defined in kiwi::network::http::Session)kiwi::network::http::Session
    Post() (defined in kiwi::network::http::Session)kiwi::network::http::Session
    PostAsync(Callback callback) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    Put() (defined in kiwi::network::http::Session)kiwi::network::http::Session
    PutAsync(Callback callback) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    Response typedef (defined in kiwi::network::http::Session)kiwi::network::http::Session
    Session() (defined in kiwi::network::http::Session)kiwi::network::http::Session
    setAuthorization(std::string const &auth) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    setBody(std::string const &content) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    setHost(std::string const &host) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    setParameters(Parameters &&parameters) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    setPayload(Payload &&payload) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    setPort(std::string const &port) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    setTarget(std::string const &endpoint) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    setTimeout(Timeout timeout) (defined in kiwi::network::http::Session)kiwi::network::http::Session
    ~Session()=default (defined in kiwi::network::http::Session)kiwi::network::http::Session
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1network_1_1http_1_1_session.html b/docs/html/classkiwi_1_1network_1_1http_1_1_session.html new file mode 100644 index 00000000..b6eda76a --- /dev/null +++ b/docs/html/classkiwi_1_1network_1_1http_1_1_session.html @@ -0,0 +1,182 @@ + + + + + + +Kiwi: kiwi::network::http::Session Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +List of all members
    +
    +
    kiwi::network::http::Session Class Reference
    +
    +
    + + + + + + +

    +Public Types

    +using Response = http::Response< beast::http::string_body >
     
    +using Callback = std::function< void(Response)>
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    +uint64_t getId () const
     
    +void setHost (std::string const &host)
     
    +void setPort (std::string const &port)
     
    +void setTarget (std::string const &endpoint)
     
    +void setTimeout (Timeout timeout)
     
    +void setAuthorization (std::string const &auth)
     
    +void setParameters (Parameters &&parameters)
     
    +void setPayload (Payload &&payload)
     
    +void setBody (std::string const &content)
     
    +bool executed ()
     
    +void cancel ()
     
    +Response Get ()
     
    +void GetAsync (Callback callback)
     
    +Response Post ()
     
    +void PostAsync (Callback callback)
     
    +Response Put ()
     
    +void PutAsync (Callback callback)
     
    +Response Delete ()
     
    +void DeleteAsync (Callback callback)
     
    +
    The documentation for this class was generated from the following files:
      +
    • Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.h
      • +
    • Modules/KiwiNetwork/KiwiHttp/KiwiHttp_Session.cpp
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1server_1_1_server-members.html b/docs/html/classkiwi_1_1server_1_1_server-members.html new file mode 100644 index 00000000..87b25eb9 --- /dev/null +++ b/docs/html/classkiwi_1_1server_1_1_server-members.html @@ -0,0 +1,112 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::server::Server Member List
    +
    +
    + +

    This is the complete list of members for kiwi::server::Server, including all inherited members.

    + + + + + + +
    getConnectedUsers(uint64_t session_id) const kiwi::server::Server
    getSessions() const kiwi::server::Server
    process()kiwi::server::Server
    Server(uint16_t port, std::string const &backend_directory, std::string const &open_token, std::string const &kiwi_version)kiwi::server::Server
    ~Server()kiwi::server::Server
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1server_1_1_server.html b/docs/html/classkiwi_1_1server_1_1_server.html new file mode 100644 index 00000000..fae25a2a --- /dev/null +++ b/docs/html/classkiwi_1_1server_1_1_server.html @@ -0,0 +1,216 @@ + + + + + + +Kiwi: kiwi::server::Server Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +List of all members
    +
    +
    kiwi::server::Server Class Reference
    +
    +
    + +

    The Server class. + More...

    + +

    #include <KiwiServer_Server.h>

    +
    +Inheritance diagram for kiwi::server::Server:
    +
    +
    + + + +
    + + + + + + +

    +Classes

    class  Logger
     
    class  Session
     
    + + + + + + + + + + + + + + + + +

    +Public Member Functions

     Server (uint16_t port, std::string const &backend_directory, std::string const &open_token, std::string const &kiwi_version)
     Constructor. More...
     
     ~Server ()
     Destructor. More...
     
    +void process ()
     Process the socket hence process all sessions.
     
    +std::set< uint64_t > getSessions () const
     Returns a list of sessions currenty opened.
     
    +std::set< uint64_t > getConnectedUsers (uint64_t session_id) const
     Returns a list of users connected to session.
     
    +

    Detailed Description

    +

    The Server class.

    +

    Constructor & Destructor Documentation

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    kiwi::server::Server::Server (uint16_t port,
    std::string const & backend_directory,
    std::string const & open_token,
    std::string const & kiwi_version 
    )
    +
    + +

    Constructor.

    +

    Initializes socket and creates backend directory if not there.

    + +
    +
    + +
    +
    + + + + + + + +
    kiwi::server::Server::~Server ()
    +
    + +

    Destructor.

    +

    Disconnect all users and clean sessions. onDisconnected will be called for all port.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1server_1_1_server.png b/docs/html/classkiwi_1_1server_1_1_server.png new file mode 100644 index 0000000000000000000000000000000000000000..22f2d651bcf2353b843bfe37aeb3824b5a2a481c GIT binary patch literal 729 zcmeAS@N?(olHy`uVBq!ia0y~yU}OTa12~w0t+`7`H7v9z?!Eq{!SXRAtho(ptwm{hF7;-tXh6rgaUTKS|! z-MapHo|`0|bK2YP-6rMmAv!Po@x&Bu_ku@94o~P=od2zs<5y9&bQ8;+vTuxqv+Dl* zOx$iQr+v>W^=pCHT$RhGIsA%W_q$J8E5)*M&f%4lc|(8oCWI?>Jig&~)>xV2T(PlH zpZG_QO`(^$wT|XSxaa0*Zx-_Vdd5S4hjhP6^wiZ2OQv>7KNM{e&@3)*5b8fD#r)0CGl}b zx0K)c;rgLXG%PXmY3<4%`(j-Ko|l=*d2Tz!;ZYQm>{lf?;mQ8X)dD=fekidl*4vjU zI^jt}ivtG`O>;^}GxKC@oOx4)@c?fwgF$TYW`U;M=*ELrbXp#$e`DfVmZr#()eZ_a zIAS<(d|U2qCZ-1dYs;VWGnlI)$-xvc)YPyt8E=kcYG5@n_-^NwN>UJc^_rG?Y_wZxV<=?e;PPo~HhL)a`U{E{t`QxF_GZ_n)czvog z{c3YouFf=035XbK5^Rg!2b9^86b?{TQP)2)51O-&wa zR;^Smcw@rWaB|h{hbOyo^INage@fDqWIm8`bh_~D#K6j*t{m?3Pc5@OmaW9l@Lvb) lLZBm=6eD;cq2c?Nv25 + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::server::Server::Logger Member List
    +
    +
    + +

    This is the complete list of members for kiwi::server::Server::Logger, including all inherited members.

    + + + + +
    log(juce::String const &message)kiwi::server::Server::Logger
    Logger(juce::File const &file, juce::String const &welcome_message)kiwi::server::Server::Logger
    ~Logger()kiwi::server::Server::Logger
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1server_1_1_server_1_1_logger.html b/docs/html/classkiwi_1_1server_1_1_server_1_1_logger.html new file mode 100644 index 00000000..d7cc70b1 --- /dev/null +++ b/docs/html/classkiwi_1_1server_1_1_server_1_1_logger.html @@ -0,0 +1,127 @@ + + + + + + +Kiwi: kiwi::server::Server::Logger Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::server::Server::Logger Class Referencefinal
    +
    +
    + + + + + + + + + + + +

    +Public Member Functions

    + Logger (juce::File const &file, juce::String const &welcome_message)
     Constructor.
     
    + ~Logger ()
     Destructor.
     
    +void log (juce::String const &message)
     Logs a message.
     
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1server_1_1_server_1_1_session-members.html b/docs/html/classkiwi_1_1server_1_1_server_1_1_session-members.html new file mode 100644 index 00000000..122a4a45 --- /dev/null +++ b/docs/html/classkiwi_1_1server_1_1_server_1_1_session-members.html @@ -0,0 +1,116 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::server::Server::Session Member List
    +
    +
    + +

    This is the complete list of members for kiwi::server::Server::Session, including all inherited members.

    + + + + + + + + + + +
    bind(flip::PortBase &port)kiwi::server::Server::Session
    getConnectedUsers() const kiwi::server::Server::Session
    getId() const kiwi::server::Server::Session
    load()kiwi::server::Server::Session
    save() const kiwi::server::Server::Session
    Session(Session &&rhs)kiwi::server::Server::Session
    Session(uint64_t identifier, juce::File const &backend_file, std::string const &token, std::string const &kiwi_version, Server::Logger &logger)kiwi::server::Server::Session
    unbind(flip::PortBase &port)kiwi::server::Server::Session
    ~Session()kiwi::server::Server::Session
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1server_1_1_server_1_1_session.html b/docs/html/classkiwi_1_1server_1_1_server_1_1_session.html new file mode 100644 index 00000000..9cea2595 --- /dev/null +++ b/docs/html/classkiwi_1_1server_1_1_server_1_1_session.html @@ -0,0 +1,269 @@ + + + + + + +Kiwi: kiwi::server::Server::Session Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::server::Server::Session Class Referencefinal
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     Session (Session &&rhs)
     Constructor. More...
     
     Session (uint64_t identifier, juce::File const &backend_file, std::string const &token, std::string const &kiwi_version, Server::Logger &logger)
     Constructor. More...
     
     ~Session ()
     Destructor. More...
     
    +uint64_t getId () const
     Returns the id of the session.
     
    bool save () const
     Saves the document into designated backend file. More...
     
    +bool load ()
     Loads the document from designated backend file.
     
    +void bind (flip::PortBase &port)
     Binds user to session.
     
    void unbind (flip::PortBase &port)
     Unbinds user from session. More...
     
    +std::set< uint64_t > getConnectedUsers () const
     Returns a list of connected users.
     
    +

    Constructor & Destructor Documentation

    + +
    +
    + + + + + + + + +
    kiwi::server::Server::Session::Session (Session && rhs)
    +
    + +

    Constructor.

    +

    Create a Session by moving another Session.

    + +
    +
    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    kiwi::server::Server::Session::Session (uint64_t identifier,
    juce::File const & backend_file,
    std::string const & token,
    std::string const & kiwi_version,
    Server::Logger & logger 
    )
    +
    + +

    Constructor.

    +

    Constructor will load the document if file exists. backend_file is the file in which the session will save and load document.

    + +
    +
    + +
    +
    + + + + + + + +
    kiwi::server::Server::Session::~Session ()
    +
    + +

    Destructor.

    +

    Unbinds all documents and ports.

    + +
    +
    +

    Member Function Documentation

    + +
    +
    + + + + + + + +
    bool kiwi::server::Server::Session::save () const
    +
    + +

    Saves the document into designated backend file.

    +

    Returns true if saving succeeded.

    + +
    +
    + +
    +
    + + + + + + + + +
    void kiwi::server::Server::Session::unbind (flip::PortBase & port)
    +
    + +

    Unbinds user from session.

    +

    If user that disconnect is the last one, the session will be saved.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_atom-members.html b/docs/html/classkiwi_1_1tool_1_1_atom-members.html new file mode 100644 index 00000000..30f3862d --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_atom-members.html @@ -0,0 +1,141 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Atom Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Atom, including all inherited members.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Atom() noexceptkiwi::tool::Atom
    Atom(const bool value) noexceptkiwi::tool::Atom
    Atom(const int value) noexceptkiwi::tool::Atom
    Atom(const long value) noexceptkiwi::tool::Atom
    Atom(const long long value) noexceptkiwi::tool::Atom
    Atom(const float value) noexceptkiwi::tool::Atom
    Atom(const double value) noexceptkiwi::tool::Atom
    Atom(string_t const &sym)kiwi::tool::Atom
    Atom(string_t &&sym)kiwi::tool::Atom
    Atom(char const *sym)kiwi::tool::Atom
    Atom(Atom const &other)kiwi::tool::Atom
    Atom(Atom &&other)kiwi::tool::Atom
    Comma()kiwi::tool::Atomstatic
    Dollar(int_t index)kiwi::tool::Atomstatic
    float_t typedefkiwi::tool::Atom
    getDollarIndex() const kiwi::tool::Atom
    getFloat() const noexceptkiwi::tool::Atom
    getInt() const noexceptkiwi::tool::Atom
    getString() const kiwi::tool::Atom
    getType() const noexceptkiwi::tool::Atom
    int_t typedefkiwi::tool::Atom
    isBang() const kiwi::tool::Atom
    isComma() const noexceptkiwi::tool::Atom
    isDollar() const noexceptkiwi::tool::Atom
    isFloat() const noexceptkiwi::tool::Atom
    isInt() const noexceptkiwi::tool::Atom
    isNull() const noexceptkiwi::tool::Atom
    isNumber() const noexceptkiwi::tool::Atom
    isString() const noexceptkiwi::tool::Atom
    operator=(Atom const &other)kiwi::tool::Atom
    operator=(Atom &&other) noexceptkiwi::tool::Atom
    string_t typedefkiwi::tool::Atom
    Type enum namekiwi::tool::Atom
    ~Atom()kiwi::tool::Atom
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_atom.html b/docs/html/classkiwi_1_1tool_1_1_atom.html new file mode 100644 index 00000000..54e0ba4a --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_atom.html @@ -0,0 +1,1028 @@ + + + + + + +Kiwi: kiwi::tool::Atom Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Types | +Public Member Functions | +Static Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Atom Class Reference
    +
    +
    + +

    The Atom can dynamically hold different types of value. + More...

    + +

    #include <KiwiTool_Atom.h>

    + + + + + + + + + + + + + + +

    +Public Types

    enum  Type : uint8_t {
    +  Null = 0, +Int, +Float, +String, +
    +  Comma, +Dollar +
    + }
     Enum of Atom value types. More...
     
    +using int_t = int64_t
     The type of a signed integer number in the Atom class.
     
    +using float_t = double
     The type of a floating-point number in the Atom class.
     
    +using string_t = std::string
     The type of a string type in the Atom class.
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     Atom () noexcept
     Default constructor. More...
     
     Atom (const bool value) noexcept
     Constructs an int_t Atom. More...
     
     Atom (const int value) noexcept
     Constructs an int_t Atom. More...
     
     Atom (const long value) noexcept
     Constructs an int_t Atom. More...
     
     Atom (const long long value) noexcept
     Constructs an int_t Atom. More...
     
     Atom (const float value) noexcept
     Constructs a float_t Atom. More...
     
     Atom (const double value) noexcept
     Constructs a float_t Atom. More...
     
     Atom (string_t const &sym)
     Constructs a string_t Atom. More...
     
     Atom (string_t &&sym)
     Constructs a string_t Atom. More...
     
     Atom (char const *sym)
     Constructs a string_t Atom. More...
     
     Atom (Atom const &other)
     Copy constructor. More...
     
     Atom (Atom &&other)
     Move constructor. More...
     
    + ~Atom ()
     Destructor.
     
    Atom & operator= (Atom const &other)
     Copy assigment operator. More...
     
    Atom & operator= (Atom &&other) noexcept
     Copy assigment operator. More...
     
    Type getType () const noexcept
     Get the type of the Atom. More...
     
    bool isNull () const noexcept
     Returns true if the Atom is Null. More...
     
    bool isInt () const noexcept
     Returns true if the Atom is an int_t. More...
     
    bool isFloat () const noexcept
     Returns true if the Atom is a float_t. More...
     
    bool isNumber () const noexcept
     Returns true if the Atom is a bool, an int_t, or a float_t. More...
     
    bool isString () const noexcept
     Returns true if the Atom is a string_t. More...
     
    bool isBang () const
     Returns true if the Atom is a string_t that contains the special "bang" keyword. More...
     
    bool isComma () const noexcept
     Returns true if the Atom is an comma_t. More...
     
    bool isDollar () const noexcept
     Returns true if the Atom is a dollar or a dollar typed. More...
     
    int_t getInt () const noexcept
     Retrieves the Atom value as an int_t value. More...
     
    float_t getFloat () const noexcept
     Retrieves the Atom value as a float_t value. More...
     
    string_t const & getString () const
     Retrieves the Atom value as a string_t value. More...
     
    int_t getDollarIndex () const
     Retrieves the Dollar index value if the Atom is a dollar type. More...
     
    + + + + + + + +

    +Static Public Member Functions

    +static Atom Comma ()
     Constructs a Comma Atom.
     
    static Atom Dollar (int_t index)
     Constructs a Dollar Atom. More...
     
    +

    Detailed Description

    +

    The Atom can dynamically hold different types of value.

    +

    The Atom can hold an integer, a float or a string.

    +

    Member Enumeration Documentation

    + +
    +
    + + + + + +
    + + + + +
    enum kiwi::tool::Atom::Type : uint8_t
    +     		+strong
    +
    + +

    Enum of Atom value types.

    +
    See also
    getType(), isNull(), isInt(), isFloat(), isNumber(), isString(), isComma(), isDollar()
    + +
    +
    +

    Constructor & Destructor Documentation

    + +
    +
    + + + + + +
    + + + + + + + +
    kiwi::tool::Atom::Atom ()
    +     		+noexcept
    +
    + +

    Default constructor.

    +

    Constructs an Atom of type Null.

    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (const bool value)
    +     		+noexcept
    +
    + +

    Constructs an int_t Atom.

    +

    The integer value will be 1 or 0 depending on the bool value.

    Parameters
    + + +
    valueThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (const int value)
    +     		+noexcept
    +
    + +

    Constructs an int_t Atom.

    +
    Parameters
    + + +
    valueThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (const long value)
    +     		+noexcept
    +
    + +

    Constructs an int_t Atom.

    +
    Parameters
    + + +
    valueThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (const long long value)
    +     		+noexcept
    +
    + +

    Constructs an int_t Atom.

    +
    Parameters
    + + +
    valueThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (const float value)
    +     		+noexcept
    +
    + +

    Constructs a float_t Atom.

    +

    infinty and NaN value both produce a Null Atom type.

    Parameters
    + + +
    valueThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (const double value)
    +     		+noexcept
    +
    + +

    Constructs a float_t Atom.

    +

    infinty and NaN value both produce a Null Atom type.

    Parameters
    + + +
    valueThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (string_t const & sym)
    +
    + +

    Constructs a string_t Atom.

    +
    Parameters
    + + +
    symThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (string_t && sym)
    +
    + +

    Constructs a string_t Atom.

    +
    Parameters
    + + +
    symThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (char const * sym)
    +
    + +

    Constructs a string_t Atom.

    +
    Parameters
    + + +
    symThe value.
    +
    +
    + +
    +
    + +
    +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (Atom const & other)
    +
    + +

    Copy constructor.

    +

    Constructs an Atom by copying the contents of an other Atom.

    Parameters
    + + +
    otherThe other Atom.
    +
    +
    + +
    +
    + +
    +
    + + + + + + + + +
    kiwi::tool::Atom::Atom (Atom && other)
    +
    + +

    Move constructor.

    +

    Constructs an Atom value by stealing the contents of an other Atom using move semantics, leaving the other as a Null value Atom.

    Parameters
    + + +
    otherThe other Atom value.
    +
    +
    + +
    +
    +

    Member Function Documentation

    + +
    +
    + + + + + +
    + + + + + + + + +
    Atom kiwi::tool::Atom::Dollar (int_t index)
    +     		+static
    +
    + +

    Constructs a Dollar Atom.

    +
    Parameters
    + + +
    indexmust be between 1 and 9
    +
    +
    +
    Returns
    A Dollar Atom or a Null Atom if out of range.
    + +
    +
    + +
    +
    + + + + + + + +
    Atom::int_t kiwi::tool::Atom::getDollarIndex () const
    +
    + +

    Retrieves the Dollar index value if the Atom is a dollar type.

    +
    Returns
    The Dollar index if the Atom is a dollar, 0 otherwise.
    +
    See also
    getType(), isDollar(), isDollarTyped()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    Atom::float_t kiwi::tool::Atom::getFloat () const
    +     		+noexcept
    +
    + +

    Retrieves the Atom value as a float_t value.

    +
    Returns
    The current floating-point atom value if it is a number otherwise 0.0.
    +
    See also
    getType(), isNumber(), isFloat(), getInt()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    Atom::int_t kiwi::tool::Atom::getInt () const
    +     		+noexcept
    +
    + +

    Retrieves the Atom value as an int_t value.

    +
    Returns
    The current integer atom value if it is a number otherwise 0.
    +
    See also
    getType(), isNumber(), isInt(), getFloat()
    + +
    +
    + +
    +
    + + + + + + + +
    Atom::string_t const & kiwi::tool::Atom::getString () const
    +
    + +

    Retrieves the Atom value as a string_t value.

    +
    Returns
    The current string atom value if it is a string otherwise an empty string.
    +
    See also
    getType(), isString(), getInt(), getFloat()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    Atom::Type kiwi::tool::Atom::getType () const
    +     		+noexcept
    +
    + +

    Get the type of the Atom.

    +
    Returns
    The Type of the atom as a Type.
    +
    See also
    isNull(), isInt(), isFloat(), isNumber(), isString()
    + +
    +
    + +
    +
    + + + + + + + +
    bool kiwi::tool::Atom::isBang () const
    +
    + +

    Returns true if the Atom is a string_t that contains the special "bang" keyword.

    +
    Returns
    true if the Atom is a string_t that contains the special "bang" keyword.
    +
    See also
    getType(), isNull(), isInt(), isFloat(), isString()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    bool kiwi::tool::Atom::isComma () const
    +     		+noexcept
    +
    + +

    Returns true if the Atom is an comma_t.

    +
    Returns
    true if the Atom is a comma_t.
    +
    See also
    getType(), isNull(), isInt(), isFloat(), isNumber(), isString()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    bool kiwi::tool::Atom::isDollar () const
    +     		+noexcept
    +
    + +

    Returns true if the Atom is a dollar or a dollar typed.

    +
    Returns
    true if the Atom is a dollar_t.
    +
    See also
    getType(), isNull(), isInt(), isFloat(), isNumber(), isString()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    bool kiwi::tool::Atom::isFloat () const
    +     		+noexcept
    +
    + +

    Returns true if the Atom is a float_t.

    +
    Returns
    true if the Atom is an float_t.
    +
    See also
    getType(), isNull(), isInt(), isNumber(), isString()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    bool kiwi::tool::Atom::isInt () const
    +     		+noexcept
    +
    + +

    Returns true if the Atom is an int_t.

    +
    Returns
    true if the Atom is an int_t.
    +
    See also
    getType(), isNull(), isFloat(), isNumber(), isString()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    bool kiwi::tool::Atom::isNull () const
    +     		+noexcept
    +
    + +

    Returns true if the Atom is Null.

    +
    Returns
    true if the Atom is Null.
    +
    See also
    getType(), isInt(), isFloat(), isNumber(), isString()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    bool kiwi::tool::Atom::isNumber () const
    +     		+noexcept
    +
    + +

    Returns true if the Atom is a bool, an int_t, or a float_t.

    +
    Returns
    true if the Atom is a bool, an int_t, or a float_t.
    +
    See also
    getType(), isNull(), isInt(), isFloat(), isString()
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + +
    bool kiwi::tool::Atom::isString () const
    +     		+noexcept
    +
    + +

    Returns true if the Atom is a string_t.

    +
    Returns
    true if the Atom is a string_t.
    +
    See also
    getType(), isNull(), isInt(), isFloat(), isNumber()
    + +
    +
    + +
    +
    + + + + + + + + +
    Atom & kiwi::tool::Atom::operator= (Atom const & other)
    +
    + +

    Copy assigment operator.

    +

    Copies an Atom value.

    Parameters
    + + +
    otherThe Atom object to copy.
    +
    +
    + +
    +
    + +
    +
    + + + + + +
    + + + + + + + + +
    Atom & kiwi::tool::Atom::operator= (Atom && other)
    +     		+noexcept
    +
    + +

    Copy assigment operator.

    +

    Copies an Atom value with the "copy and swap" method.

    Parameters
    + + +
    otherThe Atom object to copy.
    +
    +
    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_beacon-members.html b/docs/html/classkiwi_1_1tool_1_1_beacon-members.html new file mode 100644 index 00000000..1cb7c383 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_beacon-members.html @@ -0,0 +1,113 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Beacon Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Beacon, including all inherited members.

    + + + + + + + +
    Beacon::Factory (defined in kiwi::tool::Beacon)kiwi::tool::Beaconfriend
    bind(Castaway &castaway)kiwi::tool::Beacon
    dispatch(std::vector< Atom > const &args)kiwi::tool::Beacon
    getName() const kiwi::tool::Beaconinline
    unbind(Castaway &castaway)kiwi::tool::Beacon
    ~Beacon()=defaultkiwi::tool::Beacon
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_beacon.html b/docs/html/classkiwi_1_1tool_1_1_beacon.html new file mode 100644 index 00000000..305e35fe --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_beacon.html @@ -0,0 +1,162 @@ + + + + + + +Kiwi: kiwi::tool::Beacon Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +Friends | +List of all members
    +
    +
    kiwi::tool::Beacon Class Reference
    +
    +
    + +

    The beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used to bind beacon's castaways. + More...

    + +

    #include <KiwiTool_Beacon.h>

    + + + + + + + + +

    +Classes

    class  Castaway
     The beacon castaway can be binded to a beacon. More...
     
    class  Factory
     The beacon factory is used to create beacons. More...
     
    + + + + + + + + + + + + + + + + +

    +Public Member Functions

    +std::string getName () const
     Gets the name of the beacon.
     
    + ~Beacon ()=default
     Destructor.
     
    +void bind (Castaway &castaway)
     Adds a castaway in the binding list of the beacon.
     
    +void unbind (Castaway &castaway)
     Removes a castaways from the binding list of the beacon.
     
    +void dispatch (std::vector< Atom > const &args)
     Dispatch message to beacon castaways.
     
    + + + +

    +Friends

    +class Beacon::Factory
     
    +

    Detailed Description

    +

    The beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used to bind beacon's castaways.

    +

    The beacon are uniques in the scope of a beacon factory and matchs to a string. If you create a beacon with a string that already matchs to a beacon of the beacon factory, it will return this beacon otherwise it will create a new beacon. Thus, the beacons can be used to bind, unbind and retrieve castways. After recovering a castaway, you should dynamically cast it to the class you expect. More often, this will be a kiwi Object.

    See also
    Beacon::Factory
    +
    +Beacon::Castaway
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway-members.html b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway-members.html new file mode 100644 index 00000000..c795b4f2 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway-members.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Beacon::Castaway Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Beacon::Castaway, including all inherited members.

    + + + +
    receive(std::vector< Atom > const &args)=0 (defined in kiwi::tool::Beacon::Castaway)kiwi::tool::Beacon::Castawaypure virtual
    ~Castaway() (defined in kiwi::tool::Beacon::Castaway)kiwi::tool::Beacon::Castawayinlinevirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway.html b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway.html new file mode 100644 index 00000000..f5b828b2 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway.html @@ -0,0 +1,133 @@ + + + + + + +Kiwi: kiwi::tool::Beacon::Castaway Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Beacon::Castaway Class Referenceabstract
    +
    +
    + +

    The beacon castaway can be binded to a beacon. + More...

    + +

    #include <KiwiTool_Beacon.h>

    +
    +Inheritance diagram for kiwi::tool::Beacon::Castaway:
    +
    +
    + + +kiwi::engine::Receive + +
    + + + + +

    +Public Member Functions

    +virtual void receive (std::vector< Atom > const &args)=0
     
    +

    Detailed Description

    +

    The beacon castaway can be binded to a beacon.

    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway.png b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_castaway.png new file mode 100644 index 0000000000000000000000000000000000000000..7eab72265719b73482f8644689f307dee9e728cc GIT binary patch literal 694 zcmeAS@N?(olHy`uVBq!ia0vp^D}gwGgBeJMPFs2gNJ#|vgt-3y{~ySF@#br3|Dg#$ z78oBmaDcV*jy#adQ4-`A%m7pb0#{Fk7%?y~xq7-dhEy=Vo%?#yY6Std+5M~b{8ygu z!p!G!Wsc7(r?)vb9e4V2_xzqdC1@6t&;gbf%?ABMt_R+xvD~X;-ouz1TAE`ybj~dVVZAV)0>PX7Q4@ zI?Z?Vb${o`*J|Ya`x<+e{lLEKpKq=^)&IYL*0C$|X3sY>EwbPLJCW;y>LHN>(|2cj zX`W?hur_bdoN??+*=*NRsmr@xsI2-t!|fe&h43XQD5Wj`y{8DD-{mzNaE!+Be^Pv)5`}3!kMYP{c^OPz`+V%75?ke4*VHd@o*{;sizE-mF&?J)w zH?ABpaC|Kk+Y@zeWoGugeL1__>NB$@pLmledHH<8EY-{-OYg?#ow{azvTVz;-NjkQ zz8KG0^ZaQ~R^`Hq4Zqc&UwJl1rPuPW*Ug%&J8v&;-g)0NdZzf!c>6p5=l`BmBDuVO zy$bI~!@UJ(R9-62x%Q>vvC7NjKV|Wg_Ib|mnxvno<+<;UZ}GWGwttMVr&V|j{S{+? PiHyP1)z4*}Q$iB}aUWAv literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory-members.html b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory-members.html new file mode 100644 index 00000000..4691ce65 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Beacon::Factory Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Beacon::Factory, including all inherited members.

    + + + + +
    Factory()=default (defined in kiwi::tool::Beacon::Factory)kiwi::tool::Beacon::Factory
    getBeacon(std::string const &name) (defined in kiwi::tool::Beacon::Factory)kiwi::tool::Beacon::Factory
    ~Factory()=default (defined in kiwi::tool::Beacon::Factory)kiwi::tool::Beacon::Factory
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory.html b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory.html new file mode 100644 index 00000000..5302e1f6 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory.html @@ -0,0 +1,134 @@ + + + + + + +Kiwi: kiwi::tool::Beacon::Factory Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Beacon::Factory Class Reference
    +
    +
    + +

    The beacon factory is used to create beacons. + More...

    + +

    #include <KiwiTool_Beacon.h>

    +
    +Inheritance diagram for kiwi::tool::Beacon::Factory:
    +
    +
    + + +kiwi::engine::Instance + +
    + + + + +

    +Public Member Functions

    +Beacon & getBeacon (std::string const &name)
     
    +

    Detailed Description

    +

    The beacon factory is used to create beacons.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory.png b/docs/html/classkiwi_1_1tool_1_1_beacon_1_1_factory.png new file mode 100644 index 0000000000000000000000000000000000000000..c2381c1180f190c3a9be2da1b0f7a0e683f9abb9 GIT binary patch literal 668 zcmeAS@N?(olHy`uVBq!ia0vp^^ME*jgBeKP-)Ykeq$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0v^`xMLn;{G&VAjtR6&5PyZ_0a|H|(r z^Gg=5xNXIG(qJKiJHMNE$~?`T40)TD zC?|MVcY5(B9Phk$)Q92t#~amE!9RaKKVy}7>)od3J8!+-`L1e%rC#;By0=>oYE0A(dtVzH*#0AY|EMTwd%Cp>CKmo*MIVs-GAe*?e+zG_5P*)+q7#U=Zea8+soF^ zDxTx_WzF->xSLL*cT|7^!m|(C);Y zt?BbuyJyxFB);*OzVqtz)yMyv{<^mL{>gt|dIIMkl&xaum#kt4+*hT!^olM+{wKy4 z)AxO~o4@YwuWP?=eSLF%=e-j#4HnM)3a2hGcNl$PSj1!7pn;qF$8hhQ;<}0c=PdWL zM^36rec>52Wudxfpj6e#Kexm@trlI3HlMGr!iwU?uJZylKJv%^`uFfst&tbrSm_X zjds8LXVty)_dD<1iLE}PeUAU?mrcu5D)pMIZP!dJz5e^nmsQ#^eeW`&munVJl$zIe z{p^EnUzEz%d+}_q=$w51&Z^ycW-qg+@ujX)x%+Hs{}Pp}HdnLTTqn)@{Nqbh;>0D- w_Xx&#{!(q5r{XGEHA&>@>gmPj?tbF`cR_LEFUiS)z@)_B>FVdQ&MBb@0K~UcJpcdz literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1tool_1_1_circular_buffer-members.html b/docs/html/classkiwi_1_1tool_1_1_circular_buffer-members.html new file mode 100644 index 00000000..cd7b87a8 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_circular_buffer-members.html @@ -0,0 +1,117 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::CircularBuffer< T > Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::CircularBuffer< T >, including all inherited members.

    + + + + + + + + + + + +
    assign(size_t nb_elements, const T &value) (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    CircularBuffer(size_t capacity) (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    CircularBuffer(size_t capacity, size_t size, T const &value) (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    clear() (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    operator[](size_t index) const noexcept (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    operator[](size_t index) noexcept (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    pop_front() (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    push_back(T const &value) (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    size() const (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    ~CircularBuffer() (defined in kiwi::tool::CircularBuffer< T >)kiwi::tool::CircularBuffer< T >inline
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_circular_buffer.html b/docs/html/classkiwi_1_1tool_1_1_circular_buffer.html new file mode 100644 index 00000000..fa5b90f8 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_circular_buffer.html @@ -0,0 +1,149 @@ + + + + + + +Kiwi: kiwi::tool::CircularBuffer< T > Class Template Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::CircularBuffer< T > Class Template Referencefinal
    +
    +
    + +

    #include <KiwiTool_CircularBuffer.h>

    + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + CircularBuffer (size_t capacity)
     
    + CircularBuffer (size_t capacity, size_t size, T const &value)
     
    +void assign (size_t nb_elements, const T &value)
     
    +void clear ()
     
    +size_t size () const
     
    +T const & operator[] (size_t index) const noexcept
     
    +T & operator[] (size_t index) noexcept
     
    +void push_back (T const &value)
     
    +void pop_front ()
     
    +

    Detailed Description

    +

    template<class T>
    +class kiwi::tool::CircularBuffer< T >

    + +
    Todo:
    documentation inspired from boost circular buffer
    +
    See also
    http://www.boost.org/doc/libs/1_59_0/doc/html/boost/circular_buffer.html#idp23975984-bb
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_concurrent_queue-members.html b/docs/html/classkiwi_1_1tool_1_1_concurrent_queue-members.html new file mode 100644 index 00000000..b1244f04 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_concurrent_queue-members.html @@ -0,0 +1,113 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::ConcurrentQueue< T > Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::ConcurrentQueue< T >, including all inherited members.

    + + + + + + + +
    ConcurrentQueue(size_t capacity)kiwi::tool::ConcurrentQueue< T >inline
    load_size() const kiwi::tool::ConcurrentQueue< T >inline
    pop(T &value)kiwi::tool::ConcurrentQueue< T >inline
    push(T const &value)kiwi::tool::ConcurrentQueue< T >inline
    push(T &&value)kiwi::tool::ConcurrentQueue< T >inline
    ~ConcurrentQueue()=defaultkiwi::tool::ConcurrentQueue< T >
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_concurrent_queue.html b/docs/html/classkiwi_1_1tool_1_1_concurrent_queue.html new file mode 100644 index 00000000..5ec145ea --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_concurrent_queue.html @@ -0,0 +1,291 @@ + + + + + + +Kiwi: kiwi::tool::ConcurrentQueue< T > Class Template Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::ConcurrentQueue< T > Class Template Referencefinal
    +
    +
    + +

    A mono producer, mono consumer FIFO lock free queue. + More...

    + +

    #include <KiwiTool_ConcurrentQueue.h>

    + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     ConcurrentQueue (size_t capacity)
     Constructor. More...
     
    + ~ConcurrentQueue ()=default
     Destructor.
     
    void push (T const &value)
     Pushes element at end of queue (by copy). More...
     
    void push (T &&value)
     Pushes element at end of queue (by move). More...
     
    bool pop (T &value)
     Pops first element in the queue. More...
     
    size_t load_size () const
     Returns an approximative size for the queue. More...
     
    +

    Detailed Description

    +

    template<class T>
    +class kiwi::tool::ConcurrentQueue< T >

    + +

    A mono producer, mono consumer FIFO lock free queue.

    +

    Wrapper around a thirdparty concurrent queue.

    See also
    https://github.com/cameron314/readerwriterqueue
    +

    Constructor & Destructor Documentation

    + +
    +
    +
    +template<class T>
    + + + + + +
    + + + + + + + + +
    kiwi::tool::ConcurrentQueue< T >::ConcurrentQueue (size_t capacity)
    +     		+inline
    +
    + +

    Constructor.

    +

    Reserves memory space for at least capcity elements.

    + +
    +
    +

    Member Function Documentation

    + +
    +
    +
    +template<class T>
    + + + + + +
    + + + + + + + +
    size_t kiwi::tool::ConcurrentQueue< T >::load_size () const
    +     		+inline
    +
    + +

    Returns an approximative size for the queue.

    +

    Since size is increased and decreased after elements are effectively pushed or poped, for the consumer the returned size is guaranteed to be lower or equal to the effective size of the queue, for the producer the returned size is guaranteed to be greater or equal than the effective size of the queue.

    + +
    +
    + +
    +
    +
    +template<class T>
    + + + + + +
    + + + + + + + + +
    bool kiwi::tool::ConcurrentQueue< T >::pop (T & value)
    +     		+inline
    +
    + +

    Pops first element in the queue.

    +

    Returns false if the queue was empty and pop failed, true otherwise.

    + +
    +
    + +
    +
    +
    +template<class T>
    + + + + + +
    + + + + + + + + +
    void kiwi::tool::ConcurrentQueue< T >::push (T const & value)
    +     		+inline
    +
    + +

    Pushes element at end of queue (by copy).

    +

    If number of elements exceeds capacity allocation will occur. Increments element counter.

    + +
    +
    + +
    +
    +
    +template<class T>
    + + + + + +
    + + + + + + + + +
    void kiwi::tool::ConcurrentQueue< T >::push (T && value)
    +     		+inline
    +
    + +

    Pushes element at end of queue (by move).

    +

    If number of elements exceeds capacity allocation will occur. Increments element counter.

    + +
    +
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_listeners-members.html b/docs/html/classkiwi_1_1tool_1_1_listeners-members.html new file mode 100644 index 00000000..0a07f23a --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_listeners-members.html @@ -0,0 +1,121 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Listeners< ListenerClass > Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Listeners< ListenerClass >, including all inherited members.

    + + + + + + + + + + + + + + + +
    add(listener_ref_t listener) noexceptkiwi::tool::Listeners< ListenerClass >inline
    call(T fun, Args &&...arguments) const kiwi::tool::Listeners< ListenerClass >inline
    clear() noexceptkiwi::tool::Listeners< ListenerClass >inline
    contains(listener_ref_t listener) const noexceptkiwi::tool::Listeners< ListenerClass >inline
    empty() const noexceptkiwi::tool::Listeners< ListenerClass >inline
    getListeners()kiwi::tool::Listeners< ListenerClass >inline
    getListeners() const kiwi::tool::Listeners< ListenerClass >inline
    listener_ptr_t typedef (defined in kiwi::tool::Listeners< ListenerClass >)kiwi::tool::Listeners< ListenerClass >
    listener_ref_t typedef (defined in kiwi::tool::Listeners< ListenerClass >)kiwi::tool::Listeners< ListenerClass >
    listener_t typedef (defined in kiwi::tool::Listeners< ListenerClass >)kiwi::tool::Listeners< ListenerClass >
    Listeners()kiwi::tool::Listeners< ListenerClass >inline
    remove(listener_ref_t listener) noexceptkiwi::tool::Listeners< ListenerClass >inline
    size() const noexceptkiwi::tool::Listeners< ListenerClass >inline
    ~Listeners() noexceptkiwi::tool::Listeners< ListenerClass >inline
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_listeners.html b/docs/html/classkiwi_1_1tool_1_1_listeners.html new file mode 100644 index 00000000..84392846 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_listeners.html @@ -0,0 +1,304 @@ + + + + + + +Kiwi: kiwi::tool::Listeners< ListenerClass > Class Template Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Types | +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Listeners< ListenerClass > Class Template Reference
    +
    +
    + +

    The listener set is a class that manages a list of listeners. + More...

    + +

    #include <KiwiTool_Listeners.h>

    + + + + +

    +Classes

    struct  is_valid_listener
     
    + + + + + + + +

    +Public Types

    +using listener_t = typename std::remove_pointer< typename std::remove_reference< ListenerClass >::type >::type
     
    +using listener_ref_t = listener_t &
     
    +using listener_ptr_t = listener_t *
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Listeners ()
     Creates an empty listener set.
     
    + ~Listeners () noexcept
     Destructor.
     
    bool add (listener_ref_t listener) noexcept
     Add a listener. More...
     
    bool remove (listener_ref_t listener) noexcept
     Remove a listener. More...
     
    +size_t size () const noexcept
     Returns the number of listeners.
     
    +bool empty () const noexcept
     Returns true if there is no listener.
     
    +void clear () noexcept
     Remove all listeners.
     
    +bool contains (listener_ref_t listener) const noexcept
     Returns true if the set contains a given listener.
     
    +std::vector< listener_ptr_t > getListeners ()
     Get the listeners.
     
    +std::vector< listener_ptr_t > getListeners () const
     Retrieve the listeners.
     
    template<class T , class... Args>
    void call (T fun, Args &&...arguments) const
     Calls a given method for each listener of the set. More...
     
    +

    Detailed Description

    +

    template<class ListenerClass>
    +class kiwi::tool::Listeners< ListenerClass >

    + +

    The listener set is a class that manages a list of listeners.

    +

    Manages a list of listeners and allows to retrieve them easily and thread-safely.

    +

    Member Function Documentation

    + +
    +
    +
    +template<class ListenerClass>
    + + + + + +
    + + + + + + + + +
    bool kiwi::tool::Listeners< ListenerClass >::add (listener_ref_t listener)
    +     		+inlinenoexcept
    +
    + +

    Add a listener.

    +

    If the listener was allready present in the set, the function does nothing.

    Parameters
    + + +
    listenerThe new listener to be added.
    +
    +
    +
    Returns
    True if success, otherwise false.
    + +
    +
    + +
    +
    +
    +template<class ListenerClass>
    +
    +template<class T , class... Args>
    + + + + + +
    + + + + + + + + + + + + + + + + + + +
    void kiwi::tool::Listeners< ListenerClass >::call (T fun,
    Args &&... arguments 
    ) const
    +     		+inline
    +
    + +

    Calls a given method for each listener of the set.

    +
    Parameters
    + + + +
    funThe listener's method to call.
    argumentsoptional arguments.
    +
    +
    + +
    +
    + +
    +
    +
    +template<class ListenerClass>
    + + + + + +
    + + + + + + + + +
    bool kiwi::tool::Listeners< ListenerClass >::remove (listener_ref_t listener)
    +     		+inlinenoexcept
    +
    + +

    Remove a listener.

    +

    If the listener wasn't in the set, the function does nothing.

    Parameters
    + + +
    listenerThe listener to be removed.
    +
    +
    +
    Returns
    True if success, false otherwise.
    + +
    +
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_matrix-members.html b/docs/html/classkiwi_1_1tool_1_1_matrix-members.html new file mode 100644 index 00000000..39792da2 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_matrix-members.html @@ -0,0 +1,117 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Matrix< Type > Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Matrix< Type >, including all inherited members.

    + + + + + + + + + + + +
    at(size_t row, size_t colunm)kiwi::tool::Matrix< Type >
    at(size_t row, size_t column) const kiwi::tool::Matrix< Type >
    getNumCols() const kiwi::tool::Matrix< Type >
    getNumRows() const kiwi::tool::Matrix< Type >
    Matrix(size_t num_rows, size_t num_cols)kiwi::tool::Matrix< Type >
    Matrix(Matrix const &other)kiwi::tool::Matrix< Type >
    Matrix(Matrix &&other)kiwi::tool::Matrix< Type >
    operator=(Matrix const &other)kiwi::tool::Matrix< Type >
    operator=(Matrix &&other)kiwi::tool::Matrix< Type >
    ~Matrix()kiwi::tool::Matrix< Type >
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_matrix.html b/docs/html/classkiwi_1_1tool_1_1_matrix.html new file mode 100644 index 00000000..7859a105 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_matrix.html @@ -0,0 +1,298 @@ + + + + + + +Kiwi: kiwi::tool::Matrix< Type > Class Template Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Matrix< Type > Class Template Referencefinal
    +
    +
    + +

    A matrix data structure. + More...

    + +

    #include <KiwiTool_Matrix.h>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     Matrix (size_t num_rows, size_t num_cols)
     Constructor. More...
     
    + ~Matrix ()
     Destructor.
     
    + Matrix (Matrix const &other)
     Copy constructor.
     
    + Matrix (Matrix &&other)
     Move constructor.
     
    Matrix & operator= (Matrix const &other)
     Assignment operator. More...
     
    Matrix & operator= (Matrix &&other)
     Move assignement operator. More...
     
    +size_t getNumRows () const
     Returns the number of rows.
     
    +size_t getNumCols () const
     Returns the number of colunms.
     
    Type & at (size_t row, size_t colunm)
     Gets a value stored in matrix. More...
     
    Type const & at (size_t row, size_t column) const
     Gets a value stored in matrix. More...
     
    +

    Detailed Description

    +

    template<class Type>
    +class kiwi::tool::Matrix< Type >

    + +

    A matrix data structure.

    +

    Implementation of basic matrix operation.

    Todo:
    Adds more usefull operation.
    +

    Constructor & Destructor Documentation

    + +
    +
    +
    +template<class Type >
    + + + + + + + + + + + + + + + + + + +
    kiwi::tool::Matrix< Type >::Matrix (size_t num_rows,
    size_t num_cols 
    )
    +
    + +

    Constructor.

    +

    Initializes matrix with default constructor.

    + +
    +
    +

    Member Function Documentation

    + +
    +
    +
    +template<class Type >
    + + + + + + + + + + + + + + + + + + +
    Type & kiwi::tool::Matrix< Type >::at (size_t row,
    size_t colunm 
    )
    +
    + +

    Gets a value stored in matrix.

    +

    row (res column) must be inferior to number of rows (res num columns).

    + +
    +
    + +
    +
    +
    +template<class Type >
    + + + + + + + + + + + + + + + + + + +
    Type const & kiwi::tool::Matrix< Type >::at (size_t row,
    size_t column 
    ) const
    +
    + +

    Gets a value stored in matrix.

    +

    row (res column) must be inferior to number of rows (res num columns).

    + +
    +
    + +
    +
    +
    +template<class Type >
    + + + + + + + + +
    Matrix< Type > & kiwi::tool::Matrix< Type >::operator= (Matrix< Type > const & other)
    +
    + +

    Assignment operator.

    +

    Number of rows and columns must match.

    + +
    +
    + +
    +
    +
    +template<class Type >
    + + + + + + + + +
    Matrix< Type > & kiwi::tool::Matrix< Type >::operator= (Matrix< Type > && other)
    +
    + +

    Move assignement operator.

    +

    Number of rows and columns must match.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_parameter-members.html b/docs/html/classkiwi_1_1tool_1_1_parameter-members.html new file mode 100644 index 00000000..2430e2d7 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_parameter-members.html @@ -0,0 +1,115 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Parameter Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Parameter, including all inherited members.

    + + + + + + + + + +
    getType() const kiwi::tool::Parameter
    operator=(Parameter const &other)kiwi::tool::Parameter
    operator[](size_t index) const kiwi::tool::Parameter
    Parameter(Type type)kiwi::tool::Parameter
    Parameter(Type type, std::vector< Atom > const atoms)kiwi::tool::Parameter
    Parameter(Parameter const &other)kiwi::tool::Parameter
    Type enum namekiwi::tool::Parameter
    ~Parameter()kiwi::tool::Parameter
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_parameter.html b/docs/html/classkiwi_1_1tool_1_1_parameter.html new file mode 100644 index 00000000..37e5e71b --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_parameter.html @@ -0,0 +1,208 @@ + + + + + + +Kiwi: kiwi::tool::Parameter Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Types | +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Parameter Class Reference
    +
    +
    + +

    Parameter is a class designed to represent any type of data. + More...

    + +

    #include <KiwiTool_Parameter.h>

    + + + + + +

    +Public Types

    enum  Type { Int, +Float, +String + }
     The different types of data represented.
     
    + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     Parameter (Type type)
     Default Constructor. More...
     
     Parameter (Type type, std::vector< Atom > const atoms)
     Constructor. More...
     
    + Parameter (Parameter const &other)
     Copy constructor.
     
    +Parameter & operator= (Parameter const &other)
     Assignment operator.
     
    + ~Parameter ()
     Desctructor.
     
    +Type getType () const
     Returns the type of the parameter.
     
    +Atom const & operator[] (size_t index) const
     Returns the underlying data of the parameter.
     
    +

    Detailed Description

    +

    Parameter is a class designed to represent any type of data.

    +

    It's implemented as a vector of Atom.

    Todo:
    Use virtual classes that implements check of atoms, copy and default initialization instead of using switches. See in juce::variant.
    +

    Constructor & Destructor Documentation

    + +
    +
    + + + + + + + + +
    kiwi::tool::Parameter::Parameter (Type type)
    +
    + +

    Default Constructor.

    +

    Initialises data according to type.

    + +
    +
    + +
    +
    + + + + + + + + + + + + + + + + + + +
    kiwi::tool::Parameter::Parameter (Type type,
    std::vector< Atom > const atoms 
    )
    +
    + +

    Constructor.

    +

    Atoms must be well formated for the construction to succeed.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler-members.html b/docs/html/classkiwi_1_1tool_1_1_scheduler-members.html new file mode 100644 index 00000000..aee00d0c --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler-members.html @@ -0,0 +1,123 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Scheduler< Clock > Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Scheduler< Clock >, including all inherited members.

    + + + + + + + + + + + + + + + + + +
    clock_t typedef (defined in kiwi::tool::Scheduler< Clock >)kiwi::tool::Scheduler< Clock >
    defer(std::shared_ptr< Task > const &task)kiwi::tool::Scheduler< Clock >
    defer(std::shared_ptr< Task > &&task)kiwi::tool::Scheduler< Clock >
    defer(std::function< void(void)> &&func)kiwi::tool::Scheduler< Clock >
    duration_t typedef (defined in kiwi::tool::Scheduler< Clock >)kiwi::tool::Scheduler< Clock >
    isThisConsumerThread() const kiwi::tool::Scheduler< Clock >
    lock() const kiwi::tool::Scheduler< Clock >
    process()kiwi::tool::Scheduler< Clock >
    schedule(std::shared_ptr< Task > const &task, duration_t delay=std::chrono::milliseconds(0))kiwi::tool::Scheduler< Clock >
    schedule(std::shared_ptr< Task > &&task, duration_t delay=std::chrono::milliseconds(0))kiwi::tool::Scheduler< Clock >
    schedule(std::function< void(void)> &&func, duration_t delay=std::chrono::milliseconds(0))kiwi::tool::Scheduler< Clock >
    Scheduler()kiwi::tool::Scheduler< Clock >
    setThreadAsConsumer()kiwi::tool::Scheduler< Clock >
    time_point_t typedef (defined in kiwi::tool::Scheduler< Clock >)kiwi::tool::Scheduler< Clock >
    unschedule(std::shared_ptr< Task > const &task)kiwi::tool::Scheduler< Clock >
    ~Scheduler()kiwi::tool::Scheduler< Clock >
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler.html b/docs/html/classkiwi_1_1tool_1_1_scheduler.html new file mode 100644 index 00000000..445289e6 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler.html @@ -0,0 +1,439 @@ + + + + + + +Kiwi: kiwi::tool::Scheduler< Clock > Class Template Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Types | +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Scheduler< Clock > Class Template Referencefinal
    +
    +
    + +

    A class designed to delay tasks' execution between threads that where previously declared. + More...

    + +

    #include <KiwiTool_Scheduler.h>

    + + + + + + + + + + + + + + + + + +

    +Classes

    class  CallBack
     The scheduler's callback is a task that uses an std::function for conveniency. More...
     
    class  Event
     An event that associates a task and a execution time. More...
     
    class  Queue
     A class that holds a list of scheduled events. More...
     
    class  Task
     The abstract class that the scheduler executes. Caller must override execute function to specify the callback behavior. More...
     
    class  Timer
     An abstract class designed to repetedly call a method at a specified intervall of time. Overriding timerCallBack and calling startTimer will start repetdly calling method. More...
     
    + + + + + + + +

    +Public Types

    +using clock_t = Clock
     
    +using time_point_t = typename Clock::time_point
     
    +using duration_t = typename Clock::duration
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

     Scheduler ()
     Constructor. More...
     
    + ~Scheduler ()
     Desctructor.
     
    void setThreadAsConsumer ()
     Sets the current thread as the consumer thread. More...
     
    bool isThisConsumerThread () const
     Check wehter or not this thread is the consumer. More...
     
    void schedule (std::shared_ptr< Task > const &task, duration_t delay=std::chrono::milliseconds(0))
     Delays execution of a task. Shared ownership. More...
     
    void schedule (std::shared_ptr< Task > &&task, duration_t delay=std::chrono::milliseconds(0))
     Delays execution of a task. Transfer ownership. More...
     
    void schedule (std::function< void(void)> &&func, duration_t delay=std::chrono::milliseconds(0))
     Delays execution of a function by the scheduler. More...
     
    void defer (std::shared_ptr< Task > const &task)
     Conditionally schedule a task in the consumer thread. More...
     
    void defer (std::shared_ptr< Task > &&task)
     Conditionally schedule a task in the consumer thread. More...
     
    void defer (std::function< void(void)> &&func)
     Conditionally schedule a function in the consumer thread. More...
     
    void unschedule (std::shared_ptr< Task > const &task)
     Used to cancel the execution of a previously scheduled task. More...
     
    +void process ()
     Processes events of the consumer that have reached exeuction time.
     
    +std::unique_lock< std::mutex > lock () const
     Lock the process until the returned lock is out of scope.
     
    +

    Detailed Description

    +

    template<class Clock = std::chrono::high_resolution_clock>
    +class kiwi::tool::Scheduler< Clock >

    + +

    A class designed to delay tasks' execution between threads that where previously declared.

    +

    The scheduler is designed as a singleton that uses multiple event lists. Before processing the scheduler one should create an instance and register all threads that will use the scheduler. One can override the clock used by the scheduler to get time.

    +

    Constructor & Destructor Documentation

    + +
    +
    +
    +template<class Clock >
    + + + + + + + +
    kiwi::tool::Scheduler< Clock >::Scheduler ()
    +
    + +

    Constructor.

    +

    Sets current thread as the consumer thread.

    + +
    +
    +

    Member Function Documentation

    + +
    +
    +
    +template<class Clock >
    + + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::defer (std::shared_ptr< Task > const & task)
    +
    + +

    Conditionally schedule a task in the consumer thread.

    +

    The task is scheduled only if the calling thread is not the consumer thread. Otherwise it is executed right away.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::defer (std::shared_ptr< Task > && task)
    +
    + +

    Conditionally schedule a task in the consumer thread.

    +

    The task is scheduled only if the calling thread is not the consumer thread. Otherwise it is executed right away. Task is destroyed when executed.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::defer (std::function< void(void)> && func)
    +
    + +

    Conditionally schedule a function in the consumer thread.

    +

    The function is scheduled only if the calling thread is not the consumer thread. Otherwise it is executed right away.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + +
    bool kiwi::tool::Scheduler< Clock >::isThisConsumerThread () const
    +
    + +

    Check wehter or not this thread is the consumer.

    +

    This method can be usefull to help decide if a direct call can be made or if the scheduler shall be used.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + + + + + + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::schedule (std::shared_ptr< Task > const & task,
    duration_t delay = std::chrono::milliseconds(0) 
    )
    +
    + +

    Delays execution of a task. Shared ownership.

    +

    Calling twice this method with same task will cancel the previous scheduled execution and add a new one at specified time.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + + + + + + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::schedule (std::shared_ptr< Task > && task,
    duration_t delay = std::chrono::milliseconds(0) 
    )
    +
    + +

    Delays execution of a task. Transfer ownership.

    +

    Calling twice this method with same task will cancel the previous scheduled execution and add a new one at specified time.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + + + + + + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::schedule (std::function< void(void)> && func,
    duration_t delay = std::chrono::milliseconds(0) 
    )
    +
    + +

    Delays execution of a function by the scheduler.

    +

    Internally create a callback that will be executed and destroyed by the scheduler.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::setThreadAsConsumer ()
    +
    + +

    Sets the current thread as the consumer thread.

    +

    This method can be called for instance if the scheduler's constructor is called on another thread than desired consumer.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::unschedule (std::shared_ptr< Task > const & task)
    +
    + +

    Used to cancel the execution of a previously scheduled task.

    +

    If the task is currently being processed by the scheduler, this method does't wait for the execution to finish but only guarantee that further execution will no occur.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back-members.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back-members.html new file mode 100644 index 00000000..902c52ff --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back-members.html @@ -0,0 +1,112 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Scheduler< Clock >::CallBack Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Scheduler< Clock >::CallBack, including all inherited members.

    + + + + + + +
    CallBack(std::function< void(void)> func)kiwi::tool::Scheduler< Clock >::CallBack
    execute() override finalkiwi::tool::Scheduler< Clock >::CallBackvirtual
    Task()kiwi::tool::Scheduler< Clock >::Task
    ~CallBack()kiwi::tool::Scheduler< Clock >::CallBack
    ~Task()kiwi::tool::Scheduler< Clock >::Taskvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back.html new file mode 100644 index 00000000..0b78ba9f --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back.html @@ -0,0 +1,153 @@ + + + + + + +Kiwi: kiwi::tool::Scheduler< Clock >::CallBack Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Scheduler< Clock >::CallBack Class Reference
    +
    +
    + +

    The scheduler's callback is a task that uses an std::function for conveniency. + More...

    + +

    #include <KiwiTool_Scheduler.h>

    +
    +Inheritance diagram for kiwi::tool::Scheduler< Clock >::CallBack:
    +
    +
    + + +kiwi::tool::Scheduler< Clock >::Task + +
    + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + CallBack (std::function< void(void)> func)
     Constructor, initializes function.
     
    + ~CallBack ()
     Destructor.
     
    +void execute () override final
     Executes the given functions.
     
    - Public Member Functions inherited from kiwi::tool::Scheduler< Clock >::Task
     Task ()
     Constructor. More...
     
    virtual ~Task ()
     Destructor. More...
     
    +

    Detailed Description

    +

    template<class Clock = std::chrono::high_resolution_clock>
    +class kiwi::tool::Scheduler< Clock >::CallBack

    + +

    The scheduler's callback is a task that uses an std::function for conveniency.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back.png b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_call_back.png new file mode 100644 index 0000000000000000000000000000000000000000..5e62e20783f8cf00be31ad0841858b67817d352d GIT binary patch literal 841 zcmeAS@N?(olHy`uVBq!ia0vp^uYov#gBeJkzgZLrq$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0Zg{#lhEy=VoqMt9s}_gb^ps`q|DRZH zeUYOh(<=Q}`~unixk;jt9Z#k`w&-&`qNuc~#cXwlhh1)%;KUlP$nIZPmGds}PIaRXEyJAZGxzvq)GY1nu>-{L!+hlDn-a(T7xY)rxHR|hP#(@d9K?tP>3|IxJ__5XQS7p|3kKlK}P zw!UM3oqt6050hrCXcw35$7Sr~-*tauUahTl?&6D>->br(uR3gXZ29sl`o$FhdXbb63Zc%SmgF7s_OFJh=awJ3&zQ$gi(k`QA9KxxeD{ zfptfAy*6-g%MEL&xwVD?sD}}#h3U!VG}aT#&vH%hpDn5|-%Q&97``Y9{;c%UOce}d zn05iC(ERn)%n!dSJKW?gR!1Aione`=a#rOH4ujkqKQ6yXc+ix{DuERA>9Xc|r|0vz zZJf9E=yvt*l53<4#sB{cIR16bdGD_aN=xrprkwfN>l8CNLizQPwxqW$-zVp7+r9U_ zUtE6KwD@GPy9c)%Pqq^Et#7JIK5Vu5V&v5`7ats0#dLeGZ2HkPZ6&)V&J|g|!EW_$ zshdCUuQBudGEW&8{9=z}v!`%wb?deKb7s}~Kl?K5H|$#UXuW&Ey4tI&i?1fmU9;fA z?Zv$d&31-VpO>1SQqaG+p_;vk;pd)S?h})FKcBrg_2ixA4O_nET>N_T%E7R%8d)}< z;QQAvJg7+ga;#i(YjZPi{C~zxS;!&Sy>VL5DXCxlleZhj%b6YkWdR0HS3j3^P6 + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Scheduler< Clock >::Event Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Scheduler< Clock >::Event, including all inherited members.

    + + + + + + + +
    Event(std::shared_ptr< Task > &&task, time_point_t time)kiwi::tool::Scheduler< Clock >::Event
    Event(Event &&other)kiwi::tool::Scheduler< Clock >::Event
    execute()kiwi::tool::Scheduler< Clock >::Event
    operator=(Event &&other)kiwi::tool::Scheduler< Clock >::Event
    Scheduler (defined in kiwi::tool::Scheduler< Clock >::Event)kiwi::tool::Scheduler< Clock >::Eventfriend
    ~Event()kiwi::tool::Scheduler< Clock >::Event
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_event.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_event.html new file mode 100644 index 00000000..4cef20b6 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_event.html @@ -0,0 +1,152 @@ + + + + + + +Kiwi: kiwi::tool::Scheduler< Clock >::Event Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Friends | +List of all members
    +
    +
    kiwi::tool::Scheduler< Clock >::Event Class Referencefinal
    +
    +
    + +

    An event that associates a task and a execution time. + More...

    + +

    #include <KiwiTool_Scheduler.h>

    + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Event (std::shared_ptr< Task > &&task, time_point_t time)
     Constructor.
     
    + Event (Event &&other)
     Moove constructor.
     
    +Event & operator= (Event &&other)
     Moove assignment operator.
     
    + ~Event ()
     Destructor.
     
    +void execute ()
     Called by the scheduler to execute a the task.
     
    + + + +

    +Friends

    +class Scheduler
     
    +

    Detailed Description

    +

    template<class Clock = std::chrono::high_resolution_clock>
    +class kiwi::tool::Scheduler< Clock >::Event

    + +

    An event that associates a task and a execution time.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_queue-members.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_queue-members.html new file mode 100644 index 00000000..c1dae3f3 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_queue-members.html @@ -0,0 +1,114 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Scheduler< Clock >::Queue Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Scheduler< Clock >::Queue, including all inherited members.

    + + + + + + + + +
    process(time_point_t process_time)kiwi::tool::Scheduler< Clock >::Queue
    Queue()kiwi::tool::Scheduler< Clock >::Queue
    schedule(std::shared_ptr< Task > const &task, duration_t delay)kiwi::tool::Scheduler< Clock >::Queue
    schedule(std::shared_ptr< Task > &&task, duration_t delay)kiwi::tool::Scheduler< Clock >::Queue
    Scheduler (defined in kiwi::tool::Scheduler< Clock >::Queue)kiwi::tool::Scheduler< Clock >::Queuefriend
    unschedule(std::shared_ptr< Task > const &task)kiwi::tool::Scheduler< Clock >::Queue
    ~Queue()kiwi::tool::Scheduler< Clock >::Queue
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_queue.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_queue.html new file mode 100644 index 00000000..39cb59d6 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_queue.html @@ -0,0 +1,163 @@ + + + + + + +Kiwi: kiwi::tool::Scheduler< Clock >::Queue Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +Friends | +List of all members
    +
    +
    kiwi::tool::Scheduler< Clock >::Queue Class Referencefinal
    +
    +
    + +

    A class that holds a list of scheduled events. + More...

    + +

    #include <KiwiTool_Scheduler.h>

    + + + + +

    +Classes

    struct  Command
     
    + + + + + + + + + + + + + + + + + + + +

    +Public Member Functions

    + Queue ()
     Constructor.
     
    + ~Queue ()
     Destructor.
     
    +void schedule (std::shared_ptr< Task > const &task, duration_t delay)
     Delays the execution of a task. Shared ownership.
     
    +void schedule (std::shared_ptr< Task > &&task, duration_t delay)
     Delays the execution of a task. Transfer ownership.
     
    +void unschedule (std::shared_ptr< Task > const &task)
     Cancels the execution of a task.
     
    +void process (time_point_t process_time)
     Processes all events that have reached execution time.
     
    + + + +

    +Friends

    +class Scheduler
     
    +

    Detailed Description

    +

    template<class Clock = std::chrono::high_resolution_clock>
    +class kiwi::tool::Scheduler< Clock >::Queue

    + +

    A class that holds a list of scheduled events.

    +

    Implementation countains a list of events sorted by execution time that is updated before processing using commands. A queue is created for each consumer.

    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task-members.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task-members.html new file mode 100644 index 00000000..a1ca1fd6 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Scheduler< Clock >::Task Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Scheduler< Clock >::Task, including all inherited members.

    + + + + +
    Scheduler (defined in kiwi::tool::Scheduler< Clock >::Task)kiwi::tool::Scheduler< Clock >::Taskfriend
    Task()kiwi::tool::Scheduler< Clock >::Task
    ~Task()kiwi::tool::Scheduler< Clock >::Taskvirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task.html new file mode 100644 index 00000000..4cea698c --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task.html @@ -0,0 +1,200 @@ + + + + + + +Kiwi: kiwi::tool::Scheduler< Clock >::Task Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +Friends | +List of all members
    +
    +
    kiwi::tool::Scheduler< Clock >::Task Class Referenceabstract
    +
    +
    + +

    The abstract class that the scheduler executes. Caller must override execute function to specify the callback behavior. + More...

    + +

    #include <KiwiTool_Scheduler.h>

    +
    +Inheritance diagram for kiwi::tool::Scheduler< Clock >::Task:
    +
    +
    + + +kiwi::engine::LineTilde::BangTask +kiwi::tool::Scheduler< Clock >::CallBack +kiwi::tool::Scheduler< Clock >::Timer::Task + +
    + + + + + + + + +

    +Public Member Functions

     Task ()
     Constructor. More...
     
    virtual ~Task ()
     Destructor. More...
     
    + + + +

    +Friends

    +class Scheduler
     
    +

    Detailed Description

    +

    template<class Clock = std::chrono::high_resolution_clock>
    +class kiwi::tool::Scheduler< Clock >::Task

    + +

    The abstract class that the scheduler executes. Caller must override execute function to specify the callback behavior.

    +

    Constructor & Destructor Documentation

    + +
    +
    +
    +template<class Clock >
    + + + + + + + +
    kiwi::tool::Scheduler< Clock >::Task::Task ()
    +
    + +

    Constructor.

    +

    A certain task is designed to be scheduled on only one consumer.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + +
    + + + + + + + +
    kiwi::tool::Scheduler< Clock >::Task::~Task ()
    +     		+virtual
    +
    + +

    Destructor.

    +

    It is not safe to destroy a task from another thread than the consumer because it can be concurrent to its execution. One can create a task that deletes itself at exeuction time or lock a consumer using Scheduler::Lock before deleting the task.

    + +

    Reimplemented in kiwi::tool::Scheduler< Clock >::Timer::Task.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task.png b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_task.png new file mode 100644 index 0000000000000000000000000000000000000000..c5ab0e4c2bedae0ea4ca65c8ef2213c681377f2e GIT binary patch literal 1574 zcmbVLdo+}382`rPk}kT)sx4zXqf(|3Z5g-0)@E`|5{Vh*nl#c(OtWUFwvuBf*Xd$t zB`fWk2!qrNl9)9lOia?2*`Xo%B!k z)MNN~9t2R*ymhzwS^Q#OX2qh+COsJ0EF_pzJIjtd4BpGXOv-RN z+V2Vof%<@)uoS%{jGnvq5(}~u!-93xOg zm1=qq%WpO9>5H~dQ&We5?$qQlUBD7Zu1Uw;4jCC#OWi+3fcgFQ*+}@7Bz>vD3c(FX zsIpI{t z3D-BKMD8^1&q*4p3xXTEC$y$#)GcCu{^5rF)`4Ejh|9f+S{=tUm;&n@GE0Q8H*%{& zN;1Xq2DxqU+rf5~;?#A<@cIdzp#@Gl`3&*phcamH;gjhtcAi#zzKqtqQ|@u-eoZ>s zF4iWl?cBECg4e5<_muLna>&BrhkkBY20L5Z{lVj6KO2A$ZIALl2A zDVzCwV*g0CaM$Kv#%qdKRKR|?P7e`3e(y|K^2Hl91@mL)Tu~GzO7%nD0Myn9SN`9eh!muD&7bNx~ ztQ7pDah=0ewMYt21v%dThO$A{lhJ9N|E8_es~~2^LtBaOTO9hWS=53ODNQezLUWAO zJy{iNrwd=l??FhUmD_L67jKw8$r)&N#rRvRRdny9)kiA>vePRsdYsSaSznhwfeK>S%v3QpbL@I z?~cAV{Ka?1$D_>MO&`3@BDEDfI(Pfjo>3P=uzhx@6(N~F zva=cQ{j`r{<((;SQnKz}E5R#mVx{bR_c_eR*5SgmW_sN6zAUO?bm6*Vuyj zbUSeOGM*xK3-ZErZZpOD4S~yi6n3DZm$X?C_&XbOP8HVb!FhLg94UpwtJq#}7pwa; zmA4sGebvEy?CWCS1>4ri6mZKx>glue+>o=|6DTEX(YKs6b#iR7!rd7u^y7Jo?F*cj z5canR;jkLA`Iq_@D)oxBg9+-)1-VqVaNCeKENjW%V7wdTPhB!v!^3+ROUbEUl7Txn zcJ)T_s$g?(!bn?v2Vcz3&V%v|*;M#r3%TR{4QSZCm^Y=qN!p%u!brY`PrayAY)x!- zjcI&rdFy%E1tEL1&wvSKbXlfz4M(GAqP89~X$9>i+ls8B1*CBKSyAITUJjPpOI)%q zk)cG2Uqx#sWU2eH4kpiu6kZKE&TQBN3Vo1{iWVF3RsfQ1Pn!*IfEbpjf$#`Yg?9cgU{4H$ literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer-members.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer-members.html new file mode 100644 index 00000000..d5735867 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer-members.html @@ -0,0 +1,111 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Scheduler< Clock >::Timer Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Scheduler< Clock >::Timer, including all inherited members.

    + + + + + +
    startTimer(duration_t period)kiwi::tool::Scheduler< Clock >::Timer
    stopTimer()kiwi::tool::Scheduler< Clock >::Timer
    Timer(Scheduler &scheduler)kiwi::tool::Scheduler< Clock >::Timer
    ~Timer()kiwi::tool::Scheduler< Clock >::Timer
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer.html new file mode 100644 index 00000000..04340c10 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer.html @@ -0,0 +1,238 @@ + + + + + + +Kiwi: kiwi::tool::Scheduler< Clock >::Timer Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Classes | +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Scheduler< Clock >::Timer Class Referenceabstract
    +
    +
    + +

    An abstract class designed to repetedly call a method at a specified intervall of time. Overriding timerCallBack and calling startTimer will start repetdly calling method. + More...

    + +

    #include <KiwiTool_Scheduler.h>

    +
    +Inheritance diagram for kiwi::tool::Scheduler< Clock >::Timer:
    +
    +
    + + +kiwi::engine::DelaySimpleTilde +kiwi::engine::MeterTilde +kiwi::engine::NumberTilde + +
    + + + + +

    +Classes

    class  Task
     
    + + + + + + + + + + + + + +

    +Public Member Functions

     Timer (Scheduler &scheduler)
     Constructor. More...
     
     ~Timer ()
     Destructor. More...
     
    void startTimer (duration_t period)
     Starts the timer. More...
     
    void stopTimer ()
     Stops the timer. More...
     
    +

    Detailed Description

    +

    template<class Clock = std::chrono::high_resolution_clock>
    +class kiwi::tool::Scheduler< Clock >::Timer

    + +

    An abstract class designed to repetedly call a method at a specified intervall of time. Overriding timerCallBack and calling startTimer will start repetdly calling method.

    +

    Constructor & Destructor Documentation

    + +
    +
    +
    +template<class Clock >
    + + + + + + + + +
    kiwi::tool::Scheduler< Clock >::Timer::Timer (Scheduler & scheduler)
    +
    + +

    Constructor.

    +

    A timer can only be created for a certain consumer.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + +
    kiwi::tool::Scheduler< Clock >::Timer::~Timer ()
    +
    + +

    Destructor.

    +

    It is not safe to destroy a timer in another thread than the consumer. If intended one shall lock the consumer before destroying the timer.

    + +
    +
    +

    Member Function Documentation

    + +
    +
    +
    +template<class Clock >
    + + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::Timer::startTimer (duration_t period)
    +
    + +

    Starts the timer.

    +

    Will cause timerCallBack to be called at a specified rate by the right consumer.

    + +
    +
    + +
    +
    +
    +template<class Clock >
    + + + + + + + +
    void kiwi::tool::Scheduler< Clock >::Timer::stopTimer ()
    +
    + +

    Stops the timer.

    +

    If called when timerCallBack is being processed, stopTimer will not wait for the execution to finish but will only guarantee that further execution will not occur.

    + +
    +
    +
    The documentation for this class was generated from the following files: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer.png b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer.png new file mode 100644 index 0000000000000000000000000000000000000000..38113598de288164bc4ed59ec298ac168b1f686d GIT binary patch literal 1483 zcmZuxdpOf;9RJPz?l}pgB*(OtTL)oTh1AR#&&-`%I)zSdLs2eEryMCXBKkR`;WSZh z%ca>OWUIyFR+~!>!;*4MPT2YBzjJw?=Y7AI=lgxWm(S;UGu#MRWd&^o005M6jt)cs zkN_dwO->SeukQ7Tfdt&mnRG%d7DMXn$JO}k_8dt2e%WlcbjFA-WXi=63GM(Cw0#CS zBr^bz_Qg5akrH6@#qTau9o{LGIc>5f&W&oPUD1OZX1x#@9SHJ~YxFqJl)!*Bb1g`T zAV7QiepMJ6=G#q{fKxs^0RfrP!$wF7><<;Ld=NlCeX3Km(^Pbc=`+*Yo4i>p|HG=3 zb;zFSDLY&1w${|~7|RNwR9LYCfuh{ayQvu}aVj@fYnl#vjnsocwc6C~?DDj0Ef$`Q z&Gu*2P5fWY$2|V5S|7s=k9_kAcb%&nN5TxFO_S@M8zXJ!9+71XhO53hx>iL#r;FVA zhAd=rc;m4mr>#;)aT7i#Hc5|h)sH}#_R%os`(4Fjc@9sp<#B>v0(lOvJ7mj?msBs; z->Pca?#N2$?C(o|*VGv)1o;Kjzv!UfeH%F}e1t54NjvYSYdUmmNfxbtqK?z-g;k5H z@!-9!Einwm+}%ztB{I-$`)5+Boe3hg9b=$D@`065yJcm8p|Y@_dbprRtNBpWx4AaV zT92S$=v}4AecbVB(j832Z6z0G)&1h-kShOy6NPr zu>n&0f7}7X@vc&A08Y`>0+b*G2&Og1h66T4{to)G7t`RjLLAA|^RdIVCnS z8d}RPFR1$<;OG@Yq^+O{Dg{U`$V0*Wt~<~`aEj}Dj(o2rlqJIkk|ewc6vld3d)w!4 zu0O3LkEi~|!o6Kf7NfSV{K`Ze$xaXwattCh)+*q#e55urNOzX;7FSi?r6E;oy6sM{^F`NHE)sJ zUN*t=tRnGrg?Y56@bru>zS6ym)_3h0?^&oy1haF)@}#LS<-=SI0yS9yQdczG>3DKm z;j%w((VNbXYi!%$&b8;*o*WDZ)me2|?=novPO)TxTvc@zT1mcLi2z2JpSyQ_O z9jt^E%|9K9T{>v4QCLH?O{S;G%tKJ``K87^lPC*XkQypIX(xL3&Hi1(FRc3Gn3F->Cwk_iLVoFW?axLF`>>maE5%+%Gj$lqhGI} z_5!gh`*z-Lp)kpK**D*QsJVNhthnh!IhyhO(ME zXJhonTnMtWdyJdB1jqF(jxn}Uro-MiFPC`k#Ieb$29 zj2>oAj1{<3O_sM11|mz=y@l)!_1xvb&DnNUHzxSh98c6rF%6cU;CS#f*B&U!3xh?N1oMogg^W*axNk4F?6oN&o-= literal 0 HcmV?d00001 diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task-members.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task-members.html new file mode 100644 index 00000000..1d37c88f --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task-members.html @@ -0,0 +1,111 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    kiwi::tool::Scheduler< Clock >::Timer::Task Member List
    +
    +
    + +

    This is the complete list of members for kiwi::tool::Scheduler< Clock >::Timer::Task, including all inherited members.

    + + + + + +
    execute() overridekiwi::tool::Scheduler< Clock >::Timer::Taskinlinevirtual
    Task(Timer &timer) (defined in kiwi::tool::Scheduler< Clock >::Timer::Task)kiwi::tool::Scheduler< Clock >::Timer::Taskinline
    kiwi::tool::Scheduler::Task::Task()kiwi::tool::Scheduler< Clock >::Task
    ~Task()kiwi::tool::Scheduler< Clock >::Timer::Taskinlinevirtual
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task.html b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task.html new file mode 100644 index 00000000..eb924b17 --- /dev/null +++ b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task.html @@ -0,0 +1,168 @@ + + + + + + +Kiwi: kiwi::tool::Scheduler< Clock >::Timer::Task Class Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +Public Member Functions | +List of all members
    +
    +
    kiwi::tool::Scheduler< Clock >::Timer::Task Class Referencefinal
    +
    +
    +
    +Inheritance diagram for kiwi::tool::Scheduler< Clock >::Timer::Task:
    +
    +
    + + +kiwi::tool::Scheduler< Clock >::Task + +
    + + + + + + + + + + + + + + +

    +Public Member Functions

    + Task (Timer &timer)
     
     ~Task ()
     Destructor. More...
     
    +void execute () override
     The pure virtual execution method. Called by the scheduler when execution time is reached.
     
    - Public Member Functions inherited from kiwi::tool::Scheduler< Clock >::Task
     Task ()
     Constructor. More...
     
    +

    Constructor & Destructor Documentation

    + +
    +
    +
    +template<class Clock = std::chrono::high_resolution_clock>
    + + + + + +
    + + + + + + + +
    kiwi::tool::Scheduler< Clock >::Timer::Task::~Task ()
    +     		+inlinevirtual
    +
    + +

    Destructor.

    +

    It is not safe to destroy a task from another thread than the consumer because it can be concurrent to its execution. One can create a task that deletes itself at exeuction time or lock a consumer using Scheduler::Lock before deleting the task.

    + +

    Reimplemented from kiwi::tool::Scheduler< Clock >::Task.

    + +
    +
    +
    The documentation for this class was generated from the following file: +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task.png b/docs/html/classkiwi_1_1tool_1_1_scheduler_1_1_timer_1_1_task.png new file mode 100644 index 0000000000000000000000000000000000000000..b77638de1ff1c357407257b31485be8ed1be49a7 GIT binary patch literal 874 zcmeAS@N?(olHy`uVBq!ia0vp^KY%!ZgBeINJ9z8@QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;Ln;{G&V5+4PK(EN`t6zf{wv=P zbDYGG<^O!1@#PDN^-8=GM4kSe-uJ%RZKHRPoo<2WsU@s>o-<3B_sxvA7GgVm;M-4g zDftMmOFpSHXZNaX{g(R9tnSVO!I()_Xa8DSl^47}@Y*QRl!UB*-XBnX`8})AJ4g*4Hd7>P?tiyk$nbBb9fOgU_K)N4L7&zS*wZdcZJq%K=8C%tq#vOHAx1may_o@I+HkAANgUuH;d+3H~sN z*ay!KyFGkWzA%&7y;7!!UxzVG>-3!*mMz~_>4hsVFn!(6%>KgU`|}rf4(?@Me|isV zeb-~_dZ`~5vz|oT^lzAYqjhrTT%)|T`{KBKYo~mCFfm#$&&2x6>E~I-5qnZTKJAUY z&|rRNb^7f37>%=!Kc9_0YMFOQH1cuAof9qBW|@3YzLEGbBc(QPc38pW{IqvR6wkig+tUL6GcNjT!uLmv-36F27(8A5T-G@yGywn%+^I$Y literal 0 HcmV?d00001 diff --git a/docs/html/dir_2d5e7e2f87b278ed04b40f15c3112bb4.html b/docs/html/dir_2d5e7e2f87b278ed04b40f15c3112bb4.html new file mode 100644 index 00000000..6ae060a3 --- /dev/null +++ b/docs/html/dir_2d5e7e2f87b278ed04b40f15c3112bb4.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Objects Directory Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    KiwiModel_Objects Directory Reference
    +
    +
    + + +

    +Files

    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/dir_2e34f4a47a35755637d0fbb4263328e1.html b/docs/html/dir_2e34f4a47a35755637d0fbb4263328e1.html index 6284e374..80a1799d 100644 --- a/docs/html/dir_2e34f4a47a35755637d0fbb4263328e1.html +++ b/docs/html/dir_2e34f4a47a35755637d0fbb4263328e1.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Ressources Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiApp_Ressources Directory Reference
    + + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_4c0a8d8567be4e932569bc111da90cf3.html b/docs/html/dir_4c0a8d8567be4e932569bc111da90cf3.html index 43d8a05e..0c2d0016 100644 --- a/docs/html/dir_4c0a8d8567be4e932569bc111da90cf3.html +++ b/docs/html/dir_4c0a8d8567be4e932569bc111da90cf3.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Network Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiApp_Network Directory Reference
    + + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_5075f496c9440eda045d61f24a275d29.html b/docs/html/dir_5075f496c9440eda045d61f24a275d29.html index f0b4ed27..a9b2bca6 100644 --- a/docs/html/dir_5075f496c9440eda045d61f24a275d29.html +++ b/docs/html/dir_5075f496c9440eda045d61f24a275d29.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiDsp Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiDsp Directory Reference
    + + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_5f1d664de9b91ef7031a8dbd2f639110.html b/docs/html/dir_5f1d664de9b91ef7031a8dbd2f639110.html new file mode 100644 index 00000000..09c62914 --- /dev/null +++ b/docs/html/dir_5f1d664de9b91ef7031a8dbd2f639110.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiModel/KiwiModel_Converters Directory Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    KiwiModel_Converters Directory Reference
    +
    +
    + + +

    +Files

    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/dir_6118710b0f789d12950652de74b0b43f.html b/docs/html/dir_6118710b0f789d12950652de74b0b43f.html new file mode 100644 index 00000000..60b0df4d --- /dev/null +++ b/docs/html/dir_6118710b0f789d12950652de74b0b43f.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiEngine/KiwiEngine_Objects Directory Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    KiwiEngine_Objects Directory Reference
    +
    +
    + + +

    +Files

    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/dir_6b2561cfb5818aa8d74e69e7233c5cf4.html b/docs/html/dir_6b2561cfb5818aa8d74e69e7233c5cf4.html new file mode 100644 index 00000000..b38922c6 --- /dev/null +++ b/docs/html/dir_6b2561cfb5818aa8d74e69e7233c5cf4.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiServer Directory Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    KiwiServer Directory Reference
    +
    +
    + + +

    +Files

    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/dir_6b9671ab685b5cc0f6f5237b1b62b425.html b/docs/html/dir_6b9671ab685b5cc0f6f5237b1b62b425.html new file mode 100644 index 00000000..ffc28a62 --- /dev/null +++ b/docs/html/dir_6b9671ab685b5cc0f6f5237b1b62b425.html @@ -0,0 +1,108 @@ + + + + + + +Kiwi: Modules/KiwiNetwork Directory Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    KiwiNetwork Directory Reference
    +
    +
    + + +

    +Directories

    + +

    +Files

    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/dir_6d89ecf3c3819a96b23656210de5cf73.html b/docs/html/dir_6d89ecf3c3819a96b23656210de5cf73.html index f74d46b2..bbcb8118 100644 --- a/docs/html/dir_6d89ecf3c3819a96b23656210de5cf73.html +++ b/docs/html/dir_6d89ecf3c3819a96b23656210de5cf73.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiModel Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiModel Directory Reference
    + + +

    +Directories

    + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_748e941d1d38e258f05b9c3c648f2b58.html b/docs/html/dir_748e941d1d38e258f05b9c3c648f2b58.html new file mode 100644 index 00000000..277ed40c --- /dev/null +++ b/docs/html/dir_748e941d1d38e258f05b9c3c648f2b58.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiNetwork/KiwiHttp Directory Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    KiwiHttp Directory Reference
    +
    +
    + + +

    +Files

    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/dir_759fc562c0ca6ee75e96b07025954477.html b/docs/html/dir_759fc562c0ca6ee75e96b07025954477.html index 19c3708d..de3ac84a 100644 --- a/docs/html/dir_759fc562c0ca6ee75e96b07025954477.html +++ b/docs/html/dir_759fc562c0ca6ee75e96b07025954477.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Utils Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiApp_Utils Directory Reference
    + + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_805bb369f87809a94dc97d224c7ebf37.html b/docs/html/dir_805bb369f87809a94dc97d224c7ebf37.html new file mode 100644 index 00000000..02022a2f --- /dev/null +++ b/docs/html/dir_805bb369f87809a94dc97d224c7ebf37.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Modules/KiwiTool Directory Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    KiwiTool Directory Reference
    +
    +
    + + +

    +Files

    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/dir_8a1ab1ee7578188f7fa41649c125c353.html b/docs/html/dir_8a1ab1ee7578188f7fa41649c125c353.html index 599572bf..9273abb2 100644 --- a/docs/html/dir_8a1ab1ee7578188f7fa41649c125c353.html +++ b/docs/html/dir_8a1ab1ee7578188f7fa41649c125c353.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Patcher Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiApp_Patcher Directory Reference
    + + +

    +Directories

    + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_8e58523ef7c47011151621d3e9128759.html b/docs/html/dir_8e58523ef7c47011151621d3e9128759.html index c2456608..9167c08b 100644 --- a/docs/html/dir_8e58523ef7c47011151621d3e9128759.html +++ b/docs/html/dir_8e58523ef7c47011151621d3e9128759.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_General Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiApp_General Directory Reference
    + + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_922c588100a187620fdc1533bc178f73.html b/docs/html/dir_922c588100a187620fdc1533bc178f73.html index cd372977..d5c9c823 100644 --- a/docs/html/dir_922c588100a187620fdc1533bc178f73.html +++ b/docs/html/dir_922c588100a187620fdc1533bc178f73.html @@ -3,8 +3,7 @@ - - + Kiwi: Client Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + + - + - - - - + +
    KiwiApp_Components Directory Reference
    + + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_b246c2914b5ffa4794c798ccb88bcf77.html b/docs/html/dir_b246c2914b5ffa4794c798ccb88bcf77.html index 5511c5bc..d04dcfb9 100644 --- a/docs/html/dir_b246c2914b5ffa4794c798ccb88bcf77.html +++ b/docs/html/dir_b246c2914b5ffa4794c798ccb88bcf77.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Audio Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiApp_Audio Directory Reference
    + + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_bf7bc16006a33accfcf4dfd969f1372c.html b/docs/html/dir_bf7bc16006a33accfcf4dfd969f1372c.html index 83299e3c..2aafd27d 100644 --- a/docs/html/dir_bf7bc16006a33accfcf4dfd969f1372c.html +++ b/docs/html/dir_bf7bc16006a33accfcf4dfd969f1372c.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source/KiwiApp_Application Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiApp_Application Directory Reference
    + + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_c88bb91bae2cc3c847a1f325116b4926.html b/docs/html/dir_c88bb91bae2cc3c847a1f325116b4926.html index 283d6a23..7bb3ee8d 100644 --- a/docs/html/dir_c88bb91bae2cc3c847a1f325116b4926.html +++ b/docs/html/dir_c88bb91bae2cc3c847a1f325116b4926.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules/KiwiEngine Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +
    KiwiEngine Directory Reference
    + + +

    +Directories

    + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_d6938551291504e72153a19ce9826d2b.html b/docs/html/dir_d6938551291504e72153a19ce9826d2b.html new file mode 100644 index 00000000..690c6a89 --- /dev/null +++ b/docs/html/dir_d6938551291504e72153a19ce9826d2b.html @@ -0,0 +1,105 @@ + + + + + + +Kiwi: Client/Source/KiwiApp_Auth Directory Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    Kiwi +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    KiwiApp_Auth Directory Reference
    +
    +
    + + +

    +Files

    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/dir_e3601b28331a3cecdd3a50c0b81b6ca0.html b/docs/html/dir_e3601b28331a3cecdd3a50c0b81b6ca0.html index 13024c06..c3bb5595 100644 --- a/docs/html/dir_e3601b28331a3cecdd3a50c0b81b6ca0.html +++ b/docs/html/dir_e3601b28331a3cecdd3a50c0b81b6ca0.html @@ -3,8 +3,7 @@ - - + Kiwi: Client/Source Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + +

    Directories

    + +

    +Files

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/dir_f2541a3b18981391fa76fac5599e978a.html b/docs/html/dir_f2541a3b18981391fa76fac5599e978a.html index 7a9a738e..155ca376 100644 --- a/docs/html/dir_f2541a3b18981391fa76fac5599e978a.html +++ b/docs/html/dir_f2541a3b18981391fa76fac5599e978a.html @@ -3,8 +3,7 @@ - - + Kiwi: Modules Directory Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,41 @@ - + - - - - + + - + - - - - + +
    Here is a list of all documented files with brief descriptions:
    -
    [detail level 1234]
    +
    [detail level 12345]
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     ▼ Client
     ▼ Source
     ▼ KiwiApp_Application
     KiwiApp_AboutWindow.h
     KiwiApp_BeaconDispatcher.h
     KiwiApp_Console.h
     KiwiApp_ConsoleHistory.h
     KiwiApp_DocumentBrowserView.h
     KiwiApp_Instance.h
     KiwiApp_SettingsPanel.h
     ▼ KiwiApp_Audio
     KiwiApp_DspDeviceManager.h
     ▼ KiwiApp_Components
     KiwiApp_CustomToolbarButton.h
     KiwiApp_ImageButton.h
     KiwiApp_SuggestEditor.h
     KiwiApp_TooltipWindow.h
     KiwiApp_Window.h
     ▼ KiwiApp_General
     KiwiApp_CommandIDs.h
     KiwiApp_IDs.h
     KiwiApp_LookAndFeel.h
     KiwiApp_StoredSettings.h
     ▼ KiwiApp_Network
     KiwiApp_Api.h
     KiwiApp_CarrierSocket.h
     KiwiApp_DocumentBrowser.h
     KiwiApp_DocumentManager.h
     ▼ KiwiApp_Patcher
     KiwiApp_LinkView.h
     KiwiApp_ObjectView.h
     KiwiApp_PatcherComponent.h
     KiwiApp_PatcherManager.h
     KiwiApp_PatcherView.h
     KiwiApp_PatcherViewHitTester.h
     KiwiApp_PatcherViewIoletHighlighter.h
     KiwiApp_PatcherViewLasso.h
     KiwiApp_PatcherViewport.h
     ▼ KiwiApp_Ressources
     KiwiApp_BinaryData.h
     ▼ KiwiApp_Utils
     KiwiApp_SuggestList.h
     KiwiApp.h
     ▼ Modules
     ▼ KiwiDsp
     KiwiDsp_Chain.h
     KiwiDsp_Def.h
     KiwiDsp_Misc.h
     KiwiDsp_Processor.h
     KiwiDsp_Signal.h
     ▼ KiwiEngine
     KiwiEngine_AudioControler.h
     KiwiEngine_Beacon.h
     KiwiEngine_CircularBuffer.h
     KiwiEngine_ConcurrentQueue.h
     KiwiEngine_Console.h
     KiwiEngine_Def.h
     KiwiEngine_Factory.h
     KiwiEngine_Instance.h
     KiwiEngine_Link.h
     KiwiEngine_Listeners.h
     KiwiEngine_Object.h
     KiwiEngine_Objects.h
     KiwiEngine_Patcher.h
     KiwiEngine_Scheduler.h
     KiwiEngine_Scheduler.hpp
     ▼ KiwiModel
     KiwiModel_Atom.h
     KiwiModel_DataModel.h
     KiwiModel_Def.h
     KiwiModel_Factory.h
     KiwiModel_Link.h
     KiwiModel_Object.h
     KiwiModel_Objects.h
     KiwiModel_Patcher.h
     KiwiModel_PatcherUser.h
     KiwiModel_PatcherValidator.h
     KiwiModel_PatcherView.h
     ► KiwiApp_Application
     ► KiwiApp_Audio
     ► KiwiApp_Auth
     ► KiwiApp_Components
     ► KiwiApp_General
     ► KiwiApp_Network
     ► KiwiApp_Patcher
     ► KiwiApp_Ressources
     ► KiwiApp_Utils
     KiwiApp.h
     ▼ Modules
     ▼ KiwiDsp
     KiwiDsp_Chain.h
     KiwiDsp_Def.h
     KiwiDsp_Misc.h
     KiwiDsp_Processor.h
     KiwiDsp_Signal.h
     ▼ KiwiEngine
     ► KiwiEngine_Objects
     KiwiEngine_AudioControler.h
     KiwiEngine_Console.h
     KiwiEngine_Def.h
     KiwiEngine_Factory.h
     KiwiEngine_Instance.h
     KiwiEngine_Link.h
     KiwiEngine_Object.h
     KiwiEngine_Patcher.h
     ▼ KiwiModel
     ► KiwiModel_Converters
     ► KiwiModel_Objects
     KiwiModel_DataModel.h
     KiwiModel_Def.h
     KiwiModel_DocumentManager.h
     KiwiModel_Error.h
     KiwiModel_Factory.h
     KiwiModel_Link.h
     KiwiModel_Object.h
     KiwiModel_ObjectClass.h
     KiwiModel_Patcher.h
     KiwiModel_PatcherUser.h
     KiwiModel_PatcherValidator.h
     KiwiModel_PatcherView.h
     ▼ KiwiNetwork
     ► KiwiHttp
     KiwiNetwork_Http.h
     ▼ KiwiServer
     KiwiServer_Server.h
     ▼ KiwiTool
     KiwiTool_Atom.h
     KiwiTool_Beacon.h
     KiwiTool_CircularBuffer.h
     KiwiTool_ConcurrentQueue.h
     KiwiTool_Listeners.h
     KiwiTool_Matrix.h
     KiwiTool_Matrix.hpp
     KiwiTool_Parameter.h
     KiwiTool_Scheduler.h
     KiwiTool_Scheduler.hpp
    @@ -149,7 +346,7 @@
    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/functions.html b/docs/html/functions.html index 0f6e1716..c592c97a 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@
    - + - - - - + + + +
    Here is a list of all documented class members with links to the class documentation for each member:
    -

    - a -

    - + - - - - + + + +
    Here is a list of all documented class members with links to the class documentation for each member:
    -

    - ~ -

    - + - - - - + + + +
    Here is a list of all documented class members with links to the class documentation for each member:
    -

    - b -

    - + - - - - + + + +
    Here is a list of all documented class members with links to the class documentation for each member:
    -

    - c -

    - + - - - - + + + +
    Here is a list of all documented class members with links to the class documentation for each member:
    -

    - d -

    Generated by   doxygen - 1.8.13 + 1.8.11
    diff --git a/docs/html/functions_e.html b/docs/html/functions_e.html index 2bc78480..182001a9 100644 --- a/docs/html/functions_e.html +++ b/docs/html/functions_e.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
    Here is a list of all documented class members with links to the class documentation for each member:
    -

    - e -

    @@ -114,7 +197,7 @@

    - e -

      Generated by   doxygen - 1.8.13 + 1.8.11
      diff --git a/docs/html/functions_enum.html b/docs/html/functions_enum.html index aa500e77..76b624b0 100644 --- a/docs/html/functions_enum.html +++ b/docs/html/functions_enum.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Enumerations @@ -12,6 +11,9 @@ + @@ -29,19 +31,55 @@ - + - - - - + + +
      Border : kiwi::HitTester +
    • Flag +: kiwi::model::ObjectClass +
    • Sort : kiwi::ConsoleHistory
      • @@ -69,8 +110,9 @@ : kiwi::HitTester
    • Type -: kiwi::Atom -, kiwi::engine::Console::Message +: kiwi::engine::Console::Message +, kiwi::tool::Atom +, kiwi::tool::Parameter
    • Zone : kiwi::HitTester @@ -81,7 +123,7 @@
      Generated by   doxygen - 1.8.13 + 1.8.11
      diff --git a/docs/html/functions_eval.html b/docs/html/functions_eval.html index 419c92a8..76139fea 100644 --- a/docs/html/functions_eval.html +++ b/docs/html/functions_eval.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Enumerator @@ -12,6 +11,9 @@ + @@ -29,19 +31,55 @@
      • - + - - - - + + + - + - - - - + + + +
      Here is a list of all documented class members with links to the class documentation for each member:
      -

      - f -

      Generated by   doxygen - 1.8.13 + 1.8.11
      diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 8de7e9f6..c475ba3b 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
        -

      - a -

      - + - - - - + + + +
        -

      - ~ -

      - + - - - - + + + +
        -

      - b -

      - + - - - - + + + +
        -

      - c -

      - + - - - - + + + +
        -

      - d -

      Generated by   doxygen - 1.8.13 + 1.8.11
      diff --git a/docs/html/functions_func_e.html b/docs/html/functions_func_e.html index 7f7697c5..68c24e20 100644 --- a/docs/html/functions_func_e.html +++ b/docs/html/functions_func_e.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
        -

      - e -

      @@ -114,7 +197,7 @@

      - e -

        Generated by   doxygen - 1.8.13 + 1.8.11
        diff --git a/docs/html/functions_func_f.html b/docs/html/functions_func_f.html index b0f1ac4b..fff23a58 100644 --- a/docs/html/functions_func_f.html +++ b/docs/html/functions_func_f.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
          -

        - f -

        Generated by   doxygen - 1.8.13 + 1.8.11
        diff --git a/docs/html/functions_func_g.html b/docs/html/functions_func_g.html index e50e6bb9..9bfb2563 100644 --- a/docs/html/functions_func_g.html +++ b/docs/html/functions_func_g.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
          -

        - g -

        @@ -477,7 +698,7 @@

        - g -

          Generated by   doxygen - 1.8.13 + 1.8.11
          diff --git a/docs/html/functions_func_h.html b/docs/html/functions_func_h.html index ad0b0eaa..63177ec9 100644 --- a/docs/html/functions_func_h.html +++ b/docs/html/functions_func_h.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
            -

          - h -

          - + - - - - + + + +
            -

          - i -

          - + - - - - + + + +
            -

          - j -

          @@ -70,7 +136,7 @@

          - j -

            Generated by   doxygen - 1.8.13 + 1.8.11
            diff --git a/docs/html/functions_func_l.html b/docs/html/functions_func_l.html index b06ec783..7b03850f 100644 --- a/docs/html/functions_func_l.html +++ b/docs/html/functions_func_l.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
              -

            - l -

            @@ -142,7 +220,7 @@

            - l -

              Generated by   doxygen - 1.8.13 + 1.8.11
              diff --git a/docs/html/functions_func_m.html b/docs/html/functions_func_m.html index 7014ee90..1927606a 100644 --- a/docs/html/functions_func_m.html +++ b/docs/html/functions_func_m.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + + @@ -98,7 +180,7 @@

              - m -

                Generated by   doxygen - 1.8.13 + 1.8.11
                diff --git a/docs/html/functions_func_n.html b/docs/html/functions_func_n.html index 2d70fef1..6c5f0112 100644 --- a/docs/html/functions_func_n.html +++ b/docs/html/functions_func_n.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                  -

                - n -

                @@ -100,7 +172,7 @@

                - n -

                  Generated by   doxygen - 1.8.13 + 1.8.11
                  diff --git a/docs/html/functions_func_o.html b/docs/html/functions_func_o.html index b7f23451..4ddb48aa 100644 --- a/docs/html/functions_func_o.html +++ b/docs/html/functions_func_o.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                    -

                  - o -

                  @@ -123,7 +214,7 @@

                  - o -

                    Generated by   doxygen - 1.8.13 + 1.8.11
                    diff --git a/docs/html/functions_func_p.html b/docs/html/functions_func_p.html index 448b589d..7f4ea996 100644 --- a/docs/html/functions_func_p.html +++ b/docs/html/functions_func_p.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                      -

                    - p -

                    - + - - - - + + + + @@ -70,7 +139,7 @@

                    - q -

                      Generated by   doxygen - 1.8.13 + 1.8.11
                      diff --git a/docs/html/functions_func_r.html b/docs/html/functions_func_r.html index c338b0f5..a8c7258b 100644 --- a/docs/html/functions_func_r.html +++ b/docs/html/functions_func_r.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                        -

                      - r -

                      @@ -199,7 +303,7 @@

                      - r -

                        Generated by   doxygen - 1.8.13 + 1.8.11
                        diff --git a/docs/html/functions_func_s.html b/docs/html/functions_func_s.html index feb13312..3ad19a77 100644 --- a/docs/html/functions_func_s.html +++ b/docs/html/functions_func_s.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                          -

                        - s -

                        - + - - - - + + + +
                          -

                        - t -

                        @@ -122,7 +190,7 @@

                        - t -

                          Generated by   doxygen - 1.8.13 + 1.8.11
                          diff --git a/docs/html/functions_func_u.html b/docs/html/functions_func_u.html index fe664f27..825633f4 100644 --- a/docs/html/functions_func_u.html +++ b/docs/html/functions_func_u.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                            -

                          - u -

                          - + - - - - + + + +
                            -

                          - v -

                            +

                            - v -

                              +
                            • validateSelectedRow() +: kiwi::SuggestEditor::Menu +
                            • View() : kiwi::model::Patcher::View
                              • @@ -73,7 +142,7 @@

                              - v -

                                Generated by   doxygen - 1.8.13 + 1.8.11
                                diff --git a/docs/html/functions_func_w.html b/docs/html/functions_func_w.html index 8f164632..a3c7444e 100644 --- a/docs/html/functions_func_w.html +++ b/docs/html/functions_func_w.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@
                          - + - - - - + + + +
                          Generated by   doxygen - 1.8.13 + 1.8.11
                          diff --git a/docs/html/functions_func_z.html b/docs/html/functions_func_z.html index a99cccc3..07231b39 100644 --- a/docs/html/functions_func_z.html +++ b/docs/html/functions_func_z.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Functions @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                            -

                          - z -

                          @@ -70,7 +136,7 @@

                          - z -

                            Generated by   doxygen - 1.8.13 + 1.8.11
                            diff --git a/docs/html/functions_g.html b/docs/html/functions_g.html index c646fd6f..c04fa5a2 100644 --- a/docs/html/functions_g.html +++ b/docs/html/functions_g.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                            Here is a list of all documented class members with links to the class documentation for each member:
                            -

                            - g -

                            @@ -477,7 +698,7 @@

                            - g -

                              Generated by   doxygen - 1.8.13 + 1.8.11
                              diff --git a/docs/html/functions_h.html b/docs/html/functions_h.html index f1c7e9dc..9e4716cd 100644 --- a/docs/html/functions_h.html +++ b/docs/html/functions_h.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                              Here is a list of all documented class members with links to the class documentation for each member:
                              -

                              - h -

                              - + - - - - + + + +
                              Here is a list of all documented class members with links to the class documentation for each member:
                              -

                              - i -

                              - + - - - - + + + +
                              Here is a list of all documented class members with links to the class documentation for each member:
                              -

                              - j -

                              @@ -70,7 +136,7 @@

                              - j -

                                Generated by   doxygen - 1.8.13 + 1.8.11
                                diff --git a/docs/html/functions_l.html b/docs/html/functions_l.html index 885a046d..19f0fb0b 100644 --- a/docs/html/functions_l.html +++ b/docs/html/functions_l.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                Here is a list of all documented class members with links to the class documentation for each member:
                                -

                                - l -

                                @@ -145,7 +223,7 @@

                                - l -

                                  Generated by   doxygen - 1.8.13 + 1.8.11
                                  diff --git a/docs/html/functions_m.html b/docs/html/functions_m.html index 4056f8b9..3e07db25 100644 --- a/docs/html/functions_m.html +++ b/docs/html/functions_m.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                  Here is a list of all documented class members with links to the class documentation for each member:
                                  -

                                  - m -

                                  @@ -110,7 +192,7 @@

                                  - m -

                                    Generated by   doxygen - 1.8.13 + 1.8.11
                                    diff --git a/docs/html/functions_n.html b/docs/html/functions_n.html index b6668f3a..84a4fa23 100644 --- a/docs/html/functions_n.html +++ b/docs/html/functions_n.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                    Here is a list of all documented class members with links to the class documentation for each member:
                                    -

                                    - n -

                                    @@ -103,7 +175,7 @@

                                    - n -

                                      Generated by   doxygen - 1.8.13 + 1.8.11
                                      diff --git a/docs/html/functions_o.html b/docs/html/functions_o.html index 5d6180c5..fd97af91 100644 --- a/docs/html/functions_o.html +++ b/docs/html/functions_o.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                      Here is a list of all documented class members with links to the class documentation for each member:
                                      -

                                      - o -

                                      @@ -123,7 +214,7 @@

                                      - o -

                                        Generated by   doxygen - 1.8.13 + 1.8.11
                                        diff --git a/docs/html/functions_p.html b/docs/html/functions_p.html index 9ff66364..7f3d5934 100644 --- a/docs/html/functions_p.html +++ b/docs/html/functions_p.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                        Here is a list of all documented class members with links to the class documentation for each member:
                                        -

                                        - p -

                                        - + - - - - + + + +
                                        Here is a list of all documented class members with links to the class documentation for each member:
                                        -

                                        - q -

                                        @@ -70,7 +139,7 @@

                                        - q -

                                          Generated by   doxygen - 1.8.13 + 1.8.11
                                          diff --git a/docs/html/functions_r.html b/docs/html/functions_r.html index ba492928..6dd8f146 100644 --- a/docs/html/functions_r.html +++ b/docs/html/functions_r.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                          Here is a list of all documented class members with links to the class documentation for each member:
                                          -

                                          - r -

                                          @@ -199,7 +303,7 @@

                                          - r -

                                            Generated by   doxygen - 1.8.13 + 1.8.11
                                            diff --git a/docs/html/functions_rela.html b/docs/html/functions_rela.html new file mode 100644 index 00000000..9e6662d1 --- /dev/null +++ b/docs/html/functions_rela.html @@ -0,0 +1,113 @@ + + + + + + +Kiwi: Class Members - Related Functions + + + + + + + + + + +
                                            +
                                            + + + + + + +
                                            +
                                            Kiwi +
                                            +
                                            +
                                            + + + + + + +
                                            + +
                                            +
                                            + + +
                                            + +
                                            + +
                                            +  +
                                            + +
                                            +Generated by   +doxygen + 1.8.11 +
                                            + + diff --git a/docs/html/functions_s.html b/docs/html/functions_s.html index 3b1d309d..0d4ddead 100644 --- a/docs/html/functions_s.html +++ b/docs/html/functions_s.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                            Here is a list of all documented class members with links to the class documentation for each member:
                                            -

                                            - s -

                                            - + - - - - + + + +
                                            Here is a list of all documented class members with links to the class documentation for each member:
                                            -

                                            - t -

                                            @@ -129,7 +198,7 @@

                                            - t -

                                              Generated by   doxygen - 1.8.13 + 1.8.11
                                              diff --git a/docs/html/functions_type.html b/docs/html/functions_type.html index 261f2345..f9edcd3f 100644 --- a/docs/html/functions_type.html +++ b/docs/html/functions_type.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Typedefs @@ -12,6 +11,9 @@ + @@ -29,19 +31,55 @@ - + - - - - + + +
                                               
                                              @@ -92,7 +133,7 @@
                                              Generated by   doxygen - 1.8.13 + 1.8.11
                                              diff --git a/docs/html/functions_u.html b/docs/html/functions_u.html index ad759c3b..c0deda26 100644 --- a/docs/html/functions_u.html +++ b/docs/html/functions_u.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                              Here is a list of all documented class members with links to the class documentation for each member:
                                              -

                                              - u -

                                              - + - - - - + + + +
                                              Here is a list of all documented class members with links to the class documentation for each member:
                                              -

                                              - v -

                                                +

                                                - v -

                                                  +
                                                • validateSelectedRow() +: kiwi::SuggestEditor::Menu +
                                                • View() : kiwi::model::Patcher::View
                                                  • @@ -73,7 +142,7 @@

                                                  - v -

                                                    Generated by   doxygen - 1.8.13 + 1.8.11
                                                    diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index ba5d3bce..405a4d48 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members - Variables @@ -12,6 +11,9 @@ + @@ -29,19 +31,55 @@
                                              - + - - - - + + + - + - - - - + + + +
                                              Here is a list of all documented class members with links to the class documentation for each member:
                                              -

                                              - w -

                                              Generated by   doxygen - 1.8.13 + 1.8.11
                                              diff --git a/docs/html/functions_z.html b/docs/html/functions_z.html index 5426a39d..04efea12 100644 --- a/docs/html/functions_z.html +++ b/docs/html/functions_z.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Members @@ -12,6 +11,9 @@ + @@ -29,19 +31,83 @@ - + - - - - + + + +
                                              Here is a list of all documented class members with links to the class documentation for each member:
                                              -

                                              - z -

                                              @@ -73,7 +139,7 @@

                                              - z -

                                                Generated by   doxygen - 1.8.13 + 1.8.11
                                                diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 41210e36..285f48e0 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -3,8 +3,7 @@ - - + Kiwi: Class Hierarchy @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
                                                This inheritance list is sorted roughly, but not completely, alphabetically:
                                                -
                                                [detail level 1234]
                                                - +
                                                [detail level 12345]
                                                 Ckiwi::ApiAn API request handler class
                                                + @@ -73,224 +100,389 @@ - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                 Ckiwi::ApiA remote API request handler
                                                 ►CApplicationCommandTarget
                                                 Ckiwi::AtomThe Atom can dynamically hold different types of value
                                                 Ckiwi::AtomHelperAn Atom helper class
                                                 Ckiwi::tool::AtomThe Atom can dynamically hold different types of value
                                                 Ckiwi::tool::AtomHelperAn Atom helper class
                                                 ►Ckiwi::engine::AudioControlerAudioControler is a pure interface that enable controling audio in kiwi
                                                 ►CAudioDeviceManager
                                                 ►CAudioIODeviceCallback
                                                 Ckiwi::engine::BeaconThe beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used to bind beacon's castaways
                                                 Ckiwi::dsp::BufferA class that wraps a vector of Signal objects
                                                 ►CButton
                                                 Ckiwi::CarrierSocketClass that encapsulate a TCP socket
                                                 ►Ckiwi::engine::Beacon::CastawayThe beacon castaway can be binded to a beacon
                                                 Ckiwi::dsp::ChainAn audio rendering class that manages processors in a graph structure
                                                 Ckiwi::engine::CircularBuffer< T >
                                                 Ckiwi::engine::Router::Cnx
                                                 Ckiwi::engine::Scheduler< Clock >::Queue::Command
                                                 Ckiwi::dsp::Chain::compare_proc
                                                 ►CComponent
                                                 ►CComponentListener
                                                 Ckiwi::engine::ConcurrentQueue< T >A mono producer, mono consumer FIFO lock free queue
                                                 Ckiwi::engine::ConcurrentQueue< kiwi::engine::Scheduler::Queue::Command >
                                                 Ckiwi::engine::ConsoleThe console is an interface that let you print messages
                                                 ►CDataModel
                                                 Ckiwi::Api::Document
                                                 ►CDocumentObserver
                                                 Ckiwi::DocumentBrowser::Drive::DocumentSession
                                                 ►CDocumentValidator
                                                 ►CDocumentWindow
                                                 Ckiwi::DocumentBrowser::Drive
                                                 Ckiwi::engine::Scheduler< Clock >::EventAn event that associates a task and a execution time
                                                 Ckiwi::model::FactoryThe model Object's factory
                                                 ►Ckiwi::engine::Beacon::FactoryThe beacon factory is used to create beacons
                                                 Ckiwi::engine::FactoryThe engine Object's factory
                                                 Ckiwi::FileHandlerClass that enable saving and loading the document from a kiwi file
                                                 Ckiwi::HitTesterThe HitTester class..
                                                 Ckiwi::dsp::Chain::index_node
                                                 Ckiwi::InstanceThe Application Instance
                                                 ►Cintegral_constant
                                                 ►Ckiwi::dsp::IPerformCallBackPure virtual interface that defines a perform function to be implemented by child classes
                                                 Ckiwi::model::Factory::isValidObject< TModel >IsValidObject type traits
                                                 ►CJUCEApplication
                                                 Ckiwi::engine::LinkThe Link represents the connection between the outlet of an Object to the inlet of another
                                                 ►CListBox
                                                 ►CListBoxModel
                                                 ►Ckiwi::NetworkSettings::ListenerNetworkSettings Listener
                                                 ►CListener
                                                 ►Ckiwi::DocumentBrowser::ListenerListen to document explorer changes
                                                 ►Ckiwi::DocumentBrowser::Drive::ListenerListen to document browser changes
                                                 Ckiwi::tool::BeaconThe beacon is unique and matchs to a "unique" string in the scope of a beacon factory and can be used to bind beacon's castaways
                                                 Ckiwi::network::http::Body
                                                 Ckiwi::dsp::BufferA class that wraps a vector of Signal objects
                                                 ►CButton
                                                 ►CButtonListener
                                                 Ckiwi::CarrierSocketClass that encapsulate a TCP socket
                                                 ►Ckiwi::tool::Beacon::CastawayThe beacon castaway can be binded to a beacon
                                                 Ckiwi::dsp::ChainAn audio rendering class that manages processors in a graph structure
                                                 Ckiwi::tool::CircularBuffer< T >
                                                 Ckiwi::tool::Scheduler< Clock >::Queue::Command
                                                 Ckiwi::dsp::Chain::compare_proc
                                                 ►CComponent
                                                 ►CComponentListener
                                                 Ckiwi::tool::ConcurrentQueue< T >A mono producer, mono consumer FIFO lock free queue
                                                 Ckiwi::tool::ConcurrentQueue< kiwi::tool::Scheduler::Queue::Command >
                                                 Ckiwi::engine::ConsoleThe console is an interface that let you print messages
                                                 ►Ckiwi::Api::Controller
                                                 Ckiwi::model::ConverterConverts a document's backend representation to meet current version representation
                                                 ►CDataModel
                                                 Ckiwi::Api::Document
                                                 Ckiwi::model::DocumentManager
                                                 ►CDocumentObserver
                                                 Ckiwi::DocumentBrowser::Drive::DocumentSession
                                                 ►CDocumentValidator
                                                 ►CDocumentWindow
                                                 Ckiwi::DocumentBrowser::Drive
                                                 Ckiwi::Api::Error
                                                 Ckiwi::tool::Scheduler< Clock >::EventAn event that associates a task and a execution time
                                                 Ckiwi::Factory
                                                 Ckiwi::engine::FactoryThe engine Object's factory
                                                 ►Ckiwi::tool::Beacon::FactoryThe beacon factory is used to create beacons
                                                 Ckiwi::model::FactoryThe model Object's factory
                                                 Ckiwi::HitTesterThe HitTester class..
                                                 Ckiwi::dsp::Chain::index_node
                                                 ►Cintegral_constant
                                                 ►Ckiwi::dsp::IPerformCallBackPure virtual interface that defines a perform function to be implemented by child classes
                                                 Ckiwi::model::Factory::isValidObject< TModel >IsValidObject type traits
                                                 ►CJUCEApplication
                                                 Ckiwi::engine::LinkThe Link represents the connection between the outlet of an Object to the inlet of another
                                                 ►CListBox
                                                 ►CListBoxModel
                                                 ►Ckiwi::PatcherManager::Listener
                                                 ►CListener
                                                 ►CListener
                                                 ►CListener
                                                 ►Ckiwi::engine::Console::ListenerYou can inherit from this class to receive console changes
                                                 ►Ckiwi::NetworkSettings::ListenerNetworkSettings Listener
                                                 ►Ckiwi::DocumentBrowser::Drive::ListenerListen to document browser changes
                                                 ►Ckiwi::EditableObjectView::Listener
                                                 ►Ckiwi::engine::Console::ListenerYou can inherit from this class to receive console changes
                                                 ►CListener
                                                 ►CListener
                                                 ►CListener
                                                 ►Ckiwi::ConsoleHistory::ListenerThe Console History Listener is a is a virtual class you can inherit from to receive console history change notifications
                                                 ►Ckiwi::SuggestEditor::ListenerReceives callbacks from a SuggestEditor component
                                                 Ckiwi::engine::Listeners< ListenerClass >The listener set is a class that manages a list of listeners
                                                 Ckiwi::engine::Listeners< kiwi::ConsoleHistory::Listener >
                                                 Ckiwi::engine::Listeners< kiwi::DocumentBrowser::Drive::Listener >
                                                 Ckiwi::engine::Listeners< kiwi::DocumentBrowser::Listener >
                                                 Ckiwi::engine::Listeners< kiwi::engine::Console::Listener >
                                                 Ckiwi::engine::Listeners< kiwi::NetworkSettings::Listener >
                                                 Ckiwi::engine::Listeners< kiwi::PatcherManager::Listener >
                                                 Ckiwi::engine::Listeners< kiwi::SuggestEditor::Listener >
                                                 Ckiwi::engine::Scheduler< Clock >::LockThis class is intended to lock the execution of a certain consumer
                                                 ►CLookAndFeel_V4
                                                 ►CMenuBarModel
                                                 Ckiwi::engine::Console::MessageThe Console Message owns the informations of a message posted via a console
                                                 Ckiwi::dsp::Chain::NodeThe Node object wraps and manages a Processor object inside a Chain object
                                                 ►CObject
                                                 ►Ckiwi::engine::ObjectThe Object reacts and interacts with other ones by sending and receiving messages via its inlets and outlets
                                                 ►Ckiwi::model::Factory::ObjectClassBaseObjectClass base class
                                                 Ckiwi::SuggestList::OptionsScore bonuses and penalties to sort entries
                                                 Ckiwi::engine::PatcherThe Patcher manages a set of Object and Link
                                                 Ckiwi::dsp::Chain::Node::PinThe pin helds a set of tie that points to other pins
                                                 Ckiwi::dsp::Processor::PrepareInfo
                                                 ►Ckiwi::dsp::ProcessorThe pure virtual class that processes digital signal in a Chain object
                                                 ►CPropertyPanel
                                                 Ckiwi::engine::Scheduler< Clock >::QueueA class that holds a list of scheduled events
                                                 Ckiwi::engine::Router
                                                 ►Cruntime_error
                                                 Ckiwi::engine::Scheduler< Clock >A class designed to delay tasks' execution between threads that where previously declared
                                                 Ckiwi::dsp::SignalA class that wraps a vector of sample_t
                                                 Ckiwi::StringHelperAn std::string helper class
                                                 Ckiwi::SuggestListA string container that provide suggestion list based on given patterns
                                                 ►CTableListBoxModel
                                                 ►Ckiwi::engine::Scheduler< Clock >::TaskThe abstract class that the scheduler executes. Caller must override execute function to specify the callback behavior
                                                 ►CTextEditor
                                                 Ckiwi::dsp::Chain::Node::TieA tie is a reference held by a pin to another pin
                                                 ►Ckiwi::engine::Scheduler< Clock >::TimerAn abstract class designed to repetedly call a method at a specified intervall of time. Overriding timerCallBack and calling startTimer will start repetdly calling method
                                                 ►CTimer
                                                 Ckiwi::dsp::TimerThe timer
                                                 ►CToolbarItemComponent
                                                 ►CToolbarItemFactory
                                                 ►CTooltipClient
                                                 ►CViewport
                                                 ►CListener
                                                 ►CListener
                                                 ►CListener
                                                 ►Ckiwi::model::Object::Listener
                                                 ►Ckiwi::PatcherManager::Listener
                                                 ►Ckiwi::ConsoleHistory::ListenerThe Console History Listener is a is a virtual class you can inherit from to receive console history change notifications
                                                 Ckiwi::tool::Listeners< ListenerClass >The listener set is a class that manages a list of listeners
                                                 Ckiwi::tool::Listeners< kiwi::ConsoleHistory::Listener >
                                                 Ckiwi::tool::Listeners< kiwi::DocumentBrowser::Drive::Listener >
                                                 Ckiwi::tool::Listeners< kiwi::EditableObjectView::Listener >
                                                 Ckiwi::tool::Listeners< kiwi::engine::Console::Listener >
                                                 Ckiwi::tool::Listeners< kiwi::model::Object::Listener >
                                                 Ckiwi::tool::Listeners< kiwi::NetworkSettings::Listener >
                                                 Ckiwi::tool::Listeners< kiwi::PatcherManager::Listener >
                                                 Ckiwi::server::Server::Logger
                                                 ►CLookAndFeel_V4
                                                 Ckiwi::tool::Matrix< Type >A matrix data structure
                                                 ►CMenuBarModel
                                                 Ckiwi::engine::Console::MessageThe Console Message owns the informations of a message posted via a console
                                                 Ckiwi::MouseHandlerThe mouse handler is used to make the patcher view react to the mouse interactions
                                                 Ckiwi::dsp::Chain::NodeThe Node object wraps and manages a Processor object inside a Chain object
                                                 ►CObject
                                                 Ckiwi::model::ObjectClassThe static representation of an object
                                                 Ckiwi::SuggestList::OptionsScore bonuses and penalties to sort entries
                                                 Ckiwi::network::http::Payload::Pair
                                                 Ckiwi::network::http::Parameters::Parameter
                                                 Ckiwi::tool::ParameterParameter is a class designed to represent any type of data
                                                 Ckiwi::model::ParameterClassThis is a parameter static informations
                                                 Ckiwi::network::http::Parameters
                                                 Ckiwi::tool::AtomHelper::ParsingFlags
                                                 Ckiwi::engine::PatcherThe Patcher manages a set of Object and Link
                                                 Ckiwi::network::http::Payload
                                                 Ckiwi::dsp::Chain::Node::PinThe pin helds a set of tie that points to other pins
                                                 ►CPortFactoryListener
                                                 ►CPortListener
                                                 Ckiwi::dsp::Processor::PrepareInfo
                                                 ►Ckiwi::dsp::ProcessorThe pure virtual class that processes digital signal in a Chain object
                                                 Ckiwi::network::http::Query< ReqType, ResType >
                                                 Ckiwi::tool::Scheduler< Clock >::QueueA class that holds a list of scheduled events
                                                 Ckiwi::engine::Ramp
                                                 ►Cresponse
                                                 ►Cruntime_error
                                                 Ckiwi::tool::Scheduler< Clock >A class designed to delay tasks' execution between threads that where previously declared
                                                 Ckiwi::server::Server::Session
                                                 Ckiwi::network::http::Session
                                                 ►CSettableTooltipClient
                                                 Ckiwi::dsp::SignalA class that wraps a vector of sample_t
                                                 Ckiwi::SuggestListA string container that provide suggestion list based on given patterns
                                                 ►CTabbedComponent
                                                 ►CTableListBoxModel
                                                 ►Ckiwi::tool::Scheduler< Clock >::TaskThe abstract class that the scheduler executes. Caller must override execute function to specify the callback behavior
                                                 ►CTextEditor
                                                 Ckiwi::dsp::Chain::Node::TieA tie is a reference held by a pin to another pin
                                                 ►Ckiwi::tool::Scheduler< Clock >::TimerAn abstract class designed to repetedly call a method at a specified intervall of time. Overriding timerCallBack and calling startTimer will start repetdly calling method
                                                 Ckiwi::dsp::TimerThe timer
                                                 ►CTimer
                                                 ►CToolbarItemComponent
                                                 ►CToolbarItemFactory
                                                 ►CTooltipClient
                                                 ►Ckiwi::Api::User
                                                 Ckiwi::engine::Ramp::ValueTimePair
                                                 ►CViewport
                                                @@ -298,7 +490,7 @@
                                                Generated by   doxygen - 1.8.13 + 1.8.11
                                                diff --git a/docs/html/index.html b/docs/html/index.html index 86a8fc1d..79d76b12 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -3,8 +3,7 @@ - - + Kiwi: Main Page @@ -12,6 +11,9 @@ + @@ -29,19 +31,36 @@
                                                - + - - - - + +
                                                +
                                                +Classes | +Typedefs | +Enumerations | +Functions
                                                +
                                                +
                                                kiwi Namespace Reference
                                                +
                                                +
                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

                                                +Classes

                                                class  AboutWindow
                                                 Kiwi About window. More...
                                                 
                                                class  AlertBox
                                                 
                                                class  Api
                                                 A remote API request handler. More...
                                                 
                                                class  ApiController
                                                 
                                                class  AuthPanel
                                                 
                                                class  BangView
                                                 
                                                class  BeaconDispatcher
                                                 
                                                class  BeaconDispatcherElem
                                                 A Component that allows to dispatch messages to Beacon::Castaway objects. More...
                                                 
                                                class  BeaconDispatcherToolbarFactory
                                                 
                                                class  CarrierSocket
                                                 Class that encapsulate a TCP socket. More...
                                                 
                                                class  ClassicView
                                                 The view of any textual kiwi object. More...
                                                 
                                                class  CommentView
                                                 The view of any textual kiwi object. More...
                                                 
                                                class  Console
                                                 
                                                class  ConsoleContent
                                                 The juce ConsoleContent Component. More...
                                                 
                                                class  ConsoleHistory
                                                 The Console History listen to the Console and keep an history of the messages. More...
                                                 
                                                class  ConsoleToolbarFactory
                                                 
                                                class  CustomToolbarButton
                                                 A type of button designed to go on a toolbar. More...
                                                 
                                                class  CustomTooltipClient
                                                 A custom tooltip client that provides the bounds of the tooltip to show. More...
                                                 
                                                class  DocumentBrowser
                                                 Request Patcher document informations through a Kiwi API. More...
                                                 
                                                class  DocumentBrowserView
                                                 
                                                class  DspDeviceManager
                                                 
                                                class  EditableObjectView
                                                 Abstract class for object's views that can be edited in mode unlock. More...
                                                 
                                                class  Factory
                                                 
                                                class  FormComponent
                                                 
                                                class  HitTester
                                                 The HitTester class... More...
                                                 
                                                class  ImageButton
                                                 A button that displays a Drawable. More...
                                                 
                                                class  Instance
                                                 The Application Instance. More...
                                                 
                                                class  IoletHighlighter
                                                 
                                                class  KiwiApp
                                                 
                                                class  Lasso
                                                 
                                                class  LinkView
                                                 The juce link Component. More...
                                                 
                                                class  LinkViewBase
                                                 The LinkView base class. More...
                                                 
                                                class  LinkViewCreator
                                                 The LinkView creator helper. More...
                                                 
                                                class  LoginForm
                                                 
                                                class  LookAndFeel
                                                 
                                                class  MessageView
                                                 The view of any textual kiwi object. More...
                                                 
                                                class  MeterTildeView
                                                 
                                                class  MouseHandler
                                                 The mouse handler is used to make the patcher view react to the mouse interactions. More...
                                                 
                                                class  NetworkSettings
                                                 
                                                class  NumberTildeView
                                                 The view of any textual kiwi object. More...
                                                 
                                                class  NumberView
                                                 The view of any textual kiwi object. More...
                                                 
                                                class  NumberViewBase
                                                 The view of any textual kiwi object. More...
                                                 
                                                class  ObjectFrame
                                                 A juce component holding the object's graphical representation. More...
                                                 
                                                class  ObjectView
                                                 Abstract for objects graphical representation. More...
                                                 
                                                class  PatcherComponent
                                                 The PatcherComponent holds a patcher view and a patcher toolbar. More...
                                                 
                                                class  PatcherManager
                                                 The main DocumentObserver. More...
                                                 
                                                class  PatcherToolbar
                                                 
                                                class  PatcherView
                                                 The juce Patcher Component. More...
                                                 
                                                class  PatcherViewport
                                                 The PatcherView Viewport. More...
                                                 
                                                class  PatcherViewWindow
                                                 
                                                class  SettingsPanel
                                                 A Panel Component that shows application's settings. More...
                                                 
                                                class  SignUpForm
                                                 
                                                class  SliderView
                                                 
                                                struct  Spinner
                                                 
                                                class  StoredSettings
                                                 Settings storage class utility. More...
                                                 
                                                class  SuggestEditor
                                                 A text editor with auto-completion. More...
                                                 
                                                class  SuggestList
                                                 A string container that provide suggestion list based on given patterns. More...
                                                 
                                                class  ToggleView
                                                 
                                                class  TooltipWindow
                                                 A custom TooltipWindow. More...
                                                 
                                                class  Window
                                                 Common interface for all windows held by the application. More...
                                                 
                                                + + + + + + + +

                                                +Typedefs

                                                +typedef std::shared_ptr< ConsoleHistory > sConsoleHistory
                                                 
                                                +typedef std::weak_ptr< ConsoleHistory > wConsoleHistory
                                                 
                                                +using json = nlohmann::json
                                                 
                                                + + + + + + +

                                                +Enumerations

                                                enum  WindowId : std::size_t {
                                                +  Console = 0, +FormComponent, +AboutKiwi, +DocumentBrowser, +
                                                +  ApplicationSettings, +AudioSettings, +BeaconDispatcher, +count +
                                                + }
                                                 Singleton application window's ids. More...
                                                 
                                                enum  CommandIDs {
                                                +  newPatcher = 0x200010, +newPatcherView = 0x200020, +openFile = 0x200030, +closePatcher = 0x200051, +
                                                +  save = 0x200060, +saveAs = 0x200061, +minimizeWindow = 0x201010, +maximizeWindow = 0x201020, +
                                                +  closeWindow = 0x201031, +showConsoleWindow = 0x202000, +showAudioStatusWindow = 0x202010, +showAboutAppWindow = 0x202020, +
                                                +  showAppSettingsWindow = 0x202030, +showDocumentBrowserWindow = 0x202040, +showBeaconDispatcherWindow = 0x202050, +addBeaconDispatcher = 0x202051, +
                                                +  removeBeaconDispatcher = 0x202052, +undo = 0xf1000a, +redo = 0xf1000b, +duplicate = 0xf1000c, +
                                                +  pasteReplace = 0xf1000d, +toFront = 0xf2000a, +toBack = 0xf2000b, +zoomIn = 0xf20013, +
                                                +  zoomOut = 0xf20014, +zoomNormal = 0xf20015, +editModeSwitch = 0xf20100, +gridModeSwitch = 0xf20200, +
                                                +  enableSnapToGrid = 0xf20201, +newBox = 0xf30300, +newMessage = 0xf30301, +newFlonum = 0xf30302, +
                                                +  newNumber = 0xf30303, +newComment = 0xf30304, +newBang = 0xf30305, +newToggle = 0xf30306, +
                                                +  newSlider = 0xf30307, +showPatcherInspector = 0xf20400, +showObjectInspector = 0xf20410, +openObjectHelp = 0xf20411, +
                                                +  switchDsp = 0xf20420, +startDsp = 0xf20421, +stopDsp = 0xf20422, +scrollToTop = 0xf30001, +
                                                +  scrollToBottom = 0xf30002, +clearAll = 0xf40001, +login = 0xf50000, +signup = 0xf50010, +
                                                +  logout = 0xf50020, +remember_me = 0xf50030 +
                                                + }
                                                 
                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

                                                +Functions

                                                +StoredSettings & getAppSettings ()
                                                 
                                                +juce::PropertiesFile & getGlobalProperties ()
                                                 
                                                +juce::PropertiesFile::Options getPropertyFileOptionsFor (juce::String const &filename, juce::String const &suffix)
                                                 
                                                +bool saveJsonToFile (juce::String const &filename, json const &j)
                                                 
                                                +json getJsonFromFile (juce::String const &filename)
                                                 
                                                +void to_json (json &j, Api::User const &user)
                                                 Helper function to convert an Api::User into a json object.
                                                 
                                                +void from_json (json const &j, Api::User &user)
                                                 Helper function to convert a json object into an Api::User.
                                                 
                                                +void to_json (json &j, Api::AuthUser const &user)
                                                 Helper function to convert an Api::AuthUser into a json object.
                                                 
                                                +void from_json (json const &j, Api::AuthUser &user)
                                                 Helper function to convert a json object into an Api::AuthUser.
                                                 
                                                +void to_json (json &j, Api::Document const &doc)
                                                 Helper function to convert an Api::Document into a json object.
                                                 
                                                +void from_json (json const &j, Api::Document &doc)
                                                 Helper function to convert a json object into an Api::Document.
                                                 
                                                +ObjectFrame::Outline::Border operator| (ObjectFrame::Outline::Border const &l_border, ObjectFrame::Outline::Border const &r_border)
                                                 
                                                +

                                                Detailed Description

                                                +
                                                Todo:
                                                Clean flip headers below, use only needed one in this file
                                                +

                                                Enumeration Type Documentation

                                                + +
                                                +
                                                + + + + +
                                                enum kiwi::CommandIDs
                                                +
                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                Enumerator
                                                newPatcher  +

                                                Create a new blank patcher window.

                                                +
                                                newPatcherView  +

                                                Create a new patcher view.

                                                +
                                                openFile  +

                                                Open a file in a new window.

                                                +
                                                closePatcher  +

                                                Close the current patcher.

                                                +
                                                save  +

                                                Save the current patcher document.

                                                +
                                                saveAs  +

                                                Save the current patcher document as.

                                                +
                                                minimizeWindow  +

                                                Reduce the current window.

                                                +
                                                maximizeWindow  +

                                                Maximise the current window.

                                                +
                                                closeWindow  +

                                                Close the current window.

                                                +
                                                showConsoleWindow  +

                                                Make visible the "console" window.

                                                +
                                                showAudioStatusWindow  +

                                                Make visible the "audio status" window.

                                                +
                                                showAboutAppWindow  +

                                                Make visible the "about app" window.

                                                +
                                                showAppSettingsWindow  +

                                                Make visible the "application settings" window.

                                                +
                                                showDocumentBrowserWindow  +

                                                Make visible the "document browser" window.

                                                +
                                                showBeaconDispatcherWindow  +

                                                Make visible the "beacon dispatcher" window.

                                                +
                                                addBeaconDispatcher  +

                                                Add a new "beacon dispatcher" element.

                                                +
                                                removeBeaconDispatcher  +

                                                Remove a "beacon dispatcher" element.

                                                +
                                                undo  +

                                                Undo last action.

                                                +
                                                redo  +

                                                Redo last action.

                                                +
                                                duplicate  +

                                                Duplicate selected objects and paste them on patcher.

                                                +
                                                pasteReplace  +

                                                Replace an objects by the one in the clipboard.

                                                +
                                                toFront  +

                                                Move selected object ahead of all other objects.

                                                +
                                                toBack  +

                                                Move selected object behind all other objects.

                                                +
                                                zoomIn  +

                                                Magnify the patcher view of almost 10%.

                                                +
                                                zoomOut  +

                                                Reduce the patcher view of almost 10%.

                                                +
                                                zoomNormal  +

                                                Restore the patcher view zoom to 100%.

                                                +
                                                editModeSwitch  +

                                                Toggle Lock/Unlock patcher view.

                                                +
                                                gridModeSwitch  +

                                                Toggle grid patcher mode.

                                                +
                                                enableSnapToGrid  +

                                                Toggle snap to grid patcher mode.

                                                +
                                                newBox  +

                                                Add a new "box" to the patcher.

                                                +
                                                newMessage  +

                                                Add a new "message" object box to the patcher.

                                                +
                                                newFlonum  +

                                                Add a new "flonum" object box to the patcher.

                                                +
                                                newNumber  +

                                                Add a new "number" object box to the patcher.

                                                +
                                                newComment  +

                                                Add a new "comment" object box to the patcher.

                                                +
                                                newBang  +

                                                Add a new "button" object box to the patcher.

                                                +
                                                newToggle  +

                                                Add a new "toggle" object box to the patcher.

                                                +
                                                newSlider  +

                                                Add a new "slider" object box to the patcher.

                                                +
                                                showPatcherInspector  +

                                                Shows the patcher properties inspector.

                                                +
                                                showObjectInspector  +

                                                Shows the selected objects properties inspector.

                                                +
                                                openObjectHelp  +

                                                Open selected object help patcher.

                                                +
                                                switchDsp  +

                                                Toggle DSP state.

                                                +
                                                startDsp  +

                                                Starts the dsp.

                                                +
                                                stopDsp  +

                                                Stops the dsp.

                                                +
                                                scrollToTop  +

                                                Scroll to the top.

                                                +
                                                scrollToBottom  +

                                                Scroll to the bottom.

                                                +
                                                clearAll  +

                                                Clear all content.

                                                +
                                                login  +

                                                Log-in the user.

                                                +
                                                signup  +

                                                Register the user.

                                                +
                                                logout  +

                                                Log-out the user.

                                                +
                                                remember_me  +

                                                Toggle the "remember me" option to save user profile.

                                                +
                                                + +
                                                +
                                                + +
                                                +
                                                + + + + + +
                                                + + + + +
                                                enum kiwi::WindowId : std::size_t
                                                +                                                 		+strong
                                                +
                                                + +

                                                Singleton application window's ids.

                                                +
                                                See also
                                                Instance::showWindowWithId
                                                + +
                                                +
                                                +
                                                + +
                                                +Generated by   +doxygen + 1.8.11 +
                                                + + diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html new file mode 100644 index 00000000..20d9c6a6 --- /dev/null +++ b/docs/html/namespacemembers.html @@ -0,0 +1,353 @@ + + + + + + +Kiwi: Namespace Members + + + + + + + + + + +
                                                +
                                                + + + + + + +
                                                +
                                                Kiwi +
                                                +
                                                +
                                                + + + + + + + +
                                                + +
                                                +
                                                + + +
                                                + +
                                                + +
                                                +
                                                Here is a list of all documented namespace members with links to the namespaces they belong to:
                                                + +

                                                - a -

                                                  +
                                                • addBeaconDispatcher +: kiwi +
                                                  • +
                                                + + +

                                                - c -

                                                  +
                                                • clearAll +: kiwi +
                                                  • +
                                                • closePatcher +: kiwi +
                                                  • +
                                                • closeWindow +: kiwi +
                                                  • +
                                                • CommandIDs +: kiwi +
                                                  • +
                                                + + +

                                                - d -

                                                  +
                                                • duplicate +: kiwi +
                                                  • +
                                                + + +

                                                - e -

                                                  +
                                                • editModeSwitch +: kiwi +
                                                  • +
                                                • enableSnapToGrid +: kiwi +
                                                  • +
                                                + + +

                                                - f -

                                                  +
                                                • from_json() +: kiwi +
                                                  • +
                                                + + +

                                                - g -

                                                  +
                                                • gridModeSwitch +: kiwi +
                                                  • +
                                                + + +

                                                - l -

                                                + + +

                                                - m -

                                                  +
                                                • maximizeWindow +: kiwi +
                                                  • +
                                                • minimizeWindow +: kiwi +
                                                  • +
                                                + + +

                                                - n -

                                                  +
                                                • newBang +: kiwi +
                                                  • +
                                                • newBox +: kiwi +
                                                  • +
                                                • newComment +: kiwi +
                                                  • +
                                                • newFlonum +: kiwi +
                                                  • +
                                                • newMessage +: kiwi +
                                                  • +
                                                • newNumber +: kiwi +
                                                  • +
                                                • newPatcher +: kiwi +
                                                  • +
                                                • newPatcherView +: kiwi +
                                                  • +
                                                • newSlider +: kiwi +
                                                  • +
                                                • newToggle +: kiwi +
                                                  • +
                                                + + +

                                                - o -

                                                  +
                                                • openFile +: kiwi +
                                                  • +
                                                • openObjectHelp +: kiwi +
                                                  • +
                                                + + +

                                                - p -

                                                  +
                                                • pasteReplace +: kiwi +
                                                  • +
                                                + + +

                                                - r -

                                                  +
                                                • redo +: kiwi +
                                                  • +
                                                • remember_me +: kiwi +
                                                  • +
                                                • removeBeaconDispatcher +: kiwi +
                                                  • +
                                                + + +

                                                - s -

                                                  +
                                                • save +: kiwi +
                                                  • +
                                                • saveAs +: kiwi +
                                                  • +
                                                • scrollToBottom +: kiwi +
                                                  • +
                                                • scrollToTop +: kiwi +
                                                  • +
                                                • showAboutAppWindow +: kiwi +
                                                  • +
                                                • showAppSettingsWindow +: kiwi +
                                                  • +
                                                • showAudioStatusWindow +: kiwi +
                                                  • +
                                                • showBeaconDispatcherWindow +: kiwi +
                                                  • +
                                                • showConsoleWindow +: kiwi +
                                                  • +
                                                • showDocumentBrowserWindow +: kiwi +
                                                  • +
                                                • showObjectInspector +: kiwi +
                                                  • +
                                                • showPatcherInspector +: kiwi +
                                                  • +
                                                • signup +: kiwi +
                                                  • +
                                                • startDsp +: kiwi +
                                                  • +
                                                • stopDsp +: kiwi +
                                                  • +
                                                • switchDsp +: kiwi +
                                                  • +
                                                + + +

                                                - t -

                                                  +
                                                • to_json() +: kiwi +
                                                  • +
                                                • toBack +: kiwi +
                                                  • +
                                                • toFront +: kiwi +
                                                  • +
                                                + + +

                                                - u -

                                                + + +

                                                - w -

                                                  +
                                                • WindowId +: kiwi +
                                                  • +
                                                + + +

                                                - z -

                                                  +
                                                • zoomIn +: kiwi +
                                                  • +
                                                • zoomNormal +: kiwi +
                                                  • +
                                                • zoomOut +: kiwi +
                                                  • +
                                                +
                                                + +
                                                +Generated by   +doxygen + 1.8.11 +
                                                + + diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html new file mode 100644 index 00000000..ec6bdcf3 --- /dev/null +++ b/docs/html/namespacemembers_enum.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Namespace Members + + + + + + + + + + +
                                                +
                                                + + + + + + +
                                                +
                                                Kiwi +
                                                +
                                                +
                                                + + + + + + +
                                                + +
                                                +
                                                + + +
                                                + +
                                                + +
                                                + 
                                                  +
                                                • CommandIDs +: kiwi +
                                                  • +
                                                • WindowId +: kiwi +
                                                  • +
                                                +
                                                + +
                                                +Generated by   +doxygen + 1.8.11 +
                                                + + diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html new file mode 100644 index 00000000..55e02899 --- /dev/null +++ b/docs/html/namespacemembers_eval.html @@ -0,0 +1,331 @@ + + + + + + +Kiwi: Namespace Members + + + + + + + + + + +
                                                +
                                                + + + + + + +
                                                +
                                                Kiwi +
                                                +
                                                +
                                                + + + + + + + +
                                                + +
                                                +
                                                + + +
                                                + +
                                                + +
                                                +  + +

                                                - a -

                                                  +
                                                • addBeaconDispatcher +: kiwi +
                                                  • +
                                                + + +

                                                - c -

                                                  +
                                                • clearAll +: kiwi +
                                                  • +
                                                • closePatcher +: kiwi +
                                                  • +
                                                • closeWindow +: kiwi +
                                                  • +
                                                + + +

                                                - d -

                                                  +
                                                • duplicate +: kiwi +
                                                  • +
                                                + + +

                                                - e -

                                                  +
                                                • editModeSwitch +: kiwi +
                                                  • +
                                                • enableSnapToGrid +: kiwi +
                                                  • +
                                                + + +

                                                - g -

                                                  +
                                                • gridModeSwitch +: kiwi +
                                                  • +
                                                + + +

                                                - l -

                                                + + +

                                                - m -

                                                  +
                                                • maximizeWindow +: kiwi +
                                                  • +
                                                • minimizeWindow +: kiwi +
                                                  • +
                                                + + +

                                                - n -

                                                  +
                                                • newBang +: kiwi +
                                                  • +
                                                • newBox +: kiwi +
                                                  • +
                                                • newComment +: kiwi +
                                                  • +
                                                • newFlonum +: kiwi +
                                                  • +
                                                • newMessage +: kiwi +
                                                  • +
                                                • newNumber +: kiwi +
                                                  • +
                                                • newPatcher +: kiwi +
                                                  • +
                                                • newPatcherView +: kiwi +
                                                  • +
                                                • newSlider +: kiwi +
                                                  • +
                                                • newToggle +: kiwi +
                                                  • +
                                                + + +

                                                - o -

                                                  +
                                                • openFile +: kiwi +
                                                  • +
                                                • openObjectHelp +: kiwi +
                                                  • +
                                                + + +

                                                - p -

                                                  +
                                                • pasteReplace +: kiwi +
                                                  • +
                                                + + +

                                                - r -

                                                  +
                                                • redo +: kiwi +
                                                  • +
                                                • remember_me +: kiwi +
                                                  • +
                                                • removeBeaconDispatcher +: kiwi +
                                                  • +
                                                + + +

                                                - s -

                                                  +
                                                • save +: kiwi +
                                                  • +
                                                • saveAs +: kiwi +
                                                  • +
                                                • scrollToBottom +: kiwi +
                                                  • +
                                                • scrollToTop +: kiwi +
                                                  • +
                                                • showAboutAppWindow +: kiwi +
                                                  • +
                                                • showAppSettingsWindow +: kiwi +
                                                  • +
                                                • showAudioStatusWindow +: kiwi +
                                                  • +
                                                • showBeaconDispatcherWindow +: kiwi +
                                                  • +
                                                • showConsoleWindow +: kiwi +
                                                  • +
                                                • showDocumentBrowserWindow +: kiwi +
                                                  • +
                                                • showObjectInspector +: kiwi +
                                                  • +
                                                • showPatcherInspector +: kiwi +
                                                  • +
                                                • signup +: kiwi +
                                                  • +
                                                • startDsp +: kiwi +
                                                  • +
                                                • stopDsp +: kiwi +
                                                  • +
                                                • switchDsp +: kiwi +
                                                  • +
                                                + + +

                                                - t -

                                                + + +

                                                - u -

                                                + + +

                                                - z -

                                                  +
                                                • zoomIn +: kiwi +
                                                  • +
                                                • zoomNormal +: kiwi +
                                                  • +
                                                • zoomOut +: kiwi +
                                                  • +
                                                +
                                                + +
                                                +Generated by   +doxygen + 1.8.11 +
                                                + + diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html new file mode 100644 index 00000000..1db0ae4f --- /dev/null +++ b/docs/html/namespacemembers_func.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Namespace Members + + + + + + + + + + +
                                                +
                                                + + + + + + +
                                                +
                                                Kiwi +
                                                +
                                                +
                                                + + + + + + +
                                                + +
                                                +
                                                + + +
                                                + +
                                                + +
                                                + 
                                                  +
                                                • from_json() +: kiwi +
                                                  • +
                                                • to_json() +: kiwi +
                                                  • +
                                                +
                                                + +
                                                +Generated by   +doxygen + 1.8.11 +
                                                + + diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html new file mode 100644 index 00000000..64d5933b --- /dev/null +++ b/docs/html/namespaces.html @@ -0,0 +1,103 @@ + + + + + + +Kiwi: Namespace List + + + + + + + + + + +
                                                +
                                                + + + + + + +
                                                +
                                                Kiwi +
                                                +
                                                +
                                                + + + + + +
                                                + +
                                                +
                                                + + +
                                                + +
                                                + +
                                                +
                                                +
                                                Namespace List
                                                +
                                                +
                                                +
                                                Here is a list of all documented namespaces with brief descriptions:
                                                + + +
                                                 Nkiwi
                                                +
                                                +
                                                + +
                                                +Generated by   +doxygen + 1.8.11 +
                                                + + diff --git a/docs/html/pages.html b/docs/html/pages.html index 9e834477..27e37f07 100644 --- a/docs/html/pages.html +++ b/docs/html/pages.html @@ -3,8 +3,7 @@ - - + Kiwi: Related Pages @@ -12,6 +11,9 @@ + @@ -29,19 +31,36 @@ - + - - - - + - + - - - - + +
                                              @@ -79,7 +106,7 @@
                                              Generated by   doxygen - 1.8.13 + 1.8.11
                                              diff --git a/docs/html/structkiwi_1_1_document_browser_1_1_drive_1_1_listener.html b/docs/html/structkiwi_1_1_document_browser_1_1_drive_1_1_listener.html index d142e274..608f4e5a 100644 --- a/docs/html/structkiwi_1_1_document_browser_1_1_drive_1_1_listener.html +++ b/docs/html/structkiwi_1_1_document_browser_1_1_drive_1_1_listener.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::DocumentBrowser::Drive::Listener Struct Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                                              - + - - - - + +
                                            @@ -87,23 +114,23 @@ - - - - - @@ -118,7 +145,7 @@
                                            Generated by   doxygen - 1.8.13 + 1.8.11
                                            diff --git a/docs/html/structkiwi_1_1_editable_object_view_1_1_listener-members.html b/docs/html/structkiwi_1_1_editable_object_view_1_1_listener-members.html new file mode 100644 index 00000000..8c177038 --- /dev/null +++ b/docs/html/structkiwi_1_1_editable_object_view_1_1_listener-members.html @@ -0,0 +1,111 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
                                            +
                                            +

                                            Public Member Functions

                                            +
                                            virtual ~Listener ()=default
                                             Destructor.
                                             
                                            +
                                            virtual void documentAdded (DocumentBrowser::Drive::DocumentSession &doc)
                                             Called when a document session has been added.
                                             
                                            +
                                            virtual void documentChanged (DocumentBrowser::Drive::DocumentSession &doc)
                                             Called when a document session changed.
                                             
                                            +
                                            virtual void documentRemoved (DocumentBrowser::Drive::DocumentSession &doc)
                                             Called when a document session has been removed.
                                             
                                            +
                                            virtual void driveChanged ()
                                             Called when one or more documents has been added, removed or changed.
                                             
                                            + + + + + +
                                            +
                                            Kiwi +
                                            +
                                            +
                                            + + + + + + +
                                            +
                                            + + +
                                            + +
                                            + + + +
                                            +
                                            +
                                            kiwi::EditableObjectView::Listener Member List
                                            +
                                            +
                                            + +

                                            This is the complete list of members for kiwi::EditableObjectView::Listener, including all inherited members.

                                            + + + + + +
                                            editorHidden()=0kiwi::EditableObjectView::Listenerpure virtual
                                            editorShown()=0kiwi::EditableObjectView::Listenerpure virtual
                                            textChanged(std::string const &new_text)=0kiwi::EditableObjectView::Listenerpure virtual
                                            ~Listener()=defaultkiwi::EditableObjectView::Listenervirtual
                                            + +
                                            +Generated by   +doxygen + 1.8.11 +
                                            + + diff --git a/docs/html/structkiwi_1_1_editable_object_view_1_1_listener.html b/docs/html/structkiwi_1_1_editable_object_view_1_1_listener.html new file mode 100644 index 00000000..4950b1cd --- /dev/null +++ b/docs/html/structkiwi_1_1_editable_object_view_1_1_listener.html @@ -0,0 +1,139 @@ + + + + + + +Kiwi: kiwi::EditableObjectView::Listener Struct Reference + + + + + + + + + + +
                                            +
                                            + + + + + + +
                                            +
                                            Kiwi +
                                            +
                                            +
                                            + + + + + + +
                                            +
                                            + + +
                                            + +
                                            + + +
                                            +
                                            +
                                            +Public Member Functions | +List of all members
                                            +
                                            +
                                            kiwi::EditableObjectView::Listener Struct Referenceabstract
                                            +
                                            +
                                            +
                                            +Inheritance diagram for kiwi::EditableObjectView::Listener:
                                            +
                                            +
                                            + + +kiwi::ObjectFrame + +
                                            + + + + + + + + + + + + + + +

                                            +Public Member Functions

                                            +virtual ~Listener ()=default
                                             Destructor.
                                             
                                            +virtual void textChanged (std::string const &new_text)=0
                                             Called when the text has been edited and return key was pressed.
                                             
                                            +virtual void editorHidden ()=0
                                             Called when the classic view ends its edition.
                                             
                                            +virtual void editorShown ()=0
                                             Called when the classic view enters its edition mode.
                                             
                                            +
                                            The documentation for this struct was generated from the following file: +
                                            + +
                                            +Generated by   +doxygen + 1.8.11 +
                                            + + diff --git a/docs/html/structkiwi_1_1_editable_object_view_1_1_listener.png b/docs/html/structkiwi_1_1_editable_object_view_1_1_listener.png new file mode 100644 index 0000000000000000000000000000000000000000..2c7960100e8b34b701fef46d72dafb34080cf732 GIT binary patch literal 751 zcmeAS@N?(olHy`uVBq!ia0vp^CxAGBgBeI>Z$8xoq$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IZ0>O5T>Ln;{G&b{4tSb@jIpKay;|0j3v zY~=m2uk*%<++~VpjC?oVX3wOhjq`u*djI+G zKexQMheP!~$IV=tyuxh7o|N=6$uAlPs`856|sXEzjq~yMon*YBs^O|c>{;{5y zj^8F^T$^9KKjj8B=|7H*IhK7S}gp)mH`gTOBL8?l#L*ibaK< zyD9j|@L9;6tP`KsdQJW*|1xZ?(2=Q^{j(pPn5q~5#!7*q{l$xq%q$Oh=N>6M)X6Ys z0VpIGnG7a9t6!TrYuSJOhQp=IJDS!p7442~d7`DTU*@{PP9BdC-G+@K3Jl7c4h(KV zumA*UV`52AVdXgB!6ncz5lulwsOHj=EqOp@~khU(A02rJ_YSR<=PbUyXyM1)R?-ttXTp5AtyayIT-dhWY0hn`AC{qvK)^w}}re7rnvzx_nMj+27Yizlb7PjtLi zT0Px!#ogCc-j}R@X>FP2#`(@&{nCz2C%^vQBUCf>O+U0B~#^Z(~>EdSidkU YaA@7W6~A)_Fm*C`y85}Sb4q9e0O#ph - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
                                          @@ -78,7 +105,7 @@
                                          Generated by   doxygen - 1.8.13 + 1.8.11
                                          diff --git a/docs/html/structkiwi_1_1_kiwi_app_1_1_main_menu_model.html b/docs/html/structkiwi_1_1_kiwi_app_1_1_main_menu_model.html index 3555b90a..7cd2f71d 100644 --- a/docs/html/structkiwi_1_1_kiwi_app_1_1_main_menu_model.html +++ b/docs/html/structkiwi_1_1_kiwi_app_1_1_main_menu_model.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::KiwiApp::MainMenuModel Struct Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                                          - + - - - - + +
                                        @@ -85,13 +112,13 @@ - - -

                                        Public Member Functions

                                        +
                                        juce::StringArray getMenuBarNames ()
                                         
                                        +
                                        juce::PopupMenu getMenuForIndex (int topLevelMenuIndex, const juce::String &menuName)
                                         
                                        +
                                        void menuItemSelected (int menuItemID, int topLevelMenuIndex)
                                         
                                        @@ -106,7 +133,7 @@
                                        Generated by   doxygen - 1.8.13 + 1.8.11
                                        diff --git a/docs/html/structkiwi_1_1_network_settings_1_1_listener-members.html b/docs/html/structkiwi_1_1_network_settings_1_1_listener-members.html index 2d5573c9..8ec17802 100644 --- a/docs/html/structkiwi_1_1_network_settings_1_1_listener-members.html +++ b/docs/html/structkiwi_1_1_network_settings_1_1_listener-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                                        - + - - - - + +
                                      @@ -76,7 +103,7 @@
                                      Generated by   doxygen - 1.8.13 + 1.8.11
                                      diff --git a/docs/html/structkiwi_1_1_network_settings_1_1_listener.html b/docs/html/structkiwi_1_1_network_settings_1_1_listener.html index c3c59628..54189c2a 100644 --- a/docs/html/structkiwi_1_1_network_settings_1_1_listener.html +++ b/docs/html/structkiwi_1_1_network_settings_1_1_listener.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::NetworkSettings::Listener Struct Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                                      - + - - - - + +
                                    @@ -80,19 +107,19 @@
                                    -kiwi::DocumentBrowser +kiwi::KiwiApp
                                    - - - +

                                    Public Member Functions

                                    +
                                    virtual ~Listener ()=default
                                     Destructor.
                                     
                                    +
                                    virtual void networkSettingsChanged (NetworkSettings const &, juce::Identifier const &)=0
                                     Called when a document session has been added.
                                     Called when the network settings has changed.
                                     

                                    Detailed Description

                                    @@ -105,7 +132,7 @@
                                    Generated by   doxygen - 1.8.13 + 1.8.11
                                    diff --git a/docs/html/structkiwi_1_1_network_settings_1_1_listener.png b/docs/html/structkiwi_1_1_network_settings_1_1_listener.png index 69a9271920c09e8fc2b41097ec0b3c08b11683eb..7dbdcd1854947b20a1195fd1fc64e610c4513c47 100644 GIT binary patch delta 620 zcmZo++sis3rryWX#WAFU@$KB#n-(hwu+8pYwdcQbz6}?j`1zwbYOYu3EWOH*W!$s5 z-cxhwRRzX1t{%)40+$%%LSFt&2@hERd*SNTY3jN2x4*q3ePGV92eY5YdouI9;oCn| zPW`{i#s2@EzgFkkm!CP6{rp+I%cln%ug#WoXU*Mn{p$0?`IR<#^&Czwb-%y$w|%!# z|K$?@t5sLmE}3_0>ecPCfp*IC9^`D+-hGB;+g9V*t@AFWM*mKCH0pJ^-Ok`Zwhsx~ ze>InG5o5@I#JE99+sj^#J8Heg-;%iVRh}!ttbC<&XL={-poI(+4PV6D!EA| zlbye|&XT<}>5H+qm-nS?kedW9O?q-L*y{Nl@yGIkkJN4-S$l930}yz+`njxgN@xNA DR8B9% delta 692 zcmV;l0!#h91%w8WTz`{EL_t(|0qvdbj=f8=t%( zeFVN_Mgm(#=`(No#ESz@r-`)P{4+OtX%iCDXiS!iO}8D!)53wKRJb#yloSvk|RW4mb+J9k?OtGhj^*0~3+syW6J1qR3nA782M9T$tg!ofy zA`KA5U#AS0c8Le@0r8P`|KtJQ=f9)}z+YI>01+%{fC#puKc$rJ1;Ceh0Njl`NP`(f|=GX@CfpG(ZGP8X$rt z4G_VS28duu1E%Dh^LKdUoby*8OVYhq(vlRxl9r?hUP&kOYiqWf?N5^4;o0G%ev;() zSz3|?_E+!DzDa-5Pm&xzNbhBvq|hQ=e~-wO%fa5zRd1K=zDk!Sd$s9j`qXGXWOr=)dr#)y|$2~2`{D3DLPjhX=7_6?FCHrnbU4x`bbnHX~LJK zi=(TSk{o7zN50imlcWj1Nss-e<>{M|?yIFFM;+Y_^|`dmF?ZyRTU>)HB~!Y$6X`MP ze@c(;LmBtIKRw#_S2x@r4lbwLIZ>axT1lF){w + + + + + +Kiwi: Member List + + + + + + + + + + +
                                    +
                                    + + + + + + +
                                    +
                                    Kiwi +
                                    +
                                    +
                                    + + + + + + +
                                    +
                                    + + +
                                    + +
                                    + + +
                                    +
                                    +
                                    +
                                    kiwi::ObjectFrame::Outline Member List
                                    +
                                    +
                                    + +

                                    This is the complete list of members for kiwi::ObjectFrame::Outline, including all inherited members.

                                    + + + + + + + + + +
                                    Border enum name (defined in kiwi::ObjectFrame::Outline)kiwi::ObjectFrame::Outline
                                    getBorderThickness() const kiwi::ObjectFrame::Outline
                                    getResizeLength() const kiwi::ObjectFrame::Outline
                                    hitTest(juce::Point< int > const &pt, HitTester &hit_tester) const kiwi::ObjectFrame::Outline
                                    Outline(int resize_length, int resize_thickness, int inner_thickness)kiwi::ObjectFrame::Outline
                                    setInnerColour(juce::Colour colour)kiwi::ObjectFrame::Outline
                                    setResizeColour(juce::Colour colour)kiwi::ObjectFrame::Outline
                                    ~Outline() (defined in kiwi::ObjectFrame::Outline)kiwi::ObjectFrame::Outline
                                    + +
                                    +Generated by   +doxygen + 1.8.11 +
                                    + + diff --git a/docs/html/structkiwi_1_1_object_frame_1_1_outline.html b/docs/html/structkiwi_1_1_object_frame_1_1_outline.html new file mode 100644 index 00000000..e9b74969 --- /dev/null +++ b/docs/html/structkiwi_1_1_object_frame_1_1_outline.html @@ -0,0 +1,192 @@ + + + + + + +Kiwi: kiwi::ObjectFrame::Outline Struct Reference + + + + + + + + + + +
                                    +
                                    + + + + + + +
                                    +
                                    Kiwi +
                                    +
                                    +
                                    + + + + + + +
                                    +
                                    + + +
                                    + +
                                    + + +
                                    +
                                    +
                                    +Public Types | +Public Member Functions | +List of all members
                                    +
                                    +
                                    kiwi::ObjectFrame::Outline Struct Reference
                                    +
                                    +
                                    +
                                    +Inheritance diagram for kiwi::ObjectFrame::Outline:
                                    +
                                    +
                                    + + + +
                                    + + + + +

                                    +Public Types

                                    enum  Border : int { Top = 1 << 0, +Bottom = 1 << 1, +Left = 1 << 2, +Right = 1 << 3 + }
                                     
                                    + + + + + + + + + + + + + + + + + + + +

                                    +Public Member Functions

                                     Outline (int resize_length, int resize_thickness, int inner_thickness)
                                     Constructor. More...
                                     
                                    +bool hitTest (juce::Point< int > const &pt, HitTester &hit_tester) const
                                     Tests if the point reaches an interactive resiable corner.
                                     
                                    +int getBorderThickness () const
                                     Returns the corner border width.
                                     
                                    +int getResizeLength () const
                                     Returns the corner border length.
                                     
                                    +void setResizeColour (juce::Colour colour)
                                     Sets the corner colour.
                                     
                                    +void setInnerColour (juce::Colour colour)
                                     Sets the inner border colour.
                                     
                                    +

                                    Constructor & Destructor Documentation

                                    + +
                                    +
                                    + + + + + + + + + + + + + + + + + + + + + + + + +
                                    kiwi::ObjectFrame::Outline::Outline (int resize_length,
                                    int resize_thickness,
                                    int inner_thickness 
                                    )
                                    +
                                    + +

                                    Constructor.

                                    +

                                    Defines the resizable corner size, its thickness and the inner border thickness?

                                    + +
                                    +
                                    +
                                    The documentation for this struct was generated from the following files:
                                      +
                                    • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectFrame.h
                                      • +
                                    • Client/Source/KiwiApp_Patcher/KiwiApp_Objects/KiwiApp_ObjectFrame.cpp
                                      • +
                                    +
                                    + +
                                    +Generated by   +doxygen + 1.8.11 +
                                    + + diff --git a/docs/html/structkiwi_1_1_object_frame_1_1_outline.png b/docs/html/structkiwi_1_1_object_frame_1_1_outline.png new file mode 100644 index 0000000000000000000000000000000000000000..317bf147dbdf1d088fb0e70fde6858022cad7b1d GIT binary patch literal 602 zcmeAS@N?(olHy`uVBq!ia0vp^^ME*jgBeKP-)Ykeq$C1-LR|m<{|{uoc=NTi|Ih>= z3ycpOIKbL@M;^%KC<*clW&kPzfvcxNj2IXgUwXPYhEy=VoqM-$wE+*?ar3|T{`dNO zHvBm_ZC9+w+^tgt6(!O+4DTeRnd#3^IqUVpbJFw+lU4NP_AXtd^0M~czOxIb=Y9Bj zcR~20&q}w9HkEDqX=XEL@BUZvFP>&jube*3>gbn0K9lr5v+i9LYw2+*wJuiw`o%3( zwQE#jpEsY9{jzRvvgfWd>i74q)%bpmH~rOSX|3={d_Q~d`-7~~f8}{;JEyJZC!wlI zPoAz!PczeHxc`LFK)?94tz7W$vunR^nSC?AXzz*`2K$BV4^+P}>}io}n0|rzgHRPi zoD=^6?-z^}oVE=5NRsx;fX3)c99RQYx#{&&=eJQ`gL$VeeAqdUIeQ`Fo+aHe@9aFP z7O)#^T0NI_ZYsOP%K2Z8-rX9PHQV*;wbvbAZgiH~PIvxX>vgxrwEX*q<`T=NV%wLk zU!=WPDRjAB|FpEV$7eZTT-|oLrZ!@I_*S*@)!TI|=RY%v&%gK1zh~KAA9I_}?o~IJ z?G1Um=53a6ZRmOzetq-OQ_Fs4er@yqec|Gs<< - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
                                  @@ -76,7 +103,7 @@
                                  Generated by   doxygen - 1.8.13 + 1.8.11
                                  diff --git a/docs/html/structkiwi_1_1_patcher_manager_1_1_listener.html b/docs/html/structkiwi_1_1_patcher_manager_1_1_listener.html index 15859b4a..c4b96c89 100644 --- a/docs/html/structkiwi_1_1_patcher_manager_1_1_listener.html +++ b/docs/html/structkiwi_1_1_patcher_manager_1_1_listener.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::PatcherManager::Listener Struct Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                                  - + - - - - + +
                                @@ -82,7 +109,7 @@ - @@ -95,7 +122,7 @@
                                Generated by   doxygen - 1.8.13 + 1.8.11
                                diff --git a/docs/html/structkiwi_1_1_spinner-members.html b/docs/html/structkiwi_1_1_spinner-members.html new file mode 100644 index 00000000..42bfdee0 --- /dev/null +++ b/docs/html/structkiwi_1_1_spinner-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
                                +
                                +

                                Public Member Functions

                                +
                                virtual void connectedUserChanged (PatcherManager &manager)
                                 Called when one or more users are connecting or disconnecting to the Patcher Document.
                                 
                                + + + + + +
                                +
                                Kiwi +
                                +
                                +
                                + + + + + + +
                                +
                                + + +
                                + +
                                + + + +
                                +
                                +
                                kiwi::Spinner Member List
                                +
                                +
                                + +

                                This is the complete list of members for kiwi::Spinner, including all inherited members.

                                + + + + +
                                paint(juce::Graphics &g) override (defined in kiwi::Spinner)kiwi::Spinnerinline
                                Spinner() (defined in kiwi::Spinner)kiwi::Spinnerinline
                                timerCallback() override (defined in kiwi::Spinner)kiwi::Spinnerinline
                                + +
                                +Generated by   +doxygen + 1.8.11 +
                                + + diff --git a/docs/html/structkiwi_1_1_spinner.html b/docs/html/structkiwi_1_1_spinner.html new file mode 100644 index 00000000..c93a8824 --- /dev/null +++ b/docs/html/structkiwi_1_1_spinner.html @@ -0,0 +1,128 @@ + + + + + + +Kiwi: kiwi::Spinner Struct Reference + + + + + + + + + + +
                                +
                                + + + + + + +
                                +
                                Kiwi +
                                +
                                +
                                + + + + + + +
                                +
                                + + +
                                + +
                                + + +
                                +
                                +
                                +Public Member Functions | +List of all members
                                +
                                +
                                kiwi::Spinner Struct Reference
                                +
                                +
                                +
                                +Inheritance diagram for kiwi::Spinner:
                                +
                                +
                                + + + +
                                + + + + + + +

                                +Public Member Functions

                                +void timerCallback () override
                                 
                                +void paint (juce::Graphics &g) override
                                 
                                +
                                The documentation for this struct was generated from the following file:
                                  +
                                • Client/Source/KiwiApp_Components/KiwiApp_FormComponent.cpp
                                  • +
                                +
                                + +
                                +Generated by   +doxygen + 1.8.11 +
                                + + diff --git a/docs/html/structkiwi_1_1_spinner.png b/docs/html/structkiwi_1_1_spinner.png new file mode 100644 index 0000000000000000000000000000000000000000..734dc91ccc11435e9947770a0ab7a3437f0637bc GIT binary patch literal 615 zcmeAS@N?(olHy`uVBq!ia0vp^8-O@~gBeKn>GHn=QW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;PbGvJLSdCpT)|y-aGeLZZ!NEw}&ko&2yo zt7gAB<`Pcr^g^qB9P{o(TU^FLl%-}zB? z=$tFN!K@qC7;HLum@9-N**>Tk@jN*B*T}~A@)NcL^M$xM4onsRincJ?a3(VNJ4wK~ zKSdJ-Cmv+@VfgQxBF_wthXQOlPi`-7md(z+KK1{_=U#~oyr2Eqb@YViJuaOUaZI=O z`O-hHFL}*8FC4HdMs-h?-dd5!Y`Z5b_?Mo3ev;|OG$XH>71C*<`sWixUN_I=WH8^= zBE8?uLj38`L#thXnPpe_S8Tq - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
                              @@ -78,7 +105,7 @@
                              Generated by   doxygen - 1.8.13 + 1.8.11
                              diff --git a/docs/html/structkiwi_1_1_suggest_list_1_1_options.html b/docs/html/structkiwi_1_1_suggest_list_1_1_options.html index 718f0747..14965a11 100644 --- a/docs/html/structkiwi_1_1_suggest_list_1_1_options.html +++ b/docs/html/structkiwi_1_1_suggest_list_1_1_options.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::SuggestList::Options Struct Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                              - + - - - - + +
                            @@ -77,18 +104,18 @@ - - - - @@ -103,7 +130,7 @@
                            Generated by   doxygen - 1.8.13 + 1.8.11
                            diff --git a/docs/html/structkiwi_1_1dsp_1_1_chain_1_1compare__proc-members.html b/docs/html/structkiwi_1_1dsp_1_1_chain_1_1compare__proc-members.html index 7bf63c46..21680ef0 100644 --- a/docs/html/structkiwi_1_1dsp_1_1_chain_1_1compare__proc-members.html +++ b/docs/html/structkiwi_1_1dsp_1_1_chain_1_1compare__proc-members.html @@ -3,8 +3,7 @@ - - +Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@

                            Public Attributes

                            +
                            int adjacency_bonus = 5
                             
                            +
                            int leading_letter_penalty = -9
                             For adjacent matches.
                             
                            +
                            int max_leading_letter_penalty = -9
                             For every letter in str before the first match.
                             
                            +
                            int unmatched_letter_penalty = -1
                             Maximum penalty for leading letters.
                             
                            - + - - - - + +
                          @@ -77,7 +104,7 @@
                          Generated by   doxygen - 1.8.13 + 1.8.11
                          diff --git a/docs/html/structkiwi_1_1dsp_1_1_chain_1_1compare__proc.html b/docs/html/structkiwi_1_1dsp_1_1_chain_1_1compare__proc.html index a12161fc..15170f3c 100644 --- a/docs/html/structkiwi_1_1dsp_1_1_chain_1_1compare__proc.html +++ b/docs/html/structkiwi_1_1dsp_1_1_chain_1_1compare__proc.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Chain::compare_proc Struct Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                          - + - - - - + +
                        @@ -73,17 +100,17 @@ - -

                        Public Member Functions

                        +
                         compare_proc (Processor const &proc)
                         
                        +
                        bool operator() (Node::uPtr const &node)
                         
                        - +

                        Public Attributes

                        -Processor const & m_proc
                        +Processor const & m_proc
                         
                        The documentation for this struct was generated from the following file:
                          @@ -94,7 +121,7 @@
                          Generated by   doxygen - 1.8.13 + 1.8.11
                          diff --git a/docs/html/structkiwi_1_1dsp_1_1_chain_1_1index__node-members.html b/docs/html/structkiwi_1_1dsp_1_1_chain_1_1index__node-members.html index 888f838e..e299af05 100644 --- a/docs/html/structkiwi_1_1dsp_1_1_chain_1_1index__node-members.html +++ b/docs/html/structkiwi_1_1dsp_1_1_chain_1_1index__node-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                        - + - - - - + +
                      @@ -79,7 +106,7 @@
                      Generated by   doxygen - 1.8.13 + 1.8.11
                      diff --git a/docs/html/structkiwi_1_1dsp_1_1_chain_1_1index__node.html b/docs/html/structkiwi_1_1dsp_1_1_chain_1_1index__node.html index c8fddd38..55d48fa9 100644 --- a/docs/html/structkiwi_1_1dsp_1_1_chain_1_1index__node.html +++ b/docs/html/structkiwi_1_1dsp_1_1_chain_1_1index__node.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Chain::index_node Struct Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                      - + - - - - + +
                    @@ -73,19 +100,19 @@ - -

                    Public Member Functions

                    +
                    void computeIndex (Node &node)
                     
                    +
                    void operator() (Node::uPtr const &node)
                     
                    - -

                    Public Attributes

                    +
                    size_t m_next_index
                     
                    +
                    std::set< Node * > m_loop_nodes
                     
                    @@ -97,7 +124,7 @@
                    Generated by   doxygen - 1.8.13 + 1.8.11
                    diff --git a/docs/html/structkiwi_1_1dsp_1_1_processor_1_1_prepare_info-members.html b/docs/html/structkiwi_1_1dsp_1_1_processor_1_1_prepare_info-members.html index caf34db4..9712cee0 100644 --- a/docs/html/structkiwi_1_1dsp_1_1_processor_1_1_prepare_info-members.html +++ b/docs/html/structkiwi_1_1dsp_1_1_processor_1_1_prepare_info-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                    - + - - - - + +
                  @@ -77,7 +104,7 @@
                  Generated by   doxygen - 1.8.13 + 1.8.11
                  diff --git a/docs/html/structkiwi_1_1dsp_1_1_processor_1_1_prepare_info.html b/docs/html/structkiwi_1_1dsp_1_1_processor_1_1_prepare_info.html index cceef15d..c46ed35e 100644 --- a/docs/html/structkiwi_1_1dsp_1_1_processor_1_1_prepare_info.html +++ b/docs/html/structkiwi_1_1dsp_1_1_processor_1_1_prepare_info.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::dsp::Processor::PrepareInfo Struct Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                  - + - - - - + +
                @@ -72,13 +99,13 @@ - - -

                Public Attributes

                +
                const size_t sample_rate
                 
                +
                const size_t vector_size
                 
                +
                const std::vector< bool > & inputs
                 
                @@ -90,7 +117,7 @@
                Generated by   doxygen - 1.8.13 + 1.8.11
                diff --git a/docs/html/structkiwi_1_1engine_1_1_ramp_1_1_value_time_pair-members.html b/docs/html/structkiwi_1_1engine_1_1_ramp_1_1_value_time_pair-members.html new file mode 100644 index 00000000..22edb8f1 --- /dev/null +++ b/docs/html/structkiwi_1_1engine_1_1_ramp_1_1_value_time_pair-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
                +
                + + + + + + +
                +
                Kiwi +
                +
                +
                + + + + + + +
                +
                + + +
                + +
                + + +
                +
                +
                +
                kiwi::engine::Ramp::ValueTimePair Member List
                +
                +
                + +

                This is the complete list of members for kiwi::engine::Ramp::ValueTimePair, including all inherited members.

                + + + + +
                time_ms (defined in kiwi::engine::Ramp::ValueTimePair)kiwi::engine::Ramp::ValueTimePair
                value (defined in kiwi::engine::Ramp::ValueTimePair)kiwi::engine::Ramp::ValueTimePair
                ValueTimePair(dsp::sample_t value_, dsp::sample_t time_ms_) (defined in kiwi::engine::Ramp::ValueTimePair)kiwi::engine::Ramp::ValueTimePairinline
                + +
                +Generated by   +doxygen + 1.8.11 +
                + + diff --git a/docs/html/structkiwi_1_1engine_1_1_ramp_1_1_value_time_pair.html b/docs/html/structkiwi_1_1engine_1_1_ramp_1_1_value_time_pair.html new file mode 100644 index 00000000..d6d029e1 --- /dev/null +++ b/docs/html/structkiwi_1_1engine_1_1_ramp_1_1_value_time_pair.html @@ -0,0 +1,127 @@ + + + + + + +Kiwi: kiwi::engine::Ramp::ValueTimePair Struct Reference + + + + + + + + + + +
                +
                + + + + + + +
                +
                Kiwi +
                +
                +
                + + + + + + +
                +
                + + +
                + +
                + + +
                +
                +
                +Public Member Functions | +Public Attributes | +List of all members
                +
                +
                kiwi::engine::Ramp::ValueTimePair Struct Reference
                +
                +
                + + + + +

                +Public Member Functions

                + ValueTimePair (dsp::sample_t value_, dsp::sample_t time_ms_)
                 
                + + + + + +

                +Public Attributes

                +dsp::sample_t value
                 
                +dsp::sample_t time_ms
                 
                +
                The documentation for this struct was generated from the following file: +
                + +
                +Generated by   +doxygen + 1.8.11 +
                + + diff --git a/docs/html/structkiwi_1_1model_1_1_factory_1_1is_valid_object-members.html b/docs/html/structkiwi_1_1model_1_1_factory_1_1is_valid_object-members.html index 040112ee..dd1e5216 100644 --- a/docs/html/structkiwi_1_1model_1_1_factory_1_1is_valid_object-members.html +++ b/docs/html/structkiwi_1_1model_1_1_factory_1_1is_valid_object-members.html @@ -3,8 +3,7 @@ - - + Kiwi: Member List @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@
                - + - - - - + +
              @@ -69,12 +96,13 @@

              This is the complete list of members for kiwi::model::Factory::isValidObject< TModel >, including all inherited members.

              +
              value enum value (defined in kiwi::model::Factory::isValidObject< TModel >)kiwi::model::Factory::isValidObject< TModel >
              Generated by   doxygen - 1.8.13 + 1.8.11
              diff --git a/docs/html/structkiwi_1_1model_1_1_factory_1_1is_valid_object.html b/docs/html/structkiwi_1_1model_1_1_factory_1_1is_valid_object.html index 80465710..1481c27b 100644 --- a/docs/html/structkiwi_1_1model_1_1_factory_1_1is_valid_object.html +++ b/docs/html/structkiwi_1_1model_1_1_factory_1_1is_valid_object.html @@ -3,8 +3,7 @@ - - + Kiwi: kiwi::model::Factory::isValidObject< TModel > Struct Template Reference @@ -12,6 +11,9 @@ + @@ -29,19 +31,44 @@ - + - - - - + +
            @@ -77,7 +104,8 @@ - +

            Public Types

            enum  
            enum  { value + }
             

            Detailed Description

            @@ -99,7 +127,7 @@
            Generated by   doxygen - 1.8.13 + 1.8.11
            diff --git a/docs/html/structkiwi_1_1network_1_1http_1_1_parameters_1_1_parameter-members.html b/docs/html/structkiwi_1_1network_1_1http_1_1_parameters_1_1_parameter-members.html new file mode 100644 index 00000000..0cee8e36 --- /dev/null +++ b/docs/html/structkiwi_1_1network_1_1http_1_1_parameters_1_1_parameter-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +
            kiwi::network::http::Parameters::Parameter Member List
            +
            +
            + +

            This is the complete list of members for kiwi::network::http::Parameters::Parameter, including all inherited members.

            + + + + +
            key (defined in kiwi::network::http::Parameters::Parameter)kiwi::network::http::Parameters::Parameter
            Parameter(KeyType &&key, ValueType &&value) (defined in kiwi::network::http::Parameters::Parameter)kiwi::network::http::Parameters::Parameter
            value (defined in kiwi::network::http::Parameters::Parameter)kiwi::network::http::Parameters::Parameter
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1network_1_1http_1_1_parameters_1_1_parameter.html b/docs/html/structkiwi_1_1network_1_1http_1_1_parameters_1_1_parameter.html new file mode 100644 index 00000000..cc75ddb6 --- /dev/null +++ b/docs/html/structkiwi_1_1network_1_1http_1_1_parameters_1_1_parameter.html @@ -0,0 +1,129 @@ + + + + + + +Kiwi: kiwi::network::http::Parameters::Parameter Struct Reference + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +Public Member Functions | +Public Attributes | +List of all members
            +
            +
            kiwi::network::http::Parameters::Parameter Struct Reference
            +
            +
            + + + + + +

            +Public Member Functions

            +template<typename KeyType , typename ValueType >
             Parameter (KeyType &&key, ValueType &&value)
             
            + + + + + +

            +Public Attributes

            +std::string key
             
            +std::string value
             
            +
            The documentation for this struct was generated from the following files: +
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1network_1_1http_1_1_payload_1_1_pair-members.html b/docs/html/structkiwi_1_1network_1_1http_1_1_payload_1_1_pair-members.html new file mode 100644 index 00000000..d870b44d --- /dev/null +++ b/docs/html/structkiwi_1_1network_1_1http_1_1_payload_1_1_pair-members.html @@ -0,0 +1,111 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +
            kiwi::network::http::Payload::Pair Member List
            +
            +
            + +

            This is the complete list of members for kiwi::network::http::Payload::Pair, including all inherited members.

            + + + + + +
            key (defined in kiwi::network::http::Payload::Pair)kiwi::network::http::Payload::Pair
            Pair(KeyType &&p_key, ValueType &&p_value) (defined in kiwi::network::http::Payload::Pair)kiwi::network::http::Payload::Pairinline
            Pair(KeyType &&p_key, const std::int32_t &p_value) (defined in kiwi::network::http::Payload::Pair)kiwi::network::http::Payload::Pairinline
            value (defined in kiwi::network::http::Payload::Pair)kiwi::network::http::Payload::Pair
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1network_1_1http_1_1_payload_1_1_pair.html b/docs/html/structkiwi_1_1network_1_1http_1_1_payload_1_1_pair.html new file mode 100644 index 00000000..e83ef348 --- /dev/null +++ b/docs/html/structkiwi_1_1network_1_1http_1_1_payload_1_1_pair.html @@ -0,0 +1,132 @@ + + + + + + +Kiwi: kiwi::network::http::Payload::Pair Struct Reference + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +Public Member Functions | +Public Attributes | +List of all members
            +
            +
            kiwi::network::http::Payload::Pair Struct Reference
            +
            +
            + + + + + + + + +

            +Public Member Functions

            +template<typename KeyType , typename ValueType , typename std::enable_if<!std::is_integral< ValueType >::value, bool >::type = true>
             Pair (KeyType &&p_key, ValueType &&p_value)
             
            +template<typename KeyType >
             Pair (KeyType &&p_key, const std::int32_t &p_value)
             
            + + + + + +

            +Public Attributes

            +std::string key
             
            +std::string value
             
            +
            The documentation for this struct was generated from the following file: +
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1tool_1_1_atom_helper-members.html b/docs/html/structkiwi_1_1tool_1_1_atom_helper-members.html new file mode 100644 index 00000000..c432f0b8 --- /dev/null +++ b/docs/html/structkiwi_1_1tool_1_1_atom_helper-members.html @@ -0,0 +1,111 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +
            kiwi::tool::AtomHelper Member List
            +
            +
            + +

            This is the complete list of members for kiwi::tool::AtomHelper, including all inherited members.

            + + + + + +
            parse(std::string const &text, int flags=0) (defined in kiwi::tool::AtomHelper)kiwi::tool::AtomHelperstatic
            toString(Atom const &atom, const bool add_quotes=true)kiwi::tool::AtomHelperstatic
            toString(std::vector< Atom > const &atoms, const bool add_quotes=true)kiwi::tool::AtomHelperstatic
            trimDecimal(std::string const &text) (defined in kiwi::tool::AtomHelper)kiwi::tool::AtomHelperstatic
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1tool_1_1_atom_helper.html b/docs/html/structkiwi_1_1tool_1_1_atom_helper.html new file mode 100644 index 00000000..ea0028f9 --- /dev/null +++ b/docs/html/structkiwi_1_1tool_1_1_atom_helper.html @@ -0,0 +1,179 @@ + + + + + + +Kiwi: kiwi::tool::AtomHelper Struct Reference + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +Classes | +Static Public Member Functions | +List of all members
            +
            +
            kiwi::tool::AtomHelper Struct Reference
            +
            +
            + +

            An Atom helper class. + More...

            + +

            #include <KiwiTool_Atom.h>

            + + + + +

            +Classes

            struct  ParsingFlags
             
            + + + + + + + + + + + +

            +Static Public Member Functions

            +static std::vector< Atom > parse (std::string const &text, int flags=0)
             
            +static std::string toString (Atom const &atom, const bool add_quotes=true)
             Convert an Atom into a string.
             
            static std::string toString (std::vector< Atom > const &atoms, const bool add_quotes=true)
             Convert a vector of Atom into a string. More...
             
            +static std::string trimDecimal (std::string const &text)
             
            +

            Detailed Description

            +

            An Atom helper class.

            +

            Member Function Documentation

            + +
            +
            + + + + + +
            + + + + + + + + + + + + + + + + + + +
            std::string kiwi::tool::AtomHelper::toString (std::vector< Atom > const & atoms,
            const bool add_quotes = true 
            )
            +             		+static
            +
            + +

            Convert a vector of Atom into a string.

            +

            This method will call the toString static method for each atom of the vector and output a whitespace between each one (except for the special Atom::Type::Comma that is stuck to the previous Atom).

            + +
            +
            +
            The documentation for this struct was generated from the following files: +
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1tool_1_1_atom_helper_1_1_parsing_flags-members.html b/docs/html/structkiwi_1_1tool_1_1_atom_helper_1_1_parsing_flags-members.html new file mode 100644 index 00000000..28cc58ea --- /dev/null +++ b/docs/html/structkiwi_1_1tool_1_1_atom_helper_1_1_parsing_flags-members.html @@ -0,0 +1,110 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +
            kiwi::tool::AtomHelper::ParsingFlags Member List
            +
            +
            + +

            This is the complete list of members for kiwi::tool::AtomHelper::ParsingFlags, including all inherited members.

            + + + + +
            Comma enum value (defined in kiwi::tool::AtomHelper::ParsingFlags)kiwi::tool::AtomHelper::ParsingFlags
            Dollar enum value (defined in kiwi::tool::AtomHelper::ParsingFlags)kiwi::tool::AtomHelper::ParsingFlags
            Flags enum name (defined in kiwi::tool::AtomHelper::ParsingFlags)kiwi::tool::AtomHelper::ParsingFlags
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1tool_1_1_atom_helper_1_1_parsing_flags.html b/docs/html/structkiwi_1_1tool_1_1_atom_helper_1_1_parsing_flags.html new file mode 100644 index 00000000..13b80b9b --- /dev/null +++ b/docs/html/structkiwi_1_1tool_1_1_atom_helper_1_1_parsing_flags.html @@ -0,0 +1,118 @@ + + + + + + +Kiwi: kiwi::tool::AtomHelper::ParsingFlags Struct Reference + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +Public Types | +List of all members
            +
            +
            kiwi::tool::AtomHelper::ParsingFlags Struct Reference
            +
            +
            + + + + +

            +Public Types

            enum  Flags { Comma = 0x01, +Dollar = 0x02 + }
             
            +
            The documentation for this struct was generated from the following file: +
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1tool_1_1_listeners_1_1is__valid__listener.html b/docs/html/structkiwi_1_1tool_1_1_listeners_1_1is__valid__listener.html new file mode 100644 index 00000000..74a9b944 --- /dev/null +++ b/docs/html/structkiwi_1_1tool_1_1_listeners_1_1is__valid__listener.html @@ -0,0 +1,115 @@ + + + + + + +Kiwi: kiwi::tool::Listeners< ListenerClass >::is_valid_listener Struct Reference + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +
            kiwi::tool::Listeners< ListenerClass >::is_valid_listener Struct Reference
            +
            +
            +
            +Inheritance diagram for kiwi::tool::Listeners< ListenerClass >::is_valid_listener:
            +
            +
            + + + +
            +
            The documentation for this struct was generated from the following file: +
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1tool_1_1_listeners_1_1is__valid__listener.png b/docs/html/structkiwi_1_1tool_1_1_listeners_1_1is__valid__listener.png new file mode 100644 index 0000000000000000000000000000000000000000..0c65255453bb2e08faa0f02e45745849b6a60a10 GIT binary patch literal 1588 zcmc(fdo6r~o#LF*DrX!T%WMOv3>Qv^lATGvS1xU7aUgheSsFViNarE003 zvQpPAF43sOsc1t~D=Au$rYvp=Rnk(ru-Mrj`)Avqd(U~_@AEw8`^Wp7^Ld_2K>^-6 zS|(Zm0O(+R&^Q24p(^7b4OQh^v8R1YDMms5AxF2iw!^uF59yRg+m1hPPfri{(uBD( z)kwny1OrOb_8A!naR2~tF9z)yk_lR*2|K1-w9yPab90Mw!HTmCRXGF654MGSu3b&TO>x!zdA1;d4?ke=l;H|V-W5F+sTEJO0VyUg`@w$?q z;*e^$2&z{3+Ve&*(`r`T+eO{+mY<{A(!YElA~lRoPoipK3tn8gQ40H=59Kih2&Rjy zAYr~Bgwnh?#Gl9W=rI@4imA+D#02M+2;W#4uPRM$)sqlwZ)er7d;>;FQwO_#w{3TY zNDlV2mrgEV^J8IaeuMb;`VGesQF)m*TwLaAsbGCHudqh5H(732N!hwnG=CVXVsI%|v`0YQwPmx42F$(5!!x62e524(f{5oZH@Kh83y5jmWTa5KO*QdmNlGe8==z;h9@SiQ`S;)eLIWfWg zeth$kfqB-Z*pi!@!bZ%KvvDxTi<^m(f#bNP8cvi`#k8Q-9P;9gn`5`#gv3HFPX1uj8kdM61XO@oei_xmsZ=N zSUueDO64w$@lWP3CnP<@BIqHQgUpaRiEvLHgTo4jj{*#@nBB5pif zhWT`ToFMO@4eggC$YY1~hEmkxUy7W@(sxlbj}*FI)9NYgOd6zF$c8sf8P*K5sYA_D zo-bnQ7K5Hw=e3BsW7cG`Lx`tZp8|F2l^YO8AYCU=`Vus@q2j>eP6a3X%t-BUz?==S zd?pAM$Wb|q*gWi+v>H(^L_f zRu#mhv1E z|G=B&N93KhGv^eG%#0NMv&9%*j`2=qBXt%+JwA)x6y>&AZ|xl{)J-fEEj}LIh`&Ai z)UPUM!v2(rqC>=JsUQhYKe`*^K>@!x7>QMa@h0~oSd&^vHZ`lCBRc|i#s3Y?-|$@D YVQff}3Mz-A137g0XnzE=>Px# literal 0 HcmV?d00001 diff --git a/docs/html/structkiwi_1_1tool_1_1_scheduler_1_1_queue_1_1_command-members.html b/docs/html/structkiwi_1_1tool_1_1_scheduler_1_1_queue_1_1_command-members.html new file mode 100644 index 00000000..9df126ab --- /dev/null +++ b/docs/html/structkiwi_1_1tool_1_1_scheduler_1_1_queue_1_1_command-members.html @@ -0,0 +1,109 @@ + + + + + + +Kiwi: Member List + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +
            kiwi::tool::Scheduler< Clock >::Queue::Command Member List
            +
            +
            + +

            This is the complete list of members for kiwi::tool::Scheduler< Clock >::Queue::Command, including all inherited members.

            + + + +
            m_task (defined in kiwi::tool::Scheduler< Clock >::Queue::Command)kiwi::tool::Scheduler< Clock >::Queue::Command
            m_time (defined in kiwi::tool::Scheduler< Clock >::Queue::Command)kiwi::tool::Scheduler< Clock >::Queue::Command
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/structkiwi_1_1tool_1_1_scheduler_1_1_queue_1_1_command.html b/docs/html/structkiwi_1_1tool_1_1_scheduler_1_1_queue_1_1_command.html new file mode 100644 index 00000000..8a8e30d6 --- /dev/null +++ b/docs/html/structkiwi_1_1tool_1_1_scheduler_1_1_queue_1_1_command.html @@ -0,0 +1,120 @@ + + + + + + +Kiwi: kiwi::tool::Scheduler< Clock >::Queue::Command Struct Reference + + + + + + + + + + +
            +
            + + + + + + +
            +
            Kiwi +
            +
            +
            + + + + + + +
            +
            + + +
            + +
            + + +
            +
            +
            +Public Attributes | +List of all members
            +
            +
            kiwi::tool::Scheduler< Clock >::Queue::Command Struct Reference
            +
            +
            + + + + + + +

            +Public Attributes

            +std::shared_ptr< Task > m_task
             
            +time_point_t m_time
             
            +
            The documentation for this struct was generated from the following file: +
            + +
            +Generated by   +doxygen + 1.8.11 +
            + + diff --git a/docs/html/tabs.css b/docs/html/tabs.css index a28614b8..9cf578f2 100644 --- a/docs/html/tabs.css +++ b/docs/html/tabs.css @@ -1 +1,60 @@ -.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}#doc-content{overflow:auto;display:block;padding:0;margin:0;-webkit-overflow-scrolling:touch}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace!important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0!important;-webkit-border-radius:0;border-radius:0!important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px!important;-webkit-border-radius:5px;border-radius:5px!important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0!important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px!important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file +.tabs, .tabs2, .tabs3 { + background-image: url('tab_b.png'); + width: 100%; + z-index: 101; + font-size: 13px; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; +} + +.tabs2 { + font-size: 10px; +} +.tabs3 { + font-size: 9px; +} + +.tablist { + margin: 0; + padding: 0; + display: table; +} + +.tablist li { + float: left; + display: table-cell; + background-image: url('tab_b.png'); + line-height: 36px; + list-style: none; +} + +.tablist a { + display: block; + padding: 0 20px; + font-weight: bold; + background-image:url('tab_s.png'); + background-repeat:no-repeat; + background-position:right; + color: #283A5D; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; + outline: none; +} + +.tabs3 .tablist a { + padding: 0 10px; +} + +.tablist a:hover { + background-image: url('tab_h.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + text-decoration: none; +} + +.tablist li.current a { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} diff --git a/docs/html/todo.html b/docs/html/todo.html index 98e9ba6c..2001a700 100644 --- a/docs/html/todo.html +++ b/docs/html/todo.html @@ -3,8 +3,7 @@ - - + Kiwi: Todo List @@ -12,6 +11,9 @@ + @@ -29,19 +31,36 @@
            - + - - - - +
            +
            Namespace kiwi
            +
            Clean flip headers below, use only needed one in this file
            Class kiwi::dsp::LoopError
            Add more infos about the detected loop.
            -
            Class kiwi::engine::CircularBuffer< T >
            -
            documentation inspired from boost circular buffer
            -
            Member kiwi::engine::Object::receive (size_t index, std::vector< Atom > const &args)=0
            +
            Member kiwi::engine::Object::receive (size_t index, std::vector< tool::Atom > const &args)=0
            see if the method must be noexcept.
            -
            Member kiwi::engine::Object::send (const size_t index, std::vector< Atom > const &args)
            +
            Member kiwi::engine::Object::send (const size_t index, std::vector< tool::Atom > const &args)

            Improve the stack overflow system.

            -

            See if the method must be noexcept.

            +

            See if the method must be noexcept.

            +
            Class kiwi::model::AdcTilde
            +
            Check better way to get routes.
            +
            Class kiwi::model::DacTilde
            +
            Check better way to get routes.
            +
            Class kiwi::model::Object::Error
            +
            Check if object's id shall be added to error.
            +
            Class kiwi::tool::CircularBuffer< T >
            +
            documentation inspired from boost circular buffer
            +
            Class kiwi::tool::Matrix< Type >
            +
            Adds more usefull operation.
            +
            Class kiwi::tool::Parameter
            +
            Use virtual classes that implements check of atoms, copy and default initialization instead of using switches. See in juce::variant.
            Generated by   doxygen - 1.8.13 + 1.8.11
            diff --git a/docs/index.html b/docs/index.html index cc7d2f01..b596d047 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,9 +3,9 @@ Kiwi Wiki - - - + + + @@ -13,22 +13,28 @@
            - Getting started - Objects - Tutorials - Versions - Developper guide -
            - -
            -

            Kiwi Wiki

            -

            Welcome to our wiki !

            -

            You will find here all relevent informations on how to use kiwi as well - as guidance for fellow developpers eager to contribute.

            + +
            + Getting started + Objects + Tutorials + Versions + Developper guide +
            + + + + + +
            + En + + Fr +
            + +
            +

            Kiwi Wiki

            +

            Welcome to our wiki !

            +

            You will find here all relevent informations on how to use kiwi as well + as guidance for fellow developpers eager to contribute.

            +
            + + + + + + + + + + + +
            + +
            + Getting started + Objects + Tutorials + Versions + Developper guide +
            + + + + + +
            + En + + Fr +
            +
            + + + +
            +
            + + + + + diff --git a/docs/software/getting-started.md b/docs/software/getting-started.md new file mode 100644 index 00000000..421af933 --- /dev/null +++ b/docs/software/getting-started.md @@ -0,0 +1,81 @@ +# Getting started + +## Download + +Please follow this [link](https://github.com/Musicoll/Kiwi/releases/latest) to download the software. You'll find a version for each operating system, a list of help patches that describes the objects' behaviour and a set of tutorials guiding through creating certain audio processing. + +## Compatibility + +Kiwi is compatible with the three main operating system. + +- Macos : version 10.7 and later. +- Windows : windows 7 and later. +- Linus : tested with ubuntu 14.04 + +## Installing + +Once download is complete, the corresponding archive shall be extracted by double clicking on it. A Kiwi folder containing the application is then created. On macos and linux copy the application to your app folder (Application folder on Mac, /usr/bin on linux). Windows users may execute the installer. + +## Lauching Kiwi + +When Kiwi is executed three main windows appear : The Document Browser, the Beacon Dispatcher and Kiwi's console. + + + + + + + +
            + +The menu bar appears on top of your screen or as a header of Kiwi's console on windows. + + + +## Signing up + +There is two options to connect to Kiwi's server: either create a user account or use an already created account. To create an account, click on 'Register' under 'Account' menu. A register window appears. Enter your username, your email adress and your passowrd. After clicking the register button the user receives a email containing a temporary link enabling him to validate his account creation. + + + + +To connect to an existing user account, click on login in the menu 'Account'. A login window shows up. Enter your email address or username and your password. If you forgot your password, you can reset it using your email address by clicking on the button 'Forgot password'. + + + +## First patch + +At this point, you can either join a shared patch using the Document Browser window or open a local patch. In this section we will demonstrate how to open and manipulate a local patch. Instructions on how to collaborate will be given later. + +Pease click on this link to download a first example and open the example with Kiwi. + + + +As you can see, the patch is a set of objects each one carrying out an operation. Data either control or signal data is sent between objects using links. Grey connections are used to send messages (numbers, strings, lists, bang ect...) whereas green connections send signals from top to bottom. + +This first patch is a generator of sound (synthesis) where the top-left part is the generator. The top-right is used to trigger a gain envelope. The signal is then sent to a master gain control and the dac~ object which represents the audio output of the patch. + +A patch can either be in mode edition or in mode lock. In edition mode objects and links can be added, removed or edited. In mode lock, graphical objects (the gain slider is graphical is an example) are now enabled and can be manipulated to generate different sounds. To switch between mode lock and mode edition either click on the lock button + or press Cmd + E (Ctrl + E for linux or windows users). + +The audio processing is by default disabled, to put the audio on click on the speaker icon on the top left part of the patch . + +Once you have locked the patch and started the audio processing you can increase the gain using the "gain" slider, you can generate the sound by clicking on the "envelope" message object (below "envelope" comment) and adjust the frequency of the generated sound by dragging the number object which controls the frequency. + +## Collaborate + +In this section we will describe how one can join a patch and collaborate with other users. + +To collaborate with others one may use the document browser and open a document that is being edited by another collaborator. There is no chatting solution integrated in Kiwi's software but you can use another chatting software to meet up and speak while working together. + + + +As you can see the document displays a list of documents accessible by anyone. Downloading, deleting, uploading, renaming, duplicating a patches is enabled by right clicking on the document browser. Sorting documents using different criteria is also possible. + +Double click on a patch to start collaborating. + + + +Once you have join the document you can click on the top left part to show users currently editing or using the patch. Objects currently selected by other users are hilighted in orange whereas your own selection is shown in blue. + +You can now edit and/or play the patch as you will with others. diff --git a/docs/software/objects.html b/docs/software/objects.html new file mode 100644 index 00000000..f003f238 --- /dev/null +++ b/docs/software/objects.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
            + +
            + Getting started + Objects + Tutorials + Versions + Developper guide +
            + + + + + +
            + En + + Fr +
            +
            + + + +
            +
            + + + + + diff --git a/docs/software/objects.md b/docs/software/objects.md new file mode 100644 index 00000000..0d78787b --- /dev/null +++ b/docs/software/objects.md @@ -0,0 +1,74 @@ +# Objects + +## Help patches + +A list of help patches describing how each object works is here. The list of help patches is currently incomplete but will evolve later on. + +## List of objects + +| Object | Alias | Description | +|-----------------|:-----:|---------------------------------------------------------| +| **line~** | | Generate an audio ramp signal | +| **noise~** | | A white noise generator | +| **sah~** | | Samples and holds an input signal | +| **hub** | | Send message to other users | +| **send** | *s* | Send message to matching receive object | +| **mtof** | | Convert midi notes to frequencies | +| **number~** | | Display audio samples values | +| **number** | | Display a nuumber | +| **select** | | Ouput bang if receive matching input | +| **snapshot~** | | Ouput sample signal values | +| **random** | | Ouput random number in a uniform distribution | +| **unpack** | | Access elements in a list | +| **pack** | | Create and outputs a list of messages | +| **comment** | | Add a comment to the patch | +| **!=~** | | Signal inequality operator | +| **==~** | | Signal equality operator | +| **>=~** | | Signal superior operator | +| **>~** | | Signal strict superior operator | +| **<=~** | | Signal inferior operator | +| **<~** | | Signal strict inferior operator | +| **/~** | | Divide two signals | +| **-~** | | Substract two signals | +| **%** | | Compute the modulo of number in desired basis | +| **pow** | | Compute exponentiation of a number | +| **==** | | Equality operator | +| **!=** | | Inequality operator | +| **>=** | | Superior operator | +| **>** | | Strict superior operator | +| **<=** | | Inferior operator | +| **<** | | Strict inferior operator | +| **/** | | Compute the division of two numbers | +| **-** | | Compute the substraction of two numbers | +| **message** | | Send messages or list of messages | +| **slider** | | Graphical slider sending values between 0 and 1 | +| **toggle** | | A switch button | +| **bang** | | Send a bang message | +| **meter~** | | A peak amplitude vu meter | +| **trigger** | *t* | Trigger events based on received data | +| **newbox** | | Empty new box | +| **errorbox** | | Error box | +| **+** | | Add two numbers | +| **\*** | | Multiply two numbers | +| **print** | | Print messages into Kiwi console | +| **receive** | *r* | Receive messages from a sender bound to the same name | +| **loadmess** | | Output arguments as message when the patch is loaded | +| **delay** | | Delay messages as bang | +| **pipe** | | Delay any message | +| **metro** | | Output bang at regular time interval | +| **adc~** | | Receive audio signals from inputs or external devices | +| **dac~** | | Send audio signals to outputs or external devices | +| **osc~** | | A cosine oscillator | +| **phasor~** | | Generate a sawtooth signal | +| **\*~** | | Multiply two signals | +| **+~** | | Add two signals | +| **sig~** | | Convert numbers into audio signals | +| **delaysimple~**| | Simple variable delay line with optional feedback value | +| **scale** | | Convert a number from one range into another range | +| **gate** | | Route message to selected output | +| **switch** | | Output message receive in selected inlet | +| **gate~** | | Route received signal to selected output | +| **switch~** | | Ouput signal received in selected inlet | +| **clip** | | Clip a number between a maximum and a minimum value | +| **clip~** | | Clip a signal between a maximum and a minimum value | +| **float** | | Store a float value | diff --git a/docs/software/tutorials.html b/docs/software/tutorials.html new file mode 100644 index 00000000..2945a747 --- /dev/null +++ b/docs/software/tutorials.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
            + +
            + Getting started + Objects + Tutorials + Versions + Developper guide +
            + + + + + +
            + En + + Fr +
            +
            + + + +
            +
            + + + + + diff --git a/docs/software/tutorials.md b/docs/software/tutorials.md new file mode 100644 index 00000000..60edd721 --- /dev/null +++ b/docs/software/tutorials.md @@ -0,0 +1,10 @@ +# Tutorials + +A set of tutorials is available here. Each tutorial aims at taking you through the creation of a specific audio processing or exploring a certain aspect of Kiwi software. + +Available tutorials: + +- flanger +- fm-synthesis +- overlapped-pitchshifter.kiwi +- overlapp diff --git a/docs/software/versions.html b/docs/software/versions.html new file mode 100644 index 00000000..7cf33ef9 --- /dev/null +++ b/docs/software/versions.html @@ -0,0 +1,63 @@ + + + + + Kiwi Wiki + + + + + + + + + + +
            + +
            + Getting started + Objects + Tutorials + Versions + Developper guide +
            + + + + + +
            + En + + Fr +
            +
            + + + +
            +
            + + + + + diff --git a/docs/software/versions.md b/docs/software/versions.md index 4407be71..ff48299d 100644 --- a/docs/software/versions.md +++ b/docs/software/versions.md @@ -1,5 +1,13 @@ +# Versions + Kiwi follows the [Semantic Versioning Specification](http://semver.org/). +## v1.0.0 + +- Fix numerous bugs. +- Add new required objects (gate/gate~/switch/switch~/float/clip/clip~). +- Improve former objects' behaviour. + ## v1.0.0-beta - Adding graphical objects. @@ -14,8 +22,7 @@ Kiwi follows the [Semantic Versioning Specification](http://semver.org/). * Search document enabled. - Enable patch compatibility between versions. - Fix miscellaneous bugs. - -Check out new available objects in v1.0.0-beta [here](List-of-Objects). +- Add new objects. ## v0.1.0 @@ -28,22 +35,19 @@ Check out new available objects in v1.0.0-beta [here](List-of-Objects). - Add a scheduler and make the objects pipe, delay and metro. - Add an "About Kiwi" Window. - Add an "Application preferences" window. - -See the list of objects added in the v0.1.0 [here](List-of-Objects). +- Add new objects. ## v0.0.3 - Collaboration on LAN with automatic client discovery. - Add DSP chain - Add some basic DSP objects - -See the list of objects added in the v0.0.3 [here](List-of-Objects). +- Add new objects. ## v0.0.2 - Add beacons and a beacon dispatcher window - -See the list of objects added in the v0.0.2 [here](List-of-Objects). +- Add new objects. ## v0.0.1 From 4183797bb70ba1137c45fd5978676bb6c12d3b7a Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 3 May 2018 09:28:01 +0200 Subject: [PATCH 34/35] Adapt endpoint releases to match API. --- Client/Source/KiwiApp.h | 2 +- Client/Source/KiwiApp_Network/KiwiApp_Api.cpp | 4 ++-- Client/Source/KiwiApp_Network/KiwiApp_Api.h | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Client/Source/KiwiApp.h b/Client/Source/KiwiApp.h index 53541442..8d24b0c1 100644 --- a/Client/Source/KiwiApp.h +++ b/Client/Source/KiwiApp.h @@ -34,7 +34,7 @@ namespace ProjectInfo { const char* const projectName = "Kiwi"; - const char* const versionString = "v1.0.0-beta"; + const char* const versionString = "v0.1.0"; const int versionNumber = 0x010; } diff --git a/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp b/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp index 418013e8..1904c302 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp +++ b/Client/Source/KiwiApp_Network/KiwiApp_Api.cpp @@ -27,7 +27,7 @@ namespace kiwi const std::string Api::Endpoint::login {Api::Endpoint::root + "/login"}; const std::string Api::Endpoint::documents {Api::Endpoint::root + "/documents"}; const std::string Api::Endpoint::users {Api::Endpoint::root + "/users"}; - const std::string Api::Endpoint::release {Api::Endpoint::root + "/release"}; + const std::string Api::Endpoint::releases {Api::Endpoint::root + "/releases"}; std::string Api::Endpoint::document(std::string const& document_id) { @@ -420,7 +420,7 @@ namespace kiwi uint64_t Api::getRelease(CallbackFn success_cb, ErrorCallback error_cb) { - auto session = makeSession(Endpoint::release); + auto session = makeSession(Endpoint::releases); auto cb = [success = std::move(success_cb), fail = std::move(error_cb)](Response res) diff --git a/Client/Source/KiwiApp_Network/KiwiApp_Api.h b/Client/Source/KiwiApp_Network/KiwiApp_Api.h index 84b5745e..de187bfa 100644 --- a/Client/Source/KiwiApp_Network/KiwiApp_Api.h +++ b/Client/Source/KiwiApp_Network/KiwiApp_Api.h @@ -174,7 +174,7 @@ namespace kiwi static const std::string login; static const std::string documents; static const std::string users; - static const std::string release; + static const std::string releases; static std::string document(std::string const& document_id); static std::string user(std::string const& user_id); From 94d4ecef9b2bff6ab9aa097e83d67f84b34e6ce6 Mon Sep 17 00:00:00 2001 From: jean-millot Date: Thu, 3 May 2018 10:00:14 +0200 Subject: [PATCH 35/35] Bump kiwi version. --- Client/Source/KiwiApp.h | 4 ++-- Ressources/Project/Xcode/Info.plist | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Client/Source/KiwiApp.h b/Client/Source/KiwiApp.h index 8d24b0c1..098e8547 100644 --- a/Client/Source/KiwiApp.h +++ b/Client/Source/KiwiApp.h @@ -34,8 +34,8 @@ namespace ProjectInfo { const char* const projectName = "Kiwi"; - const char* const versionString = "v0.1.0"; - const int versionNumber = 0x010; + const char* const versionString = "v1.0.0"; + const int versionNumber = 0x100; } namespace kiwi diff --git a/Ressources/Project/Xcode/Info.plist b/Ressources/Project/Xcode/Info.plist index 3bf0edf1..6e2eecc1 100755 --- a/Ressources/Project/Xcode/Info.plist +++ b/Ressources/Project/Xcode/Info.plist @@ -15,9 +15,9 @@ CFBundlePackageType APPL CFBundleShortVersionString - 0.1.0 + 1.0.0 CFBundleVersion - 0.1.0 + 1.0.0 NSHighResolutionCapable NSHumanReadableCopyright