uf_sc.html

/*

uf_sc.h
File description:

User functions for smart containers and section builders.
***************************************************************************************************/

#ifndef UF_SC_H_INCLUDED
#define UF_SC_H_INCLUDED

#include <uf_sc_types.h>
#include <uf_curve.h>
#include <libufun_exports.h>

/*******************************************************************************
Initiate UF_SC_input_data_t

You need to call this function if you define this data to ensure that your UF
code will never have compile problems in future versions when we could add new
parameters to the data structure to enhance the functionality.

We will set all the parameters to be zero, false, or NULL except tolerances which
will use the modeling tolerances.

Environment: Internal and External
See Also: UF_MODL_free_sc_input_data

History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT void UF_MODL_init_sc_input_data
(
int rule_type, /* The input data type */
UF_SC_input_data_p_t rule /* <I/O> pointer to UF_SC_input_data_t structure */
);

/*******************************************************************************
Create a face container from the input rules. Return the error code.

If you want to change the features that have face containers,
you should not delete the existing face containers and create
new ones. You should change the face containers using the
functions UF_MODL_add_rules_to_face_container and/or
UF_MODL_remove_rules_from_face_container.

Environment: Internal and External
See Also: UF_MODL_ask_smart_face_container ,
UF_MODL_add_rules_to_face_container ,
UF_MODL_remove_rules_from_face_container
Example: ufd_modl_face_containers.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_create_smart_face_container
(
tag_t object_in_part , /* Object in the part in which the
face container object is to be created. */
int n_rules , /* The number of face container rules. */
int * rule_types , /* An array of the types for the face container rules.
The valid types are defined in uf_sc_types.h. */
UF_SC_input_data_t * rules , /* An array of face container rules.
The face container rule data are
defined in uf_sc_types.h. */
tag_t * face_container_tag /*<O> The tag of the face container */
);

/*******************************************************************************
Return the rules and the resulting faces of a face container.

If you want to change the features that have face containers,
you should not delete the existing face containers and create
new ones. You should change the face containers using the
functions UF_MODL_add_rules_to_face_container and/or
UF_MODL_remove_rules_from_face_container.

Environment: Internal and External
See Also: UF_MODL_create_smart_face_container ,
UF_MODL_add_rules_to_face_container ,
UF_MODL_remove_rules_from_face_container
Example: ufd_modl_face_containers.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_ask_smart_face_container
(
tag_t face_container_tag , /* The tag of the face container. */
int * n_rules , /*<O> The number of face container rules. */
int ** rule_types , /*<OF> An array of the types for the face container rules.
The valid types are defined in uf_sc_types.h. */
UF_SC_input_data_t ** rules , /*<OF> An array of face container rules.
The face container rule data are
defined in uf_sc_types.h. */
int * n_face_eids , /*<O> The number of resulting faces */
tag_t ** face_eids /*<OF> An array of resulting faces */
);

/*******************************************************************************
Add the rules to an existing face container. If any rules are already in the face
container, they are ignored.

Environment: Internal and External
See Also: UF_MODL_create_smart_face_container ,
UF_MODL_ask_rules_to_face_container ,
UF_MODL_remove_rules_from_face_container
Example: ufd_modl_face_containers.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_add_rules_to_face_container
(
int n_rules , /* The number of face container
rules to be removed. */
int * rule_types , /* The types of face container rules to be removed.
The valid types are defined in uf_sc_types.h. */
UF_SC_input_data_t * rules , /* The face container rules to be removed.
The face container rule data are
defined in uf_sc_types.h. */
tag_t face_container_tag /* The tag of the face container. */
);

/*******************************************************************************
Remove existing rules from a face container. If one of the input rules is
not in the container, an error will be returned.

Environment: Internal and External
See Also: UF_MODL_create_smart_face_container ,
UF_MODL_ask_rules_to_face_container ,
UF_MODL_add_rules_from_face_container
Example: ufd_modl_face_containers.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_remove_rules_from_face_container
(
int n_rules , /* The number of face container rules to be added. */
int * rule_types, /* The types of face container rules to be added.
The valid types are defined in uf_sc_types.h. */
UF_SC_input_data_t * rules , /* The face container rules to be added.
The face container rule data are
defined in uf_sc_types.h. */
tag_t face_container_tag /* The tag of the face container. */
);

