Erases an object from a view.

Flag
0 = OK
1 = View Does Not Exist
2 = Invalid Character In View Name
3 = Invalid Object Type

Internal and External
 

gateway

Convert a view dependent object to model

NOTE: An individual ordinate dimension cannot be converted to a
model object by itself. You may however convert an ordinate origin
and all its associated ordinate dimensions to model objects by setting
np2 = object identifier of the ordinate origin.

This user function will convert more object types to model dependent objects than
UF_VIEW_convert_to_model().

Flag
0 = OK
1 = View Does Not Exist
2 = Invalid Character In View Name
3 = Object Not View Dependent
4 = Ordinate Dimension cannot be converted
to a model object.

Internal and External

UF_VIEW_convert_to_model
 

gateway

Convert model object to view dependent

NOTE: An individual ordinate dimension cannot be converted to a
view dependent object by itself. You may however convert an
ordinate origin and all its associated ordinate dimensions to view
dependent objects by setting np2 = object identifier of the ordinate
origin.

This user function will convert more object types to view dependent objects than
UF_VIEW_convert_to_view().

Flag
0 = OK
1 = View Does Not Exist
2 = Invalid Character In View Name
3 = Object Already View Dependent
4 = Object Not Eligible For View Dependence
5 = Operation not available when work part
and display part are different
6 = Ordinate Dimension cannot be converted
to a view dependent object.

Internal and External

UF_VIEW_convert_to_view
 

gateway

Removes the view dependent edits from an object.

Flag
0 = OK
1 = View Does Not Exist
2 = Invalid Character In View Name
3 = Object Not View Modified

Internal and External
 

gateway

Converts all view dependent objects to model.

Note: This user function uses the same object filter as that of the view
dependent edit functionality in interactive NX.

Flag
0 = OK
1 = View Does Not Exist
2 = Invalid Character In View Name
3 = Object Not View Modified

Internal and External
 

gateway

Removes all view dependent edits from a view.

Flag
0 = OK
1 = View Does Not Exist
2 = Invalid Character In View Name
3 = No View Modifications Exist

Internal and External
 

gateway

Modify the COLOR/FONT/WIDTH of a curve in a view.

RP3 is the normalized start and stop parameters for the curve along
the normalized curve from 0.0 (beginning) to 1.0 (end). The curve
display is modified between the two specified limits.

Flag
0 = OK
1 = View Does Not Exist
2 = Invalid Character In View Name
3 = Invalid Color Number
4 = Invalid Font Number
5 = Invalid Width Number
6 = Invalid Object Type
7 = Data Base Limit ForObject View Mods Full
8 = Attempt To Erase Curve On Full Parameter - Use uc6400

Internal and External
 

gateway

Returns view dependent edit data for an object.
Please use UF_VIEW_ask_vde_data rather than uc6408

Internal and External

UF_VIEW_ask_vde_data
 

gateway

Returns view dependent status of an object and the associated view name when
the object is view dependent.

Drafting views will have a @0 appended to the end of the name (ViewName@0).
Modeling views will just conatin the name (ViewName).

Error Code
0 = Success
1 = Invalid Object Type

Internal and External
 

gateway

Read View Center and Scale

If cp1 is blank, the work view is used.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name

Internal and External
 

gateway

Set View Center and Scale

If cp1 is blank, the work view is updated. The scale must be greater
than 0.0. An invalid scale is an error and does not change the view
center. uc6431 can edit a non-active view.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
31 = Invalid Scale

Internal and External
 

gateway

Fit the View(s)

If cp1 is blank and ip2=1, the work view is updated. If ip2=2, the
value in cp1 is ignored.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
9 = View Not Active

Internal and External
 

gateway

Read View Matrix

If cp1 is blank, the work view is used.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name

Internal and External
 

gateway

Set View Matrix

If cp1 is blank, the work view is updated. The object Identifier in np3
must reference an object that has a coordinate system associated with
it, such as an arc, conic, drafting object, CSYS, etc.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
3 = View is a Drawing View or Drawing Member View
9 = View Not Active
31 = Invalid Type Object In np3
32 = Invalid Matrix In rp4
33 = Invalid Matrix Option

Internal and External
 

gateway

Rotate View Point around View Center

If cp1 is blank, the work view is updated. A compound rotation can be
accomplished by setting several values of rp2 to non-zero. Negative
angles are valid. The rotations are executed in the order of rp2[0],
rp2[1], rp2[2].

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
9 = View Not Active

Internal and External
 

gateway

Read View Clipping Planes

If cp1 is blank, the work view is used. The values of rr3 are not
returned if the corresponding values of IR2 = 1.
NOTE: "Clipping Enabled by System" means NX
automatically detects that clipping planes are required and turns them on.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name

Internal and External
 

gateway

Set View Clipping Planes

