Obtain the key in of a text string.

Internal

1 = Back
2 = Cancel
3 = OK (Accept default )
5 = Data entered
8 = Disallowed state, unable to bring up dialog
 

gateway

Display a message box and wait for acknowledgement, if desired
A maximum of 132 characters can be displayed in cp1. An asterisk
may be used to indicate where cp1 should be split to continue on
another line when displaying to a message box. If you use an asterisk
when displaying to the Status Line, the asterisk is replaced by a hyphen.

Please avoid using format escape sequences in the cp1
character string. For example, the newline escape sequence (\n) can
cause an undesirable shift in the displayed text.

Internal
 

gateway

This routine displays a selection menu list box. You can have a
maximum of 14 menu items in the list box. You can specify any one
of the list items to be the default by setting the value of parameter
ip2 to the desired list item. If you do not want a default list item, set
ip2 = 0 and the OK button will be greyed out. If you want menu list
item number 5 to be the default, then set ip2 = 5. Then menu item
response values start at 5 and end at 18. If you choose menu item 1,
then 5 is returned. If you select menu item 14, then 18 is returned.

Internal

1 = Back
2 = Cancel Operation
5-18 = The given menu item was selected
19 = Disallowed state, unable to bring up dialog
 

gateway

Multiple selection menu
In internal mode, no defaults are set, and ia6 is initialized to zero.
Selecting numeric keypad #I sets ia6[I] to 1. Pressing Back exits the menu.

Internal

1 = Back
2 = Cancel Operation
3 = OK
4 = Alternate Action
8 = Disallowed state, unable to bring up dialog
 

gateway

Display keyboard entry menu and gets the integer response.

Internal

1 = Back
2 = Cancel Operation
3 = OK - No user input
4 = OK with user input
8 = Disallowed state, unable to bring up dialog
 

gateway

Display a keyboard entry menu and obtain integer or real data.

This routine displays an entry menu with integers and reals. The two
arrays ia4[ip3] and ra5[ip3] are initialized with the default
parameters that you specify. Both of these arrays as well as array
ip6[ip3] and cp2[ip3][16] must be dimensioned to ip3. For example, if
you decide to use the maximum of 14 parameter values you would
dimension ia4[14], ra5[14], ip6[14], and cp2[14][16].

The array values of ip6[ip3] determine which menu entries are
doubles and which are integers. For example if you set ip6[7] = 1, you
are specifying the 8th menu entry to be double. This also means that
the eighth value of ra5 (ra5[7]) is used as the default value. The index
array value of ip6 maps to the index array values of ia4 and ra5
depending on whether you use an initial integer or double parameter
value. For example, if you specify four integers and then one double
you will get ra[4] as your first double, not ra[0].
The entry menu values always maintain the data type (double or int)
of the initialized default values. Therefore, if you enter a double value
into the entry menu where an integer was the default, the double is
converted to an integer by truncating the decimal portion of the
double. Similiarly, if you enter an integer where the default was a
double, the integer is converted to a double.

Note: If a real number containing more than 12 decimal places is
passed into this function, the underlying code will truncate it to
12 decimal places. This will then pass back a return a value of
4 (OK with user input) instead of the expected 3 (OK - No user input).
By truncating your real parameter to 12 or less decimal places before
calling this function, it will work as expected.

Internal

1 = Back
2 = Cancel Operation
3 = OK - No user input
4 = OK with user input
8 = Disallowed state, unable to bring up dialog
 

gateway

Display keyboard entry menu and obtain a real response.

Note: If a real number containing more than 12 decimal places is
passed into this function, the underlying code will truncate it to
12 decimal places. This will then pass back a return a value of
4 (OK with user input) instead of the expected 3 (OK - No user input).
By truncating your real parameter to 12 or less decimal places before
calling this function, it will work as expected.

Internal

1 = Back
2 = Cancel Operation
3 = OK - No user input
4 = OK with user input
8 = Disallowed state, unable to bring up dialog
 

gateway

Display keyboard entry menu and obtain an integer, real or string
in response.

The displayed parameters can be any combination of integer, real, or
string values. The type of variable used for displaying the parameter
values are user input in array ip7.

Note: If a real number containing more than 12 decimal places is
passed into this function, the underlying code will truncate it to
12 decimal places. This will then pass back a return a value of
4 (OK with user input) instead of the expected 3 (OK - No user input).
By truncating your real parameter to 12 or less decimal places before
calling this function, it will work as expected.

Internal

1 = Back
2 = Cancel Operation
3 = OK - No user input
4 = OK with user input
8 = Disallowed state, unable to bring up dialog
 

gateway

Display the user message (cue) and returns a screen
position point in parameter point (X,Y,Z) on the WCS plane in
Absolute Coordinates of the Displayed Part. A typical user message
might be "Pick a point."

Response Returned
1 = Back
2 = Cancel
5 = Position Returned
7 = No Active Part
8 = Disallowed state, unable to bring up dialog

Internal
 

gateway

Display a user message and return a point from the Point
Subfunction in Absolute Coordinates of the current Work Part.

The returned coordinates are always relative to the current work view.

Response Returned
1 = Back
2 = Cancel
5 = Position Returned
7 = No Active Part
8 = Disallowed state, unable to bring up dialog

Internal

The ia2[0] parameter was modified in V13.0 to
return a value of 12 for a quadrant point.
 

gateway

uc1617 object select with class selection menu
Use UF_UI_select_with_class_dialog instead.
 

gateway

uc1618 simple object select. Use UF_UI_select_with_single_dialog instead.
 

gateway

Interactively choose a CSYS. Though 40 characters are allowed in the title,
it should be noted that the first option (ORIGIN,X-PT,Y-PT) appends the point
number (PT1, PT2, and PT3) on the end of the message. Thus, only 36
characters are effectively allowed.

Users Response
1 = Back
2 = Cancel
3 = OK
7 = No Active Part
8 = Disallowed state, unable to bring up dialog

Internal
 

gateway

Selects a view.
For modeling views only. If the current layout is a drafting layout,
the dialog will not come up and the return code will be 8.

Return Code
0 = OK, View Selected
1 = Back
2 = Cancel
3 = OK, No View Selected
8 = Disallowed state, unable to bring up dialog

Internal
 

gateway

