This causes the grid to be display immediately instead of waiting for a
system determined regeneration (at more opportune time). However, trying
to activate a grid in the wrong context will not work. For example, a drawing
grid cannot be displayed in the Modeling application context.

product_context - either UF_DISP_SKETCH_GRID for sketcher application,
or UF_DISP_DRAWING_GRID for drawing,
or UF_DISP_SHED_GRID for True Shading display,
or UF_DISP_MODEL_GRID for others (or default).

Internal and External

UF_DISP_ask_grid_parameters
UF_DISP_set_grid_parameters
UF_DISP_deactivate_grid
UF_DISP_ask_current_grid_context

Originally released in V19.0
 

gateway

Adds an object to the display. You can use this routine to update the
display of a new or modified object, if UF_DISP_set_display has been
used to turn off the display update.

Internal
 

gateway

Determines the color in the Color Table Object (CTO) "closest" to
the given color values, based on the specified Color Comparison
Method. The index of the closest color is returned.
UF_DISP_CCM_EUCLIDEAN_DISTANCE - this method returns the
color which is the least Euclidean distance away from the given color
in the RGB color cube.
Note that the background color is not considered as a candidate.
There must be a part loaded when this function is called.

Internal

Please see the example
 

gateway

Returns the index of the color in the color table of the currently
displayed part that is most similar to the color indicated by the
given color name symbol.

If the specified part cannot be found, then the closest color in
the default color definition file (CDF) specified by the customer
defaults file is returned. If no such file exists, then the closest
color in the system color table is returned.

Zero is returned upon successful execution.
Any other return code indicates an error.

Internal and External

UF_DISP_color_name_t
UF_DISP_ask_closest_color
UF_DISP_ask_closest_color_in_part

Originally released in NX3.
 

gateway

Returns the index of the color in the color table of the specified
part that is most similar to the color indicated by the given color
name symbol. Parameter object_in_part identifies the part; the
parameter can be set to the part tag or the tag of an object in the
part.

If the specified part cannot be found, then the closest color in
the default color definition file (CDF) specified by the customer
defaults file is returned. If no such file exists, then the closest
color in the system color table is returned.

Zero is returned upon successful execution.
Any other return code indicates an error.

Internal and External

UF_DISP_color_name_t
UF_DISP_ask_closest_color
UF_DISP_ask_closest_color_in_displayed_part

Originally released in NX3.
 

gateway

Obtains the name and values of the specified color from the Color
Table object (CTO) of the Display part. The color values are given
using the specified color model.
Note that the maximum value permitted for clr_num is the number of
records presently in the CTO, minus 1. The number of CTO records
may be obtained by calling UF_DISP_ask_color_count. There must be
a part loaded when this function is called.

Internal and External

See example
 

gateway

Returns the actual number of records currently in the Color Table
object of the Display part, including the record for the background
color. There must be a part loaded when this function is called.

Internal and External

See example
 

gateway

This function returns the current application for task environment

return - either UF_DISP_SKETCH_GRID for sketcher application,
or UF_DISP_DRAWING_GRID for drawing,
or UF_DISP_SHED_GRID for True Shading display,
or UF_DISP_MODEL_GRID for others (or default).
or UF_DISP_NULL_GRID if no grid is setup yet

Internal and External

UF_DISP_ask_grid_parameters
UF_DISP_set_grid_parameters
UF_DISP_activate_grid
UF_DISP_deactivate_grid

Originally released in V19.0
 

gateway

This function returns ERROR_OK or zero if either
a material in the Materials in Part Palette is selected or
a material in the Materials Library is selected depending which was selected lastly.
If material selected is from the Materials in Part palette, then both material_tag and
material_full_archive_name will be returned. If the material selected is from
the Materials library, then only material_full_archive_name will be returned.
The function also returns the material source of UF_DISP_material_source_t type.
This can be used to determine which of UF_DISP_ask_work_part_material_lwa_user_area_data
or UF_DISP_ask_library_material_lwa_user_area_data to call to find the
LWA (LightWork Archive) user area data.
If no material is found selected, non-zero is returned.
This function applies to materials of current renderer type.

Internal only

This function is created for NX604.
 

gateway

Given an object (body, face, facetted_body), return the assigned decals'
base material.
If decal is assigned on body and user use the body's faces as input parameter,
Then this function would return 0 decal. It will not search for the face's parent body.
User should write their own code to get the body of face,using NXOpen::Face::GetBody or
UF_MODL_ask_face_body, and call this function again.

Internal and External

This function was created in NX11.0.2
 

gateway

Queries the display status. You can use UF_DISP_ask_display to find out
the current state of the graphics display.

