Photon Fusion 2.1.1

Simulation.AreaOfInterest Struct Reference

Static access to AreaOfInterest for backwards compatibility. More...

Static Public Member Functions

static int GetCellSize ()
 Get the size of each cell in the AOI grid.
static void SphereToCells (Vector3 position, float radius, HashSet< int > cells)
 Convert a sphere into a set of AOI cells.
static int ToCell (int x, int y, int z)
 Convert a cell coordinate into the respective cell index.
static int ToCell (Vector3 position)
 Convert a position into the respective cell index.
static Vector3 ToCellCenter (int index)
 Convert a cell index into the respective cell center position.

Static Public Attributes

static int x
 Get the size of the AOI grid.

Properties

static int CELL_SIZE [get]
 Size of each cell in the AOI grid.

Detailed Description

Static access to AreaOfInterest for backwards compatibility.

Member Function Documentation

◆ GetCellSize()

int GetCellSize ( )
static

Get the size of each cell in the AOI grid.

Returns
The size of each cell in the AOI grid.

◆ SphereToCells()

void SphereToCells ( Vector3 position,
float radius,
HashSet< int > cells )
static

Convert a sphere into a set of AOI cells.

Parameters
positionSphere center
radiusSphere radius. Max allowed radius is AreaOfInterestState.MaxSharedRadius
cellsResulting set of cells

◆ ToCell() [1/2]

int ToCell ( int x,
int y,
int z )
static

Convert a cell coordinate into the respective cell index.

Parameters
xX coordinate
yY coordinate
zZ coordinate
Returns
Cell index

◆ ToCell() [2/2]

int ToCell ( Vector3 position)
static

Convert a position into the respective cell index.

Parameters
positionPosition
Returns
Cell index

◆ ToCellCenter()

Vector3 ToCellCenter ( int index)
static

Convert a cell index into the respective cell center position.

Parameters
indexCell index
Returns
Cell center position

Member Data Documentation

◆ x

int x
static

Get the size of the AOI grid.

Clamp cell coordinates to the valid range.

Converts a cell index into its corresponding cell coordinates.

Convert a position into the respective cell coordinate.

Returns
The size of the AOI grid.
Parameters
positionPosition
Returns
Cell coordinate
Parameters
indexThe index of the cell to be converted.
Returns
A tuple containing the x, y, and z coordinates of the cell.
Parameters
xX coordinate
yY coordinate
zZ coordinate
Returns
Clamped cell coordinates