If cp1 is blank, the work view is updated. The values of rp3 are
ignored if the corresponding clipping plane is disabled (ip2) or
auto-set. Using auto-set calculates the plane to be the minimum (for
front plane) or maximum (for back plane) distance that displays all
objects.

You cannot disable clipping planes in a view that has 3D vectors (see
Uc6440 - Read view display type), and you cannot disable the front
clipping plane in perspective views (see uc6439 - Set view
perspective).

If the projection type is "PERSPECTIVE" and the front Z clipping
plane is in front of the EYE POINT (see uc6438 - Read view
perspective), the front Z clipping plane moves to the EYE POINT.
Return Codes of 33 and 34 are warnings only.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
3 = View Has 3D Vectors - Can Not
Remove Clipping Planes
9 = View Not Active
31 = Front Plane Behind Back Plane
33 = Perspective View - Can Not Remove
Front Plane
34 = Perspective View - Front Plane Moved
To Eye Point

Internal and External
 

gateway

Read View Perspective

If cp1 is blank, the work view is used. rr3 is modified only if the
projection type is "perspective" (ir2=2).

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name

Internal and External
 

gateway

Set View Perspective

If cp1 is blank, the work view is updated. The value of rp3 is used only
if ip2=2. The value of rp4 is used only if ip2=3.
If projection type is "PERSPECTIVE" and the EYE POINT is set to
be behind the current front Z clipping plane, the front Z clipping
plane is moved equal to the EYE POINT.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
3 = Drafting View Not Valid
9 = View Not Active
31 = Invalid Distance
32 = Invalid Projection Option

Internal and External
 

gateway

Read view display type

If cp1 is blank, the work view is used.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name

Internal and External
 

gateway

Read View Drawing Parameters

If cp1 is blank, the work view is used.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
3 = View Is A Drawing

Internal and External
 

gateway

Set view drawing parameters

If cp1 is blank, the work view is updated. The reference point and
scale are used to place a view on a drawing. The scale must be
greater than 0.0. UF6443 can edit a non-active view.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
3 = View Is A Drawing
4 = Not allowed in "Work in member view"
mode
31 = Invalid Scale

Internal and External
 

gateway

Read Surface/Solid Display Parameters

Please use
UF_VIEW_ask_surface_display_options
and
UF_VIEW_ask_fog_options
instead.

If cp1 is blank, the work view is used.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name

Internal and External
 

gateway

Set Surface/Solid Display Parameters

Please use
UF_VIEW_set_surface_display_options
and
UF_VIEW_set_fog_options
instead.

If cp1 is blank, the work view is updated.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
3 = Drafting View Not Valid
31 = Invalid Parameter

Internal and External
 

gateway

Read View Layer Visibility Mask

If cp1 is blank, the work view is used. ir3 is returned only if ir2=2. For
example, if an individual layer visibility mask exists for this view.
NOTE: This routine does not read the global layer mask.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name

Internal and External
 

gateway

Set View Layer Visibility Mask

If cp1 is blank, the work view is used. If ip2=1, any existing view layer
visibility mask is deleted for this view. If ip2=2, a new layer visibility
mask is created if none exists. ip3 is used only if ip2=2. For example,
if an individual layer visibility mask is to be used for this view.
UF6447 can edit a non-active view.
NOTE: This routine does not affect the global layer mask (see
routines UF500x).

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
31 = Invalid Mask Status

Internal and External
 

gateway

Read Work View Name
Please use UF_VIEW_ask_work_view rather than uc6448.

work view name.

Internal and External
 

gateway

Change Work View

This function has no effect if a drawing is current.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
9 = View Not Active

Internal and External
 

gateway

Save View

cp1 is the name of the view to save. If cp1 is blank, the work view is
saved.
cp2 is the name to save the view as. If cp2 is blank, the view is saved
with the same name. If cp2 is not blank and a view of that name does
not exist, a new view is created. If cp2 is not blank and a view of that
name already exists, an error is returned.
ip3 and ip4 are used only if the view is saved with a new name (i.e.,
cp2 <>"" and cp2<> cp1).
NOTE: The view orientation is not changed for a "canned" view.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
4 = View Already Exists
9 = View Not Active
10 = Operation Not Allowed in "Work in
member View" mode
11 = Can't Save View because drawing is
currently displayed
23 = Can't Save Drawing View With New
Name

Internal and External
 

gateway

Delete View

Many views cannot be deleted. Among them are the "canned" views
and work view. If a view contains a drawing, it cannot be deleted. In
addition, any view that belongs to a layout cannot be deleted.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
3 = Cannot Delete Canned View
4 = Cannot Delete Work View
5 = Cannot Delete Drawing View
6 = Cannot delete view. View belongs to at
least one layout.
8 = Cannot delete view. View belongs to at
least one layout.

Internal and External
 

gateway

