Merge pull request Live2D#30 from Live2D/feature/add_canvas_information

add canvas information

Author: ono-at-live2d-com

Assets/Live2D/Cubism/Core/CubismCanvasInformation.cs

@@ -0,0 +1,121 @@
+/*
+ * Copyright(c) Live2D Inc. All rights reserved.
+ * 
+ * Use of this source code is governed by the Live2D Open Software license
+ * that can be found at http://live2d.com/eula/live2d-open-software-license-agreement_en.html.
+ */
+
+
+using Live2D.Cubism.Core.Unmanaged;
+using Live2D.Cubism.Framework;
+using UnityEngine;
+
+
+namespace Live2D.Cubism.Core
+{
+    /// <summary>
+    /// Single <see cref="CubismModel"/> canvas information.
+    /// </summary>
+    [CubismDontMoveOnReimport]
+    public sealed class CubismCanvasInformation
+    {
+        /// <summary>
+        /// Initializes instance.
+        /// </summary>
+        /// <param name="unmanagedModel">Handle to unmanaged model.</param>
+        public CubismCanvasInformation(CubismUnmanagedModel unmanagedModel)
+        {
+            Reset(unmanagedModel);
+        }
+
+
+        /// <summary>
+        /// Unmanaged canvas information from unmanaged model.
+        /// </summary>
+        private CubismUnmanagedCanvasInformation UnmanagedCanvasInformation { get; set; }
+
+
+        /// <summary>
+        /// Width of native model canvas.
+        /// </summary>
+        public float CanvasWidth
+        {
+            get
+            {
+                // Pull data.
+                return UnmanagedCanvasInformation.CanvasWidth;
+            }
+        }
+
+
+        /// <summary>
+        /// Height of native model canvas.
+        /// </summary>
+        public float CanvasHeight
+        {
+            get
+            {
+                // Pull data.
+                return UnmanagedCanvasInformation.CanvasHeight;
+            }
+        }
+
+
+        /// <summary>
+        /// Coordinate origin of X axis.
+        /// </summary>
+        public float CanvasOriginX
+        {
+            get
+            {
+                // Pull data.
+                return UnmanagedCanvasInformation.CanvasOriginX;
+            }
+        }
+
+
+        /// <summary>
+        /// Coordinate origin of Y axis.
+        /// </summary>
+        public float CanvasOriginY
+        {
+            get
+            {
+                // Pull data.
+                return UnmanagedCanvasInformation.CanvasOriginY;
+            }
+        }
+
+
+        /// <summary>
+        /// Pixels per unit of native model.
+        /// </summary>
+        public float PixelsPerUnit
+        {
+            get
+            {
+                // Pull data.
+                return UnmanagedCanvasInformation.PixelsPerUnit;
+            }
+        }
+
+
+        /// <summary>
+        /// Revives the instance.
+        /// </summary>
+        /// <param name="unmanagedModel">Handle to unmanaged model.</param>
+        internal void Revive(CubismUnmanagedModel unmanagedModel)
+        {
+            UnmanagedCanvasInformation = unmanagedModel.CanvasInformation;
+        }
+
+        /// <summary>
+        /// Restores instance to initial state.
+        /// </summary>
+        /// <param name="unmanagedModel">Handle to unmanaged model.</param>
+        private void Reset(CubismUnmanagedModel unmanagedModel)
+        {
+            Revive(unmanagedModel);
+        }
+    }
+}

Assets/Live2D/Cubism/Core/CubismModel.cs

@@ -173,6 +173,30 @@ public CubismDrawable[] Drawables
             private set { _drawables = value; }
         }
 
+        /// <summary>
+        /// <see cref="CanvasInformation"/> backing field.
+        /// </summary>
+        [NonSerialized]
+        private CubismCanvasInformation _canvasInformation;
+
+        /// <summary>
+        /// Canvas information of model.
+        /// </summary>
+        public CubismCanvasInformation CanvasInformation
+        {
+            get
+            {
+                if (_canvasInformation == null)
+                {
+                    Revive();
+                }
+
+
+                return _canvasInformation;
+            }
+            private set { _canvasInformation = value; }
+        }
+
         /// <summary>
         /// Parameter store cache.
         /// </summary>
@@ -222,11 +246,12 @@ private void Revive()
             Parts = GetComponentsInChildren<CubismPart>();
             Drawables = GetComponentsInChildren<CubismDrawable>();
 
-
             Parameters.Revive(TaskableModel.UnmanagedModel);
             Parts.Revive(TaskableModel.UnmanagedModel);
             Drawables.Revive(TaskableModel.UnmanagedModel);
 
+            CanvasInformation = new CubismCanvasInformation(TaskableModel.UnmanagedModel);
+
             _parameterStore = GetComponent<CubismParameterStore>();
         }
 
@@ -255,6 +280,8 @@ private void Reset(CubismMoc moc)
             Parameters = parameters.GetComponentsInChildren<CubismParameter>();
             Parts = parts.GetComponentsInChildren<CubismPart>();
             Drawables = drawables.GetComponentsInChildren<CubismDrawable>();
+
+            CanvasInformation = new CubismCanvasInformation(TaskableModel.UnmanagedModel);
         }
 
         /// <summary>