SketchAlongPathBuilder Class

class NXOpen.SketchAlongPathBuilder

Bases: NXOpen.Builder

Use the NXOpen.SketchAlongPathBuilder to create or reattach a NXOpen.Sketch along a path.

To create a new instance of this class, use NXOpen.SketchCollection.CreateSketchAlongPathBuilder()

Default values.

Property	Value
ShowAllDatumAxes	True
SketchOrient	Automatic

New in version NX5.0.0.

Properties

Property	Description
Axis	Returns the horizontal reference
NextThroughPointSolution	Returns the parameter indicating the location of the next solution
OrientingFace	Returns the orienting faces to evaluate X and Y axis of sketch if NXOpen.SketchAlongPathBuilderSketchOrientationType is NXOpen.SketchAlongPathBuilderSketchOrientationType.RelativeToFace.
PlaneLocation	Returns the plane location
PlaneOrientation	Returns or sets the plane orientation type
PlaneOrientationAxis	Returns or sets the plane orientation axis for one of the types of Normal to Vector, Parallel to Vector and Through Axis
ReverseAxis	Returns or sets the flag to indicate the horizontal reference axis is reversed
ReversePlaneNormal	Returns or sets the flag to indicate the plane normal is reversed
Section	Returns the path
ShowAllDatumAxes	Returns or sets the flag to create all datum axes for path having shared edge.
SketchOrient	Returns or sets the sketch orientation method as NXOpen.SketchAlongPathBuilderSketchOrientationType
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

SketchAlongPathBuilderPlaneOrientationType Enumeration	Indicates the orientation of the plane
SketchAlongPathBuilderSketchOrientationType Enumeration	Indicates the sketch orientation method.

Property Detail

Axis

SketchAlongPathBuilder.Axis

Returns the horizontal reference

-------------------------------------

Getter Method

Signature Axis

Returns:The sketch horizontal reference (X-axis) Return type:NXOpen.SelectIReferenceAxis

New in version NX5.0.0.

License requirements: None.

NextThroughPointSolution

SketchAlongPathBuilder.NextThroughPointSolution

Returns the parameter indicating the location of the next solution

-------------------------------------

Getter Method

Signature NextThroughPointSolution

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

OrientingFace

SketchAlongPathBuilder.OrientingFace

Returns the orienting faces to evaluate X and Y axis of sketch if NXOpen.SketchAlongPathBuilderSketchOrientationType is NXOpen.SketchAlongPathBuilderSketchOrientationType.RelativeToFace.

The datum axes are evaluated as tangent and normal of the orienting face.

-------------------------------------

Getter Method

Signature OrientingFace

Returns: Return type:NXOpen.ScCollector

New in version NX6.0.0.

License requirements: None.

PlaneLocation

SketchAlongPathBuilder.PlaneLocation

Returns the plane location

-------------------------------------

Getter Method

Signature PlaneLocation

Returns: Return type:NXOpen.GeometricUtilities.OnPathDimensionBuilder

New in version NX5.0.0.

License requirements: None.

PlaneOrientation

SketchAlongPathBuilder.PlaneOrientation

Returns or sets the plane orientation type

-------------------------------------

Getter Method

Signature PlaneOrientation

Returns: Return type:NXOpen.SketchAlongPathBuilderPlaneOrientationType

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlaneOrientation

Parameters:planeOrientationType (NXOpen.SketchAlongPathBuilderPlaneOrientationType) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

PlaneOrientationAxis

SketchAlongPathBuilder.PlaneOrientationAxis

Returns or sets the plane orientation axis for one of the types of “Normal to Vector”, “Parallel to Vector” and “Through Axis”

-------------------------------------

Getter Method

Signature PlaneOrientationAxis

Returns:The plane orientation axis Return type:NXOpen.Direction

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlaneOrientationAxis

Parameters:vector (NXOpen.Direction) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

ReverseAxis

SketchAlongPathBuilder.ReverseAxis

Returns or sets the flag to indicate the horizontal reference axis is reversed

-------------------------------------

Getter Method

Signature ReverseAxis

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReverseAxis

Parameters:reverseAxis (bool) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

ReversePlaneNormal

SketchAlongPathBuilder.ReversePlaneNormal

Returns or sets the flag to indicate the plane normal is reversed

-------------------------------------

Getter Method

Signature ReversePlaneNormal

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReversePlaneNormal

Parameters:reversePlaneNormal (bool) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

Section

SketchAlongPathBuilder.Section

Returns the path

-------------------------------------

Getter Method

Signature Section

Returns: Return type:NXOpen.Section

New in version NX5.0.0.

License requirements: None.

ShowAllDatumAxes

SketchAlongPathBuilder.ShowAllDatumAxes

Returns or sets the flag to create all datum axes for path having shared edge.

This option is applicable only when NXOpen.SketchAlongPathBuilderSketchOrientationType is NXOpen.SketchAlongPathBuilderSketchOrientationType.RelativeToFace

-------------------------------------

Getter Method

Signature ShowAllDatumAxes

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowAllDatumAxes

Parameters:showAllDatumAxes (bool) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

SketchOrient

SketchAlongPathBuilder.SketchOrient

Returns or sets the sketch orientation method as NXOpen.SketchAlongPathBuilderSketchOrientationType

-------------------------------------

Getter Method

Signature SketchOrient

Returns: Return type:NXOpen.SketchAlongPathBuilderSketchOrientationType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SketchOrient

Parameters:sketchOrientMethod (NXOpen.SketchAlongPathBuilderSketchOrientationType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)

Method Detail

Validate

SketchAlongPathBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.