Rename View
Please use UF_VIEW_rename rather than uc6455.
If cp1 is blank, the work view is renamed. The "canned" views cannot
be renamed. In addition, modeling views cannot be renamed as
drawing view names and vice versa.

Return Code
0 = OK
1 = Old View Does Not Exist
2 = Invalid View Name
3 = Can Not Rename Canned View
4 = New View Already Exists
5 = Can Not Rename Drawing View

Internal and External
 

gateway

Cycle Views in Part
Please use UF_OBJ_cycle_objs_in_part with type UF_view_type rather than uc6456
This routine cycles the part and returns one view name per cycle. To
start the cycle, set CA1 to an empty string (""). The first
view name is returned in CA1. The next call returns the second view
name in CA1. When CA1 is returned with an empty string (ca1 returns ""),
all view names have been returned. View or drawing names that are
28 characters or less are appended with an "@n" string (where n is
any positive integer including zero). If your view name is more than 28
characters, the "@n" string is truncated.
NOTE: The cycle can be continued even if the view named in CA1 is
deleted.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name

Internal and External
 

gateway

Cycle Objects in View
Please use UF_VIEW_cycle_objects rather than uc6457
If cp1 is blank, the work view is used. ip2=1 returns all objects which
are visible in the view. Objects which are out of the view bounds are
not returned.

Different types of cycles can be intermingled. For instance, while
cycling view dependent objects, you can also cycle objects erased in a
view. You cannot delete or un-erase objects or view modifications
during a cycle.

Warning: This function will return curves that are used to display a
solid silhouette in a drawing member view. Use UF_DRAW_ask_group_of_curve
on any curve returned to determine if the curve belongs to a
UF_solid_silhouette_type group.

NOTE: return/IR4=9 is valid only if ip2=1.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Name
9 = View Not Active
31 = Invalid Selection Option

Internal and External
 

gateway

Routine -
UF_VIEW_add_to_view_set

Description -
Add an orthographic view to view set

Return Codes -
ERROR_OK
UF_VIEW_INVALID_OBJECT
UF_VIEW_INVALID_VIEW_TAG
UF_VIEW_INVALID_ORIENTATION_TYPE


See Also -
UF_VIEW_create_view_set
UF_VIEW_remove_from_view_set
UF_VIEW_ask_view_set_by_name
UF_VIEW_ask_base_view_of_view_set
UF_VIEW_set_base_view_of_view_set
UF_VIEW_ask_views_of_view_set
UF_VIEW_delete_view_set

Internal and External

This routine is originally created in release NX3.0
 

gateway

Routine -
UF_VIEW_ask_base_view_of_view_set

Description -
Query the base view of the given a view set

Return Codes -
ERROR_OK
UF_VIEW_INVALID_OBJECT
UF_VIEW_INVALID_VIEW_TAG

See Also -
UF_VIEW_create_view_set
UF_VIEW_add_to_view_set
UF_VIEW_remove_from_view_set
UF_VIEW_ask_view_set_by_name
UF_VIEW_set_base_view_of_view_set
UF_VIEW_ask_views_of_view_set
UF_VIEW_delete_view_set

Internal and External

This routine is originally created in release NX3.0
 

gateway

Ask View Center

If view is NULL_TAG, the work view is used.

The view center returned by this function is a point on the view plane at the
center of the viewing volume. If the viewing volume is symmetric (as it usually
is), then this point is also the view origin.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Tag - can not find view object from given view tag
3 = center pointer is NULL

Internal and External

UF_VIEW_set_center
uc6430
 

gateway

Returns the current X and Y clip boundaries of the given view. The clip
boundaries define a rectangle on the Z = 0 plane of View Space.

Please note the following:
The clip boundary returned is different to the one returned by
UF_VIEW_ask_xy_clip. UF_VIEW_ask_xy_clip return the boundary saved
in the data base for the view. UF_VIEW_ask_current_xy_clip return the
current boundary.

If the view is in the current layout, has been changed in
the layout (by, for example, a Zoom), and has not been saved since
it was changed, then the clip boundaries returned by this function
will reflect the changes.

This function is unusual in that, unlike most Open API
functions, the coordinate space is View Space. View Space is
parallel to the screen, with the center of the view at (0,0,0). The
view center is mapped from Absolute Space to View Space by
applying first the view rotation, then the view translation to it. The
scale in View Space is the same as in Absolute Space.

Internal

UF_VIEW_ask_xy_clip

Original release was in NX5.0.
 

gateway

Returns the fog options of the specified view. The view must have type
UF_VIEW_MODEL_TYPE.

Internal and External

UF_VIEW_set_fog_options
UF_VIEW_fog_options_t

Originally released in NX4.0.
 

gateway

Ask View Perspective

If view is NULL_TAG, the work view is used. distance is modified only if the
projection type is "perspective" (type = 2).

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Tag - can not find view object from given view tag
3 = Either type or distance pointer is NULL

