NcmPlanarBuilder Class

class NXOpen.CAM.NcmPlanarBuilder

Bases: NXOpen.CAM.NcmSubopBuilder

Represents a NXOpen.CAM.NcmPlanarBuilder

New in version NX5.0.0.

Properties

Property	Description
ApplySafetyToDirect	Returns or sets the apply safety to direct value
ClearanceBuilder	Returns the clearance builder (inheritable tool dep)
CollisionCheck	Returns or sets the collision check activation
CutcomMinimumAngle	Returns or sets the cutter compensation minimum angle
CutcomMinimumMoveBuilder	Returns the cutter compensation minimum move builder (inheritable tool dep)
CutcomOutputContactPoint	Returns or sets the cutter compensation output contact point status
CutcomOutputPlane	Returns or sets the cutter compensation output plane status
CutcomTrackingPointType	Returns or sets the cutter compensation tracking point selection
CutcomType	Returns or sets the cutter compensation type
DefaultRegionStartType	Returns or sets the region start type
EngageClosedAreaBuilder	Returns the default engage closed area builder
EngageInitialClosedBuilder	Returns the initial engage closed area builder
EngageInitialOpenBuilder	Returns the initial engage open area builder
EngageOpenAreaBuilder	Returns the default engage open area builder
FinalSafeDistanceBuilder	Returns the final safe distance builder (inheritable tool dep)
FinalType	Returns or sets the final type
InitialSafeDistanceBuilder	Returns the initial safe distance builder (inheritable tool dep)
InitialType	Returns or sets the initial type
LimitEngRetToCutRegion	Returns or sets the flag to control limitation of engage and retract motions to cut regions
OverlapDistanceBuilder	Returns the start/drill points overlap distance builder (inheritable tool dep)
PredrillPointsEffectDistBuilder	Returns the pre-drill points effective distance builder (inheritable tool dep)
PredrillPointsOutput	Returns or sets the pre-drill points output option
PredrillPointsUseEffectDist	Returns or sets the pre-drill points use effective distance
RetractAreaBuilder	Returns the retract area builder
RetractFinalBuilder	Returns the final retract builder
SmoothingBuilder	Returns the smoothing builder
StartPointsEffectDistBuilder	Returns the region start points effective distance builder (inheritable tool dep)
StartPointsUseEffectDist	Returns or sets the start points use effective distance
SuppressCutcom	Returns or sets the suppress cutter compensation
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
TransferBetweenLevelsSafeDistanceBuilder	Returns the transfer between levels safe distance builder (inheritable tool dep)
TransferBetweenLevelsType	Returns or sets the transfer between levels type
TransferBetweenRegionsBuilder	Returns the Transfer Between Regions builder
TransferBetweenRegionsSafeDistanceBuilder	Returns the transfer between regions safe distance builder (inheritable tool dep)
TransferBetweenRegionsType	Returns or sets the transfer between regions type
TransferWithinLevelsHeightBuilder	Returns the transfer within levels height builder (inheritable tool dep)
TransferWithinLevelsMaxFollowDistanceBuilder	Returns the transfer within levels max follow distance builder (inheritable tool dep)
TransferWithinLevelsSafeDistanceBuilder	Returns the transfer within levels safe distance builder (inheritable tool dep)
TransferWithinLevelsType	Returns or sets the transfer within levels type
TransferWithinLevelsWith	Returns or sets the transfer within levels strategy

Methods

Method	Description
GetPredrillPoints	The pre-drill points @return Array of points
GetRegionStartPoints	Returns region start points
SetPredrillPoints	The pre-drill points
SetRegionStartPoints	Sets region start points

Enumerations

NcmPlanarBuilderCutcomTypes Enumeration	Available types for cutter compensation in planar milling
NcmPlanarBuilderFinalRet Enumeration	Available strategies for final retract in planar milling
NcmPlanarBuilderFinalTypes Enumeration	Available types for final clearance in planar milling
NcmPlanarBuilderInitialEng Enumeration	Available strategies for initial engage in planar milling
NcmPlanarBuilderInitialTypes Enumeration	Available types for initial clearance in planar milling
NcmPlanarBuilderPredrillPointsOutputOptions Enumeration	Available options for output of pre-drill points in planar milling
NcmPlanarBuilderTransferBetweenLevelsTypes Enumeration	Available types for transfer between levels in planar milling
NcmPlanarBuilderTransferBetweenRegionsTypes Enumeration	Available types for transfer between regions in planar milling
NcmPlanarBuilderTransferWithinLevelsTypes Enumeration	Available types for transfer within levels in planar milling
NcmPlanarBuilderTransferWithinLevelsWiths Enumeration	Available strategies for transfer within levels in planar milling

