mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class BaseObjectCollection

    Inheritance
    Object
    BaseObjectCollection
    GridObjectCollection
    Implements
    MonoBehaviour
    Namespace: Microsoft.MixedReality.Toolkit.Utilities
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class BaseObjectCollection : MonoBehaviour, MonoBehaviour

    Properties

    IgnoreInactiveTransforms

    Whether to include space for inactive transforms in the layout

    Declaration
    public bool IgnoreInactiveTransforms { get; set; }
    Property Value
    Type Description
    Boolean

    IgnoreInactiveTransforms

    Whether to include space for inactive transforms in the layout

    Declaration
    public bool IgnoreInactiveTransforms { get; set; }
    Property Value
    Type Description
    Boolean

    NodeList

    List of objects with generated data on the object.

    Declaration
    protected List<ObjectCollectionNode> NodeList { get; }
    Property Value
    Type Description
    List<ObjectCollectionNode>

    NodeList

    List of objects with generated data on the object.

    Declaration
    protected List<ObjectCollectionNode> NodeList { get; }
    Property Value
    Type Description
    List<ObjectCollectionNode>

    OnCollectionUpdated

    Action called when collection is updated

    Declaration
    public Action<BaseObjectCollection> OnCollectionUpdated { get; set; }
    Property Value
    Type Description
    Action<BaseObjectCollection>

    OnCollectionUpdated

    Action called when collection is updated

    Declaration
    public Action<BaseObjectCollection> OnCollectionUpdated { get; set; }
    Property Value
    Type Description
    Action<BaseObjectCollection>

    SortType

    Type of sorting to use.

    Declaration
    public CollationOrder SortType { get; set; }
    Property Value
    Type Description
    CollationOrder

    SortType

    Type of sorting to use.

    Declaration
    public CollationOrder SortType { get; set; }
    Property Value
    Type Description
    CollationOrder

    Methods

    ContainsNode(Transform)

    Check if a node exists in the NodeList.

    Declaration
    protected bool ContainsNode(Transform node)
    Parameters
    Type Name Description
    Transform node

    The Transfrom belonging to the ObjectCollectionNode

    Returns
    Type Description
    Boolean

    true when node belongs to an element of the list.

    ContainsNode(Transform)

    Check if a node exists in the NodeList.

    Declaration
    protected bool ContainsNode(Transform node)
    Parameters
    Type Name Description
    Transform node

    The Transfrom belonging to the ObjectCollectionNode

    Returns
    Type Description
    Boolean

    true when node belongs to an element of the list.

    ContainsNode(Transform, out Int32)

    Check if a node exists in the NodeList.

    Declaration
    protected bool ContainsNode(Transform node, out int nodeIndex)
    Parameters
    Type Name Description
    Transform node

    The Transform belonging to ObjectCollectionNode

    Int32 nodeIndex

    The index of the element in NodeList

    Returns
    Type Description
    Boolean

    true when node belongs to an element of the list.

    ContainsNode(Transform, out Int32)

    Check if a node exists in the NodeList.

    Declaration
    protected bool ContainsNode(Transform node, out int nodeIndex)
    Parameters
    Type Name Description
    Transform node

    The Transform belonging to ObjectCollectionNode

    Int32 nodeIndex

    The index of the element in NodeList

    Returns
    Type Description
    Boolean

    true when node belongs to an element of the list.

    LayoutChildren()

    Implement for laying out all children when UpdateCollection is called.

    Declaration
    protected abstract void LayoutChildren()

    LayoutChildren()

    Implement for laying out all children when UpdateCollection is called.

    Declaration
    protected abstract void LayoutChildren()

    PruneEmptyNodes()

    Checks for empty nodes and removes them

    Declaration
    protected void PruneEmptyNodes()

    PruneEmptyNodes()

    Checks for empty nodes and removes them

    Declaration
    protected void PruneEmptyNodes()

    SortNodes()

    Sorts NodeList based on SortType

    Declaration
    protected void SortNodes()

    SortNodes()

    Sorts NodeList based on SortType

    Declaration
    protected void SortNodes()

    UpdateCollection()

    Rebuilds / updates the collection layout. Update collection is called from the editor button on the inspector.

    Declaration
    public virtual void UpdateCollection()

    UpdateCollection()

    Rebuilds / updates the collection layout. Update collection is called from the editor button on the inspector.

    Declaration
    public virtual void UpdateCollection()

    Implements

    MonoBehaviour
    In This Article
    • Properties
      • IgnoreInactiveTransforms
      • IgnoreInactiveTransforms
      • NodeList
      • NodeList
      • OnCollectionUpdated
      • OnCollectionUpdated
      • SortType
      • SortType
    • Methods
      • ContainsNode(Transform)
      • ContainsNode(Transform)
      • ContainsNode(Transform, out Int32)
      • ContainsNode(Transform, out Int32)
      • LayoutChildren()
      • LayoutChildren()
      • PruneEmptyNodes()
      • PruneEmptyNodes()
      • SortNodes()
      • SortNodes()
      • UpdateCollection()
      • UpdateCollection()
    • Implements
    Back to top Generated by DocFX