NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::OperationDisplayOptionsBuilder Class Reference

Represents a display options Builder
This is an abstract class and cannot be instantiated. More...

Inheritance diagram for NXOpen::CAM::OperationDisplayOptionsBuilder:
NXOpen::TaggedObject

List of all members.

Public Types

enum  PathDisplayTypes {
  PathDisplayTypesSolidCenter, PathDisplayTypesDashedCenter, PathDisplayTypesSilhouette, PathDisplayTypesFill,
  PathDisplayTypesSilhouetteFill
}
 the path display types
Created in NX6.0.0. More...
enum  PathNormalTypes { PathNormalTypesTypesToolAxis, PathNormalTypesTypesSpecify }
 the path normal types
Created in NX6.0.0. More...
enum  PatternDisplayTypes { PatternDisplayTypesNone, PatternDisplayTypesSpecify }
 the pattern display types
Created in NX6.0.0. More...
enum  ToolDisplayTypes { ToolDisplayTypesNone, ToolDisplayTypesTool2d, ToolDisplayTypesTool3d, ToolDisplayTypesAxis }
 the tool display types
Created in NX6.0.0. More...

Public Member Functions

bool ArrowDisplayFlag ()
 Returns the arrow display flag
Created in NX6.0.0.
bool DisplayCutRegionsFlag ()
 Returns the display cut regions flag
Created in NX6.0.0.
bool FeedDisplayFlag ()
 Returns the feed display flag
Created in NX6.0.0.
bool LineNumberDisplayFlag ()
 Returns the line number display flag
Created in NX6.0.0.
NXOpen::CAM::DisplayPaintPaintDisplay ()
 Returns the sub builder for paint display
Created in NX7.5.0.
NXOpen::CAM::DisplayPathPathDisplay ()
 Returns the sub builder for path display
Created in NX7.5.0.
NXOpen::CAM::PathDisplayColorsPathDisplayColors ()
 Returns the path display colors builder
Created in NX7.5.0.
NXOpen::CAM::OperationPathDisplayColorsBuilderPathDisplayColorsBuilder ()
 Returns the operation path display colors builder

NXOpen::CAM::OperationDisplayOptionsBuilder::PathDisplayTypes PathDisplayType ()
 Returns the path display types
Created in NX6.0.0.
NXOpen::CAM::OperationDisplayOptionsBuilder::PathNormalTypes PathNormalType ()
 Returns the path normal types
Created in NX6.0.0.
NXOpen::DirectionPathVector ()
 Returns the path vector
Created in NX6.0.0.
int PatternDisplayFrequency ()
 Returns the pattern display frequency
Created in NX6.0.0.
NXOpen::CAM::OperationDisplayOptionsBuilder::PatternDisplayTypes PatternDisplayType ()
 Returns the pattern display types
Created in NX6.0.0.
NXString PatternFile ()
 Returns the pattern file name
Created in NX6.0.0.
double PatternXOffset ()
 Returns the pattern X offset
Created in NX6.0.0.
double PatternYOffset ()
 Returns the pattern Y offset
Created in NX6.0.0.
double PatternZOffset ()
 Returns the pattern Z offset
Created in NX6.0.0.
bool PauseAfterDisplayFlag ()
 Returns the pause after display flag
Created in NX6.0.0.
double PercentOfTool ()
 Returns the percent of tool.The range is 1-100.
bool RefreshBeforeDisplayFlag ()
 Returns the refresh before display flag
Created in NX6.0.0.
int ReplaySpeed ()
 Returns the replay speed.
void SetArrowDisplayFlag (bool arrowDisplay)
 Sets the arrow display flag
Created in NX6.0.0.
void SetDisplayCutRegionsFlag (bool displayCutRegions)
 Sets the display cut regions flag
Created in NX6.0.0.
void SetFeedDisplayFlag (bool feedDisplay)
 Sets the feed display flag
Created in NX6.0.0.
void SetLineNumberDisplayFlag (bool lineNumberDisplay)
 Sets the line number display flag
Created in NX6.0.0.
void SetPathDisplayType (NXOpen::CAM::OperationDisplayOptionsBuilder::PathDisplayTypes pathDisplay)
 Sets the path display types
Created in NX6.0.0.
void SetPathNormalType (NXOpen::CAM::OperationDisplayOptionsBuilder::PathNormalTypes pathNormal)
 Sets the path normal types
Created in NX6.0.0.
void SetPathVector (NXOpen::Direction *vector)
 Sets the path vector
Created in NX6.0.0.
void SetPatternDisplayFrequency (int patternDisplayFrequency)
 Sets the pattern display frequency
Created in NX6.0.0.
void SetPatternDisplayType (NXOpen::CAM::OperationDisplayOptionsBuilder::PatternDisplayTypes patternDisplay)
 Sets the pattern display types
Created in NX6.0.0.
void SetPatternFile (const NXString &filename)
 Sets the pattern file name
Created in NX6.0.0.
void SetPatternXOffset (double xOffset)
 Sets the pattern X offset
Created in NX6.0.0.
void SetPatternYOffset (double yOffset)
 Sets the pattern Y offset
Created in NX6.0.0.
void SetPatternZOffset (double zOffset)
 Sets the pattern Z offset
Created in NX6.0.0.
void SetPauseAfterDisplayFlag (bool pauseAfterDisplay)
 Sets the pause after display flag
Created in NX6.0.0.
void SetPercentOfTool (double percentTool)
 Sets the percent of tool.The range is 1-100.
void SetRefreshBeforeDisplayFlag (bool refreshBeforeDisplay)
 Sets the refresh before display flag
Created in NX6.0.0.
void SetReplaySpeed (int displaySpeed)
 Sets the replay speed.
void SetSuppressPathDisplayFlag (bool suppressPathDisplay)
 Sets the suppress path display flag
