iufSource.h File Reference

Go to the source code of this file.

Macros
#define	IUS_INVALID   (ius_t) NULL

Typedefs
typedef IufSource *	ius_t

Enumerations
enum	IufSourceType {   IUF_INVALID_SOURCE_TYPE = 0, IUF_2D_NON_PARAMETRIC_SOURCE, IUF_3D_NON_PARAMETRIC_SOURCE, IUF_2D_PARAMETRIC_SOURCE,   IUF_3D_PARAMETRIC_SOURCE }

Functions
int	iufSourceDelete (ius_t source)
	Delete a source. More...
int	iufSourceCompare (ius_t reference, ius_t actual)
	Compare two sources. More...
IufSourceType	iufSourceGetType (ius_t source)
	Get which type the source has. More...

Macro Definition Documentation

IUS_INVALID

#define IUS_INVALID   (ius_t) NULL

Typedef Documentation

ius_t

typedef IufSource* ius_t

A source consists of points that simultaneously emit. These points can be in 2D or 3D and can have either a parametric description of their locations or a x,(y),z list. To create a source use the explicit functions iuf2DParametricSourceCreate(), iuf3DParametricSourceCreate(), iuf2DNonParametricSourceCreate(), iuf3DNonParametricSourceCreate()

Enumeration Type Documentation

IufSourceType

enum IufSourceType

Enumerator
IUF_INVALID_SOURCE_TYPE
IUF_2D_NON_PARAMETRIC_SOURCE
IUF_3D_NON_PARAMETRIC_SOURCE
IUF_2D_PARAMETRIC_SOURCE
IUF_3D_PARAMETRIC_SOURCE

Function Documentation

iufSourceCompare()

int iufSourceCompare	(	ius_t	reference,
		ius_t	actual
	)

Compare two sources.

Returns

Returns IUF_TRUE in case the sources are equal and IUF_FALSE otherwise.

Parameters

reference	The source to compare to
actual	The source to compare with

iufSourceDelete()

int iufSourceDelete

(

ius_t

source

)

Delete a source.

Returns

Returns IUF_E_OK in case of success and IUF_ERR_VALUE in case of an error.

Parameters

source

The source that is deleted

iufSourceGetType()

IufSourceType iufSourceGetType

(

ius_t

source

)

Get which type the source has.

Returns

Returns if the source is 2D, 3D and Parametric or non Parametric

Parameters

source

The source of interest