Returns the name of view in which the last screen pick occurred
(either Interactive NX or Internal Open C API - uc1615, uc1616,
uc1617, uc1618 or GRIP). If the view of the last position indication
was removed from the current layout, the work view is returned.
Using the matrix from the view (uc6433 - Read View Matrix) can
help the determine which end of a curve was picked, etc.

Internal
 

gateway

Adds the friendly name associated with the class name of a User
Defined Object (UDO) to the Type list of the class selection dialog.
The class becomes selectable.

Internal and External

UF_UI_delete_from_class_sel
 

gateway

Add objects to the selection list.

Any objects already in the selection list are ignored.
You can use this function with UIStyler dialogs and with the
UF_UI_select_with_class_dialog function. You can call
UF_UI_add_to_sel_list from the constructor callback/selection
initialization procedure to begin the dialog with objects already
selected. The user can then review these objects, and if desired,
deselect them.

The application selection callback can also call this function to add
other objects to the selection list based on the objects(s) just selected.
The selection filter procedure cannot call this function. You cannot
use this function with UF_UI_select_with_single_dialog.
Based on the object(s) just selected, other objects may need to be
selected. For example, all edges of the selected face or all faces
tangent to the selected face.

Internal

Original release was in V13.0.
 

gateway

Allows selection of features belonging to any fully loaded part. By default,
only features belonging to the Work Part are selectable.

For UIStyler dialogs, this function should be called from the initialize_cb.

For use with UF_UI_select_with_class_dialog or UF_UI_select_with_single_dialog,
this function should be called from the init_proc (UF_UI_sel_init_fn_t).

Note that features not belonging to the Work Part can be queried, but should
not be edited in any way.

Internal
 

gateway

Appends a menu item to the NX menu bar. Once a menu is
defined as an array of UF_UI_menubar_item_t, the custom
application should call UF_UI_append_menubar_menu() from the
user exit ufsta().

Once this routine is called, an Open C API license is captured and
not released until NX is exited.

A program which uses UF_UI_append_menubar_menu should not
use the option to unload an Open C API image. Additionally, if
your code which defines UF_UI_append_menubar_menu itself
loads a shared library, this code should not attempt to unload the
library. NX always makes a strong attempt to prevent
unloading a library which was loaded by using UF_UI_append_menubar_menu.

The USER_STARTUP (ufsta) user_exit was developed exclusively
to work in conjunction with UF_UI_append_menubar_menu to
define menus. If you use this routine it must be called early (i.e.
prior to complete initialization of NX).

This requirement makes the use of the USER_STARTUP exit
inappropriate for any purpose other than calling
UF_UI_append_to_menubar. In particular, running a GRIP
program, opening a part file, etc. from the shared library pointed to
by the USER_STARTUP environment variable does not work
because NX initialization has not yet completed at the
time this library is loaded.

NOTE: This function is only available on Unix. Please look at
menuscript for this functionality on Windows.

Internal
 

gateway

Displays the File-->New File Selection Dialog.

Internal

UF_UI_ugmgr_ask_create_part_file_name
 

gateway

Reads the current mask for selection within views. Object selection can
be made in the work view on a drawing layout only or any view, and this
routine returns the current value.

In drafting, the default is the work view so use UF_UI_set_cursor_view
if you want to select in any view.

Internal

UF_UI_set_cursor_view
 

gateway

Reads the directory path of a given dialog.

Internal

UF_UI_dialog_dir_id_t
 

gateway

Reads the filter extension of the current dialog.

Internal

UF_UI_dialog_dir_id_t
 

gateway

This function will ask for the objects that are on the global selection list

Internal

Added in NX2
 

gateway

Inquires what units the user would like information displayed in.
These are the units used to display results in the Info functions.
The units are only used for displaying results in Info and do not
necessarily correspond to the part units or the units used in other
Open C API functions.

Internal and External

Refer to the example
 

gateway

Inquires the information window (listing window) real number display
preference and number of decimal places to display.

UF_UI_SYSTEM_DECIMAL_PLACES means the user has
requested the system precision to be used for formatting real numbers
for the information window. In this case, the number of decimal
places varies based on each real value, such that the sum of the
number of places before and after the decimal point equals the
number of significant digits of double precision floating point accuracy
that can be represented on the client machine. The decimal_places
parameter should not be used when this mode is set.

UF_UI_USER_DECIMAL_PLACES means the user has asked for a
specific number of decimal places. The decimal_places parameter is
only valid with this mode.

Internal and External

Refer to the example
 

gateway

Query NX lock status.

This function is useful when dismissing a custom dialog and you want
to determine whether or not a lock has been set. If a lock has been set
then you know you need to call UF_UI_cancel_uf_dialog in order to
cancel the currently displayed Open dialog or UIStyler dialog.

NOTE: If an NX's owned DA2 is currently displayed when this
check is done then UF_UI_ask_lock_status returns UF_UI_LOCK.
When your custom application attempts to cancel this dialog,
UF_UI_cancel_uf_dialog returns an error. This failure does not cause
any problems, and you should continue using this method in order to
cancel any potential Open dialogs that are currently displayed.

UF_UI_LOCK when NX is in lock status.
UF_UI_UNLOCK when NX is in unlock status.

Internal

Refer to the example
Refer to the example
 

gateway

This function return information if NX graphics window special minimal mode is on or off

Privileged

Added in NX7.5.2
 

gateway

Displays the File-->Open File Selection Dialog.

Internal

NX1 - "use_disp_file" parameter is obsolete; left in interface
for forward compatibility and changed name to "unused"
 

gateway

This routine returns the current visibility of the given ribbon tab. This function
only applies to ribbon tabs; for groups, galleries, cascades, and dropdowns the
result is undefined.

Internal

UF_UI_set_ribbon_vis
UF_UI_create_ribbon

Originally released in NX9.0
 

gateway

Returns the view and absolute coordinates of the cursor position for
the associated selection.

If an object was selected, the view returned is the view in which the
object was selected. For single position, the view is the view of the
cursor.

If the object was selected by name, view = NULL_TAG and the
cursor position are undefined.

Internal

Original release was in V13.0.
 

gateway

Returns a bitmask of information describing the selection that was just
performed.

