< Summary

Class:CarouselComponentView
Assembly:UIComponents
File(s):/tmp/workspace/unity-renderer/unity-renderer/Assets/UIComponents/Scripts/Components/Carousel/CarouselComponentView.cs
Covered lines:183
Uncovered lines:51
Coverable lines:234
Total lines:628
Line coverage:78.2% (183 of 234)
Covered branches:0
Total branches:0

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity NPath complexity Sequence coverage
CarouselComponentView()0%110100%
Awake()0%110100%
Start()0%220100%
Configure(...)0%110100%
RefreshControl()0%22090.91%
OnScreenSizeChanged()0%110100%
Dispose()0%110100%
SetSpaceBetweenItems(...)0%2.032080%
SetTimeBetweenItems(...)0%2100%
SetAnimationTransitionTime(...)0%2100%
SetAnimationCurve(...)0%2100%
SetBackgroundColor(...)0%2.262060%
SetManualControlsActive(...)0%6.076087.5%
SetItems(...)0%6200%
SetItems(...)0%220100%
AddItem(...)0%110100%
RemoveItem(...)0%220100%
GetItems()0%2100%
ExtractItems()0%220100%
RemoveItems()0%110100%
StartCarousel(...)0%110100%
StopCarousel()0%220100%
GoToPreviousItem()0%2.062075%
ResetCarousel()0%2100%
GoToNextItem()0%2.062075%
MakeJumpFromDotsSelector(...)0%2.062075%
ConfigureManualButtonsEvents()0%330100%
CreateItem(...)0%2.012088.89%
ResizeItem(...)0%110100%
ResizeAllItems()0%440100%
DestroyInstantiatedItems()0%330100%
RunCarouselCoroutine()0%32.8714054.17%
RunRightAnimation()0%9.665042.86%
RunLeftAnimation()0%9.665042.86%
RunAnimationCoroutine()0%5.735069.23%
GenerateDotsSelector()0%660100%
SetSelectedDot(...)0%550100%
RegisterCurrentInstantiatedItems()0%6.026092.31%

File(s)

/tmp/workspace/unity-renderer/unity-renderer/Assets/UIComponents/Scripts/Components/Carousel/CarouselComponentView.cs

