UnityEngine.GridModule.xml 8.42 KB
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<doc>
  <members>
    <assembly>
      <name>UnityEngine.GridModule</name>
    </assembly>
    <member name="T:UnityEngine.Grid">
      <summary>
        <para>Grid is the base class for plotting a layout of uniformly spaced points and lines.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.Grid.cellGap">
      <summary>
        <para>The size of the gap between each cell in the Grid.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.Grid.cellLayout">
      <summary>
        <para>The layout of the cells in the Grid.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.Grid.cellSize">
      <summary>
        <para>The size of each cell in the Grid.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.Grid.cellSwizzle">
      <summary>
        <para>The cell swizzle for the Grid.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.Grid.GetCellCenterLocal(UnityEngine.Vector3Int)">
      <summary>
        <para>Get the logical center coordinate of a grid cell in local space.</para>
      </summary>
      <param name="position">Grid cell position.</param>
      <returns>
        <para>Center of the cell transformed into local space coordinates.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.Grid.GetCellCenterWorld(UnityEngine.Vector3Int)">
      <summary>
        <para>Get the logical center coordinate of a grid cell in world space.</para>
      </summary>
      <param name="position">Grid cell position.</param>
      <returns>
        <para>Center of the cell transformed into world space coordinates.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.Grid.InverseSwizzle(UnityEngine.GridLayout/CellSwizzle,UnityEngine.Vector3)">
      <summary>
        <para>Does the inverse swizzle of the given position for given swizzle order.</para>
      </summary>
      <param name="swizzle">Determines the rearrangement order for the inverse swizzle.</param>
      <param name="position">Position to inverse swizzle.</param>
      <returns>
        <para>The inversed swizzled position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.Grid.Swizzle(UnityEngine.GridLayout/CellSwizzle,UnityEngine.Vector3)">
      <summary>
        <para>Swizzles the given position with the given swizzle order.</para>
      </summary>
      <param name="swizzle">Determines the rearrangement order for the swizzle.</param>
      <param name="position">Position to swizzle.</param>
      <returns>
        <para>The swizzled position.</para>
      </returns>
    </member>
    <member name="T:UnityEngine.GridLayout">
      <summary>
        <para>An abstract class that defines a grid layout.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.GridLayout.cellGap">
      <summary>
        <para>The size of the gap between each cell in the layout.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.GridLayout.cellLayout">
      <summary>
        <para>The layout of the cells.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.GridLayout.cellSize">
      <summary>
        <para>The size of each cell in the layout.</para>
      </summary>
    </member>
    <member name="P:UnityEngine.GridLayout.cellSwizzle">
      <summary>
        <para>The cell swizzle for the layout.</para>
      </summary>
    </member>
    <member name="T:UnityEngine.GridLayout.CellLayout">
      <summary>
        <para>The layout of the GridLayout.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.GridLayout.CellLayout.Rectangle">
      <summary>
        <para>Rectangular layout for cells in the GridLayout.</para>
      </summary>
    </member>
    <member name="T:UnityEngine.GridLayout.CellSwizzle">
      <summary>
        <para>Swizzles cell positions to other positions.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.GridLayout.CellSwizzle.XYZ">
      <summary>
        <para>Keeps the cell positions at XYZ.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.GridLayout.CellSwizzle.XZY">
      <summary>
        <para>Swizzles the cell positions from XYZ to XZY.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.GridLayout.CellSwizzle.YXZ">
      <summary>
        <para>Swizzles the cell positions from XYZ to YXZ.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.GridLayout.CellSwizzle.YZX">
      <summary>
        <para>Swizzles the cell positions from XYZ to YZX.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.GridLayout.CellSwizzle.ZXY">
      <summary>
        <para>Swizzles the cell positions from XYZ to ZXY.</para>
      </summary>
    </member>
    <member name="F:UnityEngine.GridLayout.CellSwizzle.ZYX">
      <summary>
        <para>Swizzles the cell positions from XYZ to ZYX.</para>
      </summary>
    </member>
    <member name="M:UnityEngine.GridLayout.CellToLocal(UnityEngine.Vector3Int)">
      <summary>
        <para>Converts a cell position to local position space.</para>
      </summary>
      <param name="cellPosition">Cell position to convert.</param>
      <returns>
        <para>Local position of the cell position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.CellToLocalInterpolated(UnityEngine.Vector3)">
      <summary>
        <para>Converts an interpolated cell position in floats to local position space.</para>
      </summary>
      <param name="cellPosition">Interpolated cell position to convert.</param>
      <returns>
        <para>Local position of the cell position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.CellToWorld(UnityEngine.Vector3Int)">
      <summary>
        <para>Converts a cell position to world position space.</para>
      </summary>
      <param name="cellPosition">Cell position to convert.</param>
      <returns>
        <para>World position of the cell position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.GetBoundsLocal(UnityEngine.Vector3Int)">
      <summary>
        <para>Returns the local bounds for a cell at the location.</para>
      </summary>
      <param name="localPosition">Location of the cell.</param>
      <param name="cellPosition"></param>
      <returns>
        <para>Local bounds of cell at the position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.GetLayoutCellCenter">
      <summary>
        <para>Get the default center coordinate of a cell for the set layout of the Grid.</para>
      </summary>
      <returns>
        <para>Cell Center coordinate.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.LocalToCell(UnityEngine.Vector3)">
      <summary>
        <para>Converts a local position to cell position.</para>
      </summary>
      <param name="localPosition">Local Position to convert.</param>
      <returns>
        <para>Cell position of the local position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.LocalToCellInterpolated(UnityEngine.Vector3)">
      <summary>
        <para>Converts a local position to cell position.</para>
      </summary>
      <param name="localPosition">Local Position to convert.</param>
      <returns>
        <para>Interpolated cell position of the local position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.LocalToWorld(UnityEngine.Vector3)">
      <summary>
        <para>Converts a local position to world position.</para>
      </summary>
      <param name="localPosition">Local Position to convert.</param>
      <returns>
        <para>World position of the local position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.WorldToCell(UnityEngine.Vector3)">
      <summary>
        <para>Converts a world position to cell position.</para>
      </summary>
      <param name="worldPosition">World Position to convert.</param>
      <returns>
        <para>Cell position of the world position.</para>
      </returns>
    </member>
    <member name="M:UnityEngine.GridLayout.WorldToLocal(UnityEngine.Vector3)">
      <summary>
        <para>Converts a world position to local position.</para>
      </summary>
      <param name="worldPosition">World Position to convert.</param>
      <returns>
        <para>Local position of the world position.</para>
      </returns>
    </member>
  </members>
</doc>