ConstructionPlaneInput.setByDistanceOnPath Method
Parent Object:
ConstructionPlaneInputDefined in namespace "adsk::fusion" and the header file is <Fusion/Construction/ConstructionPlaneInput.h>
Description
This input method is for creating a construction plane normal to, and at specified distance along, a path defined by an edge or sketch profile. 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.setByDistanceOnPath(pathEntity, distance) |
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.
#include <Fusion/Construction/ConstructionPlaneInput.h>
returnValue = constructionPlaneInput_var->setByDistanceOnPath(pathEntity, distance);
|
Return Value
| boolean |
Returns true if the creation of the ConstructionPlaneInput is successful. |
Parameters
| pathEntity |
Base |
The path can be an edge, sketch curve, or a path of multiple entities. |
| distance |
ValueInput |
The distance is a value from 0 to 1 indicating the position along the path where 0 is at the start and 1 is at the end. |
Samples
Version
Introduced in version August 2014
