CurveShapingBuilder Class¶
-
class
NXOpen.GeometricUtilities.
CurveShapingBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.GeometricUtilities.CurveShapingBuilder
.This class allows shaping of curves by identifying key points on them and modifying the location of those points. It also allows constraining curve ends. .. versionadded:: NX7.5.0
Properties¶
Property | Description |
---|---|
CanMoveAlongCurve | Returns or sets the value indicating if point should be moved along curve. |
ConstraintManager | Returns the constraint manager. |
EndContinuity | Returns or sets the continuity at end of the curve |
HasLinearTransition | Returns or sets the value indicating if transition type is linear |
InsertionMethod | Returns or sets the point insertion method |
MovementMethod | Returns or sets the movement method |
MovementPlane | Returns or sets the movement plane |
MovementVector | Returns or sets the movement vector |
Number | Returns or sets the number of points to be inserted |
OrientExpress | Returns the orient express object |
SelectCurves | Returns the curve selection for point insertion |
SpecifyPoints | Returns the specified points to define insertion point locations |
StartContinuity | Returns or sets the continuity at start of the curve |
Tag | Returns the Tag for this object. |
WCSOption | Returns or sets the WCS option |
Methods¶
Method | Description |
---|---|
AddCurve | Adds a curve for shaping |
ApplyParameterValue | Applies parameter value from a key point to a group of key points without affecting curve shape |
Deform | Deforms curves based on active points |
DeleteAllPoints | Deletes all points on a curve. |
RemoveCurve | Removes a curve |
SetActivePoints | Sets key points that are selected or will be moved |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
CurveShapingBuilderInsertionMethodOptions Enumeration | Point insertion option |
CurveShapingBuilderMovementMethodType Enumeration | Curve parameter points movement types |
CurveShapingBuilderWCSOptionType Enumeration | WCS principal axis or plane types |
Property Detail¶
CanMoveAlongCurve¶
-
CurveShapingBuilder.
CanMoveAlongCurve
¶ Returns or sets the value indicating if point should be moved along curve.
A key point is moved along the curve in order to change its parametric location without affecting curve shape.
-------------------------------------
Getter Method
Signature
CanMoveAlongCurve()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CanMoveAlongCurve(canMoveAlongCurve)
Parameters: canMoveAlongCurve (bool) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
ConstraintManager¶
-
CurveShapingBuilder.
ConstraintManager
¶ Returns the constraint manager.
Allows definition of key points to be used to shape the curve.
-------------------------------------
Getter Method
Signature
ConstraintManager()
Returns: Return type: NXOpen.Features.GeometricConstraintDataManager
New in version NX7.5.0.
License requirements: None.
EndContinuity¶
-
CurveShapingBuilder.
EndContinuity
¶ Returns or sets the continuity at end of the curve
-------------------------------------
Getter Method
Signature
EndContinuity()
Returns: Return type: NXOpen.GeometricUtilities.ContinuityContinuityTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndContinuity(endContinuity)
Parameters: endContinuity ( NXOpen.GeometricUtilities.ContinuityContinuityTypes
) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
HasLinearTransition¶
-
CurveShapingBuilder.
HasLinearTransition
¶ Returns or sets the value indicating if transition type is linear
-------------------------------------
Getter Method
Signature
HasLinearTransition()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HasLinearTransition(hasLinear)
Parameters: hasLinear (bool) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
InsertionMethod¶
-
CurveShapingBuilder.
InsertionMethod
¶ Returns or sets the point insertion method
-------------------------------------
Getter Method
Signature
InsertionMethod()
Returns: Return type: NXOpen.GeometricUtilities.CurveShapingBuilderInsertionMethodOptions
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InsertionMethod(insertionMethod)
Parameters: insertionMethod ( NXOpen.GeometricUtilities.CurveShapingBuilderInsertionMethodOptions
) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
MovementMethod¶
-
CurveShapingBuilder.
MovementMethod
¶ Returns or sets the movement method
-------------------------------------
Getter Method
Signature
MovementMethod()
Returns: Return type: NXOpen.GeometricUtilities.CurveShapingBuilderMovementMethodType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementMethod(movementMethod)
Parameters: movementMethod ( NXOpen.GeometricUtilities.CurveShapingBuilderMovementMethodType
) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
MovementPlane¶
-
CurveShapingBuilder.
MovementPlane
¶ Returns or sets the movement plane
-------------------------------------
Getter Method
Signature
MovementPlane()
Returns: Return type: NXOpen.Plane
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementPlane(movementPlane)
Parameters: movementPlane ( NXOpen.Plane
) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
MovementVector¶
-
CurveShapingBuilder.
MovementVector
¶ Returns or sets the movement vector
-------------------------------------
Getter Method
Signature
MovementVector()
Returns: Return type: NXOpen.Direction
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementVector(movementVector)
Parameters: movementVector ( NXOpen.Direction
) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Number¶
-
CurveShapingBuilder.
Number
¶ Returns or sets the number of points to be inserted
-------------------------------------
Getter Method
Signature
Number()
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Number(number)
Parameters: number (int) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
OrientExpress¶
-
CurveShapingBuilder.
OrientExpress
¶ Returns the orient express object
-------------------------------------
Getter Method
Signature
OrientExpress()
Returns: Return type: NXOpen.GeometricUtilities.OrientXpressBuilder
New in version NX7.5.0.
License requirements: None.
SelectCurves¶
-
CurveShapingBuilder.
SelectCurves
¶ Returns the curve selection for point insertion
-------------------------------------
Getter Method
Signature
SelectCurves()
Returns: Return type: NXOpen.SelectSplineList
New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SpecifyPoints¶
-
CurveShapingBuilder.
SpecifyPoints
¶ Returns the specified points to define insertion point locations
-------------------------------------
Getter Method
Signature
SpecifyPoints()
Returns: Return type: NXOpen.SelectPointList
New in version NX7.5.0.
License requirements: None.
StartContinuity¶
-
CurveShapingBuilder.
StartContinuity
¶ Returns or sets the continuity at start of the curve
-------------------------------------
Getter Method
Signature
StartContinuity()
Returns: Return type: NXOpen.GeometricUtilities.ContinuityContinuityTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartContinuity(startContinuity)
Parameters: startContinuity ( NXOpen.GeometricUtilities.ContinuityContinuityTypes
) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
WCSOption¶
-
CurveShapingBuilder.
WCSOption
¶ Returns or sets the WCS option
-------------------------------------
Getter Method
Signature
WCSOption()
Returns: Return type: NXOpen.GeometricUtilities.CurveShapingBuilderWCSOptionType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WCSOption(wcsOption)
Parameters: wcsOption ( NXOpen.GeometricUtilities.CurveShapingBuilderWCSOptionType
) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Method Detail¶
AddCurve¶
-
CurveShapingBuilder.
AddCurve
¶ Adds a curve for shaping
Signature
AddCurve(curve)
Parameters: curve ( NXOpen.Curve
) – Curve to be deformedNew in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
ApplyParameterValue¶
-
CurveShapingBuilder.
ApplyParameterValue
¶ Applies parameter value from a key point to a group of key points without affecting curve shape
Signature
ApplyParameterValue(sourcePoint, destinationPoints)
Parameters: - sourcePoint (
NXOpen.Point
) – Point whose parameter value to be applied - destinationPoints (list of
NXOpen.Point
) – Points to be edited
New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
- sourcePoint (
Deform¶
-
CurveShapingBuilder.
Deform
¶ Deforms curves based on active points
Signature
Deform()
New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
DeleteAllPoints¶
-
CurveShapingBuilder.
DeleteAllPoints
¶ Deletes all points on a curve.
If no curve is specified, deletes all points on all curves.
Signature
DeleteAllPoints(curve)
Parameters: curve ( NXOpen.Spline
) – CurveNew in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
RemoveCurve¶
-
CurveShapingBuilder.
RemoveCurve
¶ Removes a curve
Signature
RemoveCurve(curve)
Parameters: curve ( NXOpen.Curve
) – Curve to be deletedNew in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SetActivePoints¶
-
CurveShapingBuilder.
SetActivePoints
¶ Sets key points that are selected or will be moved
Signature
SetActivePoints(points, masterPoint)
Parameters: - points (list of
NXOpen.Point
) – Key points - masterPoint (
NXOpen.Point
) – Point which user actually moves to move a group of selected points
New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
- points (list of
Validate¶
-
CurveShapingBuilder.
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.