Dump extensive information about the contents of the input Field to an HTML file, and write a simple summary to a string output (user interface parameter.)
| Name | Type | Description | |
| in | Mesh+ Node_Data | input field for print_field to dump contents | |
The following lists all of the parameters found in the parameter block PrintFieldParams, which are accessed by the module PrintField and the UI Macro PrintFieldUI.
| Name | Type | Description | UI Control |
| filename | string | output HTML filename | PrintField File Name |
| gridout | int | toggle grid information in the output file | Grid Data |
| cellout | int | toggle cell information in the output file | Cell Data |
| xformout | int | toggle xform information in the output file | Xform Data |
| nodesout | int | toggle node information in the output file | Nodes Data |
| htmlout | int | toggle HTML formatting in the output file | Print HTML File |
| allout | int | toggle points array information in the output file | Print All Point |
| trigger | int | trigger the start of printing | Click to Start Printing |
| message | string | status message about printing | Printing Status |
| notes | string | summary information about field | Node/Cell Data Attributes |
PrintField accepts any type of Field for input and dumps extensive selectable information about the Grid, Cell, Node, Xform and Point data to a plain text or HTML formatted file. Additionally a summary of the information is written to a string parameter, which is displayed by the UI macro.
in
Reference to a field containing Mesh+Node_Data.
filename
Contains the filename and path of the HTML file to write the contents of the field to.
gridout
Toggle to select if the Grid information in the field should be included in the HTML file dump.
cellout
Toggle to select if the Cell information in the field should be included in the HTML file dump.
xformout
Toggle to select if the Xform information in the field should be included in the HTML file dump.
nodesout
Toggle to select if the Nodes information in the field should be included in the HTML file dump.
allout
Toggle to select if all the Point information in the field should be included in the HTML file dump.
htmlout
Toggle to select if output contains HTML formatting. If turned off, the file only contains a purely textual dump of the same information.
trigger
Used to trigger the actual printing (dumping) of the information to the selected file.
message
Used to hold status of the printing.
notes
When HTML file is dumped, this multi-line string is filled with a simple summary of the field contents.
The low-level PrintField module is used in this User Macro print_field. Note that there is no Functional Macro. Additionally, this User Macro also uses the PrintFieldParams parameter block group object, as does the PrintFieldUI UI Macro.
An example application PrintFieldEg is provided, which uses the AVS/Express sample data file hydrogen.fld, to display or dump the contents of that field.
iac_proj/printfld/pfldmacs.v contains the print_field User Macro, the PrintFieldUI UI Macro, and the example application PrintFieldEg V definitions.
The Print_FieldMacs library inherits its process. As this library contains no procedural code, the process is not important. The low-level PrintField module, executes under the process specified in its library, not the process defined in the high-level library.
Note that if "Print All Point" is selected then the output file may become very large!
The filename specified as the output HTML file may only be written to once; any attempt to do so will result in an error message in the error dialog window.
Phil Chen Connie Farb
Paul G. Lever
International AVS Centre Manchester Visualization Centre Manchester Computing University of Manchester Oxford Road Manchester United Kingdom M13 9PL
PrintFieldParams, PrintFieldUI and PrintField.
print_field in AVS/Express version 3.4.