This function is retired. See more information in the 'Remarks' section below.
This method has been retired and replaced by the setByPath method. The setByPath method lets you choose how the distance is specified; proportional distance (which is the only option with setByDistanceOnPath) or the physical distance along the path.
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.
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object. |
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object. |
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object. |
| Type | Description |
| boolean | Returns true if the construction plane definition is successful. |
| Name | Type | Description |
| 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. |
| Name | Description |
| Construction Plane API Sample | Demonstrates creating construction plane by different ways. |
| Create a User Coordinate System | Demonstrates the creation of a user coordinate system at the end of a selected sketch curve or edge. |