Internal

Released in V16.0
 

gateway

Inquires the context pointer and returns information about display,
selection, fit, and attention point information in the output structure.
This function can be called prior to displaying geometry, after
geometry is displayed, or both. This routine may only be called from a
UDO registered callback routine. The context argument passed into this
routine will be passed from NX to the UDO callback routine.

NOTE: All values in the inquiry structure are set to NULL or FALSE by this function
except for the following:
If this routine is being called from the attention point callback the
is_attn_pt_valid field is set to TRUE.
If this routine is being called from the fit callback only the view_tag is set.
If this routine is being called from the display callback,
the view_tag, is_draw_open_disp, is_view_mode_valid, and view_mode fields
are set.

Internal and External

UF_DISP_inquire_p_t
UF_UDOBJ_register_display_cb
UF_UDOBJ_register_fit_cb
UF_UDOBJ_register_attn_pt_cb
UF_UDOBJ_register_select_cb

Modified in V17 to return the view tag
 

gateway

Returns the data that affects drawing monochrome display.
This routine MUST be called to populate the data structure, before
UF_DISP_set_drawing_display is called.

Please reference ufd_disp.c to review a sample execution of this function.

UF_err_program_not_initialized

Internal and External

UF_DISP_drawing_display_data_t

None
 

gateway

This function returns a list of geometry object tags that are associated to
the given material tag.

The object_tags are limited to these types: UF_solid_type, UF_solid_face_subtype
and UF_faceted_model_type.

This function supports both types of materials.

Internal

See example

This function is created for NX7.5 QRM.
 

gateway

Queries the information about the grid in the designated application
context. The 'product_context' variable must be set.

product_context - either UF_DISP_SKETCH_GRID for sketcher application,
or UF_DISP_DRAWING_GRID for drawing,
or UF_DISP_SHED_GRID for True Shading display,
or UF_DISP_MODEL_GRID for others (or default).

Internal and External

UF_DISP_set_grid_parameters
UF_DISP_activate_grid
UF_DISP_deactivate_grid
UF_DISP_ask_current_grid_context

Originally released in V19.0
 

gateway

This function returns the LWA user area data based on the material_full_archive_name and the
specification_attribute_string_key.
If the specified data is found in the LWA user area data, ERROR_OK or 0 is returned.
This function only supports Author based materials and libraries.

Internal only

This function is created for NX604.
 

gateway

This function returns the material tag and name of the material assigned to
the object defined by object_tag.
The object_tag is limited to these types: UF_solid_type, UF_solid_face_subtype
and UF_faceted_model_type.
This function supports both types of materials, but will only work on the materials of
the current renderer type.
For example, if you are using the Author RTS renderer(vs. Iray+ RTS renderer), then this API
will apply to Author type materials.

Internal and External

See example

This function is created for NX3 QRM.
 

gateway

Get list of current materials (material_name and material_tag) in the specific part.
As different render engine has their own material format. This function will return materials match for the material_format_type parameter.
Currently we only have Author and IrayPlus format materials.

NOTE:this function does not return decal materials. Please use UF_DISP_ask_decals for that purpose.

Internal and External

See example

This function was created in NX11.0.2
 

gateway

Returns the model bounds of the work part. Each part should contain
exactly one "model bounds object" which ideally contains a 3D box in
absolute space inside of which is all of the geometry of the work part.
NOTE: In general, the model bounds returned by this function are
NOT accurate, as NX does not usually update the model bounds as
objects are created, modified, and deleted. This function is intended
for use by certain NX applications such as translators which know that
their application has earlier computed model bounds which are still
known to be valid.

Internal and External
 

gateway

Returns the model bounds tag of the work part. Each part should
contain exactly one "model bounds object" which ideally contains a
3D box in absolute space inside of which is all of the geometry of the
work part.

Internal and External
 

gateway

Returns the current name display setting.

Internal and External
 

gateway

Returns the current name display view setting. The constant
UF_DISP_NAMES_IN_VIEW_OF_DEFN is the view which was the
work view when the object was defined.

Internal and External
 

gateway

Reads the face analysis display parameters into the supplied
UF_DISP_srfanl_data_t structure. This routine uses a pointer to the
structure UF_DISP_srfanl_data_s.

Internal
 

gateway

Reads system display parameters. This routine uses a pointer to the
structure UF_DISP_system_params_s.

To access parameters related to shaded face edges, please use
UF_VIEW_ask_shaded_edge_options
instead.

Internal and External

UF_DISP_system_params_p_t

