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

Represents a PlotBuilder . More...

Inheritance diagram for NXOpen::PlotBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ImageResolutionOption { ImageResolutionOptionDraft, ImageResolutionOptionLow, ImageResolutionOptionMedium, ImageResolutionOptionHigh }
 Specifies the plot image resolution. More...
enum  JustificationOption { JustificationOptionLeft, JustificationOptionCenter, JustificationOptionRight }
 Specifies the justification of the banner. More...
enum  PlotTypes { PlotTypesStandard, PlotTypesUsingLayout }
 Specifies the type of plot. More...
enum  RotationOption { RotationOptionDegree0, RotationOptionDegree90, RotationOptionDegree180, RotationOptionDegree270 }
 Specifies the rotation of the banner. More...
enum  UnitsOption { UnitsOptionMetric, UnitsOptionEnglish }
 Specifies which units are associated to the dimensions. More...
enum  XdisplayOption { XdisplayOptionLeft, XdisplayOptionCenter, XdisplayOptionRight }
 Specifies the x-coordinate for the banner location. More...
enum  YdisplayOption { YdisplayOptionBottom, YdisplayOptionCenter, YdisplayOptionTop }
 Specifies the y-coordinate for the banner location. More...

Public Member Functions

void AddToPlotLayout ()
 Add Plot to Layout.
void AdvancedPlot ()
 Initialize the SDI dialog.
NXString BannerMessage ()
 Returns the banner message.
double CharacterSize ()
 Returns the character size of the banner.
void ClearPlotLayout ()
 Clear Plot from Layout.
bool ClsfData ()
 Returns the option to plot clsf data.
NXOpen::PlotColorsWidthsBuilderColorsWidthsBuilder ()
 Returns the Colors Widths builder.
int Copies ()
 Returns the number of copies to be plotted.
bool DisplayBanner ()
 Returns the display banner.
std::vector< NXStringGetFilenames ()
 Gets all the temporary CGM filenames to be plotted.
std::vector< NXStringGetGraphicFilenames ()
 Gets all the Graphic filenames to be saved.
NXOpen::PlotBuilder::ImageResolutionOption ImageResolution ()
 Returns the resolution of images created for plotting shaded views.
NXString JobName ()
 Returns the job name to be used for plotting.
NXOpen::PlotBuilder::JustificationOption Justification ()
 Returns the justification of the banner text.
NXString PlotterText ()
 Returns the plotter text.
NXOpen::PlotBuilder::PlotTypes PlotType ()
 Returns the type of plot.
NXString PrinterGroupText ()
 Returns the printer group text.
NXString ProfileText ()
 Returns the profile text.
bool RasterImages ()
 Returns the raster images option.
NXOpen::PlotBuilder::RotationOption Rotation ()
 Returns the rotation of the banner.
void SaveCgm ()
 Saves the selected sheets as CGM files.
void SetBannerMessage (const NXString &bannerMessage)
 Sets the banner message.
void SetCharacterSize (double characterSize)
 Sets the character size of the banner.
void SetClsfData (bool clsfData)
 Sets the option to plot clsf data.
void SetCopies (int copies)
 Sets the number of copies to be plotted.
void SetDisplayBanner (bool displayBanner)
 Sets the display banner.
void SetFilenames (std::vector< NXString > &filenames)
 Sets all the temporary CGM filenames to be plotted.
void SetGraphicFilenames (std::vector< NXString > &filenames)
 Sets all the Graphic filenames to be saved.
void SetImageResolution (NXOpen::PlotBuilder::ImageResolutionOption imageResolution)
 Sets the resolution of images created for plotting shaded views.
void SetJobName (const NXString &jobName)
 Sets the job name to be used for plotting.
void SetJustification (NXOpen::PlotBuilder::JustificationOption justification)
 Sets the justification of the banner text.
void SetPlotterText (const NXString &plotter)
 Sets the plotter text.
void SetPlotType (NXOpen::PlotBuilder::PlotTypes plotType)
 Sets the type of plot.
void SetPrinterGroupText (const NXString &printerGroup)
 Sets the printer group text.
void SetProfileText (const NXString &profile)
 Sets the profile text.
void SetRasterImages (bool rasterImages)
 Sets the raster images option.
void SetRotation (NXOpen::PlotBuilder::RotationOption rotation)
 Sets the rotation of the banner.
void SetShadedGeometry (bool shadedGeometry)
 Sets the shaded geometry as wireframe option.
void SetTolerance (double tolerance)
 Sets the plotting tolerance.
void SetUnits (NXOpen::PlotBuilder::UnitsOption units)
 Sets the units used to create the banner.
void SetXDisplay (NXOpen::PlotBuilder::XdisplayOption xDisplay)
 Sets the X coordinate of a banner.
