OffsetCurveBuilder Class¶
-
class
NXOpen.Features.OffsetCurveBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a
NXOpen.Features.OffsetCurvebuilderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateOffsetCurveBuilder()Default values.
Property Value CurveFitData.CurveJoinMethod No CurveFitData.Degree 7 CurveFitData.FitMethod DegreeAndSegments CurveFitData.IsAdvancedFit 0 CurveFitData.IsAlignShape 0 CurveFitData.MaximumDegree 7 CurveFitData.MaximumSegments 1 CurveFitData.MinimumDegree 5 CurveFitData.Segments 1 CurveFitMethod.FitOption Cubic CurveFitMethod.MaximumDegree 7 CurveFitMethod.MaximumSegments 1 DraftAngle.Value 0.0 DraftHeight.Value 5.0 (millimeters part), 0.25 (inches part) ExtendFactor (deprecated) 1.0 GroupObjects false InputCurvesOptions.Associative true LawControl.EndValue.Value 5.0 (millimeters part), 0.25 (inches part) LawControl.Function ft LawControl.LawType Constant LawControl.Parameter t LawControl.StartValue.Value 5.0 (millimeters part), 0.25 (inches part) LawControl.Value.Value 5.0 (millimeters part), 0.25 (inches part) NumberOfCopies 1 Offset3dDistance.Value 5.0 (millimeters part), 0.25 (inches part) OffsetDistance.Value 5.0 (millimeters part), 0.25 (inches part) RoughOffset false TrimMethod ExtendTangents Type Distance New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| AxialOffsetDirection | Returns or sets the direction |
| CurveFitData | Returns the curve fit settings |
| CurveFitMethod | Returns the curve fit method |
| CurvesToOffset | Returns the curves to offset |
| DraftAngle | Returns the angle |
| DraftHeight | Returns the height |
| ExtendFactor | Returns or sets the extend factor |
| GroupObjects | Returns or sets the group objects |
| InputCurvesOptions | Returns the input curves |
| LawControl | Returns the Law builder |
| NumberOfCopies | Returns or sets the number of copies |
| Offset3dDistance | Returns the offset3d |
| OffsetDistance | Returns the distance |
| ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
| PatchSolutionFlag | Returns or sets the patch solution flag |
| PatchSurfaceFilename | Returns or sets the patch surface filename |
| PointOnOffsetPlane | Returns or sets the point on offset plane |
| ReverseDirection | Returns or sets the reverse direction |
| RoughOffset | Returns or sets the rough offset |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Tolerance | Returns or sets the distance tolerance |
| TrimMethod | Returns or sets the trim |
| Type | Returns or sets the offset type |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| ComputeOffsetDirection | To compute offset direction. |
| 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. |
| GetFeature | Returns the feature currently being edited by this builder. |
| GetObject | Returns the object currently being edited by this builder. |
| HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
| SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
| ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| OffsetCurveBuilderTrimOption Enumeration | Represents the Offset Curve trim option |
| OffsetCurveBuilderTypes Enumeration | Represents the Offset Curve types |
Property Detail¶
AxialOffsetDirection¶
-
OffsetCurveBuilder.AxialOffsetDirection¶ Returns or sets the direction
-------------------------------------Getter Method
Signature
AxialOffsetDirectionReturns: Return type: NXOpen.DirectionNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AxialOffsetDirectionParameters: direction ( NXOpen.Direction) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
CurveFitData¶
-
OffsetCurveBuilder.CurveFitData¶ Returns the curve fit settings
-------------------------------------Getter Method
Signature
CurveFitDataReturns: Return type: NXOpen.GeometricUtilities.CurveFitDataNew in version NX8.0.0.
License requirements: None.
CurveFitMethod¶
-
OffsetCurveBuilder.CurveFitMethod¶ Returns the curve fit method
-------------------------------------Getter Method
Signature
CurveFitMethodReturns: Return type: NXOpen.GeometricUtilities.CurveFitOptionsNew in version NX5.0.0.
License requirements: None.
CurvesToOffset¶
-
OffsetCurveBuilder.CurvesToOffset¶ Returns the curves to offset
-------------------------------------Getter Method
Signature
CurvesToOffsetReturns: Return type: NXOpen.SectionNew in version NX5.0.0.
License requirements: None.
DraftAngle¶
-
OffsetCurveBuilder.DraftAngle¶ Returns the angle
-------------------------------------Getter Method
Signature
DraftAngleReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
DraftHeight¶
-
OffsetCurveBuilder.DraftHeight¶ Returns the height
-------------------------------------Getter Method
Signature
DraftHeightReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
ExtendFactor¶
-
OffsetCurveBuilder.ExtendFactor¶ Returns or sets the extend factor
-------------------------------------Getter Method
Signature
ExtendFactorReturns: Return type: float New in version NX5.0.0.
Deprecated since version NX11.0.0: Extend factor functionality is no longer supported.
License requirements: None.
-------------------------------------Setter Method
Signature
ExtendFactorParameters: extendFactor (float) – New in version NX5.0.0.
Deprecated since version NX11.0.0: Extend factor functionality is no longer supported.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
GroupObjects¶
-
OffsetCurveBuilder.GroupObjects¶ Returns or sets the group objects
-------------------------------------Getter Method
Signature
GroupObjectsReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GroupObjectsParameters: groupObjects (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
InputCurvesOptions¶
-
OffsetCurveBuilder.InputCurvesOptions¶ Returns the input curves
-------------------------------------Getter Method
Signature
InputCurvesOptionsReturns: Return type: NXOpen.GeometricUtilities.CurveOptionsNew in version NX5.0.0.
License requirements: None.
LawControl¶
-
OffsetCurveBuilder.LawControl¶ Returns the Law builder
-------------------------------------Getter Method
Signature
LawControlReturns: Return type: NXOpen.GeometricUtilities.LawBuilderNew in version NX5.0.0.
License requirements: None.
NumberOfCopies¶
-
OffsetCurveBuilder.NumberOfCopies¶ Returns or sets the number of copies
-------------------------------------Getter Method
Signature
NumberOfCopiesReturns: Return type: int New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NumberOfCopiesParameters: numberOfCopies (int) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
Offset3dDistance¶
-
OffsetCurveBuilder.Offset3dDistance¶ Returns the offset3d
-------------------------------------Getter Method
Signature
Offset3dDistanceReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
OffsetDistance¶
-
OffsetCurveBuilder.OffsetDistance¶ Returns the distance
-------------------------------------Getter Method
Signature
OffsetDistanceReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
PointOnOffsetPlane¶
-
OffsetCurveBuilder.PointOnOffsetPlane¶ Returns or sets the point on offset plane
-------------------------------------Getter Method
Signature
PointOnOffsetPlaneReturns: Return type: NXOpen.PointNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PointOnOffsetPlaneParameters: pointOnOffsetPlane ( NXOpen.Point) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
ReverseDirection¶
-
OffsetCurveBuilder.ReverseDirection¶ Returns or sets the reverse direction
-------------------------------------Getter Method
Signature
ReverseDirectionReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReverseDirectionParameters: reverseDirection (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
RoughOffset¶
-
OffsetCurveBuilder.RoughOffset¶ Returns or sets the rough offset
-------------------------------------Getter Method
Signature
RoughOffsetReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RoughOffsetParameters: roughOffset (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
Tolerance¶
-
OffsetCurveBuilder.Tolerance¶ Returns or sets the distance tolerance
-------------------------------------Getter Method
Signature
ToleranceReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToleranceParameters: tolerance (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
TrimMethod¶
-
OffsetCurveBuilder.TrimMethod¶ Returns or sets the trim
-------------------------------------Getter Method
Signature
TrimMethodReturns: Return type: NXOpen.Features.OffsetCurveBuilderTrimOptionNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TrimMethodParameters: trim ( NXOpen.Features.OffsetCurveBuilderTrimOption) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
Type¶
-
OffsetCurveBuilder.Type¶ Returns or sets the offset type
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Features.OffsetCurveBuilderTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.Features.OffsetCurveBuilderTypes) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
Method Detail¶
ComputeOffsetDirection¶
-
OffsetCurveBuilder.ComputeOffsetDirection¶ Overloaded method ComputeOffsetDirection
ComputeOffsetDirection()ComputeOffsetDirection(seedEntity, seedPoint)
-------------------------------------To compute offset direction. To compute offset direction whenever it is required or needs to be updated.
Signature
ComputeOffsetDirection()Returns: a tuple Return type: A tuple consisting of (offsetDirection, startPoint). offsetDirection is a NXOpen.Vector3d. direction of offset startPoint is aNXOpen.Point3d. start point of directionNew in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
-------------------------------------To compute offset direction on the seed entity at the given seed point.
Signature
ComputeOffsetDirection(seedEntity, seedPoint)Parameters: - seedEntity (
NXOpen.ICurve) – seed entity that is part of section of offset curve builder - seedPoint (
NXOpen.Point3d) – seed point on the seed entity at which to compute the offset direction
Returns: a tuple
Return type: A tuple consisting of (offsetDirection, startPoint). offsetDirection is a
NXOpen.Vector3d. direction of offset at seed point on seed entity startPoint is aNXOpen.Point3d. start point of entities in section of offset curveNew in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
-------------------------------------
Validate¶
-
OffsetCurveBuilder.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.