vtkfigCAPI.h File Reference

Go to the source code of this file.

Typedefs
typedef struct vtkfigFrame_struct	vtkfigFrame
	Provide a framework wrapping window+interactor+renderers from vtk. More...
typedef struct vtkfigDataSet_struct	vtkfigDataSet
	Class to collect all data given on one grid. More...
typedef struct vtkfigScalarView_struct	vtkfigScalarView
	Surface and contour plot of 2/3D scalar data. More...
typedef struct vtkfigVectorView_struct	vtkfigVectorView
	Quiver plots + streamlines for vector fields. More...
typedef struct vtkfigGridView_struct	vtkfigGridView
	Grid visualization. More...
typedef struct vtkfigXYPlot_struct	vtkfigXYPlot
	XY Function plot. More...

Functions
void	vtkfigPrintOpenGLInfo ()
vtkfigFrame *	vtkfigCreateFrame (void)
void	vtkfigDestroyFrame (vtkfigFrame *frame)
void	vtkfigUnmapFrame (vtkfigFrame *frame)
	Unmap frame from screen. More...
vtkfigDataSet *	vtkfigCreateDataSet (void)
void	vtkfigDestroyDataSet (vtkfigDataSet *dataset)
vtkfigScalarView *	vtkfigCreateScalarView (void)
void	vtkfigDestroyScalarView (vtkfigScalarView *scalarview)
vtkfigVectorView *	vtkfigCreateVectorView (void)
void	vtkfigDestroyVectorView (vtkfigVectorView *vectorview)
vtkfigGridView *	vtkfigCreateGridView (void)
void	vtkfigDestroyGridView (vtkfigGridView *gridview)
vtkfigXYPlot *	vtkfigCreateXYPlot (void)
void	vtkfigDestroyXYPlot (vtkfigXYPlot *xyplot)
void	vtkfigSetRectilinearGrid2D (vtkfigDataSet *dataset, double *x, int nx, double *y, int ny)
	Enter data of a 2D rectilinear grid. More...
void	vtkfigSetRectilinearGrid3D (vtkfigDataSet *dataset, double *x, int nx, double *y, int ny, double *z, int nz)
	Set data of a scalar function defined on the points of the grid. More...
void	vtkfigSetSimplexGrid (vtkfigDataSet *dataset, int index_offset, int dim, double *points, int npoints, int *cells, int ncells)
	Enter data of a simplex grid. More...
void	vtkfigSetCellRegions (vtkfigDataSet *dataset, int *cr, int n)
	Set cell region data (for multiregion grids) More...
void	vtkfigSetBoundaryCellRegions (vtkfigDataSet *dataset, int *cr, int n)
	Set boundary cell region data (for multiregion grids) More...
void	vtkfigSetSimplexGridBoundaryCells (vtkfigDataSet *dataset, int index_offset, int dim, int *bc, int n)
void	vtkfigSetPointScalar (vtkfigDataSet *dataset, double *x, int nx, char *name)
void	vtkfigSetPointVector (vtkfigDataSet *dataset, double *uvw, int npoints, int dim, char *name)
void	vtkfigSetGridViewData (vtkfigGridView *gridview, vtkfigDataSet *dataset)
	Add Dataset to figure. More...
void	vtkfigSetScalarViewData (vtkfigScalarView *scalarview, vtkfigDataSet *dataset, char *name)
	Add Dataset to figure. More...
void	vtkfigSetVectorViewData (vtkfigVectorView *vectorview, vtkfigDataSet *dataset, char *name)
	Add Dataset to figure. More...
void	vtkfigShow (vtkfigFrame *frame)
	Show frame content and continue. More...
void	vtkfigInteract (vtkfigFrame *frame)
	Show frame content and wait for interaction. More...
void	vtkfigClearFrame (vtkfigFrame *frame)
	Remove all figures. More...
void	vtkfigAddScalarView (vtkfigFrame *frame, vtkfigScalarView *figure)
	Add figure at position (0) More...
