ConstructionSnapPoint.create Method

Description

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.

Syntax

Python
C++
TypeScript 🧪

This is a static method.

# Uses no optional arguments.
returnValue = adsk.fusion.ConstructionSnapPoint.create(entity)

# Uses optional arguments.
returnValue = adsk.fusion.ConstructionSnapPoint.create(entity, referenceEntity, point, snapPointType)

This is a static method.

#include <Fusion/Construction/ConstructionSnapPoint.h>

// Uses no optional arguments.
returnValue = adsk::fusion::ConstructionSnapPoint::create(entity);

// Uses optional arguments.
returnValue = adsk::fusion::ConstructionSnapPoint::create(entity, referenceEntity, point, snapPointType);

This is a static method.

// Uses no optional arguments.
returnValue = adsk.fusion.ConstructionSnapPoint.create(entity);

// Uses optional arguments.
returnValue = adsk.fusion.ConstructionSnapPoint.create(entity, referenceEntity, point, snapPointType)

Parameters

entity

Base

The host entity the snap point is taken on. Valid types depend on the snap-point type and include BRepEdge, BRepFace, BRepVertex, SketchPoint, SketchCurve, ConstructionPoint, ConstructionAxis and ConstructionPlane.

referenceEntity

Base

Optional. A reference entity that disambiguates the snap (for example the host face used to qualify an edge-mid snap). Defaults to null when the snap point does not require a reference entity.

This is an optional argument whose default value is null.

point

Point3D

Optional. The picked 3D point in world space. When omitted, a default point is derived from the entity that is appropriate for the requested snap-point type. A point must be supplied for the TangentOn... snap-point types, since those identify an arbitrary location on a curved surface.

This is an optional argument whose default value is null.

snapPointType

ConstructionSnapPointTypes

Optional. The kind of snap classification for the supplied point. Use DefaultConstructionSnapPointType when no semantic classification applies. Defaults to DefaultConstructionSnapPointType.

This is an optional argument whose default value is ConstructionSnapPointTypes.DefaultConstructionSnapPointType.

Samples

Construction Axis API Sample

Demonstrates creating construction axis in various ways.

Construction Plane API Sample

Demonstrates creating construction plane by different ways.

ConstructionSnapPoint.create Method

Description

Syntax

Return Value

Parameters

Samples

Version

Type	Description
ConstructionSnapPoint	Returns the transient ConstructionSnapPoint or null if the inputs were invalid.

Name	Type	Description
entity	Base	The host entity the snap point is taken on. Valid types depend on the snap-point type and include BRepEdge, BRepFace, BRepVertex, SketchPoint, SketchCurve, ConstructionPoint, ConstructionAxis and ConstructionPlane.
referenceEntity	Base	Optional. A reference entity that disambiguates the snap (for example the host face used to qualify an edge-mid snap). Defaults to null when the snap point does not require a reference entity. This is an optional argument whose default value is null.
point	Point3D	Optional. The picked 3D point in world space. When omitted, a default point is derived from the entity that is appropriate for the requested snap-point type. A point must be supplied for the TangentOn... snap-point types, since those identify an arbitrary location on a curved surface. This is an optional argument whose default value is null.
snapPointType	ConstructionSnapPointTypes	Optional. The kind of snap classification for the supplied point. Use DefaultConstructionSnapPointType when no semantic classification applies. Defaults to DefaultConstructionSnapPointType. This is an optional argument whose default value is ConstructionSnapPointTypes.DefaultConstructionSnapPointType.