Internal and External

UF_VIEW_set_perspective
uc6438
 

gateway

Ask View matrix

If view is NULL_TAG, the work view is used.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Tag - can not find view object from given view tag
3 = matrix pointer is NULL

Internal and External

UF_VIEW_set_rotation
uc6433
 

gateway

Returns the shaded edge options of the specified view. The view
must have type UF_VIEW_MODEL_TYPE.

Internal and External

UF_VIEW_set_shaded_edge_options
UF_VIEW_shaded_edge_options_t

Originally released in NX4.0.
 

gateway

Returns the rendering style and the Edge display options of
the specified view. The view must have type UF_VIEW_MODEL_TYPE.

Internal and External

UF_VIEW_set_surface_display_options
UF_VIEW_rendering_style_t
UF_VIEW_edge_display_options_t

Originally released in NX4.0.
 

gateway

Gets the tag of an existing view that you specify by name.

Internal and External
 

gateway

This routine retrieves the type of the specified view.

Internal and External
 

gateway

Retrieves the number of view dependent edits for an object, and the
corresponding data for each modification.

Internal and External

For example please refer to the example
 

gateway

Retrieve the number of view dependent edits for an object and the
corresponding edit types

Internal and External
 

gateway

This function returns the lighting attributes of a single specified view.
Each view can have different lights assigned to it. The lights are now
shared between the NX hardware shading and Photo shading.

If no lights were found with the part, the following 2 default lights are
turned on in each view to ensure that shaded display is lit:
1. Light name: Default 1 Ambient
Light type: UF_VIEW_AMBIENT_LIGHT
2. Light name : Default 2 Up-Front Dist
Light type: UF_VIEW_DISTANT_LIGHT
Light mode: UF_VIEW_FIXED_TO_OBSERVER
Light Location: 0.8, 0.0, 0.4
Light to: 0.0, 0.0, 0.0

Internal and External

UF_VIEW_set_view_light
 

gateway

Routine -
UF_VIEW_ask_view_set_by_name

Description -
Query the view set by the given name

Note -
The query is only against the current displayed part. If there is
no view set with the given name, a NULL_TAG is returned.

Return Codes -
ERROR_OK
UF_VIEW_INVALID_NAME

See Also -
UF_VIEW_create_view_set
UF_VIEW_add_to_view_set
UF_VIEW_remove_from_view_set
UF_VIEW_ask_base_view_of_view_set
UF_VIEW_set_base_view_of_view_set
UF_VIEW_ask_views_of_view_set
UF_VIEW_delete_view_set

Internal and External

This routine is originally created in release NX3.0
 

gateway

Routine -
UF_VIEW_ask_views_of_view_set

Description -
Query the list of views in a view set

Return Codes -
ERROR_OK
UF_VIEW_INVALID_OBJECT
UF_VIEW_INVALID_VIEW_TAG

UF_VIEW_create_view_set
UF_VIEW_add_to_view_set
UF_VIEW_remove_from_view_set
UF_VIEW_ask_view_set_by_name
UF_VIEW_ask_base_view_of_view_set
UF_VIEW_set_base_view_of_view_set
UF_VIEW_delete_view_set

Internal and External

This routine is originally created in release NX3.0
 

gateway

Returns visible objects in a view broken down by those which are entirely
visible within the view and those which are visible but clipped by the view
boundary (i.e those which cross the view boundary).

Note that this function is primarily designed to work with drafting member
views. While it may be used with model views or drawing sheet views, the bounds
of those latter views are not considered in the outcome. The bounds of drafting
member views, including those with non-rectangular borders are considered.

If view is NULL_TAG, the work view is used.

Warning: When run in external mode, this function will return solids as visible
which are occluded by other solids in the specified view. For a drafting member
view, extracted edges may be used to force occlusion to be considered.

Internal and External

UF_VIEW_cycle_objects

Originally released in V19.0
 

gateway

Gets all of the visualization data. If you pass a NULL_TAG to the
view argument, then the work view is used.

Please use
UF_VIEW_ask_surface_display_options
and
UF_VIEW_ask_fog_options
instead.

Internal and External

UF_VIEW_visualization_t

In the V15.0 release, new fields were added to the
UF_VIEW_visualization_t data structure.
In NX4.0, this function is superceded by
UF_VIEW_ask_surface_display_options and UF_VIEW_ask_fog_options.
 

gateway

This routine retrieves the work view tag.

Internal and External

uc6448

This function was originally released in V16.0.
 

gateway

Returns the X and Y clip boundaries of the given view. The clip
boundaries define a rectangle on the Z = 0 plane of View Space.

This function is primarily intended for use by specialized
applications such as Translators. Please note the following:
The clip boundaries returned are those saved in the data base for
the view. If the view is in the current layout, has been changed in
the layout (by, for example, a Zoom), and has not been saved since
it was changed, then the clip boundaries returned by this function
do NOT reflect the changes.

