VIEW3D REFERENCE

Hardcopy Output Functions

Th following set of functions can be used to produce files containing a PostScript or CGM representation of a View3D widget..

Function Name Description
XintCGMDrawBox To tell the CGM output whether or not to draw a box around a CGM plot.
XintCGMGetDimensions Gets the size in inches used by a View3D widget.
XintOutputCGM Creates a CGM file containing the graphic representation of a single widget.
XintOutputCompositeCGM Creates a CGM file containing the graphic representation of all of the widgets that are children of a composite widget.
XintOutputCompositePostscript Creates a PostScript file containing the graphic representation of all the widgets that are children of a composite widget.
XintOutputMontageCGM Creates a CGM file containing the graphic representation of a single widget.
XintOutputMontagePostscript Creates a PostScript file containing a montage composed of several widgets.
XintOutputPostscript Creates a PostScript file containing the graphic representation of a single widget.
XintPostscriptGetDefaults Gets the PostScript page characteristics.
XintPostscriptSetDefaults Sets the PostScript page characteristics.
XintView3DAddTiffToMovieFile This function adds a TIFF file to the end of a movie file.
XintView3DReadTiffFile This function will read the image data from a TIFF file.
XintView3DWriteTiff This function outputs the View3D screen display as a TIFF file.

Function Name	Description
XintCGMDrawBox	To tell the CGM output whether or not to draw a box around a CGM plot.
XintCGMGetDimensions	Gets the size in inches used by a View3D widget.
XintOutputCGM	Creates a CGM file containing the graphic representation of a single widget.
XintOutputCompositeCGM	Creates a CGM file containing the graphic representation of all of the widgets that are children of a composite widget.
XintOutputCompositePostscript	Creates a PostScript file containing the graphic representation of all the widgets that are children of a composite widget.
XintOutputMontageCGM	Creates a CGM file containing the graphic representation of a single widget.
XintOutputMontagePostscript	Creates a PostScript file containing a montage composed of several widgets.
XintOutputPostscript	Creates a PostScript file containing the graphic representation of a single widget.
XintPostscriptGetDefaults	Gets the PostScript page characteristics.
XintPostscriptSetDefaults	Sets the PostScript page characteristics.
XintView3DAddTiffToMovieFile	This function adds a TIFF file to the end of a movie file.
XintView3DReadTiffFile	This function will read the image data from a TIFF file.
XintView3DWriteTiff	This function outputs the View3D screen display as a TIFF file.

XintCGMDrawBox

This function sets a flag that tells the CGM output routines XintOutputCGM and XintOutputCompositeCGM whether or not to draw a rectangular box around the plot.

     void XintCGMDrawBox (Boolean flag)

where flag is a Boolean variable that should be set to True to have the box drawn around the plot.

XintCGMGetDimensions

This function returns the dimensions (in inches) that a widget (or combination of widgets) will occupy when mapped to a plot. This function is usually called prior to calling a CGM hardcopy function so that you may specify the appropriate dimensions in the CGM hardcopy function call.

     void XintCGMGetDimensions (...)

Widget widget The ID of the widget to be output.
float * width Width in inches of the widget's extent.
float * height Height in inches of the widget's extent.

XintOutputCGM

Writes a color CGM description of a widget (whose class is derived from the XintCompBase widget class) to a disk file.

     Boolean    XintOutputCGM (...)

Widget widget The ID of the widget to be output.
char * filename Name of CGM file to be created.
double plot_width Specifies the width in inches of the CGM plot to be generated.
double plot_height Specifies the height in inches of the CGM plot to be generated.

In case of error, the function returns a warning message to the end user (as controlled by resource XmNwarning) and returns False. Otherwise, it returns True.

XintOutputCompositeCGM

This function writes a color CGM description of the contents of a container widget to a disk file. The geometry of the widgets inside the container widget is preserved. However, widgets contained in a Motif ScrolledWindow widget are expanded to their full size and the scrollbars are not displayed. Only widgets that are instances of CompBase, Motif Label or one of their subclasses will be output.

     Boolean   XintOutputCompositeCGM (...)

Widget widget Composite widget for output.
char * filename Name of CGM file to be created.
double plot_width Specifies the width in inches of the CGM plot to be generated.
double plot_height Specifies the height in inches of the CGM plot to be generated.

In case of error, the function displays a warning message (as controlled by resource XmNwarning) to the end user and returns False. Otherwise, it returns True.

