Databinding Service

Databinding library can be used to set application data and bind them to events when they change. Useful for a heavy data oriented system.

Data on a tree!

Each node represent a data in this service, so for example the branch "app.settings.audio.music" corresponds to the branch "A.B.H.N", branches can be reached in the tree by nodes, depth or branch ids.

The dot (.) is considered as a node separator in the system, can be changed to any char here

How to use it

To start the databinding service simply create an instance of it

using DataBinding;

var dataBinding = new DataBindingService();

Add data

Call AddData by providing the data type and the a branch, new nodes will be created if nodes of the branch don't exists.

dataBinding.AddData<bool>("app.settings.notifications", true)
           .AddData<bool>("app.settings.notifications.hasSound", true)
           .AddData<bool>("app.settings.sound.music", true);

Binding components

Components bind to a data branch and get notified if the data changes in the system. Implement BindingComponent<T> interface by the specifying the data type which it will bind to.

public class SampleBindingComponent : BindingComponent<bool>
{
    public void OnValueChanged(string branch, bool value)
    {
        // Do stuff with the new data
    }
}

Binding data to components

Call Bind<T>(branch, instance) by specifying the data type, the data branch and the binding component instance.

var sampleBindingComponent = new SampleBindingComponent();

dataBinding.Bind<bool>("app.settings.sound.music", sampleBindingComponent);

Get and modify data

Call GetData<T>(string branch) to get an object of type Data<T> and access its value.

var musicData = dataBinding.GetData<bool>("app.settings.sound.music");
var isMusicEnabled = musicData.value;

// Change data and reassign
isMusicEnabled = !isMusicEnabled;
musicData.value = isMusicEnabled;

Reassigning the value will notify automatically components bind to this data. To manually notify components, on the Data<T> object call NotifyComponents.

musicData.NotifyComponents()

Tests

To better understand the system and have a quick dive in the codebase have a look at the unit tests in the project.

Useful methods

GetData<T>(string nodeId, int treeDepth) if you know the node and the data depth in the tree
ContainsNode(string branch)
ExtractNode(string branch) will return a node object

adizhavo/databinding