If this is not what you need, consider using uc6431 (Read View
Center and Scale), which returns the current data for the view in
the layout, if it is in the layout, or otherwise returns the data for the
view from the data base.

This function is unusual in that, unlike most Open API
functions, the coordinate space is View Space. View Space is
parallel to the screen, with the center of the view at (0,0,0). The
view center is mapped from Absolute Space to View Space by
applying first the view rotation, then the view translation to it. The
scale in View Space is the same as in Absolute Space.

Internal and External

UF_VIEW_set_xy_clip
 

gateway

Ask View Z-Clipping Planes

If view is NULL_TAG, the work view is used.
The values of distance are not returned if the corresponding values of status = 1.
NOTE: "Clipping Enabled by System" means NX automatically detects that clipping
planes are required and turns them on.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Tag - can not find view object from given view tag
3 = Either status or distance pointer is NULL

Internal and External

UF_VIEW_set_Z_clip
uc6436
 

gateway

Retrieves the zoom scale of the specified view. This is the value
displayed on the Zoom View menu which is the current scale at which
the view is displayed. If there are multiple occurrences of the view in
the layout, only one arbitrary occurrence is retrieved.
The view must be on the current layout. On a drawing layout, the view
must be a drawing view or a member work view.

Internal
 

gateway

This routine converts a view dependent object in the specified view
to the model.

Internal and External

Note: This user function uses the same object filter as that of the view
dependent edit functionality in interactive NX; you cannot change it.

For example please refer to the example

This function was originally released in V15.0.
 

gateway

Converts a model object to the view dependent object in the
specified view.

Note: This user function uses the same object filter as that of the view
dependent edit functionality in interactive NX; you cannot change it.

Internal and External

For example please refer to the example

This function was originally released in V15.0.
 

gateway

Makes a copy of the given view, creating a new view.
The view_to_copy may or may not be currently displayed. The
new_view is NOT displayed by UF_VIEW_copy_view, but you can later
replace the new view into the layout, using uc6464.

The data for the copy is taken from the "saved" parameters of the
view, which are not necessarily the view parameters currently being
used for the view. For example, if UF_VIEW_rotate_view has been
used since the view was displayed, and the view has not been saved
since the call to UF_VIEW_rotate_view, then the saved parameters do
not include the effect of the rotation. If this is not what you want, you
might call uc6450 first, but note that uc6450 does not save a change to
the rotation of one of the eight "canned" views.

This function does not copy any view modifications made to objects in
view_to_copy to new_view. Any view-dependent objects defined in
view_to_copy are not moved to new_view but remain defined in
view_to_copy.

Internal and External

uc6464
uc6450
 

gateway

Routine -
UF_VIEW_create_view_set

Description -
Create a view set from a base view and a list of orthographic view types.
The view set created will reside in the same part as the base view does.
The view set contains a list of orthographic user defined modeling views
with one of the view as base view. All the other view's orientation are
determined by the base view. When base view changes its orientation, all
the other view's orientation will update accordingly.

Note -
The base_view_tag must be a user defined modeling view, it can not
be any canned views. The base_view_type and other_view_types must
be any one within UF_VIEW_standard_orientation_t

Return Codes -
ERROR_OK
UF_VIEW_INVALID_VIEW_TAG
UF_VIEW_INVALID_OBJECT
UF_VIEW_INVALID_ORIENTATION_TYPE
UF_VIEW_CONFLICT_ORIENTATION_TYPE
UF_VIEW_INVALID_NAME
UF_VIEW_NOT_IN_DISPLAYED_PART

See Also -
UF_VIEW_add_to_view_set
UF_VIEW_remove_from_view_set
UF_VIEW_ask_view_set_by_name
UF_VIEW_ask_base_view_of_view_set
UF_VIEW_set_base_view_of_view_set
UF_VIEW_ask_views_of_view_set
UF_VIEW_delete_view_set

Internal and External

This routine is originally created in release NX3.0
 

gateway

Cycle objects within a view.

If view is NULL_TAG, the work view is used.

A cycle type of UF_VIEW_VISIBLE_OBJECTS returns all objects which are
visible in the view; when using a cycle type of UF_VIEW_VISIBLE_OBJECTS,
objects which are outside of the view bounds are not returned. However,
non-rectangular boundaries of drafting member views are not considered
by UF_VIEW_cycle_objects. UF_VIEW_cycle_objects only works on the
rectangular boundary of the view - as though the breakline/detail
boundary was removed. If the desire is to obtain visible objects within a
drafting member view with non-rectangular borders and with respect to the
non-rectangular border itself, please refer to UF_VIEW_ask_visible_objects.

You must not delete, or un-erase objects, or add or remove view
modifications during a cycle as the resulting changes will cause the
outcome of the cycle to be unpredictable.

