OffsetCageBuilder Class¶
-
class
NXOpen.Features.Subdivision.OffsetCageBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.Subdivision.OffsetCageBuilderbuilder.To create a new instance of this class, use
NXOpen.Features.Subdivision.SubdivisionBodyCollection.CreateOffsetCageBuilder()Default values.
Property Value NumberOfCopies 1 OffsetDistance.Value 10.0 (millimeters part), 0.5 (inches part) New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| CanReverseOffsetDirection | Returns or sets the flag indicating if offset direction can be reversed. |
| NumberOfCopies | Returns or sets the number of copies to offset |
| Objects | Returns the objects to be offset |
| OffsetDistance | Returns the offset distance. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| 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. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
CanReverseOffsetDirection¶
-
OffsetCageBuilder.CanReverseOffsetDirection¶ Returns or sets the flag indicating if offset direction can be reversed.
-------------------------------------Getter Method
Signature
CanReverseOffsetDirectionReturns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CanReverseOffsetDirectionParameters: reverse (bool) – New in version NX11.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
NumberOfCopies¶
-
OffsetCageBuilder.NumberOfCopies¶ Returns or sets the number of copies to offset
-------------------------------------Getter Method
Signature
NumberOfCopiesReturns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NumberOfCopiesParameters: numberOfCopies (int) – New in version NX11.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
Objects¶
-
OffsetCageBuilder.Objects¶ Returns the objects to be offset
-------------------------------------Getter Method
Signature
ObjectsReturns: Return type: NXOpen.Features.Subdivision.SelectCageObjectDataNew in version NX11.0.0.
License requirements: None.
OffsetDistance¶
-
OffsetCageBuilder.OffsetDistance¶ Returns the offset distance.
-------------------------------------Getter Method
Signature
OffsetDistanceReturns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
OffsetCageBuilder.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.