cartesian_coordinate.h File Reference

#include <guunits/guunits.h>
#include <stdbool.h>

Include dependency graph for cartesian_coordinate.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	gu_cartesian_coordinate
	A cartesian_coordinate is a general coordinate for representing positions on a tow dimensional plane. More...

Typedefs
typedef struct gu_cartesian_coordinate	gu_cartesian_coordinate
	A cartesian_coordinate is a general coordinate for representing positions on a tow dimensional plane. More...

Functions
bool	gu_cartesian_coordinate_equals (const gu_cartesian_coordinate, const gu_cartesian_coordinate) __attribute__((const))

Typedef Documentation

gu_cartesian_coordinate

typedef struct gu_cartesian_coordinate gu_cartesian_coordinate

A cartesian_coordinate is a general coordinate for representing positions on a tow dimensional plane.

This coordinate describes the position through the x and y axes. The gu_cartesian_coordinate is generally used for the coordinate system of the soccer field. This describes the world (or more specifically the field) in terms of the location of each side of the soccer field. The home side is in the west, whereas the away side is in the east. Because of this,it may not be a good idea to repurpose this coordinate for use in other applications since the x and y coordinates of this coordinate must be in centimetres.

When describing objects that face in certain directions it is important to disregard this coordinate and instead use gu_field_coordinate.

Function Documentation

gu_cartesian_coordinate_equals()

bool gu_cartesian_coordinate_equals	(	const	gu_cartesian_coordinate,
		const	gu_cartesian_coordinate
	)		const