The valid bits which can be examined are defined in this header file.
UF_UI_SEL_DESC_SELECTION
UF_UI_SEL_DESC_DESELECTION
UF_UI_SEL_RESELECTION
UF_UI_SEL_DESC_SINGLE
UF_UI_SEL_DESC_MULTIPLE
UF_UI_SEL_DESC_SINGLE_POSITION
UF_UI_SEL_DESC_RECTANGLE_POSITION
UF_UI_SEL_DESC_NAME_SELECTION
UF_UI_SEL_DESC_RECTANGLE

Multiple bits may be set. For example, for a rectangle deselection, the
DESELECTION, MULTIPLE, and RECTANGLE bits would be set.

For a name selection which selected one object, the SELECTION,
SINGLE, and NAME_SELECTION bits would be set.

If a reselect was done (an object is selected and the previous object
selected is deselected), only the RESELECTION bit is set.

The SINGLE and MULTIPLE bits are not set for position.

The RECTANGLE bit is set for rectangle selection, rectangle
deselection, and rectangle position.

You use this function with UIStyler dialogs and
UF_UI_select_by_class and can be called from either the selection
filter procedure or the selection callback.

Internal

Original release was in V13.0.
 

gateway

Returns the number of objects currently selected.
You can use this function with UIStyler dialogs and with
UF_UI_select_with_class_dialog.

Internal

UF_UI_remove_from_sel_list

Original release was in V13.0.
 

gateway

Returns the number of objects selected and a pointer to an array of
tags of the objects selected.

You can use this function with the UIStyler dialogs and with
UF_UI_select_with_class_dialog.

Internal

UF_UI_remove_from_sel_list

Original release was in V13.0.
 

gateway

Returns the absolute coordinates of the rectangle cursor positions.

The view that returns is the view of the button down position.
button down position - is the position where you press and hold mouse button 1.
button up position - is the position where you release mouse button 1.

Pos1 and Pos2 are the absolute coordinates of the button down and
button up positions respectively. Pos3 is the absolute coordinates of
the rectangle corner which, as viewed on the screen, is horizontal with
pos1. Pos4 is the absolute coordinates of the rectangle corner which,
as viewed on the screen, is horizontal with pos2.

Returns an error if the last gesture was not rectangle.

Internal

Original release was in V13.0.
 

gateway

This routine returns the current visibility of the given toolbar.

Internal

UF_UI_set_toolbar_vis
UF_UI_create_toolbar

Originally released in V16.0
 

gateway

Cancels the existing custom application dialog area 2 by sending a
cancel message.

UF_UI_SUCCESS when dialog area 2 is cancelled successfully or there
is not DA2 displayed

UF_UI_FAILURE when dialog area 2 is not cancelled.

Dialog area 2 is not cancelled when the current dialog area 2 is not
an interactive Open C API dialog.

The custom application can only bring up a new interactive Open C
API dialog when UF_UI_cancel_uf_dialog returns a
UF_UI_SUCCESS. The new interactive Open C API must be
brought up with an XtAppAddTimeOut call. Failure to follow the
above guideline can give unpredictable results.

Use UF_UI_cancel_uf_dialog for action buttons which are always
available and that call interactive Open C API (i.e. the action
button is not greyed out or ungreyed in the custom supplied state
change function).

Internal

Refer to the example
 

gateway

Closes the listing window. If in internal Open API, the window is
closed. If in external Open API, then the device is set to closed.

Internal and External

UF_UI_exit_listing_window

For V15.0, this function was modified so that it closes the window but
does not clear the windows contents. Prior to V15.0, this function
closed and cleared the window in Internal Open API.
 

gateway

Create an File Selection Box dialog.

Internal
 

gateway

This will creates a File Selection Box dialog which also supports multiple file selection filters.

0 = No error
!= 0 = Error code

Internal
 

gateway

Creates a part and makes it the work part using the File-->New File
Selection Dialog.

Note: This function will not work when using TCIN (NXManager). To create a new
part for for that mode, call UF_UI_ugmgr_ask_create_part_name followed by
UF_UGMGR_new_part_from_template.

Internal
 

gateway

Creates a ribbon from the given .rtb/.gly/.grb file. The file name should not have
any hard coded path and should exist in one of the Open application
directories. The show parameter is only used to show or hide the ribbon
when it is loaded for the first time. On all subsequent loads, the show/hide
value as recorded in the users registry is used.

In order to be successfully loaded, the .rtb/.gly/.grb file must be located in the
application subdirectory of one of the directories listed in the file
pointed to by UGII_CUSTOM_DIRECTORY_FILE, which defaults to
$UGII_BASE_DIR/ugii/menus/custom_dirs.dat.

Example:
UF_UI_ribbon_id_t id = NULL;

error = UF_UI_create_ribbon("my.rtb", 1, &id);

Internal

UF_UI_remove_ribbon

Originally released in NX9.0
 

gateway

Creates a toolbar from the given .tbr file. The file name should not have
any hard coded path and should exist in one of the Open application
directories. The show parameter is only used to show or hide the toolbar
when it is loaded for the first time. On all subsequent loads, the show/hide
value as recorded in the users registry is used.

In order to be successfully loaded, the .tbr file must be located in the
application subdirectory of one of the directories listed in the file
pointed to by UGII_CUSTOM_DIRECTORY_FILE, which defaults to
$UGII_BASE_DIR/ugii/menus/custom_dirs.dat.

Example:
UF_UI_toolbar_id_t id = NULL;

error = UF_UI_create_toolbar("my.tbr", 1, &id);

Internal

UF_UI_remove_toolbar

Originally released in V16.0
 

gateway

Loads a User Tool dialog. This function replaces previously loaded definitions.
Information on user tools can be found in the NX documentation under
System administration -> Customizing the NX installation.

Internal

Refer to the example
 

gateway

Removes the friendly name associated with the class name of a User
Defined Object (UDO) from the Type list of the class selection dialog.
The class becomes nonselectable.

Internal

UF_UI_add_to_class_sel
 

gateway

Quick Access Menus, provides for enabling global functions and special
functions in many instances where they were previously greyed out.
This is done by
providing an automatic cancel feature when these menu items are chosen.
The two most common cases are:
- with a special function dialog open, Quick Access Menus will allow
a different special function to be chosen. The original special
function is canceled and replace by the new one.
- With a tool palette open in DA1 and one of its dialogs in DA2,
you can now choose another tool palette or global function from the
menubar. The DA2 will be canceled, and the DA1 wll be replaced by the
the new DA1.

