iufPosition.h File Reference

#include <iufTypes.h>

Go to the source code of this file.

Macros
#define	IU3DP_INVALID   (iu3dp_t) NULL
#define	IU2DP_INVALID   (iu2dp_t) NULL

Typedefs
typedef Iuf3DPosition *	iu3dp_t
typedef Iuf2DPosition *	iu2dp_t

Functions
iu2dp_t	iuf2DPositionCreate (float x, float z)
	Create a 2D position (x,z) More...
iu3dp_t	iuf3DPositionCreate (float x, float y, float z)
	Create a 3D position (x,y,z) More...
void	iuf3DPositionDelete (iu3dp_t pos)
	Delete a 3D position. More...
void	iuf2DPositionDelete (iu2dp_t pos)
	Delete a 3D position. More...
IUF_BOOL	iuf2DPositionCompare (iu2dp_t reference, iu2dp_t actual)
	compare two 2D positions with each other More...
IUF_BOOL	iuf3DPositionCompare (iu3dp_t reference, iu3dp_t actual)
	compare two 3D positions with each other More...

Macro Definition Documentation

IU2DP_INVALID

#define IU2DP_INVALID   (iu2dp_t) NULL

IU3DP_INVALID

#define IU3DP_INVALID   (iu3dp_t) NULL

Typedef Documentation

iu2dp_t

typedef Iuf2DPosition* iu2dp_t

iu3dp_t

typedef Iuf3DPosition* iu3dp_t

a 3D position has an x, y and z, while a 2D position has an x and z only. x is along the transducer, z is the depth direction, and y is perpendicular to the transducer array

Function Documentation

iuf2DPositionCompare()

IUF_BOOL iuf2DPositionCompare	(	iu2dp_t	reference,
		iu2dp_t	actual
	)

compare two 2D positions with each other

Returns

Return IUF_TRUE when the positions are equal and IUF_FALSE otherwise

Parameters

reference	The position two compare to
actual	The position two compare with

iuf2DPositionCreate()

iu2dp_t iuf2DPositionCreate	(	float	x,
		float	z
	)

Create a 2D position (x,z)

Returns

Returns (x,z).

Parameters

x	along the transducer
z	depth direction

iuf2DPositionDelete()

void iuf2DPositionDelete

(

iu2dp_t

pos

)

Delete a 3D position.

Parameters

pos	The position of interest

iuf3DPositionCompare()

IUF_BOOL iuf3DPositionCompare	(	iu3dp_t	reference,
		iu3dp_t	actual
	)

compare two 3D positions with each other

Returns

Return IUF_TRUE when the positions are equal and IUF_FALSE otherwise

Parameters

reference	The position two compare to
actual	The position two compare with

iuf3DPositionCreate()

iu3dp_t iuf3DPositionCreate	(	float	x,
		float	y,
		float	z
	)

Create a 3D position (x,y,z)

Returns

Returns (x,y,z).

iuf3DPositionDelete()

void iuf3DPositionDelete

(

iu3dp_t

pos

)

Delete a 3D position.

Parameters

pos	The position of interest