ScatterObjectCollection Class

Definition

Namespace:

Microsoft.MixedReality.Toolkit.Utilities

Assembly:

Microsoft.MixedReality.Toolkit.SDK.dll

A Scatter Object Collection is simply a set of child objects randomly laid out within a radius. Pressing "update collection" will run the randomization, feel free to run as many times until you get the desired result.

public ref class ScatterObjectCollection : Microsoft::MixedReality::Toolkit::Utilities::GridObjectCollection

[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/ScatterObjectCollection")]
public class ScatterObjectCollection : Microsoft.MixedReality.Toolkit.Utilities.GridObjectCollection

[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/ScatterObjectCollection")>]
type ScatterObjectCollection = class
    inherit GridObjectCollection

Public Class ScatterObjectCollection
Inherits GridObjectCollection

Inheritance

UnityEngine.MonoBehaviour

BaseObjectCollection

GridObjectCollection

ScatterObjectCollection

Attributes

UnityEngine.AddComponentMenuAttribute

Constructors

ScatterObjectCollection()

Fields

HalfCell

(Inherited from GridObjectCollection)

Properties

Anchor	Where the grid is anchored relative to local origin (Inherited from GridObjectCollection)
AnchorAlongAxis	Whether anchoring occurs along an objects axis or not (Inherited from GridObjectCollection)
CellHeight	Height of the cell per object in the collection. (Inherited from GridObjectCollection)
CellWidth	Width of the cell per object in the collection. (Inherited from GridObjectCollection)
ColumnAlignment	How the columns are aligned in the grid (Inherited from GridObjectCollection)
Columns	Number of columns per row. Can only be assigned when layout type is ColumnsThenRows (Inherited from GridObjectCollection)
CylinderMesh	Reference mesh to use for rendering the cylinder layout (Inherited from GridObjectCollection)
Distance	This is the Distance for an offset for the Plane mapping and is ignored for the other mappings. (Inherited from GridObjectCollection)
Height	Total Height of collection (Inherited from GridObjectCollection)
IgnoreInactiveTransforms	Whether to include space for inactive transforms in the layout (Inherited from BaseObjectCollection)
Layout	Specify direction in which children are laid out (Inherited from GridObjectCollection)
NodeList	List of objects with generated data on the object. (Inherited from BaseObjectCollection)
NodeListReadOnly	Read only list of objects with generated data on the object. (Inherited from BaseObjectCollection)
OnCollectionUpdated	Action called when collection is updated (Inherited from BaseObjectCollection)
OrientType	Should the objects in the collection face the origin of the collection (Inherited from GridObjectCollection)
RadialRange	This is the radial range for creating a radial fan layout. (Inherited from GridObjectCollection)
Radius	This is the radius of either the Cylinder or Sphere mapping and is ignored when using the plane mapping. (Inherited from GridObjectCollection)
RowAlignment	How the rows are aligned in the grid (Inherited from GridObjectCollection)
Rows	Number of rows per column. Can only be assigned when layout type is RowsThenColumns (Inherited from GridObjectCollection)
SortType	Type of sorting to use. (Inherited from BaseObjectCollection)
SphereMesh	Reference mesh to use for rendering the sphere layout (Inherited from GridObjectCollection)
SurfaceType	Type of surface to map the collection to. (Inherited from GridObjectCollection)
Width	Total Width of collection (Inherited from GridObjectCollection)

Methods

ContainsNode(Transform, Int32)	Check if a node exists in the NodeList. (Inherited from BaseObjectCollection)
ContainsNode(Transform)	Check if a node exists in the NodeList. (Inherited from BaseObjectCollection)
LayoutChildren()	Overriding base function for laying out all the children when UpdateCollection is called.
OnDrawGizmosSelected()	(Inherited from GridObjectCollection)
PruneEmptyNodes()	Checks for empty nodes and removes them (Inherited from BaseObjectCollection)
ResolveGridLayout(Vector3[], LayoutOrder)	(Inherited from GridObjectCollection)
SortNodes()	Sorts NodeList based on SortType (Inherited from BaseObjectCollection)
UpdateCollection()	Rebuilds / updates the collection layout. Update collection is called from the editor button on the inspector. (Inherited from BaseObjectCollection)
UpdateNodeFacing(ObjectCollectionNode)	Update the facing of a node given the nodes new position for facing origin with node and orientation type (Inherited from GridObjectCollection)