iuf3DSize.h File Reference

Go to the source code of this file.

Data Structures
struct	Iuf3DSize

Macros
#define	IU3DS_INVALID   (iu3ds_t) NULL

Typedefs
typedef Iuf3DSize *	iu3ds_t
	3D elements are considered block shaped and aligned (z-angle rotation=0) and can rotate in theta (y-axis) and phi (over the x-axis) angles are in radians and have a position [x,y,z] in meters and a size in [sx, sy, sz] in meters. More...

Functions
iu3ds_t	iuf3DSizeCreate (float sx, float sy, float sz)
	create a 3-axis size 3D space More...
int	iuf3DSizeDelete (iu3ds_t size)
	delete a 3-axis size object More...
int	iuf3DSizeCompare (iu3ds_t reference, iu3ds_t actual)
	Compare two 3D sizes, argument order doesn't matter. More...

---

Data Structure Documentation

Iuf3DSize

struct Iuf3DSize

Data Fields
float	sx	Size in x dimension in m.
float	sy
float	sz	, Size in y dimension in m Size in z dimension in m

Macro Definition Documentation

IU3DS_INVALID

#define IU3DS_INVALID   (iu3ds_t) NULL

Typedef Documentation

iu3ds_t

typedef Iuf3DSize* iu3ds_t

3D elements are considered block shaped and aligned (z-angle rotation=0) and can rotate in theta (y-axis) and phi (over the x-axis) angles are in radians and have a position [x,y,z] in meters and a size in [sx, sy, sz] in meters.

Function Documentation

iuf3DSizeCompare()

int iuf3DSizeCompare	(	iu3ds_t	reference,
		iu3ds_t	actual
	)

Compare two 3D sizes, argument order doesn't matter.

Returns

returns IUF_TRUE in case the angles are equal or IUF_FALSE in case they differ.

Parameters

reference	a 3D size to compare to
actual	a 3D size to compare with

iuf3DSizeCreate()

iu3ds_t iuf3DSizeCreate	(	float	sx,
		float	sy,
		float	sz
	)

create a 3-axis size 3D space

Returns

returns an allocated and initialized 3D size.

Parameters

sx	size in x direction in m
sy	size in y direction in m
sz	size in z direction in m

iuf3DSizeDelete()

int iuf3DSizeDelete

(

iu3ds_t

size

)

delete a 3-axis size object

Returns

returns IUF_ERR_VALUE in case this fails or IUF_E_OK in case of success

Parameters

size	the size object to be deleted