Do not attempt to delete objects when cycling the database in a loop. Problems
can occur when trying to read the next object when the current object has been
deleted. To delete objects, save an array with the objects in it, and then
when you have completed cycling, use UF_OBJ_delete_array_of_objects to delete
the saved array of objects.

Warning: This function will return curves that are used to display a
solid silhouette in a drawing member view. Use UF_DRAW_ask_group_of_curve
on any curve returned to determine if the curve belongs to a
UF_solid_silhouette_type group.

Warning: This function can return objects which are visible within the specified view
but which are on layers other than the user-accessible layers of 1 - 256 inclusive.

Warning: When run in external mode, this function will return solids as visible
which are occluded by other solids in the specified view. For a drafting member
view, extracted edges may be used to force occlusion to be considered.

Warning: For drafting member views with extracted edges on (Exact, Smart Lightweight, or Exact (Pre-NX 8.5)
with Extracted Edges toggle on) this function will not return solid
faces and edges because they are not visible.

Internal and External

UF_VIEW_ask_visible_objects

Originally released in V18.0
 

gateway

Deletes a view or returns an error code stating why view could not be
deleted.

Internal and External
 

gateway

Routine -
UF_VIEW_delete_view_set

Description -
Delete the view set

Return Codes -
ERROR_OK
UF_VIEW_INVALID_OBJECT
UF_VIEW_INVALID_VIEW_TAG

UF_VIEW_create_view_set
UF_VIEW_add_to_view_set
UF_VIEW_remove_from_view_set
UF_VIEW_ask_view_set_by_name
UF_VIEW_ask_base_view_of_view_set
UF_VIEW_set_base_view_of_view_set
UF_VIEW_ask_views_of_view_set

Internal and External

This routine is originally created in release NX3.0
 

gateway

Sets the lighting attributes of a single specified light.

You cannot change the light type, light mode, or direction of the light with
this function.

Internal and External

UF_VIEW_set_view_light
UF_VIEW_ask_view_light

This routine is originally created in release NX3.0.3
 

gateway

Makes the specified view the work view then expands the view. If the
view is already expanded or if the current layout is a single view, then
the request is ignored. An active layout must exist. The view may be a
member view in a drawing layout. Expanding a drawing member view
is equivalent to entering the Work In Member View mode.

Internal

For example please refer to the example
 

gateway

Expands the current work view. If the view was already expanded or if
the current layout is a single view, then the request is ignored. An
active layout must already exist. The layout cannot be a layout with a
drawing.

Internal
 

gateway

Fits the geometry to the view by the specified fraction. A 1.00 fraction
means all geometry is fitted to the whole view (There is a small
fraction for padding). A 0.50 fraction is approximately a 1.00 fraction
fit plus a half scale. This is equivalent to changing the percentage on
the Display Preferences menu and doing a fit except the value is
specified differently. If there are multiple occurrences of the view in
the layout, only one arbitrary occurrence is changed.

The view must be on the current layout. On a drawing layout, the view
must be a drawing view or a member work view.

Internal
 

gateway

Checks the expand state of the work view. If the current layout is a
single view, the returned value for expanded is false. An active layout
must currently exist. The expanded view may be a drawing member
view. Checking the expanded state of a drawing member view is
equivalent to checking the Work In Member View mode.

Internal
 

gateway

Maps a point in drawing space to absolute coordinates. Vectors cannot
be mapped using this function. This function maps from drawing member views
to model coordinates only. If the units of the part file and drawing are
different and the input point is in part units then scale the point to
the drawing units before calling this function.

Internal and External

UF_VIEW_map_model_to_drawing

Originally released in V16.0
 

gateway

Maps a point in absolute space to drawing coordinates. Vectors cannot
be mapped using this function. This function maps from drawing member views
only. If the units of the part file and drawing are different then scale
the mapped point to the units of the part file where required.

Internal and External

UF_VIEW_map_drawing_to_model

Originally released in V16.0
 

gateway

Translates the specified view to the specified center. This has the
effect of changing the view origin with the View pull down menu and
does not trigger a regen. If there are multiple occurrences of the view
in the layout, only one arbitrary occurrence is translated.
The view must be on the current layout. On a drawing layout, the view
must be a drawing view or a member work view.

Internal
 

gateway

Routine -
UF_VIEW_remove_from_view_set

Description -
Remove an orthographic view from the view set

Return Codes -
ERROR_OK
UF_VIEW_INVALID_OBJECT
UF_VIEW_INVALID_VIEW_TAG
UF_VIEW_INVALID_ORIENTATION_TYPE

See Also -
UF_VIEW_create_view_set
UF_VIEW_add_to_view_set
UF_VIEW_ask_view_set_by_name
UF_VIEW_ask_base_view_of_view_set
UF_VIEW_set_base_view_of_view_set
UF_VIEW_ask_views_of_view_set
UF_VIEW_delete_view_set

