Revision as of 04:07, 26 October 2007 S2plot admin (Talk | contribs) ← Previous diff |
Current revision S2plot admin (Talk | contribs)
|
Line 1: |
Line 1: |
| __FORCETOC__ | | __FORCETOC__ |
- | ==General== | + | |
| + | ==General == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:Colours | Colours]]</td><td>Useful colour definitions based on PGPlot default settings.</td><td> </td></tr> | + | <tr><td>[[Function:Colours | Colours]]</td><td>Useful colour definitions based on PGPlot default settings. </td><td> </td></tr> |
- | <tr><td>[[function:Textures | Textures]]</td><td>Important information on using textures in S2PLOT. </td><td> </td></tr> | + | <tr><td>[[Function:Textures | Textures]]</td><td>Important information on using textures in S2PLOT. </td><td> </td></tr> |
- | <tr><td>[[function:struct XYZ | struct XYZ]]</td><td>Data structure for (x,y,z) coordinates. </td><td> </td></tr> | + | <tr><td>[[Function:struct_XYZ | struct XYZ]]</td><td>Data structure for (x,y,z) coordinates. </td><td> </td></tr> |
- | <tr><td>[[function:struct COLOUR | struct COLOUR]]</td><td>Data structure for (r,g,b) colour indices.</td><td> </td></tr> | + | <tr><td>[[Function:struct_COLOUR | struct COLOUR]]</td><td>Data structure for (r,g,b) colour indices. </td><td> </td></tr> |
| </table> | | </table> |
- | | |
| | | |
| ==Opening, Closing and Selecting Devices == | | ==Opening, Closing and Selecting Devices == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <th width=15%>S2PLOT<th><th width=*>Description<th><th width=15%>PGPLOT<th><tr> | + | <tr><td>[[Function:s2open | s2open]]</td><td>Open the S2PLOT device. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN]</td></tr> |
- | <tr><Tr><td>[[Function:reference.php?s=1&e=s2open | s2open]<td><td>Open the S2PLOT device. <td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN]<td><tr> | + | <tr><td>[[Function:s2opend | s2opend]]</td><td>Open the S2PLOT device (device string version). </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN]</td></tr> |
- | <Tr><td>[[Function:reference.php?s=1&e=s2opend | s2opend]<td><td>Open the S2PLOT device (device string version). <td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN]<td><tr> | + | <tr><td>[[Function:s2opendo | s2opendo]]</td><td>Open the S2PLOT device (device string version, ignoring command line arguments). </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN]</td></tr> |
- | <Tr><td>[[Function:reference.php?s=1&e=s2opendo | s2opendo]<td><td>Open the S2PLOT device (device string version, ignoring command line arguments). <td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN]<td><tr> | + | <tr><td>[[Function:s2ldev | s2ldev]]</td><td>List the available S2PLOT devices on stdout. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGLDEV PGLDEV]</td></tr> |
- | <Tr><td>[[Function:reference.php?s=1&e=s2ldev | s2ldev]<td><td>List the available S2PLOT devices on stdout. <td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGLDEV PGLDEV]<td><tr> | + | <tr><td>[[Function:s2show | s2show]]</td><td>Draw the scene and enter interactive mode if interactive is non-zero. </td><td> </td></tr> |
- | <Tr><td>[[Function:reference.php?s=1&e=s2show | s2show]<td><td>Draw the scene and enter interactive mode if interactive is non-zero. <td><td> <td><tr> | + | <tr><td>[[Function:s2disp | s2disp]]</td><td>Draw the scene, but return control when a timeout occurs or when shift-ENTER is pressed. </td><td> </td></tr> |
- | <Tr><td>[[Function:reference.php?s=1&e=s2disp | s2disp]<td><td>Draw the scene, but return control when a timeout occurs or when 'TAB' key is pressed. <td><td> <td><tr> | + | <tr><td>[[Function:s2eras | s2eras]]</td><td>Erase the geometry. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGERAS PGERAS]</td></tr> |
- | <Tr><td>[[Function:reference.php?s=1&e=s2eras | s2eras]<td><td>Erase the geometry. <td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGERAS PGERAS]<td><tr> | + | </table> |
- | <table> | + | |
| | | |
- | ==Opening, Closing and Selecting Devices== | + | ==Windows and Viewports == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2open | s2open]]</td><td> Open the S2PLOT device. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN]</td></tr> | + | <tr><td>[[Function:s2svp | s2svp]]</td><td>Set up the part of 3D space that is used for plotting. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSVP PGSVP]</td></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td>Open the S2PLOT device (device string version).</td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN] </td></tr> | + | <tr><td>[[Function:s2qvp | s2qvp]]</td><td>Query the device viewport range. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQVP PGQVP]</td></tr> |
- | <tr><td>[[function:s2opendo | s2opendo]]</td><td>Open the S2PLOT device (device string version, ignoring command line arguments). </td><td> [http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGOPEN PGOPEN]</td></tr> | + | <tr><td>[[Function:s2swin | s2swin]]</td><td>Set up the world coordinate range for the device. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSWIN PGSWIN]</td></tr> |
- | <tr><td>[[function:s2ldev | s2ldev]]</td><td>List the available S2PLOT devices on stdout.</td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGLDEV PGLDEV] </td></tr> | + | <tr><td>[[Function:s2qwin | s2qwin]]</td><td>Query the world coordinate range. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQWIN PGQWIN]</td></tr> |
- | <tr><td>[[function:s2show | s2show]]</td><td>Draw the scene and enter interactive mode if interactive is non-zero.</td><td> </td></tr> | + | <tr><td>[[Function:s2env | s2env]]</td><td>Convenience function which sets the plotting environment. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGENV PGENV]</td></tr> |
- | <tr><td>[[function:s2disp | s2disp]]</td><td>Draw the scene, but return control when a timeout occurs or when 'TAB' key is pressed. </td><td> </td></tr> | + | |
- | <tr><td>[[function:s2eras | s2eras]]</td><td>Erase the geometry.</td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGERAS PGERAS]</td></tr> | + | |
| </table> | | </table> |
| | | |
- | ==Windows and Viewports== | + | ==Primitives == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2svp | s2svp]]</td><td> Set up the part of 3D space that is used for plotting. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSVP PGSVP]</td></tr> | + | <tr><td>[[Function:s2line | s2line]]</td><td>Draw a poly line, n vertices at (xpts, ypts, zpts). </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGLINE PGLINE]</td></tr> |
- | <tr><td>[[function:s2qvp | s2qvp]]</td><td>Query the device viewport range.</td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQVP PGQVP]</td></tr> | + | <tr><td>[[Function:s2circxy | s2circxy]]</td><td>Draw a circle in the xy plane at a given z coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGCIRC PGCIRC]</td></tr> |
- | <tr><td>[[function:s2swin | s2swin]]</td><td> Set up the world coordinate range for the device.</td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSWIN PGSWIN]</td></tr> | + | <tr><td>[[Function:s2circxz | s2circxz]]</td><td>Draw a circle in the xz plane at a given y coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGCIRC PGCIRC]</td></tr> |
- | <tr><td>[[function:s2qwin | s2qwin]]</td><td>Query the world coordinate range. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQWIN PGQWIN] </td></tr> | + | <tr><td>[[Function:s2circyz | s2circyz]]</td><td>Draw a circle in the yz plane at a given x coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGCIRC PGCIRC]</td></tr> |
- | <tr><td>[[function:s2env | s2env]]</td><td>Convenience function which sets the plotting environment. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGENV PGENV]</td></tr> | + | <tr><td>[[Function:s2diskxy | s2diskxy]]</td><td>Draw a disk in the xy plane at a given z coordinate. </td><td> </td></tr> |
| + | <tr><td>[[Function:s2diskxz | s2diskxz]]</td><td>Draw a disk in the xz plane at a given y coordinate. </td><td> </td></tr> |
| + | <tr><td>[[Function:s2diskyz | s2diskyz]]</td><td>Draw a disk in the yz plane at a given x coordinate. </td><td> </td></tr> |
| + | <tr><td>[[Function:s2rectxy | s2rectxy]]</td><td>Draw a rectangle in the xy plane at a given z coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGRECT PGRECT]</td></tr> |
| + | <tr><td>[[Function:s2rectxz | s2rectxz]]</td><td>Draw a rectangle in the xz plane at a given y coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGRECT PGRECT]</td></tr> |
| + | <tr><td>[[Function:s2rectyz | s2rectyz]]</td><td>Draw a rectangle in the yz plane at a given x coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGRECT PGRECT]</td></tr> |
| + | <tr><td>[[Function:s2wcube |s2wcube]]</td><td>Draw a wireframe cube.</td><td></td></tr> |
| + | <tr><td>[[Function:s2pt1 | s2pt1]]</td><td>Draw a single point with a given symbol. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGPT1 PGPT1]</td></tr> |
| + | <tr><td>[[Function:s2pt | s2pt]]</td><td>Draw a set of points with a given symbol. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGPT PGPT]</td></tr> |
| + | <tr><td>[[Function:s2pnts | s2pnts]]</td><td>Draw a set of points with different markers. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGPNTS PGPNTS]</td></tr> |
| + | <tr><td>[[Function:s2textxy | s2textxy]]</td><td>Draw text in the xy plane at a fixed z coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGTEXT PGTEXT]</td></tr> |
| + | <tr><td>[[Function:s2textxz | s2textxz]]</td><td>Draw text in the xz plane at a fixed y coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGTEXT PGTEXT]</td></tr> |
| + | <tr><td>[[Function:s2textyz | s2textyz]]</td><td>Draw text in the yz plane at a fixed x coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGTEXT PGTEXT]</td></tr> |
| + | <tr><td>[[Function:s2textxyf | s2textxyf]]</td><td>Draw flipped text in the xy plane at a fixed z coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGTEXT PGTEXT]</td></tr> |
| + | <tr><td>[[Function:s2textxzf | s2textxzf]]</td><td>Draw flipped text in the xz plane at a fixed y coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGTEXT PGTEXT]</td></tr> |
| + | <tr><td>[[Function:s2textyzf | s2textyzf]]</td><td>Draw flipped text in the yz plane at a fixed x coordinate. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGTEXT PGTEXT]</td></tr> |
| + | <tr><td>[[Function:s2qtxtxy | s2qtxtxy]]</td><td>Find the bounding box of text drawn with s2textxy. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQTXT PGQTXT]</td></tr> |
| + | <tr><td>[[Function:s2qtxtxz | s2qtxtxz]]</td><td>Find the bounding box of text drawn with s2textxz. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQTXT PGQTXT]</td></tr> |
| + | <tr><td>[[Function:s2qtxtyz | s2qtxtyz]]</td><td>Find the bounding box of text drawn with s2textyz. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQTXT PGQTXT]</td></tr> |
| + | <tr><td>[[Function:s2qtxtxyf | s2qtxtxyf]]</td><td>Find the bounding box of text drawn with s2textxyf. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQTXT PGQTXT]</td></tr> |
| + | <tr><td>[[Function:s2qtxtxzf | s2qtxtxzf]]</td><td>Find the bounding box of text drawn with s2textxzf. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQTXT PGQTXT]</td></tr> |
| + | <tr><td>[[Function:s2qtxtyzf | s2qtxtyzf]]</td><td>Find the bounding box of text drawn with s2textyzf. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQTXT PGQTXT]</td></tr> |
| + | <tr><td>[[Function:s2arro | s2arro]]</td><td>Draw an arrow from the point with world-coordinates (x1,y1,z1) to (x2,y2,z2). </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGARRO PGARRO]</td></tr> |
| </table> | | </table> |
| | | |
- | | + | ==Drawing Attributes == |
- | | + | |
- | ==Primitives== | + | |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:s2sci | s2sci]]</td><td>Set the pen colour by index. |
| + | </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSCI PGSCI]</td></tr> |
| + | <tr><td>[[Function:s2qci | s2qci]]</td><td>Query the colour index</td><td> </td></tr> |
| + | <tr><td>[[Function:s2scr | s2scr]]</td><td>Set colour representation, ie. define a colour associated with an index. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSCR PGSCR]</td></tr> |
| + | <tr><td>[[Function:s2qcr | s2qcr]]</td><td>Query colour representation. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQCR PGQCR]</td></tr> |
| + | <tr><td>[[Function:s2slw | s2slw]]</td><td>Set the linewidth in pixels. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSLW PGSLW]</td></tr> |
| + | <tr><td>[[Function:s2qlw | s2qlw]]</td><td>Query the line width</td><td> </td></tr> |
| + | <tr><td>[[Function:s2sls | s2sls]]</td><td>Set the line style.</td/><td></td></tr> |
| + | <tr><td>[[Function:s2qls | s2qls]]</td><td>Query the line style.</td/><td></td></tr> |
| + | <tr><td>[[Function:s2sch | s2sch]]</td><td>Set the character height in "arbitrary" units. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSCH PGSCH]</td></tr> |
| + | <tr><td>[[Function:s2qch | s2qch]]</td><td>Query the character height</td><td> </td></tr> |
| + | <tr><td>[[Function:s2sah | s2sah]]</td><td>Set the style to be used for arrowheads drawn with s2arro. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSAH PGSAH]</td></tr> |
| + | <tr><td>[[Function:s2qah | s2qah]]</td><td>Query the arrow-head style</td><td> </td></tr> |
| + | <tr><td>[[Function:s2twc | s2twc]]</td><td>Set the window clipping mode</td><td> </td></tr> |
| + | <tr><td>[[Function:s2qwc| s2qwc]]</td><td>Query the window clipping mode</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2txh | ss2txh]]</td><td>Enable/disable/toggle the visibility of the cursor cross-hair </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qxh | ss2qxh]]</td><td>Query the visibility of the cursor cross-hair </td><td></td></tr> |
| + | <tr><td>[[Function:ss2tsc | ss2tsc]]</td><td>Enable/disable 2-d screen coordinates</td><td> </td></tr> |
| </table> | | </table> |
| | | |
- | ==Attributes== | + | ==Axes, Boxes & Labels == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:s2box | s2box]]</td><td>Draw a labelled box around the world space. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGBOX PGBOX]</td></tr> |
| + | <tr><td>[[Function:s2lab | s2lab]]</td><td>Draw labels along the edges of bounding box. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGLAB PGLAB]</td></tr> |
| + | <tr><td>[[Function:s2help | s2help]]</td><td>Set the custom help string.</td/><td></td></tr> |
| </table> | | </table> |
| | | |
- | ==Axes, Boxes & Labels== | + | ==XY(Z) Plots == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:s2errb | s2errb]]</td><td>Draw error bars at the coordinates (xpts[i], ypts[i], zpts[i]). </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGERRB PGERRB]</td></tr> |
| + | <tr><td>[[Function:s2funt | s2funt]]</td><td>Draw a curve defined by parametric equations fx(t), fy(t) and fz(t). </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGFUNT PGFUNT]</td></tr> |
| + | <tr><td>[[Function:s2funtc | s2funtc]]</td><td>Draw a curve defined by parametric equations fx(t), fy(t) and fz(t) with colour control. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGFUNT PGFUNT]</td></tr> |
| + | <tr><td>[[Function:s2funxy | s2funxy]]</td><td>Draw the surface described by the provided function fxy. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGFUNX PGFUNX]</td></tr> |
| + | <tr><td>[[Function:s2funxz | s2funxz]]</td><td>Draw the surface described by the provided function fxz. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGFUNY PGFUNY]</td></tr> |
| + | <tr><td>[[Function:s2funyz | s2funyz]]</td><td>Draw the surface described by the provided function fyz. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGFUNX PGFUNX]</td></tr> |
| + | <tr><td>[[Function:s2funxyr | s2funxyr]]</td><td>Draw surface as per s2funxy, but with explicit settings for the colour range mapping. </td><td> </td></tr> |
| + | <tr><td>[[Function:s2funxzr | s2funxzr]]</td><td>Draw surface as per s2funxz, but with explicit settings for the colour range mapping. </td><td> </td></tr> |
| + | <tr><td>[[Function:s2funyzr | s2funyzr]]</td><td>Draw surface as per s2funyz, but with explicit settings for the colour range mapping. </td><td> </td></tr> |
| + | <tr><td>[[Function:s2funuv | s2funuv]]</td><td>Plot a parametric function (generally a surface) defined by functions fx(u,v), fy(u,v) and fz(u,v). </td><td> </td></tr> |
| + | <tr><td>[[Function:s2funuva | s2funuva]]</td><td>Plot a parametric function (generally a surface) defined by functions fx(u,v), fy(u,v) and fz(u,v) with transparency. </td><td> </td></tr> |
| </table> | | </table> |
| | | |
- | ==XY(Z) Plots== | + | ==Images/Surfaces == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:s2surp | s2surp]]</td><td>Draw a colour surface representation of the 2-dimensional array, data, containing nx * ny values. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGIMAG PGIMAG]</td></tr> |
| + | <tr><td>[[Function:s2surpa | s2surpa]]</td><td>Draw a colour surface representation of the 2-dimensional array, data, containing nx * ny values. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGIMAG PGIMAG]</td></tr> |
| + | <tr><td>[[Function:s2scir | s2scir]]</td><td>Set the range of colour indices used for shading. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSCIR PGSCIR]</td></tr> |
| + | <tr><td>[[Function:s2qcir | s2qcir]]</td><td>Query the colour index range. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGQCIR PGQCIR]</td></tr> |
| + | <tr><td>[[Function:s2icm | s2icm]]</td><td>Install various colour maps. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGSITF PGSITF]</td></tr> |
| </table> | | </table> |
| | | |
- | ==Images/Surfaces== | + | ==Isosurfaces == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:ns2cis | ns2cis]]</td><td>Create an isosurface object </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2cisc | ns2cisc]]</td><td>Create an isosurface object with a colour function </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2dis | ns2dis]]</td><td>Draw an isosurface object </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2sisl | ns2sisl]]</td><td>Change the level of isosurface </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2sisa | ns2sisa]]</td><td>Set the alpha channel for an isosurface</td><td> </td></tr> |
| + | <tr><td>[[Function:ns2sisc | ns2sisc]]</td><td>Set the colour for an isosurface</td><td> </td></tr> |
| + | <tr><td>[[Function:ns2ssq |ns2ssq ]]</td><td>Set general surface quality.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2qsq |ns2qsq ]]</td><td>Query general surface quality.</td/><td></td></tr> |
| </table> | | </table> |
| | | |
- | ==Vector Plots== | + | ==Volume Rendering == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:ns2cvr | ns2cvr]]</td><td>Create a volume rendering object </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2cvra | ns2cvra]]</td><td>Volume rendering with alpha function specified.</td/><td></td></tr> |
| + | <tr><td>[[Function:ds2dvr | ds2dvr]]</td><td>Draw a volume render object from a dynamic callback. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2svrl | ns2svrl]]</td><td>Change volume rendering data and alpha ranges </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2svas |ns2svas ]]</td><td>Set alpha scaling mode.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2qvas |ns2qvas ]]</td><td>Query alpha scaling mode.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2sevas |ns2sevas ]]</td><td>Explicitly set alpha scaling values.</td/><td></td></tr> |
| </table> | | </table> |
| | | |
- | ==Miscellaneous Routines== | + | ==Misecllaneous Plots == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:s2vect3 | s2vect3]]</td><td>Draw a vector map of a 3D data array, with blanking. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGVECT PGVECT]</td></tr> |
| + | <tr><td>[[Function:s2skypa | s2skypa]]</td><td>Draw a skyscraper plot with/without walls</td><td> </td></tr> |
| + | <tr><td>[[Function:s2impa | s2impa]]</td><td>Draw an impulse plot with/without trunks</td><td> </td></tr> |
| + | <tr><td>[[Function:s2chromapts | s2chromapts]]</td><td>Plot points on a sphere using chromastereoscopic colouring for depth </td><td> </td></tr> |
| + | <tr><td>[[Function:s2chromacpts | s2chromacpts]]</td><td>Plot cartesian points using chromastereoscopic colouring for depth </td><td> </td></tr> |
| </table> | | </table> |
| | | |
- | ==S2 "Native" Routines== | + | |
| + | |
| + | ==S2 "Native" Routines == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:ns2sphere | ns2sphere]]</td><td>Draw a sphere, with a given centre, radius and colour. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vsphere | ns2vsphere]]</td><td>Draw a sphere, with a given centre, radius and colour - vecotr input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2spheret | ns2spheret]]</td><td>Draw a textured sphere, with given centre, radius, colour and texture filename. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vspheret | ns2vspheret]]</td><td>Draw a textured sphere, with given centre, radius, colour and texture filename - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2spherex | ns2spherex]]</td><td>Draw a textured sphere, with given centre, radius, colour and texture ID. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vspherex | ns2vspherex]]</td><td>Draw a textured sphere, with given centre, radius, colour and texture ID - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vplanett |ns2vplanett ]]</td><td>Draw a planet with texture filename.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2vplanetx |ns2vplanetx ]]</td><td>Draw a planet with texture id.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2disk | ns2disk]]</td><td>Draw an annulus with given centre, inner and out radii, and colour. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vdisk | ns2vdisk]]</td><td>Draw an annulus with given centre, inner and out radii, and colour - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2arc | ns2arc]]</td><td>Draw an arc at (px,py,pz) with normal (nx,ny,nz) in current pen (thickness,colour). </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2varc | ns2varc]]</td><td>Draw an arc at (px,py,pz) with normal (nx,ny,nz) in current pen (thickness,colour) - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2erc |ns2erc ]]</td><td>Draw an arc.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2verc |ns2verc ]]</td><td>Draw an arc - vector input.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2text | ns2text]]</td><td>Draw text at a given position, with right and up vectors, a specific colour, and a text string of course. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vtext | ns2vtext]]</td><td>Draw text at a given position, with right and up vectors, a specific colour, and a text string of course - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2point | ns2point]]</td><td>Draw a point at the given position and colour. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vpoint | ns2vpoint]]</td><td>Draw a point at the given position and colour - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vnpoint | ns2vnpoint]]</td><td>Draw multiple points at the given positions with one colour - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2thpoint | ns2thpoint]]</td><td>Draw a thick point at given position, in colour and thickness in pixels (not world coords). </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vthpoint | ns2vthpoint]]</td><td>Draw a thick point at given position, in colour and thickness in pixels (not world coords) - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vpa | ns2vpa]]</td><td>Draw a thick transparent point. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2i | ns2i]]</td><td>Illumination. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vi | ns2vi]]</td><td>Illumination - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2line | ns2line]]</td><td>Draw a line from one point to another in a specific colour. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vline | ns2vline]]</td><td>Draw a line from one point to another in a specific colour - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2thline | ns2thline]]</td><td>Draw a thick line from one point to another in a specific colour. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vthline | ns2vthline]]</td><td>Draw a thick line from one point to another in a specific colour - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2thwcube |ns2thwcube ]]</td><td>Draw a wireframe cube.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2vthwcube |ns2vthwcube ]]</td><td>Draw a wireframe cube - vector input.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2cline | ns2cline]]</td><td>Draw a coloured line, with colour blended between the two given colours along the line. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vcline | ns2vcline]]</td><td>Draw a coloured line, with colour blended between the two given colours along the line - vector input. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2thcline |ns2thcline ]]</td><td>Draw a thick coloured line.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2vthcline |ns2vthcline ]]</td><td>Draw a thick coloured line - vector input.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2vf3 | ns2vf3]]</td><td>3-vertex facet with single colour and automatic normals. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf3a | ns2vf3a]]</td><td>3-vertex facet with transparency </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf3n | ns2vf3n]]</td><td>3-vertex facet with single colour and normals given. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf3c | ns2vf3c]]</td><td>3-vertex facet with coloured vertices and autmoatic normals. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf3nc | ns2vf3nc]]</td><td>3-vertex facet with coloured vertices and normals given. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf3na | ns2vf3na]]</td><td>Transparent 3-vertex facet with coloured vertices, normals and alpha given. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf3nca | ns2vf3nca]]</td><td>3-vertex facet with coloured vertices, normals and alpha per vertex given.</td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf4 | ns2vf4]]</td><td>4-vertex facet with single colour and automatic normals. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf4n | ns2vf4n]]</td><td>4-vertex facet with single colour and normals given. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf4c | ns2vf4c]]</td><td>4-vertex facet with coloured vertices and automatic normals. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf4nc | ns2vf4nc]]</td><td>4-vertex facet with coloured vertices and normals given. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf4t | ns2vf4t]]</td><td>Textured 4-vertex facet, scale in [0,1]; trans = 'o' or 't'. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf4x | ns2vf4x]]</td><td>Draw a textured 4-vertex facet using a texture id. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vf4xt | ns2vf4xt]]</td><td>Draw a textured 4-vertex facet with alpha channel using a texture id. </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2scube |ns2scube ]]</td><td>Draw a solid cube.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2vscube |ns2vscube ]]</td><td>Draw a solid cube - vector input.</td/><td></td></tr> |
| + | <tr><td>[[Function:ns2m | ns2m]]</td><td>Draw a marker </td><td> </td></tr> |
| + | <tr><td>[[Function:ns2vm | ns2vm]]</td><td>Draw a marker - vector input </td><td> </td></tr> |
| </table> | | </table> |
| | | |
- | ==Callback and Handle System== | + | ==Dynamic-Only Geometry Functions == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:ds2bb | ds2bb]]</td><td>Draw a (dynamic) billboard: a textured facet that always faces the camera </td><td> </td></tr> |
| + | <tr><td>[[Function:ds2vbb | ds2vbb]]</td><td>Draw a (dynamic) billboard: a textured facet that always faces the camera - vector input </td><td> </td></tr> |
| + | <tr><td>[[Function:ds2vbbr | ds2vbbr]]</td><td>Draw a (dynamic) billboard texture with specified rotation</td><td> </td></tr> |
| + | <tr><td>[[Function:ds2vbbp |ds2vbbp ]]</td><td>Draw a "billboard" with aspect ratio - vector input.</td/><td></td></tr> |
| + | <tr><td>[[Function:ds2vbbpr |ds2vbbpr ]]</td><td>Billboard with aspect ratio, offset in screen coords, and rotation of texture - vector input.</td/><td></td></tr> |
| + | <tr><td>[[Function:ds2tb | ds2tb]]</td><td>Draw text that always faces the camera </td><td> </td></tr> |
| + | <tr><td>[[Function:ds2vtb | ds2vtb]]</td><td>Draw text that always faces the camera - vector input </td><td> </td></tr> |
| + | <tr><td>[[Function:ds2protect | ds2protect]]</td><td>Protect dynamic geometry </td><td> </td></tr> |
| + | <tr><td>[[Function:ds2unprotect | ds2unprotect]]</td><td>Unprotect dynamic geometry </td><td> </td></tr> |
| + | <tr><td>[[Function:ds2isprotected | ds2isprotected]]</td><td>Query state of dynamic geometry protection</td><td> </td></tr> |
| </table> | | </table> |
| | | |
- | ==Advanced Texture and Colormap Handling== | + | ==Callback and Handle System == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:cs2scb | cs2scb]]</td><td>Set the callback function; can be null to cancel callback. </td><td> </td></tr> |
| + | <tr><td>[[Function:cs2scbx | cs2scbx]]</td><td>Set dynamic callback with initialisation data</td><td> </td></tr> |
| + | <tr><td>[[Function:cs2ecb | cs2ecb]]</td><td>Animation state - Enable callback. </td><td> </td></tr> |
| + | <tr><td>[[Function:cs2dcb | cs2dcb]]</td><td>Animation state - Disable callback. </td><td> </td></tr> |
| + | <tr><td>[[Function:cs2tcb | cs2tcb]]</td><td>Animation state - Toggle callback. </td><td> </td></tr> |
| + | <tr><td>[[Function:cs2sncb | cs2sncb]]</td><td>Set the function to call when number-keys pressed. </td><td> </td></tr> |
| + | <tr><td>[[Function:cs2socb | cs2socb]]</td><td>Register function that will draw direct OpenGL graphics when called. </td><td> </td></tr> |
| + | <tr><td>[[Function:cs2srcb |cs2srcb ]]</td><td>Register when remote control data is received.</td/><td></td></tr> |
| + | <tr><td>[[Function:cs2shcb | cs2shcb]]</td><td>Set the handle callback function for when a handle is (de)selected </td><td> </td></tr> |
| + | <tr><td>[[Function:cs2sdhcb | cs2sdhcb]]</td><td>Set the handle dragging callback</td><td> </td></tr> |
| + | <tr><td>[[Function:cs2skcb | cs2skcb]]</td><td>Set the keyboard callback</td><td> </td></tr> |
| + | <tr><td>[[Function:cs2spcb | cs2spcb]]</td><td>Set the user prompt callback</td><td> </td></tr> |
| + | <tr><td>[[Function:cs2sptxy |cs2sptxy ]]</td><td>Set the text and position of a prompt.</td/><td></td></tr> |
| + | <tr><td>[[Function:ds2ah | ds2ah]]</td><td>Add a handle to allow interactive picking of objects </td><td> </td></tr> |
| + | <tr><td>[[Function:ds2ahx | ds2ahx]]</td><td>Add a handle with a specified texture</td><td> </td></tr> |
| + | <tr><td>[[Function:cs2th | cs2th]]</td><td>Toggle the state of a named (dynamic) handle </td><td> </td></tr> |
| + | <tr><td>[[Function:cs2thv | cs2thv]]</td><td>Toggle the current state of selection handles </td><td> |
| + | <tr><td>[[Function:cs2qhv | cs2qhv]]</td><td>Query whether selection handles are currently visible </td><td> </td></tr></td></tr> |
| </table> | | </table> |
| | | |
- | ==Environment and Rendering Attributes== | + | ==Panels == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:xs2ap | xs2ap]]</td><td>Add a new panel</td><td> </td></tr> |
| + | <tr><td>[[Function:xs2cp | xs2cp]]</td><td>Select a panel for subsequent geometry calls</td><td> </td></tr> |
| + | <tr><td>[[Function:xs2mp | xs2mp]]</td><td>Modify location of existing panel</td><td> </td></tr> |
| + | <tr><td>[[Function:xs2tp | xs2tp]]</td><td>Toggle visibility of panel</td><td> </td></tr> |
| + | <tr><td>[[Function:xs2lpc | xs2lpc]]</td><td>Link panel cameras together</td><td> </td></tr> |
| + | <tr><td>[[Function:xs2qcpa | xs2qcpa]]</td><td>Query status of currently selected panel</td><td> </td></tr> |
| + | <tr><td>[[Function:xs2qpa | xs2qpa]]</td><td>Query whether identified panel is active</td><td> </td></tr> |
| + | <tr><td>[[Function:xs2qsp | xs2qsp]]</td><td>Query currently selected panel</td><td> </td></tr> |
| + | <tr><td>[[Function:xs2spp | xs2spp]]</td><td>Set panel frame properties.</td/><td></td></tr> |
| + | <tr><td>[[Function:ss2qsd | ss2qsd]]</td><td>Query screen panel dimensions</td><td> </td></tr> |
| </table> | | </table> |
| | | |
- | ==Advanced Camera Control== | + | ==Advanced Texture and Colormap Handling == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:ss2lt | ss2lt]]</td><td>Load a texture for future (generally repeated) use. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2gt | ss2gt]]</td><td>Get a pointer to an identified texture. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2ct | ss2ct]]</td><td>Create a texture with specified width and height</td><td></td></tr> |
| + | <tr><td>[[Function:ss2pt | ss2pt]]</td><td>Reinstall a texture. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2ctt | ss2ctt]]</td><td>Create a transient texture map</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2ptt | ss2ptt]]</td><td>Reinstall a transient texture map</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2dt | ss2dt]]</td><td>Delete a texture </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2lcm | ss2lcm]]</td><td>Load a colourmap into memory. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2ltt | ss2ltt]]</td><td>Create a texture with LATEX commands. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2ftt | ss2ftt]] </td><td>Use a named freetype font to create a texture map.</td><td></td></tr> |
| + | <tr><td>[[Function:ns2texpoly3d | ns2texpoly3d]] </td><td>Draw a 3d texture.</td><td></td></tr> |
| + | <tr><td>[[Function:ss2c3dt | ss2c3dt]] </td><td>Create an empty 3d texture.</td><td></td></tr> |
| + | <tr><td>[[Function:ss2g3dt | ss2g3dt]] </td><td>Fetch pointer to 3d texture.</td><td></td></tr> |
| </table> | | </table> |
| | | |
- | ==Additional Primitives== | + | ==Environment and Rendering Attributes == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:ss2ssr | ss2ssr]]</td><td>Set sphere resolution. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qsr | ss2qsr]]</td><td>Query the sphere resolution</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2srm | ss2srm]]</td><td>Set the rendering mode. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qrm | ss2qrm]]</td><td>Get the rendering mode. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2sl | ss2sl]]</td><td>Set the entire lighting environment </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2sfc | ss2sfc]]</td><td>Set the foreground colour</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qfc | ss2qfc]]</td><td>Query the foreground colour</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2sbc | ss2sbc]]</td><td>Set the background colour. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qbc | ss2qbc]]</td><td>Query the background colour</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2sfra | ss2sfra]]</td><td>Set the fisheye rotation angle (degrees). </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qfra | ss2qfra]]</td><td>Query fisheye rotation angle</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2spt | ss2spt]]</td><td>Set the projection type of the device in use</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qpt | ss2qpt]]</td><td>Fetch the projection type of the device in use. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qsa | ss2qsa]]</td><td>Query the screen type and settings</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qar | ss2qar]]</td><td>Query the aspect ratio</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2snfe | ss2snfe]]</td><td>Set the clipping plane expansion factor</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qnfp | ss2qnfp]]</td><td>Query the near and far clip plane distances</td><td> </td></tr> |
| </table> | | </table> |
| | | |
- | ==Functions in Testing/Development== | + | ==Advanced Camera Control == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:ss2sc | ss2sc]]</td><td>Set the camera position, up vector and view direction. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qc | ss2qc]]</td><td>Query the camera position, up vector and view direction. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2scaf | ss2scaf]]</td><td>Set the camera position, up vector, view direction and rotate point. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2sas | ss2sas]]</td><td>Start/Stop the camera rotation. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qas | ss2qas]]</td><td>Query the autospin state</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2scf | ss2scf]]</td><td>Set the camera mid/focus point. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qcf | ss2qcf]]</td><td>Query camera focus point and state</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2qpr | ss2qpr]]</td><td>Query point to rotate camera about. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2ucf | ss2ucf]]</td><td>Unset the camera mid/focus point - revert to auto mid-point. </td><td> </td></tr> |
| + | <tr><td>[[Function:ss2sca |ss2sca ]]</td><td>Set the camera aperture.</td/><td></td></tr> |
| + | <tr><td>[[Function:ss2qca |ss2qca ]]</td><td>Query the camera aperture.</td/><td></td></tr> |
| + | <tr><td>[[Function:ss2tc | ss2tc]]</td><td>Enable/disable (1,0) camera translation. </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:ss2scs |ss2scs ]]</td><td>Set the camera speed.</td/><td></td></tr> |
| + | <tr><td>[[Function:ss2qcs |ss2qcs ]]</td><td>Query the camera 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> |
| | | |
- | ==Dynamic-Only Geometry Functions== | + | ==Image Writing/Fetching == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:ss2wtga | ss2wtga]]</td><td>Write the current frame image to a TGA file</td><td> </td></tr> |
| + | <tr><td>[[Function:ss2gpix | ss2gpix]]</td><td>Fetch the current RGB buffer</td><td> </td></tr> |
| </table> | | </table> |
| | | |
- | ==Deprecated Function Names (V1.48-V1.62)== | + | ==Miscellaneous Routines == |
| <table border=1 width=100%> | | <table border=1 width=100%> |
- | <tr><th width=20%>S2PLOT</th><th>Description</th><th width=20%>PGPLOT</th></tr> | + | <tr><th width=15%>S2PLOT</th><th width=*>Description</th><th width=15%>PGPLOT</th></tr> |
- | <tr><td>[[function:s2opend | s2opend]]</td><td> </td><td> </td></tr> | + | <tr><td>[[Function:s2iden | s2iden]]</td><td>Write username, date, time and optional string at bottom of plot. </td><td>[http://www.astro.caltech.edu/~tjp/pgplot/subroutines.html#PGIDEN PGIDEN]</td></tr> |
| + | <tr><td>[[Function:pushVRMLname | pushVRMLname]] </td><td>Push the given name onto the VRML name stack.</td><td></td></tr> |
| </table> | | </table> |
| + | |
| + | ==Deprecated Function Names (V1.48-V1.62) == |
| + | |
| + | For function names from earlier releases of S2PLOT that have been deprecated, see [[Functions:Deprecated | here]]. |
For function names from earlier releases of S2PLOT that have been deprecated, see here.