ConstructionPlaneInput.setByPerpendicularToPlane Method

This input method creates a construction plane that is perpendicular to the input face or plane. 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

Python
C++
TypeScript 🧪

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

# Uses no optional arguments.
returnValue = constructionPlaneInput_var.setByPerpendicularToPlane(planarEntity)

# Uses optional arguments.
returnValue = constructionPlaneInput_var.setByPerpendicularToPlane(planarEntity, distance, referenceEntity, useUDirection)

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

#include <Fusion/Construction/ConstructionPlaneInput.h>

// Uses no optional arguments.
returnValue = constructionPlaneInput_var->setByPerpendicularToPlane(planarEntity);

// Uses optional arguments.
returnValue = constructionPlaneInput_var->setByPerpendicularToPlane(planarEntity, distance, referenceEntity, useUDirection);

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

// Uses no optional arguments.
returnValue = constructionPlaneInput_var.setByPerpendicularToPlane(planarEntity);

// Uses Optional arguments.
returnValue = constructionPlaneInput_var.setByPerpendicularToPlane(planarEntity, distance, referenceEntity, useUDirection);

Parameters

planarEntity

Base

The face or plane the new construction plane will be perpendicular to. This may be a planar BRepFace, a cylindrical/conical/toroidal BRepFace, a ConstructionPlane, a Profile, or a Sketch (the sketch must contain at least one profile).

distance

ValueInput

An optional ValueInput specifying the offset distance of the perpendicular plane from its base position. Pass null to default to zero.

This is an optional argument whose default value is null.

referenceEntity

Base

An optional reference entity that the new plane passes through. Supported types: BRepVertex, ConstructionPoint, SketchPoint, planar BRepFace, or ConstructionPlane. Pass null to omit (the plane is then positioned by `distance` along the perpendicular direction from a point on `planarEntity`).

This is an optional argument whose default value is null.

useUDirection

boolean

True to align the perpendicular plane with the U axis of the reference face; false to align with the V axis. Defaults to true.

This is an optional argument whose default value is True.

ConstructionPlaneInput.setByPerpendicularToPlane Method

Description

Syntax

Return Value

Parameters

Version

Type	Description
boolean	Returns true if the construction plane definition is successful.

Name	Type	Description
planarEntity	Base	The face or plane the new construction plane will be perpendicular to. This may be a planar BRepFace, a cylindrical/conical/toroidal BRepFace, a ConstructionPlane, a Profile, or a Sketch (the sketch must contain at least one profile).
distance	ValueInput	An optional ValueInput specifying the offset distance of the perpendicular plane from its base position. Pass null to default to zero. This is an optional argument whose default value is null.
referenceEntity	Base	An optional reference entity that the new plane passes through. Supported types: BRepVertex, ConstructionPoint, SketchPoint, planar BRepFace, or ConstructionPlane. Pass null to omit (the plane is then positioned by `distance` along the perpendicular direction from a point on `planarEntity`). This is an optional argument whose default value is null.
useUDirection	boolean	True to align the perpendicular plane with the U axis of the reference face; false to align with the V axis. Defaults to true. This is an optional argument whose default value is True.