Property Detail

ApplySafetyToDirect

NcmPlanarBuilder.ApplySafetyToDirect

Returns or sets the apply safety to direct value

-------------------------------------

Getter Method

Signature ApplySafetyToDirect()

Returns:the apply safety value Return type:bool

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature ApplySafetyToDirect(applySafety)

Parameters:applySafety (bool) – the apply safety value

New in version NX9.0.3.

License requirements: cam_base (“CAM BASE”)

ClearanceBuilder

NcmPlanarBuilder.ClearanceBuilder

Returns the clearance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature ClearanceBuilder()

Returns:Clearance Return type:NXOpen.CAM.NcmClearanceBuilder

New in version NX5.0.0.

License requirements: None.

CollisionCheck

NcmPlanarBuilder.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(newValue)

Parameters:newValue (bool) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CutcomMinimumAngle

NcmPlanarBuilder.CutcomMinimumAngle

Returns or sets the cutter compensation minimum angle

-------------------------------------

Getter Method

Signature CutcomMinimumAngle()

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CutcomMinimumAngle(minimumAngle)

Parameters:minimumAngle (float) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CutcomMinimumMoveBuilder

NcmPlanarBuilder.CutcomMinimumMoveBuilder

Returns the cutter compensation minimum move builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature CutcomMinimumMoveBuilder()

Returns:The cutcom minimum move builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

CutcomOutputContactPoint

NcmPlanarBuilder.CutcomOutputContactPoint

Returns or sets the cutter compensation output contact point status

-------------------------------------

Getter Method

Signature CutcomOutputContactPoint()

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CutcomOutputContactPoint(newValue)

Parameters:newValue (bool) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CutcomOutputPlane

NcmPlanarBuilder.CutcomOutputPlane

Returns or sets the cutter compensation output plane status

-------------------------------------

Getter Method

Signature CutcomOutputPlane()

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CutcomOutputPlane(outputPlane)

Parameters:outputPlane (bool) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CutcomTrackingPointType

NcmPlanarBuilder.CutcomTrackingPointType

Returns or sets the cutter compensation tracking point selection

-------------------------------------

Getter Method

Signature CutcomTrackingPointType()

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CutcomTrackingPointType(newValue)

Parameters:newValue (int) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CutcomType

NcmPlanarBuilder.CutcomType

Returns or sets the cutter compensation type

-------------------------------------

Getter Method

Signature CutcomType()

Returns: Return type:NXOpen.CAM.NcmPlanarBuilderCutcomTypes

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CutcomType(cutcomType)

Parameters:cutcomType (NXOpen.CAM.NcmPlanarBuilderCutcomTypes) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

EngageClosedAreaBuilder

NcmPlanarBuilder.EngageClosedAreaBuilder

Returns the default engage closed area builder

-------------------------------------

Getter Method

Signature EngageClosedAreaBuilder()

Returns:the default engage closed area builder Return type:NXOpen.CAM.NcmPlanarEngRetBuilder

New in version NX5.0.0.

License requirements: None.

EngageInitialClosedBuilder

NcmPlanarBuilder.EngageInitialClosedBuilder

Returns the initial engage closed area builder

-------------------------------------

Getter Method

Signature EngageInitialClosedBuilder()

Returns:the initial engage closed area builder Return type:NXOpen.CAM.NcmPlanarEngRetBuilder

New in version NX5.0.0.

License requirements: None.

EngageInitialOpenBuilder

NcmPlanarBuilder.EngageInitialOpenBuilder

Returns the initial engage open area builder

-------------------------------------

Getter Method

Signature EngageInitialOpenBuilder()

Returns:the initial engage open area builder Return type:NXOpen.CAM.NcmPlanarEngRetBuilder

New in version NX5.0.0.

License requirements: None.

EngageOpenAreaBuilder

NcmPlanarBuilder.EngageOpenAreaBuilder

Returns the default engage open area builder

-------------------------------------

Getter Method

Signature EngageOpenAreaBuilder()

Returns:the default engage open area builder Return type:NXOpen.CAM.NcmPlanarEngRetBuilder

New in version NX5.0.0.

License requirements: None.

FinalSafeDistanceBuilder

NcmPlanarBuilder.FinalSafeDistanceBuilder

