Develop v0.1.0

Assets/CHANGELOG.md

@@ -1,9 +1,51 @@
 # Changelog
 
-## [1.0.0] - YYYY-MM-DD
+## [0.0.4-preview.5] - 2019-08-06
 
-* Initial version
+Refactor code
 
 ### Features
 
-* 
+* Add Interval event
+
+### Improvements
+
+* Refactor codes
+* Reverses reference direction between Publishers
+
+## [0.0.3-preview.4] - 2019-08-06
+
+Fix minor bugs
+
+### Fixes
+
+* Avoid `CS0649` warning
+* Fix version conflicts in UniRx
+
+## [0.0.2-preview.3] - 2019-08-06
+
+Support many events
+
+### Features
+
+* Support Lifecycle events
+* Support Physics/Physics2D events
+* Support Camera, Transform, RectTransform events
+* Support Audio events
+
+### Improvements
+
+* Connect events correctly
+* Refresh EventMessages on re-invoke event
+
+### Supports
+
+* Supported Unity version bumped up to 2019.2
+
+## [0.0.1] - 2019-07-21
+
+Initial version
+
+### Features
+
+* Implements simple events

Assets/README.md

@@ -1,13 +1,13 @@
-# Event Connector
+# UniFlow
 
-EventConnector is a library that can connect various Unity events including user interaction without writing any C# script.
+UniFlow is a library that can connect various Unity components without writing any C# script.
 
