HealPath Class¶
-
class
NXOpen.Routing.
HealPath
¶ Bases:
NXOpen.TransientObject
Represents a
NXOpen.Routing.HealPath
object which holds the data used in the creation of the heal path spline.New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
ReverseEnd | Returns the reverse end end. |
ReverseStart | Returns the reverse start end. |
Methods¶
Method | Description |
---|---|
Dispose | Frees the object from memory. |
GetAllData | Get all the data associated with the heal path creation. |
GetEndExtension | Get end extension. |
GetEndParms | Get end parameters. |
GetEndPoint | Get the end point. |
GetEndVector | Get the end vector. |
GetHealMethod | Get heal method. |
GetSplineOptions | Get spline options (by pole/by points). |
GetStartExtension | Get start extension. |
GetStartParms | Get start parameters. |
GetStartPoint | Get the start point. |
GetStartVector | Get the start vector. |
SetAllData | Set all the data associated with the heal path creation. |
SetEndExtension | Set end extension. |
SetEndParms | Set end parameters. |
SetEndPoint | Set the end point. |
SetEndVector | Set the end vector. |
SetHealMethod | Set heal method. |
SetReverseEnd | Sets the reverse end end. |
SetReverseStart | Sets the reverse start end. |
SetSplineOptions | Set spline options. |
SetStartExtension | Set start extension. |
SetStartParms | Set start parameters. |
SetStartPoint | Set the start point. |
SetStartVector | Set the start vector. |
Property Detail¶
ReverseEnd¶
-
HealPath.
ReverseEnd
¶ Returns the reverse end end.
Reverse the direction tha tthe end of the heal path takes when the path is healed.
-------------------------------------
Getter Method
Signature
ReverseEnd
Returns: Return type: bool New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
ReverseStart¶
-
HealPath.
ReverseStart
¶ Returns the reverse start end.
Reverse the direction that the start of the heal path takes when the path is healed.
-------------------------------------
Getter Method
Signature
ReverseStart
Returns: Return type: bool New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
Dispose¶
-
HealPath.
Dispose
¶ Frees the object from memory.
After this method is called, it is illegal to use the object.
Signature
Dispose()
New in version NX5.0.0.
License requirements: None.
GetAllData¶
-
HealPath.
GetAllData
¶ Get all the data associated with the heal path creation.
Signature
GetAllData()
Returns: a tuple Return type: A tuple consisting of (startPoint, endPoint, startVector, endVector, startParms, endParms, startExtension, endExtension, reverseStart, reverseEnd, healMethod, splineOptions). startPoint is a NXOpen.Point3d
. endPoint is aNXOpen.Point3d
. startVector is aNXOpen.Vector3d
. endVector is aNXOpen.Vector3d
. startParms is a float. endParms is a float. startExtension is a float. endExtension is a float. reverseStart is a bool. reverseEnd is a bool. healMethod is aNXOpen.Routing.HealMethod
. splineOptions is aNXOpen.Routing.SplineOptions
.New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetEndExtension¶
-
HealPath.
GetEndExtension
¶ Get end extension.
Signature
GetEndExtension()
Returns: Return type: float New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetEndParms¶
-
HealPath.
GetEndParms
¶ Get end parameters.
Signature
GetEndParms()
Returns: Return type: float New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetEndPoint¶
-
HealPath.
GetEndPoint
¶ Get the end point.
Queries from end object if input is origin.
Signature
GetEndPoint()
Returns: Return type: NXOpen.Point3d
New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetEndVector¶
-
HealPath.
GetEndVector
¶ Get the end vector.
Queries from end object if input is zero vector.
Signature
GetEndVector()
Returns: Return type: NXOpen.Vector3d
New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetHealMethod¶
-
HealPath.
GetHealMethod
¶ Get heal method.
Signature
GetHealMethod()
Returns: Return type: NXOpen.Routing.HealMethod
New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetSplineOptions¶
-
HealPath.
GetSplineOptions
¶ Get spline options (by pole/by points).
Signature
GetSplineOptions()
Returns: Return type: NXOpen.Routing.SplineOptions
New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetStartExtension¶
-
HealPath.
GetStartExtension
¶ Get start extension.
Signature
GetStartExtension()
Returns: Return type: float New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetStartParms¶
-
HealPath.
GetStartParms
¶ Get start parameters.
Signature
GetStartParms()
Returns: Return type: float New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetStartPoint¶
-
HealPath.
GetStartPoint
¶ Get the start point.
Queries from start object if input is origin.
Signature
GetStartPoint()
Returns: Return type: NXOpen.Point3d
New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
GetStartVector¶
-
HealPath.
GetStartVector
¶ Get the start vector.
Queries from start object if input is zero vector.
Signature
GetStartVector()
Returns: Return type: NXOpen.Vector3d
New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetAllData¶
-
HealPath.
SetAllData
¶ Set all the data associated with the heal path creation.
Signature
SetAllData(startPoint, endPoint, startVector, endVector, startParm, endParm, startExtension, endExtension, reverseStart, reverseEnd, healMethod, splineOptions)
Parameters: - startPoint (
NXOpen.Point3d
) – - endPoint (
NXOpen.Point3d
) – - startVector (
NXOpen.Vector3d
) – - endVector (
NXOpen.Vector3d
) – - startParm (float) –
- endParm (float) –
- startExtension (float) –
- endExtension (float) –
- reverseStart (bool) –
- reverseEnd (bool) –
- healMethod (
NXOpen.Routing.HealMethod
) – - splineOptions (
NXOpen.Routing.SplineOptions
) –
New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
- startPoint (
SetEndExtension¶
-
HealPath.
SetEndExtension
¶ Set end extension.
Signature
SetEndExtension(endExtension)
Parameters: endExtension (float) – New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetEndParms¶
-
HealPath.
SetEndParms
¶ Set end parameters.
Signature
SetEndParms(endParms)
Parameters: endParms (float) – New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetEndPoint¶
-
HealPath.
SetEndPoint
¶ Set the end point.
Signature
SetEndPoint(endPoint)
Parameters: endPoint ( NXOpen.Point3d
) –New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetEndVector¶
-
HealPath.
SetEndVector
¶ Set the end vector.
Signature
SetEndVector(endVector)
Parameters: endVector ( NXOpen.Vector3d
) –New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetHealMethod¶
-
HealPath.
SetHealMethod
¶ Set heal method.
Signature
SetHealMethod(healMethod)
Parameters: healMethod ( NXOpen.Routing.HealMethod
) –New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetReverseEnd¶
-
HealPath.
SetReverseEnd
¶ Sets the reverse end end.
Reverse the direction tha tthe end of the heal path takes when the path is healed.
Signature
SetReverseEnd(reverse)
Parameters: reverse (bool) – New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetReverseStart¶
-
HealPath.
SetReverseStart
¶ Sets the reverse start end.
Reverse the direction that the start of the heal path takes when the path is healed.
Signature
SetReverseStart(reverse)
Parameters: reverse (bool) – New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetSplineOptions¶
-
HealPath.
SetSplineOptions
¶ Set spline options.
Signature
SetSplineOptions(splineOptions)
Parameters: splineOptions ( NXOpen.Routing.SplineOptions
) –New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetStartExtension¶
-
HealPath.
SetStartExtension
¶ Set start extension.
Signature
SetStartExtension(startExtension)
Parameters: startExtension (float) – New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetStartParms¶
-
HealPath.
SetStartParms
¶ Set start parameters.
Signature
SetStartParms(startParms)
Parameters: startParms (float) – New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetStartPoint¶
-
HealPath.
SetStartPoint
¶ Set the start point.
Signature
SetStartPoint(startPoint)
Parameters: startPoint ( NXOpen.Point3d
) –New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)
SetStartVector¶
-
HealPath.
SetStartVector
¶ Set the start vector.
Signature
SetStartVector(startVector)
Parameters: startVector ( NXOpen.Vector3d
) –New in version NX5.0.0.
License requirements: routing_base (“Routing Basic”)