VTKFIG  0.25.0
Easy VTK based in situ visualization
vtkfigCAPI.h
Go to the documentation of this file.
1 
10 #ifdef __cplusplus
11 extern "C" {
12 #endif
13 
17  void vtkfigPrintOpenGLInfo();
18 
22  typedef struct vtkfigFrame_struct vtkfigFrame;
30  void vtkfigDestroyFrame(vtkfigFrame *frame);
31 
35  void vtkfigUnmapFrame(vtkfigFrame *frame);
36 
40  typedef struct vtkfigDataSet_struct vtkfigDataSet;
48  void vtkfigDestroyDataSet(vtkfigDataSet *dataset);
49 
53  typedef struct vtkfigScalarView_struct vtkfigScalarView;
61  void vtkfigDestroyScalarView(vtkfigScalarView *scalarview);
62 
66  typedef struct vtkfigVectorView_struct vtkfigVectorView;
74  void vtkfigDestroyVectorView(vtkfigVectorView *vectorview);
75 
79  typedef struct vtkfigGridView_struct vtkfigGridView;
87  void vtkfigDestroyGridView(vtkfigGridView *gridview);
88 
92  typedef struct vtkfigXYPlot_struct vtkfigXYPlot;
100  void vtkfigDestroyXYPlot(vtkfigXYPlot *xyplot);
101 
102 
106  void vtkfigSetRectilinearGrid2D(vtkfigDataSet*dataset,double *x, int nx, double *y, int ny);
107 
111  void vtkfigSetRectilinearGrid3D(vtkfigDataSet*dataset,double *x, int nx, double *y, int ny, double *z, int nz);
112 
116  void vtkfigSetSimplexGrid(vtkfigDataSet*dataset,int index_offset, int dim, double *points, int npoints, int *cells, int ncells);
117 
121  void vtkfigSetCellRegions(vtkfigDataSet*dataset, int *cr, int n);
125  void vtkfigSetBoundaryCellRegions(vtkfigDataSet*dataset, int *cr, int n);
129  void vtkfigSetSimplexGridBoundaryCells(vtkfigDataSet*dataset, int index_offset, int dim, int *bc, int n);
130 
131 
132 
133 
134 
138  void vtkfigSetRectilinearGrid3D(vtkfigDataSet*dataset,double *x, int nx, double *y, int ny, double *z, int nz);
139 
140 
144  void vtkfigSetPointScalar(vtkfigDataSet*dataset,double *x, int nx, char *name);
145 
149  void vtkfigSetPointVector(vtkfigDataSet*dataset,double *uvw, int npoints, int dim, char *name);
150 
151 
155  void vtkfigSetGridViewData(vtkfigGridView*gridview, vtkfigDataSet*dataset);
156 
160  void vtkfigSetScalarViewData(vtkfigScalarView*scalarview, vtkfigDataSet*dataset, char *name);
161 
165  void vtkfigSetVectorViewData(vtkfigVectorView*vectorview, vtkfigDataSet*dataset, char *name);
166 
170  void vtkfigShow(vtkfigFrame*frame);
171 
175  void vtkfigInteract(vtkfigFrame*frame);
176 
180  void vtkfigClearFrame(vtkfigFrame *frame);
181 
185  void vtkfigAddScalarView(vtkfigFrame*frame, vtkfigScalarView *figure);
189  void vtkfigAddVectorView(vtkfigFrame*frame, vtkfigVectorView *figure);
193  void vtkfigAddGridView(vtkfigFrame*frame, vtkfigGridView *figure);
197  void vtkfigAddXYPlot(vtkfigFrame*frame, vtkfigXYPlot *figure);
198 
202  void vtkfigAddScalarViewAt(vtkfigFrame*frame, vtkfigScalarView *figure, int ipos);
206  void vtkfigAddVectorViewAt(vtkfigFrame*frame, vtkfigVectorView *figure, int ipos);
210  void vtkfigAddGridViewAt(vtkfigFrame*frame, vtkfigGridView *figure, int ipos);
214  void vtkfigAddXYPlotAt(vtkfigFrame*frame, vtkfigXYPlot *figure, int ipos);
215 
227  void vtkfigRemoveGridView(vtkfigFrame*frame, vtkfigGridView *figure);
231  void vtkfigRemoveXYPlot(vtkfigFrame*frame, vtkfigXYPlot *figure);
232 
236  void vtkfigWritePNG(vtkfigFrame*frame, char*fname);
240  void vtkfigStartVideo(vtkfigFrame*frame, char*fname);
244  void vtkfigStopVideo(vtkfigFrame*frame);
248  void vtkfigSetSize(vtkfigFrame*frame,int x, int y);
252  void vtkfigSetLayout(vtkfigFrame*frame,int x, int y);
256  void vtkfigSetWindowTitle(vtkfigFrame*frame, char*title);
260  void vtkfigSetFrameTitle(vtkfigFrame*frame, char*title);
264  void vtkfigSetPosition(vtkfigFrame*frame,int x, int y);
265 
269  void vtkfigWriteVTK(vtkfigDataSet*dataset,char* filename, char* filetype);
270 
274  void vtkfigSetIsolevels(vtkfigScalarView *scalarview,double *v, int nv);
275 
279  void vtkfigShowIsosurfaces(vtkfigScalarView *scalarview, int show);
280 
284  void vtkfigSetQuiverGrid2D(vtkfigVectorView *vectorview, int nx, int ny );
285 
289  void vtkfigSetQuiverGrid3D(vtkfigVectorView *vectorview, int nx, int ny, int nz );
290 
291 
295  void vtfigAddPlot(vtkfigXYPlot*xyplot, double *x, int nx, double *y, int ny);
299  void vtkfigSetTitle(vtkfigXYPlot*xyplot,char *t);
303  void vtkfigShowLegend(vtkfigXYPlot*xyplot,int b);
307  void vtkfigShowGrid(vtkfigXYPlot*xyplot,int b);
308 
312  void vtkfigAdjustLabels(vtkfigXYPlot*xyplot,int b);
316  void vtkfigSetLegendPosition(vtkfigXYPlot*xyplot,double x, double y);
320  void vtkfigSetLegendSize(vtkfigXYPlot*xyplot,double w, double h);
321 
325  void vtkfigClear(vtkfigXYPlot*xyplot);
329  void vtkfigSetPlotLineType(vtkfigXYPlot*xyplot,char *t);
333  void vtkfigSetPlotMarkerType(vtkfigXYPlot*xyplot,char *t);
337  void vtkfigSetPlotColor(vtkfigXYPlot*xyplot,double r, double g, double b);
341  void vtkfigSetPlotLegend(vtkfigXYPlot*xyplot,char *t);
345  void vtkfigSetGridColor(vtkfigXYPlot*xyplot,double r, double g, double b);
349  void vtkfigSetAxesColor(vtkfigXYPlot*xyplot,double r, double g, double b);
353  void vtkfigSetXTitle(vtkfigXYPlot*xyplot,char *t);
357  void vtkfigSetYTitle(vtkfigXYPlot*xyplot,char *t);
358 
362  void vtkfigSetLineWidth(vtkfigXYPlot*xyplot,double w);
366  void vtkfigSetMarkerSize(vtkfigXYPlot*xyplot,double s);
367 
371  void vtkfigSetXRange(vtkfigXYPlot*xyplot,double x0, double x1);
375  void vtkfigSetYRange(vtkfigXYPlot*xyplot,double y0, double y1);
379  void vtkfigSetNumberOfXLabels(vtkfigXYPlot*xyplot,int n);
383  void vtkfigSetNumberOfYLabels(vtkfigXYPlot*xyplot,int n);
384 
385 
386  typedef struct vtkfigSimplexGrid_struct vtkfigSimplexGrid;
387  void vtkfigDelaunay(vtkfigSimplexGrid *g,int index_offset, int dim, double *inpoints,int n_inpoints);
388 
389 #ifdef __cplusplus
390 }
391 #endif
vtkfigSetGridViewData
void vtkfigSetGridViewData(vtkfigGridView *gridview, vtkfigDataSet *dataset)
Add Dataset to figure.
vtkfigDestroyVectorView
void vtkfigDestroyVectorView(vtkfigVectorView *vectorview)
vtkfigStopVideo
void vtkfigStopVideo(vtkfigFrame *frame)
Stop video recording.
vtkfigXYPlot
struct vtkfigXYPlot_struct vtkfigXYPlot
XY Function plot.
Definition: vtkfigCAPI.h:92
vtkfigAddXYPlot
void vtkfigAddXYPlot(vtkfigFrame *frame, vtkfigXYPlot *figure)
Add figure at position (0)
vtkfigSetIsolevels
void vtkfigSetIsolevels(vtkfigScalarView *scalarview, double *v, int nv)
vtkfig::Figure::AddActor2D
void AddActor2D(vtkSmartPointer< vtkActor2D > prop)
Add vtk Actor to renderer showing figure.
Definition: vtkfigFigure.h:149
vtkfigSetNumberOfXLabels
void vtkfigSetNumberOfXLabels(vtkfigXYPlot *xyplot, int n)
Set the number of x axis labels.
vtkfigGLScene.h
vtkfig::XYPlot::SetPlotLineType
void SetPlotLineType(const std::string type)
Set the line type of the next plot.
vtkfigCreateGridView
vtkfigGridView * vtkfigCreateGridView(void)
vtkfig::VectorView::New
static std::shared_ptr< VectorView > New()
Smart pointer constructor.
vtkfigClearFrame
void vtkfigClearFrame(vtkfigFrame *frame)
Remove all figures.
vtkfigDestroyXYPlot
void vtkfigDestroyXYPlot(vtkfigXYPlot *xyplot)
vtkfig::Delaunay2D
void Delaunay2D(const V0 &points_in, V &points, IV &cells)
Create a 2D Delaunay triangulation from point set.
Definition: vtkfigTools.h:70
vtkfigSetGridColor
void vtkfigSetGridColor(vtkfigXYPlot *xyplot, double r, double g, double b)
Set the color of the grid lines.
vtkfigSetNumberOfYLabels
void vtkfigSetNumberOfYLabels(vtkfigXYPlot *xyplot, int n)
Set the number of y axis labels.
vtkfig::Frame::SetPosition
void SetPosition(int x, int y)
Set frame position on screen.
vtkfigSetYTitle
void vtkfigSetYTitle(vtkfigXYPlot *xyplot, char *t)
Set the title of the y axis.
vtkfigVectorView
struct vtkfigVectorView_struct vtkfigVectorView
Quiver plots + streamlines for vector fields.
Definition: vtkfigCAPI.h:66
vtkfigScalarView.h
vtkfig::GridView::New
static std::shared_ptr< GridView > New()
GridView smart pointer constructor.
vtkfig::XYPlot::SetPlotLegend
void SetPlotLegend(const std::string legend)
Set the information for the legend entry for the next plot.
vtkfigSetXRange
void vtkfigSetXRange(vtkfigXYPlot *xyplot, double x0, double x1)
Set the range of the x values.
vtkfigSetLineWidth
void vtkfigSetLineWidth(vtkfigXYPlot *xyplot, double w)
Set the width of all lines in the plot.
vtkfig::ScalarView::SetSurfaceRGBTable
void SetSurfaceRGBTable(const V &tab, int lutsize)
Set Surface RGB table from vector.
Definition: vtkfigScalarView.h:119
vtkfigCreateVectorView
vtkfigVectorView * vtkfigCreateVectorView(void)
vtkfigCAPI.h
vtkfig::DataSet::SetRectilinearGrid
void SetRectilinearGrid(const V &x, const V &y)
Enter data of a 2D rectilinear grid.
Definition: vtkfigDataSet.h:469
vtkfigShowGrid
void vtkfigShowGrid(vtkfigXYPlot *xyplot, int b)
Show grid lines in the plot ?
vtkfigWritePNG
void vtkfigWritePNG(vtkfigFrame *frame, char *fname)
Write png image of frame content.
vtkfig::Delaunay3D
void Delaunay3D(const V0 &points_in, V &points, IV &cells)
Create a 3D Delaunay triangulation from point set.
Definition: vtkfigTools.h:115
vtkfigSetSize
void vtkfigSetSize(vtkfigFrame *frame, int x, int y)
Set frame size in pixels.
vtkfigRemoveXYPlot
void vtkfigRemoveXYPlot(vtkfigFrame *frame, vtkfigXYPlot *figure)
Remove figure.
vtkfigWriteVTK
void vtkfigWriteVTK(vtkfigDataSet *dataset, char *filename, char *filetype)
Write dataset to disk in VTK format.
vtkfigShow
void vtkfigShow(vtkfigFrame *frame)
Show frame content and continue.
vtkfig::PrintOpenGLInfo
void PrintOpenGLInfo(void)
Print Open GL info to screen.
vtkfigSetRectilinearGrid2D
void vtkfigSetRectilinearGrid2D(vtkfigDataSet *dataset, double *x, int nx, double *y, int ny)
Enter data of a 2D rectilinear grid.
vtkfigDestroyScalarView
void vtkfigDestroyScalarView(vtkfigScalarView *scalarview)
vtkfigStartVideo
void vtkfigStartVideo(vtkfigFrame *frame, char *fname)
Start video recording.
vtfigAddPlot
void vtfigAddPlot(vtkfigXYPlot *xyplot, double *x, int nx, double *y, int ny)
Add a pair of x/y data to the figure.
vtkfig::DataSet::SetPointScalar
void SetPointScalar(const V &f, const std::string name)
Set data of a scalar function defined on the points of the grid.
Definition: vtkfigDataSet.h:703
vtkfig::XYPlot::AddPlot
void AddPlot(const V &x, const V &y)
Add a pair of x/y data to the figure.
Definition: vtkfigXYPlot.h:295
vtkfigSetPlotColor
void vtkfigSetPlotColor(vtkfigXYPlot *xyplot, double r, double g, double b)
Set the color of the next plot.
vtkfigAddGridView
void vtkfigAddGridView(vtkfigFrame *frame, vtkfigGridView *figure)
Add figure at position (0)
vtkfig::Frame::AddFigure
void AddFigure(std::shared_ptr< Figure > figure)
Add figure at position (0)
vtkfigSetYRange
void vtkfigSetYRange(vtkfigXYPlot *xyplot, double y0, double y1)
Set the range of the y values.
vtkfigRemoveScalarView
void vtkfigRemoveScalarView(vtkfigFrame *frame, vtkfigScalarView *figure)
Remove figure.
vtkfigDestroyFrame
void vtkfigDestroyFrame(vtkfigFrame *frame)
vtkfigSetScalarViewData
void vtkfigSetScalarViewData(vtkfigScalarView *scalarview, vtkfigDataSet *dataset, char *name)
Add Dataset to figure.
vtkfigAddVectorViewAt
void vtkfigAddVectorViewAt(vtkfigFrame *frame, vtkfigVectorView *figure, int ipos)
Add figure at position (0)
vtkfig::Frame::SetLayout
void SetLayout(int nvpx, int nvpy)
Set layout of subframe grid.
vtkfigFigure.h
vtkfigSetQuiverGrid2D
void vtkfigSetQuiverGrid2D(vtkfigVectorView *vectorview, int nx, int ny)
Set quiver points on grid in domain bounding box (2D)
vtkfigAdjustLabels
void vtkfigAdjustLabels(vtkfigXYPlot *xyplot, int b)
Adjust labels to "nice values" ?
vtkfigXYPlot.h
vtkfigFrame
struct vtkfigFrame_struct vtkfigFrame
Provide a framework wrapping window+interactor+renderers from vtk.
Definition: vtkfigCAPI.h:22
vtkfig::Figure::SetData
void SetData(std::shared_ptr< DataSet > data, const std::string name="")
Add Dataset to figure.
vtkfigSetPointVector
void vtkfigSetPointVector(vtkfigDataSet *dataset, double *uvw, int npoints, int dim, char *name)
vtkfigDataSet
struct vtkfigDataSet_struct vtkfigDataSet
Class to collect all data given on one grid.
Definition: vtkfigCAPI.h:40
vtkfigDestroyGridView
void vtkfigDestroyGridView(vtkfigGridView *gridview)
vtkfigClient.h
vtkfigCreateScalarView
vtkfigScalarView * vtkfigCreateScalarView(void)
vtkfigRemoveVectorView
void vtkfigRemoveVectorView(vtkfigFrame *frame, vtkfigVectorView *figure)
Remove figure.
vtkfigClear
void vtkfigClear(vtkfigXYPlot *xyplot)
Remove all data from plot.
vtkfig::XYPlot::SetYRange
void SetYRange(double y0, double y1)
Set the range of the y values.
vtkfigSetLayout
void vtkfigSetLayout(vtkfigFrame *frame, int x, int y)
Set layout of subframe grid.
vtkfigSetLegendPosition
void vtkfigSetLegendPosition(vtkfigXYPlot *xyplot, double x, double y)
Set the position of the legend box.
vtkfigGridView
struct vtkfigGridView_struct vtkfigGridView
Grid visualization.
Definition: vtkfigCAPI.h:79
vtkfigSetPlotMarkerType
void vtkfigSetPlotMarkerType(vtkfigXYPlot *xyplot, char *t)
Set marker type.
vtkfigSetFrameTitle
void vtkfigSetFrameTitle(vtkfigFrame *frame, char *title)
Set Frame title.
vtkfigSetPlotLegend
void vtkfigSetPlotLegend(vtkfigXYPlot *xyplot, char *t)
Set the information for the legend entry for the next plot.
vtkfig::Frame::SetFrameTitle
void SetFrameTitle(const std::string title)
Set Frame title.
vtkfig::Figure::SetTitle
void SetTitle(std::string xtitle)
Set figure title.
Definition: vtkfigFigure.h:103
vtkfig::ScalarView::New
static std::shared_ptr< ScalarView > New()
Create smart pointer to ScalarView instance.
vtkfig::Figure::New
static std::shared_ptr< Figure > New()
Construct smartpointer to empty figure.
vtkfig::internal::BuildLookupTable
vtkSmartPointer< vtkLookupTable > BuildLookupTable(RGBTable &xrgb, size_t size)
Build lookup table.
vtkfigSetCellRegions
void vtkfigSetCellRegions(vtkfigDataSet *dataset, int *cr, int n)
Set cell region data (for multiregion grids)
vtkfigSetLegendSize
void vtkfigSetLegendSize(vtkfigXYPlot *xyplot, double w, double h)
Set the size of the legend box.
vtkfig::DataSet::SetSimplexGrid
void SetSimplexGrid(int dim, const V &points, const IV &cells)
Enter data of a simplex grid.
Definition: vtkfigDataSet.h:362
vtkfigAddXYPlotAt
void vtkfigAddXYPlotAt(vtkfigFrame *frame, vtkfigXYPlot *figure, int ipos)
Add figure at position (0)
vtkfig::Frame::Show
void Show()
Show frame content and continue.
vtkfig::internals::Client
Client side visualization setup.
Definition: vtkfigClient.h:30
vtkfig::Figure::SetViewVolume
void SetViewVolume(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
Set view volume (e.g. to zoom in to a part)
Definition: vtkfigFigure.h:106
vtkfigSetVectorViewData
void vtkfigSetVectorViewData(vtkfigVectorView *vectorview, vtkfigDataSet *dataset, char *name)
Add Dataset to figure.
vtkfigPrintOpenGLInfo
void vtkfigPrintOpenGLInfo()
vtkfigShowIsosurfaces
void vtkfigShowIsosurfaces(vtkfigScalarView *scalarview, int show)
vtkfigAddVectorView
void vtkfigAddVectorView(vtkfigFrame *frame, vtkfigVectorView *figure)
Add figure at position (0)
vtkfigUnmapFrame
void vtkfigUnmapFrame(vtkfigFrame *frame)
Unmap frame from screen.
vtkfigSetTitle
void vtkfigSetTitle(vtkfigXYPlot *xyplot, char *t)
Set the title of the plot.
vtkfigAddScalarView
void vtkfigAddScalarView(vtkfigFrame *frame, vtkfigScalarView *figure)
Add figure at position (0)
vtkfigCreateDataSet
vtkfigDataSet * vtkfigCreateDataSet(void)
vtkfig::XYPlot::SetPlotColor
void SetPlotColor(double r, double g, double b)
Set the color of the next plot.
vtkfig::Frame::SetWindowTitle
void SetWindowTitle(const std::string title)
Set window title.
vtkfigScalarView
struct vtkfigScalarView_struct vtkfigScalarView
Surface and contour plot of 2/3D scalar data.
Definition: vtkfigCAPI.h:53
vtkfig::NSpin
size_t NSpin()
Return content of environment variable VTKFIG_NSPIN or large value.
vtkfigSetPosition
void vtkfigSetPosition(vtkfigFrame *frame, int x, int y)
Set frame position on screen.
vtkfigAddScalarViewAt
void vtkfigAddScalarViewAt(vtkfigFrame *frame, vtkfigScalarView *figure, int ipos)
Add figure at position (0)
vtkfigSetAxesColor
void vtkfigSetAxesColor(vtkfigXYPlot *xyplot, double r, double g, double b)
Set the color of the axes.
vtkfigCreateFrame
vtkfigFrame * vtkfigCreateFrame(void)
vtkfigDestroyDataSet
void vtkfigDestroyDataSet(vtkfigDataSet *dataset)
vtkfigCreateXYPlot
vtkfigXYPlot * vtkfigCreateXYPlot(void)
vtkfigInteract
void vtkfigInteract(vtkfigFrame *frame)
Show frame content and wait for interaction.
vtkfig::RGBTable
std::vector< RGBPoint > RGBTable
Color table.
Definition: vtkfigTools.h:43
vtkfigShowLegend
void vtkfigShowLegend(vtkfigXYPlot *xyplot, int b)
Show a legend box ?
vtkfigSetSimplexGrid
void vtkfigSetSimplexGrid(vtkfigDataSet *dataset, int index_offset, int dim, double *points, int npoints, int *cells, int ncells)
Enter data of a simplex grid.
vtkfigSetXTitle
void vtkfigSetXTitle(vtkfigXYPlot *xyplot, char *t)
Set the title of the x axis.
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.
vtkfig::Frame::SetSize
void SetSize(int x, int y)
Set frame size in pixels.
vtkfig::Frame::Interact
void Interact()
Show frame content and wait for interaction.
vtkfigRemoveGridView
void vtkfigRemoveGridView(vtkfigFrame *frame, vtkfigGridView *figure)
Remove figure.
vtkfigVectorView.h
vtkfigTools.h
vtkfig::DataSet::New
static std::shared_ptr< DataSet > New()
Static constructor of smart pointer to an empty instance.
vtkfigSetSimplexGridBoundaryCells
void vtkfigSetSimplexGridBoundaryCells(vtkfigDataSet *dataset, int index_offset, int dim, int *bc, int n)
vtkfig::Frame::WritePNG
void WritePNG(std::string fname)
Write png image of frame content.
vtkfigDataSet.h
vtkfigFrame.h
vtkfigGridView.h
vtkfigSetPointScalar
void vtkfigSetPointScalar(vtkfigDataSet *dataset, double *x, int nx, char *name)
vtkfig::XYPlot::New
static std::shared_ptr< XYPlot > New()
Smartpointer construtor.
vtkfig::Frame::LinkCamera
void LinkCamera(int ivp, Frame &frame, int livp)
Link camera to other camera.
vtkfigSetBoundaryCellRegions
void vtkfigSetBoundaryCellRegions(vtkfigDataSet *dataset, int *cr, int n)
Set boundary cell region data (for multiregion grids)
vtkfigSetQuiverGrid3D
void vtkfigSetQuiverGrid3D(vtkfigVectorView *vectorview, int nx, int ny, int nz)
Set quiver points on grid in domain bounding box (2D)
vtkfigSetMarkerSize
void vtkfigSetMarkerSize(vtkfigXYPlot *xyplot, double s)
Set the size of all markers in the plot.
vtkfigSetPlotLineType
void vtkfigSetPlotLineType(vtkfigXYPlot *xyplot, char *t)
Set the line type of the next plot.
vtkfig::Frame::New
static std::shared_ptr< Frame > New()
Create smart pointer to frame.
vtkfigSetWindowTitle
void vtkfigSetWindowTitle(vtkfigFrame *frame, char *title)
Set window title.
vtkfig::XYPlot::Clear
void Clear()
Remove all data from plot.
vtkfigAddGridViewAt
void vtkfigAddGridViewAt(vtkfigFrame *frame, vtkfigGridView *figure, int ipos)
Add figure at position (0)
vtkfig::Figure::AddActor
void AddActor(vtkSmartPointer< vtkActor > prop)
Add vtk Actor to renderer showing figure.
Definition: vtkfigFigure.h:144