API Documentation > Miscellaneous > Object ProCurves > Function ProCurvesCollect
Function ProCurvesCollect
Description
Asks the user to interactively create a collection of chains
Replacement in Object TOOLKIT:
Synopsis
#include <ProCollect.h>
ProCurvesCollect
(
/* (In)
Array allocated by the Creo Parametric TOOLKIT application defining which portion of the user interface that the Creo Parametric user will be allowed to use while in the dialog. Following instruction types are supported: PRO_CHAINCOLLUI_ONE_BY_ONE PRO_CHAINCOLLUI_TAN_CHAIN PRO_CHAINCOLLUI_CURVE_CHAIN PRO_CHAINCOLLUI_BNDRY_CHAIN PRO_CHAINCOLLUI_SURF_CHAIN PRO_CHAINCOLLUI_LOG_EDGE PRO_CHAINCOLLUI_FROM_TO PRO_CHAINCOLLUI_ALLOW_LENGTH_ADJUSTMENT PRO_CHAINCOLLUI_ALLOW_ALL PRO_CHAINCOLLUI_ALLOW_EXCLUDED PRO_CHAINCOLLUI_ALLOW_APPENDED
*/
int n_types
/* (In)
The number of instruction types in the array.
*/
ProCrvcollFilter filter_func
/* (In)
The filter function called just after each selection of a curve or edge Pass NULL to skip this filter.
*/
ProAppData app_data
/* (In)
Application data passed to the filter function. Can be NULL.
*/
ProCollection* collection
/* (In)
The resulting collection object. This pointer must be allocated by calling ProCrvcollectionAlloc(). If the input collection contains instructions already, they will be appended into the details shown by the dialog.
*/
ProSelection** sel_list
/* (Out)
Pointer to a ProArray (allocated by the function) of ProSelection objects describing the curves and edges resulting from the collection. Free this array using ProSelectionarrayFree(). Pass NULL if not interested in this information at this time.
NOTE: If using a collection that permits "extended" and "trimmed" chains, the selection list might not be 100% accurate (because there will be no selection representing the extended and trimmed item(s).
*/
int* n_sel
/* (Out)
Number of entries in sel_list, if sel_list is not NULL.
*/
)
Returns
The function succeeded.
One or more arguments is invalid.
The user aborted the collection activity.
The input ProCollection contains instructions that cannot be resolved into a single chain.
See Also
Sample Code References
User Guide References
Was this helpful?