Class ListViewControllerBase | Unity Reflect | 1.1.0-preview.6
docs.unity3d.com
    Show / Hide Table of Contents

    Class ListViewControllerBase

    Inheritance
    Object
    ListViewControllerBase
    ListViewController<TData, TItem, TIndex>
    Namespace: Unity.Labs.ListView
    Syntax
    public abstract class ListViewControllerBase : MonoBehaviour, IScrollHandler

    Fields

    m_EnableSettling

    Declaration
    protected bool m_EnableSettling
    Field Value
    Type Description
    Boolean

    m_Extents

    Declaration
    protected Vector3 m_Extents
    Field Value
    Type Description
    Vector3

    m_ItemSize

    Declaration
    protected Vector3 m_ItemSize
    Field Value
    Type Description
    Vector3

    m_Padding

    Declaration
    protected float m_Padding
    Field Value
    Type Description
    Single

    m_ScrollDelta

    Declaration
    protected float m_ScrollDelta
    Field Value
    Type Description
    Single

    m_Scrolling

    Declaration
    protected bool m_Scrolling
    Field Value
    Type Description
    Boolean

    m_ScrollOffset

    Declaration
    protected float m_ScrollOffset
    Field Value
    Type Description
    Single

    m_ScrollReturn

    Declaration
    protected float m_ScrollReturn
    Field Value
    Type Description
    Single

    m_SettleSpeed

    Declaration
    protected float m_SettleSpeed
    Field Value
    Type Description
    Single

    m_Settling

    Declaration
    protected bool m_Settling
    Field Value
    Type Description
    Boolean

    m_Size

    Declaration
    protected Vector3 m_Size
    Field Value
    Type Description
    Vector3

    m_StartPosition

    Declaration
    protected Vector3 m_StartPosition
    Field Value
    Type Description
    Vector3

    m_Templates

    Declaration
    protected GameObject[] m_Templates
    Field Value
    Type Description
    GameObject[]

    Properties

    itemSize

    Declaration
    public Vector3 itemSize { get; }
    Property Value
    Type Description
    Vector3

    listHeight

    Declaration
    protected abstract float listHeight { get; }
    Property Value
    Type Description
    Single

    scrollOffset

    Declaration
    public float scrollOffset { get; set; }
    Property Value
    Type Description
    Single

    scrollSpeed

    Declaration
    public float scrollSpeed { get; set; }
    Property Value
    Type Description
    Single

    size

    Declaration
    public virtual Vector3 size { set; }
    Property Value
    Type Description
    Vector3

    Methods

    Awake()

    Declaration
    protected virtual void Awake()

    ComputeConditions()

    Declaration
    protected virtual void ComputeConditions()

    EndSettling()

    Declaration
    protected virtual void EndSettling()

    GetObjectSize(GameObject)

    Declaration
    protected virtual Vector3 GetObjectSize(GameObject g)
    Parameters
    Type Name Description
    GameObject g
    Returns
    Type Description
    Vector3

    OnScroll(PointerEventData)

    Declaration
    public virtual void OnScroll(PointerEventData eventData)
    Parameters
    Type Name Description
    PointerEventData eventData

    OnScrollEnded()

    Declaration
    public virtual void OnScrollEnded()

    OnScrollStarted()

    Declaration
    public virtual void OnScrollStarted()

    ScrollNext()

    Declaration
    public virtual void ScrollNext()

    ScrollPrevious()

    Declaration
    public virtual void ScrollPrevious()

    ScrollTo(Int32)

    Declaration
    public virtual void ScrollTo(int index)
    Parameters
    Type Name Description
    Int32 index

    StartSettling(Action)

    Declaration
    protected virtual void StartSettling(Action onComplete = null)
    Parameters
    Type Name Description
    Action onComplete

    Update()

    Declaration
    protected virtual void Update()

    UpdateItem(IListViewItem, Int32, Single, ref Boolean)

    Declaration
    protected virtual void UpdateItem(IListViewItem item, int order, float offset, ref bool doneSettling)
    Parameters
    Type Name Description
    IListViewItem item
    Int32 order
    Single offset
    Boolean doneSettling

    UpdateItems()

    Declaration
    protected abstract void UpdateItems()

    UpdateItemTransform(IListViewItem, Int32, Vector3, Quaternion, Boolean, ref Boolean)

    Declaration
    protected virtual void UpdateItemTransform(IListViewItem item, int order, Vector3 targetPosition, Quaternion targetRotation, bool dontSettle, ref bool doneSettling)
    Parameters
    Type Name Description
    IListViewItem item
    Int32 order
    Vector3 targetPosition
    Quaternion targetRotation
    Boolean dontSettle
    Boolean doneSettling

    UpdateView()

    Declaration
    protected virtual void UpdateView()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023