box.h File Reference

a rectanglular region More...

Go to the source code of this file.

Classes
struct	box
	defines a rectangular region More...

Functions
int	box_contains (int const i_pos_x, int const i_pos_y, struct box const *i_box)
	test if point is within box More...
int	box_contains_box (struct box const *i_box1, struct box const *i_box2)
	test if a box is contained in another More...
int	box_equal (struct box const *i_box1, struct box const *i_box2)
	test if box is equal to another More...

Detailed Description

a rectanglular region

Function Documentation

box_contains()

int box_contains	(	int const	i_pos_x,
		int const	i_pos_y,
		struct box const *	i_box
	)

test if point is within box

Parameters

[in]	i_pos_x	x position to test
[in]	i_pos_y	y position to test
[in]	i_box	object to test

Returns

0 point is not in box !0 point is in box

box_contains_box()

int box_contains_box	(	struct box const *	i_box1,
		struct box const *	i_box2
	)

test if a box is contained in another

Parameters

[in]	i_box1	test if box1 is contained in box2
[in]	i_box2	container box

Returns

0 i_box1 is not in i_box2

!0 i_box1 is in i_box2

box_equal()

int box_equal	(	struct box const *	i_box1,
		struct box const *	i_box2
	)

test if box is equal to another

Parameters

[in]	i_box1	box to test if it is equal to i_box2
[in]	i_box2	container box

Returns

0 boxes are not equal

!0 boxes are equal