The Quick Access Menus feature may not work correctly with some
applications written that directly use Motif dialogs, use certain
User Function dialogs or which provide a confirmation step when
a dialog is canceled.

To disable Quick Access Menus in your application, call
UF_UI_disable_quick_access in your application's enter routine
and UF_UI_enable_quick_access in your application's exit
routine.

Internal

V12
 

gateway

Dismisses the interactive Open C API dialog after you select
cancel.

You use this routine after a call to any Open C dialog if it is not wrappered
with UF_UI_lock_ug_access and UF_UI_unlock_ug_access. This call guarantees that
the Open dialog is dismissed when the user select's one of its navigation
buttons.

Calling this function after an Open dialog has been displayed when it is not
needed should not cause any negative side affects.

This function is not needed after a UIStyler dialog has been displayed.
Below is an example of UF_UI_dismiss_dialog_area_2. This creates a
custom dialog via UF_UI_run_dialog that only has a pulldown item in
it called File. File has two pulldown items: Selection and Quit. The
Selection item launches UF_UI_select_by_class. The lock wrappers
are used to wrapper the start of the custom dialog and the end.
Because of this location of the lock wrappers it is necessary to call
UF_UI_dismiss_dialog_area_2.

This function

UF_UI_SUCCESS when dialog area 2 is dismissed successfully.
UF_UI_FAILURE when dialog area 2 is not dismissed. Dialog
area 2 is not dismissed when the current dialog area 2 is not
an interactive Open C API dialog or there is no DA2 displayed.

Internal

Refer to the example
 

gateway

Displays a nonmodal Message Dialog with an OK button. A message
box displays with the character string inputted through the message
argument. The character string message is written to the syslog. You
can call this routine multiple times to display more than one message
dialog. While the message dialog displays, your Open C API
program continues to execute. You can dismiss the dialog box by
clicking the OK button only after your program finishes its execution.

Internal

Refer to the example
 

gateway

Displays the specified URL in the NX internal web browser if it is available,
or otherwise in the user's defined default web browser.

Internal

Originally added in v19.0
 

gateway

Displays the specified URL in the NX internal web browser, bringing it to the
front if it is available. Otherwise displays in the user's defined default
web browser.

Internal

Originally added in NX 8.5
 

gateway

Displays or removes the specified User Tool dialog from the screen.
The only valid tool_num is 0. Closes and clears the listing window.

Internal

UF_UI_close_listing_window
Refer to the example

This function was originally released in V15.0.
 

gateway

Quick Access Menus, provides for enabling global functions and special functions
in many instances where they were previously greyed out. This is done by
providing an automatic cancel feature when these menu items are chosen.
The two most common cases are:
- with a special function dialog open, Quick Access Menus will allow
a different special function to be chosen. The original special
function is canceled and replace by the new one.
- With a tool palette open in DA1 and one of its dialogs in DA2,
you can now choose another tool palette or global function from the
menubar. The DA2 will be canceled, and the DA1 wll be replaced by the
the new DA1.

The Quick Access Menus feature may not work correctly with some
applications written that directly use Motif dialogs, use certain
User Function dialogs or which provide a confirmation step when
a dialog is canceled.

To disable Quick Access Menus in your application, call
UF_UI_disable_quick_access in your application's enter routine
and UF_UI_enable_quick_access in your application's exit
routine.

Internal

V12
 

gateway

Closes and clears the listing window. If in internal Open API,
the window is closed and cleared. If in external Open API, the
device is set to closed.

Internal and External

UF_UI_close_listing_window

This function was originally released in V15.0.
 

gateway

Retrieves the coordinates of the Dialog Area 1 window.

This function retrieves the current position of DA1.
Therefore, if the user has moved the DA1 dialog then these new
coordinates are the ones retrieved.

Internal

Refer to the example
 

gateway

Retrieves the coordinates of the Dialog Area 2 window. This API
returns UF_UI_SUCCESS if everything goes fine, otherwise, use
UF_get_fail_message to determine the exact cause of the failure.
NOTE: This function retrieves the current position of DA2.
Therefore, if the user has moved the DA2 dialog then these new
coordinates are the ones retrieved.

Internal

Refer to the example
 

gateway

Retrieves the window to be used as the parent of any user defined dialogs in
NX. This way the user defined dialog physically behaves as though
it is one of NX's dialog. For example it is not able to hide behind
the graphics window and it iconifies when NX is iconified.

This routine returns a void pointer which is the
Window to be used as the parent of user defined dialogs.
On Unix you must type cast this to a Widget. On NT you
must type cast this to an HWND.

Internal

This is a code fragment showing the essence of how to use this function on Unix.
 

gateway

Initialize the attachments structure.

Internal

Originally added in v19.0
 

gateway

Queries whether the Information window is open or closed. This
function returns a value of FALSE if the Information window:
has never been opened, has been closed with File-->Exit, File-->Close,
has been closed by a call to UF_UI_close_listing_window or by selecting
the Information button.

Internal and External
 

gateway

Inquires if object is selected.
You use this function with dialogs created with the UIStyler and with
the UF_UI_select_with_class_dialog function.

Internal

UF_UI_remove_from_sel_list

Original release was in V13.0.
 

gateway

Inhibits access to NX dialog area 1 and the appropriate
menu items before an Interactive Open C API dialog is brought up.
Both the menubar and the dialog area 1 are greyed out during the
lock. UF_UI_lock_ug_access

UF_UI_LOCK_EXISTS when dialog area 1 and the NX menu bar
is already inhibited.

UF_UI_LOCK_SET when dialog area 1 and the NX menu bar is
inhibited successfully.

UF_UI_LOCK_ERROR when another application or NX owns the DA2

It is very important to always check your return status of
UF_UI_lock_ug_access. If it is not UF_UI_LOCK_SET then you do
not want to continue with attempting to bring up a dialog. You should
also only call UF_UI_unlock_ug_access when a successful lock has
been made.

UF_UI_lock_ug_access() and UF_UI_unlock_ug_access() must be
used to surround a sequence of one or more Interactive Open C
API calls, when called from a custom dialog.

NOTE: This function does not have to be used by any UIStyler dialogs
that launch other type of Presentation APIs.