XintOutputCompositePostscript

This function writes a scaled monochrome or color PostScript description of the contents of a container widget to a disk file. The geometry of the widgets inside the container widget is preserved. However, widgets contained in a Motif ScrolledWindow widget are expanded to their full size and the scrollbars are not displayed. Only widgets that are instances of CompBase, Motif Label, Motif LabelGadget or one of their subclasses will be output.

     Boolean   XintOutputCompositePostscript (...)

Widget widget Container widget containing combination of widgets for output.
char * filename Name of PostScript file to be created.
double scale_factor Specify a real number greater than 0 (see below).
int color_model Specify XintMONOCHROME for monochrome output or XintCOLOR for color output.
int orientation Specify one of the values below.

In case of error, the function displays a warning message (as controlled by resource XmNwarning) to the end user and returns False. Otherwise, it returns True.

The argument orientation must be specified as one of the following:

Resource Value Description
XintORIENTATION_PORTRAIT Image will be oriented as on screen.
XintORIENTATION_LANDSCAPE Image will be rotated 90 degrees clockwise from the screen image.
XintORIENTATION_AUTOMATIC Image will be oriented so that the longest dimension (height or width) will be along the longest dimension of the page.

Resource Value	Description
XintORIENTATION_PORTRAIT	Image will be oriented as on screen.
XintORIENTATION_LANDSCAPE	Image will be rotated 90 degrees clockwise from the screen image.
XintORIENTATION_AUTOMATIC	Image will be oriented so that the longest dimension (height or width) will be along the longest dimension of the page.

The scale_factor argument in the function call specifies how the image inside the widget window will be scaled when output to the PostScript file. If you specify 1, then the image will be fit to the page. If you specify a fractional number greater than 0 and less than 1, then the image will be scaled to that fraction of the page. If you specify a number greater than 1, then the image will be scaled by that number, but only as much as can fit on one page will be output.

XintOutputMontageCGM

Writes a color CGM file containing a montage of several widgets into a canvas. The canvas size and the widget positions inside the canvas are specified in pixel units. The convenience function XintGetWidgetSize can be used to obtain the size in pixels of each widget. The widgets in the list must be of a class derived from CompBase, Motif ScrolledWindow or Motif Label.

     Boolean XintOutputMontageCGM (...)

Widget * widget_list List of widgets to output.
int * xpos_list List of x coordinates for the widgets.
int * ypos_list List of y coordinates for the widgets.
int count Number of widgets to output.
char * filename Name of CGM file to be created.
int canvas_width Width of canvas in pixels.
int canvas_height Height of canvas in pixels.
double width Width of plot in inches.
double height Height of plot in inches.

In case of error, the function displays a warning message (as controlled by resource XmNwarning) to the end user and returns False. Otherwise, it returns True.

XintOutputMontagePostscript

This function writes a color or monochrome PostScript file containing a montage of several widgets into a canvas. The canvas size and the widget positions inside the canvas are specified in pixel units. Convenience function XintGetWidgetSize can be used to obtain the size in pixels of each widget. The widgets in the list must be from a class derived from CompBase, Motif ScrolledWindow or Motif Label.

     Boolean XintOutputMontagePostscript (...)

Widget * widget_list List of widgets to output.
int * xpos_list List of x coordinates for the widgets.
int * ypos_list List of y coordinates for the widgets.
int count Number of widgets to output.
char * filename Name of PostScript file to be created.
int canvas_width Width of canvas in pixels.
int canvas_height Height of canvas in pixels.
double scale Specify a real number greater than 0 (see below).
int color_model Specify XintMONOCHROME for monochrome output or XintCOLOR for color output.
int orientation Specify one of the values below.

In case of error, the function displays a warning message to the end user (as controlled by resource XmNwarning) and returns False; otherwise, it returns True.

The argument orientation must be specified as one of the following defined constants:

Resource Value	Description
XintORIENTATION_PORTRAIT	Image will be oriented as on screen.
XintORIENTATION_LANDSCAPE	Image will be rotated 90 degrees clockwise from the screen image.
XintORIENTATION_AUTOMATIC	Image will be oriented so that the longest dimension (height or width) will be along the longest dimension of the page.

