feat: add view model properties

Author: HayesGordon

android/src/main/java/com/margelo/nitro/rive/BaseHybridViewModelProperty.kt

@@ -0,0 +1,20 @@
+package com.margelo.nitro.rive
+
+import androidx.annotation.Keep
+import com.facebook.proguard.annotations.DoNotStrip
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.flow.Flow
+
+@Keep
+@DoNotStrip
+interface BaseHybridViewModelProperty<T> {
+    val scope: CoroutineScope?
+    val job: Job?
+    val listeners: MutableList<(T) -> Unit>
+
+    fun ensureValueListenerJob(valueFlow: Flow<T>, drop: Int = 0)
+    fun onChanged(value: T)
+    fun removeListeners()
+    fun dispose()
+}

android/src/main/java/com/margelo/nitro/rive/BaseHybridViewModelPropertyImpl.kt

@@ -0,0 +1,50 @@
+package com.margelo.nitro.rive
+
+import androidx.annotation.Keep
+import com.facebook.proguard.annotations.DoNotStrip
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.cancel
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.drop
+
+@Keep
+@DoNotStrip
+class BaseHybridViewModelPropertyImpl<T> : BaseHybridViewModelProperty<T> {
+    override var scope: CoroutineScope? = null
+    override var job: Job? = null
+    override val listeners = mutableListOf<(T) -> Unit>()
+
+  override fun ensureValueListenerJob(valueFlow: Flow<T>, drop: Int) {
+        if (scope == null) {
+            scope = CoroutineScope(Dispatchers.Default)
+        }
+        if (job == null) {
+            job = scope?.launch {
+                valueFlow.drop(drop).collect { value ->
+                    onChanged(value)
+                }
+            }
+        }
+    }
+
+    override fun onChanged(value: T) {
+        listeners.forEach { listener ->
+            listener(value)
+        }
+    }
+
+    override fun removeListeners() {
+        listeners.clear()
+        job?.cancel()
+        scope?.cancel()
+        job = null
+        scope = null
+    }
+
+    override fun dispose() {
+        removeListeners()
+    }
+}

android/src/main/java/com/margelo/nitro/rive/HybridViewModelBooleanProperty.kt

@@ -0,0 +1,22 @@
+package com.margelo.nitro.rive
+
+import androidx.annotation.Keep
+import app.rive.runtime.kotlin.core.ViewModelBooleanProperty
+import com.facebook.proguard.annotations.DoNotStrip
+
+@Keep
+@DoNotStrip
+class HybridViewModelBooleanProperty(private val viewModelBoolean: ViewModelBooleanProperty) :
+  HybridViewModelBooleanPropertySpec(),
+  BaseHybridViewModelProperty<Boolean> by BaseHybridViewModelPropertyImpl() {
+  override var value: Boolean
+    get() = viewModelBoolean.value
+    set(value) {
+      viewModelBoolean.value = value
+    }
+
+  override fun addListener(onChanged: (value: Boolean) -> Unit) {
+    listeners.add(onChanged)
+    ensureValueListenerJob(viewModelBoolean.valueFlow)
+  }
+}

android/src/main/java/com/margelo/nitro/rive/HybridViewModelColorProperty.kt

@@ -0,0 +1,22 @@
+package com.margelo.nitro.rive
+
+import androidx.annotation.Keep
+import app.rive.runtime.kotlin.core.ViewModelColorProperty
+import com.facebook.proguard.annotations.DoNotStrip
+
+@Keep
+@DoNotStrip
+class HybridViewModelColorProperty(private val viewModelColor: ViewModelColorProperty) :
+  HybridViewModelColorPropertySpec(),
+  BaseHybridViewModelProperty<Int> by BaseHybridViewModelPropertyImpl() {
+  override var value: Double
+    get() = viewModelColor.value.toDouble()
+    set(value) {
+      viewModelColor.value = value.toInt()
+    }
+
+  override fun addListener(onChanged: (value: Double) -> Unit) {
+    listeners.add { intValue: Int -> onChanged(intValue.toDouble()) }
+    ensureValueListenerJob(viewModelColor.valueFlow)
+  }
+}

android/src/main/java/com/margelo/nitro/rive/HybridViewModelEnumProperty.kt

@@ -0,0 +1,22 @@
+package com.margelo.nitro.rive
+
+import androidx.annotation.Keep
+import app.rive.runtime.kotlin.core.ViewModelEnumProperty
+import com.facebook.proguard.annotations.DoNotStrip
+
+@Keep
+@DoNotStrip
+class HybridViewModelEnumProperty(private val viewModelEnum: ViewModelEnumProperty) :
+  HybridViewModelEnumPropertySpec(),
+  BaseHybridViewModelProperty<String> by BaseHybridViewModelPropertyImpl() {
+  override var value: String
+    get() = viewModelEnum.value
+    set(value) {
+      viewModelEnum.value = value
+    }
+
+  override fun addListener(onChanged: (value: String) -> Unit) {
+    listeners.add(onChanged)
+    ensureValueListenerJob(viewModelEnum.valueFlow)
+  }
+}

android/src/main/java/com/margelo/nitro/rive/HybridViewModelInstance.kt

@@ -2,11 +2,66 @@ package com.margelo.nitro.rive
 
 import androidx.annotation.Keep
 import app.rive.runtime.kotlin.core.ViewModelInstance
