NX Open C++ Reference Guide
|
Represents a NXOpen::PlotBuilder . More...
Public Member Functions | |
void | AddToPlotLayout () |
Add Plot to Layout. More... | |
void | AdvancedPlot () |
Initialize the SDI dialog. More... | |
NXString | BannerMessage () |
Returns the banner message. More... | |
double | CharacterSize () |
Returns the character size of the banner. More... | |
void | ClearPlotLayout () |
Clear Plot from Layout. More... | |
bool | ClsfData () |
Returns the option to plot clsf data. More... | |
NXOpen::PlotColorsWidthsBuilder * | ColorsWidthsBuilder () |
Returns the Colors Widths builder. More... | |
int | Copies () |
Returns the number of copies to be plotted. More... | |
bool | CustomSymbolsInForeground () |
Returns the plotting custom symbols in the foreground option. More... | |
bool | DisplayBanner () |
Returns the display banner. More... | |
std::vector< NXString > | GetFilenames () |
Gets all the temporary CGM filenames to be plotted. More... | |
std::vector< NXString > | GetGraphicFilenames () |
Gets all the Graphic filenames to be saved. More... | |
NXOpen::PlotBuilder::ImageResolutionOption | ImageResolution () |
Returns the resolution of images created for plotting shaded views. More... | |
NXString | JobName () |
Returns the job name to be used for plotting. More... | |
NXOpen::PlotBuilder::JustificationOption | Justification () |
Returns the justification of the banner text. More... | |
NXString | PlotterText () |
Returns the plotter text. More... | |
NXOpen::PlotBuilder::PlotTypes | PlotType () |
Returns the type of plot. More... | |
NXString | PrinterGroupText () |
Returns the printer group text. More... | |
NXString | ProfileText () |
Returns the profile text. More... | |
bool | RasterImages () |
Returns the raster images option. More... | |
NXOpen::PlotBuilder::RotationOption | Rotation () |
Returns the rotation of the banner. More... | |
void | SaveCgm () |
Saves the selected sheets as CGM files. More... | |
void | SetBannerMessage (const NXString &bannerMessage) |
Sets the banner message. More... | |
void | SetBannerMessage (const char *bannerMessage) |
Sets the banner message. More... | |
void | SetCharacterSize (double characterSize) |
Sets the character size of the banner. More... | |
void | SetClsfData (bool clsfData) |
Sets the option to plot clsf data. More... | |
void | SetCopies (int copies) |
Sets the number of copies to be plotted. More... | |
void | SetCustomSymbolsInForeground (bool customSymbolsInForeground) |
Sets the plotting custom symbols in the foreground option. More... | |
void | SetDisplayBanner (bool displayBanner) |
Sets the display banner. More... | |
void | SetFilenames (std::vector< NXString > &filenames) |
Sets all the temporary CGM filenames to be plotted. More... | |
void | SetGraphicFilenames (std::vector< NXString > &filenames) |
Sets all the Graphic filenames to be saved. More... | |
void | SetImageResolution (NXOpen::PlotBuilder::ImageResolutionOption imageResolution) |
Sets the resolution of images created for plotting shaded views. More... | |
void | SetJobName (const NXString &jobName) |
Sets the job name to be used for plotting. More... | |
void | SetJobName (const char *jobName) |
Sets the job name to be used for plotting. More... | |
void | SetJustification (NXOpen::PlotBuilder::JustificationOption justification) |
Sets the justification of the banner text. More... | |
void | SetPlotterText (const NXString &plotter) |
Sets the plotter text. More... | |
void | SetPlotterText (const char *plotter) |
Sets the plotter text. More... | |
void | SetPlotType (NXOpen::PlotBuilder::PlotTypes plotType) |
Sets the type of plot. More... | |
void | SetPrinterGroupText (const NXString &printerGroup) |
Sets the printer group text. More... | |
void | SetPrinterGroupText (const char *printerGroup) |
Sets the printer group text. More... | |
void | SetProfileText (const NXString &profile) |
Sets the profile text. More... | |
void | SetProfileText (const char *profile) |
Sets the profile text. More... | |
void | SetRasterImages (bool rasterImages) |
Sets the raster images option. More... | |
void | SetRotation (NXOpen::PlotBuilder::RotationOption rotation) |
Sets the rotation of the banner. More... | |
void | SetShadedGeometry (bool shadedGeometry) |
Sets the shaded geometry as wireframe option. More... | |
void | SetTolerance (double tolerance) |
Sets the plotting tolerance. More... | |
void | SetUnits (NXOpen::PlotBuilder::UnitsOption units) |
Sets the units used to create the banner. More... | |
void | SetXDisplay (NXOpen::PlotBuilder::XdisplayOption xDisplay) |
Sets the X coordinate of a banner. More... | |
void | SetXOffset (double xOffset) |
Sets the X coordinate offset of a banner. More... | |
void | SetYDisplay (NXOpen::PlotBuilder::YdisplayOption yDisplay) |
Sets the Y coordinate of a banner. More... | |
void | SetYOffset (double yOffset) |
Sets the Y coordinate offset of a banner. More... | |
bool | ShadedGeometry () |
Returns the shaded geometry as wireframe option. More... | |
NXOpen::PlotSourceBuilder * | SourceBuilder () |
Returns the Source builder. More... | |
double | Tolerance () |
Returns the plotting tolerance. More... | |
NXOpen::PlotBuilder::UnitsOption | Units () |
Returns the units used to create the banner. More... | |
NXOpen::PlotBuilder::XdisplayOption | XDisplay () |
Returns the X coordinate of a banner. More... | |
double | XOffset () |
Returns the X coordinate offset of a banner. More... | |
NXOpen::PlotBuilder::YdisplayOption | YDisplay () |
Returns the Y coordinate of a banner. More... | |
double | YOffset () |
Returns the Y coordinate offset of a banner. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. More... | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. More... | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents a NXOpen::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 NXOpen::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 NXOpen::PlotManager .
All sheets provided must be in the displayed part.
To create a new instance of this class, use NXOpen::PlotManager::CreatePlotBuilder
Created in NX5.0.0.
void NXOpen::PlotBuilder::AddToPlotLayout | ( | ) |
Add Plot to Layout.
This routine adds a sheet to the plot layout.
Created in NX5.0.0.
License requirements : None
void NXOpen::PlotBuilder::AdvancedPlot | ( | ) |
Initialize the SDI dialog.
Created in NX5.0.0.
License requirements : None
NXString NXOpen::PlotBuilder::BannerMessage | ( | ) |
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
double NXOpen::PlotBuilder::CharacterSize | ( | ) |
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
void NXOpen::PlotBuilder::ClearPlotLayout | ( | ) |
Clear Plot from Layout.
This routine clears all sheets from the plot layout.
Created in NX5.0.0.
License requirements : None
bool NXOpen::PlotBuilder::ClsfData | ( | ) |
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
NXOpen::PlotColorsWidthsBuilder* NXOpen::PlotBuilder::ColorsWidthsBuilder | ( | ) |
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
int NXOpen::PlotBuilder::Copies | ( | ) |
Returns the number of copies to be plotted.
Created in NX5.0.0.
License requirements : None
bool NXOpen::PlotBuilder::CustomSymbolsInForeground | ( | ) |
Returns the plotting custom symbols in the foreground option.
Setting this option on will cause custom symbols to be plotted in the foreground. When this option is off, geometry may overlap custom symbols when plotted.
Created in NX11.0.0.
License requirements : None
bool NXOpen::PlotBuilder::DisplayBanner | ( | ) |
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
std::vector<NXString> NXOpen::PlotBuilder::GetFilenames | ( | ) |
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.
std::vector<NXString> NXOpen::PlotBuilder::GetGraphicFilenames | ( | ) |
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.
NXOpen::PlotBuilder::ImageResolutionOption NXOpen::PlotBuilder::ImageResolution | ( | ) |
Returns the resolution of images created for plotting shaded views.
Created in NX5.0.0.
License requirements : None
NXString NXOpen::PlotBuilder::JobName | ( | ) |
Returns the job name to be used for plotting.
Created in NX5.0.0.
License requirements : None
NXOpen::PlotBuilder::JustificationOption NXOpen::PlotBuilder::Justification | ( | ) |
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
NXString NXOpen::PlotBuilder::PlotterText | ( | ) |
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
NXOpen::PlotBuilder::PlotTypes NXOpen::PlotBuilder::PlotType | ( | ) |
Returns the type of plot.
This can be Standard or Plot Using a Layout.
Created in NX5.0.0.
License requirements : None
NXString NXOpen::PlotBuilder::PrinterGroupText | ( | ) |
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
NXString NXOpen::PlotBuilder::ProfileText | ( | ) |
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
bool NXOpen::PlotBuilder::RasterImages | ( | ) |
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
NXOpen::PlotBuilder::RotationOption NXOpen::PlotBuilder::Rotation | ( | ) |
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
void NXOpen::PlotBuilder::SaveCgm | ( | ) |
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
bannerMessage | bannermessage |
void NXOpen::PlotBuilder::SetBannerMessage | ( | const char * | 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
bannerMessage | bannermessage |
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
characterSize | charactersize |
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
clsfData | clsfdata |
void NXOpen::PlotBuilder::SetCopies | ( | int | copies | ) |
Sets the number of copies to be plotted.
Created in NX5.0.0.
License requirements : None
copies | copies |
void NXOpen::PlotBuilder::SetCustomSymbolsInForeground | ( | bool | customSymbolsInForeground | ) |
Sets the plotting custom symbols in the foreground option.
Setting this option on will cause custom symbols to be plotted in the foreground. When this option is off, geometry may overlap custom symbols when plotted.
Created in NX11.0.0.
License requirements : None
customSymbolsInForeground | customsymbolsinforeground |
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
displayBanner | displaybanner |
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
filenames | filenames |
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
filenames | filenames |
void NXOpen::PlotBuilder::SetImageResolution | ( | NXOpen::PlotBuilder::ImageResolutionOption | imageResolution | ) |
Sets the resolution of images created for plotting shaded views.
Created in NX5.0.0.
License requirements : None
imageResolution | imageresolution |
void NXOpen::PlotBuilder::SetJobName | ( | const NXString & | jobName | ) |
Sets the job name to be used for plotting.
Created in NX5.0.0.
License requirements : None
jobName | jobname |
void NXOpen::PlotBuilder::SetJobName | ( | const char * | jobName | ) |
Sets the job name to be used for plotting.
Created in NX5.0.0.
License requirements : None
jobName | jobname |
void NXOpen::PlotBuilder::SetJustification | ( | NXOpen::PlotBuilder::JustificationOption | justification | ) |
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
justification | justification |
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
plotter | plotter |
void NXOpen::PlotBuilder::SetPlotterText | ( | const char * | 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
plotter | plotter |
void NXOpen::PlotBuilder::SetPlotType | ( | NXOpen::PlotBuilder::PlotTypes | plotType | ) |
Sets the type of plot.
This can be Standard or Plot Using a Layout.
Created in NX5.0.0.
License requirements : None
plotType | plottype |
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
printerGroup | printergroup |
void NXOpen::PlotBuilder::SetPrinterGroupText | ( | const char * | 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
printerGroup | printergroup |
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
profile | profile |
void NXOpen::PlotBuilder::SetProfileText | ( | const char * | 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
profile | profile |
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
rasterImages | rasterimages |
void NXOpen::PlotBuilder::SetRotation | ( | NXOpen::PlotBuilder::RotationOption | rotation | ) |
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
rotation | rotation |
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
shadedGeometry | shadedgeometry |
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
tolerance | tolerance |
void NXOpen::PlotBuilder::SetUnits | ( | NXOpen::PlotBuilder::UnitsOption | units | ) |
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
units | units |
void NXOpen::PlotBuilder::SetXDisplay | ( | NXOpen::PlotBuilder::XdisplayOption | xDisplay | ) |
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
xDisplay | xdisplay |
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
xOffset | xoffset |
void NXOpen::PlotBuilder::SetYDisplay | ( | NXOpen::PlotBuilder::YdisplayOption | yDisplay | ) |
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
yDisplay | ydisplay |
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
yOffset | yoffset |
bool NXOpen::PlotBuilder::ShadedGeometry | ( | ) |
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
NXOpen::PlotSourceBuilder* NXOpen::PlotBuilder::SourceBuilder | ( | ) |
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
double NXOpen::PlotBuilder::Tolerance | ( | ) |
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
NXOpen::PlotBuilder::UnitsOption NXOpen::PlotBuilder::Units | ( | ) |
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
NXOpen::PlotBuilder::XdisplayOption NXOpen::PlotBuilder::XDisplay | ( | ) |
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
double NXOpen::PlotBuilder::XOffset | ( | ) |
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
NXOpen::PlotBuilder::YdisplayOption NXOpen::PlotBuilder::YDisplay | ( | ) |
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
double NXOpen::PlotBuilder::YOffset | ( | ) |
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