NcmScBuilder Class¶
-
class
NXOpen.CAM.
NcmScBuilder
¶ Bases:
NXOpen.CAM.NcmSubopBuilder
Represents a
NXOpen.CAM.NcmScBuilder
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
CollisionCheck | Returns or sets the collision check activation |
DefaultRegionStartType | Returns or sets the region start type |
EngageAgainstCheckBuilder | Returns the against check engage settings |
EngageInitialBuilder | Returns the initial engage settings |
EngageOpenAreaBuilder | Returns the open area engage settings |
MaxToolAxisChange | Returns or sets the max tool axis change |
OutputContactData | Returns or sets the contact data output activation |
PartSafeClearance | Returns the part safe clearance |
RetractAgainstCheckBuilder | Returns the against check retract settings |
RetractFinalBuilder | Returns the final retract settings |
RetractOpenAreaBuilder | Returns the open area retract settings |
SmoothingBuilder | Returns the smoothing builder |
SmoothingOption | Returns or sets the smoothing option |
SmoothingRadiusBuilder | Returns the smoothing radius settings |
StartPointsEffectDistBuilder | Returns the region start points effective distance builder (inheritable tool dep) |
StartPointsUseEffectDist | Returns or sets the start points use effective distance |
Tag | Returns the Tag for this object. |
TransferAvoidanceFromBuilder | Returns the from point builder |
TransferAvoidanceGohomeBuilder | Returns the gohome point builder |
TransferAvoidanceReturnBuilder | Returns the return point builder |
TransferAvoidanceStartBuilder | Returns the start point builder |
TransferBetweenRegionsBuilder | Returns the transfer settings for between regions |
TransferCommonClearanceBuilder | Returns the common clearance setting |
TransferInitialFinalBuilder | Returns the transfer settings for initial and final |
TransferRegionDistanceBuilder | Returns the region distance setting |
TransferWithinRegionsBuilder | Returns the transfer settings for within regions |
Methods¶
Method | Description |
---|---|
GetCustomizableItemBuilder | Returns the customizable item builder for given customizable item name |
GetCustomizableItemNames | Returns the names for all customizable item ids |
GetRegionStartPoints | Returns region start points |
SetRegionStartPoints | Sets region start points |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
NcmScBuilderSmoothingOptions Enumeration | Available options for smoothing behavior |
Property Detail¶
CollisionCheck¶
-
NcmScBuilder.
CollisionCheck
¶ Returns or sets the collision check activation
-------------------------------------
Getter Method
Signature
CollisionCheck
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CollisionCheck
Parameters: newValue (bool) – New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
EngageAgainstCheckBuilder¶
-
NcmScBuilder.
EngageAgainstCheckBuilder
¶ Returns the against check engage settings
-------------------------------------
Getter Method
Signature
EngageAgainstCheckBuilder
Returns: The against check engage builder Return type: NXOpen.CAM.NcmScEngRetBuilder
New in version NX5.0.0.
License requirements: None.
EngageInitialBuilder¶
-
NcmScBuilder.
EngageInitialBuilder
¶ Returns the initial engage settings
-------------------------------------
Getter Method
Signature
EngageInitialBuilder
Returns: The initial engage builder Return type: NXOpen.CAM.NcmScEngRetBuilder
New in version NX5.0.0.
License requirements: None.
EngageOpenAreaBuilder¶
-
NcmScBuilder.
EngageOpenAreaBuilder
¶ Returns the open area engage settings
-------------------------------------
Getter Method
Signature
EngageOpenAreaBuilder
Returns: The open area engage builder Return type: NXOpen.CAM.NcmScEngRetBuilder
New in version NX5.0.0.
License requirements: None.
MaxToolAxisChange¶
-
NcmScBuilder.
MaxToolAxisChange
¶ Returns or sets the max tool axis change
-------------------------------------
Getter Method
Signature
MaxToolAxisChange
Returns: the max tool axis change Return type: float New in version NX5.0.0.
Deprecated since version NX9.0.0: Use
NXOpen.CAM.NcmScBuilder.SmoothingBuilder()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
MaxToolAxisChange
Parameters: newValue (float) – the max tool axis change New in version NX5.0.0.
Deprecated since version NX9.0.0: Use
NXOpen.CAM.NcmScBuilder.SmoothingBuilder()
instead.License requirements: cam_base (“CAM BASE”)
OutputContactData¶
-
NcmScBuilder.
OutputContactData
¶ Returns or sets the contact data output activation
-------------------------------------
Getter Method
Signature
OutputContactData
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputContactData
Parameters: newValue (bool) – New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
PartSafeClearance¶
-
NcmScBuilder.
PartSafeClearance
¶ Returns the part safe clearance
-------------------------------------
Getter Method
Signature
PartSafeClearance
Returns: The part safe clearance builder Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX9.0.0.
License requirements: None.
RetractAgainstCheckBuilder¶
-
NcmScBuilder.
RetractAgainstCheckBuilder
¶ Returns the against check retract settings
-------------------------------------
Getter Method
Signature
RetractAgainstCheckBuilder
Returns: The against check retract builder Return type: NXOpen.CAM.NcmScEngRetBuilder
New in version NX5.0.0.
License requirements: None.
RetractFinalBuilder¶
-
NcmScBuilder.
RetractFinalBuilder
¶ Returns the final retract settings
-------------------------------------
Getter Method
Signature
RetractFinalBuilder
Returns: The final retract builder Return type: NXOpen.CAM.NcmScEngRetBuilder
New in version NX5.0.0.
License requirements: None.
RetractOpenAreaBuilder¶
-
NcmScBuilder.
RetractOpenAreaBuilder
¶ Returns the open area retract settings
-------------------------------------
Getter Method
Signature
RetractOpenAreaBuilder
Returns: The open area retract builder Return type: NXOpen.CAM.NcmScEngRetBuilder
New in version NX5.0.0.
License requirements: None.
SmoothingBuilder¶
-
NcmScBuilder.
SmoothingBuilder
¶ Returns the smoothing builder
-------------------------------------
Getter Method
Signature
SmoothingBuilder
Returns: The smoothing builder Return type: NXOpen.CAM.NcmSmoothingBuilder
New in version NX9.0.0.
License requirements: None.
SmoothingOption¶
-
NcmScBuilder.
SmoothingOption
¶ Returns or sets the smoothing option
-------------------------------------
Getter Method
Signature
SmoothingOption
Returns: Return type: NXOpen.CAM.NcmScBuilderSmoothingOptions
New in version NX5.0.0.
Deprecated since version NX9.0.0: Use
NXOpen.CAM.NcmScBuilder.SmoothingBuilder()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
SmoothingOption
Parameters: newValue ( NXOpen.CAM.NcmScBuilderSmoothingOptions
) –New in version NX5.0.0.
Deprecated since version NX9.0.0: Use
NXOpen.CAM.NcmScBuilder.SmoothingBuilder()
instead.License requirements: cam_base (“CAM BASE”)
SmoothingRadiusBuilder¶
-
NcmScBuilder.
SmoothingRadiusBuilder
¶ Returns the smoothing radius settings
-------------------------------------
Getter Method
Signature
SmoothingRadiusBuilder
Returns: The smoothing radius builder Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX5.0.0.
Deprecated since version NX9.0.0: Use
NXOpen.CAM.NcmScBuilder.SmoothingBuilder()
instead.License requirements: None.
TransferAvoidanceFromBuilder¶
-
NcmScBuilder.
TransferAvoidanceFromBuilder
¶ Returns the from point builder
-------------------------------------
Getter Method
Signature
TransferAvoidanceFromBuilder
Returns: The from point builder Return type: NXOpen.CAM.NcmAvoidancePointBuilder
New in version NX5.0.0.
License requirements: None.
TransferAvoidanceGohomeBuilder¶
-
NcmScBuilder.
TransferAvoidanceGohomeBuilder
¶ Returns the gohome point builder
-------------------------------------
Getter Method
Signature
TransferAvoidanceGohomeBuilder
Returns: The gohome point builder Return type: NXOpen.CAM.NcmAvoidancePointBuilder
New in version NX5.0.0.
License requirements: None.
TransferAvoidanceReturnBuilder¶
-
NcmScBuilder.
TransferAvoidanceReturnBuilder
¶ Returns the return point builder
-------------------------------------
Getter Method
Signature
TransferAvoidanceReturnBuilder
Returns: The return point builder Return type: NXOpen.CAM.NcmAvoidancePointBuilder
New in version NX5.0.0.
License requirements: None.
TransferAvoidanceStartBuilder¶
-
NcmScBuilder.
TransferAvoidanceStartBuilder
¶ Returns the start point builder
-------------------------------------
Getter Method
Signature
TransferAvoidanceStartBuilder
Returns: The start point builder Return type: NXOpen.CAM.NcmAvoidancePointBuilder
New in version NX5.0.0.
License requirements: None.
TransferBetweenRegionsBuilder¶
-
NcmScBuilder.
TransferBetweenRegionsBuilder
¶ Returns the transfer settings for between regions
-------------------------------------
Getter Method
Signature
TransferBetweenRegionsBuilder
Returns: The transfer between regions builder Return type: NXOpen.CAM.NcmTransferBuilder
New in version NX5.0.0.
License requirements: None.
TransferCommonClearanceBuilder¶
-
NcmScBuilder.
TransferCommonClearanceBuilder
¶ Returns the common clearance setting
-------------------------------------
Getter Method
Signature
TransferCommonClearanceBuilder
Returns: The common clearance builder Return type: NXOpen.CAM.NcmClearanceBuilder
New in version NX5.0.0.
License requirements: None.
TransferInitialFinalBuilder¶
-
NcmScBuilder.
TransferInitialFinalBuilder
¶ Returns the transfer settings for initial and final
-------------------------------------
Getter Method
Signature
TransferInitialFinalBuilder
Returns: The transfer between regions builder Return type: NXOpen.CAM.NcmTransferBuilder
New in version NX6.0.0.
License requirements: None.
TransferRegionDistanceBuilder¶
-
NcmScBuilder.
TransferRegionDistanceBuilder
¶ Returns the region distance setting
-------------------------------------
Getter Method
Signature
TransferRegionDistanceBuilder
Returns: The region distance builder Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX5.0.0.
License requirements: None.
TransferWithinRegionsBuilder¶
-
NcmScBuilder.
TransferWithinRegionsBuilder
¶ Returns the transfer settings for within regions
-------------------------------------
Getter Method
Signature
TransferWithinRegionsBuilder
Returns: The transfer within regions builder Return type: NXOpen.CAM.NcmTransferBuilder
New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
NcmScBuilder.
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.