V12.0 light_source_angles field removed from the structure
V13.0 Added show_shaded_face_edges and hidden_shaded_face_edges
to the structure
V19.0 Added fields use_face_edges_color
face_edges_color
hidden_geometry_color
random_color_displayed
random_color_object_type
 

gateway

This function returns the texture space information required for the
specified material.
For certain material texture (e.g., logos), texture space information is
required to describe how to place the texture on a body so the texture image
or pattern will appear correctly on the model (orientation, position and
scale). If texture space information is not found for the material
(e.g., for non-textured materials, such as metals), ts_info_defined will
be set to 0 and no texture space information will be returned.

Internal and External

See example

This function is created for NX3 QRM.
 

gateway

This function returns the LWA user area data based on the material tag and the
specification_attribute_string_key.
If the specified data is found from the LWA user area data, ERROR_OK or 0 is returned.
This function only supports Author based materials.

Internal only

This function is created for NX604.
 

gateway

Queries the current work plane emphasis setting. When work plane emphasis
is on, objects that do not lie on the work plane appear de-emphasized, in
which the object color is blended with the De-emphasis Blend Color according
to the De-emphasis Blend Percentage. A de-emphasized object is unselectable
unless the work plane emphasis selection filter is overridden. Work plane
emphasis is a session dependent value; it is not saved with any part.

Internal and External

UF_DISP_set_work_plane_emphasis
UF_DISP_ask_work_plane_sel
UF_DISP_set_work_plane_sel
See example

Original release was in V13.0.
 

gateway

Queries the value of the selection override for work plane emphasis.
When work plane emphasis is enabled and the selection override is
equal to UF_DISP_SELECT_WORK_DIMMED, no objects are
filtered out of selection because they are off the work plane.
When work plane emphasis is enabled and the selection override is
equal to UF_DISP_NO_SELECT_WORK_DIMMED, no objects
dimmed for work plane emphasis are selectable.
When work plane emphasis is disabled, the selection override setting
has no affect although it can be changed. The selection override
setting takes effect once work plane emphasis is enabled.
The work plane emphasis selection override is a session dependent
value; it is not saved with any part.

Internal and External

UF_DISP_set_work_plane_emphasis
UF_DISP_ask_work_plane_emphasis
UF_DISP_set_work_plane_sel

Original release was in V13.0.
 

gateway

This function assigns the material to object
NOTE object types accepted include: UF_solid_type, UF_solid_face_subtype
and UF_faceted_model_type.
This function supports assigning of both types of materials (Iray+ and Author).

Internal and external

See example

This function is created for NX3 QRM.
 

gateway

Creates a shaded image using the capabilities of NX Photo and saves
that image as a TIFF, GIF, or JPEG file. You specify the image type
by including the appropriate file extension in the save_filename
parameter. Use any one of the following file extensions:
.tif - TIFF
.gif - GIF
.jpg - JPEG
For example, specifying "test.jpg" for the filename parameter
creates a JPEG file.
The batch shade function shades the active view using the light
sources, backgrounds, foregrounds, materials and textures that were
setup using interactive NX. If the current layout is a drawing then
this function will return without creating an output file.

If using a shade method of UF_DISP_high_quality, UF_DISP_preview,
UF_DISP_photo_real or UF_DISP_raytrace then a Studio Render license
is required. If this license is not available then the method will
default back to UF_DISP_phong.

Please note this API generates output shaded image file using Lightworks Author renderer and
supports Lightworks Author materials and textures. IrayPlus materials won't be processed.
Please set NX_RTS_IRAY=0 before executing NX Open utilities using this API.

Internal and External

See example

This function was modified in V14.0 to also produce GIF
and JPEG files
 

gateway

Creates a shaded image using the capabilities of NX Photo and saves
that image as a TIFF, GIF, or JPEG file. You specify the image type
by including the appropriate file extension in the save_filename
parameter. Use any one of the following file extensions:
.tif - TIFF
.gif - GIF
.jpg - JPEG
For example, specifying "test.jpg" for the filename parameter
creates a JPEG file.
The batch shade function shades the active view using the light
sources, backgrounds, foregrounds, materials and textures that were
setup using interactive NX. If the current layout is a drawing then
this function will return without creating an output file.
This function allows setting of some options for the shading process.

If using a shade method of UF_DISP_high_quality, UF_DISP_preview,
UF_DISP_photo_real or UF_DISP_raytrace then a Studio Render license
is required. If this license is not available then the method will
default back to UF_DISP_phong.

Please note this API generates output shaded image file using Lightworks Author renderer and
supports Lightworks Author materials and textures. IrayPlus materials won't be processed.
Please set NX_RTS_IRAY=0 before executing NX Open utilities using this API.

