nxopen.features

Interface HelixBuilder

public interface HelixBuilder

Represents a Helix builder
To create a new instance of this class, use FeatureCollection.createHelixBuilder(nxopen.features.Helix)
Default values.

Property	Value
LengthMethod	Limits
PitchLaw.Function	ft
PitchLaw.LawType	Constant
PitchLaw.Parameter	t
SizeOption	Diameter
TurnDirection	RightHand
Type	AlongVector

Created in NX8.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HelixBuilder.LengthMethods Method for defining the length
static class	HelixBuilder.OrientationOptions Orientation options for along spine type
static class	HelixBuilder.SizeOptions Option indicating how size is defined
static class	HelixBuilder.TurnDirections Option indicating direction of the turn
static class	HelixBuilder.Types Type of helix

Method Summary

Modifier and Type	Method and Description
double	angleTolerance() Returns the angle tolerance License requirements: None.
CoordinateSystem	coordinateSystem() Returns the coordinate system License requirements: None.
double	distanceTolerance() Returns the distance tolerance License requirements: None.
OnPathDimensionBuilder	endLimit() Returns the end limit License requirements: None.
void	evaluate() Evaluates the curve License requirements: features_modeling ("FEATURES MODELING") .
HelixBuilder.LengthMethods	lengthMethod() Returns the length method License requirements: None.
String	numberOfTurns() Returns the number of turns License requirements: None.
HelixBuilder.OrientationOptions	orientationOption() Returns the orientation option License requirements: None.
LawBuilder	pitchLaw() Returns the pitch License requirements: None.
void	setAngleTolerance(double angleTolerance) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setCoordinateSystem(CoordinateSystem coordinateSystem) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setDistanceTolerance(double distanceTolerance) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setLengthMethod(HelixBuilder.LengthMethods lengthMethod) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setNumberOfTurns(String numberOfTurns) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOrientationOption(HelixBuilder.OrientationOptions orientationOption) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setSizeOption(HelixBuilder.SizeOptions sizeOption) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setTurnDirection(HelixBuilder.TurnDirections turnDirection) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setType(HelixBuilder.Types type) License requirements: solid_modeling ("SOLIDS MODELING") .
LawBuilder	sizeLaw() Returns the size law License requirements: None.
HelixBuilder.SizeOptions	sizeOption() Returns the size option License requirements: None.
Section	spine() Returns the length spine License requirements: None.
Expression	startAngle() Returns the start angle License requirements: None.
OnPathDimensionBuilder	startLimit() Returns the start limit License requirements: None.
HelixBuilder.TurnDirections	turnDirection() Returns the turn direction License requirements: None.
HelixBuilder.Types	type() Returns the type License requirements: None.

Method Detail

type

HelixBuilder.Types type()
                 throws NXException,
                        RemoteException

Returns the type
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setType

void setType(HelixBuilder.Types type)
      throws NXException,
             RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

type -

Throws:

NXException

RemoteException

coordinateSystem

CoordinateSystem coordinateSystem()
                           throws NXException,
                                  RemoteException

Returns the coordinate system
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setCoordinateSystem

void setCoordinateSystem(CoordinateSystem coordinateSystem)
                  throws NXException,
                         RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

coordinateSystem -

Throws:

NXException

RemoteException

startAngle

Expression startAngle()
               throws NXException,
                      RemoteException

Returns the start angle
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

spine

Section spine()
       throws NXException,
              RemoteException

Returns the length spine
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

orientationOption

HelixBuilder.OrientationOptions orientationOption()
                                           throws NXException,
                                                  RemoteException

Returns the orientation option
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setOrientationOption

void setOrientationOption(HelixBuilder.OrientationOptions orientationOption)
                   throws NXException,
                          RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

orientationOption -

Throws:

NXException

RemoteException

sizeOption

HelixBuilder.SizeOptions sizeOption()
                             throws NXException,
                                    RemoteException

Returns the size option
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setSizeOption

void setSizeOption(HelixBuilder.SizeOptions sizeOption)
            throws NXException,
                   RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

sizeOption -

Throws:

NXException

RemoteException

sizeLaw

LawBuilder sizeLaw()
            throws NXException,
                   RemoteException

Returns the size law
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

pitchLaw

LawBuilder pitchLaw()
             throws NXException,
                    RemoteException

Returns the pitch
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

lengthMethod

HelixBuilder.LengthMethods lengthMethod()
                                 throws NXException,
                                        RemoteException

Returns the length method
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setLengthMethod

void setLengthMethod(HelixBuilder.LengthMethods lengthMethod)
              throws NXException,
                     RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

lengthMethod -

Throws:

NXException

RemoteException

numberOfTurns

String numberOfTurns()
              throws NXException,
                     RemoteException

Returns the number of turns
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setNumberOfTurns

void setNumberOfTurns(String numberOfTurns)
               throws NXException,
                      RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

numberOfTurns -

Throws:

NXException

RemoteException

startLimit

OnPathDimensionBuilder startLimit()
                           throws NXException,
                                  RemoteException

Returns the start limit
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

endLimit

OnPathDimensionBuilder endLimit()
                         throws NXException,
                                RemoteException

Returns the end limit
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

turnDirection

HelixBuilder.TurnDirections turnDirection()
                                   throws NXException,
                                          RemoteException

Returns the turn direction
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setTurnDirection

void setTurnDirection(HelixBuilder.TurnDirections turnDirection)
               throws NXException,
                      RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

turnDirection -

Throws:

NXException

RemoteException

distanceTolerance

double distanceTolerance()
                  throws NXException,
                         RemoteException

Returns the distance tolerance
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setDistanceTolerance

void setDistanceTolerance(double distanceTolerance)
                   throws NXException,
                          RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

distanceTolerance -

Throws:

NXException

RemoteException

angleTolerance

double angleTolerance()
               throws NXException,
                      RemoteException

Returns the angle tolerance
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setAngleTolerance

void setAngleTolerance(double angleTolerance)
                throws NXException,
                       RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

angleTolerance -

Throws:

NXException

RemoteException

evaluate

void evaluate()
       throws NXException,
              RemoteException

Evaluates the curve
License requirements: features_modeling ("FEATURES MODELING")
.
Created in NX8.5.0

Throws:

NXException

RemoteException