Returns the final safe distance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature FinalSafeDistanceBuilder()

Returns:The final safe distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

FinalType

NcmPlanarBuilder.FinalType

Returns or sets the final type

-------------------------------------

Getter Method

Signature FinalType()

Returns: Return type:NXOpen.CAM.NcmPlanarBuilderFinalTypes

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FinalType(finalType)

Parameters:finalType (NXOpen.CAM.NcmPlanarBuilderFinalTypes) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

InitialSafeDistanceBuilder

NcmPlanarBuilder.InitialSafeDistanceBuilder

Returns the initial safe distance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature InitialSafeDistanceBuilder()

Returns:The initial safe distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

InitialType

NcmPlanarBuilder.InitialType

Returns or sets the initial type

-------------------------------------

Getter Method

Signature InitialType()

Returns: Return type:NXOpen.CAM.NcmPlanarBuilderInitialTypes

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature InitialType(initialType)

Parameters:initialType (NXOpen.CAM.NcmPlanarBuilderInitialTypes) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

LimitEngRetToCutRegion

NcmPlanarBuilder.LimitEngRetToCutRegion

Returns or sets the flag to control limitation of engage and retract motions to cut regions

-------------------------------------

Getter Method

Signature LimitEngRetToCutRegion()

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LimitEngRetToCutRegion(newValue)

Parameters:newValue (bool) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

OverlapDistanceBuilder

NcmPlanarBuilder.OverlapDistanceBuilder

Returns the start/drill points overlap distance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature OverlapDistanceBuilder()

Returns:The overlap distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

PredrillPointsEffectDistBuilder

NcmPlanarBuilder.PredrillPointsEffectDistBuilder

Returns the pre-drill points effective distance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature PredrillPointsEffectDistBuilder()

Returns:The predrill points effective distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

PredrillPointsOutput

NcmPlanarBuilder.PredrillPointsOutput

Returns or sets the pre-drill points output option

-------------------------------------

Getter Method

Signature PredrillPointsOutput()

Returns: Return type:NXOpen.CAM.NcmPlanarBuilderPredrillPointsOutputOptions

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PredrillPointsOutput(newValue)

Parameters:newValue (NXOpen.CAM.NcmPlanarBuilderPredrillPointsOutputOptions) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

PredrillPointsUseEffectDist

NcmPlanarBuilder.PredrillPointsUseEffectDist

Returns or sets the pre-drill points use effective distance

-------------------------------------

Getter Method

Signature PredrillPointsUseEffectDist()

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PredrillPointsUseEffectDist(newValue)

Parameters:newValue (bool) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

RetractAreaBuilder

NcmPlanarBuilder.RetractAreaBuilder

Returns the retract area builder

-------------------------------------

Getter Method

Signature RetractAreaBuilder()

Returns:the retract area builder Return type:NXOpen.CAM.NcmPlanarEngRetBuilder

New in version NX5.0.0.

License requirements: None.

RetractFinalBuilder

NcmPlanarBuilder.RetractFinalBuilder

Returns the final retract builder

-------------------------------------

Getter Method

Signature RetractFinalBuilder()

Returns:the final retract builder Return type:NXOpen.CAM.NcmPlanarEngRetBuilder

New in version NX5.0.0.

License requirements: None.

SmoothingBuilder

NcmPlanarBuilder.SmoothingBuilder

Returns the smoothing builder

-------------------------------------

Getter Method

Signature SmoothingBuilder()

Returns:The smoothing builder Return type:NXOpen.CAM.NcmSmoothingBuilder

New in version NX9.0.2.

License requirements: None.

SuppressCutcom

NcmPlanarBuilder.SuppressCutcom

Returns or sets the suppress cutter compensation

-------------------------------------

Getter Method

Signature SuppressCutcom()

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SuppressCutcom(suppressCutcom)

Parameters:suppressCutcom (bool) –

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

TransferAvoidanceFromBuilder

NcmPlanarBuilder.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

NcmPlanarBuilder.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

NcmPlanarBuilder.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

NcmPlanarBuilder.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.

TransferBetweenLevelsSafeDistanceBuilder

NcmPlanarBuilder.TransferBetweenLevelsSafeDistanceBuilder

Returns the transfer between levels safe distance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature TransferBetweenLevelsSafeDistanceBuilder()

Returns:The transfer between levels safe distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

TransferBetweenLevelsType

NcmPlanarBuilder.TransferBetweenLevelsType

Returns or sets the transfer between levels type