Internal and External

This routine is originally created in release NX3.0
 

gateway

Renames a view.

Internal and External

Originally released in V17.0
 

gateway

Restores the specified view to the parameters (original scale,
translation, and rotation) that were in effect at either the last reset of
restore data, the last view regen, the last fit, or view save operation.
This is the same as the restore option on the View menu. If there is
nothing to restore, the function is ignored. If there are multiple
occurrences of the view in the layout, only one arbitrary occurrence is
restored.

The view must be on the current layout. On a drawing layout, the view
must be a drawing view or a member work view.

Internal
 

gateway

Rotates the specified view using the view center as the origin of
rotation and about the axis specified in the view space.

It does not trigger a regen. Negative angle means clockwise direction.
If there are multiple occurrences of the view in the layout, only one
arbitrary occurrence is rotated. The view must be on the current layout.
The layout cannot be a layout with drawing.

Internal
 

gateway

Rotate the specified view using the specified center as origin of
rotation and about the specified axis. The center and the axis are
specified in absolute coordinates. This is the similar to
UF_VIEW_rotate_view but the user can specify the center in absolute
coordinates and the axis is in absolute coordinates. It does not trigger
a regen. A negative angle means rotation in the clockwise direction. If
there are multiple occurrences of the view in the layout, only one
arbitrary occurrence is rotated.

The view must be on the current layout. The layout cannot be a layout
with drawing.

Internal
 

gateway

Saves all "active" views (those in the current layout) and retains their
current names.

Internal and External

uc6450

Original release was in V14.0.
 

gateway

Routine -
UF_VIEW_set_base_view_of_view_set

Description -
Set a new base view in the set.

Return Codes -
ERROR_OK
UF_VIEW_INVALID_OBJECT
UF_VIEW_INVALID_VIEW_TAG
UF_VIEW_INVALID_ORIENTATION_TYPE

UF_VIEW_create_view_set
UF_VIEW_add_to_view_set
UF_VIEW_remove_from_view_set
UF_VIEW_ask_view_set_by_name
UF_VIEW_ask_base_view_of_view_set
UF_VIEW_ask_views_of_view_set
UF_VIEW_delete_view_set

Internal and External

This routine is originally created in release NX3.0
 

gateway

Set View Center

If view is NULL_TAG, the work view is used.

The view center returned by this function is a point on the view plane at the
center of the viewing volume. If the viewing volume is symmetric (as it usually
is), then this point is also the view origin.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Tag - can not find view object from given view tag
3 = center pointer is NULL

Internal and External

UF_VIEW_ask_center
uc6431
 

gateway

Sets the fog options of the specified view. The view must have type
UF_VIEW_MODEL_TYPE.

Internal and External

UF_VIEW_ask_fog_options
UF_VIEW_fog_options_t

Originally released in NX4.0.
 

gateway

Set View Perspective

If view is NULL_TAG, the work view is used. The value of distance is used only
if option = 2. The value of eye_point is used only if option = 3.
If projection type is "PERSPECTIVE" and the EYE POINT is set to
be behind the current front Z clipping plane, the front Z clipping
plane is moved equal to the EYE POINT.

If the eye point is changed (option = 3), then the rotation matrix
of the view will also be changed.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Tag - can not find view object from given view tag
3 = Drafting View Not Valid
9 = View Not Active
31 = Invalid Distance
32 = Invalid Projection Option (not equal to 1, 2, or 3)

Internal and External

UF_VIEW_ask_perspective
uc6439
 

gateway

Set View matrix

If view is NULL_TAG, the work view is used.

The input axes do not have to be unit vectors. If the vectors are not
perpendicular, they will be made so by adjusting the Y-axis. An error
code = 32 will result if either of the input vectors is zero or if they
are parallel.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Tag - can not find view object from given view tag
9 = View Not Active
32 = Cross product of input X and Y axes is zero

Internal and External

UF_VIEW_ask_rotation
uc6434
 

gateway

Set View scale

If view is NULL_TAG, the work view is used.

Scales the specified view by the specified scale factor. This is the same
as changing the scale on the Zoom View menu and does not trigger a
re-gen. If there are multiple occurrences of the view in the layout, then
only one arbitrary occurrence is affected.

The view must be on the current layout. On a drawing layout, the view
must be a drawing view or a member work view.

Return Code
0 = OK
1 = View does not exist
2 = Invalid view tag -- cannot find view object from given view tag
31 = Input scale value is less than or equal to zero

Internal
 

gateway

Sets the shaded edge options of the specified view. The view must
have type UF_VIEW_MODEL_TYPE.

Internal and External

UF_VIEW_ask_shaded_edge_options
UF_VIEW_shaded_edge_options_t

Originally released in NX4.0.
 

gateway