Internal and External

This function was first released in NX3.0.3
 

gateway

Computes the model bounds for the work part. The model bounds
defines a box in Absolute coordinates which contains all of the
potentially displayable geometry of the part. The sides of the box are
parallel to the axes of the absolute coordinate system. Objects which
are not currently displayable, because they are blanked or on an
invisible layer, are still included within the model bounds.
If there are no displayable objects in the part, bounds_computed will
be FALSE, and model_bounds will contain default bounds, which are
the size of the current graphics in X and Y, with Z the same as the
smaller of X and Y.
NOTE: This function is of limited value for most NX Open API
application developers. It is intended to be used by certain NX
applications such as translators.

Internal and External
 

gateway

Displays a temporary conehead vector with either the base of the staff,
the arrow tip or the base of the arrow head at the reference point
in the specified view.

void

Internal

See example
 

gateway

This function copies a material specified by the material_name input argument from the currently
opened Lightworks LWA archive material library to the work part.
NOTE: this API will not work on CgFX materials.

0 = Success
-1 = Failed to find an opened LWA archive materials library
-2 = Failed to import named material.
Not -1,-2, 0 = Error code
Standard UF Error Codes:
UF_err_program_not_initialized
UF_err_bad_parameter_number_1: problem found with material_name argument
UF_err_part_not_loaded: need to have an opened work part.

This function only supports Author based materials and libraries(lwa).

Internal and external

See example

This function is created for NX8.5.3
 

gateway

This function creates a new material based on an existing material
attributes defined by the given material tag.
This function supports copying of both type of materials(Iray+ and Author).

Internal and External

See example

This function is created for NX3 QRM.
 

gateway

Allows the batch creation of an MPEG movie based on an existing
animation saved in the opened part. An Animation can be created
using the Create Animation Dialog. See the NX Gateway Online
help for details on creating an animation name and frames.

Note that only animations of "Define Key Frames" type are supported.
The Default animation is "Define Trajectory Curves" type. To create
a "Define Key Frames" type animation, the user needs to select
"Define Key Frames" prior to selecting Add/Copy when creating a new
animation.

0 = Success
-1 = Unable to find data for "animation_name"
-2 = General error creating MPEG data
not -1,-2, 0 = Error code
Standard UF Error Codes

Internal and External

Original release was in V13.0.
 

gateway

Create a new material from system material.
Given a system material name, this function will create a new material based on this system
material. This function will return newly created material name and tag.

0 = Success
Standard UF Error Codes:
UF_err_program_not_initialized
UF_err_bad_parameter_number_1: studio_system_material_name is null pointer.
UF_err_part_not_loaded
UF_err_invalid_filename: invalid system material name to create system material.
UF_err_file_does_not_exist: can not found new created material's xml file.
UF_err_no_work_part: invalid work part.
NOTE: This function only used in iray+ mode(NX_RTS_IRAY is set to ON (1)).
The newly created material/texture are added to the current display part. So you need to open a part first.
You need to save the part to make sure the created material/texture attributes are saved with the part.

Internal and external

See example

This function is created for NX11.0.2
 

gateway

This is mainly called when existing from a 'task' environment (eg. Sketcher)
This causes the grid to be removed from display. In general, if switching
from one application to another this call is not necessary because the DSS
subsystem manages all this. However, in a task environment, existing the
environment doesn't always cause display regeneration. Therefore, it is a
good 'house keeping' practice to call this when another grid is expected to
be restored when existing from the current task environment.

product_context - either UF_DISP_SKETCH_GRID for sketcher application,
or UF_DISP_DRAWING_GRID for drawing,
or UF_DISP_SHED_GRID for True Shading display,
or UF_DISP_MODEL_GRID for others (or default).
restore_prev_context_grid - TRUE to assure a proper display regeneration
FALSE, if you don't care

Internal and External

UF_DISP_ask_grid_parameters
UF_DISP_set_grid_parameters
UF_DISP_activate_grid
UF_DISP_ask_current_grid_context

Originally released in V19.0
 

gateway

This function deletes the material specified by the material_tag.
This function supports deletion of both types of materials (Iray+ and Author).

Internal and external

See example

This function is created for NX3 QRM.
 

gateway

Displays a User Defined Object arc. The arc is drawn from the start
angle to the end angle in a counter clockwise manner. This routine
may only be called from a UDO registered callback routine. The
context argument passed into this routine will be passed from NX
to the UDO callback routine.

Internal and External

UF_UDOBJ_register_display_cb
UF_UDOBJ_register_fit_cb
UF_UDOBJ_register_attn_pt_cb
UF_UDOBJ_register_select_cb
 