-------------------------------------

Getter Method

Signature TransferBetweenLevelsType()

Returns: Return type:NXOpen.CAM.NcmPlanarBuilderTransferBetweenLevelsTypes

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TransferBetweenLevelsType(transferType)

Parameters:transferType (NXOpen.CAM.NcmPlanarBuilderTransferBetweenLevelsTypes) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

TransferBetweenRegionsBuilder

NcmPlanarBuilder.TransferBetweenRegionsBuilder

Returns the Transfer Between Regions builder

-------------------------------------

Getter Method

Signature TransferBetweenRegionsBuilder()

Returns:Transfer Between Regions Return type:NXOpen.CAM.NcmTransfer

New in version NX9.0.0.

License requirements: None.

TransferBetweenRegionsSafeDistanceBuilder

NcmPlanarBuilder.TransferBetweenRegionsSafeDistanceBuilder

Returns the transfer between regions safe distance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature TransferBetweenRegionsSafeDistanceBuilder()

Returns:The transfer between regions safe distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

Deprecated since version NX9.0.0: Please use NXOpen.CAM.NcmTransfer.SafeDistanceBuilder() instead.

License requirements: None.

TransferBetweenRegionsType

NcmPlanarBuilder.TransferBetweenRegionsType

Returns or sets the transfer between regions type

-------------------------------------

Getter Method

Signature TransferBetweenRegionsType()

Returns: Return type:NXOpen.CAM.NcmPlanarBuilderTransferBetweenRegionsTypes

New in version NX5.0.0.

Deprecated since version NX9.0.0: Please use NXOpen.CAM.NcmTransfer.Type() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature TransferBetweenRegionsType(transferType)

Parameters:transferType (NXOpen.CAM.NcmPlanarBuilderTransferBetweenRegionsTypes) –

New in version NX5.0.0.

Deprecated since version NX9.0.0: Please use NXOpen.CAM.NcmTransfer.Type() instead.

License requirements: cam_base (“CAM BASE”)

TransferWithinLevelsHeightBuilder

NcmPlanarBuilder.TransferWithinLevelsHeightBuilder

Returns the transfer within levels height builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature TransferWithinLevelsHeightBuilder()

Returns:The transfer within levels height builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

TransferWithinLevelsMaxFollowDistanceBuilder

NcmPlanarBuilder.TransferWithinLevelsMaxFollowDistanceBuilder

Returns the transfer within levels max follow distance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature TransferWithinLevelsMaxFollowDistanceBuilder()

Returns:The transfer within levels max follow distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

TransferWithinLevelsSafeDistanceBuilder

NcmPlanarBuilder.TransferWithinLevelsSafeDistanceBuilder

Returns the transfer within levels safe distance builder (inheritable tool dep)

-------------------------------------

Getter Method

Signature TransferWithinLevelsSafeDistanceBuilder()

Returns:The transfer within levels safe distance builder Return type:NXOpen.CAM.InheritableToolDepBuilder

New in version NX5.0.0.

License requirements: None.

TransferWithinLevelsType

NcmPlanarBuilder.TransferWithinLevelsType

Returns or sets the transfer within levels type

-------------------------------------

Getter Method

Signature TransferWithinLevelsType()

Returns: Return type:NXOpen.CAM.NcmPlanarBuilderTransferWithinLevelsTypes

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TransferWithinLevelsType(transferType)

Parameters:transferType (NXOpen.CAM.NcmPlanarBuilderTransferWithinLevelsTypes) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

TransferWithinLevelsWith

NcmPlanarBuilder.TransferWithinLevelsWith

Returns or sets the transfer within levels strategy

-------------------------------------

Getter Method

Signature TransferWithinLevelsWith()

Returns: Return type:NXOpen.CAM.NcmPlanarBuilderTransferWithinLevelsWiths

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TransferWithinLevelsWith(newValue)

Parameters:newValue (NXOpen.CAM.NcmPlanarBuilderTransferWithinLevelsWiths) –

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

GetPredrillPoints

NcmPlanarBuilder.GetPredrillPoints

The pre-drill points

Signature GetPredrillPoints()

Returns:Array of points Return type:list of NXOpen.Point

New in version NX5.0.0.

License requirements: None.

SetPredrillPoints

NcmPlanarBuilder.SetPredrillPoints

The pre-drill points

Signature SetPredrillPoints(predrillPoints)

Parameters:predrillPoints (list of NXOpen.Point) – Array of points

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)