UF_PLOT_add_job_to_plot_layout (view source)
 
Defined in: uf_plot.h
 
Overview
Adds a plot job to the plot layout, and outputs the rectangular bounds of the
plot in the specified units coordinates.
NOTE - If an error occurs during execution, the plot layout will be cleared.

Environment
Internal and External

See Also
UF_PLOT_job_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_add_job_to_plot_layout
(
tag_t drawing_sheet,
UF_PLOT_job_options_p_t job_options,
const char * job_name,
UF_PLOT_units_t units,
double origin [ 2 ] ,
UF_PLOT_rotation_t rotation,
double scale,
UF_PLOT_extents_p_t extents
)
tag_tdrawing_sheetInputTag of drawing sheet. If this
is NULL_TAG, the current display
is being plotted.
UF_PLOT_job_options_p_tjob_optionsInputSpecifies plot job options.
If NULL, current session job
options are used instead. If
non-NULL, call
UF_PLOT_ask_default_job_options
or
UF_PLOT_ask_session_job_options
to initialize the structure before
setting structure fields. Current
session job options are not
modified by structure values.
const char *job_nameInputName of the job
UF_PLOT_units_tunitsInputUnits used to define the plot origin
and extents.
doubleorigin [ 2 ] InputThe location of the plot origin
expressed in the specified units.
UF_PLOT_rotation_trotationInputDefines the orientation of the
plot in the plot layout.
doublescaleInputDefines the scale of the plot in
the plot layout.
UF_PLOT_extents_p_textentsOutputIf non-NULL the rectangular bounds of
the plot in the layout (the coordinates of
the lower-left and the upper-right corners
of the plot in millimeters or inches as
indicated by the units parameter) are
returned.

 


 
UF_PLOT_ask_default_banner_options (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the default banner option settings.

Environment
Internal and External

See Also
UF_PLOT_banner_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_default_banner_options
(
UF_PLOT_banner_options_p_t banner_options
)
UF_PLOT_banner_options_p_tbanner_optionsOutputNon-null pointer to a
banner options data structure.

 


 
UF_PLOT_ask_default_custom_colors (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the default plotting custom colors.

Environment
Internal and External

See Also
UF_CGM_custom_colors_t AKA UF_PLOT_custom_colors_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_default_custom_colors
(
UF_PLOT_custom_colors_p_t custom_colors
)
UF_PLOT_custom_colors_p_tcustom_colorsOutputPointer to the custom
colors data structure.

 


 
UF_PLOT_ask_default_custom_widths (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the default plotting custom widths.

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_default_custom_widths
(
UF_PLOT_custom_widths_p_t custom_widths
)
UF_PLOT_custom_widths_p_tcustom_widthsOutputdefault custom widths

 


 
UF_PLOT_ask_default_job_name (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the default job name. The name might include the part name, the user
name, or a descriptive string, according to job name preferences specified in
the customer defaults file. If the specified drawing sheet tag is not NULL_TAG,
the drawing sheet name is appended to the end of the job name. The returned
job name can be used for constructing file names and other purposes.

The name is returned (such as can be constructed) even if there are errors.
However, no name will be returned if the drawing sheet is not in the
displayed part.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_default_job_name
(
tag_t drawing_sheet,
char * * job_name
)
tag_tdrawing_sheetInputIf not NULL_TAG, the name of this drawing
sheet is appended to the end of the job name
char * *job_nameOutput to UF_*free*String with job name. User must free with
UF_free()

 


 
UF_PLOT_ask_default_job_options (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the default plot job option settings.

Environment
Internal and External

See Also
UF_PLOT_job_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_default_job_options
(
UF_PLOT_job_options_p_t job_options
)
UF_PLOT_job_options_p_tjob_optionsOutputNon-null pointer to a
job options data structure.

 


 
UF_PLOT_ask_default_printer_and_profile (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the name of the default printer and default profile for the current
printer group. Both arrays must be freed with UF_free.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_default_printer_and_profile
(
char * * printer,
char * * profile
)
char * *printerOutput to UF_*free*The default printer in the
current printer group. Must be
freed with UF_free()
char * *profileOutput to UF_*free*The default profile in the
current printer group. Must be
freed with UF_free()

 


 
UF_PLOT_ask_drawing_sheet_colors (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the current custom colors for the drawing sheet. If no
custom colors are saved for the specified drawing sheet an error is returned.

Environment
Internal and External

See Also
UF_CGM_custom_colors_t AKA UF_PLOT_custom_colors_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_drawing_sheet_colors
(
tag_t drawing_sheet,
UF_PLOT_custom_colors_p_t custom_colors
)
tag_tdrawing_sheetInputtag of the sheet in question
UF_PLOT_custom_colors_p_tcustom_colorsOutputPointer to the custom colors
used in the drawing sheet.

 


 
UF_PLOT_ask_drawing_sheet_widths (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the current custom widths for the drawing sheet. If no custom
widths are saved for the specified drawing sheet an error is returned.

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_drawing_sheet_widths
(
tag_t drawing_sheet,
UF_PLOT_custom_widths_p_t custom_widths
)
tag_tdrawing_sheetInputtag of the sheet in question
UF_PLOT_custom_widths_p_tcustom_widthsOutputPointer to the custom widths
used in the drawing sheet.

 


 
UF_PLOT_ask_plot_layout_extents (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the total bounds of the plot layout, the lower-left and upper-right
corners of the smallest rectangle that encloses all plots, in millimeters or
inches as indicated by the units parameter.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_plot_layout_extents
(
UF_PLOT_units_t units,
UF_PLOT_extents_p_t extents
)
UF_PLOT_units_tunitsInputUF_PLOT_MILLIMETERS - the extents are
returned in millimeters.
UF_PLOT_INCHES - the extents are returned in
inches
UF_PLOT_extents_p_textentsOutputThe rectangular bounds of the plot in
the layout.

 


 
UF_PLOT_ask_printer_groups (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the printer groups if the printer group list file exists.
Otherwise, returns zero printer groups.

More information about the Printer Group List File is available under
the Printer Administration section in the Gateway Help documentation.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_printer_groups
(
int * num_printer_groups,
UF_PLOT_printer_group_p_t * printer_groups
)
int *num_printer_groupsOutputNumber of printer groups
UF_PLOT_printer_group_p_t *printer_groupsOutput to UF_*free*Printer groups array.
Must be freed with UF_free()

 


 
UF_PLOT_ask_printer_names (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the names of the printers for the current printer group.
Each printer name in the array must be freed with UF_free, and the array of
printer names must also be freed with UF_free. NULL is returned if
there are no printers.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_printer_names
(
int * num_printers,
char * * * printers
)
int *num_printersOutputNumber of printers in
the current printer group.
char * * *printersOutput to UF_*free*Names of the printers in
the current printer group.
Each name and the array
of names must be freed with
UF_free()

 


 
UF_PLOT_ask_profile_names (view source)
 
Defined in: uf_plot.h
 
Overview
Returns an allocated array of the profile names associated with the
given printer in the current printer group. Each profile name in the array
must be freed with UF_free, and the array of profile names must also be freed
with UF_free.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_profile_names
(
const char * printer,
int * num_profiles,
char * * * profiles
)
const char *printerInputThe name of a printer in
the current printer group
int *num_profilesOutputThe number of profiles
associated with the given printer.
char * * *profilesOutput to UF_*free*The profile names associated with the
given printer in the current group.
Each name and the array
of names must be freed with
UF_free()

 


 
UF_PLOT_ask_session_banner_options (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the current banner option settings for the session.

Environment
Internal and External

See Also
UF_PLOT_banner_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_session_banner_options
(
UF_PLOT_banner_options_p_t banner_options
)
UF_PLOT_banner_options_p_tbanner_optionsOutputNon-null pointer to a
banner options data structure.

 


 
UF_PLOT_ask_session_custom_colors (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the current plotting custom colors for the session.

Environment
Internal and External

See Also
UF_CGM_custom_colors_t AKA UF_PLOT_custom_colors_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_session_custom_colors
(
UF_PLOT_custom_colors_p_t custom_colors
)
UF_PLOT_custom_colors_p_tcustom_colorsOutputPointer to the custom
colors used in the session.

 


 
UF_PLOT_ask_session_custom_widths (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the current plotting custom widths for the session.

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_session_custom_widths
(
UF_PLOT_custom_widths_p_t custom_widths
)
UF_PLOT_custom_widths_p_tcustom_widthsOutputcurrent session widths

 


 
UF_PLOT_ask_session_job_options (view source)
 
Defined in: uf_plot.h
 
Overview
Returns the current plot job option settings for the session.

Environment
Internal and External

See Also
UF_PLOT_job_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_ask_session_job_options
(
UF_PLOT_job_options_p_t job_options
)
UF_PLOT_job_options_p_tjob_optionsOutputNon-null pointer to a
job options data structure.

 


 
UF_PLOT_clear_plot_layout (view source)
 
Defined in: uf_plot.h
 
Overview
Removes all plots from the plot layout, leaving it empty.
NOTE - This routine is unnecessary after a successful call to
UF_PLOT_save_cgm_for_plot_layout or UF_PLOT_print_plot_layout as they
automatically clear the plot layout upon successful execution.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_clear_plot_layout
(
void
)

 


 
UF_PLOT_compare_ughpgl_files (view source)
 
Defined in: uf_plot.h
 
Overview
Compares the lines created by plotter pen movements in two HPGL
plot files created in NX, and returns a resulting plot file. The resulting
plot file shows the lines which are the same and those which are
different between the plot files compared.

Environment
Internal and External

History
This function was originally released in V14.0.
 
Required License(s)
gateway

 
int UF_PLOT_compare_ughpgl_files
(
char * first_plot,
char * second_plot,
UF_PLOT_ughpgl_cmp_options_p_t compare_options,
char * result_plot,
UF_PLOT_diff_cmp_status_t * comparison_result
)
char *first_plotInputName of the first plot file (256 char max)
char *second_plotInputName of the second plot file (256 char max)
UF_PLOT_ughpgl_cmp_options_p_tcompare_optionsInputIndicates options considered
during comparison of plots.
char *result_plotInputName of resulting plot file. If created, this resulting
plot file will contain the overlay of both plots. Lines
that are the same in both plots will be in one color,
lines that are in the first plot only will be in a second
color, and lines that are in the second plot only will be
in a third color.
UF_PLOT_diff_cmp_status_t *comparison_resultOutputComparison results:
UF_PLOT_CMP_NO_DIFF_FOUND
UF_PLOT_CMP_DIFF_FOUND

 


 
UF_PLOT_convert_custom_widths (view source)
 
Defined in: uf_plot.h
 
Overview
Converts numeric values stored in the UF_PLOT_custom_widths_t structure to the
specified units, and then updates the units field of the structure. This
function can be called to ensure custom widths are expressed in appropriate
units after obtaining the widths from a drawing sheet or WDF.

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_convert_custom_widths
(
UF_PLOT_units_t units,
UF_PLOT_custom_widths_p_t custom_widths
)
UF_PLOT_units_tunitsInputUF_PLOT_MILLIMETERS - the custom
width data is converted to millimeters.
UF_PLOT_INCHES - the custom width is
converted to inches
UF_PLOT_custom_widths_p_tcustom_widthsInput / Outputcustom widths data
structure to convert

 


 
UF_PLOT_convert_file (view source)
 
Defined in: uf_plot.h
 
Overview
Parses the indicated CGM or TIFF file, converts the CGM or TIFF data to the
graphics format indicated by the output_format parameter, and saves the
converted data in a file with the specified name, appending an appropriate
suffix if necessary. If a file of the same name already exists, it is
overwritten. Note that this call uses the plotting system to do the conversion
so the plotting system must be configured correctly. In particular the
graphics format that you choose needs to have proper defaults in the NX Print
Print Setup page. In particular the Pixel Dimensions must be non-zero.

Starting in NX 5.0.2, the TIFF conversion is done by calling the cgm2tiff
program released in the NXPLOT kit. The resolution for this conversion is
forced to 72 DPI. You can force the old behavior (which uses the plotting
system) by setting the environment variable UGII_PLOT_CONVERT_OLD_BEHAVIOR.

By far the best way to do a TIFF conversion will be to bypass this call
completely, and directly call the cgm2tiff program to do the conversion
once you have created a CGM file. The cgm2tiff program has options so that
you can control the resolution, scale and rotation of the TIFF file.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_convert_file
(
const char * cgm_or_tiff_file_name,
UF_PLOT_format_t output_format,
const char * output_file_name
)
const char *cgm_or_tiff_file_nameInputName of CGM or TIFF file to convert
UF_PLOT_format_toutput_formatInputFormat used to create the output file
const char *output_file_nameInputName of converted file

 


 
UF_PLOT_delete_drawing_sheet_colors (view source)
 
Defined in: uf_plot.h
 
Overview
Deletes custom colors saved for the specified drawing sheet. An error
code is returned if the drawing sheet has no custom colors.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_delete_drawing_sheet_colors
(
tag_t drawing_sheet
)
tag_tdrawing_sheetInputColors will be deleted from this drawing

 


 
UF_PLOT_delete_drawing_sheet_widths (view source)
 
Defined in: uf_plot.h
 
Overview
Deletes drawing sheet widths saved for the specified drawing sheet. An error
code is returned if the drawing sheet has no widths.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_delete_drawing_sheet_widths
(
tag_t drawing_sheet
)
tag_tdrawing_sheetInputWidths will be deleted from this drawing

 


 
UF_PLOT_has_drawing_sheet_colors (view source)
 
Defined in: uf_plot.h
 
Overview
Returns whether or not custom colors are saved for the specified
drawing sheet.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_has_drawing_sheet_colors
(
tag_t drawing_sheet,
logical * drawing_sheet_has_colors
)
tag_tdrawing_sheetInputtag of sheet to check
logical *drawing_sheet_has_colorsOutputTRUE - drawing sheet colors are
saved for this drawing sheet.
FALSE - drawing sheet colors are not
saved for this drawing sheet.

 


 
UF_PLOT_has_drawing_sheet_widths (view source)
 
Defined in: uf_plot.h
 
Overview
Returns whether or not custom widths are saved for the specified drawing sheet.

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_has_drawing_sheet_widths
(
tag_t drawing_sheet,
logical * drawing_sheet_has_widths
)
tag_tdrawing_sheetInputtag of sheet to check
logical *drawing_sheet_has_widthsOutputTRUE - drawing sheet widths are
saved for this drawing sheet.
FALSE - drawing sheet widths are not
saved for this drawing sheet.

 


 
UF_PLOT_print (view source)
 
Defined in: uf_plot.h
 
Overview
Prints a plot job. The drawing sheet provided must be in the displayed part.

Environment
Internal and External

See Also
UF_PLOT_job_options_t
UF_PLOT_banner_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_print
(
tag_t drawing_sheet,
UF_PLOT_job_options_p_t job_options,
const char * job_name,
UF_PLOT_banner_options_p_t banner_options,
const char * printer,
const char * profile,
int num_copies
)
tag_tdrawing_sheetInputThe plot job represents this drawing sheet.
If NULL_TAG, the plot job represents the current
display image.
UF_PLOT_job_options_p_tjob_optionsInputSpecifies plot job options.
If NULL, current session job
options are used instead. If
non-NULL, call
UF_PLOT_ask_default_job_options
or
UF_PLOT_ask_session_job_options
to initialize the structure before
setting structure fields. Current
session job options are not
modified by structure values.
const char *job_nameInputName of job to print.
UF_PLOT_banner_options_p_tbanner_optionsInputSpecifies banner options.
If NULL, current session
banner options are used
instead. If non-NULL, call
UF_PLOT_ask_default_banner_options
or
UF_PLOT_ask_session_banner_options
to initialize the structure
before setting structure
fields. Current session banner
options are not modified by
structure values.
const char *printerInputSpecifies the name of the printer on
which the job is to be printed. If NULL, the
default printer is used.
const char *profileInputSpecifies the name of the desired profile for the
printer. If NULL, the default profile is used.
intnum_copiesInputNumber of copies to print.

 


 
UF_PLOT_print_file (view source)
 
Defined in: uf_plot.h
 
Overview
Prints the CGM or TIFF file with the specified name.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_print_file
(
const char * filename,
const char * printer,
const char * profile,
int num_copies
)
const char *filenameInputName of CGM or TIFF file to print
const char *printerInputSpecifies the name of the printer on which the
job is to be printed. If NULL, the default printer
is used.
const char *profileInputSpecifies the name of the desired profile for the
printer. If NULL, the default profile is used.
intnum_copiesInputNumber of copies to print.

 


 
UF_PLOT_print_plot_layout (view source)
 
Defined in: uf_plot.h
 
Overview
Prints the plot layout.

Environment
Internal and External

See Also
UF_PLOT_banner_options_t

Returns
UF_PLOT_ERR_EMPTY_LAYOUT if the plot layout is empty.

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_print_plot_layout
(
const char * job_name,
UF_PLOT_banner_options_p_t banner_options,
const char * printer,
const char * profile,
int num_copies
)
const char *job_nameInputName for the plot job
UF_PLOT_banner_options_p_tbanner_optionsInputSpecifies banner options.
If NULL, current session
banner options are used
instead. If non-NULL, call
UF_PLOT_ask_default_banner_options
or
UF_PLOT_ask_session_banner_options
to initialize the structure
before setting structure
fields. Current session banner
options are not modified by
structure values.
const char *printerInputSpecifies the name of the printer on
which the job is to be printed. If NULL, the
default printer is used.
const char *profileInputSpecifies the name of the desired profile for the
printer. If NULL, the default profile is used.
intnum_copiesInputNumber of copies to print.

 


 
UF_PLOT_read_custom_colors_from_cdf (view source)
 
Defined in: uf_plot.h
 
Overview
Initializes a UF_PLOT_custom_colors_t structure according to color data stored
in the specified CDF.

Environment
Internal and External

See Also
UF_CGM_custom_colors_t AKA UF_PLOT_custom_colors_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_read_custom_colors_from_cdf
(
const char * cdf_name,
UF_PLOT_custom_colors_p_t custom_colors
)
const char *cdf_nameInputName of CDF to use
UF_PLOT_custom_colors_p_tcustom_colorsOutputColor data found in the CDF

 


 
UF_PLOT_read_custom_widths_from_wdf (view source)
 
Defined in: uf_plot.h
 
Overview
Initializes a UF_PLOT_custom_widths_t structure according to width data stored
in the specified WDF.

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_read_custom_widths_from_wdf
(
const char * wdf_name,
UF_PLOT_custom_widths_p_t custom_widths
)
const char *wdf_nameInputName of WDF to use
UF_PLOT_custom_widths_p_tcustom_widthsOutputWidth data found in the WDF

 


 
UF_PLOT_save_cgm (view source)
 
Defined in: uf_plot.h
 
Overview
Saves a plot job in a CGM file with the specified name. The Suffix .cgm is
appended to the name if it is not present. If a CGM file of the same name
already exists, it is overwritten. The drawing sheet provided must be in
the displayed part.

Environment
Internal and External

See Also
UF_PLOT_job_options_t
UF_PLOT_banner_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_save_cgm
(
tag_t drawing_sheet,
UF_PLOT_job_options_p_t job_options,
const char * job_name,
UF_PLOT_banner_options_p_t banner_options,
const char * cgm_file_name
)
tag_tdrawing_sheetInputThe plot job represents this
drawing sheet. If NULL_TAG, the
plot job represents the current
display image.
UF_PLOT_job_options_p_tjob_optionsInputSpecifies plot job options.
If NULL, current session job
options are used instead. If
non-NULL, call
UF_PLOT_ask_default_job_options
or
UF_PLOT_ask_session_job_options
to initialize the structure before
setting structure fields. Current
session job options are not
modified by structure values.
const char *job_nameInputName for the plot job
UF_PLOT_banner_options_p_tbanner_optionsInputSpecifies banner options.
If NULL, current session
banner options are used
instead. If non-NULL, call
UF_PLOT_ask_default_banner_options
or
UF_PLOT_ask_session_banner_options
to initialize the structure
before setting structure
fields. Current session banner
options are not modified by
structure values.
const char *cgm_file_nameInputCGM file name

 


 
UF_PLOT_save_cgm_for_plot_layout (view source)
 
Defined in: uf_plot.h
 
Overview
Saves the plot layout in a CGM file with the specified name. Note that the
suffix .cgm is appended to the name if not present. If a CGM file of the
same name already exists, it is overwritten.

Environment
Internal and External

See Also
UF_PLOT_banner_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_save_cgm_for_plot_layout
(
const char * job_name,
UF_PLOT_banner_options_p_t banner_options,
const char * cgm_file_name
)
const char *job_nameInputName for the plot job
UF_PLOT_banner_options_p_tbanner_optionsInputSpecifies banner options.
If NULL, current session
banner options are used
instead. If non-NULL, call
UF_PLOT_ask_default_banner_options
or
UF_PLOT_ask_session_banner_options
to initialize the structure
before setting structure
fields. Current session banner
options are not modified by
structure values.
const char *cgm_file_nameInputCGM file name

 


 
UF_PLOT_set_drawing_sheet_colors (view source)
 
Defined in: uf_plot.h
 
Overview
Saves the specified custom colors for the indicated drawing sheet. Call
one of the following functions to initialize the UF_PLOT_custom_colors_t
structure before setting structure fields.

UF_PLOT_ask_default_custom_colors
UF_PLOT_ask_session_custom_colors
UF_PLOT_ask_drawing_sheet_colors
UF_PLOT_read_custom_colors_from_cdf

Environment
Internal and External

See Also
UF_CGM_custom_colors_t AKA UF_PLOT_custom_colors_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_set_drawing_sheet_colors
(
tag_t drawing_sheet,
UF_PLOT_custom_colors_p_t custom_colors
)
tag_tdrawing_sheetInputThe colors will be stored with
this drawing sheet
UF_PLOT_custom_colors_p_tcustom_colorsInputColors to store with the
drawing sheet

 


 
UF_PLOT_set_drawing_sheet_widths (view source)
 
Defined in: uf_plot.h
 
Overview
Saves the specified widths for the indicated drawing sheet. Call one
of the following functions to initialize the UF_PLOT_custom_widths_t
structure before setting structure fields.

UF_PLOT_ask_default_custom_widths
UF_PLOT_ask_session_custom_widths
UF_PLOT_ask_drawing_sheet_widths
UF_PLOT_read_custom_widths_from_wdf

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_set_drawing_sheet_widths
(
tag_t drawing_sheet,
UF_PLOT_custom_widths_p_t custom_widths
)
tag_tdrawing_sheetInputThe widths will be stored with
this drawing sheet
UF_PLOT_custom_widths_p_tcustom_widthsInputWidth to store with the
drawing sheet

 


 
UF_PLOT_set_printer_group (view source)
 
Defined in: uf_plot.h
 
Overview
Sets the current printer group

The jobs_dir and home_dir parameters can be NULL, in which case the default
jobs and home directories are used. If group_dir specifies a printer group
in the printer group list file, however, then jobs_dir and home_dir should
be set to the values returned by UF_PLOT_ask_printer_groups for group_dir.

If the jobs and home directories exist, they must be writable. If they do
not exist, it must be possible to create them.

If the jobs_dir is passed a string with a trailing backslash, the directory
will not be created.

Environment
Internal and External

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_set_printer_group
(
const char * group_dir,
const char * jobs_dir,
const char * home_dir
)
const char *group_dirInputGroup directory
const char *jobs_dirInputJobs directory
const char *home_dirInputHome directory

 


 
UF_PLOT_set_session_banner_options (view source)
 
Defined in: uf_plot.h
 
Overview
Modifies the current banner option settings for the session. Call
UF_PLOT_ask_default_banner_options or UF_PLOT_ask_session_banner_options
to initialize the UF_PLOT_banner_options_t structure before setting
structure fields.

Environment
Internal and External

See Also
UF_PLOT_banner_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_set_session_banner_options
(
const UF_PLOT_banner_options_p_t banner_options
)
const UF_PLOT_banner_options_p_tbanner_optionsInputbanner options
data structure

 


 
UF_PLOT_set_session_custom_colors (view source)
 
Defined in: uf_plot.h
 
Overview
Modifies the current plotting custom colors for the session. Call
one of the following functions to initialize the UF_PLOT_custom_colors_t
structure before setting structure fields.

UF_PLOT_ask_default_custom_colors
UF_PLOT_ask_session_custom_colors
UF_PLOT_ask_drawing_sheet_colors
UF_PLOT_read_custom_colors_from_cdf

Environment
Internal and External

See Also
UF_CGM_custom_colors_t AKA UF_PLOT_custom_colors_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_set_session_custom_colors
(
UF_PLOT_custom_colors_p_t custom_colors
)
UF_PLOT_custom_colors_p_tcustom_colorsInputCustom colors data
structure to be used for
the current session

 


 
UF_PLOT_set_session_custom_widths (view source)
 
Defined in: uf_plot.h
 
Overview
Modifies the current plotting custom widths for the session. Call one
of the following functions to initialize the UF_PLOT_custom_widths_t
structure before setting structure fields.

UF_PLOT_ask_default_custom_widths
UF_PLOT_ask_session_custom_widths
UF_PLOT_ask_drawing_sheet_widths
UF_PLOT_read_custom_widths_from_wdf

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_set_session_custom_widths
(
UF_PLOT_custom_widths_p_t custom_widths
)
UF_PLOT_custom_widths_p_tcustom_widthsInputcustom widths to set
for the current session

 


 
UF_PLOT_set_session_job_options (view source)
 
Defined in: uf_plot.h
 
Overview
Modifies the current plot job option settings for the session. Call
UF_PLOT_ask_default_job_options or UF_PLOT_ask_session_job_options
to initialize the UF_PLOT_job_options_t structure before setting
structure fields.

Environment
Internal and External

See Also
UF_PLOT_job_options_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_set_session_job_options
(
UF_PLOT_job_options_p_t job_options
)
UF_PLOT_job_options_p_tjob_optionsInputPointer to the job options
you wish to set.

 


 
UF_PLOT_set_ughpgl_small_tol (view source)
 
Defined in: uf_plot.h
 
Overview
Sets the tolerance which is used when determining if a vector is ignorable.
If a vector is less than or equal to the given length, then the line may
be ignored if it is not matched.

Environment
Internal and External
 
Required License(s)
gateway

 
int UF_PLOT_set_ughpgl_small_tol
(
double small_tolerance,
int units
)
doublesmall_toleranceInputThe maximum length of a vector that
may be ignored.
intunitsInputMetric of English units.

 


 
UF_PLOT_set_ughpgl_tol (view source)
 
Defined in: uf_plot.h
 
Overview
Sets the tolerance which is used when comparing non-overlapping vectors
between the first and second plot file. When the vectors compared are a
distance apart of less than or equal to the shift tolerance, they are
checked off as common vectors and not as unique vectors.

Environment
Internal and External
 
Required License(s)
gateway

 
int UF_PLOT_set_ughpgl_tol
(
double shift_tolerance,
int units
)
doubleshift_toleranceInputThe amount of shift which will be
allowed between two non-overlapping pair of
vectors from the first and second plot file.
If the vectors are within the shift amount,
they are then considered one and the same.
intunitsInputMetric of English units.

 


 
UF_PLOT_write_custom_colors_to_cdf (view source)
 
Defined in: uf_plot.h
 
Overview
Saves the custom colors in a CDF with the specified name.
Note that the suffix .cdf is appended to the name if not present.
If a CDF of the same name already exists it is overwritten.

Call one of the following functions to initialize the UF_PLOT_custom_colors_t
structure before setting structure fields.

UF_PLOT_ask_default_custom_colors
UF_PLOT_ask_session_custom_colors
UF_PLOT_ask_drawing_sheet_colors
UF_PLOT_read_custom_colors_from_cdf

Environment
Internal and External

See Also
UF_CGM_custom_colors_t AKA UF_PLOT_custom_colors_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_write_custom_colors_to_cdf
(
const char * cdf_name,
UF_PLOT_custom_colors_p_t custom_colors
)
const char *cdf_nameInputName of CDF to use
UF_PLOT_custom_colors_p_tcustom_colorsInputColor data to write in the CDF

 


 
UF_PLOT_write_custom_widths_to_wdf (view source)
 
Defined in: uf_plot.h
 
Overview
Saves the custom width data in a WDF with the specified name.
Note that the suffix .wdf is appended to the name if not present.
If a WDF of the same name already exists it is overwritten.

Call one of the following functions to initialize the UF_PLOT_custom_widths_t
structure before setting structure fields.

UF_PLOT_ask_default_custom_widths
UF_PLOT_ask_session_custom_widths
UF_PLOT_ask_drawing_sheet_widths
UF_PLOT_read_custom_widths_from_wdf

Environment
Internal and External

See Also
UF_CGM_custom_widths_t AKA UF_PLOT_custom_widths_t

History
Originally released in NX3.0.
 
Required License(s)
gateway

 
int UF_PLOT_write_custom_widths_to_wdf
(
const char * wdf_name,
UF_PLOT_custom_widths_p_t custom_widths
)
const char *wdf_nameInputName of WDF to use
UF_PLOT_custom_widths_p_tcustom_widthsInputWidth data to write in the WDF