ConstructionPlaneInput.setByTwoEdges Method

Parent Object: ConstructionPlaneInput
Defined in namespace "adsk::fusion" and the header file is <Fusion/Construction/ConstructionPlaneInput.h>

Description

This input method is for creating a construction plane that passes through two coplanar linear entities or axes. Defines a plane by specifying two coplanar linear entities. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component.

Syntax

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByTwoEdges(linearEntityOne, linearEntityTwo)
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

#include <Fusion/Construction/ConstructionPlaneInput.h>

returnValue = constructionPlaneInput_var->setByTwoEdges(linearEntityOne, linearEntityTwo);
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByTwoEdges(linearEntityOne, linearEntityTwo);

Return Value

Type Description
boolean Returns true if the creation of the ConstructionPlaneInput is successful. This will fail if the two linear entities are not coplanar.

Parameters

Name Type Description
linearEntityOne Base The first of two coplanar linear entities to define the plane
linearEntityTwo Base The second of two coplanar linear entities to define the plane

Samples

Name Description
Construction Plane API Sample

Demonstrates creating construction planes using ConstructionPlaneInput: offset from a profile, angle, tangent, two planes, two edges, three points, three snap points, tangent at a point, and along a path. Also shows reading healthState, errorOrWarningMessage, and renaming planes.

Before running: No open document is required. The script creates a new design, sketches a circle and lines, extrudes a cylinder, then exercises the construction plane APIs on that model. Run from Scripts and Add-Ins (Python/C++/TypeScript) in the DESIGN workspace.

Version

Introduced in version August 2014