/*******************************************************************************
Create a wireframe container from the input rules. Return the error code.

If you want to change the features that have wireframe containers,
you should not delete the existing wireframe containers and create
new ones. You should change the wireframe containers using the
functions UF_MODL_add_rules_to_wireframe_container and/or
UF_MODL_remove_rules_from_wireframe_container.

Environment: Internal and External
See Also: UF_MODL_ask_smart_wireframe_container ,
UF_MODL_add_rules_to_wireframe_container ,
UF_MODL_remove_rules_from_wireframe_container
Example: ufd_modl_wireframe_containers.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_create_smart_wireframe_container
(
tag_t object_in_part , /* Object in the part in which the
wireframe container object is to be created. */
int n_rules , /* The number of wireframe container rules. */
int * rule_types, /* An array of the types for the wireframe
container rules. The valid types are
defined in uf_sc_types.h. */
UF_SC_input_data_t * rules , /* An array of wireframe container rules.
The wireframe container rule data are
defined in uf_sc_types.h. */
tag_t * wireframe_container_tag /*<O> The tag of the wireframe container */
);

/*******************************************************************************
Return the rules and the resulting wireframe, curves or edges, of a wireframe container.

If you want to change the features that have wireframe containers,
you should not delete the existing wireframe containers and create
new ones. You should change the wireframe containers using the
functions UF_MODL_add_rules_to_wireframe_container and/or
UF_MODL_remove_rules_from_wireframe_container.

Environment: Internal and External
See Also: UF_MODL_create_smart_wireframe_container ,
UF_MODL_add_rules_to_wireframe_container ,
UF_MODL_remove_rules_from_wireframe_container
Example: ufd_modl_wireframe_containers.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_ask_smart_wireframe_container
(
tag_t wireframe_container_tag , /* The tag of the wireframe container. */
int * n_rules , /*<O> The number of wireframe container rules. */
int ** rule_types , /*<OF> An array of the types for the wireframe
container rules. The valid types are
defined in uf_sc_types.h. */
UF_SC_input_data_t ** rules , /*<OF> An array of wireframe container rules.
The wireframe container rule data are
defined in uf_sc_types.h. */
int * n_wireframe_eids , /*<O> The number of resulting wireframes */
tag_t ** wireframe_eids /*<OF> An array of resulting wireframes */
);

/*******************************************************************************
Add the rules to an existing wireframe container. If any rules are already in the wireframe
container, they are ignored.

Environment: Internal and External
See Also: UF_MODL_create_smart_wireframe_container ,
UF_MODL_ask_rules_to_wireframe_container ,
UF_MODL_remove_rules_from_wireframe_container
Example: ufd_modl_wireframe_containers.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_add_rules_to_wireframe_container
(
int n_rules , /* The number of wireframe container
rules to be removed. */
int * rule_types , /* The types of wireframe container rules
to be removed. The valid types are defined
in uf_sc_types.h. */
UF_SC_input_data_t * rules , /* The wireframe container rules to be removed.
The wireframe container rule data are
defined in uf_sc_types.h. */
tag_t wireframe_container_tag /* The tag of the wireframe container. */
);

/*******************************************************************************
Remove existing rules from a wireframe container. If one of the input rules is
not in the container, an error will be returned.

Environment: Internal and External
See Also: UF_MODL_create_smart_wireframe_container ,
UF_MODL_ask_rules_to_wireframe_container ,
UF_MODL_add_rules_from_wireframe_container
Example: ufd_modl_wireframe_containers.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_remove_rules_from_wireframe_container
(
int n_rules , /* The number of wireframe container
rules to be added. */
int * rule_types, /* The types of wireframe container rules
to be added. The valid types are defined
in uf_sc_types.h. */
UF_SC_input_data_t * rules , /* The wireframe container rules to be added.
The wireframe container rule data are
defined in uf_sc_types.h. */
tag_t wireframe_container_tag /* The tag of the wireframe container. */
);

