uc5822 (view source)
Defined in: uf_patt.h
Overview
Read Pattern Data. Returns pattern data.
Return
1 = np1 is not a pattern object
Environment
Internal and External
Required License(s)
gateway
int uc5822
(
tag_t object,
char name [ UF_OBJ_NAME_BUFSIZE ] ,
char file_name [ MAX_FSPEC_BUFSIZE ] ,
int * view_dependent_status,
int * layer,
int * retrieval_status,
double transform_data [ 13 ]
)
| tag_t | object | Input | Pattern Object Identifier |
| char | name [ UF_OBJ_NAME_BUFSIZE ] | Output | Pattern Name |
| char | file_name [ MAX_FSPEC_BUFSIZE ] | Output | Corresponding Archive Part File Name
In NX Manager mode this will be an encoded part filename. |
| int * | view_dependent_status | Output | View Dependent Status
0 = Model Object
1 = View Dependent Entity |
| int * | layer | Output | Layer |
| int * | retrieval_status | Output | Retrieval Status
0 = Good, Pattern Data is in Dynamic
Memory
1 = Error Occurred During Pattern Data
Retrieval |
| double | transform_data [ 13 ] | Output | Pattern Information, rr7 is a 13 element array
rr7[13]
[0] - [8] - Pattern Orientation Matrix
[9]-[11] - Pattern Origin
[12] - Pattern Scale |
uc5823 (view source)
Defined in: uf_patt.h
Overview
Retrieve pattern data as a single pattern object and return its identifier.
Return
Error Status
< 0 = Error
0 = No Error
1 = Part File Not Found
3 = Part In Checkpoint Format
5 = Part Failed Revision Check
6 = No Pattern Data In Part
14= Pattern data must be recreated
20= Invalid Pattern Name
21= Matrix Is Not Orthogonal
22= Scale Must Be Positive
Environment
Internal and External
Required License(s)
gateway
int uc5823
(
char * file_name,
char * pattern_name,
int autoscale_option,
double transform_data [ 13 ] ,
tag_t * pattern
)
| char * | file_name | Input | Pattern File Specification |
| char * | pattern_name | Input | Pattern Name
" " = Part Name |
| int | autoscale_option | Input | Autoscale Option
1 = Yes - Autoscale If Metric/English
Conflict
2 = No - Continue if Metric/English Conflict |
| double | transform_data [ 13 ] | Input | Pattern Real Data, rp4[13]
[0] - [8] Pattern Orientation Matrix
[9] - [11] Pattern Origin
[12] Pattern Scale |
| tag_t * | pattern | Output | Pattern object identifier |
uc5824 (view source)
Defined in: uf_patt.h
Overview
Cycles pattern errors.
Environment
Internal and External
Required License(s)
gateway
int uc5824
(
int * ia1,
char cr2 [ MAX_FSPEC_BUFSIZE ]
)
| int * | ia1 | Input / Output | On input the error found by the last call to this routine.
If this routine has not been called yet, then set ia1 to 0
to start cycling. On output this will be the next error.
The cycling is complete when a 0 is returned. |
| char | cr2 [ MAX_FSPEC_BUFSIZE ] | Output | Part Name Where Error Occurred |
uf5891 (view source)
Defined in: uf_patt.h
Overview
uf5891 read/set pattern display parameters - Internal and External
Please replace calls to uc5891 with UF_PATT_ask_params and
UF_PATT_set_params
Required License(s)
gateway
void uf5891
(
tag_t * np1,
int * ip2,
int * ia3
)
UF_PATT_ask_params (view source)
Defined in: uf_patt.h
Overview
Reads the pattern's display parameters.
Environment
Internal and External
See Also
History
Original release was in V14.0.
Required License(s)
gateway
int UF_PATT_ask_params
(
tag_t tag,
UF_PATT_switch_t * origin_display,
UF_PATT_switch_t * max_min_display,
UF_PATT_switch_t * control_pt_display
)
| tag_t | tag | Input | Tag of pattern entity (or NULL_TAG for global setting) |
| UF_PATT_switch_t * | origin_display | Output | Origin marker display status
UF_PATT_on = display status is on
UF_PATT_off = display status is off |
| UF_PATT_switch_t * | max_min_display | Output | Max/Min box display status
UF_PATT_on = display status is on
UF_PATT_off = display status is off |
| UF_PATT_switch_t * | control_pt_display | Output | Control point display status
UF_PATT_on = display status is on
UF_PATT_off = display status is off |
UF_PATT_create_point (view source)
Defined in: uf_patt.h
Overview
Creates a pattern point entity at the specified coordinates.
Environment
Internal and External
See Also
History
Original release was in V14.0.
Required License(s)
gateway
int UF_PATT_create_point
(
double coordinates [ 3 ] ,
tag_t * tag
)
| double | coordinates [ 3 ] | Input | Coordinates of pattern point in model space |
| tag_t * | tag | Output | Tag of newly created pattern point entity |
UF_PATT_is_archiving_on (view source)
Defined in: uf_patt.h
Overview
Reads the pattern's data archiving switch.
Environment
Internal and External
See Also
History
Original release was in V14.0.
Required License(s)
gateway
int UF_PATT_is_archiving_on
(
logical * on
)
| logical * | on | Output | Curent setting of the pattern data archiving switch
TRUE = switch is on
FALSE = switch is off |
UF_PATT_is_shading_on (view source)
Defined in: uf_patt.h
Overview
n
Reads the pattern's shaded data archiving switch.
Environment
Internal and External
See Also
History
Original release was in V14.0.
Required License(s)
gateway
int UF_PATT_is_shading_on
(
logical * on
)
| logical * | on | Output | Read the pattern's shaded data archiving switch
TRUE = switch is on
FALSE = switch is off |
UF_PATT_set_archiving (view source)
Defined in: uf_patt.h
Overview
Sets the pattern's data archiving switch.
NOTE: Setting the pattern's data archiving switch to UF_PATT_off
also sets the Shaded Data Archiving switch to UF_PATT_off since
shaded data cannot be filed unless pattern data is filed. This is
consistent with the interactive functionality.
Environment
Internal and External
See Also
History
Original release was in V14.0.
Required License(s)
gateway
int UF_PATT_set_archiving
(
UF_PATT_switch_t setting
)
| UF_PATT_switch_t | setting | Input | Set the pattern's data archiving switch.
UF_PATT_on = set switch on
UF_PATT_off = set switch off |
UF_PATT_set_params (view source)
Defined in: uf_patt.h
Overview
Set the pattern's display parameters.
Environment
Internal and External
See Also
History
Original release was in V14.0.
Required License(s)
gateway
int UF_PATT_set_params
(
tag_t tag,
UF_PATT_switch_t origin_status,
UF_PATT_switch_t max_min_status,
UF_PATT_switch_t control_pt_status
)
| tag_t | tag | Input | Tag of pattern entity (or NULL_TAG for global setting) |
| UF_PATT_switch_t | origin_status | Input | Origin marker display status
UF_PATT_on = display status is on
UF_PATT_off = display status is off |
| UF_PATT_switch_t | max_min_status | Input | Max/Min box display status
UF_PATT_on = display status is on
UF_PATT_off = display status is off |
| UF_PATT_switch_t | control_pt_status | Input | Control point display status
UF_PATT_on = display status is on
UF_PATT_off = display status is off |
UF_PATT_set_shading (view source)
Defined in: uf_patt.h
Overview
Set the pattern's shaded data archiving switch.
NOTE: Setting the pattern's shaded data archiving switch to
UF_PATT_on also sets the pattern's data archiving switch to
UF_PATT_on since shaded data cannot be filed unless pattern data is
filed. This is consistent with the interactive functionality.
Environment
Internal and External
See Also
History
Original release was in V14.0.
Required License(s)
gateway
int UF_PATT_set_shading
(
UF_PATT_switch_t setting
)
| UF_PATT_switch_t | setting | Input | Set the pattern's shaded data archiving switch.
UF_PATT_on = set switch on
UF_PATT_off = set switch off |