Show / Hide Table of Contents

    Class GridObjectCollection

    A Grid Object Collection is simply a set of child objects organized with some layout parameters. The collection can be used to quickly create control panels or sets of prefab/objects.

    Inheritance
    Object
    BaseObjectCollection
    GridObjectCollection
    ScatterObjectCollection
    Inherited Members
    BaseObjectCollection.OnCollectionUpdated
    BaseObjectCollection.NodeList
    BaseObjectCollection.IgnoreInactiveTransforms
    BaseObjectCollection.SortType
    BaseObjectCollection.UpdateCollection()
    BaseObjectCollection.ContainsNode(Transform)
    Namespace: Microsoft.MixedReality.Toolkit.Utilities
    Assembly: cs.temp.dll.dll
    Syntax
    public class GridObjectCollection : BaseObjectCollection

    Fields

    Columns

    Declaration
    protected int Columns
    Field Value
    Type Description
    Int32

    HalfCell

    Declaration
    protected Vector2 HalfCell
    Field Value
    Type Description
    Vector2

    Properties

    CellHeight

    Height of the cell per object in the collection.

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

    CellWidth

    Width of the cell per object in the collection.

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

    CylinderMesh

    Reference mesh to use for rendering the cylinder layout

    Declaration
    public Mesh CylinderMesh { get; set; }
    Property Value
    Type Description
    Mesh

    Distance

    This is the Distance for an offset for the Plane mapping and is ignored for the other mappings.

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

    Height

    Total Height of collection

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

    Layout

    Whether to sort objects by row first or by column first

    Declaration
    public LayoutOrder Layout { get; set; }
    Property Value
    Type Description
    LayoutOrder

    OrientType

    Should the objects in the collection face the origin of the collection

    Declaration
    public OrientationType OrientType { get; set; }
    Property Value
    Type Description
    OrientationType

    RadialRange

    This is the radial range for creating a radial fan layout.

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

    Radius

    This is the radius of either the Cylinder or Sphere mapping and is ignored when using the plane mapping.

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

    Rows

    Number of rows per column, column number is automatically determined

    Declaration
    public int Rows { get; set; }
    Property Value
    Type Description
    Int32

    SphereMesh

    Reference mesh to use for rendering the sphere layout

    Declaration
    public Mesh SphereMesh { get; set; }
    Property Value
    Type Description
    Mesh

    SurfaceType

    Type of surface to map the collection to.

    Declaration
    public ObjectOrientationSurfaceType SurfaceType { get; set; }
    Property Value
    Type Description
    ObjectOrientationSurfaceType

    Width

    Total Width of collection

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

    Methods

    LayoutChildren()

    Overriding base function for laying out all the children when UpdateCollection is called.

    Declaration
    protected override void LayoutChildren()
    Overrides
    BaseObjectCollection.LayoutChildren()

    OnDrawGizmosSelected()

    Declaration
    protected virtual void OnDrawGizmosSelected()

    ResolveGridLayout(Vector3[], LayoutOrder)

    Declaration
    protected void ResolveGridLayout(Vector3[] grid, LayoutOrder order)
    Parameters
    Type Name Description
    Vector3[] grid
    LayoutOrder order

    UpdateNodeFacing(ObjectCollectionNode)

    Update the facing of a node given the nodes new position for facing origin with node and orientation type

    Declaration
    protected void UpdateNodeFacing(ObjectCollectionNode node)
    Parameters
    Type Name Description
    ObjectCollectionNode node
    Back to top Generated by DocFX