ConstructionSnapPoint Object

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

Description

A transient value object describing a snap-point selection passed to construction-geometry inputs (such as ConstructionAxisInput.setByTwoSnapPoints). A ConstructionSnapPoint mirrors what the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a snap-point type that classifies the selection.

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().

create

Creates a new transient ConstructionSnapPoint.

Only the host entity is required. The remaining arguments fall back to sensible defaults:

  • referenceEntity defaults to null.
  • point defaults to a point derived from the entity that is appropriate for the given snap-point type (for example the midpoint of an edge for EdgeMidConstructionSnapPointType or the centroid of a planar face for FaceCenterConstructionSnapPointType).
  • snapPointType defaults to DefaultConstructionSnapPointType, which stores the supplied (or entity-derived) point with no further classification.

A point must still be supplied for the "TangentOn..." snap-point types, because those identify an arbitrary location on a curved surface that cannot be derived from the face alone.

Properties

Name Description
entity The host entity the snap point is taken on.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
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():
point The picked 3D point in world space.
referenceEntity The optional reference entity. Returns null when the snap point does not need a reference entity.
snapPointType The snap-point type classifying this selection.

Accessed From

ConstructionSnapPoint.create

Samples

Name Description
Construction Axis API Sample Demonstrates creating construction axis in various ways.
Construction Plane API Sample Demonstrates creating construction plane by different ways.

Version

Introduced in version September 2026