public class ClampingOperationInfo
Holds information about a World Clamping Operation (executed using the ClampOriginCells method.
| Name | Type | Description |
|---|---|---|
| NewWorldOriginCell | Cell |
The new Origin Cell of the World after the clamping operation. |
| World | World |
The World this info referes to. |
| WorldClampingShift | Cell |
The amount of shift added to the World's Origin Cell and other values that reference World Grid Cells as a result of the clamping operation. |
public void ClearMemory()
Can be used to manually clear the memory taken up by the Origin Cell and Clamping Shift data. If you do not call this, this data will remain loaded until the next Clamping Operation is executed.
public bool TryGetPostClampOriginCellAndClampingShiftOfZoneGrouping(int zoneIndex, int groupingIndex, out Cell postClampOriginCell, out Cell clampingShift)
Tries to get the Origin Cell value (expressed as a Cell on the Zone Grouping's Endless
Grid) for a particular Zone Grouping after
the clamping operation, as well as the amount of Cell Shift that was added to each
Cell of this Zone Grouping as a result of the shift.
When clamping occurs all current Endless Grid Cell values of the World's World Cells
and Origin Cells are offset by a certain number of
Cells on each axis, which is why the Origin Cell might change. However keep in mind
that the position of the Origin Cell will not have changed,
and for most purposes, you can ignore the change in origin cell. However, if you are
using the Origin Cell value for a Zone Grouping for
some purposes, and storing it locally, you will need to update that local copy with
this new value.
| Name | Type | Description |
|---|---|---|
| zoneIndex | int |
The index of the Zone whose information you want to retrieve. |
| groupingIndex | int |
The index of the World Grouping whose information you want to retrieve. |
| postClampOriginCell | out Cell |
The origin cell (post clamp) if the method returns true. |
| clampingShift | out Cell |
The amount of cell shift that was added to each Cell during the clamping operation. |
type
True if the origin cell and clamping shift could be retrieved, false otherwise.