See the return values in the description section.

Internal

Refer to the example
 

gateway

This routine will display a modal message dialog which supports the following
dialog types: Question, Information, Error and Warning.

Multiple strings may be provided using message and num_messages. These strings
will be placed on individual lines within the dialog.

If the buttons argument is set to NULL, the dialog will display the OK button
only. Otherwise, you may customize the label and the return value of
at most 3 buttons on the dialog. Note that return values must be within the range
of 1 thru 100.

The translate flag will attempt to locate the strings within the NX Native
Language Database. If it cannot locate the string, it will simply display
the provided string.

0 = No error
not 0 = Error code

Internal

Originally released in v18.0
 

gateway

Opens and manages (displays) a motif style Information
window if in internal Open API mode. The first time
this window is opened it will be empty. Further calls will
display the information previously displayed in the window.
If in external Open API mode, sets the listing window
flag to open.

Internal and External
 

gateway

Opens a part and makes it the work part using the File-->Open File
Selection Dialog.

Internal

Refer to the example

NX1 - "use_disp_file" parameter is obsolete; left in interface
for forward compatibility and changed name to "unused"
 

gateway

Main entry point for the associative point constructor dialog.
Creates an associative point in the work part and returns the point and coordinates of the
point in terms of the absolute work part coordinate system.

The dialog will create a non-associative point in certain cases, depending upon the setting
of the Reference menu in the Coordinates area of the dialog:

- If the Reference menu is set to WCS or Absolute Display Part and the work part is different
from the display part and coordinates are typed into the Coordinates input fields,
a non-associative point will be created.

- If the Reference menu is set to WCS or Absolute Display Part and the work part is different
from the display part and offsets are typed into any of the Offset input fields,
a non-associative point will be created.

Internal

uc1616
UF_SO_set_visibility_option

Originally added in v19.0
 

gateway

Registers or unregisters the state change callback for a persistent
dialog. Your state change callback can manage the greying and
ungreying of the action buttons in its persistent Motif dialogs. Call
UF_UI_register_state_fn with the address of the change state callback
registers the function. Calling UF_UI_register_state_fn with a NULL
first argument unregisters the state change callback. NX
activates the registered state change function at the appropriate times
to grey or ungrey the custom persistent action button. You must
unregister your change state function when your custom dialog is
exiting.

NOTE: A state change is the locking and unlocking of NX
main menu bar. If you are in your own custom application that has
launched an Open dialog and the user goes into an all purpose
function dialog (such as Layer-->Settings or Info-->Object), then this is
still considered a lock state so the function in
UF_UI_register_change_state_fn does not get called.

Returns one of the following values:
UF_UI_FAILURE = failure
UF_UI_SUCCESS = success

Internal

Refer to the example
 

gateway

Removes all the objects from the selection list and optionally
unhighlights them.

You use this function with dialogs created with the UIStyler and with
the UF_UI_select_with_class_dialog function.

Internal

Original release was in V13.0.
 

gateway

Removes objects from the selection list.

This function is to be used with dialogs created with the UIStyler and
with the UF_UI_select_with_class_dialog function. It can be called
from the selection callback. It cannot be called from the selection
filter procedure.

If any of the objects are not in the list, an error is returned and NO
objects are removed from the list.

It could be called by the selection callback to remove
objects from the selection list. For example, based on objects just
deselected, the application may need to remove other associated
objects from the selection list.

Internal

Refer to the example

Original release was in V13.0.
 

gateway

Removes the ribbon with the given id. Once the ribbon is removed the ribbon
id should not be used.

Example:

if (id)
UF_UI_remove_ribbon(id);
id = NULL;

Internal

UF_UI_create_ribbon

Originally released in NX9.0
 

gateway

Removes the toolbar with the given id. Once the toolbar is removed the toolbar
id should not be used.

Example:

if (id)
UF_UI_remove_toolbar(id);
id = NULL;

Internal

UF_UI_create_toolbar

Originally released in V16.0
 

gateway

This routine must be used to wrapper the creation of multiple toolbars.
The use of this function helps with the positioning of the toolbars when
they are docked.

Example:

UF_UI_suspend_create_toolbar();
UF_UI_create_toolbar("file1.tbr",1, &id1);
UF_UI_create_toolbar("file2.tbr",1, &id2);
UF_UI_create_toolbar("file3.tbr",1, &id3);
UF_UI_resume_create_toolbar();

Internal

UF_UI_suspend_create_toolbar

Originally released in V16.0
 

gateway

This routine must be used to wrapper the creation of multiple toolbars.
The use of this function helps with the positioning of the toolbars when
they are docked. It restore toolbar state for current application.

Example:

UF_UI_suspend_init_appstate();
UF_UI_create_toolbar("file1.tbr",1, &id1);
UF_UI_create_toolbar("file2.tbr",1, &id2);
UF_UI_create_toolbar("file3.tbr",1, &id3);
UF_UI_resume_init_appstate();

Internal

UF_UI_suspend_init_appstate

Originally released in V18.0
 

gateway

This routine must be used to wrapper the removing of multiple toolbars.
The use of this function helps with the correct recording of the positions
of the docked toolbars in the registry.

Example:

UF_UI_suspend_remove_toolbar();
if (id1) UF_UI_remove_toolbar(id1);
if (id2) UF_UI_remove_toolbar(id2);
if (id3) UF_UI_remove_toolbar(id3);
UF_UI_resume_remove_toolbar();

id1 = NULL;
id2 = NULL;
id3 = NULL;

Internal

UF_UI_suspend_remove_toolbar

Originally released in V16.0
 

gateway

Execute Routing callback functions(internal\external) on passed in objects.

There must be an active part for this function to be called.

Internal

Original release was in NX404 IP2 MP4
 

gateway

Saves the contents of the Information window to the file specified by
the argument.

Note: The saved listing window information is limited to 256 characters
per line. If a line is longer than 256 characters, it will be wrapped to
multiple lines in the saved file.

Internal and External
 

gateway

NOTE: This function is to be obsoleted in the near future. Please use
the replacement function UF_UI_select_with_class_dialog
Selects multiple objects.

Internal

Refer to the example
UF_UI_selection_options_t
 

gateway

