NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Preferences::PartVisualizationColorSetting Class Reference

Represents the set of visualization preferences under color setting tab applicable to part
To obtain an instance of this class, refer to NXOpen::Preferences::PartPreferences

Created in NX3.0.0. More...

Public Types

enum  RandomColorDisplayFor { RandomColorDisplayForFaces, RandomColorDisplayForBodies }
 Describes whether the random color display is applicable for faces or bodies. More...
 

Public Member Functions

int AttentionColor ()
 Returns the color that an HD3D objects associated objects are highlighted with when the HD3D object is selected. More...
 
NXOpen::NXColorHandleActiveColor ()
 Returns the color of active handles. More...
 
NXOpen::NXColorHandleColor ()
 Returns the color of handles. More...
 
NXOpen::NXColorHandleOrientxpressColor ()
 Returns the color of the OrientXpress handle. More...
 
NXOpen::NXColorHandlePreselectionColor ()
 Returns the preselection color of handles. More...
 
NXOpen::NXColorHandleSelectionColor ()
 Returns the selection color of handles. More...
 
int HiddenGeometryColor ()
 Returns the color of hidden geometry. More...
 
int MonochromeBackgroundColor ()
 Returns the monochrome background color
Created in NX3.0.0. More...
 
bool MonochromeDisplay ()
 Returns the monochrome display flag. More...
 
int MonochromeForegroundColor ()
 Returns the monochrome foreground color. More...
 
int MonochromePreselectionColor ()
 Returns the monochrome color for preselected objects
Created in NX3.0.0. More...
 
int MonochromeSelectionColor ()
 Returns the monochrome selection_color. More...
 
int PreselectionColor ()
 Returns the preselection color. More...
 
NXOpen::Preferences::PartVisualizationColorSetting::RandomColorDisplayFor RandomColorDisplay ()
 Returns the random color display selection. More...
 
bool RandomColorDisplayOption ()
 Returns the random color display flag. More...
 
int SelectionColor ()
 Returns the selection color. More...
 
void SetAttentionColor (int attentionColor)
 Sets the color that an HD3D objects associated objects are highlighted with when the HD3D object is selected. More...
 
void SetHandleActiveColor (NXOpen::NXColor *handleActiveColor)
 Sets the color of active handles. More...
 
void SetHandleColor (NXOpen::NXColor *handleColor)
 Sets the color of handles. More...
 
void SetHandleOrientxpressColor (NXOpen::NXColor *handleOrientxpressColor)
 Sets the color of the OrientXpress handle. More...
 
void SetHandlePreselectionColor (NXOpen::NXColor *handlePreselectionColor)
 Sets the preselection color of handles. More...
 
void SetHandleSelectionColor (NXOpen::NXColor *handleSelectionColor)
 Sets the selection color of handles. More...
 
void SetHiddenGeometryColor (int hiddenGeometryColor)
 Sets the color of hidden geometry. More...
 
void SetMonochromeBackgroundColor (int monochromeBackgroundColor)
 Sets the monochrome background color
Created in NX3.0.0. More...
 
void SetMonochromeDisplay (bool monochromeDisplay)
 Sets the monochrome display flag. More...
 
void SetMonochromeForegroundColor (int monochromeForegroundColor)
 Sets the monochrome foreground color. More...
 
void SetMonochromePreselectionColor (int monochromePreselectionColor)
 Sets the monochrome color for preselected objects
Created in NX3.0.0. More...
 
void SetMonochromeSelectionColor (int monochromeSelectionColor)
 Sets the monochrome selection_color. More...
 
void SetPreselectionColor (int preselectionColor)
 Sets the preselection color. More...
 
void SetRandomColorDisplay (NXOpen::Preferences::PartVisualizationColorSetting::RandomColorDisplayFor randomColorDisplay)
 Sets the random color display selection. More...
 
void SetRandomColorDisplayOption (bool randomColorDisplayOption)
 Sets the random color display flag. More...
 
void SetSelectionColor (int selectionColor)
 Sets the selection color. More...
 
void SetShowWidths (bool showWidths)
 Sets the show widths flag. More...
 
bool ShowWidths ()
 Returns the show widths flag. More...
 
void ShuffleRandomColor ()
 Allows user to shuffle the Random color
Created in NX3.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the set of visualization preferences under color setting tab applicable to part
To obtain an instance of this class, refer to NXOpen::Preferences::PartPreferences

Created in NX3.0.0.


