ConstructionPlaneInput.setByTwoPlanes 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 at the midpoint between two planar faces or construction planes. 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.setByTwoPlanes(planarEntityOne, planarEntityTwo)
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

#include <Fusion/Construction/ConstructionPlaneInput.h>

returnValue = constructionPlaneInput_var->setByTwoPlanes(planarEntityOne, planarEntityTwo);
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByTwoPlanes(planarEntityOne, planarEntityTwo);

Return Value

Type Description
boolean Returns true if the creation of the ConstructionPlaneInput is successful. This will fail if the two planes are co-planar.

Parameters

Name Type Description
planarEntityOne Base The first planar face or construction plane to create a bisecting plane between
planarEntityTwo Base The second planar face or construction plane to create a bisecting plane between

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