ConstructionPlaneInput.setByOffset 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 is offset from a planar face or construction plane at a specified distance. 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.setByOffset(planarEntity, offset)
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

#include <Fusion/Construction/ConstructionPlaneInput.h>

returnValue = constructionPlaneInput_var->setByOffset(planarEntity, offset);
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByOffset(planarEntity, offset);

Return Value

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

Parameters

Name Type Description
planarEntity Base A plane, planar face or construction plane from which to create the offset plane.
offset ValueInput ValueInput object that specifies the offset distance for 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.
Loft Feature API Sample

Demonstrates creating a new loft feature.

Before running: No open document is required; the script creates a new design (or additional documents) as it runs.

Version

Introduced in version August 2014