Update UI 2.9.0

docs/UI/InfiniteScroll/README.en.md

@@ -11,22 +11,36 @@
 
 ## Overview
 
-Scroll Rect (Scroll View) creates items to fit in content and allows them to be reusable.
+Scroll Rect(Scroll View) creates scrollItems to fit in content and allows them to be reusable.
 
-* InfiniteScroll creates elements of content with user-inserted InfiniteScrollData (or inherited) class.
-    * InfiniteScroll.InsertData()
-* In the Prefab which is to be used as element of content, the InfiniteScrollItem (or inherited) class must be attached before use.
-    * Implement Prefab on InfiniteScrollItem.UpdateData()
+### Reusing ScrollItem
+Reusing scrollItems conserves memory and enhances performance.
+
+![infinitescroll_objectmanaged](images/infinitescroll_objectmanaged.gif)
+
+* InfiniteScroll creates content elements using user-inserted InfiniteScrollData inherited classes.
+    * Use 'InfiniteScroll.InsertData()'
+* In the Prefab intended to be used as content elements, the InfiniteScrollItem inherited class must be attached before use.
+    * Implement the 'InfiniteScrollItem.UpdateData()' method.
+
+### Scroll Management
+Can adjust the reference point and direction according to the purpose of using the scroll.
+
+![infinitescroll_item](images/infinitescroll_item.gif)
 
 ## How to use
 
-### produce
+### Configuration
+
 ![inspector](images/inspector.png)
-* Add an Infinite Scroll component to the object to which the scroll rectangle (Scroll Rect(Scroll View)) is attached.
-* Add a prefab with a class that inherits InfiniteScrollItem to the Item Prefab.
+
+* Add the Infinite Scroll component to the object with the scroll rectangle area Scroll Rect(Scroll View) attached.
+* Attach a prefab with a class that inherits InfiniteScrollItem to the Item Prefab.
+
+![itemprefab](images/itemprefab.png)
 
 ### Apply scroll data
-* InfiniteScrollItem is used by applying the data of the content within the inherited class.
+* To apply scroll data, Need to implement the UpdateData method within a class that inherits from the InfiniteScrollItem class. This allows you to apply data to the content's data.
     ```
     public override void UpdateData(InfiniteScrollData scrollData)
     {
@@ -36,26 +50,102 @@ Scroll Rect (Scroll View) creates items to fit in content and allows them to b
     }
     ```
 
-### Item Dynamic Resizing
+### Adding ScrollItem
+* Add a ScrollItem using the InsertData function with a data class that inherits from InfiniteScrollData.
+* The added data is managed internally by the scroll and passed to UpdateData of InfiniteScrollItem to update the items.
+
+```
+public InfiniteScroll scroll;
+
+class TestScrollData : InfiniteScrollData
+{
+}
+
+void InsertData()
+{
+    TestScrollData data = new TestScrollData();
+
+    scroll.InsertData(data);
+}
+```
+
+### ScrollItem Filtering
+Can filter the data managed within the scroll to control what is shown.
+* Use the 'SetFilter' function to make scrollItems invisible.
+* ScrollItems with a return value of false will be visible, while those with a return value of true will not be visible.
+
+```
+public InfiniteScroll scroll;
+
+class TestScrollFilter : InfiniteScrollData
+{
+    public bool filter;
+}
+
+void Filter()
+{
+    scroll.SetFilter(TestFilter);
+}
+
+bool OnFilter(InfiniteScrollData data)
+{
+    if (data is TestScrollFilter testData)
+    {
+        return testData.filter;
+    }
+
+    return false;
+}
+```
+
+#### Filtering Odd and Even
+
+![infinitescroll_filter](images/infinitescroll_filter.gif)
+
+### ScrollItem Dynamic Resizing
 * Enable the Dynamic Item Size option.
 * InfiniteScrollItem inherited class
     * Use SetSize to change the size.
     * When the size is changed without using SetSize, the OnUpdateItemSize() function is called to reflect it on the scroll.
 
-### Apply scroll grid
+### Applying Grid to ScrollItems
+* Can divide the items of the scroll into a grid for application.
+    ![infinitescroll_grid](images/infinitescroll_grid.gif)
+
+#### Inspector
 * Set the size to divide the Values ​​grid of Layout.
+    * ![grid_1](images/grid_1.png)
 * Set the grid ratio with the ratio of the Element of Values.
+    * Activated when Grid Count is 2 or more.
+    * The UI position may change depending on the direction of the scrollItems.
     * ![grid_2](images/grid_2.png)
