S2PLOT:3dPDF

From S2PLOT

(Difference between revisions)

Revision as of 00:30, 13 October 2008

1 3d-PDF: Embedding S2PLOT Content in PDF Documents

3d-PDF: Embedding S2PLOT Content in PDF Documents

Since version 2.02, S2PLOT has been able to write the displayed geometry to a VRML 97 format file. This format was selected as it can be read in by Adobe Acrobat 3D and embedded in Portable Document Format (PDF) files. Modern versions of Adobe Reader can then render the 3-d model interactively, allowing the reader to view the 3-d scene from any angle or distance. Individual parts of the model can be turned on and off by explicit user control (eg. toggling the display of axis labels) or by implicit programmatic control (eg. toggling the selected set of slices for display as a volume rendering).

The 3-d PDF capabilities of S2PLOT are documented in the following papers. If you embed S2PLOT content in a formally published article, please cite at least one of these sources:

Fluke, C.J., Barnes, D.G., 2008, The Interactive Astronomy Textbook, Astronomy Education Review, 7(1). For interactive figures, please download paper from here. (AER).
Barnes, D.G., Fluke, C.J., 2008, Incorporating interactive 3-dimensional graphics in astronomy research papers, New Astronomy, 13, 599. For interactive figures, please download paper from here. (ADS) - arXiv:0709.2734.

Requirements

S2PLOT version 2.02 or higher
- version 2.4 or higher recommended
- S2PLOT is freely available for non-commercial and educational use
Adobe Acrobat 3D version 8.1.2
- Adobe Acrobat Pro 9 Extended expected to work but not yet tested and interface may be different to that described below
- Acrobat 3D and Acrobat Pro 9 Extended are commercial software but frequently are available at special academic and education prices

VRML export from S2PLOT

Most S2PLOT geometry can be written to VRML format. While running an S2PLOT program, simply press Shift-W and a file called "test.wrl" will be written. It will overwrite any pre-existing "test.wrl" file in the current working directory.

When writing an S2PLOT program whose output may be captured to VRML, keep the following points in mind:

screen-coordinate geometry is not saved to VRML
line thickness is not properly supported in VRML
textured spheres are not presently written to VRML (next version of S2PLOT)
transparent dots are not presently written to VRML (next version of S2PLOT)
disks are not presently written to VRML (next version of S2PLOT)
both static and dynamic S2PLOT geometry is saved to the VRML file
you can organise parts of your geometry into named sections of the VRML file (model tree) by using the S2PLOT function pushVRMLname
correct volume rendering requires special attention (see below)
frame animation is possible (see below)
billboards can be used but require special attention (see below)
handles are written and can be used for particular types of interaction (see below)
Acrobat Reader generally struggles with more than say 5000 pieces of geometry (whether points, lines or facets)
you can programmatically export the VRML file by declaring the function "void writeVRML20(void)" and calling it from a dynamic S2PLOT callback function

VRML import to Acrobat 3D

You can either create a new document in Acrobat 3D based on a VRML file, or you can embed a 3-d figure in an existing document.

To create a new document, simply select "Create PDF: From File ..." from the "File" menu or the main toolbar. "Control-N" should also accomplish the same result. Choose your VRML file ("test.wrl" unless you have renamed it) and then press "Open". Continue below.
To embed a 3-d figure in an existing document, select "Open ..." from the "File" menu ("Control-O" is the usual shortcut). Select the PDF file into which you will embed the figure, and press "Open". From the "Tools" menu go to "Advanced Editing" and choose "3D Tool". Drag out the area on the document where you wish to place the 3-d figure. In the resulting "Add 3D Content" window, click on the "Browse" button next to the "3D Model" field, and choose your VRML file and press "Open", then click "OK"

You should now see the "Acrobat 3D Conversion" dialog on-screen. This dialog is slightly different depending on which path you took above, however at this point, many of the defaults will suffice. Just make sure that the "3D Format in PDF" setting in the "Import" tab is "PRC Tessellation (Faceted)", and click "OK".

Import of the 3-d VRML model will now proceed, and can take from seconds to minutes depending on the complexity of the scene. On completion, click the "Hand" icon on the toolbar, click on the figure, and you will enter "3D mode". In this mode by default you can:

drag with the left button to modify the viewing angle
scroll the mouse wheel to zoom in and out
drag up and down with the right button (or shift-left button) to zoom in and out
drag with control-left button to "strafe" the camera
drag with control-right button to select a rectangular zoom area

The 3D toolbar (usually showing above the figure) provides control of:

lighting
perspective versus orthographic rendering
background colour
rendering mode (wireframe, shaded, et cetera)
the model tree

At this stage, you might like to save your existing or new PDF file, and view it in Acrobat Reader. You might be happy with this result already, however some tips now follow on improving the visual appearance and viewing options.

View and Display Options

Global viewing options are set in the Acrobat Reader software by the end-user, and typically at a minimum the following settings are recommended:

enable double-sided rendering
disable 3D selection for the Hand tool
enable Acrobat JavaScript

Figure-specific options can be set and controlled in the Acrobat 3D application itself, and the ability of an end-user to access to modify these options in the Reader can be limited if required. Most options are accessed by selecting the "3D Tool" and double-clicking on the 3-d figure.

Background colour, lighting and rendering mode

Managing views

A set of default views can be added to the figure in

Enabling standard S2PLOT interaction

Billboards

Volume rendering

Frame animation

Handles

Going further

Working with LaTeX

The "movie15" package for LaTeX, written by Alexander Grahn, provides a nice way to handle the embedding of 3-d figures in LaTeX-generated PDF files. It does not remove the need for Adobe Acrobat 3D, but it does improve workflow when creating professional articles.

This package has traditionally been used to embed basic 2-d animations and movies in PDF documents using LaTeX. Some introductory material on movie15 for this purpose can be found [here.]

Retrieved from "https://astronomy.swin.edu.au/s2plot/index.php?title=S2PLOT:3dPDF"

 ===View and Display Options===
-Acrobat 3D offers an extensive range of options to control the rendering of your 3-d figure.  Global options are set in the Acrobat Reader software by the user, and typically at a minimum the following settings are recommended:
+Global viewing options are set in the Acrobat Reader software by the end-user, and typically at a minimum the following settings are recommended:
+* enable double-sided rendering
+* disable 3D selection for the Hand tool
+* enable Acrobat JavaScript
-...
+Figure-specific options can be set and controlled in the Acrobat 3D application itself, and the ability of an end-user to access to modify these options in the Reader can be limited if required.  Most options are accessed by selecting the "3D Tool" and double-clicking on the 3-d figure.
-Figure-specific options can be set and controlled in the Acrobat 3D application itself, and the ability of an end-user to access to modify these options in the Reader can be controlled as well.  Most options are accessed by selecting the "3D Tool" and double-clicking on the 3-d figure.
 ====Background colour, lighting and rendering mode====