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

Represents a PlotColorsWidthsBuilder to be used for plotting. More...

Inheritance diagram for NXOpen::PlotColorsWidthsBuilder:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  Color {
  ColorAsDisplayed, ColorPartColors, ColorCustomPalette, ColorBlackOnWhite,
  ColorLegacyColors, ColorColorsByWidth
}
 Specifies the color option to use when plotting. More...
enum  Width { WidthStandardWidths, WidthSingleWidth, WidthCustomThreeWidths, WidthCustomPalette }
 Specifies the primary selection of which type of width assignment to use. More...

Public Member Functions

NXOpen::PlotColorsWidthsBuilder::Color Colors ()
 Returns the color option to be used when plotting.
NXOpen::CDFCreateCdf ()
 Creates and returns a CDF object representing the Color Palette.
NXOpen::WidthDefinitionCreateWidthDefinition ()
 Creates and returns a WidthDefinition object representing the Width Palette.
void DefinePalette ()
 Initialize the Color Palette.
void DefineWidths ()
 Initialize the Width dialog.
void DeleteColors ()
 Delete drawing sheet colors
Created in NX5.0.0.
void DeleteWidths ()
 Delete drawing sheet widths
Created in NX5.0.0.
void EditColors ()
 Edit drawing sheet colors
Created in NX5.0.0.
void EditWidths ()
 Edit drawing sheet widths
Created in NX5.0.0.
NXOpen::CDFGetCdf ()
 Returns a CDF object representing the Color Palette.
NXOpen::WidthDefinitionGetWidthDefinition ()
 Returns a WidthDefinition object representing the Width Palette.
void ResetColors ()
 Reset drawing sheet colors
Created in NX5.0.0.
void ResetWidths ()
 Reset drawing sheet widths
Created in NX5.0.0.
void RetrieveColors ()
 Retrieve drawing sheet colors
Created in NX5.0.0.
void RetrieveWidths ()
 Retrieve drawing sheet widths
Created in NX5.0.0.
void SaveColors ()
 Save drawing sheet colors
Created in NX5.0.0.
void SaveWidths ()
 Save drawing sheet widths
Created in NX5.0.0.
void SetColors (NXOpen::PlotColorsWidthsBuilder::Color colors)
 Sets the color option to be used when plotting.
void SetUseDrawingSheetColors (bool useDrawingSheetColors)
 Sets the use drawing sheet colors.
void SetUseDrawingSheetWidths (bool useDrawingSheetWidths)
 Sets the use drawing sheet widths.
void SetWidths (NXOpen::PlotColorsWidthsBuilder::Width widths)
 Sets the width option.
bool UseDrawingSheetColors ()
 Returns the use drawing sheet colors.
bool UseDrawingSheetWidths ()
 Returns the use drawing sheet widths.
NXOpen::PlotColorsWidthsBuilder::Width Widths ()
 Returns the width option.

Detailed Description

Represents a PlotColorsWidthsBuilder to be used for plotting.

The PlotColorsWidthsBuilder class maintains all colors and widths data, which will be used by the PlotBuilder. If the color option is set to Custom Palette or Colors By Width, the PlotBuilder will translate the CDF object maintained by PlotColorsWidthsBuilder in order to plot with the user-defined colors. If the width option is set to Single Width, Custom Three Width, or Custom Palette, the PlotBuilder will translate the WidthDefinition object maintained by PlotColorsWidthsBuilder in order to plot with the user-defined widths.


Created in NX5.0.0.


Member Enumeration Documentation

Specifies the color option to use when plotting.

Enumerator:
ColorAsDisplayed 

As Displayed.

ColorPartColors 

Part Colors.

ColorCustomPalette 

Custom Palette.

ColorBlackOnWhite 

Black on White.

ColorLegacyColors 

Legacy Colors.

ColorColorsByWidth 

Colors by Width.

Specifies the primary selection of which type of width assignment to use.

Enumerator:
WidthStandardWidths 

