Loading...
Searching...
No Matches
LocalTree::DocumentPlugin Class Referencefinal
Inheritance diagram for LocalTree::DocumentPlugin:
LocalTree::ScriptableTreeBase score::DocumentPlugin

Public Member Functions

 DocumentPlugin (const score::DocumentContext &doc, QObject *parent)
 
void init ()
 
void on_documentClosing () override
 
ossia::net::device_base & device () const noexcept override
 
Protocols::LocalDevice & localDevice ()
 
std::shared_ptr< const ScriptableSnapshot > snapshot () const noexcept override
 Snapshot of the scriptable namespace, safe to read from any thread.
 
const ReferenceIndex & references () const noexcept
 
ReferenceIndex & references () noexcept
 
std::vector< QObject * > referrers (const QObject &target) const override
 The states, ports, events and syncs holding an address anchored to the object.
 
std::vector< QObject * > targets (const QObject &referrer) const override
 The objects the addresses of a state, port, event or sync are anchored to.
 
ossia::net::parameter_base * reserve (const ::State::Address &address, const ossia::value &sample) override
 
void follow (QObject &referrer) override
 
bool hasPlayedValues () const noexcept override
 Whether the last run wrote control values that only the execution received.
 
void keepPlayedValues () override
 Stores these values in the document, as Record playback would.
 
QObject * objectAt (const ossia::net::node_base &node, QString &member) const noexcept override
 The object a published node stands for; member receives which of its parameters.
 
ossia::net::node_base * nodeOf (const QObject &object, const QString &member) const noexcept override
 
void connectToStop ()
 
void beginRecall (Recall recall)
 
void endRecall (Recall recall)
 
- Public Member Functions inherited from LocalTree::ScriptableTreeBase
void snapshotChanged ()
 
void setEmphasized (std::vector< const QObject * > objects)
 Objects the selection refers to or that refer to it; drawn emphasized.
 
bool emphasized (const QObject &object) const noexcept
 
void emphasisChanged ()
 
void published (QObject *object)
 Emitted when a namespace node starts standing for the object.
 
void referencesChanged (QObject *referrer)
 The referrer's references may have broken or resolved; null means all. Coalesced.
 
void executionStarted ()
 
void executionStopped ()
 Emitted when the execution has released the published controls.
 
void playedValuesChanged ()
 
Recall recall () const noexcept
 Read from any thread.
 
uint32_t runsEnded () const noexcept
 Read from any thread.
 
Recall recallAt (Recall recall, uint32_t run) const noexcept
 A write from a run that has ended since counts as written at its stop.
 
- Public Member Functions inherited from score::DocumentPlugin
 DocumentPlugin (const score::DocumentContext &, const QString &name, QObject *parent)
 
const score::DocumentContext & context () const
 
template<typename Impl >
 DocumentPlugin (const score::DocumentContext &ctx, Impl &vis, QObject *parent)
 

Additional Inherited Members

- Protected Attributes inherited from LocalTree::ScriptableTreeBase
std::atomic< Recall > m_recall {Recall::None}
 
std::atomic< uint32_t > m_runsEnded {}
 
- Protected Attributes inherited from score::DocumentPlugin
const score::DocumentContext & m_context
 

Constructor & Destructor Documentation

◆ ~DocumentPlugin()

LocalTree::DocumentPlugin::~DocumentPlugin ( )
virtual

Reimplemented from score::DocumentPlugin.

Member Function Documentation

◆ beginRecall()

void LocalTree::DocumentPlugin::beginRecall ( Recall  recall)

Brackets a state sent to the published controls outside the run; the recall ends once its writes have been applied.

◆ device()

ossia::net::device_base & LocalTree::DocumentPlugin::device ( ) const
inlineoverridevirtualnoexcept

◆ follow()

void LocalTree::DocumentPlugin::follow ( QObject &  referrer)
overridevirtual

Re-derives the referrer's local addresses from their anchors and anchors the others by name; pasted copies publish under new names.

Implements LocalTree::ScriptableTreeBase.

◆ hasPlayedValues()

bool LocalTree::DocumentPlugin::hasPlayedValues ( ) const
overridevirtualnoexcept

Whether the last run wrote control values that only the execution received.

Implements LocalTree::ScriptableTreeBase.

◆ keepPlayedValues()

void LocalTree::DocumentPlugin::keepPlayedValues ( )
overridevirtual

Stores these values in the document, as Record playback would.

Implements LocalTree::ScriptableTreeBase.

◆ nodeOf()

ossia::net::node_base * LocalTree::DocumentPlugin::nodeOf ( const QObject &  object,
const QString &  member 
) const
overridevirtualnoexcept

◆ objectAt()

QObject * LocalTree::DocumentPlugin::objectAt ( const ossia::net::node_base &  node,
QString &  member 
) const
overridevirtualnoexcept

The object a published node stands for; member receives which of its parameters.

Implements LocalTree::ScriptableTreeBase.

◆ on_documentClosing()

void LocalTree::DocumentPlugin::on_documentClosing ( )
overridevirtual

Reimplemented from score::DocumentPlugin.

◆ referrers()

std::vector< QObject * > LocalTree::DocumentPlugin::referrers ( const QObject &  target) const
inlineoverridevirtual

The states, ports, events and syncs holding an address anchored to the object.

Implements LocalTree::ScriptableTreeBase.

◆ reserve()

ossia::net::parameter_base * LocalTree::DocumentPlugin::reserve ( const ::State::Address &  address,
const ossia::value &  sample 
)
overridevirtual

Parameter to send to for the address of a dynamic port not created yet; the port takes it over when it appears.

Implements LocalTree::ScriptableTreeBase.

◆ snapshot()

std::shared_ptr< const LocalTree::ScriptableSnapshot > LocalTree::DocumentPlugin::snapshot ( ) const
overridevirtualnoexcept

Snapshot of the scriptable namespace, safe to read from any thread.

Implements LocalTree::ScriptableTreeBase.

◆ targets()

std::vector< QObject * > LocalTree::DocumentPlugin::targets ( const QObject &  referrer) const
inlineoverridevirtual

The objects the addresses of a state, port, event or sync are anchored to.

Implements LocalTree::ScriptableTreeBase.


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