SurfaceContourBuilder Class¶
-
class
NXOpen.CAM.
SurfaceContourBuilder
¶ Bases:
NXOpen.CAM.MillOperationBuilder
Represents a SurfaceContour Builder
To create a new instance of this class, use
NXOpen.CAM.OperationCollection.CreateSurfaceContourBuilder()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
AccessVectorMethod | Returns or sets the Access Vector Method |
AutomaticAuxiliaryFloor | Returns or sets the Automatic Auxiliary Floor |
AutomaticAuxiliaryFloorDistance | Returns or sets the Automatic Auxiliary Floor Distance |
AuxiliaryFloorGeometry | Returns the auxiliary floor geometry builder |
BladeFinish | Returns the Blade Finish Drive Method builder |
BladeRough | Returns the Blade Rough Drive Method builder |
BlendFinish | Returns the Blend Finish Drive Method builder |
ChannelName | Returns or sets the channel’s name |
CheckGeometry | Returns the check geometry builder |
CheckToolAboveBall | Returns or sets a bool to check tool above ball |
CleanupType | Returns or sets the cleanup type |
CurveOffset | Returns the curve offset |
CutAreaGeometry | Returns the cut area geometry builder |
CutDirection | Returns or sets the cut direction |
CutLevels | Returns the cut levels builder |
CutParameters | Returns the cut parameter object |
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
DmCmBuilder | Returns the Contour Profile Drive Method builder |
DmSpiralBuilder | Returns the Spiral Drive Method builder |
DmSurfBuilder | Returns the Surface Area Drive Method builder |
DmareaMillingBuilder | Returns the Area Milling Drive Method builder |
DmboundaryBuilder | Returns the Boundary Drive Method builder |
DmcurveBuilder | Returns the Curve Drive Method builder |
DmradBuilder | Returns the Radial Cut Drive Method builder |
DmtpBuilder | Returns the Tool Path Drive Method builder |
EdgeFinish | Returns the Edge Finish Drive Method builder |
EndOfPath | Returns the end event builder |
EndUdeSet | Returns the end ude set |
FeedsBuilder | Returns the feeds and speeds builder |
FlowBuilder | Returns the Flow Cut Drive Method builder |
Geometry | Returns the geometry builder |
GougeChecking | Returns or sets the gouge checking flag |
GuidedCurveBuilder | Returns the Guided Curve Drive Method builder |
HoleAxisType | Returns or sets the Hole Axis Type |
HoleDepth | Returns the max depth distance builder |
HoleDepthType | Returns or sets the Hole Depth Type |
HubFinish | Returns the Hub Finish Drive Method builder |
LayoutAndLayer | Returns the Layer and Layout |
MinCutLength | Returns the min cut length builder (tool dependent double) |
MotionOutput | Returns the motion output builder |
MotionOutputBuilder | Returns the motion output builder |
NonCuttingBuilder | Returns the non-cutting moves builder |
Notes | Returns the notes builder |
NumberOfBlades | Returns the number of blades |
OptimizationBasedOn | Returns or sets the optimization based on in operation |
OptimizationDistanceMethod | Returns or sets the optimization distance method in operation |
OptimizationLevel | Returns or sets the optimization level in operation |
OptimizationMethod | Returns or sets the optim method |
PartGeometry | Returns the part geometry builder |
PathDisplayOptions | Returns the path display options builder |
PostToolPathExit | Returns or sets the environment variable that points to the post tool path generation library which has the exit |
ProjectionVector | Returns the Projection Vector builder (block) |
ReferenceTool | Returns or sets the reference tool object |
RetractDistance | Returns the Retract Distance builder (inheritable double) |
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double) |
RotaryFloorFinishBuilder | Returns the rotary floor finish builder. |
SafeClearance | Returns the safe clearance builder |
SelectToolFlag | Returns or sets the user selected tool |
SmoothingRadius | Returns the smoothing radius |
StartOfPath | Returns the start event builder |
StartUdeSet | Returns the start ude set |
StepoverLift | Returns the stepover lift |
StreamlineCutPattern | Returns the streamline cut pattern |
StreamlineCutStep | Returns the streamline cut step |
StreamlineStepover | Returns the streamline stepover |
StreamlineToolPosition | Returns the streamline tool position |
StreamlineTrimAndExtend | Returns the streamline trim and extend |
Tag | Returns the Tag for this object. |
ToolAxis | Returns the tool axis builder |
ToolAxisAdvanced | Returns the tool axis advanced builder |
ToolAxisFixed | Returns the Tool Axis Fixed builder |
ToolAxisVariable | Returns the Tool Axis Variable builder |
ToolChangeSetting | Returns the tool change builder |
ToolContactShift | Returns the tool contact shift |
ToolPathEditor | Returns the Tool Path Editor Builder |
ToolPathSplitParametersBuilder | Returns the tool path split Parameters |
TrimBoundary | Returns the trim boundary |
UserExitCiBuilder | Returns the CAM Exit name builder in User Defined Drive Method builder |
WallCleanupType | Returns or sets the wall cleanup mode |
WallGeometry | Returns the wall geometry builder |
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. |
GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name |
GetCustomizableItemNames | Returns the names for all customizable item ids |
GetCutRegionsBuilder | The cut regions builder |
GetDriveMethod | Get drive method |
GetHoleAxisValues | Get the Hole Axis values |
GetObject | Returns the object currently being edited by this builder. |
SetDriveMethod | Set drive method |
SetHoleAxisValues | Set the Hole Axis values |
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. |
Enumerations¶
SurfaceContourBuilderAccessVectorMethodType Enumeration | Available types for access vector for the contour profile method of surface milling |
SurfaceContourBuilderCleanupTypes Enumeration | Available types for cleanup |
SurfaceContourBuilderCutDirectionTypes Enumeration | The types of the cut direction |
SurfaceContourBuilderDriveMethodTypes Enumeration | Available types for Drive Method |
Property Detail¶
AccessVectorMethod¶
-
SurfaceContourBuilder.
AccessVectorMethod
¶ Returns or sets the Access Vector Method
-------------------------------------
Getter Method
Signature
AccessVectorMethod
Returns: the value of Access Vector Method Return type: NXOpen.CAM.SurfaceContourBuilderAccessVectorMethodType
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AccessVectorMethod
Parameters: accessVectorMethod ( NXOpen.CAM.SurfaceContourBuilderAccessVectorMethodType
) – the value of Access Vector MethodNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
AutomaticAuxiliaryFloor¶
-
SurfaceContourBuilder.
AutomaticAuxiliaryFloor
¶ Returns or sets the Automatic Auxiliary Floor
-------------------------------------
Getter Method
Signature
AutomaticAuxiliaryFloor
Returns: the Automatic Auxiliary Floor value Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutomaticAuxiliaryFloor
Parameters: applyAutoAuxFloor (bool) – the Automatic Auxiliary Floor value New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
AutomaticAuxiliaryFloorDistance¶
-
SurfaceContourBuilder.
AutomaticAuxiliaryFloorDistance
¶ Returns or sets the Automatic Auxiliary Floor Distance
-------------------------------------
Getter Method
Signature
AutomaticAuxiliaryFloorDistance
Returns: the Distance value Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutomaticAuxiliaryFloorDistance
Parameters: auxFloorDis (float) – the Distance value New in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
AuxiliaryFloorGeometry¶
-
SurfaceContourBuilder.
AuxiliaryFloorGeometry
¶ Returns the auxiliary floor geometry builder
-------------------------------------
Getter Method
Signature
AuxiliaryFloorGeometry
Returns: Return type: NXOpen.CAM.Geometry
New in version NX8.0.0.
License requirements: None.
BladeFinish¶
-
SurfaceContourBuilder.
BladeFinish
¶ Returns the Blade Finish Drive Method builder
-------------------------------------
Getter Method
Signature
BladeFinish
Returns: the blade finish Return type: NXOpen.CAM.BladeFinish
New in version NX7.5.0.
License requirements: None.
BladeRough¶
-
SurfaceContourBuilder.
BladeRough
¶ Returns the Blade Rough Drive Method builder
-------------------------------------
Getter Method
Signature
BladeRough
Returns: the blade rough Return type: NXOpen.CAM.BladeRough
New in version NX7.0.0.
License requirements: None.
BlendFinish¶
-
SurfaceContourBuilder.
BlendFinish
¶ Returns the Blend Finish Drive Method builder
-------------------------------------
Getter Method
Signature
BlendFinish
Returns: the blend finish Return type: NXOpen.CAM.BlendFinish
New in version NX7.5.0.
License requirements: None.
CheckGeometry¶
-
SurfaceContourBuilder.
CheckGeometry
¶ Returns the check geometry builder
-------------------------------------
Getter Method
Signature
CheckGeometry
Returns: Return type: NXOpen.CAM.Geometry
New in version NX8.0.0.
License requirements: None.
CheckToolAboveBall¶
-
SurfaceContourBuilder.
CheckToolAboveBall
¶ Returns or sets a bool to check tool above ball
-------------------------------------
Getter Method
Signature
CheckToolAboveBall
Returns: the check tool above ball value Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckToolAboveBall
Parameters: checkToolAboveBall (bool) – the check tool above ball value New in version NX9.0.0.
License requirements: None.
CleanupType¶
-
SurfaceContourBuilder.
CleanupType
¶ Returns or sets the cleanup type
-------------------------------------
Getter Method
Signature
CleanupType
Returns: the value of cleanup type Return type: NXOpen.CAM.SurfaceContourBuilderCleanupTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CleanupType
Parameters: propValue ( NXOpen.CAM.SurfaceContourBuilderCleanupTypes
) – the value of cleanup typeNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
CurveOffset¶
-
SurfaceContourBuilder.
CurveOffset
¶ Returns the curve offset
-------------------------------------
Getter Method
Signature
CurveOffset
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX9.0.2.
License requirements: None.
CutAreaGeometry¶
-
SurfaceContourBuilder.
CutAreaGeometry
¶ Returns the cut area geometry builder
-------------------------------------
Getter Method
Signature
CutAreaGeometry
Returns: Return type: NXOpen.CAM.Geometry
New in version NX8.0.0.
License requirements: None.
CutDirection¶
-
SurfaceContourBuilder.
CutDirection
¶ Returns or sets the cut direction
-------------------------------------
Getter Method
Signature
CutDirection
Returns: the cut direction Return type: NXOpen.CAM.SurfaceContourBuilderCutDirectionTypes
New in version NX10.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
CutDirection
Parameters: cutDirType ( NXOpen.CAM.SurfaceContourBuilderCutDirectionTypes
) – the cut directionNew in version NX10.0.2.
License requirements: cam_base (“CAM BASE”)
CutLevels¶
-
SurfaceContourBuilder.
CutLevels
¶ Returns the cut levels builder
-------------------------------------
Getter Method
Signature
CutLevels
Returns: Return type: NXOpen.CAM.BladeCutLevels
New in version NX7.0.0.
License requirements: None.
DmCmBuilder¶
-
SurfaceContourBuilder.
DmCmBuilder
¶ Returns the Contour Profile Drive Method builder
-------------------------------------
Getter Method
Signature
DmCmBuilder
Returns: Return type: NXOpen.CAM.DmCmBuilder
New in version NX5.0.0.
License requirements: None.
DmSpiralBuilder¶
-
SurfaceContourBuilder.
DmSpiralBuilder
¶ Returns the Spiral Drive Method builder
-------------------------------------
Getter Method
Signature
DmSpiralBuilder
Returns: the spiral builder Return type: NXOpen.CAM.DmSpiralBuilder
New in version NX5.0.0.
License requirements: None.
DmSurfBuilder¶
-
SurfaceContourBuilder.
DmSurfBuilder
¶ Returns the Surface Area Drive Method builder
-------------------------------------
Getter Method
Signature
DmSurfBuilder
Returns: Return type: NXOpen.CAM.DmSurfBuilder
New in version NX5.0.0.
License requirements: None.
DmareaMillingBuilder¶
-
SurfaceContourBuilder.
DmareaMillingBuilder
¶ Returns the Area Milling Drive Method builder
-------------------------------------
Getter Method
Signature
DmareaMillingBuilder
Returns: the area milling builder Return type: NXOpen.CAM.DmAmBuilder
New in version NX5.0.0.
License requirements: None.
DmboundaryBuilder¶
-
SurfaceContourBuilder.
DmboundaryBuilder
¶ Returns the Boundary Drive Method builder
-------------------------------------
Getter Method
Signature
DmboundaryBuilder
Returns: the boundary builder Return type: NXOpen.CAM.DmBndBuilder
New in version NX5.0.0.
License requirements: None.
DmcurveBuilder¶
-
SurfaceContourBuilder.
DmcurveBuilder
¶ Returns the Curve Drive Method builder
-------------------------------------
Getter Method
Signature
DmcurveBuilder
Returns: the curve builder Return type: NXOpen.CAM.DmCurveBuilder
New in version NX5.0.0.
License requirements: None.
DmradBuilder¶
-
SurfaceContourBuilder.
DmradBuilder
¶ Returns the Radial Cut Drive Method builder
-------------------------------------
Getter Method
Signature
DmradBuilder
Returns: Return type: NXOpen.CAM.DmRadBuilder
New in version NX5.0.0.
License requirements: None.
DmtpBuilder¶
-
SurfaceContourBuilder.
DmtpBuilder
¶ Returns the Tool Path Drive Method builder
-------------------------------------
Getter Method
Signature
DmtpBuilder
Returns: Return type: NXOpen.CAM.DmTpBuilder
New in version NX5.0.0.
License requirements: None.
EdgeFinish¶
-
SurfaceContourBuilder.
EdgeFinish
¶ Returns the Edge Finish Drive Method builder
-------------------------------------
Getter Method
Signature
EdgeFinish
Returns: the edge finish Return type: NXOpen.CAM.EdgeFinish
New in version NX7.5.0.
License requirements: None.
FlowBuilder¶
-
SurfaceContourBuilder.
FlowBuilder
¶ Returns the Flow Cut Drive Method builder
-------------------------------------
Getter Method
Signature
FlowBuilder
Returns: Return type: NXOpen.CAM.FlowBuilder
New in version NX5.0.0.
License requirements: None.
GuidedCurveBuilder¶
-
SurfaceContourBuilder.
GuidedCurveBuilder
¶ Returns the Guided Curve Drive Method builder
-------------------------------------
Getter Method
Signature
GuidedCurveBuilder
Returns: the guided curve builder Return type: NXOpen.CAM.GuidedCurveBuilder
New in version NX11.0.1.
License requirements: None.
HubFinish¶
-
SurfaceContourBuilder.
HubFinish
¶ Returns the Hub Finish Drive Method builder
-------------------------------------
Getter Method
Signature
HubFinish
Returns: the hub finish Return type: NXOpen.CAM.HubFinish
New in version NX7.5.0.
License requirements: None.
NonCuttingBuilder¶
-
SurfaceContourBuilder.
NonCuttingBuilder
¶ Returns the non-cutting moves builder
-------------------------------------
Getter Method
Signature
NonCuttingBuilder
Returns: Return type: NXOpen.CAM.NcmScBuilder
New in version NX5.0.0.
License requirements: None.
NumberOfBlades¶
-
SurfaceContourBuilder.
NumberOfBlades
¶ Returns the number of blades
-------------------------------------
Getter Method
Signature
NumberOfBlades
Returns: Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX7.5.0.
License requirements: None.
PartGeometry¶
-
SurfaceContourBuilder.
PartGeometry
¶ Returns the part geometry builder
-------------------------------------
Getter Method
Signature
PartGeometry
Returns: Return type: NXOpen.CAM.Geometry
New in version NX8.0.0.
License requirements: None.
ProjectionVector¶
-
SurfaceContourBuilder.
ProjectionVector
¶ Returns the Projection Vector builder (block)
-------------------------------------
Getter Method
Signature
ProjectionVector
Returns: the project vector value Return type: NXOpen.CAM.ProjVecCiBuilder
New in version NX5.0.0.
License requirements: None.
RotaryFloorFinishBuilder¶
-
SurfaceContourBuilder.
RotaryFloorFinishBuilder
¶ Returns the rotary floor finish builder.
-------------------------------------
Getter Method
Signature
RotaryFloorFinishBuilder
Returns: Return type: NXOpen.CAM.DmRotaryFloorFinishBuilder
New in version NX9.0.0.
License requirements: None.
SmoothingRadius¶
-
SurfaceContourBuilder.
SmoothingRadius
¶ Returns the smoothing radius
-------------------------------------
Getter Method
Signature
SmoothingRadius
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX9.0.2.
License requirements: None.
StepoverLift¶
-
SurfaceContourBuilder.
StepoverLift
¶ Returns the stepover lift
-------------------------------------
Getter Method
Signature
StepoverLift
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX9.0.2.
License requirements: None.
StreamlineCutPattern¶
-
SurfaceContourBuilder.
StreamlineCutPattern
¶ Returns the streamline cut pattern
-------------------------------------
Getter Method
Signature
StreamlineCutPattern
Returns: Return type: NXOpen.CAM.CutPatternBuilder
New in version NX10.0.1.
License requirements: None.
StreamlineCutStep¶
-
SurfaceContourBuilder.
StreamlineCutStep
¶ Returns the streamline cut step
-------------------------------------
Getter Method
Signature
StreamlineCutStep
Returns: Return type: NXOpen.CAM.DmStreamlineCutStep
New in version NX10.0.1.
License requirements: None.
StreamlineStepover¶
-
SurfaceContourBuilder.
StreamlineStepover
¶ Returns the streamline stepover
-------------------------------------
Getter Method
Signature
StreamlineStepover
Returns: Return type: NXOpen.CAM.StepoverBuilder
New in version NX10.0.1.
License requirements: None.
StreamlineToolPosition¶
-
SurfaceContourBuilder.
StreamlineToolPosition
¶ Returns the streamline tool position
-------------------------------------
Getter Method
Signature
StreamlineToolPosition
Returns: Return type: NXOpen.CAM.DmToolPosition
New in version NX10.0.1.
License requirements: None.
StreamlineTrimAndExtend¶
-
SurfaceContourBuilder.
StreamlineTrimAndExtend
¶ Returns the streamline trim and extend
-------------------------------------
Getter Method
Signature
StreamlineTrimAndExtend
Returns: Return type: NXOpen.CAM.DmTrimExtend
New in version NX10.0.1.
License requirements: None.
ToolAxis¶
-
SurfaceContourBuilder.
ToolAxis
¶ Returns the tool axis builder
-------------------------------------
Getter Method
Signature
ToolAxis
Returns: Return type: NXOpen.CAM.ToolAxisCiBuilder
New in version NX5.0.0.
Deprecated since version NX7.5.0: Please use
NXOpen.CAM.ToolAxisFixed
orNXOpen.CAM.ToolAxisVariable
instead.License requirements: None.
ToolAxisAdvanced¶
-
SurfaceContourBuilder.
ToolAxisAdvanced
¶ Returns the tool axis advanced builder
-------------------------------------
Getter Method
Signature
ToolAxisAdvanced
Returns: Return type: NXOpen.CAM.ToolAxisAdvanced
New in version NX7.0.0.
License requirements: None.
ToolAxisFixed¶
-
SurfaceContourBuilder.
ToolAxisFixed
¶ Returns the Tool Axis Fixed builder
-------------------------------------
Getter Method
Signature
ToolAxisFixed
Returns: Return type: NXOpen.CAM.ToolAxisFixed
New in version NX7.5.0.
License requirements: None.
ToolAxisVariable¶
-
SurfaceContourBuilder.
ToolAxisVariable
¶ Returns the Tool Axis Variable builder
-------------------------------------
Getter Method
Signature
ToolAxisVariable
Returns: Return type: NXOpen.CAM.ToolAxisVariable
New in version NX7.5.0.
License requirements: None.
ToolContactShift¶
-
SurfaceContourBuilder.
ToolContactShift
¶ Returns the tool contact shift
-------------------------------------
Getter Method
Signature
ToolContactShift
Returns: Return type: NXOpen.CAM.InheritableToolDepBuilder
New in version NX9.0.2.
License requirements: None.
TrimBoundary¶
-
SurfaceContourBuilder.
TrimBoundary
¶ Returns the trim boundary
-------------------------------------
Getter Method
Signature
TrimBoundary
Returns: Return type: NXOpen.CAM.Boundary
New in version NX9.0.0.
License requirements: None.
UserExitCiBuilder¶
-
SurfaceContourBuilder.
UserExitCiBuilder
¶ Returns the CAM Exit name builder in User Defined Drive Method builder
-------------------------------------
Getter Method
Signature
UserExitCiBuilder
Returns: Return type: NXOpen.CAM.DmUserExitCiBuilder
New in version NX5.0.0.
License requirements: None.
WallGeometry¶
-
SurfaceContourBuilder.
WallGeometry
¶ Returns the wall geometry builder
-------------------------------------
Getter Method
Signature
WallGeometry
Returns: Return type: NXOpen.CAM.Geometry
New in version NX8.0.0.
License requirements: None.
Method Detail¶
GetCutRegionsBuilder¶
-
SurfaceContourBuilder.
GetCutRegionsBuilder
¶ The cut regions builder
Signature
GetCutRegionsBuilder()
Returns: Return type: NXOpen.CAM.CutRegionsBuilder
New in version NX9.0.0.
License requirements: None.
GetDriveMethod¶
-
SurfaceContourBuilder.
GetDriveMethod
¶ Get drive method
Signature
GetDriveMethod()
Returns: the drive method menu value Return type: NXOpen.CAM.SurfaceContourBuilderDriveMethodTypes
New in version NX5.0.0.
License requirements: None.
SetDriveMethod¶
-
SurfaceContourBuilder.
SetDriveMethod
¶ Set drive method
Signature
SetDriveMethod(driveMethod)
Parameters: driveMethod ( NXOpen.CAM.SurfaceContourBuilderDriveMethodTypes
) – the drive method menu valueNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Validate¶
-
SurfaceContourBuilder.
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.