Member Enumeration Documentation

Describes whether the random color display is applicable for faces or bodies.

Enumerator
RandomColorDisplayForFaces 

For Faces.

RandomColorDisplayForBodies 

For Bodies.

Member Function Documentation

int NXOpen::Preferences::PartVisualizationColorSetting::AttentionColor ( )

Returns the color that an HD3D objects associated objects are highlighted with when the HD3D object is selected.

The color must be in the range of 1 to 216 inclusive.
Created in NX7.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::Preferences::PartVisualizationColorSetting::HandleActiveColor ( )

Returns the color of active handles.


Created in NX7.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Preferences::PartVisualizationColorSetting::HandleColor ( )

Returns the color of handles.


Created in NX7.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Preferences::PartVisualizationColorSetting::HandleOrientxpressColor ( )

Returns the color of the OrientXpress handle.


Created in NX7.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Preferences::PartVisualizationColorSetting::HandlePreselectionColor ( )

Returns the preselection color of handles.


Created in NX7.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Preferences::PartVisualizationColorSetting::HandleSelectionColor ( )

Returns the selection color of handles.


Created in NX7.5.0.

License requirements : None

int NXOpen::Preferences::PartVisualizationColorSetting::HiddenGeometryColor ( )

Returns the color of hidden geometry.


Created in NX3.0.0.

License requirements : None

int NXOpen::Preferences::PartVisualizationColorSetting::MonochromeBackgroundColor ( )

Returns the monochrome background color
Created in NX3.0.0.



License requirements : None

bool NXOpen::Preferences::PartVisualizationColorSetting::MonochromeDisplay ( )

Returns the monochrome display flag.

If true it turns on the monochrome display options. Monochrome display also applies to Expanded drawing views.
Created in NX3.0.0.

License requirements : None

int NXOpen::Preferences::PartVisualizationColorSetting::MonochromeForegroundColor ( )

Returns the monochrome foreground color.

Monochrome color for all displayable objects, view borders, and view names.
Created in NX3.0.0.

License requirements : None

int NXOpen::Preferences::PartVisualizationColorSetting::MonochromePreselectionColor ( )

Returns the monochrome color for preselected objects
Created in NX3.0.0.



License requirements : None

int NXOpen::Preferences::PartVisualizationColorSetting::MonochromeSelectionColor ( )

Returns the monochrome selection_color.

Displays all selected/highlighted objects, temporary display objects (such as coneheads, temporary text), and drawing borders in this color.
Created in NX3.0.0.

License requirements : None

int NXOpen::Preferences::PartVisualizationColorSetting::PreselectionColor ( )

Returns the preselection color.

Represents color of selectable objects for the current operation.
Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::PartVisualizationColorSetting::RandomColorDisplayFor NXOpen::Preferences::PartVisualizationColorSetting::RandomColorDisplay ( )

Returns the random color display selection.


Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::PartVisualizationColorSetting::RandomColorDisplayOption ( )

Returns the random color display flag.

If true it provides a temporary display of unique colors per solid object.
Created in NX3.0.0.

License requirements : None

int NXOpen::Preferences::PartVisualizationColorSetting::SelectionColor ( )

Returns the selection color.

Represents color of selected objects, the grid, view names and borders, and temporary points and conehead vectors.
Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::PartVisualizationColorSetting::SetAttentionColor ( int  attentionColor)

Sets the color that an HD3D objects associated objects are highlighted with when the HD3D object is selected.

The color must be in the range of 1 to 216 inclusive.
Created in NX7.0.0.

License requirements : None

Parameters
attentionColorattention color
void NXOpen::Preferences::PartVisualizationColorSetting::SetHandleActiveColor ( NXOpen::NXColor handleActiveColor)

Sets the color of active handles.


Created in NX7.5.0.

License requirements : None

Parameters
handleActiveColorhandle active color
void NXOpen::Preferences::PartVisualizationColorSetting::SetHandleColor ( NXOpen::NXColor handleColor)

Sets the color of handles.


Created in NX7.5.0.

License requirements : None

Parameters
handleColorhandle color
void NXOpen::Preferences::PartVisualizationColorSetting::SetHandleOrientxpressColor ( NXOpen::NXColor handleOrientxpressColor)

Sets the color of the OrientXpress handle.


Created in NX7.5.0.

License requirements : None

Parameters
handleOrientxpressColorhandle orientxpress color
void NXOpen::Preferences::PartVisualizationColorSetting::SetHandlePreselectionColor ( NXOpen::NXColor handlePreselectionColor)