Sets the rendering style and the edge display options of the
specified view. The view must have type UF_VIEW_MODEL_TYPE.

Internal and External

UF_VIEW_ask_surface_display_options
UF_VIEW_rendering_style_t
UF_VIEW_edge_display_options_t

Originally released in NX4.0.
 

gateway

Sets the lighting attributes for a single specified view. The lights are now
shared between the NX hardware shading and Photo shading.

If no lights were found with the part, the following 2 default lights are
automatically turned on in each view to ensure shaded display
becomes lit:
1. Light name: Default 1 Ambient
Light type: UF_VIEW_AMBIENT_LIGHT
2. Light name : Default 2 Up-Front Dist
Light type: UF_VIEW_DISTANT_LIGHT
Light mode: UF_VIEW_FIXED_TO_OBSERVER
Light Location: 0.8, 0.0, 0.4
Light to: 0.0, 0.0, 0.0

Internal and External

UF_VIEW_ask_view_light
 

gateway

Sets all of the visualization data. If you pass a NULL_TAG to the view
argument, then the work view is used. This is not intended to work
for drawing member views. For drawing member views use UF_DRAW_set_view_display

Please use
UF_VIEW_set_surface_display_options
and
UF_VIEW_set_fog_options
instead.

Internal and External

UF_DRAW_set_view_display

For example please refer to the example

In the V15.0 release, new fields were added to the
UF_VIEW_visualization_s data structure.
In NX4.0, this function is superceded by
UF_VIEW_set_surface_display_options and UF_VIEW_set_fog_options.
 

gateway

Sets the X and Y clip boundaries of the given view. The clip boundaries
define a rectangle in on the Z = 0 rectangle of View Space.

This function is primarily intended for use by specialized applications such
as Translators. It is a low-level access function which only modifies the
view's data base setting for the XY clip boundaries.

If the view is currently displayed, the display of the view is not modified by
this function, and if the view is later saved, the clip boundaries given to
this function are overwritten. If this is not what you need, consider using
uc6431 (Set View Center and Scale), which, for displayed views, modifies the
displayed parameters of the view (and not the data base parameters), and for
non-displayed views modifies the data base parameters of the view. Or,
consider using UF_VIEW_pan_view and/or UF_VIEW_zoom_view, which work only on
displayed views, without regenerating the display of the view.

This function is unusual in that, unlike most Open API functions, the
coordinate space is View Space. View Space is parallel to the screen, with
the center of the view at (0,0,0). The view center is mapped from Absolute
Space to View Space by applying first the view rotation, then the view
translation to it. The scale in View Space is the same as in Absolute Space.

Internal and External

UF_VIEW_ask_xy_clip
 

gateway

Set View Z-Clipping Planes

If view is NULL_TAG, the work view is used. The values of distance are
ignored if the corresponding clipping plane is disabled (status) or
auto-set. Using auto-set calculates the plane to be the minimum (for
front plane) or maximum (for back plane) distance that displays all
objects.

You cannot disable clipping planes in a view that has 3D vectors (see
Uc6440 - Read view display type), and you cannot disable the front
clipping plane in perspective views (see uc6439 - Set view
perspective).

If the projection type is "PERSPECTIVE" and the front Z clipping
plane is in front of the EYE POINT (see uc6438 - Read view
perspective), the front Z clipping plane moves to the EYE POINT.
Return Codes of 33 and 34 are warnings only.

Return Code
0 = OK
1 = View Does Not Exist
2 = Invalid View Tag - can not find view object from given view tag
3 = View Has 3D Vectors - Can Not
Remove Clipping Planes
4 = Either status or distance pointer is NULL
9 = View Not Active
31 = Front Plane Behind Back Plane
33 = Perspective View - Can Not Remove
Front Plane
34 = Perspective View - Front Plane Moved
To Eye Point

Internal and External

UF_VIEW_ask_Z_clip
uc6437
 

gateway

Unexpands the current work view. If the view is already unexpanded
or if the current layout is a single view then the request is ignored. An
active layout must currently exist. The layout can contain a drawing.
If the expanded view is a drawing member view, then the drawing is
restored. Unexpanding a drawing member view is equivalent to
exiting the Work In Member View mode.

Internal
 

gateway

Updates the display of the specified view when losses in resolution
occur due to zooming or any incorrect operations that may affect the
display. This is the same as the update option on the View menu. If
there is nothing to update, the function is ignored. If there are
multiple occurrences of the view in the layout, then only one arbitrary
occurrence is updated. The view must be on the current layout.

Internal
 

gateway

Scales the specified view by the specified scale factor. This is the same
as changing the scale on the Zoom View menu and does not trigger a
regen. If there are multiple occurrences of the view in the layout, then
only one arbitrary occurrence is affected.

The view must be on the current layout. On a drawing layout, the view
must be a drawing view or a member work view.

Internal
 

gateway