UF_DISP_srfanl_data_s (view source)
 
Defined in: uf_disp_types.h
 
Also known as:
 
Overview
Structure definition for face analysis display parameters. These
parameters affect the display of all faces whose "face analysis"
attribute is TRUE, in all "face analysis" views. Each of
these parameters, is settable by the NX user using the
"face analysis" dialog. The data_range for different analysis type
is automatically calculated.


Data Members

spike_length
double
spike length for a hedgehog display

ref_plane [ 6 ]
double
reference plane, point on a plane & normal. Used
for 'sectional radius' and 'distance' display.

ref_vector [ 3 ]
double
reference vector, used for 'normal radius' and 'slope' display

mid_value
double
mid value of the scalar function data range for GAUSSIAN type

scale_factor
double
scale factor applied to the data range
The range of the scalar function in all
'face analysis' faces in the NX part is called
the 'data-range'. Some portion of this range
is mapped to displayed colors (from red through
green to blue). This mapped range is centered
at 'mid_value' and has size equal to the size of
the data_range times the 'scale_factor'. The
'mid_value' and 'scale_factor' are directly
controllable by the NX user, using sliders on
the 'face analysis' dialog.
This is only for GAUSSIAN type

anal_facet_edge_tol
double
This is the facet edge tolerance for
shaded display. This value is ignored
unless the surf_anal_fineness member
is set to UF_DISP_SHADED_CUSTOMIZE_TOL.
This is an upper
bound on the distance from each
chord to the curve it is approximating
The recommend value is .005 inch.Smaller
values result in finer display but
causes degraded performance. A
value of .01 would give a coarse
display, .0005 would give an extra
fine display but also causes slower
performance.
Refer to the tolerance mapping table

anal_facet_chord_tol
double
This is the facet chord distance
for shaded display. This value is ignored
unless the surf_anal_fineness member
is set to UF_DISP_SHADED_CUSTOMIZE_TOL.
This is an upper
bound on the distance from a
positions on a facet to the surface.
The recommended value is .005 inch. A
smaller value results in a finer
display but causes degraded
performance. A value of .01 would
give a coarse display, .0025 would
give a fine display, .001 an extra
fine display and .0005 an ultra
fine display.
Refer to the tolerance mapping table

anal_facet_angle_tol
double
This is the facet angle tolerance
for shaded display. This value is ignored
unless the surf_anal_fineness member
is set to UF_DISP_SHADED_CUSTOMIZE_TOL.
This is an upper bound on the angular
deviation between the surface normals
at any two positions under the facet.
The recommended value is 15 degrees.
A smaller value results in a finer
display, but causes slower
performance. A coarse display would
use a tolerance of 0.0, 15.0 gives
the standard angle, a value of 6.0
would give an extra fine display,
and a value of 3.0 an ultra fine
display.
Refer to the tolerance mapping table

anal_facet_width_tol
double
Facet width tolerance for analysis
display. This value is ignored
unless the surf_anal_fineness member
is set to UF_DISP_SHADED_CUSTOMIZE_TOL.
This value specifies the
maximum width of a facet. The
recommended value is .3. A smaller
tolerance value causes a finer display
but also causes slower performance. A
value of .075 would give a fine display,
.02 an extra fine display, and .005
an ultra fine display.
Refer to the tolerance mapping table

surf_anal_data
int
one of the 11 scalar functions to display
UF_DISP_GAUSSIAN_CURVATURE
UF_DISP_MEAN_CURVATURE
UF_DISP_MINIMUM_CURVATURE
UF_DISP_MAXIMUM_CURVATURE
UF_DISP_NORMAL_CURVATURE
UF_DISP_SECTIONAL_CURVATURE
UF_DISP_SLOPE
UF_DISP_DISTANCE
UF_DISP_U_CURVATURE
UF_DISP_V_CURVATURE
UF_DISP_REFLECTION

surf_anal_fineness
int
one of the 6 values of 'fineness'
UF_DISP_SHADED_COARSE
UF_DISP_SHADED_STANDARD
UF_DISP_SHADED_FINE
UF_DISP_SHADED_EXTRA_FINE
UF_DISP_SHADED_ULTRA_FINE
UF_DISP_SHADED_CUSTOMIZE_TOL
Refer to fineness/shaded tolerance mapping table

refl_type
int
reflection type values are:
UF_DISP_REFL_TYPE_BLACKLINES
UF_DISP_REFL_TYPE_BLKWHTLINES
UF_DISP_REFL_TYPE_COLOREDLINES
UF_DISP_REFL_TYPE_SIMHORIZON
UF_DISP_REFL_TYPE_PHOTOHORIZON
UF_DISP_REFL_TYPE_USERIMAGE

num_refl_lines
int
The number of reflection lines. Must be a
power of 2 between 2 and
UF_DISP_MAX_REFLECTION_LINES

refl_horiz_vert
int
Determines whether to display horizontal,
vertical, or all reflection lines values are:
UF_DISP_REFL_HORIZ
UF_DISP_REFL_VERT
UF_DISP_REFL_HORIZ_AND_VERT