#LineLine coverage
 1using DCL.Helpers;
 2using System.Collections;
 3using System.Collections.Generic;
 4using System.Linq;
 5using UnityEngine;
 6using UnityEngine.UI;
 7
 8public interface ICarouselComponentView
 9{
 10    /// <summary>
 11    /// Set the distance between carousel items.
 12    /// </summary>
 13    /// <param name="newSpace">Distance between items.</param>
 14    void SetSpaceBetweenItems(float newSpace);
 15
 16    /// <summary>
 17    /// Set the time that will be pass between carousel items.
 18    /// </summary>
 19    /// <param name="newTime">Time between items.</param>
 20    void SetTimeBetweenItems(float newTime);
 21
 22    /// <summary>
 23    /// Set the time that will be pass during the transition between items.
 24    /// </summary>
 25    /// <param name="newTime">Transition time between items.</param>
 26    void SetAnimationTransitionTime(float newTime);
 27
 28    /// <summary>
 29    /// Set the animation curve that will be used for the animation between items.
 30    /// </summary>
 31    /// <param name="newCurve">Animation curve between items.</param>
 32    void SetAnimationCurve(AnimationCurve newCurve);
 33
 34    /// <summary>
 35    /// Set the color of the carousel background.
 36    /// </summary>
 37    /// <param name="newColor">Background color.</param>
 38    void SetBackgroundColor(Color newColor);
 39
 40    /// <summary>
 41    /// Activates/Deactivates the controls to go to the next/previous item manually.
 42    /// </summary>
 43    /// <param name="isActived">True for activating the manual controls.</param>
 44    void SetManualControlsActive(bool isActived);
 45
 46    /// <summary>
 47    /// Set the items of the carousel.
 48    /// </summary>
 49    /// <param name="items">List of UI components.</param>
 50    void SetItems(List<BaseComponentView> items);
 51
 52    /// <summary>
 53    /// Creates the items of the carousel from the prefab. All previously existing items will be removed.
 54    /// </summary>
 55    /// <param name="prefab">Prefab to create items</param>
 56    /// <param name="amountOfItems">Amounts of items to be created</param>
 57    void SetItems(BaseComponentView prefab, int amountOfItems);
 58
 59    /// <summary>
 60    /// Adds a new item in the carousel.
 61    /// </summary>
 62    /// <param name="item">An UI component.</param>
 63    void AddItem(BaseComponentView item);
 64
 65    /// <summary>
 66    /// Remove an item from the carousel.
 67    /// </summary>
 68    /// <param name="item">An UI component</param>
 69    void RemoveItem(BaseComponentView item);
 70
 71    /// <summary>
 72    /// Get all the items of the carousel.
 73    /// </summary>
 74    /// <returns>The list of items.</returns>
 75    List<BaseComponentView> GetItems();
 76
 77    /// <summary>
 78    /// Extract all items out of the carousel.
 79    /// </summary>
 80    /// <returns>The list of extracted items.</returns>
 81    List<BaseComponentView> ExtractItems();
 82
 83    /// <summary>
 84    /// Remove all existing items from the carousel.
 85    /// </summary>
 86    void RemoveItems();
 87
 88    /// <summary>
 89    /// Start carousel animation.
 90    /// </summary>
 91    /// <param name="fromIndex">It specifies from where item the carousel will start.</param>
 92    /// <param name="startInmediately">True to directly execute the first transition.</param>
 93    /// <param name="direction">Set the direction of the carousel animations: right or left.</param>
 94    /// <param name="changeDirectionAfterFirstTransition">True to change the carousel direction just after the first tra
 95    /// <param name="numberOfInitialJumps">Number of jumps that will be executed in the first transition.</param>
 96    void StartCarousel(int fromIndex, bool startInmediately, CarouselDirection direction, bool changeDirectionAfterFirst
 97
 98    /// <summary>
 99    /// Stop carousel animation.
 100    /// </summary>
 101    void StopCarousel();
 102
 103    /// <summary>
 104    /// Force the carousel to show the previous item.
 105    /// </summary>
 106    void GoToPreviousItem();
 107
 108    /// <summary>
 109    /// Force the carousel to show the next item.
 110    /// </summary>
 111    void GoToNextItem();
 112
 113    /// <summary>
 114    /// Force the carousel to jump to a specific item.
 115    /// </summary>
 116    /// <param name="numberOfJumps">Number of jumps that will be executed during the transition.</param>
 117    /// <param name="direction">Direction in which to make the jumps.</param>
 118    void MakeJumpFromDotsSelector(int numberOfJumps, CarouselDirection direction);
 119}
 120
 121public enum CarouselDirection
 122{
 123    Right,
 124    Left
 125}
 126
 127public class CarouselComponentView : BaseComponentView, ICarouselComponentView, IComponentModelConfig
 128{
 129    [Header("Prefab References")]
 130    [SerializeField] internal RectTransform itemsContainer;
 131    [SerializeField] internal HorizontalLayoutGroup horizontalLayout;
 132    [SerializeField] internal ScrollRect itemsScroll;
 133    [SerializeField] internal RectTransform viewport;
 134    [SerializeField] internal Image background;
 135    [SerializeField] internal Button previousButton;
 136    [SerializeField] internal Button nextButton;
 137    [SerializeField] internal HorizontalLayoutGroup dotsSelector;
 138    [SerializeField] internal Button dotButtonTemplate;
 139    [SerializeField] internal Color dotSelectedColor;
 140    [SerializeField] internal Color dotUnselectedColor;
 141
 142    [Header("Configuration")]
 143    [SerializeField] internal CarouselComponentModel model;
 144
 78145    internal List<BaseComponentView> instantiatedItems = new List<BaseComponentView>();
 146    internal Coroutine itemsCoroutine;
 147    internal int currentItemIndex = 0;
 148    internal int currentDotIndex = 0;
 149    internal float currentFinalNormalizedPos;
 150    internal bool isInTransition = false;
 151
 152    public override void Awake()
 153    {
 53154        base.Awake();
 155
 53156        StartCoroutine(RegisterCurrentInstantiatedItems());
 53157        ConfigureManualButtonsEvents();
 53158    }
 159
 160    public override void Start()
 161    {
 26162        if (model.automaticTransition)
 26163            StartCarousel();
 26164    }
 165
 166    public void Configure(BaseComponentModel newModel)
 167    {
 1168        model = (CarouselComponentModel)newModel;
 1169        RefreshControl();
 1170    }
 171
 172    public override void RefreshControl()
 173    {
 1174        if (model == null)
 0175            return;
 176
 1177        SetSpaceBetweenItems(model.spaceBetweenItems);
 1178        SetTimeBetweenItems(model.timeBetweenItems);
 1179        SetAnimationTransitionTime(model.animationTransitionTime);
 1180        SetAnimationCurve(model.animationCurve);
 1181        SetBackgroundColor(model.backgroundColor);
 1182        SetManualControlsActive(model.showManualControls);
 1183        ResizeAllItems();
 1184        GenerateDotsSelector();
 1185    }
 186
 187    public override void OnScreenSizeChanged()
 188    {
 57189        base.OnScreenSizeChanged();
 190
 57191        ResizeAllItems();
 57192    }
 193
 194    public override void Dispose()
 195    {
 140196        base.Dispose();
 197
 140198        StopCarousel();
 140199        DestroyInstantiatedItems();
 140200    }
 201
 202    public void SetSpaceBetweenItems(float newSpace)
 203    {
 2204        model.spaceBetweenItems = newSpace;
 205
 2206        if (horizontalLayout == null)
 0207            return;
 208
 2209        horizontalLayout.spacing = newSpace;
 2210    }
 211
 0212    public void SetTimeBetweenItems(float newTime) { model.timeBetweenItems = newTime; }
 213
 0214    public void SetAnimationTransitionTime(float newTime) { model.animationTransitionTime = newTime; }
 215
 0216    public void SetAnimationCurve(AnimationCurve newCurve) { model.animationCurve = newCurve; }
 217
 218    public void SetBackgroundColor(Color newColor)
 219    {
 2220        model.backgroundColor = newColor;
 221
 2222        if (background == null)
 2223            return;
 224
 0225        background.color = newColor;
 0226    }
 227
 228    public void SetManualControlsActive(bool isActived)
 229    {
 76230        model.showManualControls = isActived;
 231
 76232        if (previousButton == null || nextButton == null)
 0233            return;
 234
 76235        int currentNumberOfItems = itemsContainer.childCount;
 76236        previousButton.gameObject.SetActive(isActived && currentNumberOfItems > 1);
 76237        nextButton.gameObject.SetActive(isActived && currentNumberOfItems > 1);
 76238        dotsSelector.gameObject.SetActive(isActived && currentNumberOfItems > 1);
 76239    }
 240
 241    public void SetItems(BaseComponentView prefab, int amountOfItems)
 242    {
 0243        DestroyInstantiatedItems();
 244
 0245        for (int i = 0; i < amountOfItems; i++)
 246        {
 0247            BaseComponentView instanciatedItem = Instantiate(prefab);
 0248            CreateItem(instanciatedItem, $"Item{i}");
 249        }
 250
 0251        SetManualControlsActive(model.showManualControls);
 0252        GenerateDotsSelector();
 0253    }
 254
 255    public void SetItems(List<BaseComponentView> items)
 256    {
 16257        DestroyInstantiatedItems();
 258
 98259        for (int i = 0; i < items.Count; i++)
 260        {
 33261            CreateItem(items[i], $"Item{i}");
 262        }
 263
 16264        SetManualControlsActive(model.showManualControls);
 16265        GenerateDotsSelector();
 16266    }
 267
 268    public void AddItem(BaseComponentView item)
 269    {
 2270        CreateItem(item, $"Item{instantiatedItems.Count}");
 2271        SetManualControlsActive(model.showManualControls);
 2272        GenerateDotsSelector();
 2273    }
 274
 275    public void RemoveItem(BaseComponentView item)
 276    {
 2277        BaseComponentView itemToRemove = instantiatedItems.FirstOrDefault(x => x == item);
 1278        if (itemToRemove != null)
 279        {
 1280            Destroy(itemToRemove.gameObject);
 1281            instantiatedItems.Remove(item);
 282        }
 283
 1284        SetManualControlsActive(model.showManualControls);
 1285        GenerateDotsSelector();
 1286    }
 287
 0288    public List<BaseComponentView> GetItems() { return instantiatedItems; }
 289
 290    public List<BaseComponentView> ExtractItems()
 291    {
 25292        List<BaseComponentView> extractedItems = new List<BaseComponentView>();
 58293        foreach (BaseComponentView item in instantiatedItems)
 294        {
 4295            item.transform.SetParent(null);
 4296            extractedItems.Add(item);
 297        }
 298
 25299        instantiatedItems.Clear();
 25300        SetManualControlsActive(model.showManualControls);
 301
 25302        return extractedItems;
 303    }
 304
 305    public void RemoveItems()
 306    {
 26307        DestroyInstantiatedItems();
 26308        SetManualControlsActive(model.showManualControls);
 26309    }
 310
 311    public void StartCarousel(
 312        int fromIndex = 0,
 313        bool startInmediately = false,
 314        CarouselDirection direction = CarouselDirection.Right,
 315        bool changeDirectionAfterFirstTransition = false,
 316        int numberOfInitialJumps = 1)
 317    {
 97318        StopCarousel();
 97319        itemsCoroutine = CoroutineStarter.Start(RunCarouselCoroutine(fromIndex, startInmediately, direction, changeDirec
 97320    }
 321
 322    public void StopCarousel()
 323    {
 238324        if (itemsCoroutine == null)
 232325            return;
 326
 6327        CoroutineStarter.Stop(itemsCoroutine);
 6328        itemsCoroutine = null;
 6329        isInTransition = false;
 6330    }
 331
 332    public void GoToPreviousItem()
 333    {
 3334        if (isInTransition)
 0335            return;
 336
 3337        StartCarousel(
 338            fromIndex: currentItemIndex,
 339            startInmediately: true,
 340            direction: CarouselDirection.Left,
 341            changeDirectionAfterFirstTransition: true,
 342            numberOfInitialJumps: 1);
 3343    }
 344
 345    public void ResetCarousel()
 346    {
 0347        int index = 0;
 0348        SetSelectedDot(index);
 349
 0350    }
 351
 352    public void GoToNextItem()
 353    {
 5354        if (isInTransition)
 0355            return;
 356
 5357        StartCarousel(
 358            fromIndex: currentItemIndex,
 359            startInmediately: true,
 360            direction: CarouselDirection.Right,
 361            changeDirectionAfterFirstTransition: false,
 362            numberOfInitialJumps: 1);
 5363    }
 364
 365    public void MakeJumpFromDotsSelector(int numberOfJumps, CarouselDirection direction)
 366    {
 1367        if (isInTransition)
 0368            return;
 369
 1370        StartCarousel(
 371            fromIndex: currentItemIndex,
 372            startInmediately: true,
 373            direction: direction,
 374            changeDirectionAfterFirstTransition: direction == CarouselDirection.Left,
 375            numberOfInitialJumps: numberOfJumps);
 1376    }
 377
 378    internal void ConfigureManualButtonsEvents()
 379    {
 55380        if (previousButton != null)
 381        {
 55382            previousButton.onClick.RemoveAllListeners();
 55383            previousButton.onClick.AddListener(GoToPreviousItem);
 384        }
 385
 55386        if (nextButton != null)
 387        {
 55388            nextButton.onClick.RemoveAllListeners();
 55389            nextButton.onClick.AddListener(GoToNextItem);
 390        }
 55391    }
 392
 393    internal void CreateItem(BaseComponentView newItem, string name)
 394    {
 36395        if (newItem == null)
 0396            return;
 397
 36398        newItem.transform.SetParent(itemsContainer);
 36399        newItem.transform.localPosition = Vector3.zero;
 36400        newItem.transform.localScale = Vector3.one;
 36401        newItem.name = name;
 402
 36403        instantiatedItems.Add(newItem);
 404
 36405        ResizeItem((RectTransform)newItem.transform);
 36406    }
 407
 408    internal void ResizeItem(RectTransform item)
 409    {
 69410        ((RectTransform)item.transform).sizeDelta = new Vector2(viewport.rect.width, viewport.rect.height);
 411
 69412        int currentNumberOfItems = itemsContainer.childCount;
 69413        itemsContainer.offsetMin = Vector2.zero;
 69414        float extraSpace = (currentNumberOfItems - 1) * model.spaceBetweenItems;
 69415        itemsContainer.offsetMax = new Vector2(viewport.rect.width * (currentNumberOfItems - 1) + extraSpace, 0);
 69416    }
 417
 418    internal void ResizeAllItems()
 419    {
 61420        itemsScroll.horizontalNormalizedPosition = 0f;
 61421        if (model.automaticTransition)
 61422            StartCarousel();
 423
 188424        foreach (Transform child in itemsContainer)
 425        {
 33426            ResizeItem((RectTransform)child);
 427        }
 61428    }
 429
 430    internal void DestroyInstantiatedItems()
 431    {
 548432        foreach (Transform child in itemsContainer)
 433        {
 92434            Destroy(child.gameObject);
 435        }
 436
 182437        instantiatedItems.Clear();
 438
 182439        itemsContainer.offsetMin = Vector2.zero;
 182440        itemsContainer.offsetMax = Vector2.zero;
 182441    }
 442
 443    internal IEnumerator RunCarouselCoroutine(
 444        int fromIndex = 0,
 445        bool startInmediately = false,
 446        CarouselDirection direction = CarouselDirection.Right,
 447        bool changeDirectionAfterFirstTransition = false,
 448        int numberOfInitialJumps = 1)
 449    {
 97450        currentItemIndex = fromIndex;
 97451        SetSelectedDot(currentItemIndex);
 452
 97453        bool continueCarrousel = true;
 97454        while (gameObject.activeInHierarchy && itemsContainer.childCount > 1 && continueCarrousel)
 455        {
 6456            if (!startInmediately)
 1457                yield return new WaitForSeconds(model.timeBetweenItems);
 458
 5459            if (instantiatedItems.Count > 0)
 460            {
 5461                if (direction == CarouselDirection.Right)
 462                {
 3463                    SetSelectedDot(currentItemIndex == (instantiatedItems.Count - 1) ? 0 : currentItemIndex + numberOfIn
 3464                    yield return RunRightAnimation(numberOfInitialJumps);
 465
 0466                    if (changeDirectionAfterFirstTransition)
 467                    {
 0468                        direction = CarouselDirection.Left;
 0469                        changeDirectionAfterFirstTransition = false;
 470                    }
 0471                    continueCarrousel = model.automaticTransition;
 0472                }
 473                else
 474                {
 2475                    SetSelectedDot(currentItemIndex == 0 ? (instantiatedItems.Count - 1) : currentItemIndex - numberOfIn
 2476                    yield return RunLeftAnimation(numberOfInitialJumps);
 477
 0478                    if (changeDirectionAfterFirstTransition)
 479                    {
 0480                        direction = CarouselDirection.Right;
 0481                        changeDirectionAfterFirstTransition = false;
 482                    }
 0483                    continueCarrousel = model.automaticTransition;
 484                }
 485            }
 486
 0487            startInmediately = false;
 0488            numberOfInitialJumps = 1;
 489        }
 91490    }
 491
 492    internal IEnumerator RunRightAnimation(int numberOfJumps = 1)
 493    {
 3494        if (currentItemIndex == instantiatedItems.Count - 1)
 495        {
 0496            currentItemIndex = 0;
 0497            yield return RunAnimationCoroutine(CarouselDirection.Left, instantiatedItems.Count - 1);
 0498        }
 499        else
 500        {
 3501            currentItemIndex += numberOfJumps;
 3502            yield return RunAnimationCoroutine(CarouselDirection.Right, numberOfJumps);
 503        }
 0504    }
 505
 506    internal IEnumerator RunLeftAnimation(int numberOfJumps = 1)
 507    {
 2508        if (currentItemIndex == 0)
 509        {
 2510            currentItemIndex = instantiatedItems.Count - 1;
 2511            yield return RunAnimationCoroutine(CarouselDirection.Right, instantiatedItems.Count - 1);
 0512        }
 513        else
 514        {
 0515            currentItemIndex -= numberOfJumps;
 0516            yield return RunAnimationCoroutine(CarouselDirection.Left, numberOfJumps);
 517        }
 0518    }
 519
 520    internal IEnumerator RunAnimationCoroutine(CarouselDirection direction, int numberOfJumps = 1)
 521    {
 5522        isInTransition = true;
 5523        float currentAnimationTime = 0f;
 5524        float initialNormalizedPos = itemsScroll.horizontalNormalizedPosition;
 525
 5526        if (direction == CarouselDirection.Right)
 5527            currentFinalNormalizedPos = initialNormalizedPos + ((float)numberOfJumps / (instantiatedItems.Count - 1));
 528        else
 0529            currentFinalNormalizedPos = initialNormalizedPos - ((float)numberOfJumps / (instantiatedItems.Count - 1));
 530
 5531        while (currentAnimationTime <= model.animationTransitionTime)
 532        {
 5533            itemsScroll.horizontalNormalizedPosition = Mathf.Clamp01(Mathf.Lerp(
 534                initialNormalizedPos,
 535                currentFinalNormalizedPos,
 536                model.animationCurve.Evaluate(currentAnimationTime / model.animationTransitionTime)));
 537
 5538            currentAnimationTime += Time.deltaTime;
 539
 5540            yield return null;
 541        }
 542
 0543        itemsScroll.horizontalNormalizedPosition = currentFinalNormalizedPos;
 0544        isInTransition = false;
 0545    }
 546
 547    internal void GenerateDotsSelector()
 548    {
 25549        List<GameObject> dotsToRemove = new List<GameObject>();
 110550        foreach (Transform child in dotsSelector.transform)
 551        {
 30552            if (child.gameObject == dotButtonTemplate.gameObject)
 553                continue;
 554
 5555            dotsToRemove.Add(child.gameObject);
 556        }
 557
 60558        foreach (GameObject dotToRemove in dotsToRemove)
 559        {
 5560            Utils.SafeDestroy(dotToRemove);
 561        }
 562
 132563        for (int i = 0; i < itemsContainer.childCount; i++)
 564        {
 41565            Button newDotButton = Instantiate(dotButtonTemplate, dotsSelector.transform);
 41566            newDotButton.gameObject.SetActive(true);
 41567            newDotButton.onClick.AddListener(() =>
 568            {
 0569                int dotButtonIndex = newDotButton.transform.GetSiblingIndex() - 1;
 0570                if (dotButtonIndex != currentDotIndex)
 571                {
 0572                    MakeJumpFromDotsSelector(
 573                        Mathf.Abs(dotButtonIndex - currentDotIndex),
 574                        dotButtonIndex > currentDotIndex ? CarouselDirection.Right : CarouselDirection.Left);
 575                }
 0576            });
 577        }
 578
 25579        SetSelectedDot(0);
 25580    }
 581
 582    internal void SetSelectedDot(int index)
 583    {
 128584        int currentIndex = 0;
 128585        currentDotIndex = -1;
 658586        foreach (Transform child in dotsSelector.transform)
 587        {
 201588            if (child.gameObject == dotButtonTemplate.gameObject)
 589                continue;
 590
 73591            if (currentIndex == index)
 592            {
 34593                child.GetComponent<Image>().color = dotSelectedColor;
 34594                child.transform.localScale = Vector3.one * 1.5f;
 34595                currentDotIndex = index;
 34596            }
 597            else
 598            {
 39599                child.GetComponent<Image>().color = dotUnselectedColor;
 39600                child.transform.localScale = Vector3.one;
 601            }
 602
 73603            currentIndex++;
 604        }
 128605    }
 606
 607    internal IEnumerator RegisterCurrentInstantiatedItems()
 608    {
 53609        instantiatedItems.Clear();
 610
 164611        foreach (Transform child in itemsContainer)
 612        {
 29613            BaseComponentView existingItem = child.GetComponent<BaseComponentView>();
 29614            if (existingItem != null)
 29615                instantiatedItems.Add(existingItem);
 616            else
 0617                Destroy(child.gameObject);
 618        }
 619
 620        // In the first loading, before calculating the size of the current items, it is needed to wait for a frame in o
 621        // allow time for the carousel viewport to get its final size to be able to execute the 'ResizeAllItems' functio
 53622        yield return null;
 623
 3624        ResizeAllItems();
 3625        SetManualControlsActive(model.showManualControls);
 3626        GenerateDotsSelector();
 3627    }
 628}