void SetXOffset (double xOffset)
 Sets the X coordinate offset of a banner.
void SetYDisplay (NXOpen::PlotBuilder::YdisplayOption yDisplay)
 Sets the Y coordinate of a banner.
void SetYOffset (double yOffset)
 Sets the Y coordinate offset of a banner.
bool ShadedGeometry ()
 Returns the shaded geometry as wireframe option.
NXOpen::PlotSourceBuilderSourceBuilder ()
 Returns the Source builder.
double Tolerance ()
 Returns the plotting tolerance.
NXOpen::PlotBuilder::UnitsOption Units ()
 Returns the units used to create the banner.
NXOpen::PlotBuilder::XdisplayOption XDisplay ()
 Returns the X coordinate of a banner.
double XOffset ()
 Returns the X coordinate offset of a banner.
NXOpen::PlotBuilder::YdisplayOption YDisplay ()
 Returns the Y coordinate of a banner.
double YOffset ()
 Returns the Y coordinate offset of a banner.

Detailed Description

Represents a PlotBuilder .

This class contains all information relating to plotting. The user must specify the sheets to be plotted by setting the appropriate fields through the PlotSourceBuilder . For each sheet selected, a temporary CGM file name must be supplied. Once the sheets are selected, the user must set the plotter and profile fields. If the plotter selected is an image file (JPEG, TIFF, EMF, CGM, or PNG), then a graphic filename must also be supplied for each sheet selected. The PlotBuilder class also handles all Banner data and Manufacturing data to be used during plotting. This class is created using PlotManager .
To create a new instance of this class, use PlotManager::CreatePlotBuilder

Created in NX5.0.0.


Member Enumeration Documentation

Specifies the plot image resolution.

Enumerator:
ImageResolutionOptionDraft 

Draft Resolution.

ImageResolutionOptionLow 

Low Resolution.

ImageResolutionOptionMedium 

Medium Resolution.

ImageResolutionOptionHigh 

High Resolution.

Specifies the justification of the banner.

Enumerator:
JustificationOptionLeft 

Left Justify.

JustificationOptionCenter 

Center Justify.

JustificationOptionRight 

Right Justify.

Specifies the type of plot.

Enumerator:
PlotTypesStandard 

Standard Plot.

PlotTypesUsingLayout 

Plot Using a Layout.

Specifies the rotation of the banner.

Enumerator:
RotationOptionDegree0 

0 degree rotation

RotationOptionDegree90 

90 degree rotation

RotationOptionDegree180 

180 degree rotation

RotationOptionDegree270 

270 degree rotation

Specifies which units are associated to the dimensions.

Enumerator:
UnitsOptionMetric 

Metric.

UnitsOptionEnglish 

English.

Specifies the x-coordinate for the banner location.

Enumerator:
XdisplayOptionLeft 

X dimension left.

XdisplayOptionCenter 

X dimension center.

XdisplayOptionRight 

X dimension right.

Specifies the y-coordinate for the banner location.

Enumerator:
YdisplayOptionBottom 

Y dimension bottom.

YdisplayOptionCenter 

Y dimension center.

YdisplayOptionTop 

Y dimension top.


Member Function Documentation

Add Plot to Layout.

This routine adds a sheet to the plot layout.
Created in NX5.0.0.

License requirements : None

Initialize the SDI dialog.


Created in NX5.0.0.

License requirements : None

Returns the banner message.

This text field will be added to the banner if Display Banner is set to true.
Created in NX5.0.0.

License requirements : None

Returns the character size of the banner.

If Display Banner is true, the character size value will be used to determine the size of the banner text.
Created in NX5.0.0.

License requirements : None

Clear Plot from Layout.

This routine clears all sheets from the plot layout.
Created in NX5.0.0.

License requirements : None

Returns the option to plot clsf data.

If clsf data is true, the current clsf data will be included in the plot.
Created in NX5.0.0.

License requirements : None

Returns the Colors Widths builder.

The Colors Widths builder contains all information relating to both colors and widths.
Created in NX5.0.0.

License requirements : None

Returns the number of copies to be plotted.


Created in NX5.0.0.

License requirements : None

Returns the display banner.

If true, the specified banner options will be used in adding a banner to the plot. If false, no banner will be used to plot.
Created in NX5.0.0.

License requirements : None

Gets all the temporary CGM filenames to be plotted.

This list will contain the full path of the temporary CGM file to be used during plotting. This list must equal the number of sheets selected to plot and these files will be deleted after the plotting operation is finished.

Returns:

Created in NX5.0.0.

License requirements : None

Gets all the Graphic filenames to be saved.

If the plotter selected is an image type (JPEG, CGM, TIFF, EMF, or PNG) then the graphic filenames text list will contain the full path of where these images will be saved to disk. This list must equal the number of sheets selected to plot.