Displays the given coneheads and allows the user to select one of
them. The coneheads are described using the standard conehead attributes.
Each conehead has a selection point. The location of the selection
point is set by the input parameter selection_point. The user is then
prompted for a screen location, and the conehead whose selection
point is closest, is returned to the caller.

The selection_point parameter may be any value in the range 0.0 to
1.0. A value of 0.0 sets the selection point to the base of each
conehead. 1.0 sets the selection point to the tips.

The display_coneheads flag determines if, all the coneheads, none of
the coneheads, or just the selected conehead, is left displayed when
the function ends. The selected coneheads selection point is marked
with a small circle.

The user can choose Back or Cancel without selecting a conehead.
UF_DISP_set_conehead_attrb describes how to set conehead attributes.

Internal

UF_DISP_set_conehead_attrb
 

gateway

Selects multiple features. Presents a list box of features in the work
part and allows multiple selection of features from the list box or from
the graphical display. If there are no features to be presented, an
empty list box is presented After the user okays the selection, the
features are unhighlighted. There must be a part loaded when this
function is called.

Internal

Note: If filter is NULL, boolean and UDF features will not be presented.
For all booleans to be presented use UF_UI_feat_sel_type_t
 

gateway

Displays a list box of the expressions corresponding to the parameters
of the input feature. You can select multiple expressions from the list
box. Returns an allocated array of expression tags. The expression tag
array must be freed with UF_free after use. There must be a part
loaded when this function is called. The input feature must be in the
work part.

Internal
 

gateway

Allows you to select a collection of points using the Point
Specification menu (see the NX Gateway manual for details)



Point Specification Method Menu

The logical value determines if coincident points are returned. This
function returns a count of points and an array of structures. You must
free memory using UF_free.
NOTE: object is null_tag if you use the point subfunction. pt[3] is the
location in absolute space.

Internal

UF_UI_chained_points_p_t
 

gateway

Select Routing objects using the standard Routing selection tool

There must be an active part for this function to be called.

Internal

Original release was in V18.0.
 

gateway

Displays the rpo dimensions of the specified feature in a list box
which shows the corresponding expressions. You can select multiple
expressions from the list box or select the dimensions graphically.
Returns an allocated array of expression tags. The expression tag
array must be freed with UF_free after use. An error is returned if the
feature has no rpo dimensions. There must be a part loaded when this
function is called. The feature that is input must be in the work part.

Internal
 

gateway

This function is to be obsoleted in the near future. Please
use the replacement routine UF_UI_select_with_single_dialog .
Selects a single object. The view parameter is a pointer view
sequence. This tag provides the view from which the object was
selected.

Internal

Refer to the example
UF_UI_selection_options_t
 

gateway

Presents a list box of all sketches in the work part and returns the
sketch selected by the user from either the list box or the graphical
display. After the user okays the selection of the sketch, the sketch is
unhighlighted. There must be a part loaded when this function is
called. If there are no sketches to be selected an error is returned.

NOTE: This function returns old sketches (pre-V13.0) and new
sketches (V13 and beyond). Since new sketches are now features, you
can use UF_UI_select_feature to return new sketches. This function
also provides a list box.. You can also return sketches with general
selection functions like UF_UI_select_with_single_dialog
(or UF_UI_select_single) and UF_UI_select_with_class_dialog
(or UF_UI_select_by_class).

Internal
 

gateway

All the dimensions of the specified sketch are displayed if they are
not already displayed. However, only dimension constraints are selectable,
i.e., reference dimensions cannot be selected. The user is presented with a
list box of the correspondng expressions. You can select multiple expressions
from the list box or select the sketch dimensions graphically. There must be
a part loaded when this function is called. The sketch must be in the
work part.

Returns an allocated array of expression tags. The expression tag
array has to be freed with UF_free after use. If the sketch has no
dimension constraints, an error is returned.

Internal
 

gateway

Create a Result File Selection Box dialog and allows the user to select a named reference file from
Teamcenter CAESolution dataset and passes back the selected Teamcenter file location.

0 = No error
!= 0 = Error code

Internal
 

gateway

Select multiple objects with the class selection dialog.

If the response is UF_UI_OK, the selected objects remain
highlighted. The response may be UF_UI_OK but no objects have
been selected. If the response is UF_UI_CANCEL,
all the selected objects are unhighlighted.

The valid selection scopes are defined in uf_ui.h. If the selection
scope is changed, it is restored to its original state when the dialog is
terminated.

The selection initialization procedure is an optional procedure
provided by the user to specify additional selection parameters by
calling other UF_UI selection functions. For more information, see
UF_UI_select_with_single_dialog.

In the selection initialization procedure UF_UI_set_sel_mask can
be called to specify object type filtering. The default object type
mask is all standard types selectable. UF_UI_set_sel_procs can be
called to specify a filter procedure and/or selection callback.

To begin with objects already selected (which allows them to be
deselected), call UF_UI_add_to_sel_list from the selection
initialization procedure.

There must be an active part for this function to be called.

Note: In NX5 class selection was converted to Blocked Base Menu. Selection
will now inherit any selected objects from global selection. If inheritance
is not desired then the global selection should be cleared (deselect the objects)
before calling UF_UI_select_with_class_dialog.

The function UF_UI_set_cursor_view is necessary to enable the
selection of objects within drawing member views.

Internal

UF_UI_select_with_single_dialog

UF_UI_set_cursor_view
Refer to the example

Original release was in V13.0.
 

gateway

Selects a single object with the single selection dialog. The object can
be selected with the cursor or by entering a name. The object is
highlighted.

The valid selection scopes are defined in uf_ui.h (e.g
UF_UI_SEL_SCOPE_NO_CHANGE). If the selection scope is changed, it is restored
to its original state when the dialog is terminated.

The selection initialization procedure is a function the Open C API
programmer can optionally provide in order to customize their
selection by calling other UF_UI selection functions. NX calls the
selection initialization procedure, passing the selection pointer and
user data. The selection pointer is only valid during the selection
initialization procedure, and is used as an input argument to the
UF_UI selection functions.

If the initialization is successful, the procedure should return
UF_UI_SEL_SUCCESS. Otherwise, it should return UF_UI_SEL_FAILURE.
In this case, the single selection dialog is presented and an appropriate
error code is returned. In the selection initialization procedure:

UF_UI_set_sel_mask can be called to specify object type filtering.
The default object type mask is all standard types selectable.

