camera_pivot.h File Reference

#include "camera.h"
#include <stdbool.h>
#include <guunits/guunits.h>
#include "percent_coordinate.h"
#include "relative_coordinate.h"

Include dependency graph for camera_pivot.h:

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

Go to the source code of this file.

Classes
struct	gu_camera_pivot
	A gu_camera_pivot represents the pivot point which a gu_camera is attached to. More...

Macros
#define	GU_CAMERA_PIVOT_NUM_CAMERAS   2

Typedefs
typedef struct gu_camera_pivot	gu_camera_pivot
	A gu_camera_pivot represents the pivot point which a gu_camera is attached to. More...

Functions
bool	gu_camera_pivot_equals (const gu_camera_pivot, const gu_camera_pivot, const double) __attribute__((const))
centimetres_d	gu_camera_pivot_calculate_camera_height (const gu_camera_pivot, const int) __attribute__((const))
bool	gu_camera_pivot_object_on_ground (const gu_camera_pivot, const int, const gu_percent_coordinate) __attribute__((const))
bool	gu_camera_pivot_can_see_object (const gu_camera_pivot, const int, const gu_relative_coordinate) __attribute__((const))

Macro Definition Documentation

GU_CAMERA_PIVOT_NUM_CAMERAS

#define GU_CAMERA_PIVOT_NUM_CAMERAS   2

Definition at line 74 of file camera_pivot.h.

Typedef Documentation

gu_camera_pivot

typedef struct gu_camera_pivot gu_camera_pivot

A gu_camera_pivot represents the pivot point which a gu_camera is attached to.

If a camera is on the ground, then there is no pivot point. If the camera is on the end of a stick then the pivot point is the bottom of the stick. If the camera is on the head of a robot, then the pivot point is the neck of the robot.

Function Documentation

gu_camera_pivot_calculate_camera_height()

centimetres_d gu_camera_pivot_calculate_camera_height	(	const	gu_camera_pivot,
		const int
	)		const

gu_camera_pivot_can_see_object()

bool gu_camera_pivot_can_see_object	(	const	gu_camera_pivot,
		const int	,
		const	gu_relative_coordinate
	)		const

gu_camera_pivot_equals()

bool gu_camera_pivot_equals	(	const	gu_camera_pivot,
		const	gu_camera_pivot,
		const double
	)		const

gu_camera_pivot_object_on_ground()

bool gu_camera_pivot_object_on_ground	(	const	gu_camera_pivot,
		const int	,
		const	gu_percent_coordinate
	)		const