NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::CAM::PathDisplay Class Reference

Represents a class that is used for NX testing. More...

Public Types

enum  ColorByType {
  ColorByTypeMotionType, ColorByTypeOperation, ColorByTypeTool, ColorByTypeMotionLength,
  ColorByTypeMotionGeometry, ColorByTypeFinding
}
 Choices for coloring the tool path motions. More...
 

Public Member Functions

NXOpen::CAM::PathDisplay::ColorByType ColorBy ()
 Returns the color by property
Created in NX10.0.2. More...
 
void HideToolPath (NXOpen::CAM::CAMObject *opr)
 Hide tool path
Created in NX10.0.2. More...
 
void SetColorBy (NXOpen::CAM::PathDisplay::ColorByType colorBy)
 Sets the color by property
Created in NX10.0.2. More...
 
void SetShowCutting (bool isOn)
 Sets the indicator to display only cutting moves in a tool path. More...
 
void SetShowEndpoints (bool isOn)
 Sets the indicator to display symbol at the end of each motion. More...
 
void SetShowNoncutting (bool isOn)
 Sets the indicator to display only non cutting moves in a tool path. More...
 
void SetShowToolCenter (bool isOn)
 Sets the indicator to display tool path at the tool center instead of the tool tip for a ball mill. More...
 
bool ShowCutting ()
 Returns the indicator to display only cutting moves in a tool path. More...
 
bool ShowEndpoints ()
 Returns the indicator to display symbol at the end of each motion. More...
 
bool ShowNoncutting ()
 Returns the indicator to display only non cutting moves in a tool path. More...
 
bool ShowToolCenter ()
 Returns the indicator to display tool path at the tool center instead of the tool tip for a ball mill. More...
 
void ShowToolPath (NXOpen::CAM::CAMObject *opr)
 Show tool path
Created in NX10.0.2. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a class that is used for NX testing.

This class should not be made available to customers
To obtain an instance of this class, refer to NXOpen::CAM::CAMSession

Created in NX10.0.2.

Member Enumeration Documentation

Choices for coloring the tool path motions.

Enumerator
ColorByTypeMotionType 

motion type

ColorByTypeOperation 

operation

ColorByTypeTool 

tool

ColorByTypeMotionLength 

motion length

ColorByTypeMotionGeometry 

motion geometry

ColorByTypeFinding 

finding

Member Function Documentation

NXOpen::CAM::PathDisplay::ColorByType NXOpen::CAM::PathDisplay::ColorBy ( )

Returns the color by property
Created in NX10.0.2.



License requirements : None

void NXOpen::CAM::PathDisplay::HideToolPath ( NXOpen::CAM::CAMObject opr)

Hide tool path
Created in NX10.0.2.



License requirements : None

Parameters
opropr
void NXOpen::CAM::PathDisplay::SetColorBy ( NXOpen::CAM::PathDisplay::ColorByType  colorBy)

Sets the color by property
Created in NX10.0.2.



License requirements : None

Parameters
colorBycolorby
void NXOpen::CAM::PathDisplay::SetShowCutting ( bool  isOn)

Sets the indicator to display only cutting moves in a tool path.


Created in NX10.0.2.

License requirements : None

Parameters
isOnison
void NXOpen::CAM::PathDisplay::SetShowEndpoints ( bool  isOn)

Sets the indicator to display symbol at the end of each motion.


Created in NX10.0.2.

License requirements : None

Parameters
isOnison
void NXOpen::CAM::PathDisplay::SetShowNoncutting ( bool  isOn)

Sets the indicator to display only non cutting moves in a tool path.


Created in NX10.0.2.

License requirements : None

Parameters
isOnison
void NXOpen::CAM::PathDisplay::SetShowToolCenter ( bool  isOn)

Sets the indicator to display tool path at the tool center instead of the tool tip for a ball mill.


Created in NX10.0.2.

License requirements : None

Parameters
isOnison
bool NXOpen::CAM::PathDisplay::ShowCutting ( )

Returns the indicator to display only cutting moves in a tool path.


Created in NX10.0.2.

License requirements : None

bool NXOpen::CAM::PathDisplay::ShowEndpoints ( )

Returns the indicator to display symbol at the end of each motion.


Created in NX10.0.2.

License requirements : None

bool NXOpen::CAM::PathDisplay::ShowNoncutting ( )

Returns the indicator to display only non cutting moves in a tool path.


Created in NX10.0.2.

License requirements : None

bool NXOpen::CAM::PathDisplay::ShowToolCenter ( )

Returns the indicator to display tool path at the tool center instead of the tool tip for a ball mill.


Created in NX10.0.2.

License requirements : None

void NXOpen::CAM::PathDisplay::ShowToolPath ( NXOpen::CAM::CAMObject opr)

Show tool path
Created in NX10.0.2.



License requirements : None

Parameters
opropr
tag_t NXOpen::CAM::PathDisplay::Tag ( ) const

Returns the tag of this object.


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