Class ListViewController<TData, TItem, TIndex>

Inheritance
Object
ListViewControllerBase
ListViewController<TData, TItem, TIndex>
NestedListViewController<TData, TItem, TIndex>
EditorXRListViewController<TData, TItem, TIndex>
Inherited Members
Namespace: Unity.Labs.ListView
Syntax
public abstract class ListViewController<TData, TItem, TIndex> : ListViewControllerBase, IScrollHandler where TData : class, IListViewItemData<TIndex> where TItem : class, IListViewItem<TData, TIndex>
Type Parameters
Name Description
TData
TItem
TIndex

Fields

m_Data

Declaration
protected List<TData> m_Data
Field Value
Type Description
List<TData>

m_GrabbedRows

Declaration
protected readonly Dictionary<TIndex, Transform> m_GrabbedRows
Field Value
Type Description
Dictionary<TIndex, Transform>

m_ListItems

Declaration
protected readonly Dictionary<TIndex, TItem> m_ListItems
Field Value
Type Description
Dictionary<TIndex, TItem>

m_TemplateDictionary

Declaration
protected readonly Dictionary<string, ListViewItemTemplate<TItem>> m_TemplateDictionary
Field Value
Type Description
Dictionary<String, ListViewItemTemplate<TItem>>

Properties

data

Declaration
public virtual List<TData> data { get; set; }
Property Value
Type Description
List<TData>

listHeight

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

Methods

Awake()

Declaration
protected override void Awake()
Overrides

GetGrabbedRow(Transform)

Declaration
protected virtual TItem GetGrabbedRow(Transform rayOrigin)
Parameters
Type Name Description
Transform rayOrigin
Returns
Type Description
TItem

GetListItem(TIndex)

Declaration
protected TItem GetListItem(TIndex index)
Parameters
Type Name Description
TIndex index
Returns
Type Description
TItem

GetNewItem(TData, out TItem)

Get a view item for a given datum, either from its template's pool, or by creating a new one

Declaration
protected virtual bool GetNewItem(TData datum, out TItem item)
Parameters
Type Name Description
TData datum

The datum for the desired view item
TItem item

The view item
Returns
Type Description
Boolean

True if a new item was instantiated, false if the view item came from the item pool

InstantiateItem(TData)

Declaration
protected virtual TItem InstantiateItem(TData datum)
Parameters
Type Name Description
TData datum
Returns
Type Description
TItem

Recycle(TIndex)

Declaration
protected virtual void Recycle(TIndex index)
Parameters
Type Name Description
TIndex index

RecycleItem(String, TItem)

Declaration
protected virtual void RecycleItem(string template, TItem item)
Parameters
Type Name Description
String template
TItem item

SetRowGrabbed(TIndex, Transform, Boolean)

Declaration
protected virtual void SetRowGrabbed(TIndex index, Transform rayOrigin, bool grabbed)
Parameters
Type Name Description
TIndex index
Transform rayOrigin
Boolean grabbed

Start()

Declaration
protected virtual void Start()

UpdateItems()

Declaration
protected override void UpdateItems()
Overrides

UpdateVisibleItem(TData, Int32, Single, ref Boolean)

Declaration
protected virtual TItem UpdateVisibleItem(TData datum, int order, float offset, ref bool doneSettling)
Parameters
Type Name Description
TData datum
Int32 order
Single offset
Boolean doneSettling
Returns
Type Description
TItem