Sets the preselection color of handles.


Created in NX7.5.0.

License requirements : None

Parameters
handlePreselectionColorhandle preselection color
void NXOpen::Preferences::PartVisualizationColorSetting::SetHandleSelectionColor ( NXOpen::NXColor handleSelectionColor)

Sets the selection color of handles.


Created in NX7.5.0.

License requirements : None

Parameters
handleSelectionColorhandle selection color
void NXOpen::Preferences::PartVisualizationColorSetting::SetHiddenGeometryColor ( int  hiddenGeometryColor)

Sets the color of hidden geometry.


Created in NX3.0.0.

License requirements : None

Parameters
hiddenGeometryColorhidden geometry color
void NXOpen::Preferences::PartVisualizationColorSetting::SetMonochromeBackgroundColor ( int  monochromeBackgroundColor)

Sets the monochrome background color
Created in NX3.0.0.



License requirements : None

Parameters
monochromeBackgroundColormonochrome background color
void NXOpen::Preferences::PartVisualizationColorSetting::SetMonochromeDisplay ( bool  monochromeDisplay)

Sets the monochrome display flag.

If true it turns on the monochrome display options. Monochrome display also applies to Expanded drawing views.
Created in NX3.0.0.

License requirements : None

Parameters
monochromeDisplaymonochrome display
void NXOpen::Preferences::PartVisualizationColorSetting::SetMonochromeForegroundColor ( int  monochromeForegroundColor)

Sets the monochrome foreground color.

Monochrome color for all displayable objects, view borders, and view names.
Created in NX3.0.0.

License requirements : None

Parameters
monochromeForegroundColormonochrome foreground color
void NXOpen::Preferences::PartVisualizationColorSetting::SetMonochromePreselectionColor ( int  monochromePreselectionColor)

Sets the monochrome color for preselected objects
Created in NX3.0.0.



License requirements : None

Parameters
monochromePreselectionColormonochrome preselection color
void NXOpen::Preferences::PartVisualizationColorSetting::SetMonochromeSelectionColor ( int  monochromeSelectionColor)

Sets the monochrome selection_color.

Displays all selected/highlighted objects, temporary display objects (such as coneheads, temporary text), and drawing borders in this color.
Created in NX3.0.0.

License requirements : None

Parameters
monochromeSelectionColormonochrome selection color
void NXOpen::Preferences::PartVisualizationColorSetting::SetPreselectionColor ( int  preselectionColor)

Sets the preselection color.

Represents color of selectable objects for the current operation.
Created in NX3.0.0.

License requirements : None

Parameters
preselectionColorpreselection color
void NXOpen::Preferences::PartVisualizationColorSetting::SetRandomColorDisplay ( NXOpen::Preferences::PartVisualizationColorSetting::RandomColorDisplayFor  randomColorDisplay)

Sets the random color display selection.


Created in NX3.0.0.

License requirements : None

Parameters
randomColorDisplayrandom color display
void NXOpen::Preferences::PartVisualizationColorSetting::SetRandomColorDisplayOption ( bool  randomColorDisplayOption)

Sets the random color display flag.

If true it provides a temporary display of unique colors per solid object.
Created in NX3.0.0.

License requirements : None

Parameters
randomColorDisplayOptionrandom color display option
void NXOpen::Preferences::PartVisualizationColorSetting::SetSelectionColor ( int  selectionColor)

Sets the selection color.

Represents color of selected objects, the grid, view names and borders, and temporary points and conehead vectors.
Created in NX3.0.0.

License requirements : None

Parameters
selectionColorselection color
void NXOpen::Preferences::PartVisualizationColorSetting::SetShowWidths ( bool  showWidths)

Sets the show widths flag.

If true, the object width attribute determines the displayed width of lines or curves used to represent an object.
Created in NX3.0.0.

License requirements : None

Parameters
showWidthsshow widths
bool NXOpen::Preferences::PartVisualizationColorSetting::ShowWidths ( )

Returns the show widths flag.

If true, the object width attribute determines the displayed width of lines or curves used to represent an object.
Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::PartVisualizationColorSetting::ShuffleRandomColor ( )

Allows user to shuffle the Random color
Created in NX3.0.0.



License requirements : None

tag_t NXOpen::Preferences::PartVisualizationColorSetting::Tag ( ) const

Returns the tag of this object.


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