The scale_factor argument in the function call specifies how the image inside the widget window will be scaled when output to the PostScript file. If you specify 1, the image will be fit to the page. If you specify a fractional number greater than 0 and less than 1, the image will be scaled to that fraction of the page. If you specify a number greater than 1, the image will be scaled by that number, but only as much as can fit on one page will be output to the PostScript file.

XintOutputPostscript

This function writes a scaled monochrome or color PostScript description of a widget (whose class is derived from the XintCompBase widget class) to a disk file.

     Boolean XintOutputPostscript (...)

Widget widget Widget for output.
char * filename Name of PostScript file to be created.
double scale_factor Specify a real number greater than 0 (see below).
int color_model Specify XintMONOCHROME for monochrome output or XintCOLOR for color output.
int orientation Specify one of the values below.

In case of error, the function displays a warning message to the end user and returns False; otherwise, it returns True.

Arguments orientation and scale_factor are the same as in function XintOutputMontagePostscript described above.

XintPostscriptGetDefaults

This function gets the PostScript output page characteristics set by using the XintPostscriptSetDefaults function.

     void XintPostscriptGetDefaults (...)

int * resolution Returns a pointer to an integer specifying the page resolution in dots per inch.
float * page_width> Returns a pointer to a floating point number specifying the page width in inches.
float * page_height Returns a pointer to a floating point number specifying the page height in inches.

XintPostscriptSetDefaults

This function sets the PostScript output page characteristics used by the XintOutputPostscript and XintOutputCompositePostscript functions.

     void XintPostscriptSetDefaults (...)

int * resolution Returns a pointer to an integer specifying the page resolution in dots per inch.
double page_width Specifies the page width in inches.
double page_height Specifies the page height in inches.

XintView3DAddTiffToMovieFile

This function adds a TIFF file to the end of a movie file.

     void XintView3DAddTiffToMovieFile (...)

char * tiff_file Name of TIFF file to add to movie.
char * movie_file Name of movie file to add TIFF file to.

XintView3DReadTiffFile

This function will return the image data in a TIFF file. The component of image will determine the color or grey image. This could be used to read data from voxel slices.

     unsigned char *XintView3DReadTiffFile (...)

char * filename Name of TIFF file.
int * width Width of image returned.
int * height Height of image returned.
int * num_component Components of image returned.

XintView3DWriteTiff

This function writes the View3D screen display to a TIFF file.

     void XintView3DWriteTiff (...)

Widget widget ID of the View3D widget.
char * file Name of output TIFF file.

Widget	widget	The ID of the widget to be output.
float *	width	Width in inches of the widget's extent.
float *	height	Height in inches of the widget's extent.

Widget	widget	Composite widget for output.
char *	filename	Name of CGM file to be created.
double	plot_width	Specifies the width in inches of the CGM plot to be generated.
double	plot_height	Specifies the height in inches of the CGM plot to be generated.

Widget	widget	Container widget containing combination of widgets for output.
char *	filename	Name of PostScript file to be created.
double	scale_factor	Specify a real number greater than 0 (see below).
int	color_model	Specify XintMONOCHROME for monochrome output or XintCOLOR for color output.
int	orientation	Specify one of the values below.

Widget *	widget_list	List of widgets to output.
int *	xpos_list	List of x coordinates for the widgets.
int *	ypos_list	List of y coordinates for the widgets.
int	count	Number of widgets to output.
char *	filename	Name of CGM file to be created.
int	canvas_width	Width of canvas in pixels.
int	canvas_height	Height of canvas in pixels.
double	width	Width of plot in inches.
double	height	Height of plot in inches.

Widget	widget	Widget for output.
char *	filename	Name of PostScript file to be created.
double	scale_factor	Specify a real number greater than 0 (see below).
int	color_model	Specify XintMONOCHROME for monochrome output or XintCOLOR for color output.
int	orientation	Specify one of the values below.

int *	resolution	Returns a pointer to an integer specifying the page resolution in dots per inch.
float *	page_width>	Returns a pointer to a floating point number specifying the page width in inches.
float *	page_height	Returns a pointer to a floating point number specifying the page height in inches.

char *	tiff_file	Name of TIFF file to add to movie.
char *	movie_file	Name of movie file to add TIFF file to.

char *	filename	Name of TIFF file.
int *	width	Width of image returned.
int *	height	Height of image returned.
int *	num_component	Components of image returned.

Widget	widget	ID of the View3D widget.
char *	file	Name of output TIFF file.