nxopen

Interface SketchAlongPathBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface SketchAlongPathBuilder
extends Builder

Use the SketchAlongPathBuilder to create or reattach a Sketch along a path.
To create a new instance of this class, use SketchCollection.createSketchAlongPathBuilder(nxopen.Sketch)
Default values.

Property	Value
ShowAllDatumAxes	True
SketchOrient	Automatic

Created in NX5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SketchAlongPathBuilder.PlaneOrientationType Indicates the orientation of the plane
static class	SketchAlongPathBuilder.SketchOrientationType Indicates the sketch orientation method.

Method Summary

Modifier and Type	Method and Description
SelectIReferenceAxis	axis() Returns the horizontal reference License requirements: None.
double	nextThroughPointSolution() Returns the parameter indicating the location of the next solution License requirements: None.
ScCollector	orientingFace() Returns the orienting faces to evaluate X and Y axis of sketch if SketchAlongPathBuilder.SketchOrientationType is SketchAlongPathBuilder.SketchOrientationType.RELATIVE_TO_FACE .
OnPathDimensionBuilder	planeLocation() Returns the plane location License requirements: None.
SketchAlongPathBuilder.PlaneOrientationType	planeOrientation() Returns the plane orientation type License requirements: None.
Direction	planeOrientationAxis() Returns the plane orientation axis for one of the types of "Normal to Vector", "Parallel to Vector" and "Through Axis" License requirements: None.
boolean	reverseAxis() Returns the flag to indicate the horizontal reference axis is reversed License requirements: None.
boolean	reversePlaneNormal() Returns the flag to indicate the plane normal is reversed License requirements: None.
Section	section() Returns the path License requirements: None.
void	setPlaneOrientation(SketchAlongPathBuilder.PlaneOrientationType planeOrientationType) License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT") .
void	setPlaneOrientationAxis(Direction vector) License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT") .
void	setReverseAxis(boolean reverseAxis) License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT") .
void	setReversePlaneNormal(boolean reversePlaneNormal) License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT") .
void	setShowAllDatumAxes(boolean showAllDatumAxes) License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT") .
void	setSketchOrient(SketchAlongPathBuilder.SketchOrientationType sketchOrientMethod) License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT") .
boolean	showAllDatumAxes() Returns the flag to create all datum axes for path having shared edge.
SketchAlongPathBuilder.SketchOrientationType	sketchOrient() Returns the sketch orientation method as SketchAlongPathBuilder.SketchOrientationType License requirements: None.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

section

Section section()
         throws NXException,
                RemoteException

Returns the path
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

planeLocation

OnPathDimensionBuilder planeLocation()
                              throws NXException,
                                     RemoteException

Returns the plane location
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

planeOrientation

SketchAlongPathBuilder.PlaneOrientationType planeOrientation()
                                                      throws NXException,
                                                             RemoteException

Returns the plane orientation type
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setPlaneOrientation

void setPlaneOrientation(SketchAlongPathBuilder.PlaneOrientationType planeOrientationType)
                  throws NXException,
                         RemoteException

License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")
.
Created in NX5.0.0

Parameters:

planeOrientationType -

Throws:

NXException

RemoteException

reversePlaneNormal

boolean reversePlaneNormal()
                    throws NXException,
                           RemoteException

Returns the flag to indicate the plane normal is reversed
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setReversePlaneNormal

void setReversePlaneNormal(boolean reversePlaneNormal)
                    throws NXException,
                           RemoteException

License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")
.
Created in NX5.0.0

Parameters:

reversePlaneNormal -

Throws:

NXException

RemoteException

planeOrientationAxis

Direction planeOrientationAxis()
                        throws NXException,
                               RemoteException

Returns the plane orientation axis for one of the types of "Normal to Vector", "Parallel to Vector" and "Through Axis"
License requirements: None.

Created in NX5.0.0

Returns:

The plane orientation axis

Throws:

NXException

RemoteException

setPlaneOrientationAxis

void setPlaneOrientationAxis(Direction vector)
                      throws NXException,
                             RemoteException

License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")
.
Created in NX5.0.0

Parameters:

vector -

Throws:

NXException

RemoteException

axis

SelectIReferenceAxis axis()
                   throws NXException,
                          RemoteException

Returns the horizontal reference
License requirements: None.

Created in NX5.0.0

Returns:

The sketch horizontal reference (X-axis)

Throws:

NXException

RemoteException

reverseAxis

boolean reverseAxis()
             throws NXException,
                    RemoteException

Returns the flag to indicate the horizontal reference axis is reversed
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setReverseAxis

void setReverseAxis(boolean reverseAxis)
             throws NXException,
                    RemoteException

License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")
.
Created in NX5.0.0

Parameters:

reverseAxis -

Throws:

NXException

RemoteException

nextThroughPointSolution

double nextThroughPointSolution()
                         throws NXException,
                                RemoteException

Returns the parameter indicating the location of the next solution
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

sketchOrient

SketchAlongPathBuilder.SketchOrientationType sketchOrient()
                                                   throws NXException,
                                                          RemoteException

Returns the sketch orientation method as SketchAlongPathBuilder.SketchOrientationType
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setSketchOrient

void setSketchOrient(SketchAlongPathBuilder.SketchOrientationType sketchOrientMethod)
              throws NXException,
                     RemoteException

License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")
.
Created in NX6.0.0

Parameters:

sketchOrientMethod -

Throws:

NXException

RemoteException

orientingFace

ScCollector orientingFace()
                   throws NXException,
                          RemoteException

Returns the orienting faces to evaluate X and Y axis of sketch if SketchAlongPathBuilder.SketchOrientationType is SketchAlongPathBuilder.SketchOrientationType.RELATIVE_TO_FACE . The datum axes are evaluated as tangent and normal of the orienting face.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

showAllDatumAxes

boolean showAllDatumAxes()
                  throws NXException,
                         RemoteException

Returns the flag to create all datum axes for path having shared edge. This option is applicable only when SketchAlongPathBuilder.SketchOrientationType is SketchAlongPathBuilder.SketchOrientationType.RELATIVE_TO_FACE
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setShowAllDatumAxes

void setShowAllDatumAxes(boolean showAllDatumAxes)
                  throws NXException,
                         RemoteException

License requirements: solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")
.
Created in NX6.0.0

Parameters:

showAllDatumAxes -

Throws:

NXException

RemoteException