S2PLOT:Function List
From S2PLOT
(Difference between revisions)
| Revision as of 01:43, 30 October 2007 S2plot admin (Talk | contribs) (→Deprecated Function Names (V1.48-V1.62)) ← Previous diff |
Revision as of 03:53, 22 November 2007 S2plot admin (Talk | contribs) (→Advanced Camera Control) Next diff → |
||
| Line 209: | Line 209: | ||
| <tr><td>[[Function:ss2sss | ss2sss]]</td><td>Set the spin / interaction speed </td><td> </td></tr> | <tr><td>[[Function:ss2sss | ss2sss]]</td><td>Set the spin / interaction speed </td><td> </td></tr> | ||
| <tr><td>[[Function:ss2qss | ss2qss]]</td><td>Get the spin / interaction speed </td><td> </td></tr> | <tr><td>[[Function:ss2qss | ss2qss]]</td><td>Get the spin / interaction speed </td><td> </td></tr> | ||
| + | <tr><td>[[Function:ss2qess | ss2qess]]</td><td>Get the eye separation multiplier</td><td> </td></tr> | ||
| + | <tr><td>[[Function:ss2sess | ss2sess]]</td><td>Set the eye separation multiplier </td><td> </td></tr> | ||
| </table> | </table> | ||
Revision as of 03:53, 22 November 2007
General
| S2PLOT | Description | PGPLOT |
|---|---|---|
| Colours | Useful colour definitions based on PGPlot default settings. | |
| Textures | Important information on using textures in S2PLOT. | |
| struct XYZ | Data structure for (x,y,z) coordinates. | |
| struct COLOUR | Data structure for (r,g,b) colour indices. |
Opening, Closing and Selecting Devices
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2open | Open the S2PLOT device. | PGOPEN |
| s2opend | Open the S2PLOT device (device string version). | PGOPEN |
| s2opendo | Open the S2PLOT device (device string version, ignoring command line arguments). | PGOPEN |
| s2ldev | List the available S2PLOT devices on stdout. | PGLDEV |
| s2show | Draw the scene and enter interactive mode if interactive is non-zero. | |
| s2disp | Draw the scene, but return control when a timeout occurs or when 'TAB' key is pressed. | |
| s2eras | Erase the geometry. | PGERAS |
Windows and Viewports
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2svp | Set up the part of 3D space that is used for plotting. | PGSVP |
| s2qvp | Query the device viewport range. | PGQVP |
| s2swin | Set up the world coordinate range for the device. | PGSWIN |
| s2qwin | Query the world coordinate range. | PGQWIN |
| s2env | Convenience function which sets the plotting environment. | PGENV |
Primitives
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2line | Draw a poly line, n vertices at (xpts, ypts, zpts). | PGLINE |
| s2circxy | Draw a circle in the xy plane at a given z coordinate. | PGCIRC |
| s2circxz | Draw a circle in the xz plane at a given y coordinate. | PGCIRC |
| s2circyz | Draw a circle in the yz plane at a given x coordinate. | PGCIRC |
| s2diskxy | Draw a disk in the xy plane at a given z coordinate. | |
| s2diskxz | Draw a disk in the xz plane at a given y coordinate. | |
| s2diskyz | Draw a disk in the yz plane at a given x coordinate. | |
| s2rectxy | Draw a rectangle in the xy plane at a given z coordinate. | PGRECT |
| s2rectxz | Draw a rectangle in the xz plane at a given y coordinate. | PGRECT |
| s2rectyz | Draw a rectangle in the yz plane at a given x coordinate. | PGRECT |
| s2pt1 | Draw a single point with a given symbol. | PGPT1 |
| s2pt | Draw a set of points with a given symbol. | PGPT |
| s2pnts | Draw a set of points with different markers. | PGPNTS |
| s2textxy | Draw text in the xy plane at a fixed z coordinate. | PGTEXT |
| s2textxz | Draw text in the xz plane at a fixed y coordinate. | PGTEXT |
| s2textyz | Draw text in the yz plane at a fixed x coordinate. | PGTEXT |
| s2textxyf | Draw flipped text in the xy plane at a fixed z coordinate. | PGTEXT |
| s2textxzf | Draw flipped text in the xz plane at a fixed y coordinate. | PGTEXT |
| s2textyzf | Draw flipped text in the yz plane at a fixed x coordinate. | PGTEXT |
| s2qtxtxy | Find the bounding box of text drawn with s2textxy. | PGQTXT |
| s2qtxtxz | Find the bounding box of text drawn with s2textxz. | PGQTXT |
| s2qtxtyz | Find the bounding box of text drawn with s2textyz. | PGQTXT |
| s2qtxtxyf | Find the bounding box of text drawn with s2textxyf. | PGQTXT |
| s2qtxtxzf | Find the bounding box of text drawn with s2textxzf. | PGQTXT |
| s2qtxtyzf | Find the bounding box of text drawn with s2textyzf. | PGQTXT |
| s2arro | Draw an arrow from the point with world-coordinates (x1,y1,z1) to (x2,y2,z2). | PGARRO |
Attributes
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2sci | Set the pen colour by index. | PGSCI |
| s2scr | Set colour representation, ie. define a colour associated with an index. | PGSCR |
| s2qcr | Query colour representation. | PGQCR |
| s2slw | Set the linewidth in pixels. | PGSLW |
| s2sch | Set the character height in "arbitrary" units. | PGSCH |
| s2sah | Set the style to be used for arrowheads drawn with s2arro. | PGSAH |
Axes, Boxes & Labels
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2box | Draw a labelled box around the world space. | PGBOX |
| s2lab | Draw labels along the edges of bounding box. | PGLAB |
XY(Z) Plots
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2errb | Draw error bars at the coordinates (xpts[i], ypts[i], zpts[i]). | PGERRB |
| s2funt | Draw a curve defined by parametric equations fx(t), fy(t) and fz(t). | PGFUNT |
| s2funtc | Draw a curve defined by parametric equations fx(t), fy(t) and fz(t) with colour control. | PGFUNT |
| s2funxy | Draw the surface described by the provided function fxy. | PGFUNX |
| s2funxz | Draw the surface described by the provided function fxz. | PGFUNY |
| s2funyz | Draw the surface described by the provided function fyz. | PGFUNX |
| s2funxyr | Draw surface as per s2funxy, but with explicit settings for the colour range mapping. | |
| s2funxzr | Draw surface as per s2funxz, but with explicit settings for the colour range mapping. | |
| s2funyzr | Draw surface as per s2funyz, but with explicit settings for the colour range mapping. | |
| s2funuv | Plot a parametric function (generally a surface) defined by functions fx(u,v), fy(u,v) and fz(u,v). |
Images/Surfaces
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2surp | Draw a colour surface representation of the 2-dimensional array, data, containing nx * ny values. | PGIMAG |
| s2surpa | Draw a colour surface representation of the 2-dimensional array, data, containing nx * ny values. | PGIMAG |
| s2scir | Set the range of colour indices used for shading. | PGSCIR |
| s2qcir | Query the colour index range. | PGQCIR |
| s2icm | Install various colour maps. | PGSITF |
| s2wedge | Draw a colour wedge. | PGWEDG |
Vector Plots
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2vect3 | Draw a vector map of a 3D data array, with blanking. | PGVECT |
Miscellaneous Routines
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2iden | Write username, date, time and optional string at bottom of plot. | PGIDEN |
S2 "Native" Routines
| S2PLOT | Description | PGPLOT |
|---|---|---|
| ns2sphere | Draw a sphere, with a given centre, radius and colour. | |
| ns2vsphere | Draw a sphere, with a given centre, radius and colour - vecotr input. | |
| ns2spheret | Draw a textured sphere, with given centre, radius, colour and texture filename. | |
| ns2vspheret | Draw a textured sphere, with given centre, radius, colour and texture filename - vector input. | |
| ns2disk | Draw an annulus with given centre, inner and out radii, and colour. | |
| ns2vdisk | Draw an annulus with given centre, inner and out radii, and colour - vector input. | |
| ns2arc | Draw an arc at (px,py,pz) with normal (nx,ny,nz) in current pen (thickness,colour). | |
| ns2varc | Draw an arc at (px,py,pz) with normal (nx,ny,nz) in current pen (thickness,colour) - vector input. | |
| ns2text | Draw text at a given position, with right and up vectors, a specific colour, and a text string of course. | |
| ns2vtext | Draw text at a given position, with right and up vectors, a specific colour, and a text string of course - vector input. | |
| ns2point | Draw a point at the given position and colour. | |
| ns2vpoint | Draw a point at the given position and colour - vector input. | |
| ns2vnpoint | Draw multiple points at the given positions with one colour - vector input. | |
| ns2thpoint | Draw a thick point at given position, in colour and thickness in pixels (not world coords). | |
| ns2vthpoint | Draw a thick point at given position, in colour and thickness in pixels (not world coords) - vector input. | |
| ns2i | Illumination. | |
| ns2vi | Illumination - vector input. | |
| ns2line | Draw a line from one point to another in a specific colour. | |
| ns2vline | Draw a line from one point to another in a specific colour - vector input. | |
| ns2thline | Draw a thick line from one point to another in a specific colour. | |
| ns2vthline | Draw a thick line from one point to another in a specific colour - vector input. | |
| ns2cline | Draw a coloured line, with colour blended between the two given colours along the line. | |
| ns2vcline | Draw a coloured line, with colour blended between the two given colours along the line - vector input. | |
| ns2vf3 | 3-vertex facet with single colour and automatic normals. | |
| ns2vf3n | 3-vertex facet with single colour and normals given. | |
| ns2vf3c | 3-vertex facet with coloured vertices and autmoatic normals. | |
| ns2vf3nc | 3-vertex facet with coloured vertices and normals given. | |
| ns2vf4 | 4-vertex facet with single colour and automatic normals. | |
| ns2vf4n | 4-vertex facet with single colour and normals given. | |
| ns2vf4c | 4-vertex facet with coloured vertices and automatic normals. | |
| ns2vf4nc | 4-vertex facet with coloured vertices and normals given. | |
| ns2vf4t | Textured 4-vertex facet, scale in [0,1]; trans = 'o' or 't'. | |
| ns2vf4x | Draw a textured 4-vertex facet using a texture id. | |
| ns2vf4xt | Draw a textured 4-vertex facet with alpha channel using a texture id. | |
| ns2m | Draw a marker | |
| ns2vm | Draw a marker - vector input |
Callback and Handle System
| S2PLOT | Description | PGPLOT |
|---|---|---|
| cs2scb | Set the callback function; can be null to cancel callback. | |
| cs2ecb | Animation state - Enable callback. | |
| cs2dcb | Animation state - Disable callback. | |
| cs2tcb | Animation state - Toggle callback. | |
| cs2sncb | Set the function to call when number-keys pressed. | |
| cs2socb | Register function that will draw direct OpenGL graphics when called. | |
| cs2ah | Add a handle to allow interactive picking of objects | |
| cs2shcb | Set the handle callback function for when a handle is (de)selected | |
| cs2th | Toggle the state of a named (dynamic) handle | |
| cs2qhv | Query whether selection handles are currently visible |
Advanced Texture and Colormap Handling
| S2PLOT | Description | PGPLOT |
|---|---|---|
| ss2lt | Load a texture for future (generally repeated) use. | |
| ss2gt | Get a pointer to an identified texture. | |
| ss2pt | Reinstall a texture. | |
| ss2lcm | Load a colourmap into memory. | |
| ns2spherex | Draw a textured sphere, with given centre, radius, colour and texture ID. | |
| ns2vspherex | Draw a textured sphere, with given centre, radius, colour and texture ID - vector input. |
Environment and Rendering Attributes
| S2PLOT | Description | PGPLOT |
|---|---|---|
| ss2ssr | Set sphere resolution. | |
| ss2srm | Set the rendering mode. | |
| ss2qrm | Get the rendering mode. | |
| ss2sl | Set the entire lighting environment | |
| ss2sbc | Set the background colour. | |
| ss2sfra | Set the fisheye rotation angle (degrees). | |
| ss2qpt | Fetch the projection type of the device in use. |
Advanced Camera Control
| S2PLOT | Description | PGPLOT |
|---|---|---|
| ss2sc | Set the camera position, up vector and view direction. | |
| ss2qc | Query the camera position, up vector and view direction. | |
| ss2sas | Start/Stop the camera rotation. | |
| ss2scf | Set the camera mid/focus point. | |
| ss2ucf | Unset the camera mid/focus point - revert to auto mid-point. | |
| ss2tc | Enable/disable (1,0) camera translation. | |
| ss2sss | Set the spin / interaction speed | |
| ss2qss | Get the spin / interaction speed | |
| ss2qess | Get the eye separation multiplier | |
| ss2sess | Set the eye separation multiplier |
Additional Primitives
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2chromapts | Plot points on a sphere using chromastereoscopic colouring for depth | |
| s2chromacpts | Plot cartesian points using chromastereoscopic colouring for depth |
Functions in Testing/Development
| S2PLOT | Description | PGPLOT |
|---|---|---|
| s2latexture | Create a texture with LATEX commands. | |
| ns2vf3a | 3-vertex facet with transparency | |
| ns2cis | Create an isosurface object | |
| ns2cisc | Create an isosurface object with a colour function | |
| ns2dis | Draw an isosurface object | |
| ns2sisl | Change the level of isosurface | |
| ns2cvr | Create a volume rendering object | |
| cs2thv | Toggle the current state of selection handles | |
| ss2ct | Create a texture with specified width and height | |
| ss2dt | Delete a texture | |
| ss2txh | Enable/disable/toggle the visibility of the cursor cross-hair | |
| ss2qxh | Query the visibility of the cursor cross-hair |
Dynamic-Only Geometry Functions
| S2PLOT | Description | PGPLOT |
|---|---|---|
| ds2bb | Draw a (dynamic) billboard: a textured facet that always faces the camera | |
| ds2vbb | Draw a (dynamic) billboard: a textured facet that always faces the camera - vector input | |
| ds2tb | Draw text that always faces the camera | |
| ds2vtb | Draw text that always faces the camera - vector input | |
| ds2dvr | Draw a volume render object from a dynamic callback |
Deprecated Function Names (V1.48-V1.62)
For function names from earlier releases of S2PLOT that have been deprecated, see here.