Standard Widths.

WidthSingleWidth 

Single Width.

WidthCustomThreeWidths 

Custom Three Widths.

WidthCustomPalette 

Custom palette.


Member Function Documentation

Returns the color option to be used when plotting.

If the color option is set to Custom Palette or Colors By Width then the plotter will use the user defined color attributes belonging to the CDF object.
Created in NX5.0.0.

License requirements : None

Creates and returns a CDF object representing the Color Palette.

This object contains all custom color information to be used when Custom Palette or Colors By Width is selected from the Color option.

Returns:
CDF object
Created in NX5.0.0.

License requirements : None

Creates and returns a WidthDefinition object representing the Width Palette.

This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option.

Returns:
WidthDefinition object
Created in NX5.0.0.

License requirements : None

Initialize the Color Palette.

This allows the user to change the attributes of any color. These changed colors will be used if Custom Palette or Colors By Width is selected as the color option.
Created in NX5.0.0.

License requirements : None

Initialize the Width dialog.

This allows the user to change the attributes of Single Width, Custom Three Widths, or Custom Palette. These changed width values will be used depending on the width option selected.
Created in NX5.0.0.

License requirements : None

Delete drawing sheet colors
Created in NX5.0.0.



License requirements : None

Delete drawing sheet widths
Created in NX5.0.0.



License requirements : None

Edit drawing sheet colors
Created in NX5.0.0.



License requirements : None

Edit drawing sheet widths
Created in NX5.0.0.



License requirements : None

Returns a CDF object representing the Color Palette.

This object contains all custom color information to be used when Custom Palette or Colors By Width is selected from the Color option.

Returns:
CDF object
Created in NX5.0.0.

License requirements : None

Returns a WidthDefinition object representing the Width Palette.

This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option.

Returns:
WidthDefinition object
Created in NX5.0.0.

License requirements : None

Reset drawing sheet colors
Created in NX5.0.0.



License requirements : None

Reset drawing sheet widths
Created in NX5.0.0.



License requirements : None

Retrieve drawing sheet colors
Created in NX5.0.0.



License requirements : None

Retrieve drawing sheet widths
Created in NX5.0.0.



License requirements : None

Save drawing sheet colors
Created in NX5.0.0.



License requirements : None

Save drawing sheet widths
Created in NX5.0.0.



License requirements : None

Sets the color option to be used when plotting.

If the color option is set to Custom Palette or Colors By Width then the plotter will use the user defined color attributes belonging to the CDF object.
Created in NX5.0.0.

License requirements : None

Parameters:
colorscolors
void NXOpen::PlotColorsWidthsBuilder::SetUseDrawingSheetColors ( bool  useDrawingSheetColors)

Sets the use drawing sheet colors.

When this option is set to true, the plotter will use the user-defined drawing sheet colors.
Created in NX5.0.0.

License requirements : None

Parameters:
useDrawingSheetColorsusedrawingsheetcolors
void NXOpen::PlotColorsWidthsBuilder::SetUseDrawingSheetWidths ( bool  useDrawingSheetWidths)

Sets the use drawing sheet widths.

When this option is set to true, the plotter will use the user-defined drawing sheet widths.
Created in NX5.0.0.

License requirements : None

Parameters:
useDrawingSheetWidthsusedrawingsheetwidths

Sets the width option.

If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the plotter will use the user defined width attributes belonging to the WidthDefinition object.
Created in NX5.0.0.

License requirements : None

Parameters:
widthswidths

Returns the use drawing sheet colors.

When this option is set to true, the plotter will use the user-defined drawing sheet colors.
Created in NX5.0.0.

License requirements : None

Returns the use drawing sheet widths.

When this option is set to true, the plotter will use the user-defined drawing sheet widths.
Created in NX5.0.0.

License requirements : None

Returns the width option.

If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the plotter will use the user defined width attributes belonging to the WidthDefinition object.
Created in NX5.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.