gateway

Displays a User Defined Object circle which can be solid filled. This
routine may only be called from a UDO registered callback routine. The
context argument passed into this routine will be passed from NX
to the UDO callback routine.

Internal and External

UF_UDOBJ_register_display_cb
UF_UDOBJ_register_fit_cb
UF_UDOBJ_register_attn_pt_cb
UF_UDOBJ_register_select_cb
 

gateway

Displays User Defined Object facets. This routine may only be called from a
UDO registered callback routine. The context argument passed into this
routine will be passed from NX to the UDO callback routine.

Internal and External

UF_DISP_facet_p_t
UF_DISP_facet_type_t
UF_UDOBJ_register_display_cb
UF_UDOBJ_register_fit_cb
UF_UDOBJ_register_attn_pt_cb
UF_UDOBJ_register_select_cb
 

gateway

This function defines an arc to be rendered in the specified view. The
"ogp" in the name indicates that the arc will be drawn as an Overlay
Graphics primitive (please see the Overview to this section); as such, it
neither creates, nor is directly associated with, an NX object.
The arc is drawn in a positive angular direction ("counterclockwise")
from the start angle to the end angle.
The orientation matrix must be ortho-normal. (If necessary, use
UF_MTX3_initialize to create the matrix from X and Y vectors.)
This function returns an error if the absolute value of the difference
between the start and end angle is greater than two pi (plus the system
tolerance). An error is also returned if the start angle is greater than
the end angle.
UF_DISP_display_ogp_ functions are intended to be used
exclusively from motion callback functions. Please see the discussion
and example provided with UF_UI_specify_screen_position.

Internal and External

See example
 

gateway

This function defines a circle to be rendered in the specified view.
The "ogp" in the name indicates that the arc will be drawn as an
Overlay Graphics primitive (please see the Overview to this section); as
such, it neither creates, nor is directly associated with, an NX
object. The orientation matrix must be ortho-normal. (If necessary, use
UF_MTX3_initialize to create the matrix from X and Y vectors.)
UF_DISP_display_ogp_ functions are intended to be used
exclusively from motion callback functions. Please see the discussion
and example provided with UF_UI_specify_screen_position.

Internal and External

See example
 

gateway

This function defines a simple line to be rendered in the specified
view. The "ogp" in the name indicates that the line is drawn as an
Overlay Graphics primitive (please see the Overview to this section); as
such, it neither creates, nor is directly associated with, an NX
object. UF_DISP_display_ogp_ functions are intended to be used
exclusively from motion callback functions. Please see the discussion
and example provided with UF_UI_specify_screen_position.

Internal Only

See example
 

gateway

This function defines a polyline to be rendered in the specified view.
The "ogp" in the name indicates that the polyline will be drawn as an
Overlay Graphics primitive (please see the Overview to this section); as
such, it neither creates, nor is directly associated with, an NX
object. UF_DISP_display_ogp_ functions are intended to be used
exclusively from motion callback functions. Please see the discussion
and example provided with UF_UI_specify_screen_position.

Internal and External

See example
 

gateway

Displays User Defined Object points. This routine may only be called from
a UDO registered callback routine. The context argument passed into this
routine will be passed from NX to the UDO callback routine.

Internal and External

UF_DISP_poly_marker_t
UF_UDOBJ_register_display_cb
UF_UDOBJ_register_fit_cb
UF_UDOBJ_register_attn_pt_cb
UF_UDOBJ_register_select_cb
 

gateway

Displays a closed User Defined Object polygon and may be solid
filled. The polygon must be planar and convex when using the filled option.
This routine may only be called from a UDO registered callback routine.
The context argument passed into this routine will be passed from
NX to the UDO callback routine.
NOTE: A polygon is convex if a line joining any two interior
points of the polygon lies completely inside the polygon

Internal and External

UF_UDOBJ_register_display_cb
UF_UDOBJ_register_fit_cb
UF_UDOBJ_register_attn_pt_cb
UF_UDOBJ_register_select_cb
 

gateway

Displays a User Defined Object polyline which is a connected set of
line segments. This routine may only be called from a UDO registered
callback routine. The context argument passed into this routine will be
passed from NX to the UDO callback routine.

Internal and External

UF_UDOBJ_register_display_cb
UF_UDOBJ_register_fit_cb
UF_UDOBJ_register_attn_pt_cb
UF_UDOBJ_register_select_cb
 

gateway

