100 lines
3.9 KiB
C++
100 lines
3.9 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2017 - ROLI Ltd.
|
|
|
|
JUCE is an open source library subject to commercial or open-source
|
|
licensing.
|
|
|
|
By using JUCE, you agree to the terms of both the JUCE 5 End-User License
|
|
Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
|
|
27th April 2017).
|
|
|
|
End User License Agreement: www.juce.com/juce-5-licence
|
|
Privacy Policy: www.juce.com/juce-5-privacy-policy
|
|
|
|
Or: You may also use this code under the terms of the GPL v3 (see
|
|
www.gnu.org/licenses).
|
|
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
|
DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
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}
|
|
*/
|
|
class JUCE_API ValueTreeSynchroniser : private ValueTree::Listener
|
|
{
|
|
public:
|
|
/** 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.
|
|
*/
|
|
ValueTreeSynchroniser (const ValueTree& tree);
|
|
|
|
/** Destructor. */
|
|
virtual ~ValueTreeSynchroniser();
|
|
|
|
/** 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.
|
|
*/
|
|
virtual void stateChanged (const void* encodedChange, size_t encodedChangeSize) = 0;
|
|
|
|
/** 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.
|
|
*/
|
|
void sendFullSyncCallback();
|
|
|
|
/** 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.
|
|
*/
|
|
static bool applyChange (ValueTree& target,
|
|
const void* encodedChangeData, size_t encodedChangeDataSize,
|
|
UndoManager* undoManager);
|
|
|
|
/** Returns the root ValueTree that is being observed. */
|
|
const ValueTree& getRoot() noexcept { return valueTree; }
|
|
|
|
private:
|
|
ValueTree valueTree;
|
|
|
|
void valueTreePropertyChanged (ValueTree&, const Identifier&) override;
|
|
void valueTreeChildAdded (ValueTree&, ValueTree&) override;
|
|
void valueTreeChildRemoved (ValueTree&, ValueTree&, int) override;
|
|
void valueTreeChildOrderChanged (ValueTree&, int, int) override;
|
|
void valueTreeParentChanged (ValueTree&) override;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ValueTreeSynchroniser)
|
|
};
|
|
|
|
} // namespace juce
|