ConfigurationJointSnap Object Preview

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Configurations/ConfigurationJointSnap.h>

PreviewThis 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

This object represents an individual joint snap that has been defined for a ConfigurationJointSnapColumn. Multiple joint snaps can be defined for a column and then one of those joint snaps is specified in each cell of the column.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
deleteMe Deletes this joint snap.

Properties

Name Description
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
jointGeometry Gets and sets the JointGeometry object for this snap.
name Gets and sets the name of the snap.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():

Accessed From

ConfigurationJointSnapCell.snap, ConfigurationJointSnaps.add, ConfigurationJointSnaps.item, ConfigurationJointSnaps.itemByName

Version

Introduced in version September 2024