AdditiveSetupUtility.generateSubNest Method

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Starts a Sub-Nest generation defined by the given input on this additive setup and returns immediately with an AdditiveSubNestFuture used to monitor progress and retrieve any errors or warnings. The arrangement task runs asynchronously on the document task registry.

The Sub-Nest IronObject created by this call is transient: parameters and the input object are consumed to drive the arrangement task, but no persistent Sub-Nest operation is added to the document tree (mirrors the in-product Sub-Nest dialog behavior).

Syntax

returnValue = additiveSetupUtility_var.generateSubNest(input)

#include <Cam/ModifyUtility/AdditiveSetupUtility.h>

returnValue = additiveSetupUtility_var->generateSubNest(input);

returnValue = additiveSetupUtility_var.generateSubNest(input);

Return Value

Parameters

Version