0077dbce70e6fe2ead7f02bea6e05639e3f1c732
[scilab.git] / scilab / modules / graphics / includes / SetProperty.h
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2001 - 2002 - INRIA - Matthhieu Philippe
4  * Copyright (C) 2002 - 2004 - INRIA - Djalel Abdemouche
5  * Copyright (C) 2004 - 2006 - INRIA - Fabrice Leray
6  * Copyright (C) 2005 - INRIA - Jean-Baptiste Silvy
7  * Copyright (C) 2010 - Paul Griffiths
8  * Copyright (C) 2011 - DIGITEO - Bruno JOFRET
9  *
10  * This file must be used under the terms of the CeCILL.
11  * This source file is licensed as described in the file COPYING, which
12  * you should have received as part of this distribution.  The terms
13  * are also available at
14  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
15  *
16  */
17
18 /*------------------------------------------------------------------------
19  *    Graphic library
20  *    -This file contains all functions used to SET the properties of graphics
21  *    objects.
22  *    - there are two kinds of functions : the sciInit*** which only set an object
23  *      property and sciSet*** which do the same work but check before if it is
24  *      necessary to do so.
25  *    - The returning status of each functions is as follow :
26  *      0 for correct execution, 1 if no change was made
27  *      and -1 if an error occured.
28  --------------------------------------------------------------------------*/
29
30
31 #ifndef __SCI_SET_PROPERTY__
32 #define __SCI_SET_PROPERTY__
33
34 #include "dynlib_graphics.h"
35 #include "ObjectStructure.h"
36 #include "BOOL.h"
37
38 GRAPHICS_IMPEXP void Obj_RedrawNewAngle(char* pSubwin, double alpha, double theta); /* SET  */
39
40 GRAPHICS_IMPEXP int sciSetEntityType (char* pobj, sciEntityType value); /* SET */
41 GRAPHICS_IMPEXP int sciSetColormap (char* pobj, double *rgbmat,
42                            int m, int n); /* SET */
43 GRAPHICS_IMPEXP int sciInitNumColors( char* pobj, int numcolors ) ; /* SET */
44 GRAPHICS_IMPEXP int sciSetNumColors ( char* pobj, int numcolors ) ; /* SET */
45
46 GRAPHICS_IMPEXP int sciSetGoodIndex(char* pobj, int colorindex);  /* SET */
47 GRAPHICS_IMPEXP void sciRecursiveUpdateBaW(char* pobj, int old_m, int m);  /* SET */
48 GRAPHICS_IMPEXP int sciUpdateBaW (char* pobj, int flag, int value ) ; /* SET */
49
50 GRAPHICS_IMPEXP int sciInitBackground( char* pobj, int colorindex ) ;
51 GRAPHICS_IMPEXP int sciSetBackground ( char* pobj, int colorindex ) ; /* SET */
52
53 GRAPHICS_IMPEXP int sciInitForeground( char* pobj, int colorindex ) ;
54 GRAPHICS_IMPEXP int sciSetForeground ( char* pobj, int colorindex ) ; /* SET */
55
56 GRAPHICS_IMPEXP int sciInitLineWidth( char* pobj, double linewidth ) ;
57 GRAPHICS_IMPEXP int sciSetLineWidth ( char* pobj, double linewidth ) ;  /* SET */
58
59 GRAPHICS_IMPEXP int sciInitIsLine(char* pobj, BOOL isline);
60 GRAPHICS_IMPEXP int sciSetIsLine (char* pobj, BOOL isline);  /* SET */
61
62 GRAPHICS_IMPEXP int sciInitLineStyle( char* pobj, int linestyle ) ;
63 GRAPHICS_IMPEXP int sciSetLineStyle ( char* pobj, int linestyle ) ; /* SET */
64
65 GRAPHICS_IMPEXP int sciInitIsMark(char* pobj, BOOL ismark);  /* SET */
66 GRAPHICS_IMPEXP int sciSetIsMark (char* pobj, BOOL ismark);  /* SET */
67
68 GRAPHICS_IMPEXP int sciInitIsFilled(char* pobj, BOOL isfilled);
69 GRAPHICS_IMPEXP int sciSetIsFilled (char* pobj, BOOL isfilled);  /* SET */
70
71 GRAPHICS_IMPEXP int sciInitPolylineStyle( char* pobj, int plot );
72 GRAPHICS_IMPEXP int sciInitArrowSize( char* pobj, double size );
73
74 GRAPHICS_IMPEXP int sciInitMarkStyle(char* pobj, int markstyle);
75 GRAPHICS_IMPEXP int sciSetMarkStyle (char* pobj, int markstyle); /* SET */
76
77 GRAPHICS_IMPEXP int sciInitMarkSize(char* pobj, int marksize);
78 GRAPHICS_IMPEXP int sciSetMarkSize (char* pobj, int marksize); /* SET */
79
80 GRAPHICS_IMPEXP int sciInitMarkSizeUnit(char* pobj, int marksizeunit);
81 GRAPHICS_IMPEXP int sciSetMarkSizeUnit (char* pobj, int marksizeunit); /* SET */
82
83 GRAPHICS_IMPEXP int sciInitMarkBackground(char* pobj, int colorindex);
84 GRAPHICS_IMPEXP int sciSetMarkBackground (char* pobj, int colorindex);  /* SET */
85
86 GRAPHICS_IMPEXP int sciInitMarkForeground(char* pobj, int colorindex);
87 GRAPHICS_IMPEXP int sciSetMarkForeground (char* pobj, int colorindex);  /* SET */
88
89 GRAPHICS_IMPEXP int sciInitBoxType( char* pobj, EAxesBoxType type ) ;
90 GRAPHICS_IMPEXP int sciSetBoxType ( char* pobj, EAxesBoxType type ) ; /* SET */
91
92 GRAPHICS_IMPEXP int sciInitIsBoxed(char* pobj, BOOL isboxed);
93 GRAPHICS_IMPEXP int sciSetIsBoxed (char* pobj, BOOL isboxed); /* SET */
94
95 GRAPHICS_IMPEXP int sciInitNbXSubTics(char* pobj, int nbsubtics);
96 GRAPHICS_IMPEXP int sciSetNbXSubTics (char* pobj, int nbsubtics); /* SET */
97
98 GRAPHICS_IMPEXP int sciInitNbYSubTics(char* pobj, int nbsubtics);
99 GRAPHICS_IMPEXP int sciSetNbYSubTics (char* pobj, int nbsubtics); /* SET */
100
101 GRAPHICS_IMPEXP int sciInitNbZSubTics(char* pobj, int nbsubtics);
102 GRAPHICS_IMPEXP int sciSetNbZSubTics (char* pobj, int nbsubtics); /* SET */
103
104 /* Text Functions */
105 GRAPHICS_IMPEXP int sciInitFontSize(char* pobj, double fontSize); /* SET */
106 GRAPHICS_IMPEXP int sciSetFontSize (char* pobj, double fontSize); /* SET */
107
108 GRAPHICS_IMPEXP int sciInitFontOrientation(char* pobj, double textorientation); /* SET */
109 GRAPHICS_IMPEXP int sciSetFontOrientation (char* pobj, double textorientation); /* SET */
110
111 GRAPHICS_IMPEXP int sciSetStrings( char* pobj, const StringMatrix * pStrings ) ; /* SET */
112 GRAPHICS_IMPEXP int sciSetText (   char* pobj, char ** text, int nbRow, int nbCol ) ; /* SET */
113
114 GRAPHICS_IMPEXP int sciInitFontBackground(char* pobj, int color);
115 GRAPHICS_IMPEXP int sciSetFontBackground (char* pobj, int color); /* SET */
116
117 GRAPHICS_IMPEXP int sciInitFontForeground(char* pobj, int colorindex ) ;
118 GRAPHICS_IMPEXP int sciSetFontForeground (char* pobj, int colorindex ) ; /* SET */
119
120 GRAPHICS_IMPEXP int sciInitFontStyle(char* pobj, int iAttributes ) ;
121 GRAPHICS_IMPEXP int sciSetFontStyle (char* pobj, int iAttributes ) ; /* SET */
122
123 /* Legend */
124 GRAPHICS_IMPEXP int sciInitLegendPlace(char* pobj, sciLegendPlace place);
125 GRAPHICS_IMPEXP int sciSetLegendPlace (char* pobj, sciLegendPlace place); /* SET */
126
127 GRAPHICS_IMPEXP int sciInitLegendPos(char* pobj, double position[]);
128 GRAPHICS_IMPEXP int sciSetLegendPos (char* pobj, double position[]); /* SET */
129
130 /* GMODE */
131 GRAPHICS_IMPEXP int sciInitIsClipping(char* pobj, int value) ;
132 GRAPHICS_IMPEXP int sciSetIsClipping (char* pobj, int value); /* SET */
133
134 GRAPHICS_IMPEXP int sciSetClipping (char* pobj, double pclip[4] ); /* SET */
135
136 GRAPHICS_IMPEXP int sciInitAddPlot (char* pobj, BOOL value);
137 GRAPHICS_IMPEXP int sciSetAddPlot (char* pobj, BOOL value); /* SET */
138
139 GRAPHICS_IMPEXP int sciInitAutoScale(char* pobj, BOOL value);
140 GRAPHICS_IMPEXP int sciSetAutoScale (char* pobj, BOOL value); /* SET */
141
142 GRAPHICS_IMPEXP int sciInitZooming(char* pobj, BOOL value);
143 GRAPHICS_IMPEXP int sciSetZooming (char* pobj, BOOL value); /* SET */
144
145 GRAPHICS_IMPEXP int sciInitXorMode(char* pobj, int value);
146 GRAPHICS_IMPEXP int sciSetXorMode (char* pobj, int value); /* SET */
147
148 GRAPHICS_IMPEXP int sciInitVisibility (char* pobj, BOOL value);
149 GRAPHICS_IMPEXP int sciSetVisibility (char* pobj, BOOL value); /* SET */
150
151 GRAPHICS_IMPEXP int sciInitResize(char* pobj, BOOL value);
152 GRAPHICS_IMPEXP int sciSetResize (char* pobj, BOOL value); /* SET */
153
154 GRAPHICS_IMPEXP int sciSetDefaultValues (void); /* SET */
155
156
157 /* Window Functions */
158 GRAPHICS_IMPEXP int sciInitName(char* pobj, char * newName); /* SET */
159 GRAPHICS_IMPEXP int sciSetName (char* pobj, char * newName); /* SET */
160 GRAPHICS_IMPEXP int sciInitNum( char* pobj, int value ) ;
161 GRAPHICS_IMPEXP int sciSetNum ( char* pobj, int value ) ; /* SET */
162
163 GRAPHICS_IMPEXP int sciInitDimension( char* pobj, int newWidth, int newHeight ) ;
164 GRAPHICS_IMPEXP int sciSetDimension(  char* pobj, int newWidth, int newHeight ) ; /* SET */
165
166 GRAPHICS_IMPEXP int sciInitWindowDim( char* pobj, int newWidth, int newHeight ) ;
167 GRAPHICS_IMPEXP int sciSetWindowDim(  char* pobj, int newWidth, int newHeight ) ; /* SET */
168
169 GRAPHICS_IMPEXP int sciInitScreenPosition(char* pobj, int pposx, int pposy);
170 GRAPHICS_IMPEXP int sciSetScreenPosition( char* pobj, int pposx, int pposy); /* SET */
171
172
173 GRAPHICS_IMPEXP void sciSelectFirstSubwin( char* parentFigure ) ; /* SET */
174
175 GRAPHICS_IMPEXP int sciInitSelectedSubWin (char* psubwinobj);
176 GRAPHICS_IMPEXP int sciSetSelectedSubWin (char* psubwinobj); /* SET */
177
178 GRAPHICS_IMPEXP int sciSetOriginalSubWin (char* pfigure, char* psubwin); /* SET */
179
180 GRAPHICS_IMPEXP int sciSetPoint(char* pthis, double *tab, int *numrow, int *numcol); /* SET */
181
182 GRAPHICS_IMPEXP int sciSetdrawmode(BOOL mode); /* SET */
183
184 GRAPHICS_IMPEXP int sciSetUsedWindow( int winNum ) ; /* SET */
185
186 GRAPHICS_IMPEXP int sciSetInterpVector(char* pobj, int size, int * value);
187
188 GRAPHICS_IMPEXP int sciInitAutoRotation( char* pObj, BOOL value ) ;
189 GRAPHICS_IMPEXP int sciSetAutoRotation ( char* pObj, BOOL value ) ;
190
191 GRAPHICS_IMPEXP int sciInitAutoPosition( char* pObj, BOOL value ) ;
192 GRAPHICS_IMPEXP int sciSetAutoPosition ( char* pObj, BOOL value ) ;
193
194 GRAPHICS_IMPEXP int sciInitAutoSize( char* pObj, BOOL autoSize ) ;
195 GRAPHICS_IMPEXP int sciSetAutoSize(  char* pObj, BOOL autoSize ) ;
196
197 GRAPHICS_IMPEXP int sciInitAlignment( char* pObj, sciTextAlignment align ) ;
198 GRAPHICS_IMPEXP int sciSetAlignment(  char* pObj, sciTextAlignment align ) ;
199
200 GRAPHICS_IMPEXP int sciInitUserSize( char* pObj, double width, double height ) ;
201 GRAPHICS_IMPEXP int sciSetUserSize(  char* pObj, double width, double height ) ;
202
203 GRAPHICS_IMPEXP int sciInitCenterPos( char* pObj, BOOL newCP ) ;
204 GRAPHICS_IMPEXP int sciSetCenterPos(  char* pObj, BOOL newCP ) ;
205
206 GRAPHICS_IMPEXP int sciInitIs3d( char* pObj, BOOL is3d ) ;
207 GRAPHICS_IMPEXP int sciSetIs3d(  char* pObj, BOOL is3d ) ;
208
209 GRAPHICS_IMPEXP int sciInitSelectedObject( char* pObj ) ;
210 GRAPHICS_IMPEXP int sciSetSelectObject(    char* pObj ) ;
211
212 GRAPHICS_IMPEXP int sciInitHiddenColor( char* pObj, int newColor ) ;
213 GRAPHICS_IMPEXP int sciSetHiddenColor(  char* pObj, int newColor ) ;
214
215 GRAPHICS_IMPEXP int sciInitHiddenAxisColor( char* pObj, int newColor ) ;
216 GRAPHICS_IMPEXP int sciSetHiddenAxisColor( char* pObj, int newColor ) ;
217
218 GRAPHICS_IMPEXP int setSubWinAngles( char* psubwin, double theta, double alpha );
219 GRAPHICS_IMPEXP int sciInitdrawmode( BOOL mode );
220
221 GRAPHICS_IMPEXP int sciInitGraphicsStyle( char* pobj, BOOL value );
222
223 GRAPHICS_IMPEXP int sciInitGridStyle( char* pObj, int xStyle, int yStyle, int zStyle ) ;
224 GRAPHICS_IMPEXP int sciSetGridStyle( char* pObj, int xStyle, int yStyle, int zStyle ) ; /* SET */
225
226 GRAPHICS_IMPEXP int sciSetViewport(  char* pObj, const int viewport[4] ) ; /* SET */
227
228 GRAPHICS_IMPEXP int sciInitInfoMessage(char* pObj, const char * newMessage);
229 GRAPHICS_IMPEXP int sciSetInfoMessage( char* pObj, const char * newMessage ) ; /* SET */
230
231 GRAPHICS_IMPEXP int sciInitEventHandler( char* pObj, char * name ) ;
232 GRAPHICS_IMPEXP int sciSetEventHandler(  char* pObj, char * name ) ;
233
234 GRAPHICS_IMPEXP int sciInitIsEventHandlerEnable( char* pObj, BOOL enable ) ;
235 GRAPHICS_IMPEXP int sciSetIsEventHandlerEnable(  char* pObj, BOOL enable ) ;
236
237 GRAPHICS_IMPEXP int sciSetDataBounds( char* pObj, double bounds[6] ) ; /* SET */
238 GRAPHICS_IMPEXP int sciSetRealDataBounds(char* pObj, const double bounds[6]); /* SET */
239
240 GRAPHICS_IMPEXP int sciInitViewingAngles( char* pObj, double alpha, double theta) ;
241 GRAPHICS_IMPEXP int sciSetViewingAngles( char* pObj, double alpha, double theta); /* SET */
242
243 GRAPHICS_IMPEXP int setInfoMessageWithRotationAngles(char* pFigure, double alpha, double theta);
244
245 GRAPHICS_IMPEXP int sciInitPixmapMode(char* pObj, BOOL onOrOff);
246 GRAPHICS_IMPEXP int sciSetPixmapMode(char* pObj, BOOL onOrOff); /* SET */
247
248 GRAPHICS_IMPEXP int sciInitTextPos( char* pObj, double posX, double posY, double posZ);
249 GRAPHICS_IMPEXP int sciSetTextPos( char* pObj, double posX, double posY, double posZ);
250
251 GRAPHICS_IMPEXP int sciInitLogFlags(char* pObj, char logFlags[3]);
252 GRAPHICS_IMPEXP int sciSetLogFlags(char* pObj, char logFlags[3]) ; /* SET */
253
254 GRAPHICS_IMPEXP int sciInitAutoTicks(char* pObj, BOOL autoTicksX, BOOL autoTicksY, BOOL autoTicksZ);
255 GRAPHICS_IMPEXP int sciSetAutoTicks(char* pObj, BOOL autoTicksX, BOOL autoTicksY, BOOL autoTicksZ); /* SET */
256
257 GRAPHICS_IMPEXP int sciSetZoomBox(char* pObj, const double zoomBox[6]); /* SET */
258
259 GRAPHICS_IMPEXP int sciInitImmediateDrawingMode(char* pObj, BOOL autoRedraw);
260 GRAPHICS_IMPEXP int sciSetImmediateDrawingMode(char* pObj, BOOL autoRedraw);
261
262 GRAPHICS_IMPEXP int sciInitUseNurbs(char* pObj, BOOL useNurbs);
263 GRAPHICS_IMPEXP int sciSetUseNurbs(char* pObj, BOOL useNurbs); /* SET */
264
265 GRAPHICS_IMPEXP int sciInitIsUsingFractionalMetrics(char* pObj, BOOL useFractionalMetrics);
266 GRAPHICS_IMPEXP int sciSetIsUsingFractionalMetrics(char* pObj, BOOL useFractionalMetrics); /* SET */
267
268 GRAPHICS_IMPEXP int sciInitColorRange(char* pObj, int subset[2]);
269 GRAPHICS_IMPEXP int sciSetColorRange(char* pObj, int subset[2]); /* SET */
270
271 GRAPHICS_IMPEXP int sciInitOutsideColors(char* pObj, int colors[2]);
272 GRAPHICS_IMPEXP int sciSetOutsideColors(char* pObj, int colors[2]); /* SET */
273
274 GRAPHICS_IMPEXP int sciInitZBounds(char* pObj, double bounds[2]);
275 GRAPHICS_IMPEXP int sciSetZBounds(char* pObj, double bounds[2]); /* SET */
276
277 GRAPHICS_IMPEXP int sciInitGridFront(char* pObj, BOOL gridFront);
278 GRAPHICS_IMPEXP int sciSetGridFront(char* pObj, BOOL gridFront); /* SET */
279
280 GRAPHICS_IMPEXP int sciInitLegendLocation(char* pObj, sciLegendPlace location);
281 GRAPHICS_IMPEXP int sciSetLegendLocation(char* pObj, sciLegendPlace location); /* SET */
282
283 GRAPHICS_IMPEXP int sciInitAntialiasingQuality(char* pObj, int quality);
284 GRAPHICS_IMPEXP int sciSetAntialiasingQuality(char* pObj, int quality); /* SET */
285
286 GRAPHICS_IMPEXP BOOL sciCheckColorIndex(char* pObj, int colorIndex);
287
288 /*---------------------------------------------------------------------------*/
289 /* return 0 if the string contains any % character, 1 if a %d has been found */
290 /* and -1 otherwise. */
291 GRAPHICS_IMPEXP int checkPercent( char * string ) ;
292 /*---------------------------------------------------------------------------*/
293
294 #endif /* __SCI_SET_PROPERTY__ */