Displays all or some rpo dimensions which belong to the specified
feature. The dimensions are specified indirectly by an array of
expression tags. If the count of the array is -1 then the array is
ignored and all rpo dimensions of the feature are displayed. If the
count is 0 then nothing is displayed. The display is temporary and can
be removed by a display refresh operation. The background color can
also be used to erase the dimensions but it may leave gaps on the
display. There must be a part loaded when this function is called. Any
specified expression which does not tie directly to a dimension of the
specified feature is considered invalid.

Internal
 

gateway

Displays all or some sketch dimensions which belong to a specified
sketch. The dimensions are specified indirectly by an array of
expression tags. If the count of the array is -1 then the array is
ignored and all dimensions of the sketch are displayed. If the count is
0 then nothing is displayed. The display is temporary and can be
removed by a display refresh operation. The background color can
also be used to erase the dimensions but it may leave gaps on the
display. There must be a part loaded when this function is called. Any
specified expression which does not tie directly to a dimension of the
specified feature is considered invalid.

Internal
 

gateway

Displays a temporary arc. A display refresh erases temporary
geometry. The start angle must be less than the end angle and the
absolute value of the difference must be less than two pi.

Internal

UF_OBJ_disp_props_t
UF_DISP_view_type_t
 

gateway

Displays a temporary line. A display refresh erases temporary geometry.

Internal

UF_OBJ_disp_props_t
UF_DISP_view_type_t
 

gateway

Displays a temporary marker. A display refresh erases temporary
geometry.

Internal

color constants
UF_OBJ_disp_props_t
UF_DISP_poly_marker_t
UF_DISP_view_type_t
 

gateway

Displays temporary text. A display refresh erases temporary text. The
text is entered in an array and each newline is specified by entering
the '\n' character in the text. The text must be null terminated.
The text is displayed parallel to the screen. The size of the text
is in the given size (or the system default size) on the screen, and
remains at the same size regardless of the view scale.

Internal

UF_OBJ_disp_props_t
color constants
UF_DISP_view_type_t

UF_DISP_text_ref_t

V18.0 Add comments.
 

gateway

Displays User Defined Object text which rotates with the view. The
text is entered in an array and each newline is specified by entering
the '\n' character in the text. The text must be null terminated. For
example, "Hello \n World!". This routine may only be called from a
UDO registered callback routine. The context argument passed into this
routine will be passed from NX to the UDO callback routine.
The text is drawn using the character size found in the Annotations
Preference dialog, under Lettering, General. This size may be changed
by UF_DRF_set_preferences, setting mpr[4] to the desired size.

Internal and External

UF_DISP_text_ref_t
UF_UDOBJ_register_display_cb
UF_UDOBJ_register_fit_cb
UF_UDOBJ_register_attn_pt_cb
UF_UDOBJ_register_select_cb
 

gateway

Creates a Windows Enhanced Metafile of the image in the
NX graphics window. This function is available only
on Windows NT. Calling it on any other platform will result
in an error being returned. There are options to export the
Enhanced Metafile to the clipboard or to a device context. This is
similar to exporting a plot file or a CGM file of the current display.
Any views which are in Shaded, Partially Shaded, or in Face Analysis
mode are treated as if they were in Wireframe mode.
The Enhanced Metafile will be created using part colors and a single
(standard thin) line width value.
The size of the image in the generated Enhanced Metafile is the same
as that of the current graphics window. Therefore, you may wish to
resize the graphics window to the desired size prior to invoking this
function. When in External mode, the size of the graphics window is
the size the last time the part was saved.
The output Enhanced Metafile does not include the Work Coordinate
System, the grid, nor any temporary display.
You can only use the UF_DISP_WMF_TO_CLIPBOARD option
when in Internal mode. If you use this option in External mode, this
function returns an error code.

Internal and External

Original release was in V14.0.
 

gateway

This function will free the memory allocated in UF_DISP_get_facet_data.

This function is created for NX11.0.1
 

gateway

The generated texture coords are of the form :
texture_coords[1], texture_coords[2], (vertex1)
texture_coords[3], texture_coords[4], (vertex2)
...
in which each vertex texture coordinate is represented by an
(s, t) coordinate.
NOTE: If texture coordinates cannot be generated (ex. texture space mapping is UV but no UVs are
available in the face_facet_data), the texture_coords output argument will be NULL. If it isn't NULL,
caller need to free the memory of texture_coords.

Internal and external

Refer to UF_DISP_face_facet_data_t

This function is created for NX11.0.1
 

gateway

Gets the current attribute settings with which the conehead vector
displays by a call to UF_DISP_conehead. You can then obtain the
values of the fields of the UF_DISP_conehead_attrb_s structure (see
the example below).

void

Internal

See example
 

