OperationDisplayOptionsBuilder Class

class NXOpen.CAM.OperationDisplayOptionsBuilder

Bases: NXOpen.TaggedObject

Represents a display options Builder

This is an abstract class and cannot be instantiated.

New in version NX6.0.0.

Properties

Property Description
ArrowDisplayFlag Returns or sets the arrow display flag
DisplayCutRegionsFlag Returns or sets the display cut regions flag
FeedDisplayFlag Returns or sets the feed display flag
LineNumberDisplayFlag Returns or sets the line number display flag
PaintDisplay Returns the sub builder for paint display
PathDisplay Returns the sub builder for path display
PathDisplayColors Returns the path display colors builder
PathDisplayType Returns or sets the path display types
PathNormalType Returns or sets the path normal types
PathVector Returns or sets the path vector
PatternDisplayFrequency Returns or sets the pattern display frequency
PatternDisplayType Returns or sets the pattern display types
PatternFile Returns or sets the pattern file name
PatternXOffset Returns or sets the pattern X offset
PatternYOffset Returns or sets the pattern Y offset
PatternZOffset Returns or sets the pattern Z offset
PauseAfterDisplayFlag Returns or sets the pause after display flag
PercentOfTool Returns or sets the percent of tool.
RefreshBeforeDisplayFlag Returns or sets the refresh before display flag
ReplaySpeed Returns or sets the replay speed.
SaveContactDisplayDataFlag Returns or sets the save contact displat data flag
SilhouDisplay Returns the sub builder for silhou display
SuppressPathDisplayFlag Returns or sets the suppress path display flag
Tag Returns the Tag for this object.
ToolDisplay Returns the sub builder for tool display
ToolDisplayFrequency Returns or sets the tool display frequency
ToolDisplayType Returns or sets the tool display types

Methods

Property Detail

ArrowDisplayFlag

OperationDisplayOptionsBuilder.ArrowDisplayFlag

Returns or sets the arrow display flag

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

Getter Method

Signature ArrowDisplayFlag()

Returns:the arrow display flag
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ArrowDisplayFlag(arrowDisplay)

Parameters:arrowDisplay (bool) – the arrow display flag

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

DisplayCutRegionsFlag

OperationDisplayOptionsBuilder.DisplayCutRegionsFlag

Returns or sets the display cut regions flag

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

Getter Method

Signature DisplayCutRegionsFlag()

Returns:the display cut regions flag
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DisplayCutRegionsFlag(displayCutRegions)

Parameters:displayCutRegions (bool) – the display cut regions flag

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

FeedDisplayFlag

OperationDisplayOptionsBuilder.FeedDisplayFlag

Returns or sets the feed display flag

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

Getter Method

Signature FeedDisplayFlag()

Returns:the feed display flag
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature FeedDisplayFlag(feedDisplay)

Parameters:feedDisplay (bool) – the feed display flag

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

LineNumberDisplayFlag

OperationDisplayOptionsBuilder.LineNumberDisplayFlag

Returns or sets the line number display flag

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

Getter Method

Signature LineNumberDisplayFlag()

Returns:the line number display flag
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature LineNumberDisplayFlag(lineNumberDisplay)

Parameters:lineNumberDisplay (bool) – the line number display flag

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PaintDisplay

OperationDisplayOptionsBuilder.PaintDisplay

Returns the sub builder for paint display

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

Getter Method

Signature PaintDisplay()

Returns:the paint_display
Return type:NXOpen.CAM.DisplayPaint

New in version NX7.5.0.

License requirements: None.

PathDisplay

OperationDisplayOptionsBuilder.PathDisplay

Returns the sub builder for path display

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

Getter Method

Signature PathDisplay()

Returns:the path_display
Return type:NXOpen.CAM.DisplayPath

New in version NX7.5.0.

License requirements: None.

PathDisplayColors

OperationDisplayOptionsBuilder.PathDisplayColors

Returns the path display colors builder

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

Getter Method

Signature PathDisplayColors()

Returns:The path display colors builder
Return type:NXOpen.CAM.PathDisplayColors

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

PathDisplayType

OperationDisplayOptionsBuilder.PathDisplayType

Returns or sets the path display types

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

Getter Method

Signature PathDisplayType()

Returns:the path display type
Return type:NXOpen.CAM.OperationDisplayOptionsBuilderPathDisplayTypes

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PathDisplayType(pathDisplay)

Parameters:pathDisplay (NXOpen.CAM.OperationDisplayOptionsBuilderPathDisplayTypes) – the path display type

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PathNormalType

OperationDisplayOptionsBuilder.PathNormalType

Returns or sets the path normal types

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

Getter Method

Signature PathNormalType()

Returns:the path normal type
Return type:NXOpen.CAM.OperationDisplayOptionsBuilderPathNormalTypes

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PathNormalType(pathNormal)

Parameters:pathNormal (NXOpen.CAM.OperationDisplayOptionsBuilderPathNormalTypes) – the path normal type

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PathVector

OperationDisplayOptionsBuilder.PathVector

Returns or sets the path vector

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

Getter Method

Signature PathVector()

Returns:
Return type:NXOpen.Direction

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PathVector(vector)

Parameters:vector (NXOpen.Direction) –

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PatternDisplayFrequency

OperationDisplayOptionsBuilder.PatternDisplayFrequency

Returns or sets the pattern display frequency

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

Getter Method

Signature PatternDisplayFrequency()

Returns:the pattern display frequency
Return type:int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PatternDisplayFrequency(patternDisplayFrequency)