Returns:

Created in NX5.0.0.

License requirements : None

Returns the resolution of images created for plotting shaded views.


Created in NX5.0.0.

License requirements : None

Returns the job name to be used for plotting.


Created in NX5.0.0.

License requirements : None

Returns the justification of the banner text.

If Display Banner is true, the justification will be used to position the banner text. This can be set to Left Justify, Center Justify, or Right Justify.
Created in NX5.0.0.

License requirements : None

Returns the plotter text.

The plotter field represents which plotter the user wishes to plot to, it can be an available printer or an image type (JPEG, CGM, TIFF, EMF, or PNG). If the plotter is a printer, then the appropriate printer group containing the chosen printer must also be set.
Created in NX5.0.0.

License requirements : None

Returns the type of plot.

This can be Standard or Plot Using a Layout.
Created in NX5.0.0.

License requirements : None

Returns the printer group text.

The printer group must be set if a printer is used as the plotter.
Created in NX5.0.0.

License requirements : None

Returns the profile text.

The profile must be a valid SDI created profile associated with the current plotter.
Created in NX5.0.0.

License requirements : None

Returns the raster images option.

This option determines whether or not raster images will be used when plotting.
Created in NX5.0.0.

License requirements : None

Returns the rotation of the banner.

This can be set to 0, 90, 180, or 270 and will determine the rotation of the banner if Display Banner is true.
Created in NX5.0.0.

License requirements : None

Saves the selected sheets as CGM files.


Created in NX5.0.0.

License requirements : None

void NXOpen::PlotBuilder::SetBannerMessage ( const NXString bannerMessage)

Sets the banner message.

This text field will be added to the banner if Display Banner is set to true.
Created in NX5.0.0.

License requirements : None

Parameters:
bannerMessagebannermessage
void NXOpen::PlotBuilder::SetCharacterSize ( double  characterSize)

Sets the character size of the banner.

If Display Banner is true, the character size value will be used to determine the size of the banner text.
Created in NX5.0.0.

License requirements : None

Parameters:
characterSizecharactersize
void NXOpen::PlotBuilder::SetClsfData ( bool  clsfData)

Sets the option to plot clsf data.

If clsf data is true, the current clsf data will be included in the plot.
Created in NX5.0.0.

License requirements : None

Parameters:
clsfDataclsfdata
void NXOpen::PlotBuilder::SetCopies ( int  copies)

Sets the number of copies to be plotted.


Created in NX5.0.0.

License requirements : None

Parameters:
copiescopies
void NXOpen::PlotBuilder::SetDisplayBanner ( bool  displayBanner)

Sets the display banner.

If true, the specified banner options will be used in adding a banner to the plot. If false, no banner will be used to plot.
Created in NX5.0.0.

License requirements : None

Parameters:
displayBannerdisplaybanner
void NXOpen::PlotBuilder::SetFilenames ( std::vector< NXString > &  filenames)

Sets all the temporary CGM filenames to be plotted.

This list will contain the full path of the temporary CGM file to be used during plotting. This list must equal the number of sheets selected to plot and the files will be deleted after the plotting operation is finished.
Created in NX5.0.0.

License requirements : None

Parameters:
filenames
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::PlotBuilder::SetGraphicFilenames ( std::vector< NXString > &  filenames)

Sets all the Graphic filenames to be saved.

If the plotter selected is an image type (JPEG, CGM, TIFF, EMF, or PNG) then the graphic filenames text list will contain the full path of where these images will be saved to disk. This list must equal the number of sheets selected to plot.
Created in NX5.0.0.

License requirements : None

Parameters:
filenames
NOTE: The full Unicode character set is not supported for this parameter.

Sets the resolution of images created for plotting shaded views.


Created in NX5.0.0.

License requirements : None

Parameters:
imageResolutionimageresolution
void NXOpen::PlotBuilder::SetJobName ( const NXString jobName)

Sets the job name to be used for plotting.


Created in NX5.0.0.

License requirements : None

Parameters:
jobNamejobname

Sets the justification of the banner text.

If Display Banner is true, the justification will be used to position the banner text. This can be set to Left Justify, Center Justify, or Right Justify.
Created in NX5.0.0.

License requirements : None

Parameters:
justificationjustification
void NXOpen::PlotBuilder::SetPlotterText ( const NXString plotter)

Sets the plotter text.

The plotter field represents which plotter the user wishes to plot to, it can be an available printer or an image type (JPEG, CGM, TIFF, EMF, or PNG). If the plotter is a printer, then the appropriate printer group containing the chosen printer must also be set.
Created in NX5.0.0.

License requirements : None

Parameters:
plotterplotter

Sets the type of plot.