void	vtkfigAddVectorView (vtkfigFrame *frame, vtkfigVectorView *figure)
	Add figure at position (0) More...
void	vtkfigAddGridView (vtkfigFrame *frame, vtkfigGridView *figure)
	Add figure at position (0) More...
void	vtkfigAddXYPlot (vtkfigFrame *frame, vtkfigXYPlot *figure)
	Add figure at position (0) More...
void	vtkfigAddScalarViewAt (vtkfigFrame *frame, vtkfigScalarView *figure, int ipos)
	Add figure at position (0) More...
void	vtkfigAddVectorViewAt (vtkfigFrame *frame, vtkfigVectorView *figure, int ipos)
	Add figure at position (0) More...
void	vtkfigAddGridViewAt (vtkfigFrame *frame, vtkfigGridView *figure, int ipos)
	Add figure at position (0) More...
void	vtkfigAddXYPlotAt (vtkfigFrame *frame, vtkfigXYPlot *figure, int ipos)
	Add figure at position (0) More...
void	vtkfigRemoveScalarView (vtkfigFrame *frame, vtkfigScalarView *figure)
	Remove figure. More...
void	vtkfigRemoveVectorView (vtkfigFrame *frame, vtkfigVectorView *figure)
	Remove figure. More...
void	vtkfigRemoveGridView (vtkfigFrame *frame, vtkfigGridView *figure)
	Remove figure. More...
void	vtkfigRemoveXYPlot (vtkfigFrame *frame, vtkfigXYPlot *figure)
	Remove figure. More...
void	vtkfigWritePNG (vtkfigFrame *frame, char *fname)
	Write png image of frame content. More...
void	vtkfigStartVideo (vtkfigFrame *frame, char *fname)
	Start video recording. More...
void	vtkfigStopVideo (vtkfigFrame *frame)
	Stop video recording. More...
void	vtkfigSetSize (vtkfigFrame *frame, int x, int y)
	Set frame size in pixels. More...
void	vtkfigSetLayout (vtkfigFrame *frame, int x, int y)
	Set layout of subframe grid. More...
void	vtkfigSetWindowTitle (vtkfigFrame *frame, char *title)
	Set window title. More...
void	vtkfigSetFrameTitle (vtkfigFrame *frame, char *title)
	Set Frame title. More...
void	vtkfigSetPosition (vtkfigFrame *frame, int x, int y)
	Set frame position on screen. More...
void	vtkfigWriteVTK (vtkfigDataSet *dataset, char *filename, char *filetype)
	Write dataset to disk in VTK format. More...
void	vtkfigSetIsolevels (vtkfigScalarView *scalarview, double *v, int nv)
void	vtkfigShowIsosurfaces (vtkfigScalarView *scalarview, int show)
void	vtkfigSetQuiverGrid2D (vtkfigVectorView *vectorview, int nx, int ny)
	Set quiver points on grid in domain bounding box (2D) More...
void	vtkfigSetQuiverGrid3D (vtkfigVectorView *vectorview, int nx, int ny, int nz)
	Set quiver points on grid in domain bounding box (2D) More...
void	vtfigAddPlot (vtkfigXYPlot *xyplot, double *x, int nx, double *y, int ny)
	Add a pair of x/y data to the figure. More...
void	vtkfigSetTitle (vtkfigXYPlot *xyplot, char *t)
	Set the title of the plot. More...
void	vtkfigShowLegend (vtkfigXYPlot *xyplot, int b)
	Show a legend box ? More...
void	vtkfigShowGrid (vtkfigXYPlot *xyplot, int b)
	Show grid lines in the plot ? More...
void	vtkfigAdjustLabels (vtkfigXYPlot *xyplot, int b)
	Adjust labels to "nice values" ? More...
void	vtkfigSetLegendPosition (vtkfigXYPlot *xyplot, double x, double y)
	Set the position of the legend box. More...
void	vtkfigSetLegendSize (vtkfigXYPlot *xyplot, double w, double h)
	Set the size of the legend box. More...
void	vtkfigClear (vtkfigXYPlot *xyplot)
	Remove all data from plot. More...
