ConfigurationJointSnaps.add Method

Parent Object: ConfigurationJointSnaps

Preview 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.

Defined in namespace "adsk::fusion" and the header file is <Fusion/Configurations/ConfigurationJointSnaps.h>

Description

Adds a new snap to the column. The snaps associated with the column can be used in the cells in the column.

"configurationJointSnaps_var" is a variable referencing a ConfigurationJointSnaps object.returnValue = configurationJointSnaps_var.add(name, jointGeometry)

"configurationJointSnaps_var" is a variable referencing a ConfigurationJointSnaps object.

#include <Fusion/Configurations/ConfigurationJointSnaps.h>

returnValue = configurationJointSnaps_var->add(name, jointGeometry);

Return Value

Type	Description
ConfigurationJointSnap	Returns the newly created ConfigurationJointSnap.

Parameters

Name	Type	Description
name	string	The name of the new snap. The name must be unique with respect to the other snaps defined for this column. An empty string can be provided, which will cause Fusion to use a default naming scheme to create a name.
jointGeometry	Base	A JointGeometry object that defines how the snap is defined. When creating the JointGeometry object, it must be limited to geometry in the occurrence associated with the column.

Version

Introduced in version September 2024