gateway

This function will return the facet geometry data of specific object.
The returned facet data is consistant with the data using in Ray Traced Studio window.
NOTE: A call to UF_DISP_free_temp_facet_data() is necessary to free the facet data.

Internal and external

Refer to UF_DISP_face_facet_data_t

This function is created for NX11.0.1
 

gateway

Cleans up the data returned from UF_DISP_j3d_geometry

Internal and External

None

None
 

gateway

Creates polygon and vector data for the geometry of a part file.
The output polygon data is triangle strips for polygon data and
vectors for curves.

wireframe - a boolean value where if the value is 1, then solids
and sheets will be returned as wireframe vector data
for the edges of the body. If the value is 0, then
solids and sheets will be returned as triangle strip
polygon data.
num_entities - returns the number of elements in the entity_list
entitiy_list - An array of display data structures

Internal and External

None

None
 

gateway

Displays a temporary, labeled conehead vector with either the base of
the staff, the arrow tip or the base of the arrowhead at the reference
point in the specified view(s). A label will be placed at the cone's tip.

Internal

void
 

gateway

Downloads the color table to the graphics display, so that all geometry
displayed in the graphics window will now use the current contents of
the Color Table object (of the Display part); this is equivalent to
selecting Apply from the color palette dialog in interactive
NX. There must be a part loaded before calling this function.

Internal

Please see the example
 

gateway

Ensures that previously invoked display operations are complete.

Function UF_DISP_make_display_up_to_date should be called by
NX Open API programs that directly invoke Windows, MFC, or Motif
functions to display dialogs.This function may be also needed
when NX Open dialogs are used.

When NX Open functions perform display operations, the display
operations can be buffered. NX Open dialog logic ensures that
the buffered operations are completed at appropriate times. If
an NX Open API program bypasses NX Open dialog logic, the program
might need to explicitly invoke UF_DISP_make_display_up_to_date
to complete buffered operations. The function should be called
immediately before invoking Windows, MFC, or Motif functions to
display dialogs.

Zero is returned upon successful execution.
Any other return code indicates an error.

Internal

Originally released in V17.0.2
 

gateway

This function opens the Lightworks LWA archive material library specified by the input argument lwa_material_library_name

0 = Success
-1 = Failed to initialize Lightworks session_manager
-2 = Failed to open the specified lwa material archive library file
not -1,-2, 0 = Error code
Standard UF Error Codes
UF_err_program_not_initialized
UF_err_bad_parameter_number_1: problem found with lwa_archive_library_name , file does not exist.
UF_err_part_not_loaded: need to have an opened work part.
This function only supports Author based materials and libraries(lwa).

Internal and external

See example

This function is created for NX8.5.3
 

gateway

Prints the contents of the graphics window to the default printer.
This function is available only on Windows workstations and returns
an error if called on a non-Windows workstation.

Internal

Originally released in V16.0.
Second parameter redefined in V18.0.
 

gateway

Performs an entire display refresh.

void

Internal
 

gateway

Regenerates the display.

Internal
 

gateway

Regenerates the display of a single view . The view must be currently
displayed. If you specify an inactive view (i.e. a view on a layout or a
drawing which is not displayed), an error occurs. Use
UF_VIEW_ask_tag_of_view_name to find the view_tag.

Internal

UF_VIEW_ask_tag_of_view_name
 

gateway

This function applies "None" material to a geometry identified by the input object tag argument.
This removes all the material texture links to the object.
It does not remove the materials or textures from the part.

0 = Success
Standard UF Error Codes:
UF_err_program_not_initialized
UF_err_bad_parameter_number_1: problem found with object_tag
UF_err_part_not_loaded

This function aplies to materials of current renderer type.
This means if user is in Iray+ renderer mode, then only materials of Iray+ type will be removed.

Internal and external

See example

This function is created for NX8.5.3
 

gateway

Resets the conehead attributes to the default values.

void

Internal
 

gateway

Modifies the name and values of the specified color in the Color Table
object (CTO) of the Display part. The color values are given using
the specified color model.
Note that the maximum value permitted for clr_num is the number of
records presently in the CTO, minus 1. The number of CTO records
may be obtained by calling UF_DISP_ask_color_count. There must be
a part loaded when this function is called.

Internal and External

See example
 

gateway

Allows changes to the current attribute settings with which the
conehead vector displays by a call to UF_DISP_conehead.
Note that it is best to get the current attribute settings and then
adjust the ones you need, as shown in the example.

void

Internal

See example
 

gateway