/*******************************************************************************
Create a section builder from the input section rules. Return the error code.

If you want to change the features that have section builders,
you should not delete the existing section builders and create
new ones. You should change the section builders using the
functions UF_MODL_add_rules_to_section and/or
UF_MODL_remove_rules_from_section and/or
UF_MODL_set_start_and_direction_to_section.

Environment: Internal and External
See Also: UF_MODL_ask_section ,
UF_MODL_add_rules_to_section ,
UF_MODL_remove_rules_from_section ,
UF_MODL_set_start_and_direction_to_section
Example: ufd_modl_sections.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_create_section
(
tag_t object_in_part , /* Object in the part in which the
section builder object is to be created. */
int n_rules , /* The number of section rules. */
UF_SC_section_data_t * rules , /* An array of section rules.
The section rule data are
defined in uf_sc_types.h. */
tag_t starting_object , /* Optional.
If this option is not used, then
starting_object will be Zero. Otherwise,
the object, curve or edge, specifying
the starting of the section.
If the section is a loop, then the loop is started
by starting_object and the direction is followed the
input direction. If the section is not a loop,
then the section can be started by other object,
but the direction of the section is defined by
the starting_object and direction. */
double starting_point[3] , /* If starting_object is used, the origin of
the vector defined the direction of the section.
This point has to be on the starting object. */
double direction[3] , /* If starting_object is used, the direction of the
vector defined the direction of the section. */
logical allow_multiple_loops , /* If TRUE, the section may contain multiple loops.*/
tag_t * section_tag /*<O> The tag of the section builder */
);
/*******************************************************************************
Return the section rules, the starting object, and the direction flag of a section container.

If you want to change the features that have section builders,
you should not delete the existing section builders and create
new ones. You should change the section builders using the
functions UF_MODL_add_rules_to_section and/or
UF_MODL_remove_rules_from_section and/or
UF_MODL_set_start_and_direction_to_section.

Environment: Internal and External
See Also: UF_MODL_create_section ,
UF_MODL_add_rules_to_section ,
UF_MODL_remove_rules_from_section ,
UF_MODL_set_start_and_direction_to_section
Example: ufd_modl_sections.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_ask_section
(
tag_t section_tag , /* The tag of the section builder. */
int * n_rules , /*<O> The number of section builder rules. */
UF_SC_section_data_t ** rules , /*<O> An array of section builder rules.
The section builder rule data are
defined in uf_sc_types.h. */
tag_t * starting_object , /*<O> The object, curve or edge, specifying
the starting of the section.*/
double starting_point[3] , /* The origin of the vector defined the
direction of the section. This point
has to be on the starting object. */
double direction[3] /* The direction of the vector defined the
direction of the section. */
);
/*******************************************************************************
Set the starting object and the direction of a section.

Environment: Internal and External
See Also: UF_MODL_create_section ,
UF_MODL_ask_section ,
UF_MODL_add_rules_to_section ,
UF_MODL_remove_rules_from_section
Example: ufd_modl_sections.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_set_start_and_direction_to_section
(
tag_t starting_object , /* The object, curve or edge, specifying
the starting of the section.
If the section is a loop, then the loop is started
by starting_object and the direction is followed the
input direction. If the section is not a loop,
then the section can be started by other object,
but the direction of the section is defined by
the starting_object and direction. */
double starting_point[3] , /* The origin of the vector defined the direction of
the section. This point has to be on the starting object. */
double direction[3] , /* The direction of the vector defined the direction of
the section. */
tag_t section_tag /* The tag of the section builder. */
);
/*******************************************************************************
Add section rules to an existing section. If any rules are already in the section,
they are ignored.

Environment: Internal and External
See Also: UF_MODL_create_section ,
UF_MODL_ask_section ,
UF_MODL_remove_rules_from_section ,
UF_MODL_set_start_and_direction_to_section
Example: ufd_modl_sections.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_add_rules_to_section
(
int n_rules , /* The number of section builder rules. */
UF_SC_section_data_t * rules , /* An array of section builder rules.
The section builder rule data are
defined in uf_sc_types.h. */
tag_t section_tag /* The tag of the section builder. */
);

/*******************************************************************************
Remove section rules from an existing section. If one of the input rules is
not in the section, an error will be returned. The removed rules should be
obtained from UF_MODL_ask_section.

Environment: Internal and External
See Also: UF_MODL_create_section ,
UF_MODL_ask_section ,
UF_MODL_add_rules_to_section ,
UF_MODL_set_start_and_direction_to_section
Example: ufd_modl_sections.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_remove_rules_from_section
(
int n_rules , /* The number of section builder rules. */
UF_SC_section_data_t * rules , /* An array of section builder rules.
The section builder rule data are
defined in uf_sc_types.h. */
tag_t section_tag /* The tag of the section builder. */
);

