メインコンテンツへスキップ
見出し画像

超簡易的な自作Scroll Rectの実装

    簡易的なScroll Rectの実装について紹介します。
    要件としては
    1. ある表示範囲に表示範囲より大きい表示領域を表示させるためにスクロール可能にする。
    2. スクロールホイール、 ドラッグ、 スライダー操作により表示位置を変えられるようにする。

    構造としては次のような構造とします。

    画像

    枠線などを含んだ親要素(TestScrollRectPanel )の子要素として

    画像

    実際の表示ゾーン(TestScrollRectMaskZone)を設定します。 RectMask2Dをアタッチすることで範囲外には表示させないようにすることができます。 

    この表示ゾーンの子として表示させたい要素を含むパネル(InnerPanel)を配置します。
    この時スクロールの際に表示位置を設定しやすくするように
    RectTransformの配置はtop senterとし、 またAnchorsの位置はx = 0.5, y = 1 とします。

    画像

    TestScrollRectMaskZoneには次のようなスクリプトをアタッチします。
    スライダーの枠の厚さが固定で、なおかつマジックナンバーであったり、汎用性は低いですが。
    MyScrollRectMaskZoneMotion.cs

    using UnityEngine;
    using UnityEngine.EventSystems;
    using UnityEngine.UI;
    
    public class MyScrollRectMaskZoneMotion : MonoBehaviour, IScrollHandler, IDragHandler
    {
        public const float SCROLL_SPEED = 0.5f;
        public const float DRAG_SPEED = 0.004f;
    
        [SerializeField]
        private Slider slider;
        [SerializeField]
        private RectTransform innerPanelRect; // これについてはスライダー調整時に位置がきちんと配置されるように、センター&トップ配置(RectTransformにおいて 十 配置でなく T 配置にする)にし
                                              // Anchor Pivotは x = 0.5 , y = 1とすること、 この場合 RectTransform == 0 の場合に表示面の一番上にピッタリにInner Panel最上部が位置する
    
        [SerializeField]
        private RectTransform handleSlideAreaRect;
        [SerializeField]
        private RectTransform handle;
    
        private float sliderHeight;
        private float maskZoneHeight;
        private float innerPanelHeight;
        private float scrollDistance;
    
        private void Awake()
        {
            sliderHeight = slider.GetComponent<RectTransform>().rect.height;
            maskZoneHeight = this.GetComponent<RectTransform>().rect.height;
            innerPanelHeight = innerPanelRect.rect.height;
            if (innerPanelHeight <= 0)
            {
                innerPanelHeight = 1; // 基本的に不正設定でないとここをとおらないが 0除算防止などのためにチェックして 0でない値を入れておく
            }
    
            scrollDistance = innerPanelHeight - maskZoneHeight;
            if (scrollDistance < 0)
            {
                scrollDistance = 0;
            }
        }
    
        private void OnEnable()
        {
            slider.SetValueWithoutNotify(0); // コールバック無しの値設定
    
            Vector2 pos = innerPanelRect.anchoredPosition;
            pos.y = 0;
            innerPanelRect.anchoredPosition = pos;
        }
    
        void Start()
        {
            SetHandleSlideAreaHeight();
        }
    
        public void SetHandleSlideAreaHeight()
        {
            float height = sliderHeight - 6f; // 3fはスライダーの枠の厚さ 上下左右ともに3f 上下で3f + 3f = 6f
            float heightRatio = 1f;
    
            heightRatio = maskZoneHeight / innerPanelHeight;
    
            if (heightRatio > 1)
            {
                heightRatio = 1;
            }
            height = height * heightRatio;
    
            if (height < 60f)
            {
                height = 60f; // 小さすぎると選択しにくいのと見にくいので最低限の大きさを指定
            }
    
            Vector2 size = handle.sizeDelta;
            size.y = height;
            handle.sizeDelta = size;
    
            float top = (height / 2) + 3f; // 3fはスライダーの枠の厚さ 上下左右ともに3f
            float bottom = top; // 同じ値となるので
            SetHandleSlideAreaMargins(top, bottom);
        }
    
        public void SetHandleSlideAreaMargins(float top, float bottom)
        {
            handleSlideAreaRect.offsetMin = new Vector2(handleSlideAreaRect.offsetMin.x, bottom);
            handleSlideAreaRect.offsetMax = new Vector2(handleSlideAreaRect.offsetMax.x, -top);
        }
    
        public void OnScroll(PointerEventData eventData)
        {
            float value = slider.value;
            value = value - (Mathf.Sign(eventData.scrollDelta.y) * SCROLL_SPEED);
    
            value = Mathf.Clamp(value, 0f, slider.maxValue);
    
            slider.value = value;
            slider.SetValueWithoutNotify(value); // コールバック無しの値設定
    
            SetPositionInnerPanel(value);
        }
    
        public void OnDrag(PointerEventData eventData)
        {
            // ドラッグ量をスライダー変化に変換
            float delta = eventData.delta.y * DRAG_SPEED;
    
            float value = slider.value;
            value = value + delta;
    
            value = Mathf.Clamp(value, 0f, slider.maxValue);
    
            slider.SetValueWithoutNotify(value);
            SetPositionInnerPanel(value);
        }
    
        public void SetPositionInnerPanel(float value)
        {
            Vector2 pos = innerPanelRect.anchoredPosition;
            pos.y = scrollDistance * value;
            innerPanelRect.anchoredPosition = pos;
        }
    
        public void OnSliderChanged(float value)
        {
            SetPositionInnerPanel(value);
        }
    }

    次のようにインスペクタで設定します。

    画像

    スライダーは次のように設定します。

    画像

    これで基本的に動作します。

    通常のScroll Rectを使えない場面というのも少ないので、 それほど利用場面はないかとおもいますが、 たとえばスライダーをスクロール画面とは独立した場所に配置したい場合であったり、 若干でも動作を軽くしたい場合なら必要となるかもしれません。 デフォルトのScroll Rectでなく自作したいといった場合はここから機能追加するなり さらに汎用性を高めて自分用アセットにするなりできるかとおもいます。

    以上になります。

     
     
    ゲーム制作グループ StUseSoftです。 https://x.com/StUseSoft 現在REVERSI xVSxを開発中です。 質問等があったらStUseSoftの Xにお願いします。 返事が必ずできるかわかりませんが。

    あなたへのおすすめ