UF_UI_set_sel_procs can be called to specify a filter procedure
and/or selection callback.

You can call UF_UI_select_with_single_dialog in a loop to select
multiple objects. The user indicates they are done selecting by
choosing OK. You must have an active part to call this function.

The function UF_UI_set_cursor_view is necessary to enable the selection
of objects within drawing member views.

Internal

UF_UI_set_cursor_view

Refer to the example

Original release was in V13.0.
 

gateway

Sets the current mask for selection within views. Object selection can
be made in the work view on a drawing layout only or any view, and this
routine sets the current value.

In drafting, the default is the work view so use this function if you want
to select in any view. It is recommended to call UF_UI_ask_cursor_view and
save the current value so you can set it back after changing.

Internal

UF_UI_ask_cursor_view
 

gateway

Sets the directory path of a given dialog.

Internal

UF_UI_dialog_dir_id_t
 

gateway

Sets the filter extension of the current dialog.

Internal

UF_UI_dialog_dir_id_t
 

gateway

Sets the unlock flag to unlock NX functions regardless of the
NX state.

The call to UF_UI_set_force_unlock flag must be followed with a call
to UF_UI_unlock_ug_access.

For a complete example demonstrating how to use
this function please refer to the example provided
in the Open kit called ufx_menuscript_ufsta.c.

return code:
UF_UI_SUCCESS when the unlock flag is set.
UF_UI_FAILURE when the unlock flag is not set.

Internal
 

gateway

This function will turn on/off NX graphics window special minimal mode

Privileged

Added in NX7.5.2
 

gateway

This function will set NX graphics window position in special minimal mode
If all parameters are zero then NX will be resized to fill whole current screen.

Privileged

Added in NX7.5.2
 

gateway

Displays a line of text in the NX prompt area. You call this routine
after some interactive dialog invokes a change in the status bar. You
can call this routine to prompt the user when a specific interactive
task is required. For example, if your program requires the user to
select a line end point, you could prompt the user to "Pick line end pt1".

Internal
 

gateway

This routine sets the visibility of a ribbon tab. This routine can only be used
on a ribbon tab for which you have a valid ribbon id. This function only applies
to ribbon tabs; for groups, galleries, cascades, and dropdowns it has no effect.

Note: Changing the visibility of the ribbon tab will override any user customization
of the tabs visibility. It is preferable to use UF_UI_create_ribbon and UF_UI_remove_ribbon,
which also works on groups, galleries, dropdowns and cascades.

Internal

UF_UI_ask_ribbon_vis
UF_UI_create_ribbon

Originally released in NX9.0
 

gateway

Sets the types of objects that are selectable. If this function is not
called to set the mask, then the default mask is all standard types.
The following is the current list of standard types.
UF_point_type
UF_line_type
UF_circle_type
UF_conic_type
UF_spline_type
UF_pattern_type
UF_kanji_type
UF_group_type
UF_drafting_entity_type
UF_dimension_type
UF_tabular_note_type
UF_margin_type
UF_coordinate_system_type
UF_plane_type
UF_component_type
UF_datum_axis_type
UF_datum_plane_type
UF_facet_topology_type
UF_view_type
UF_view_set_type
UF_route_control_point_type
UF_route_port_type
UF_route_segment_type
UF_route_part_anchor_type
UF_route_stock_type
UF_analysis_type
UF_traceline_type
UF_constraint_type
UF_solid_type

In this list of standard types, UF_solid_type only specifies solid bodies
and does not include faces or edges. To select faces or edges, you must
specify these object subtypes in mask_triples.

The word ALL in the two symbols UF_UI_SEL_MASK_ENABLE_ALL and
UF_UI_SEL_MASK_ALL_AND_DISABLE_SPECIFIC means all standard types.

Use this function for setting the object type mask for dialogs created
with the UIStyler. The function can be called from any UIStyler
dialog callback or the selection callback to change the object type
mask.

For UF_UI_select_with_single_dialog and UF_UI_select_with_class_dialog,
this function can only be called from the selection initialization procedure.
Calling this function from a selection filter procedure returns an error.

Internal

UF_UI_mask_t

Original release was in V13.0.
 

gateway

Specify selection filter procedure for additional filtering based on
application specific criteria, and/or selection callback to perform
application specific processing for each selection gesture processed,
and user specific data to be passed to these routines.

This function can be used with UIStyler dialogs and with
UF_UI_select_with_single_dialog and UF_UI_select_with_class_dialog.
The typedef of the filter procedure and selection callback are defined
in this header file as follows:

typedef int (UF_UI_sel_filter_fn_t) (
tag_t object,
int type[3],
void user_data,
UF_UI_selection_p_t select_)

typedef int (UF_UI_sel_cb_fn_t) (
int num_selected,
tag_p_t selected_objects,
int num_deselected,
tag_p_t deselected_objects,
void user_data,
UF_UI_selection_p_t select_)

The filter procedure is passed the tag of the candidate object, the
types of the candidate object (object type, object subtype, solid
subtype - see UF_UI_set_sel_mask) , a pointer to the user's data,
and a pointer to selection. The return responses are defined in
uf_ui.h. The filter procedure should return UF_UI_SEL_REJECT if
the object is to be discarded and UF_UI_SEL_ACCEPT if the object
is a valid candidate.

The candidate object passed to the filter procedure is not adjusted
for scope. Therefore, with an assembly part, the object is the
occurrence and not the prototype.

You can get the prototype of the object by calling
UF_ASSEM_ask_prototype_of_occ. However, if the object is to be a
promotion, for example, then the user has to do some inquiries as
in the example below:

if (UF_ASSEM_is_occurrence(object))
{
proto = UF_ASSEM_ask_prototype_of_occ(object);
UF_MODL_ask_prom_feat_of_solid(proto, &feat));
UF_MODL_prom_map_object_up(proto, feat,
&prom));
status = check_promotion(prom);
}

The selection callback is different. The objects passed to it are
already adjusted for scope.

The selection callback is passed an allocated array of the objects
selected or deselected with the previous selection. The allocated array
of tags will be freed for the user. The user can force dialog
termination by returning UF_UI_CB_EXIT_DIALOG. To continue
the dialog, the user should return UF_UI_CB_CONTINUE_DIALOG.