-    * This is the result of dividing the ratio of 2:1:1 as shown below.
-    * It can be specified according to the size with a value exceeding 1, such as 200, 100, or 100.
-    * ![grid_1](images/grid_1.png)
+
+
+### Applying Scroll Reference Point
+* Can set the reference point of the scroll.
+    * Horizontal (left, center, right)
+    * Vertical (top, middle, bottom)
+* ![infinitescroll_axis](images/infinitescroll_axis.gif)
+
+#### Inspector
+* Can select buttons to indicate the direction for each reference point.
+    * ![infinitescroll_axis](images/infinitescroll_axis.png)
+
+### Applying ScrollItem Direction
+* Can set the direction in which scrollitems are aligned.
+    * ![infinitescroll_direction](images/infinitescroll_direction.gif)
+
+#### Inspector
+* Can select buttons for each direction to set the direction.
+    * ![infinitescroll_direction](images/infinitescroll_direction.png)
 
 ### Scroll Events
 Events called according to changes in the status of ScrollView.
 
 You can register and utilize the callback function through the Inspector or AddListener.
 
 #### Inspector
+
 ![event](images/event.png)
 
 #### onChangeValue
@@ -117,6 +207,8 @@ Regarding how to use API, see Assets/GPM/UI/Sample/InfiniteScroll/Scripts/Infin
 ### InsertData
 
 Add data as the element of content.
+* data : Data to be added
+* insertIndex : Index where the addition is desired
 
 ```cs
 public void InsertData(InfiniteScrollData data)
@@ -142,14 +234,17 @@ public void UpdateData(InfiniteScrollData data)
 ### UpdateAllData
 
 Update all data.
+* If immediately is true, the data will be updated immediately.
 
 ```cs
-public void UpdateAllData()
+public void UpdateAllData(bool immediately = false)
 ```
 
 ### RemoveData
 
 Delete inserted data.
+* InfiniteScrollData : If there is managed data, it deletes that data.
+* dataIndex : Deletes the data of the managed data.
 
 ```cs
 public void RemoveData(InfiniteScrollData data)
@@ -194,12 +289,82 @@ public bool IsMoveToLastData()
 
 Move content to the specified data.
 
+* itemIndex : Moves to the index of the filtered scrollItem.
+* MoveToType : Determines where the data moves to. Options are Top, Center, and Bottom.
+* time : Sets the time it takes to move. It moves instantly when set to 0.
+* InfiniteScrollData : If there is managed data, it moves to that data.
+
+```cs
+public void MoveTo(int itemIndex, MoveToType moveToType, float time = 0)
+```
+
 ```cs
 public void MoveTo(InfiniteScrollData data, MoveToType moveToType, float time = 0)
 ```
 
+
+### MoveToFromDataIndex
+
+Moves the content to the index of the managed data.
+* dataIndex :  Moves to the index of the managed data.
+* MoveToType : Specifies where the data moves to. Options are Top, Center, and Bottom.
+* time : Sets the duration of the movement. It moves instantly when set to 0.
+
+```cs
+public void MoveToFromDataIndex(int dataIndex, MoveToType moveToType, float time = 0)
+```
+### SetFilter
+
+Selects the scrollItems to be displayed on the scroll.
+* A boolean function is added to determine if the scrollItem is filtered.
+* When it returns true, the scrollItem is filtered and not displayed; when it returns false, the scrollItem remains visible.
+* When there's a complete refresh, calling SetFilter again will reapply the filtering.
+* Adding null will result in no filtering.
+
+```cs
+public void SetFilter(Predicate<InfiniteScrollData> onFilter)
+```
+
+### SetScrollAxis
+Sets the reference point of the scroll content.
+
+```cs
+public void SetScrollAxis(ScrollAxis axis)
+```
+
+### GetScrollAxis
+Gets the reference point of the scroll content.
+
+```cs
+public ScrollAxis GetScrollAxis()
+```
+
+### SetPadding
+Sets the padding of the scroll.
+
+```cs
+public void SetPadding(Vector2 padding)
+```
+
+### GetPadding
+Retrieves the padding of the scroll.
+
+```cs
+public Vector2 GetPadding()
+```
+
+### SetSpace
+Sets the spacing between scrollItems.
+
+```cs
+public void SetSpace(Vector2 space)
+```
+
+### GetSpace
+Retrieves the spacing between scrollItems.
+
 ```cs
-public void MoveTo(int dataIndex, MoveToType moveToType, float time = 0)
+public Vector2 GetSpace()
 ```
 
 ### ResizeScrollView
@@ -214,9 +379,5 @@ public void ResizeScrollView()
 
 Assets/GPM/UI/Sample/InfiniteScroll
 
-![infinitescroll_sample](images/infinitescroll_sample.gif)
-
----
-
 ![dynamic_sample](images/dynamic_sample.gif)