/*******************************************************************************
Free the UF_MODL_free_sc_input_data.

Environment: Internal and External
See Also: UF_MODL_create_smart_face_container ,
UF_MODL_ask_smart_face_container ,
UF_MODL_create_smart_wireframe_container ,
UF_MODL_ask_smart_wireframe_container ,
UF_MODL_create_section ,
UF_MODL_ask_section
Example: ufd_modl_sections.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_free_sc_input_data
(
int sc_rule_type ,
UF_SC_input_data_p_t sc_rule
);

/*******************************************************************************
Free the UF_SC_section_data.

Environment: Internal and External
See Also: UF_MODL_create_section ,
UF_MODL_ask_section
Example: ufd_modl_sections.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_free_section_data
(
UF_SC_section_data_p_t section
);

/*******************************************************************************
Initialize the UF_SC_section_data.

Environment: Internal and External
See Also: UF_MODL_create_section ,
UF_MODL_ask_section ,
UF_MODL_free_section_data
Example: ufd_modl_sections.c
History: This function was originally released in NX2.
******************************************************************************/
extern UFUNEXPORT void UF_MODL_initialize_section_data
(
UF_SC_section_data_p_t section
);

/*******************************************************************************
Return the number of curves, the curves' data structures, and the
curves' positions in the input section.

Environment: Internal and External
See Also: UF_MODL_create_section ,
UF_MODL_ask_section ,
UF_MODL_free_section_data
UF_CURVE_free_curve_struct
History: This function was originally released in NX3.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_ask_output_curves_from_section
(
tag_t section , /* The input section */
int * n_curves , /* <O> The number of curves in the section */
int ** indices , /* <IOF> If NULL is passed in, then nothing is
returned. If a pointer is passed in,
then an array of integers will be allocated.
Each integer represents a position, starting
from 0, of the output curve in the section.
Do not change these integers. The array needed
to be free. */
UF_CURVE_struct_p_t ** curves /* <IOF> If NULL is passed in, then nothing is
returned. If a pointer is passed in,
then an array of UF_CURVE_struct_p_t will
be allocated. Each pointer represents a
output curve in the section. Do not change
these pointers. Free the pointers using
UF_CURVE_free_curve_struct. The array
needed to be free. */
);

/*******************************************************************************
Returns the underlying curve and corresponding start and end connector for
each of the output curves of a section, arranged in the same way as they are
used in the loops of the section.

Environment: Internal and External

History: This function was originally released in NX4.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_ask_input_curves_from_section
(
tag_t section , /* The input section */
int * n_loops, /* <O> The number of loops in the section. This argument cannot be NULL*/
int ** n_crv_each_loops, /* <OF> An integer array will be allocated, the size of which is the number
of loops in the section. Each element in the array
is the number of curves in each loop. This argument cannot be NULL.
The allocated memory needs to be freed.*/
UF_SC_section_output_data_p_t ** input_curves /* <OF> An array of an array of UF_SC_section_output_data_t will be allocated, where the ith row
represents the ith loop, and the jth column in the ith row reprsents
the input data for the jth curve in the ith loop. This argument can be NULL.
The start and end connectors and the corresponding points in (*input_curves)[i][j] will
be wrt the corresponding loop direction. The allocated memory needs to be freed.*/
);

/*******************************************************************************
Returns the subtype for an object of type UF_smart_container_type.
The subtypes are defined in uf_object_types.h

Environment: Internal and External

History: This function was originally released in NX4.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_ask_smart_container_subtype
(
tag_t smart_container_tag, /* The tag of the smart container */
int *smart_container_subtype /*<O> The subtype of smart container */
);

/*******************************************************************************
Returns the rule information and entities inside a container. For each rule,
this function returns the type of rule and container rule data.

Environment: Internal and External
See Also: UF_MODL_ask_smart_face_container ,
UF_MODL_ask_smart_wireframe_container

History: This function was originally released in NX401.
******************************************************************************/
extern UFUNEXPORT int UF_MODL_ask_container
(
tag_t container_tag, /* The input container */
int * n_rules, /* <O> The number of rules in the container */
int ** rule_types, /* <OF> An integer array will be allocated. Each element in the array
is the type of rule. The valid types are defined in uf_sc_types.h. The
allocated memory needs to be freed. */
UF_SC_input_data_p_t * rules, /* <OF> An array of container rules will be allocated. The container
rule data are defined in uf_sc_types.h. The allocated memory needs to be freed. */
int * n_entities, /* <O> The number of resulting entities. */
tag_t ** entities /* <OF> An array of resulting entities will allocated. The entities will
be either faces or wireframes or both. The allocated memory needs to be freed. */
);

#undef EXPORTLIBRARY
#endif /* UF_SC_H_INCLUDED */