When a selection callback is used with UF_UI_select_with_single_dialog,
the return is ignored and the dialog is always terminated.

Both the filter procedure and the selection callback are passed a
pointer to selection which can be used as input to other UF_UI
selection functions to inquire other selection data or modify selection.
This selection pointer is no longer valid after the filter procedure or
selection callback is exited.

Internal

Refer to the example

Original release was in V13.0.
 

gateway

Sets the selection type.

You use this function with UIStyler dialogs. It can be called from a
callback to change the type of selection associated with the dialog.
Valid types are defined in uf_ui.h.

A type of UF_UI_SEL_TYPE_INACTIVE_SELECTION sets selection inactive until
this function is called again. UF_UI_SEL_TYPE_ROBUST_SELECTION allows
single select, single deselect, reselect last, rectangle select, rectangle
deselect, and chaining. If UF_UI_SEL_TYPE_SINGLE_POSITION and either
UF_UI_SEL_TYPE_SINGLE_SELECTION or UF_UI_SEL_TYPE_ROBUST_SELECTION is
requested, the position is returned if no object is selected with the
single select gesture.

Calling this function for UF_UI_select_with_single_dialog or
UF_UI_select_with_class_dialog returns an error. Calling this
function from a selection filter procedure returns an error.

Internal

Original release was in V13.0.
 

gateway

Determines which object types to mask.

This function modifies a shared filter only used by a few NX commands and
does not modify the global selection filter. To establish a filter to use
for selection, see function UF_UI_set_sel_mask(), which can be used to
establish a filter for a UIStyler dialog, or the dialog launched by either
UF_UI_select_with_class_dialog or UF_UI_select_with_single_dialog; both of
these functions take in a proc of type UF_UI_sel_init_fn_t. In your
implementation of that proc, you can set up the selection filter for the
dialog using UF_UI_set_sel_mask().

Internal

UF_UI_set_sel_maks
UF_UI_select_with_class_dialog
UF_UI_select_with_single_dialog
 

gateway

Displays a line of text in the NX status area.

Internal
 

gateway

This routine sets the visibility of a toolbar. This routine can only be used
on toolbars that you have valid toolbar id for.

Internal

UF_UI_ask_toolbar_vis
UF_UI_create_toolbar

Originally released in V16.0
 

gateway

Replaces the user tool definition file specified by a user tools
menubar option. The option number range starts at one and its
maximum is defined by the original length of the ".utm" file. For
example, if the ".utm" file only includes four entries, it is not possible
to extend the size of the menubar entries by setting the option number to 5.
The replacement for the user tool definition does not take effect until
Reload-->Default is selected. Therefore, hiding and then showing the
tool does not change the definition.

Internal
 

gateway

This function launches a dialog to let the user choose a csys. The csys
specified by the input csys_tag is the default. If the csys_tag input is
NULL_TAG, then the initial CSYS is used as the default. The output csys_tag is
the csys the user specified in the dialog.

Though 40 characters are allowed in the title,
it should be noted that the first option (ORIGIN,X-PT,Y-PT) appends the point
number (PT1, PT2, and PT3) on the end of the message. Thus, only 36
characters are effectively allowed.

Users Response
1 = Back
2 = Cancel
3 = OK
7 = No Active Part
8 = Disallowed state, unable to bring up dialog

Internal
 

gateway

Allows you to select the plane subfunction default mode. A temporary
plane is created from the specified subfunction.

Internal

Refer to the example
 

gateway

This function allows you to indicate a screen position by pressing MB1
in the graphics window. The screen position and the tag of the view it
is in are returned.

An empty dialog is displayed with only the Back and Cancel buttons enabled.

The function UF_UI_set_cursor_view affects the screen_pos
and view_tag that is returned and passed to the motion callback. This
is particularly true with respect to the display of a drawing view. The
two values for the new_cursor_view parameter of UF_UI_set_cursor_view affect
the view_tag and screen_pos parameters of UF_UI_specify_screen_position as
follows:

. If new_cursor_view is set to "Any View" and the cursor is in a
drawing member view, then the return values for the view_tag and
screen_pos are the tag of the member view and the position in
Absolute Coordinates in that member view.

. If the new_cursor_view is set to "Work View", then regardless of
whether the cursor is in a member view or not, the return values
for the view_tag and screen_pos are the tag of the drawing and the
position in drawing coordinates.

If Grid Snap is presently enabled, the screen position is automatically
snapped. This also applies to the position passed to the motion
callback.

This function accepts a motion callback which will be called in
response to each detected movement (i.e. "motion") of the cursor
within the graphics window. The callback will be passed the current
position and view of the cursor, and the client data pointer.
The typedef for motion callbacks is defined in uf_disp.h as follows:

typedef void (UF_UI_motion_fn_t)(
double screen_pos[3],
UF_UI_motion_cb_data_p_t motion_cb_data,
void data );

All of the above parameters are input parameters to the callback
function:

screen_pos is the current position of the crosshair, given in Work
Part Absolute Coordinates (as described above).

motion_cb_data is a pointer to a data structure; presently, only
the following field of this structure should be referenced:
motion_cb_data->view_tag is the tag of the view of the
current crosshair position.

Finally, the third parameter to the motion callback, data, is the client
data pointer initially passed to UF_UI_specify_screen_position along
with the callback.

In general, a motion callback will generate some graphical feedback
based on the current cursor position, using Overlay Graphics
primitives. Overlay Graphics primitives are defined using the
UF_DISP_display_ogp_ functions. Overlay Graphics primitives
generated from a motion callback will be displayed immediately
following the invocation of the callback, and will be automatically
erased just before the next invocation, and upon the completion of
the call to UF_UI_specify_screen_position.

Please see the Overview of the section on Overlay Graphics primitive
functions in the Display chapter for further information regarding
their behavior and usage.

Keep in mind that your motion callback will be invoked in response to
every detected movement of the cursor (in the graphics window). If
you find that the display of the cursor appears to be "choppy", or that
it doesn't seem to be "keeping up" with your movement of the mouse,
it may be that you are attempting to do too many calculations and/or
define too many primitives from your motion callback.

There must be a part loaded when this function is called.

Internal Only

UF_UI_set_cursor_view
Refer to the example
 

gateway

Queries the user to specify a vector using the vector subfunction.
Optionally, a temporary conehead is displayed at the vector specified.