void	vtkfigSetPlotLineType (vtkfigXYPlot *xyplot, char *t)
	Set the line type of the next plot. More...
void	vtkfigSetPlotMarkerType (vtkfigXYPlot *xyplot, char *t)
	Set marker type. More...
void	vtkfigSetPlotColor (vtkfigXYPlot *xyplot, double r, double g, double b)
	Set the color of the next plot. More...
void	vtkfigSetPlotLegend (vtkfigXYPlot *xyplot, char *t)
	Set the information for the legend entry for the next plot. More...
void	vtkfigSetGridColor (vtkfigXYPlot *xyplot, double r, double g, double b)
	Set the color of the grid lines. More...
void	vtkfigSetAxesColor (vtkfigXYPlot *xyplot, double r, double g, double b)
	Set the color of the axes. More...
void	vtkfigSetXTitle (vtkfigXYPlot *xyplot, char *t)
	Set the title of the x axis. More...
void	vtkfigSetYTitle (vtkfigXYPlot *xyplot, char *t)
	Set the title of the y axis. More...
void	vtkfigSetLineWidth (vtkfigXYPlot *xyplot, double w)
	Set the width of all lines in the plot. More...
void	vtkfigSetMarkerSize (vtkfigXYPlot *xyplot, double s)
	Set the size of all markers in the plot. More...
void	vtkfigSetXRange (vtkfigXYPlot *xyplot, double x0, double x1)
	Set the range of the x values. More...
void	vtkfigSetYRange (vtkfigXYPlot *xyplot, double y0, double y1)
	Set the range of the y values. More...
void	vtkfigSetNumberOfXLabels (vtkfigXYPlot *xyplot, int n)
	Set the number of x axis labels. More...
void	vtkfigSetNumberOfYLabels (vtkfigXYPlot *xyplot, int n)
	Set the number of y axis labels. More...

Detailed Description

C Language API for vtkfig.

This API is intended for the use of vtkfig from C and Julia. It defines C structs as wrappers for the C++ classes of vtkfig and C functions wrapping their methods.

Typedef Documentation

vtkfigFrame

typedef struct vtkfigFrame_struct vtkfigFrame

Provide a framework wrapping window+interactor+renderers from vtk.

vtkfigDataSet

typedef struct vtkfigDataSet_struct vtkfigDataSet

Class to collect all data given on one grid.

vtkfigScalarView

typedef struct vtkfigScalarView_struct vtkfigScalarView

Surface and contour plot of 2/3D scalar data.

vtkfigVectorView

typedef struct vtkfigVectorView_struct vtkfigVectorView

Quiver plots + streamlines for vector fields.

vtkfigGridView

typedef struct vtkfigGridView_struct vtkfigGridView

Grid visualization.

vtkfigXYPlot

typedef struct vtkfigXYPlot_struct vtkfigXYPlot

XY Function plot.

Function Documentation

vtkfigPrintOpenGLInfo()

void vtkfigPrintOpenGLInfo

(

)

vtkfigCreateFrame()

vtkfigFrame* vtkfigCreateFrame

(

void

)

Examples

example-capi.c.

vtkfigDestroyFrame()

void vtkfigDestroyFrame

(

vtkfigFrame *

frame

)

vtkfigUnmapFrame()

void vtkfigUnmapFrame

(

vtkfigFrame *

frame

)

Unmap frame from screen.

vtkfigCreateDataSet()

vtkfigDataSet* vtkfigCreateDataSet

(

void

)

Examples

example-capi.c.

vtkfigDestroyDataSet()

void vtkfigDestroyDataSet

(

vtkfigDataSet *

dataset

)

vtkfigCreateScalarView()

vtkfigScalarView* vtkfigCreateScalarView

(

void

)

Examples

example-capi.c.

vtkfigDestroyScalarView()

void vtkfigDestroyScalarView

(

vtkfigScalarView *

scalarview

)

vtkfigCreateVectorView()

vtkfigVectorView* vtkfigCreateVectorView

