Simulation.AreaOfInterestState Struct Reference

Area of Interest Definition More...

Public Member Functions
	AreaOfInterestState (InterestManagementConfig config)
	Create a new instance of the AreaOfInterestState struct. More...
int int int z	ClampCellCoords (int x, int y, int z)
int	GetCellSize ()
	Get the size of each cell in the AOI grid. More...
int int int z	GetGridSize ()
void	SphereToCells (Vector3 position, float radius, HashSet< int > cells)
	Convert a sphere into a set of AOI cells. More...
int	ToCell (int x, int y, int z)
	Convert a cell coordinate into the respective cell index. More...
int	ToCell (Vector3 position)
	Convert a position into the respective cell index. More...
Vector3	ToCellCenter (int index)
	Convert a cell index into the respective cell center position. More...
int int int z	ToCellCoords (int index)
int int int z	ToCellCoords (Vector3 position)

Public Attributes
int	x
	Get the size of the AOI grid. More...
int int	y

Properties
int	MaxSharedRadius [get]
	The maximum radius supported for the player interest area in shared mode based on the current cell size. More...

Detailed Description

Area of Interest Definition

Constructor & Destructor Documentation

AreaOfInterestState()

AreaOfInterestState

(

InterestManagementConfig

config

)

Create a new instance of the AreaOfInterestState struct.

Parameters

config

The config to initialize.

Member Function Documentation

GetCellSize()

int GetCellSize

(

)

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
	)

Convert a sphere into a set of AOI cells.

Parameters

position	Sphere center
radius	Sphere radius. Max allowed radius is MaxSharedRadius
cells	Resulting set of cells

ToCell() [1/2]

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

Convert a cell coordinate into the respective cell index.

Parameters

x	X coordinate
y	Y coordinate
z	Z coordinate

Returns

Cell index

ToCell() [2/2]

int ToCell

(

Vector3

position

)

Convert a position into the respective cell index.

Parameters

position

Position

Returns

Cell index

ToCellCenter()

Vector3 ToCellCenter

(

int

index

)

Convert a cell index into the respective cell center position.

Parameters

index

Cell index

Returns

Cell center position

Member Data Documentation

x

int x

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

position

Position

Returns

Cell coordinate

Parameters

index

The index of the cell to be converted.

Returns

A tuple containing the x, y, and z coordinates of the cell.

Parameters

x	X coordinate
y	Y coordinate
z	Z coordinate

Returns

Clamped cell coordinates

Property Documentation

MaxSharedRadius

int MaxSharedRadius

get

The maximum radius supported for the player interest area in shared mode based on the current cell size.