Merge pull request #56 from mixer/support-key-accelerators-for-buttons

Label control and setting button properties

Author: payzer

Source/InteractiveSDK/Assets/MixerInteractive/Source/Scripts/InteractiveControl.cs

@@ -81,12 +81,30 @@ public void SetDisabled(bool disabled)
                 0);
         }
 
+        /// <summary>
+        /// This function allows you to set any property on a control.
+        /// </summary>
+        /// <param name="name">The name of the control property.</param>
+        /// <param name="value">The value of the control property.</param>
+        public void SetProperty(InteractiveControlProperty name, object value)
+        {
+            SetPropertyImpl(
+                InteractivityManager.SingletonInstance.InteractiveControlPropertyToString(name), 
+                value
+                );
+        }
+
         /// <summary>
         /// This function allows you to set any property on a control.
         /// </summary>
         /// <param name="name">The name of the control property.</param>
         /// <param name="value">The value of the control property.</param>
         public void SetProperty(string name, object value)
+        {
+            SetPropertyImpl(name, value);
+        }
+
+        private void SetPropertyImpl(string name, object value)
         {
             InteractivityManager.SingletonInstance.QueuePropertyUpdate(SceneID, ControlID, name, value);
         }

Source/InteractiveSDK/Assets/MixerInteractive/Source/Scripts/InteractiveControlProperty.cs

@@ -0,0 +1,74 @@
+/*
+ * Mixer Unity SDK
+ *
+ * Copyright (c) Microsoft Corporation
+ * All rights reserved.
+ *
+ * MIT License
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the "Software"), to deal in the Software
+ * without restriction, including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
+ * to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+using System;
+
+namespace Microsoft.Mixer
+{
+    /// <summary>
+    /// The known values for control properties.
+    /// </summary>
+    public enum InteractiveControlProperty
+    {
+        /// <summary>
+        /// The display test of the control.
+        /// </summary>
+        Text,
+
+        /// <summary>
+        /// The background color of the control.
+        /// </summary>
+        BackgroundColor,
+
+        /// <summary>
+        /// The background image of the control.
+        /// </summary>
+        BackgroundImage,
+
+        /// <summary>
+        /// The text color of the display text for the control.
+        /// </summary>
+        TextColor,
+
+        /// <summary>
+        /// The text size of the display text for the control.
+        /// </summary>
+        TextSize,
+
+        /// <summary>
+        /// The border color of the control.
+        /// </summary>
+        BorderColor,
+
+        /// <summary>
+        /// The focus color of the control.
+        /// </summary>
+        FocusColor,
+
+        /// <summary>
+        /// The accent color. Where this color shows up will depend on the control.
+        /// </summary>
+        AccentColor
+    }
+}

Source/InteractiveSDK/Assets/MixerInteractive/Source/Scripts/InteractiveControlProperty.cs.meta

@@ -0,0 +1,67 @@
+/*
+ * Mixer Unity SDK
+ *
+ * Copyright (c) Microsoft Corporation
+ * All rights reserved.
+ *
+ * MIT License
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the "Software"), to deal in the Software
+ * without restriction, including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
+ * to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+using System;
+using System.Collections.Generic;
+
+namespace Microsoft.Mixer
+{
+    /// <summary>
+    /// Represents an interactive label control. All controls are created and 
+    /// configured using Interactive Studio.
+    /// </summary>
+#if !WINDOWS_UWP
+    [System.Serializable]
+#endif
+    public class InteractiveLabelControl : InteractiveControl
+    {
+        /// <summary>
+        /// Text displayed on this control.
+        /// </summary>
+        public string Text
+        {
+            get;
+            private set;
+        }
+
+        /// <summary>
+        /// Function to update the text for the label control.
+        /// </summary>
+        /// <param name="text">String to display on the label.</param>
+        public void SetText(string text)
+        {
+            InteractivityManager interactivityManager = InteractivityManager.SingletonInstance;
+            interactivityManager.QueuePropertyUpdate(
+                SceneID, 
+                ControlID,
+                interactivityManager.InteractiveControlPropertyToString(InteractiveControlProperty.Text), 
+                text);
+        }
+
+        public InteractiveLabelControl(string controlID, InteractiveEventType type, string text, string sceneID) : base(controlID, InteractivityManager.CONTROL_TYPE_BUTTON, type, false, "", "", sceneID)
+        {
+            Text = text;
+        }
+    }
+}

Source/InteractiveSDK/Assets/MixerInteractive/Source/Scripts/InteractiveLabelControl.cs

@@ -3762,6 +3762,42 @@ internal void RegisterControlForValueUpdates(string controlTypeName, List<string
                 }
             }
         }
+
+        internal string InteractiveControlPropertyToString(InteractiveControlProperty property)
+        {
+            string controlPropertyString = string.Empty;
+            switch (property)
+            {
+                case InteractiveControlProperty.Text:
+                    controlPropertyString = "text";
+                    break;
+                case InteractiveControlProperty.BackgroundColor:
+                    controlPropertyString = "backgroundColor";
+                    break;
+                case InteractiveControlProperty.BackgroundImage:
+                    controlPropertyString = "backgroundImage";
+                    break;
+                case InteractiveControlProperty.TextColor:
+                    controlPropertyString = "textColor";
+                    break;
+                case InteractiveControlProperty.TextSize:
+                    controlPropertyString = "textSize";
+                    break;
+                case InteractiveControlProperty.BorderColor:
+                    controlPropertyString = "borderColor";
+                    break;
+                case InteractiveControlProperty.FocusColor:
+                    controlPropertyString = "focusColor";
+                    break;
+                case InteractiveControlProperty.AccentColor:
+                    controlPropertyString = "accentColor";
+                    break;
+                default:
+                    // No-op: Unexpected property.
+                    break;
+            }
+            return controlPropertyString;
+        }
     }
 
     internal struct InternalButtonCountState