UserCoordinateSystemGeometry.createByPlanarFace Method

Parent Object: UserCoordinateSystemGeometry

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/Construction/UserCoordinateSystemGeometry.h>

Description

Creates a new transient UserCoordinateSystemGeometry object based on a Profile and a curve defining that profile. A UserCoordinateSystemGeometry object can be used to create a User Coordinate System.

This is a static method.


returnValue = adsk.fusion.UserCoordinateSystemGeometry.createByPlanarFace(face, edge, keyPointType)

This is a static method.


#include <Fusion/Construction/UserCoordinateSystemGeometry.h>

returnValue = adsk::fusion::UserCoordinateSystemGeometry::createByPlanarFace(face, edge, keyPointType);

Return Value

Type	Description
UserCoordinateSystemGeometry	Returns the transient UserCoordinateSystemGeometry object that can be used to create a User Coordinate System or null in the case of a failure.

Parameters

Name	Type	Description
face	BRepFace	The planar BRepFace object.
edge	BRepEdge	A BRepEdge edge object that is one of the edges of the specified face. This argument can be null in the case where the keyPointType is CenterKeypoint indicating the center of the face is to be used. When an edge is used, the keyPointType specifies the position along the edge for the keypoint.
keyPointType	UserCoordinateSystemKeyPointTypes	Specifies the position along the edge where the joint keypoint will be located. For open edges this can be StartKeyPoint, MiddleKeyPoint, or EndKeyPoint. For closed edges (i.e. circles), it must be CenterKeyPoint. When no edge is specified, it must be CenterKeyPoint indicating the center of area of the face is to be used.

Version

Introduced in version May 2026