-Processes such as "Tutorial that accepts user interaction" and "Waiting for the end of playback of Animation, Audio, Timeline, etc." can be implemented easily.
+You can implement easily processes such as "Tutorial that accepts user interaction" and "Waiting for the end of playback of Animation, Audio, Timeline, etc.".
 
 ## Installation
 
 ```bash
-upm add package dev.monry.upm.eventconnector
+upm add package dev.monry.uniflow
 ```
 
 Please refer to [this repository](https://github.com/upm-packages/upm-cli) about the `upm` command.
@@ -16,37 +16,38 @@ Please refer to [this repository](https://github.com/upm-packages/upm-cli) about
 
 ### Basics
 
-#### 1. Attach EventPublishers
+#### 1. Attach Connectors
 
-Attach one or more Components what implements `IEventConnectable` listed below into GameObject.
+Attach one or more Components what implements `ConnectorBase` listed below into GameObject.
 
-#### 2. Implement EventReceiver
+#### 2. Connect Connectors
 
-Implement Component what inherits `EventReceiver`.
+Set *Next `ConnectorBase`* into **Target Instances** field for each Connectors.
 
-Implement the process you want to execute when the event is received in the `OnReceive()` method that needs to override by `EventReceiver`.
+It is also possible to solve with `Zenject.ResolveIdAll<T>()` by setting ID in **Target Ids** field
 
-This method will be passed `EventMessages` what contains all propagated event informations.
+#### 3. Implement Receiver
 
-#### 3. Connect EventConnectors and EventReceiver
+Implement Component what inherits `ReceiverBase`.
 
-Set **Next IEventConnectable** into *Target Connector Instances* field for each EventPublisher.
+Implement the process you want to execute when the event is received in the `OnReceive()` method that needs to override by `ReceiverBase`.
 
-It is also possible to solve with `Zenject.ResolveIdAll<T>()` by setting ID in *Target Connector Ids* field
+This method will be passed `EventMessages` what contains all propagated event informations.
 
 ### Inspector
 
 <img width="317" alt="inspector" src="https://user-images.githubusercontent.com/838945/62629227-bf136480-b967-11e9-850e-e336c1e912db.png">
 
-#### Target Connector Instances
+#### Target Instances
 
-Specify instances what inherits `EventPublisher` or `EventReceiver` into this field.
+Specify instances what inherits `ConnectableBase` into this field.<br />
+\* `ConnectorBase` and `ReceiverBase` are inherits `ConnectableBase`
 
 Fire messages at the correct time for each component.
 
-#### Target Connector Instances
+#### Target Ids
 
-Specify IDs what provides instances of `EventPublisher` or `EventReceiver` resolved by `Zenject.ResolveIdAll()` into this field.
+Specify IDs what provides instances of `IConnectable` resolved by `Zenject.ResolveIdAll()` into this field.
 
 Fire messages at the correct time for each component.
 
@@ -58,11 +59,11 @@ Set true to allow to act as the entry point of events.
 
 Set true to allow to act as the receiver of events.
 
-#### Other parameters for each Publisher
+#### Other parameters for each Connector
 
 Individual parameters can be specified for each component.
 
-## Components what inherits `EventPublisher`
+## Components what inherits `ConnectorBase`
 
 ### Messaging from traditional callback
 

Assets/Scripts/ConnectableBase.cs

@@ -0,0 +1,8 @@
+using UnityEngine;
+
+namespace UniFlow
+{
+    public abstract class ConnectableBase : MonoBehaviour, IConnectable
+    {
+    }
+}

Assets/Scripts/Connector/AnimationEvent.cs

@@ -1,21 +1,83 @@
 using System;
+using System.Linq;
 using JetBrains.Annotations;
 using UniRx;
 using UnityEngine;
 
-namespace EventConnector.Connector
+namespace UniFlow.Connector
 {
-    // AnimationEvent cannot fire to Component attaching to another GameObject
-    [RequireComponent(typeof(Animator))]
-    [AddComponentMenu("Event Connector/AnimationEvent", 301)]
-    public class AnimationEvent : EventPublisher
+    [AddComponentMenu("UniFlow/AnimationEvent", 302)]
+    public class AnimationEvent : ConnectorBase
     {
+        [SerializeField]
+        [Tooltip("If you do not specify it will be used SimpleAnimation setting")]
+        private AnimationClip animationClip = default;
+        private AnimationClip AnimationClip
+        {
+            get => animationClip;
+            [UsedImplicitly]
+            set => animationClip = value;
+        }
+
+        [SerializeField] private AnimatorCullingMode cullingMode = AnimatorCullingMode.AlwaysAnimate;
+        private AnimatorCullingMode CullingMode
+        {
+            get => cullingMode;
+            [UsedImplicitly]
+            set => cullingMode = value;
+        }
+
+        [SerializeField] private AnimatorUpdateMode updateMode = AnimatorUpdateMode.Normal;
+        private AnimatorUpdateMode UpdateMode
+        {
+            get => updateMode;
+            [UsedImplicitly]
+            set => updateMode = value;
+        }
+
+        private Animator animator = default;
+        private Animator Animator
+        {
+            get =>
+                animator != default
+                    ? animator
+                    : animator =
+                        GetComponent<Animator>() != default
+                            ? GetComponent<Animator>()
+                            : gameObject.AddComponent<Animator>();
+            [UsedImplicitly]
+            set => animator = value;
+        }
+
+        private SimpleAnimation simpleAnimation = default;
+        private SimpleAnimation SimpleAnimation
+        {
+            get =>
+                simpleAnimation != default
+                    ? simpleAnimation
+                    : simpleAnimation =
+                        GetComponent<SimpleAnimation>() != default
+                            ? GetComponent<SimpleAnimation>()
+                            : gameObject.AddComponent<SimpleAnimation>()
+            ;
+            [UsedImplicitly]
+            set => simpleAnimation = value;
+        }
+
         private ISubject<UnityEngine.AnimationEvent> Subject { get; } = new Subject<UnityEngine.AnimationEvent>();
 
-        public override IObservable<EventMessage> OnPublishAsObservable() =>
-            Subject
+        public override IObservable<EventMessage> OnConnectAsObservable()
+        {
+            if (AnimationClip != default && GetComponent<Animator>() == default && SimpleAnimation.GetStates().All(x => x.clip != AnimationClip))
+            {
+                SimpleAnimation.AddClip(AnimationClip, AnimationClip.GetInstanceID().ToString());
+            }
+
+            return Subject
+                // Prevents the previous flow from being re-invoked when triggered multiple times
                 .Take(1)
-                .Select(x => EventMessage.Create(EventType.AnimationEvent, this, x));
+                .Select(x => EventMessage.Create(ConnectorType.AnimationEvent, this, x));
+        }
 
         /// <summary>
         /// Invoked from AnimationEvent
@@ -26,5 +88,17 @@ public void Dispatch(UnityEngine.AnimationEvent animationEvent)
         {
             Subject.OnNext(animationEvent);
         }
+
+        private void Awake()
+        {
+            // ReSharper disable once InvertIf
+            // Automatic add components Animator and SimpleAnimation if AudioClip specified and Animator component does not exists.
+            if (AnimationClip != default && Animator == default && SimpleAnimation.GetStates().All(x => x.clip != AnimationClip))
+            {
+                SimpleAnimation.AddClip(AnimationClip, AnimationClip.GetInstanceID().ToString());
+                SimpleAnimation.cullingMode = CullingMode;
+                Animator.updateMode = UpdateMode;
+            }
+        }
     }
 }

Assets/Scripts/Connector/AnimatorTrigger.cs

@@ -1,34 +1,43 @@
 using System;
-using EventConnector.Message;
+using JetBrains.Annotations;
+using UniFlow.Message;
 using UniRx;
 using UnityEngine;
 
-namespace EventConnector.Connector
+namespace UniFlow.Connector
 {
-    [AddComponentMenu("Event Connector/AnimatorTrigger", 300)]
-    public class AnimatorTrigger : EventPublisher
+    [AddComponentMenu("UniFlow/AnimatorTrigger", 301)]
+    public class AnimatorTrigger : ConnectorBase
     {
         [SerializeField]
         [Tooltip("If you do not specify it will be obtained by GameObject.GetComponent<Animator>()")]
         private Animator animator = default;
+        private Animator Animator => animator ? animator : animator = GetComponent<Animator>();
+
         [SerializeField] private string triggerName = default;
+        private string TriggerName
+        {
+            get => triggerName;
+            [UsedImplicitly]
+            set => triggerName = value;
+        }
 
-        private Animator Animator => animator ? animator : animator = GetComponent<Animator>();
-        private string TriggerName => triggerName;
         private int TriggerId => Animator.StringToHash(TriggerName);
 
         private IDisposable Disposable { get; } = new CompositeDisposable();
 
-        public override IObservable<EventMessage> OnPublishAsObservable() =>
-            Observable
+        public override IObservable<EventMessage> OnConnectAsObservable()
+        {
+            return Observable
                 .Create<EventMessage>(
                     observer =>
                     {
                         Animator.SetTrigger(TriggerId);
-                        observer.OnNext(EventMessage.Create(EventType.AnimatorTrigger, Animator, AnimatorTriggerEventData.Create(TriggerName)));
+                        observer.OnNext(EventMessage.Create(ConnectorType.AnimatorTrigger, Animator, AnimatorTriggerEventData.Create(TriggerName)));
                         return Disposable;
                     }
                 );
+        }
 
         private void OnDestroy()
         {

Assets/Scripts/Connector/AudioController.cs

@@ -1,33 +1,68 @@
 using System;
-using EventConnector.Message;
+using JetBrains.Annotations;
+using UniFlow.Message;
 using UniRx;
 using UnityEngine;
 
-namespace EventConnector.Connector
+namespace UniFlow.Connector
 {
-    [AddComponentMenu("Event Connector/AudioController", 302)]
-    public class AudioController : EventPublisher
+    [AddComponentMenu("UniFlow/AudioController", 303)]
+    public class AudioController : ConnectorBase
     {
         [SerializeField] private AudioControlMethod audioControlMethod = default;
+        private AudioControlMethod AudioControlMethod
+        {
+            get => audioControlMethod;
+            [UsedImplicitly]
+            set => audioControlMethod = value;
+        }
+
         [SerializeField]
-        [Tooltip("If you do not specify it will be obtained by GameObject.GetComponent<AudioSource>()")]
-        private AudioSource audioSource = default;
+        [Tooltip("If you do not specify it will be obtained by AudioSource.clip")]
+        private AudioClip audioClip = default;
+        private AudioClip AudioClip
+        {
+            get => audioClip;
+            [UsedImplicitly]
+            set => audioClip = value;
+        }
 
-        private AudioControlMethod AudioControlMethod => audioControlMethod;
-        private AudioSource AudioSource => audioSource ? audioSource : audioSource = GetComponent<AudioSource>();
+        private AudioSource audioSource = default;
+        private AudioSource AudioSource
+        {
+            get =>
+                audioSource != default
+                    ? audioSource
+                    : audioSource =
+                        GetComponent<AudioSource>() != default
+                            ? GetComponent<AudioSource>()
+                            : gameObject.AddComponent<AudioSource>();
+            [UsedImplicitly]
+            set => audioSource = value;
+        }
 
         private IDisposable Disposable { get; } = new CompositeDisposable();
 
-        public override IObservable<EventMessage> OnPublishAsObservable() =>
-            Observable
+        public override IObservable<EventMessage> OnConnectAsObservable()
+        {
+            return Observable
                 .Create<EventMessage>(
                     observer =>
                     {
                         InvokeAudioSourceMethod();
-                        observer.OnNext(EventMessage.Create(EventType.AudioController, AudioSource, AudioControllerEventData.Create(AudioControlMethod)));
+                        observer.OnNext(EventMessage.Create(ConnectorType.AudioController, AudioSource, AudioControllerEventData.Create(AudioControlMethod)));
                         return Disposable;
                     }
                 );
+        }
+
+        private void Awake()
+        {
+            if (AudioClip != default)
+            {
+                AudioSource.clip = AudioClip;
+            }
+        }
 
         private void InvokeAudioSourceMethod()
         {