(

void

)

vtkfigDestroyVectorView()

void vtkfigDestroyVectorView

(

vtkfigVectorView *

vectorview

)

vtkfigCreateGridView()

vtkfigGridView* vtkfigCreateGridView

(

void

)

vtkfigDestroyGridView()

void vtkfigDestroyGridView

(

vtkfigGridView *

gridview

)

vtkfigCreateXYPlot()

vtkfigXYPlot* vtkfigCreateXYPlot

(

void

)

vtkfigDestroyXYPlot()

void vtkfigDestroyXYPlot

(

vtkfigXYPlot *

xyplot

)

vtkfigSetRectilinearGrid2D()

void vtkfigSetRectilinearGrid2D	(	vtkfigDataSet *	dataset,
		double *	x,
		int	nx,
		double *	y,
		int	ny
	)

Enter data of a 2D rectilinear grid.

Examples

example-capi.c.

vtkfigSetRectilinearGrid3D()

void vtkfigSetRectilinearGrid3D	(	vtkfigDataSet *	dataset,
		double *	x,
		int	nx,
		double *	y,
		int	ny,
		double *	z,
		int	nz
	)

Set data of a scalar function defined on the points of the grid.

vtkfigSetSimplexGrid()

void vtkfigSetSimplexGrid	(	vtkfigDataSet *	dataset,
		int	index_offset,
		int	dim,
		double *	points,
		int	npoints,
		int *	cells,
		int	ncells
	)

Enter data of a simplex grid.

vtkfigSetCellRegions()

void vtkfigSetCellRegions	(	vtkfigDataSet *	dataset,
		int *	cr,
		int	n
	)

Set cell region data (for multiregion grids)

vtkfigSetBoundaryCellRegions()

void vtkfigSetBoundaryCellRegions	(	vtkfigDataSet *	dataset,
		int *	cr,
		int	n
	)

Set boundary cell region data (for multiregion grids)

vtkfigSetSimplexGridBoundaryCells()

void vtkfigSetSimplexGridBoundaryCells	(	vtkfigDataSet *	dataset,
		int	index_offset,
		int	dim,
		int *	bc,
		int	n
	)

vtkfigSetPointScalar()

void vtkfigSetPointScalar	(	vtkfigDataSet *	dataset,
		double *	x,
		int	nx,
		char *	name
	)

Examples

example-capi.c.

vtkfigSetPointVector()

void vtkfigSetPointVector	(	vtkfigDataSet *	dataset,
		double *	uvw,
		int	npoints,
		int	dim,
		char *	name
	)

vtkfigSetGridViewData()

void vtkfigSetGridViewData	(	vtkfigGridView *	gridview,
		vtkfigDataSet *	dataset
	)

Add Dataset to figure.

vtkfigSetScalarViewData()

void vtkfigSetScalarViewData	(	vtkfigScalarView *	scalarview,
		vtkfigDataSet *	dataset,
		char *	name
	)

Add Dataset to figure.

Examples

example-capi.c.

vtkfigSetVectorViewData()

void vtkfigSetVectorViewData	(	vtkfigVectorView *	vectorview,
		vtkfigDataSet *	dataset,
		char *	name
	)

Add Dataset to figure.

vtkfigShow()

void vtkfigShow

(

vtkfigFrame *

frame

)

Show frame content and continue.

Examples

example-capi.c.

vtkfigInteract()

void vtkfigInteract

(

vtkfigFrame *

frame

)

Show frame content and wait for interaction.

vtkfigClearFrame()

void vtkfigClearFrame

(

vtkfigFrame *

frame

)

Remove all figures.

vtkfigAddScalarView()

void vtkfigAddScalarView	(	vtkfigFrame *	frame,
		vtkfigScalarView *	figure
	)

Add figure at position (0)

Examples

example-capi.c.

vtkfigAddVectorView()

void vtkfigAddVectorView	(	vtkfigFrame *	frame,
		vtkfigVectorView *	figure
	)

Add figure at position (0)

vtkfigAddGridView()