Sets the display status. You can use UF_DISP_set_display to turn
off the graphics display before executing a long series of graphics
intensive operations such as manipulations of views, layouts, or
drawings. You must call UF_DISP_regenerate_display to update the
display after turning it back on.
Note that there are limitations to this function in conjunction with
layout and drawing changes. If you open a layout or drawing, the
display will change to show the outlines of the views in the layout
or drawing, even though the suppress state is enabled; the contents
of the views will not be shown however.

Internal
 

gateway

Update the data that affects drawing monochrome display.
The routine UF_DISP_ask_drawing_display MUST be called to
populate the data structure, before this routine is called.

Please reference ufd_disp.c to review a sample execution of this function.

UF_err_program_not_initialized, UF_err_bad_parameter_number_1

Internal and External

UF_DISP_drawing_display_data_t

None
 

gateway

Sets up the information for the grid in the designated application
context. Any field not set will have a default value provided.

product_context - either UF_DISP_SKETCH_GRID for sketcher application,
or UF_DISP_DRAWING_GRID for drawing,
or UF_DISP_SHED_GRID for True Shading display,
or UF_DISP_MODEL_GRID for others (or default).

Internal and External

UF_DISP_ask_grid_parameters
UF_DISP_activate_grid
UF_DISP_deactivate_grid
UF_DISP_ask_current_grid_context

Originally released in V19.0
 

gateway

Turns object/feature highlight on or off.

Internal
 

gateway

Turns object/feature highlight on or off.

Internal

This function was first released in NX 7.5.5
 

gateway

Stores the given model bounds into the one and only model bounds
object for the work part. The given tag must be that of the model
bounds object.
NOTE: This function is of limited value for most NX Open API
application developers. It is intended to be used by certain NX
applications such as translators.

Internal and External
 

gateway

Sets the name display status for objects. Names are created with
UF_OBJ_set_name, and the location where they are displayed is set with
UF_OBJ_set_name_origin.

Internal and External

UF_OBJ_set_name
UF_OBJ_set_name_origin
 

gateway

Sets the name display view status. The constant
UF_DISP_NAMES_IN_VIEW_OF_DEFN is the view which is the work
view when the object is defined.

Internal and External
 

gateway

Sets the face analysis display parameters. This routine uses a pointer
to the structure UF_DISP_srfanl_data_s.

Internal

UF_DISP_srfanl_data_t
 

gateway

Sets new system display parameters. This routine uses a pointer to the
structure.
UF_DISP_system_params_p_t

To access parameters related to shaded face edges, please use
UF_VIEW_set_shaded_edge_options
instead.

Internal and External

V12.0 light_source_angles field removed from the structure
V13.0 Added show_shaded_face_edges and hidden_shaded_face_edges
to the structure
V19.0 Added fields use_face_edges_color
face_edges_color
hidden_geometry_color
random_color_displayed
random_color_object_type
 

gateway

This function allows user to set new texture space information of the material.
This function only supports Author based materials.

Internal and External

See example

This function is created for NX3 QRM.
 

gateway

Sets work plane emphasis on or off. When work plane emphasis is on,
objects that do not lie on the work plane appear de-emphasized, in
which the object color is blended with the De-emphasis Blend Color
according to the De-emphasis Blend Percentage. A de-emphasized object
is unselectable unless the work plane emphasis selection filter is
overridden. Work plane emphasis is a session dependent value; it is
not saved with any part.

Internal and External

UF_DISP_ask_work_plane_emphasis
UF_DISP_ask_work_plane_sel
UF_DISP_set_work_plane_sel

Original release was in V13.0.
 

gateway

Sets (or unsets) the work plane emphasis selection override.
When work plane emphasis is enabled and the selection override is
set to UF_DISP_SELECT_WORK_DIMMED, no objects are filtered
out of selection because they are off the work plane.
When work plane emphasis is enabled and the selection override is
set to UF_DISP_NO_SELECT_WORK_DIMMED, no objects
dimmed for work plane emphasis are selectable.
When work plane emphasis is disabled, the selection override setting
has no affect although it can be changed. The selection override
setting takes effect once work plane emphasis is enabled.
The work plane emphasis selection override is a session dependent
value; it is not saved with any part.

Internal and External

UF_DISP_ask_work_plane_emphasis
UF_DISP_set_work_plane_emphasis
UF_DISP_ask_work_plane_sel

Original release was in V13.0.
 

gateway

This function updates the display of the given geometry objects
in Studio rendering style.

The display of UF_solid_type, UF_solid_face_subtype and UF_faceted_model_type
are updated. All other object types are ignored.

This function supports materials update of current renderer type.

Internal

See example

This function is created for NX7.5.2 QRM.
 

gateway