ConstructionAxisInput.setByCircularFace Method

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

Description

This input method is for creating an axis coincident with the axis of a cylindrical, conical or torus face.

This can result in a parametric or non-parametric construction axis depending on whether the parent component is parametric or is a direct edit component.

Syntax

"constructionAxisInput_var" is a variable referencing a ConstructionAxisInput object.
returnValue = constructionAxisInput_var.setByCircularFace(circularFace)
"constructionAxisInput_var" is a variable referencing a ConstructionAxisInput object.

#include <Fusion/Construction/ConstructionAxisInput.h>

returnValue = constructionAxisInput_var->setByCircularFace(circularFace);

Return Value

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

Parameters

Name Type Description
circularFace BRepFace The face from a cylinder, cone, or torus.

Samples

Name Description
Construction Axis API Sample Demonstrates creating construction axis in various ways.

Version

Introduced in version August 2014