void vtkfigAddGridView	(	vtkfigFrame *	frame,
		vtkfigGridView *	figure
	)

Add figure at position (0)

vtkfigAddXYPlot()

void vtkfigAddXYPlot	(	vtkfigFrame *	frame,
		vtkfigXYPlot *	figure
	)

Add figure at position (0)

vtkfigAddScalarViewAt()

void vtkfigAddScalarViewAt	(	vtkfigFrame *	frame,
		vtkfigScalarView *	figure,
		int	ipos
	)

Add figure at position (0)

vtkfigAddVectorViewAt()

void vtkfigAddVectorViewAt	(	vtkfigFrame *	frame,
		vtkfigVectorView *	figure,
		int	ipos
	)

Add figure at position (0)

vtkfigAddGridViewAt()

void vtkfigAddGridViewAt	(	vtkfigFrame *	frame,
		vtkfigGridView *	figure,
		int	ipos
	)

Add figure at position (0)

vtkfigAddXYPlotAt()

void vtkfigAddXYPlotAt	(	vtkfigFrame *	frame,
		vtkfigXYPlot *	figure,
		int	ipos
	)

Add figure at position (0)

vtkfigRemoveScalarView()

void vtkfigRemoveScalarView	(	vtkfigFrame *	frame,
		vtkfigScalarView *	figure
	)

Remove figure.

vtkfigRemoveVectorView()

void vtkfigRemoveVectorView	(	vtkfigFrame *	frame,
		vtkfigVectorView *	figure
	)

Remove figure.

vtkfigRemoveGridView()

void vtkfigRemoveGridView	(	vtkfigFrame *	frame,
		vtkfigGridView *	figure
	)

Remove figure.

vtkfigRemoveXYPlot()

void vtkfigRemoveXYPlot	(	vtkfigFrame *	frame,
		vtkfigXYPlot *	figure
	)

Remove figure.

vtkfigWritePNG()

void vtkfigWritePNG	(	vtkfigFrame *	frame,
		char *	fname
	)

Write png image of frame content.

vtkfigStartVideo()

void vtkfigStartVideo	(	vtkfigFrame *	frame,
		char *	fname
	)

Start video recording.

vtkfigStopVideo()

void vtkfigStopVideo

(

vtkfigFrame *

frame

)

Stop video recording.

vtkfigSetSize()

void vtkfigSetSize	(	vtkfigFrame *	frame,
		int	x,
		int	y
	)

Set frame size in pixels.

vtkfigSetLayout()

void vtkfigSetLayout	(	vtkfigFrame *	frame,
		int	x,
		int	y
	)

Set layout of subframe grid.

vtkfigSetWindowTitle()

void vtkfigSetWindowTitle	(	vtkfigFrame *	frame,
		char *	title
	)

Set window title.

vtkfigSetFrameTitle()

void vtkfigSetFrameTitle	(	vtkfigFrame *	frame,
		char *	title
	)

Set Frame title.

vtkfigSetPosition()

void vtkfigSetPosition	(	vtkfigFrame *	frame,
		int	x,
		int	y
	)

Set frame position on screen.

vtkfigWriteVTK()

void vtkfigWriteVTK	(	vtkfigDataSet *	dataset,
		char *	filename,
		char *	filetype
	)

Write dataset to disk in VTK format.

vtkfigSetIsolevels()

void vtkfigSetIsolevels	(	vtkfigScalarView *	scalarview,
		double *	v,
		int	nv
	)

vtkfigShowIsosurfaces()

void vtkfigShowIsosurfaces	(	vtkfigScalarView *	scalarview,
		int	show
	)

vtkfigSetQuiverGrid2D()

void vtkfigSetQuiverGrid2D	(	vtkfigVectorView *	vectorview,
		int	nx,
		int	ny
	)

Set quiver points on grid in domain bounding box (2D)

vtkfigSetQuiverGrid3D()

void vtkfigSetQuiverGrid3D	(	vtkfigVectorView *	vectorview,
		int	nx,
		int	ny,
		int	nz
	)