This can be Standard or Plot Using a Layout.
Created in NX5.0.0.

License requirements : None

Parameters:
plotTypeplottype
void NXOpen::PlotBuilder::SetPrinterGroupText ( const NXString printerGroup)

Sets the printer group text.

The printer group must be set if a printer is used as the plotter.
Created in NX5.0.0.

License requirements : None

Parameters:
printerGroupprintergroup
void NXOpen::PlotBuilder::SetProfileText ( const NXString profile)

Sets the profile text.

The profile must be a valid SDI created profile associated with the current plotter.
Created in NX5.0.0.

License requirements : None

Parameters:
profileprofile
void NXOpen::PlotBuilder::SetRasterImages ( bool  rasterImages)

Sets the raster images option.

This option determines whether or not raster images will be used when plotting.
Created in NX5.0.0.

License requirements : None

Parameters:
rasterImagesrasterimages

Sets the rotation of the banner.

This can be set to 0, 90, 180, or 270 and will determine the rotation of the banner if Display Banner is true.
Created in NX5.0.0.

License requirements : None

Parameters:
rotationrotation
void NXOpen::PlotBuilder::SetShadedGeometry ( bool  shadedGeometry)

Sets the shaded geometry as wireframe option.

If set to true, this option will show shaded objects as wireframes. The shaded objects will be represented as shaded if this option is set to false.
Created in NX5.0.0.

License requirements : None

Parameters:
shadedGeometryshadedgeometry
void NXOpen::PlotBuilder::SetTolerance ( double  tolerance)

Sets the plotting tolerance.

The tolerance is a unitless value that controls the accuracy or smoothness of plotted curve geometry. Values must be greater than or equal to 0.0001. Smaller values produce smoother curves.
Created in NX5.0.0.

License requirements : None

Parameters:
tolerancetolerance

Sets the units used to create the banner.

The units can be either English or Metric and they pertain to the X-offset, the Y-offset, and the character size when creating a banner.
Created in NX5.0.0.

License requirements : None

Parameters:
unitsunits

Sets the X coordinate of a banner.

If Display Banner is true, the X and Y coordinates will determine where the banner will appear when plotting. This can be set to Left, Center, or Right.
Created in NX5.0.0.

License requirements : None

Parameters:
xDisplayxdisplay
void NXOpen::PlotBuilder::SetXOffset ( double  xOffset)

Sets the X coordinate offset of a banner.

If Display Banner is true, the X offset will be used as the offset value in combination with the X coordinate to determine where the banner will appear when plotting.
Created in NX5.0.0.

License requirements : None

Parameters:
xOffsetxoffset

Sets the Y coordinate of a banner.

If Display Banner is true, the X and Y coordinates will determine where the banner will appear when plotting. This can be set to Bottom, Center, or Top.
Created in NX5.0.0.

License requirements : None

Parameters:
yDisplayydisplay
void NXOpen::PlotBuilder::SetYOffset ( double  yOffset)

Sets the Y coordinate offset of a banner.

If Display Banner is true, the Y offset will be used as the offset value in combination with the Y coordinate to determine where the banner will appear when plotting.
Created in NX5.0.0.

License requirements : None

Parameters:
yOffsetyoffset

Returns the shaded geometry as wireframe option.

If set to true, this option will show shaded objects as wireframes. The shaded objects will be represented as shaded if this option is set to false.
Created in NX5.0.0.

License requirements : None

Returns the Source builder.

The Source builder contains all data involving the sheets to to be plotted.
Created in NX5.0.0.

License requirements : None

Returns the plotting tolerance.

The tolerance is a unitless value that controls the accuracy or smoothness of plotted curve geometry. Values must be greater than or equal to 0.0001. Smaller values produce smoother curves.
Created in NX5.0.0.

License requirements : None

Returns the units used to create the banner.

The units can be either English or Metric and they pertain to the X-offset, the Y-offset, and the character size when creating a banner.
Created in NX5.0.0.

License requirements : None

Returns the X coordinate of a banner.

If Display Banner is true, the X and Y coordinates will determine where the banner will appear when plotting. This can be set to Left, Center, or Right.
Created in NX5.0.0.

License requirements : None

Returns the X coordinate offset of a banner.

If Display Banner is true, the X offset will be used as the offset value in combination with the X coordinate to determine where the banner will appear when plotting.
Created in NX5.0.0.

License requirements : None

Returns the Y coordinate of a banner.

If Display Banner is true, the X and Y coordinates will determine where the banner will appear when plotting. This can be set to Bottom, Center, or Top.
Created in NX5.0.0.

License requirements : None

Returns the Y coordinate offset of a banner.

If Display Banner is true, the Y offset will be used as the offset value in combination with the Y coordinate to determine where the banner will appear when plotting.
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.