Parameters:patternDisplayFrequency (int) – the pattern display frequency

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PatternDisplayType

OperationDisplayOptionsBuilder.PatternDisplayType

Returns or sets the pattern display types

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

Getter Method

Signature PatternDisplayType()

Returns:the pattern display type
Return type:NXOpen.CAM.OperationDisplayOptionsBuilderPatternDisplayTypes

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PatternDisplayType(patternDisplay)

Parameters:patternDisplay (NXOpen.CAM.OperationDisplayOptionsBuilderPatternDisplayTypes) – the pattern display type

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PatternFile

OperationDisplayOptionsBuilder.PatternFile

Returns or sets the pattern file name

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

Getter Method

Signature PatternFile()

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PatternFile(filename)

Parameters:filename (str) –

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PatternXOffset

OperationDisplayOptionsBuilder.PatternXOffset

Returns or sets the pattern X offset

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

Getter Method

Signature PatternXOffset()

Returns:the pattern X offset
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PatternXOffset(xOffset)

Parameters:xOffset (float) – the pattern X offset

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PatternYOffset

OperationDisplayOptionsBuilder.PatternYOffset

Returns or sets the pattern Y offset

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

Getter Method

Signature PatternYOffset()

Returns:the pattern Y offset
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PatternYOffset(yOffset)

Parameters:yOffset (float) – the pattern Y offset

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PatternZOffset

OperationDisplayOptionsBuilder.PatternZOffset

Returns or sets the pattern Z offset

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

Getter Method

Signature PatternZOffset()

Returns:the pattern Z offset
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PatternZOffset(zOffset)

Parameters:zOffset (float) – the pattern Z offset

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PauseAfterDisplayFlag

OperationDisplayOptionsBuilder.PauseAfterDisplayFlag

Returns or sets the pause after display flag

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

Getter Method

Signature PauseAfterDisplayFlag()

Returns:the pause after display flag
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PauseAfterDisplayFlag(pauseAfterDisplay)

Parameters:pauseAfterDisplay (bool) – the pause after display flag

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

PercentOfTool

OperationDisplayOptionsBuilder.PercentOfTool

Returns or sets the percent of tool.

The range is 1-100.

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

Getter Method

Signature PercentOfTool()

Returns:the percent of tool.The range is 1-100.
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PercentOfTool(percentTool)

Parameters:percentTool (float) – the percent of tool.The range is 1-100.

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

RefreshBeforeDisplayFlag

OperationDisplayOptionsBuilder.RefreshBeforeDisplayFlag

Returns or sets the refresh before display flag

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

Getter Method

Signature RefreshBeforeDisplayFlag()

Returns:the refresh before display flag
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature RefreshBeforeDisplayFlag(refreshBeforeDisplay)

Parameters:refreshBeforeDisplay (bool) – the refresh before display flag

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

ReplaySpeed

OperationDisplayOptionsBuilder.ReplaySpeed

Returns or sets the replay speed.

The range is 1-10.

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

Getter Method

Signature ReplaySpeed()

Returns:the replay speed. The range is 1-10.
Return type:int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ReplaySpeed(displaySpeed)

Parameters:displaySpeed (int) – the replay speed. The range is 1-10.

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SaveContactDisplayDataFlag

OperationDisplayOptionsBuilder.SaveContactDisplayDataFlag

Returns or sets the save contact displat data flag

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

Getter Method

Signature SaveContactDisplayDataFlag()

Returns:the save contact displat data flag
Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature SaveContactDisplayDataFlag(saveContactDisplayData)

Parameters:saveContactDisplayData (bool) – the save contact displat data flag

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

SilhouDisplay

OperationDisplayOptionsBuilder.SilhouDisplay

Returns the sub builder for silhou display

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

Getter Method

Signature SilhouDisplay()

Returns:the silhou_display
Return type:NXOpen.CAM.DisplaySilhouette

New in version NX7.5.0.

License requirements: None.

SuppressPathDisplayFlag

OperationDisplayOptionsBuilder.SuppressPathDisplayFlag

Returns or sets the suppress path display flag

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

Getter Method

Signature SuppressPathDisplayFlag()

Returns:the suppress path display flag
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature SuppressPathDisplayFlag(suppressPathDisplay)

Parameters:suppressPathDisplay (bool) – the suppress path display flag

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

ToolDisplay

OperationDisplayOptionsBuilder.ToolDisplay

Returns the sub builder for tool display

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

Getter Method

Signature ToolDisplay()

Returns:the tool_display
Return type:NXOpen.CAM.DisplayTool

New in version NX7.5.0.

License requirements: None.

ToolDisplayFrequency

OperationDisplayOptionsBuilder.ToolDisplayFrequency

Returns or sets the tool display frequency

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

Getter Method

Signature ToolDisplayFrequency()

Returns:the tool display frequency
Return type:int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ToolDisplayFrequency(toolDisplayFrequency)

Parameters:toolDisplayFrequency (int) – the tool display frequency

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

ToolDisplayType

OperationDisplayOptionsBuilder.ToolDisplayType

Returns or sets the tool display types

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

Getter Method

Signature ToolDisplayType()

Returns:the tool display type
Return type:NXOpen.CAM.OperationDisplayOptionsBuilderToolDisplayTypes

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ToolDisplayType(toolDisplay)

Parameters:toolDisplay (NXOpen.CAM.OperationDisplayOptionsBuilderToolDisplayTypes) – the tool display type

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)