Set quiver points on grid in domain bounding box (2D)

vtfigAddPlot()

void vtfigAddPlot	(	vtkfigXYPlot *	xyplot,
		double *	x,
		int	nx,
		double *	y,
		int	ny
	)

Add a pair of x/y data to the figure.

vtkfigSetTitle()

void vtkfigSetTitle	(	vtkfigXYPlot *	xyplot,
		char *	t
	)

Set the title of the plot.

vtkfigShowLegend()

void vtkfigShowLegend	(	vtkfigXYPlot *	xyplot,
		int	b
	)

Show a legend box ?

vtkfigShowGrid()

void vtkfigShowGrid	(	vtkfigXYPlot *	xyplot,
		int	b
	)

Show grid lines in the plot ?

vtkfigAdjustLabels()

void vtkfigAdjustLabels	(	vtkfigXYPlot *	xyplot,
		int	b
	)

Adjust labels to "nice values" ?

vtkfigSetLegendPosition()

void vtkfigSetLegendPosition	(	vtkfigXYPlot *	xyplot,
		double	x,
		double	y
	)

Set the position of the legend box.

vtkfigSetLegendSize()

void vtkfigSetLegendSize	(	vtkfigXYPlot *	xyplot,
		double	w,
		double	h
	)

Set the size of the legend box.

vtkfigClear()

void vtkfigClear

(

vtkfigXYPlot *

xyplot

)

Remove all data from plot.

vtkfigSetPlotLineType()

void vtkfigSetPlotLineType	(	vtkfigXYPlot *	xyplot,
		char *	t
	)

Set the line type of the next plot.

vtkfigSetPlotMarkerType()

void vtkfigSetPlotMarkerType	(	vtkfigXYPlot *	xyplot,
		char *	t
	)

Set marker type.

vtkfigSetPlotColor()

void vtkfigSetPlotColor	(	vtkfigXYPlot *	xyplot,
		double	r,
		double	g,
		double	b
	)

Set the color of the next plot.

vtkfigSetPlotLegend()

void vtkfigSetPlotLegend	(	vtkfigXYPlot *	xyplot,
		char *	t
	)

Set the information for the legend entry for the next plot.

vtkfigSetGridColor()

void vtkfigSetGridColor	(	vtkfigXYPlot *	xyplot,
		double	r,
		double	g,
		double	b
	)

Set the color of the grid lines.

vtkfigSetAxesColor()

void vtkfigSetAxesColor	(	vtkfigXYPlot *	xyplot,
		double	r,
		double	g,
		double	b
	)

Set the color of the axes.

vtkfigSetXTitle()

void vtkfigSetXTitle	(	vtkfigXYPlot *	xyplot,
		char *	t
	)

Set the title of the x axis.

vtkfigSetYTitle()

void vtkfigSetYTitle	(	vtkfigXYPlot *	xyplot,
		char *	t
	)

Set the title of the y axis.

vtkfigSetLineWidth()

void vtkfigSetLineWidth	(	vtkfigXYPlot *	xyplot,
		double	w
	)

Set the width of all lines in the plot.

vtkfigSetMarkerSize()

void vtkfigSetMarkerSize	(	vtkfigXYPlot *	xyplot,
		double	s
	)

Set the size of all markers in the plot.

vtkfigSetXRange()

void vtkfigSetXRange	(	vtkfigXYPlot *	xyplot,
		double	x0,
		double	x1
	)

Set the range of the x values.

vtkfigSetYRange()

void vtkfigSetYRange	(	vtkfigXYPlot *	xyplot,
		double	y0,
		double	y1
	)

Set the range of the y values.

vtkfigSetNumberOfXLabels()

void vtkfigSetNumberOfXLabels	(	vtkfigXYPlot *	xyplot,
		int	n
	)

Set the number of x axis labels.

vtkfigSetNumberOfYLabels()

void vtkfigSetNumberOfYLabels	(	vtkfigXYPlot *	xyplot,
		int	n
	)

Set the number of y axis labels.