ConstructionPlaneInput.setByAngle 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 through an edge, axis or line at a specified angle. 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.setByAngle(linearEntity, angle, planarEntity)
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

#include <Fusion/Construction/ConstructionPlaneInput.h>

returnValue = constructionPlaneInput_var->setByAngle(linearEntity, angle, planarEntity);
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByAngle(linearEntity, angle, planarEntity);

Return Value

Type Description
boolean Returns true if the creation of the ConstructionPlaneInput is successful

Parameters

Name Type Description
linearEntity Base The axis about which to rotate the plane.
angle ValueInput The angle at which to create the plane.
planarEntity Base The planar face or construction plane the angle is measured from.

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