api.h File Reference

#include "common.h"
#include "vmath.h"
#include "bu/avs.h"
#include "bu/opt.h"
#include "bu/mime.h"
#include "bn/tol.h"
#include "rt/defines.h"
#include "rt/tol.h"
#include "gcv/defines.h"

Include dependency graph for api.h:

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

Go to the source code of this file.

Data Structures
struct	gcv_context
struct	gcv_opts
struct	gcv_filter
struct	gcv_plugin

Enumerations
enum	gcv_tessellation_algorithm { GCV_TESS_DEFAULT = 0 , GCV_TESS_BOTTESS , GCV_TESS_MARCHING_CUBES }
enum	gcv_filter_type { GCV_FILTER_FILTER , GCV_FILTER_READ , GCV_FILTER_WRITE }

Functions
void	gcv_context_init (struct gcv_context *cxt)
void	gcv_context_destroy (struct gcv_context *cxt)
void	gcv_opts_default (struct gcv_opts *gcv_options)
const struct bu_ptbl *	gcv_list_filters (struct gcv_context *context)
const struct gcv_filter *	find_filter (enum gcv_filter_type filter_type, bu_mime_model_t mime_type, const char *data, struct gcv_context *context)
int	gcv_execute (struct gcv_context *context, const struct gcv_filter *filter, const struct gcv_opts *gcv_options, size_t argc, const char *const *argv, const char *target)

Detailed Description

Main public API of the LIBGCV geometry conversion library.

Definition in file api.h.

Enumeration Type Documentation

gcv_tessellation_algorithm

enum gcv_tessellation_algorithm

Enumerator
GCV_TESS_DEFAULT
GCV_TESS_BOTTESS
GCV_TESS_MARCHING_CUBES

Definition at line 71 of file api.h.

gcv_filter_type

enum gcv_filter_type

Enumerator
GCV_FILTER_FILTER
GCV_FILTER_READ
GCV_FILTER_WRITE

Definition at line 78 of file api.h.

Function Documentation

gcv_context_init()

void gcv_context_init

(

struct gcv_context *

cxt

)

Initialize a conversion context.

gcv_context_destroy()

void gcv_context_destroy

(

struct gcv_context *

cxt

)

Release a conversion context, freeing all memory internally allocated by the library. Caller is responsible for freeing the context pointer itself, if necessary.

gcv_opts_default()

void gcv_opts_default

(

struct gcv_opts *

gcv_options

)

Assign default option values.

gcv_list_filters()

const struct bu_ptbl * gcv_list_filters

(

struct gcv_context *

context

)

find_filter()

const struct gcv_filter * find_filter	(	enum gcv_filter_type	filter_type,
		bu_mime_model_t	mime_type,
		const char *	data,
		struct gcv_context *	context
	)

gcv_execute()

int gcv_execute	(	struct gcv_context *	context,
		const struct gcv_filter *	filter,
		const struct gcv_opts *	gcv_options,
		size_t	argc,
		const char *const *	argv,
		const char *	target
	)

Perform a filtering operation on a gcv_context.

If 'gcv_options' is NULL, defaults will be used as set by gcv_opts_default(). The parameters 'argc' and 'argv' are used for option processing as specified by the filter.

Returns 1 on success and 0 on failure.