Grid is the base class for plotting a layout of uniformly spaced points and lines.
The Grid component stores dimensional data of the layout of the grid and provides helper functions to retrieve information about the grid, such as the conversion between the cell location and local space location of items within the grid.
The layout of the Grid component is in the XY plane with the origin of the grid always beginning at (0, 0) and the X and Y coordinates of the grid only as positive values.
Implements the interface GridLayout.
cellGap | The size of the gap between each cell in the Grid. |
cellLayout | The layout of the cells in the Grid. |
cellSize | The size of each cell in the Grid. |
cellSwizzle | The cell swizzle for the Grid. |
GetCellCenterLocal | Get the logical center coordinate of a grid cell in local space. |
GetCellCenterWorld | Get the logical center coordinate of a grid cell in world space. |
InverseSwizzle | Does the inverse swizzle of the given position for given swizzle order. |
Swizzle | Swizzles the given position with the given swizzle order. |
enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
isActiveAndEnabled | Reports whether a GameObject and its associated Behaviour is active and enabled. |
gameObject | The game object this component is attached to. A component is always attached to a game object. |
tag | The tag of this game object. |
transform | The Transform attached to this GameObject. |
cellGap | The size of the gap between each cell in the layout. |
cellLayout | The layout of the cells. |
cellSize | The size of each cell in the layout. |
cellSwizzle | The cell swizzle for the layout. |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
CompareTag | Checks the GameObject's tag against the defined tag. |
GetComponent | Returns the component of type if the GameObject has one attached. |
GetComponentInChildren | Returns the Component of type in the GameObject or any of its children using depth first search. |
GetComponentInParent | Returns the Component of type in the GameObject or any of its parents. |
GetComponents | Returns all components of Type type in the GameObject. |
GetComponentsInChildren | Returns all components of Type type in the GameObject or any of its children. Works recursively. |
GetComponentsInParent | Returns all components of Type type in the GameObject or any of its parents. |
SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
TryGetComponent | Gets the component of the specified type, if it exists. |
CellToLocal | Converts a cell position to local position space. |
CellToLocalInterpolated | Converts an interpolated cell position in floats to local position space. |
CellToWorld | Converts a cell position to world position space. |
GetBoundsLocal | Returns the local bounds for a cell at the location. |
GetLayoutCellCenter | Get the default center coordinate of a cell for the set layout of the Grid. |
LocalToCell | Converts a local position to cell position. |
LocalToCellInterpolated | Converts a local position to cell position. |
LocalToWorld | Converts a local position to world position. |
WorldToCell | Converts a world position to cell position. |
WorldToLocal | Converts a world position to local position. |
GetInstanceID | Gets the instance ID of the object. |
ToString | Returns the name of the object. |
Destroy | Removes a GameObject, component or asset. |
DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
FindObjectOfType | Returns the first active loaded object of Type type. |
FindObjectsOfType | Gets a list of all loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
bool | Does the object exist? |
operator != | Compares if two objects refer to a different object. |
operator == | Compares two object references to see if they refer to the same object. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.