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

Inheritance diagram for NXOpen::CAM::OperationDisplayOptionsBuilder:

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::DisplayPaint *	PaintDisplay ()
	Returns the sub builder for paint display Created in NX7.5.0.

NXOpen::CAM::DisplayPath *	PathDisplay ()
	Returns the sub builder for path display Created in NX7.5.0.

NXOpen::CAM::PathDisplayColors *	PathDisplayColors ()
	Returns the path display colors builder Created in NX7.5.0.

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::Direction *	PathVector ()
	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.

bool	SaveContactDisplayDataFlag ()
	Returns the save contact displat data flag Created in NX9.0.0.

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	SetPatternFile (const char *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	SetSaveContactDisplayDataFlag (bool saveContactDisplayData)
	Sets the save contact displat data flag Created in NX9.0.0.

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::DisplaySilhouette *	SilhouDisplay ()
	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::DisplayTool *	ToolDisplay ()
	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.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::OperationDisplayOptionsBuilder::PathDisplayTypes

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.

enum NXOpen::CAM::OperationDisplayOptionsBuilder::PathNormalTypes

the path normal types
Created in NX6.0.0.

Enumerator:

PathNormalTypesTypesToolAxis	Path Normal: Tool axis.
PathNormalTypesTypesSpecify	Path Normal: Specify.

enum NXOpen::CAM::OperationDisplayOptionsBuilder::PatternDisplayTypes

the pattern display types
Created in NX6.0.0.

Enumerator:

PatternDisplayTypesNone	Pattern Display: None.
PatternDisplayTypesSpecify	Pattern Display: Specify.

enum NXOpen::CAM::OperationDisplayOptionsBuilder::ToolDisplayTypes

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

bool NXOpen::CAM::OperationDisplayOptionsBuilder::ArrowDisplayFlag ( )

Returns the arrow display flag
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::OperationDisplayOptionsBuilder::DisplayCutRegionsFlag ( )

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

License requirements : None

bool NXOpen::CAM::OperationDisplayOptionsBuilder::FeedDisplayFlag ( )

Returns the feed display flag
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::OperationDisplayOptionsBuilder::LineNumberDisplayFlag ( )

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

License requirements : None

NXOpen::CAM::DisplayPaint* NXOpen::CAM::OperationDisplayOptionsBuilder::PaintDisplay ( )

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

License requirements : None

NXOpen::CAM::DisplayPath* NXOpen::CAM::OperationDisplayOptionsBuilder::PathDisplay ( )

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

License requirements : None

NXOpen::CAM::PathDisplayColors* NXOpen::CAM::OperationDisplayOptionsBuilder::PathDisplayColors ( )

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

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::OperationDisplayOptionsBuilder::PathDisplayTypes NXOpen::CAM::OperationDisplayOptionsBuilder::PathDisplayType ( )

Returns the path display types
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::OperationDisplayOptionsBuilder::PathNormalTypes NXOpen::CAM::OperationDisplayOptionsBuilder::PathNormalType ( )

Returns the path normal types
Created in NX6.0.0.

License requirements : None

NXOpen::Direction* NXOpen::CAM::OperationDisplayOptionsBuilder::PathVector ( )

Returns the path vector
Created in NX6.0.0.

License requirements : None

int NXOpen::CAM::OperationDisplayOptionsBuilder::PatternDisplayFrequency ( )

Returns the pattern display frequency
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::OperationDisplayOptionsBuilder::PatternDisplayTypes NXOpen::CAM::OperationDisplayOptionsBuilder::PatternDisplayType ( )

Returns the pattern display types
Created in NX6.0.0.

License requirements : None

NXString NXOpen::CAM::OperationDisplayOptionsBuilder::PatternFile ( )

Returns the pattern file name
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::OperationDisplayOptionsBuilder::PatternXOffset ( )

Returns the pattern X offset
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::OperationDisplayOptionsBuilder::PatternYOffset ( )

Returns the pattern Y offset
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::OperationDisplayOptionsBuilder::PatternZOffset ( )

Returns the pattern Z offset
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::OperationDisplayOptionsBuilder::PauseAfterDisplayFlag ( )

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

License requirements : None

double NXOpen::CAM::OperationDisplayOptionsBuilder::PercentOfTool ( )

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

Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::OperationDisplayOptionsBuilder::RefreshBeforeDisplayFlag ( )

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

License requirements : None

int NXOpen::CAM::OperationDisplayOptionsBuilder::ReplaySpeed ( )

Returns the replay speed.

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

License requirements : None

bool NXOpen::CAM::OperationDisplayOptionsBuilder::SaveContactDisplayDataFlag ( )

Returns the save contact displat data flag
Created in NX9.0.0.

License requirements : None

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetArrowDisplayFlag ( bool arrowDisplay )

Sets the arrow display flag
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

arrowDisplay the arrow display flag

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetDisplayCutRegionsFlag ( bool displayCutRegions )

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

License requirements : cam_base ("CAM BASE")

Parameters

displayCutRegions the display cut regions flag

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetFeedDisplayFlag ( bool feedDisplay )

Sets the feed display flag
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

feedDisplay the feed display flag

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetLineNumberDisplayFlag ( bool lineNumberDisplay )

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

License requirements : cam_base ("CAM BASE")

Parameters

lineNumberDisplay the line number display flag

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPathDisplayType ( NXOpen::CAM::OperationDisplayOptionsBuilder::PathDisplayTypes pathDisplay )

Sets the path display types
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

pathDisplay the path display type

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPathNormalType ( NXOpen::CAM::OperationDisplayOptionsBuilder::PathNormalTypes pathNormal )

Sets the path normal types
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

pathNormal the path normal type

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPathVector ( NXOpen::Direction * vector )

Sets the path vector
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

vector vector

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPatternDisplayFrequency ( int patternDisplayFrequency )

Sets the pattern display frequency
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

patternDisplayFrequency the pattern display frequency

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPatternDisplayType ( NXOpen::CAM::OperationDisplayOptionsBuilder::PatternDisplayTypes patternDisplay )

Sets the pattern display types
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

patternDisplay the pattern display type

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPatternFile ( const NXString & filename )

Sets the pattern file name
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

filename filename

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPatternFile ( const char * filename )

Sets the pattern file name
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

filename filename

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPatternXOffset ( double xOffset )

Sets the pattern X offset
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

xOffset the pattern X offset

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPatternYOffset ( double yOffset )

Sets the pattern Y offset
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

yOffset the pattern Y offset

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPatternZOffset ( double zOffset )

Sets the pattern Z offset
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

zOffset the pattern Z offset

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPauseAfterDisplayFlag ( bool pauseAfterDisplay )

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

License requirements : cam_base ("CAM BASE")

Parameters

pauseAfterDisplay the pause after display flag

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetPercentOfTool ( double percentTool )

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

Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

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

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetRefreshBeforeDisplayFlag ( bool refreshBeforeDisplay )

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

License requirements : cam_base ("CAM BASE")

Parameters

refreshBeforeDisplay the refresh before display flag

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetReplaySpeed ( int displaySpeed )

Sets the replay speed.

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

License requirements : cam_base ("CAM BASE")

Parameters

displaySpeed the replay speed. The range is 1-10.

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetSaveContactDisplayDataFlag ( bool saveContactDisplayData )

Sets the save contact displat data flag
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

saveContactDisplayData the save contact displat data flag

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetSuppressPathDisplayFlag ( bool suppressPathDisplay )

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

License requirements : cam_base ("CAM BASE")

Parameters

suppressPathDisplay the suppress path display flag

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetToolDisplayFrequency ( int toolDisplayFrequency )

Sets the tool display frequency
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

toolDisplayFrequency the tool display frequency

void NXOpen::CAM::OperationDisplayOptionsBuilder::SetToolDisplayType ( NXOpen::CAM::OperationDisplayOptionsBuilder::ToolDisplayTypes toolDisplay )

Sets the tool display types
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

toolDisplay the tool display type

NXOpen::CAM::DisplaySilhouette* NXOpen::CAM::OperationDisplayOptionsBuilder::SilhouDisplay ( )

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

License requirements : None

bool NXOpen::CAM::OperationDisplayOptionsBuilder::SuppressPathDisplayFlag ( )

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

License requirements : None

NXOpen::CAM::DisplayTool* NXOpen::CAM::OperationDisplayOptionsBuilder::ToolDisplay ( )

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

License requirements : None

int NXOpen::CAM::OperationDisplayOptionsBuilder::ToolDisplayFrequency ( )

Returns the tool display frequency
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::OperationDisplayOptionsBuilder::ToolDisplayTypes NXOpen::CAM::OperationDisplayOptionsBuilder::ToolDisplayType ( )

Returns the tool display types
Created in NX6.0.0.

License requirements : None

The documentation for this class was generated from the following file:

CAM_OperationDisplayOptionsBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation