Represents the distances from the gameboard tracking origin to the borders of the gameboard's viewable area. More...

Public Member Functions
	GameboardExtents (T5_GameboardSize gameboardSize)
Vector3	GetCornerPositionInGameboardSpace (Corner corner)
	Gets the coordinates of the specified corner in gameboard space.
Vector3	GetEdgeCenterPositionInGameboardSpace (Edge edge)
	Gets the coordinates of the center of the specified edge in gameboard space.
Vector3	GetPhysicalCenterPositionInGameboardSpace ()
	Gets the coordinates of the geometric center (or centroid) of the gameboard in gameboard space.
Vector3	GetGeometricCenterPositionInGameboardSpace ()
	Gets the coordinates of the geometric center (or centroid) of the gameboard in gameboard space.

Static Public Member Functions
static	GameboardExtents ()

Public Attributes
Length	ViewableExtentPositiveX
	The distance in meters from the gameboard origin to the edge of the viewable area in the positive X direction.
Length	ViewableExtentNegativeX
	The distance in meters from the gameboard origin to the edge of the viewable area in the negative X direction.
Length	ViewableExtentPositiveZ
	The distance in meters from the gameboard origin to the edge of the viewable area in the positive Z direction.
Length	ViewableExtentNegativeZ
	The distance in meters from the gameboard origin to the edge of the viewable area in the negative Z direction.
Length	ViewableExtentPositiveY
	The distance in meters above the gameboard origin that the viewable area extends in the positive Y direction.

Properties
Length	ViewableSpanX `[get]`
	The distance in meters representing the side-to-side width of the viewable area of the gameboard;.
Length	ViewableSpanY `[get]`
	The distance in meters representing the height of the viewable area of the gameboard;.
Length	ViewableSpanZ `[get]`
	The distance in meters representing the front-to-back length of the viewable area of the gameboard;.
Length	OriginOffsetZ `[get]`
	The distance from the tracking origin to the geometric center of the gameboard.

Detailed Description

Represents the distances from the gameboard tracking origin to the borders of the gameboard's viewable area.

Constructor & Destructor Documentation

◆ GameboardExtents() [1/2]

TiltFive.GameBoard.GameboardExtents.GameboardExtents ( )

static

◆ GameboardExtents() [2/2]

TiltFive.GameBoard.GameboardExtents.GameboardExtents ( T5_GameboardSize gameboardSize )

Member Function Documentation

◆ GetCornerPositionInGameboardSpace()

Vector3 TiltFive.GameBoard.GameboardExtents.GetCornerPositionInGameboardSpace ( Corner corner )

Gets the coordinates of the specified corner in gameboard space.

Parameters

corner

Returns: The coordinates of the specified corner in gameboard space.

Exceptions

ArgumentException Thrown when an invalid value for corner is provided.

◆ GetEdgeCenterPositionInGameboardSpace()

Vector3 TiltFive.GameBoard.GameboardExtents.GetEdgeCenterPositionInGameboardSpace ( Edge edge )

Gets the coordinates of the center of the specified edge in gameboard space.

Parameters

edge

Returns: The coordinates of the center of the specified edge in gameboard space.

Exceptions

ArgumentException Thrown when an invalid value for edge is provided.

◆ GetGeometricCenterPositionInGameboardSpace()

Vector3 TiltFive.GameBoard.GameboardExtents.GetGeometricCenterPositionInGameboardSpace ( )

Gets the coordinates of the geometric center (or centroid) of the gameboard in gameboard space.

Returns

For the LE gameboard, the tracking origin and the geometric center of the gameboard overlap, so this will return a vector of [0, 0, 0], but for the XE gameboard variants, the tracking origin is offset from the gameboard's geometric center, making this function useful for accounting for this offset.

◆ GetPhysicalCenterPositionInGameboardSpace()

Vector3 TiltFive.GameBoard.GameboardExtents.GetPhysicalCenterPositionInGameboardSpace ( )

Gets the coordinates of the geometric center (or centroid) of the gameboard in gameboard space.

Returns

For the LE gameboard, the tracking origin and the geometric center of the gameboard overlap, so this will return a vector of [0, 0, 0], but for the XE gameboard variants, the tracking origin is offset from the gameboard's geometric center, making this function useful for accounting for this offset.

Member Data Documentation

◆ ViewableExtentNegativeX

Length TiltFive.GameBoard.GameboardExtents.ViewableExtentNegativeX

The distance in meters from the gameboard origin to the edge of the viewable area in the negative X direction.

◆ ViewableExtentNegativeZ

Length TiltFive.GameBoard.GameboardExtents.ViewableExtentNegativeZ

The distance in meters from the gameboard origin to the edge of the viewable area in the negative Z direction.

◆ ViewableExtentPositiveX

Length TiltFive.GameBoard.GameboardExtents.ViewableExtentPositiveX

The distance in meters from the gameboard origin to the edge of the viewable area in the positive X direction.

◆ ViewableExtentPositiveY

Length TiltFive.GameBoard.GameboardExtents.ViewableExtentPositiveY

The distance in meters above the gameboard origin that the viewable area extends in the positive Y direction.

◆ ViewableExtentPositiveZ

Length TiltFive.GameBoard.GameboardExtents.ViewableExtentPositiveZ

The distance in meters from the gameboard origin to the edge of the viewable area in the positive Z direction.

Property Documentation

◆ OriginOffsetZ

Length TiltFive.GameBoard.GameboardExtents.OriginOffsetZ

get

The distance from the tracking origin to the geometric center of the gameboard.

For square configurations like the LE gameboard, this value will be zero, but this can be helpful for spatial logic relating to the XE or XE Raised gameboards.

◆ ViewableSpanX

Length TiltFive.GameBoard.GameboardExtents.ViewableSpanX

get

The distance in meters representing the side-to-side width of the viewable area of the gameboard;.

◆ ViewableSpanY

Length TiltFive.GameBoard.GameboardExtents.ViewableSpanY

get

The distance in meters representing the height of the viewable area of the gameboard;.

◆ ViewableSpanZ

Length TiltFive.GameBoard.GameboardExtents.ViewableSpanZ

get

The distance in meters representing the front-to-back length of the viewable area of the gameboard;.

Public Member Functions

Static Public Member Functions

Public Attributes

Properties