thick_refl_lines
int
One of 3 thicknesses of reflection lines
UF_DISP_REFL_THIN
UF_DISP_REFL_MEDIUM
UF_DISP_REFL_THICK

reflectivity
int
surface reflectivity (blending) factor.
Must be a value between
UF_DISP_REFL_REFLECTIVITY_MIN which results
in no reflection and
UF_DISP_REFL_REFLECTIVITY_MAX, which is the
default, where the surface is absolutely
reflective.

refl_move_type
int
reflection movement type. To use, set it to
one of the following types:
UF_DISP_REFL_TRANSLATE_HORIZ
UF_DISP_REFL_TRANSLATE_VERT
UF_DISP_REFL_ROTATE

refl_move_position
int
reflection translation or rotation factor.
This is used when the reflection movement
type has been set. Must be a value between
UF_DISP_REFL_TRANSLATE_MIN and
UF_DISP_REFL_TRANSLATE_MAX when refl_move_type
is set to translate or between
UF_DISP_REFL_ROTATE_ANGLE_MIN and
UF_DISP_REFL_ROTATE_ANGLE_MAX when refl_move_type
is set to rotate.

refl_smooth_lines
int
Determines whether reflection lines should be
anti-aliased. Must be set to TRUE, the
default or FALSE. Effects both
UF_DISP_REFL_TYPE_BLACKLINES,
UF_DISP_REFL_TYPE_BLKWHTLINES and
UF_DISP_REFL_TYPE_COLOREDLINES

refl_user_image_filename [ UF_CFI_MAX_PATH_NAME_SIZE ]
char
Stores user specified reflection image file name.
Effects UF_DISP_REFL_TYPE_USERIMAGE

num_contours
int
Determines the number of displayed contour
lines, between 2 and UF_DISP_MAX_CONTOUR_LINES

surf_anal_display
int
The type of face analysis display for GAUSSIAN:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

legend_color_type_gaussian
int
This is blend/sharp type for GAUSSIAN type

legend_color_num_gaussian
int
This is number of color option for GAUSSIAN type

surf_anal_display_mean
int
The type of face analysis display for MEAN:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_mean
double
mid value of the scalar function data range for MEAN type

scale_factor_mean
double
scale factor applied to the data range for MEAN

legend_color_type_mean
int
This is blend/sharp type for MEAN type

legend_color_num_mean
int
This is number of color option for MEAN type

surf_anal_display_max
int
The type of face analysis display for MAX:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_max
double
mid value of the scalar function data range for MAX type

scale_factor_max
double
scale factor applied to the data range for MAX type

legend_color_type_max
int
This is blend/sharp type for MAX type

legend_color_num_max
int
This is number of color option for MAX type

surf_anal_display_min
int
The type of face analysis display for MIN:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_min
double
mid value of the scalar function data range for MIN type

scale_factor_min
double
scale factor applied to the data range for MIN type

legend_color_type_min
int
This is blend/sharp type for MIN type

legend_color_num_min
int
This is number of color option for MIN type

surf_anal_display_normal
int
The type of face analysis display for NORMAL:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_normal
double
mid value of the scalar function data range for NORMAL type

scale_factor_normal
double
scale factor applied to the data range for NORMAL type

legend_color_type_normal
int
This is blend/sharp type for NORMAL type

legend_color_num_normal
int
This is number of color option for NORMAL type

surf_anal_display_sec
int
The type of face analysis display for SECTIONAL:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_sec
double
mid value of the scalar function data range for SECTIONAL type

scale_factor_sec
double
scale factor applied to the data range for SECTIONAL type

legend_color_type_sec
int
This is blend/sharp type for SECTIONAL type

legend_color_num_sec
int
This is number of color option for SECTIONAL type

surf_anal_display_u
int
The type of face analysis display for U:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_u
double
mid value of the scalar function data range for U type

scale_factor_u
double
scale factor applied to the data range for U

legend_color_type_u
int
This is blend/sharp type for U type

legend_color_num_u
int
This is number of color option for U type

surf_anal_display_v
int
The type of face analysis display for V:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_v
double
mid value of the scalar function data range for V type

scale_factor_v
double
scale factor applied to the data range for V type

legend_color_type_v
int
This is blend/sharp type for V type

legend_color_num_v
int
This is number of color option for V type

surf_anal_display_slope
int
The type of face analysis display for SLOPE:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_slope
double
mid value of the scalar function data range for SLOPE type

scale_factor_slope
double
scale factor applied to the data range for SLOPE

legend_color_type_slope
int
This is blend/sharp type for SLOPE type

legend_color_num_slope
int
This is number of color option for SLOPE type

surf_anal_display_distance
int
The type of face analysis display for DISTANCE:
UF_DISP_FRINGE
UF_DISP_HEDGEHOG
UF_DISP_CONTOUR_LINES

mid_value_distance
double
mid value of the scalar function data range for DISTANCE type

scale_factor_distance
double
scale factor applied to the data range for DISTANCE

legend_color_type_distance
int
This is blend/sharp type for DISTANCE type

legend_color_num_distance
int
This is number of color option for DISTANCE type

surf_anal_display_refl
int
This is the reflection display UF_DISP_REFL_LINES