Created in NX6.0.0.
void SetToolDisplayFrequency (int toolDisplayFrequency)
 Sets the tool display frequency
Created in NX6.0.0.
void SetToolDisplayType (NXOpen::CAM::OperationDisplayOptionsBuilder::ToolDisplayTypes toolDisplay)
 Sets the tool display types
Created in NX6.0.0.
NXOpen::CAM::DisplaySilhouetteSilhouDisplay ()
 Returns the sub builder for silhou display
Created in NX7.5.0.
bool SuppressPathDisplayFlag ()
 Returns the suppress path display flag
Created in NX6.0.0.
NXOpen::CAM::DisplayToolToolDisplay ()
 Returns the sub builder for tool display
Created in NX7.5.0.
int ToolDisplayFrequency ()
 Returns the tool display frequency
Created in NX6.0.0.
NXOpen::CAM::OperationDisplayOptionsBuilder::ToolDisplayTypes ToolDisplayType ()
 Returns the tool display types
Created in NX6.0.0.

Detailed Description

Represents a display options Builder
This is an abstract class and cannot be instantiated.



Created in NX6.0.0.


Member Enumeration Documentation

the path display types
Created in NX6.0.0.


Enumerator:
PathDisplayTypesSolidCenter 

Path Display: Solid Center.

PathDisplayTypesDashedCenter 

Path Display: Dashed Center.

PathDisplayTypesSilhouette 

Path Display: Silhouette.

PathDisplayTypesFill 

Path Display: Fill.

PathDisplayTypesSilhouetteFill 

Path Display: Silhouette Fill.

the path normal types
Created in NX6.0.0.


Enumerator:
PathNormalTypesTypesToolAxis 

Path Normal: Tool axis.

PathNormalTypesTypesSpecify 

Path Normal: Specify.

the pattern display types
Created in NX6.0.0.


Enumerator:
PatternDisplayTypesNone 

Pattern Display: None.

PatternDisplayTypesSpecify 

Pattern Display: Specify.

the tool display types
Created in NX6.0.0.


Enumerator:
ToolDisplayTypesNone 

Tool Display: None.

ToolDisplayTypesTool2d 

Tool Display: 2D.

ToolDisplayTypesTool3d 

Tool Display: 3D.

ToolDisplayTypesAxis 

Tool Display: Axis.


Member Function Documentation

Returns the arrow display flag
Created in NX6.0.0.



License requirements : None

Returns the display cut regions flag
Created in NX6.0.0.



License requirements : None

Returns the feed display flag
Created in NX6.0.0.



License requirements : None

Returns the line number display flag
Created in NX6.0.0.



License requirements : None

Returns the sub builder for paint display
Created in NX7.5.0.



License requirements : None

Returns the sub builder for path display
Created in NX7.5.0.



License requirements : None

Returns the path display colors builder
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Returns the operation path display colors builder

Deprecated:
Deprecated in NX7.5.0.



Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Returns the path display types
Created in NX6.0.0.



License requirements : None

Returns the path normal types
Created in NX6.0.0.



License requirements : None

Returns the path vector
Created in NX6.0.0.



License requirements : None

Returns the pattern display frequency
Created in NX6.0.0.



License requirements : None

Returns the pattern display types
Created in NX6.0.0.



License requirements : None

Returns the pattern file name
Created in NX6.0.0.



License requirements : None

Returns the pattern X offset
Created in NX6.0.0.



License requirements : None

Returns the pattern Y offset
Created in NX6.0.0.



License requirements : None

Returns the pattern Z offset
Created in NX6.0.0.



License requirements : None

Returns the pause after display flag
Created in NX6.0.0.



License requirements : None

Returns the percent of tool.The range is 1-100.


Created in NX6.0.0.

License requirements : None

Returns the refresh before display flag
Created in NX6.0.0.



License requirements : None

Returns the replay speed.

The range is 1-10.
Created in NX6.0.0.

License requirements : None

Sets the arrow display flag
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
arrowDisplaythe arrow display flag

Sets the display cut regions flag
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
displayCutRegionsthe display cut regions flag

Sets the feed display flag
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
feedDisplaythe feed display flag

Sets the line number display flag
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
lineNumberDisplaythe line number display flag

Sets the path display types
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
pathDisplaythe path display type

Sets the path normal types
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
pathNormalthe path normal type

Sets the path vector
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
vectorvector

Sets the pattern display frequency
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
patternDisplayFrequencythe pattern display frequency

Sets the pattern display types
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
patternDisplaythe pattern display type

Sets the pattern file name
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
filenamefilename

Sets the pattern X offset
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
xOffsetthe pattern X offset

Sets the pattern Y offset
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
yOffsetthe pattern Y offset

Sets the pattern Z offset
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
zOffsetthe pattern Z offset

Sets the pause after display flag
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
pauseAfterDisplaythe pause after display flag

Sets the percent of tool.The range is 1-100.


Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
percentToolthe percent of tool.The range is 1-100.

Sets the refresh before display flag
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
refreshBeforeDisplaythe refresh before display flag

Sets the replay speed.

The range is 1-10.
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters:
displaySpeedthe replay speed. The range is 1-10.

Sets the suppress path display flag
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
suppressPathDisplaythe suppress path display flag

Sets the tool display frequency
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
toolDisplayFrequencythe tool display frequency

Sets the tool display types
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
toolDisplaythe tool display type

Returns the sub builder for silhou display
Created in NX7.5.0.



License requirements : None

Returns the suppress path display flag
Created in NX6.0.0.



License requirements : None

Returns the sub builder for tool display
Created in NX7.5.0.



License requirements : None

Returns the tool display frequency
Created in NX6.0.0.



License requirements : None

Returns the tool display types
Created in NX6.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.