+import app.rive.runtime.kotlin.core.errors.ViewModelException
 import com.facebook.proguard.annotations.DoNotStrip
 
 @Keep
 @DoNotStrip
 class HybridViewModelInstance(val viewModelInstance: ViewModelInstance) : HybridViewModelInstanceSpec() {
   override val name: String
     get() = viewModelInstance.name
+
+  override fun numberProperty(path: String): HybridViewModelNumberPropertySpec? {
+    try {
+        val numberProper = viewModelInstance.getNumberProperty(path)
+        return HybridViewModelNumberProperty(numberProper)
+    } catch (e: ViewModelException) {
+      return null
+    }
+  }
+
+  override fun stringProperty(path: String): HybridViewModelStringPropertySpec? {
+    try {
+      val stringProperty = viewModelInstance.getStringProperty(path)
+      return HybridViewModelStringProperty(stringProperty)
+    } catch (e: ViewModelException) {
+      return null
+    }
+  }
+
+  override fun booleanProperty(path: String): HybridViewModelBooleanPropertySpec? {
+    try {
+      val booleanProperty = viewModelInstance.getBooleanProperty(path)
+      return HybridViewModelBooleanProperty(booleanProperty)
+    } catch (e: ViewModelException) {
+      return null
+    }
+  }
+
+  override fun colorProperty(path: String): HybridViewModelColorPropertySpec? {
+    try {
+      val colorProperty = viewModelInstance.getColorProperty(path)
+      return HybridViewModelColorProperty(colorProperty)
+    } catch (e: ViewModelException) {
+      return null
+    }
+  }
+
+  override fun enumProperty(path: String): HybridViewModelEnumPropertySpec? {
+    try {
+      val enumProperty = viewModelInstance.getEnumProperty(path)
+      return HybridViewModelEnumProperty(enumProperty)
+    } catch (e: ViewModelException) {
+      return null
+    }
+  }
+
+  override fun triggerProperty(path: String): HybridViewModelTriggerPropertySpec? {
+    try {
+      val triggerProperty = viewModelInstance.getTriggerProperty(path)
+      return HybridViewModelTriggerProperty(triggerProperty)
+    } catch (e: ViewModelException) {
+      return null
+    }
+  }
 }

android/src/main/java/com/margelo/nitro/rive/HybridViewModelNumberProperty.kt

@@ -0,0 +1,23 @@
+package com.margelo.nitro.rive
+
+import androidx.annotation.Keep
+import app.rive.runtime.kotlin.core.ViewModelNumberProperty
+import com.facebook.proguard.annotations.DoNotStrip
+import kotlinx.coroutines.flow.map
+
+@Keep
+@DoNotStrip
+class HybridViewModelNumberProperty(private val viewModelNumber: ViewModelNumberProperty) :
+  HybridViewModelNumberPropertySpec(),
+  BaseHybridViewModelProperty<Double> by BaseHybridViewModelPropertyImpl() {
+  override var value: Double
+    get() = viewModelNumber.value.toDouble()
+    set(value) {
+      viewModelNumber.value = value.toFloat()
+    }
+
+  override fun addListener(onChanged: (value: Double) -> Unit) {
+    listeners.add(onChanged)
+    ensureValueListenerJob(viewModelNumber.valueFlow.map { it.toDouble() })
+  }
+}

android/src/main/java/com/margelo/nitro/rive/HybridViewModelStringProperty.kt

@@ -0,0 +1,22 @@
+package com.margelo.nitro.rive
+
+import androidx.annotation.Keep
+import app.rive.runtime.kotlin.core.ViewModelStringProperty
+import com.facebook.proguard.annotations.DoNotStrip
+
+@Keep
+@DoNotStrip
+class HybridViewModelStringProperty(private val viewModelString: ViewModelStringProperty) :
+  HybridViewModelStringPropertySpec(),
+  BaseHybridViewModelProperty<String> by BaseHybridViewModelPropertyImpl() {
+  override var value: String
+    get() = viewModelString.value
+    set(value) {
+      viewModelString.value = value
+    }
+
+  override fun addListener(onChanged: (value: String) -> Unit) {
+    listeners.add(onChanged)
+    ensureValueListenerJob(viewModelString.valueFlow)
+  }
+}

android/src/main/java/com/margelo/nitro/rive/HybridViewModelTriggerProperty.kt

@@ -0,0 +1,21 @@
+package com.margelo.nitro.rive
+
+import androidx.annotation.Keep
+import app.rive.runtime.kotlin.core.ViewModelTriggerProperty
+import com.facebook.proguard.annotations.DoNotStrip
+
+@Keep
+@DoNotStrip
+class HybridViewModelTriggerProperty(private val viewModelTrigger: ViewModelTriggerProperty) :
+  HybridViewModelTriggerPropertySpec(),
+  BaseHybridViewModelProperty<ViewModelTriggerProperty.TriggerUnit> by BaseHybridViewModelPropertyImpl() {
+  override fun trigger() {
+    viewModelTrigger.trigger()
+  }
+
+  override fun addListener(onChanged: () -> Unit) {
+    listeners.add { _ -> onChanged() }
+    // We drop the first value as a trigger has no initial value
+    ensureValueListenerJob(viewModelTrigger.valueFlow, 1)
+  }
+}

android/src/main/java/com/rive/RiveReactNativeView.kt

@@ -28,7 +28,10 @@ class RiveReactNativeView(context: ThemedReactContext) : FrameLayout(context) {
 
   //region Public Methods (API)
   fun bindViewModelInstance(vmi: ViewModelInstance) {
-    riveAnimationView?.controller?.stateMachines?.first()?.viewModelInstance = vmi
+    val stateMachines = riveAnimationView?.controller?.stateMachines
+    if (!stateMachines.isNullOrEmpty()) {
+      stateMachines.first().viewModelInstance = vmi
+    }
   }
 
   fun play() {