This class can be used to watch for all changes to the state of a ValueTree, and to convert them to a transmittable binary encoding. More...
#include <juce_ValueTreeSynchroniser.h>
Public Member Functions | |
ValueTreeSynchroniser (const ValueTree &tree) | |
Creates a ValueTreeSynchroniser that watches the given tree. More... | |
~ValueTreeSynchroniser () override | |
Destructor. More... | |
const ValueTree & | getRoot () noexcept |
Returns the root ValueTree that is being observed. More... | |
void | sendFullSyncCallback () |
Forces the sending of a full state message, which may be large, as it encodes the entire ValueTree. More... | |
virtual void | stateChanged (const void *encodedChange, size_t encodedChangeSize)=0 |
This callback happens when the ValueTree changes and the given state-change message needs to be applied to any other trees that need to stay in sync with it. More... | |
Static Public Member Functions | |
static bool | applyChange (ValueTree &target, const void *encodedChangeData, size_t encodedChangeDataSize, UndoManager *undoManager) |
Applies an encoded change to the given destination tree. More... | |
Private Member Functions | |
void | valueTreeChildAdded (ValueTree &, ValueTree &) override |
This method is called when a child sub-tree is added. More... | |
void | valueTreeChildOrderChanged (ValueTree &, int, int) override |
This method is called when a tree's children have been re-shuffled. More... | |
void | valueTreeChildRemoved (ValueTree &, ValueTree &, int) override |
This method is called when a child sub-tree is removed. More... | |
virtual void | valueTreeParentChanged (ValueTree &treeWhoseParentHasChanged) |
This method is called when a tree has been added or removed from a parent. More... | |
void | valueTreePropertyChanged (ValueTree &, const Identifier &) override |
This method is called when a property of this tree (or of one of its sub-trees) is changed. More... | |
virtual void | valueTreeRedirected (ValueTree &treeWhichHasBeenChanged) |
This method is called when a tree is made to point to a different internal shared object. More... | |
Private Attributes | |
ValueTree | valueTree |
This class can be used to watch for all changes to the state of a ValueTree, and to convert them to a transmittable binary encoding.
The purpose of this class is to allow two or more ValueTrees to be remotely synchronised by transmitting encoded changes over some kind of transport mechanism.
To use it, you'll need to implement a subclass of ValueTreeSynchroniser and implement the stateChanged() method to transmit the encoded change (maybe via a network or other means) to a remote destination, where it can be applied to a target tree.
@tags{DataStructures}
juce::ValueTreeSynchroniser::ValueTreeSynchroniser | ( | const ValueTree & | tree | ) |
Creates a ValueTreeSynchroniser that watches the given tree.
After creating an instance of this class and somehow attaching it to a target tree, you probably want to call sendFullSyncCallback() to get them into a common starting state.
|
override |
Destructor.
|
static |
Applies an encoded change to the given destination tree.
When you implement a receiver for changes that were sent by the stateChanged() message, this is the function that you'll need to call to apply them to the target tree that you want to be synced.
|
inlinenoexcept |
Returns the root ValueTree that is being observed.
void juce::ValueTreeSynchroniser::sendFullSyncCallback | ( | ) |
Forces the sending of a full state message, which may be large, as it encodes the entire ValueTree.
This will internally invoke stateChanged() with the encoded version of the state.
|
pure virtual |
This callback happens when the ValueTree changes and the given state-change message needs to be applied to any other trees that need to stay in sync with it.
The data is an opaque blob of binary that you should transmit to wherever your target tree lives, and use applyChange() to apply this to the target tree.
|
overrideprivatevirtual |
This method is called when a child sub-tree is added.
Note that when you register a listener to a tree, it will receive this callback for child changes in both that tree and any of its children, (recursively, at any depth). If your tree has sub-trees but you only want to know about changes to the top level tree, just check the parentTree parameter to make sure it's the one that you're interested in.
Reimplemented from juce::ValueTree::Listener.
|
overrideprivatevirtual |
This method is called when a tree's children have been re-shuffled.
Note that when you register a listener to a tree, it will receive this callback for child changes in both that tree and any of its children, (recursively, at any depth). If your tree has sub-trees but you only want to know about changes to the top level tree, just check the parameter to make sure it's the tree that you're interested in.
Reimplemented from juce::ValueTree::Listener.
|
overrideprivatevirtual |
This method is called when a child sub-tree is removed.
Note that when you register a listener to a tree, it will receive this callback for child changes in both that tree and any of its children, (recursively, at any depth). If your tree has sub-trees but you only want to know about changes to the top level tree, just check the parentTree parameter to make sure it's the one that you're interested in.
Reimplemented from juce::ValueTree::Listener.
|
virtualinherited |
This method is called when a tree has been added or removed from a parent.
This callback happens when the tree to which the listener was registered is added or removed from a parent. Unlike the other callbacks, it applies only to the tree to which the listener is registered, and not to any of its children.
Reimplemented in juce::ComponentBuilder.
|
overrideprivatevirtual |
This method is called when a property of this tree (or of one of its sub-trees) is changed.
Note that when you register a listener to a tree, it will receive this callback for property changes in that tree, and also for any of its children, (recursively, at any depth). If your tree has sub-trees but you only want to know about changes to the top level tree, simply check the tree parameter in this callback to make sure it's the tree you're interested in.
Reimplemented from juce::ValueTree::Listener.
|
virtualinherited |
This method is called when a tree is made to point to a different internal shared object.
When operator= is used to make a ValueTree refer to a different object, this callback will be made.
Reimplemented in juce::AudioProcessorValueTreeState.
|
private |