NX Open C++ Reference Guide
|
Represents a CGMBuilder to be used when exporting the Current Display or drawing sheets to a CGM. More...
Public Types | |
enum | ActionOption { ActionOptionCreateNew, ActionOptionOverwriteExisting, ActionOptionFileBrowser } |
Specifies the action option to be used when running Teamcenter. More... | |
enum | Color { ColorAsDisplayed, ColorPartColors, ColorCustomPalette, ColorBlackOnWhite, ColorLegacyColors, ColorColorsByWidth } |
Specifies the color option to use when creating the CGM. More... | |
enum | ImageResolutionOption { ImageResolutionOptionDraft, ImageResolutionOptionLow, ImageResolutionOptionMedium, ImageResolutionOptionHigh } |
Specifies the image resolution when exporting a raster image. More... | |
enum | MultipleOption { MultipleOptionIndividual, MultipleOptionSingle } |
Specifies how to export multiple drawing sheets in Native mode. More... | |
enum | OutputTextOption { OutputTextOptionText, OutputTextOptionPolylines, OutputTextOptionBestfit } |
Specifies the text option, as either text or polylines. More... | |
enum | RelationOption { RelationOptionSpecification, RelationOptionManifestation } |
Specifies the relation to use when exporting a CGM to Teamcenter. More... | |
enum | SizeOption { SizeOptionFullScale, SizeOptionScaleFactor, SizeOptionDimension } |
Specifies the size option of the CGM. More... | |
enum | UnitsOption { UnitsOptionMetric, UnitsOptionEnglish } |
Specifies which units are associated to the dimensions. More... | |
enum | Vdc { VdcInteger, VdcReal } |
Specifies the VDC coordinates to use when creating the CGM. More... | |
enum | Width { WidthStandardWidths, WidthSingleWidth, WidthCustomThreeWidths, WidthCustomPalette } |
Specifies the primary selection of which type of width assignment to use. More... | |
Public Member Functions | |
NXOpen::CGMBuilder::ActionOption | Action () |
Returns the action option to be used when exporting the CGM file when in Teamcenter mode. | |
NXOpen::CGMBuilder::Color | Colors () |
Returns the color option to be used when creating the CGM. | |
NXOpen::CDF * | CreateCdf () |
Creates and returns a CDF object representing the Color Palette. | |
NXOpen::WidthDefinition * | CreateWidthDefinition () |
Creates and returns a WidthDefinition object representing the Width Palette. | |
NXString | DatasetType () |
Returns the dataset type to be used when exporting a CGM to Teamcenter Created in NX6.0.0. | |
NXOpen::CDF * | GetCdf () |
Returns a CDF object representing the Color Palette. | |
std::vector< NXString > | GetDatasetNames () |
Gets the dataset names to be used when creating CGMs in a Teamcenter environment. | |
std::vector< NXString > | GetFilenames () |
Gets all the CGM filenames. | |
NXOpen::WidthDefinition * | GetWidthDefinition () |
Returns a WidthDefinition object representing the Width Palette. | |
NXOpen::CGMBuilder::ImageResolutionOption | ImageResolution () |
Returns the resolution of images created for export of shaded views. | |
NXOpen::CGMBuilder::MultipleOption | Multiple () |
Returns the multiple option is used when more than one drawing is exported. | |
NXString | NamedReferenceType () |
Returns the named reference type to be used when exporting a CGM to Teamcenter Created in NX6.0.0. | |
NXOpen::CGMBuilder::OutputTextOption | OutputText () |
Returns the output text of the CGM. | |
bool | RasterImages () |
Returns the Raster Images option. | |
NXOpen::CGMBuilder::RelationOption | Relation () |
Returns the relation to be used when exporting a CGM to Teamcenter Created in NX6.0.0. | |
double | Scale () |
Returns the scale factor to be used when creating a CGM. | |
void | SetAction (NXOpen::CGMBuilder::ActionOption action) |
Sets the action option to be used when exporting the CGM file when in Teamcenter mode. | |
void | SetColors (NXOpen::CGMBuilder::Color colors) |
Sets the color option to be used when creating the CGM. | |
void | SetDatasetNames (std::vector< NXString > &datasetNames) |
Sets all the dataset names to be used when creating CGMs in a Teamcenter environment. | |
void | SetDatasetType (const NXString &datasetType) |
Sets the dataset type to be used when exporting a CGM to Teamcenter Created in NX6.0.0. | |
void | SetFilenames (std::vector< NXString > &filenames) |
Sets all the CGM filenames. | |
void | SetImageResolution (NXOpen::CGMBuilder::ImageResolutionOption imageResolution) |
Sets the resolution of images created for export of shaded views. | |
void | SetMultiple (NXOpen::CGMBuilder::MultipleOption multiple) |
Sets the multiple option is used when more than one drawing is exported. | |
void | SetNamedReferenceType (const NXString &namedReferenceType) |
Sets the named reference type to be used when exporting a CGM to Teamcenter Created in NX6.0.0. | |
void | SetOutputText (NXOpen::CGMBuilder::OutputTextOption outputText) |
Sets the output text of the CGM. | |
void | SetRasterImages (bool rasterImages) |
Sets the Raster Images option. | |
void | SetRelation (NXOpen::CGMBuilder::RelationOption relation) |
Sets the relation to be used when exporting a CGM to Teamcenter Created in NX6.0.0. | |
void | SetScale (double scale) |
Sets the scale factor to be used when creating a CGM. | |
void | SetShadedGeometry (bool shadedGeometry) |
Sets the Shaded Geometry as Wireframe option. | |
void | SetSize (NXOpen::CGMBuilder::SizeOption size) |
Sets the size of the CGM. | |
void | SetUnits (NXOpen::CGMBuilder::UnitsOption units) |
Sets the units of the X and Y dimensions to be used when Dimension has been selected from the Size option. | |
void | SetVdcCoordinates (NXOpen::CGMBuilder::Vdc vdc) |
Sets the Virtual Display Coordinates. | |
void | SetWidths (NXOpen::CGMBuilder::Width widths) |
Sets the width option. | |
void | SetXDimension (double xDimension) |
Sets the x dimension to be used when Dimension has been selected from the Size option. | |
void | SetYDimension (double yDimension) |
Sets the y dimension to be used when Dimension has been selected from the Size option. | |
bool | ShadedGeometry () |
Returns the Shaded Geometry as Wireframe option. | |
NXOpen::CGMBuilder::SizeOption | Size () |
Returns the size of the CGM. | |
NXOpen::PlotSourceBuilder * | SourceBuilder () |
Returns the Source builder. | |
NXOpen::CGMBuilder::UnitsOption | Units () |
Returns the units of the X and Y dimensions to be used when Dimension has been selected from the Size option. | |
NXOpen::CGMBuilder::Vdc | VdcCoordinates () |
Returns the Virtual Display Coordinates. | |
NXOpen::CGMBuilder::Width | Widths () |
Returns the width option. | |
double | XDimension () |
Returns the x dimension to be used when Dimension has been selected from the Size option. | |
double | YDimension () |
Returns the y dimension to be used when Dimension has been selected from the Size option. |
Represents a CGMBuilder to be used when exporting the Current Display or drawing sheets to a CGM.
This class is created using PlotManager .
The user must specify the sheets to be exported by setting the appropriate fields through the PlotSourceBuilder .
If running in native mode, use the Filenames field to specify the full path location of the CGM(s).
If running Teamcenter, there are several options: 1. Exporting a single CGM. More than one sheet can be exported to one CGM if the Multiple option is set to Single. The Dataset Name field must be filled with one dataset name. 2. Exporting multiple CGMs. This requires the Dataset Names field to be filled with the same number of dataset names as sheets selected for export. The Multiple option needs to be set to Individual for this functionality. 3. Overwriting an existing CGM. This requires the Dataset Name field to be filled with the dataset name that is to be overwritten. 4. Export CGM(s) locally. This is possible by setting the Action option to File Browser. If exporting locally then the Filenames field must be set with full path filenames. All options when exporting to Teamcenter require the Dataset Type and Named Reference Type fields to be set.
To create a new instance of this class, use PlotManager::CreateCgmBuilder
Default values.
Property | Value |
---|---|
Action |
CreateNew |
Colors |
AsDisplayed |
ImageResolution |
Draft |
Multiple |
Individual |
OutputText |
Text |
RasterImages |
0 |
Scale |
1 |
ShadedGeometry |
0 |
Size |
FullScale |
Units |
Metric |
VdcCoordinates |
Real |
Widths |
StandardWidths |
XDimension |
0 |
YDimension |
0 |
Created in NX6.0.0.
Specifies the action option to be used when running Teamcenter.
Specifies the color option to use when creating the CGM.
ColorAsDisplayed |
As Displayed. |
ColorPartColors |
Part Colors. |
ColorCustomPalette |
Custom Palette, uses custom colors defined in CDF. |
ColorBlackOnWhite |
Black on White. |
ColorLegacyColors |
Translates current colors to 15 legacy colors. |
ColorColorsByWidth |
Colors by Width, uses custom colors defined in CDF. |
Specifies the primary selection of which type of width assignment to use.
WidthStandardWidths |
Standard Widths. |
WidthSingleWidth |
Single Width, uses custom widths defined in WidthDefinition. |
WidthCustomThreeWidths |
Custom Three Widths, uses custom widths defined in WidthDefinition. |
WidthCustomPalette |
Custom palette, uses custom widths defined in WidthDefinition. |
Returns the action option to be used when exporting the CGM file when in Teamcenter mode.
File Browser allows for the CGM to be saved locally. Overwrite allows for the newly created CGM to overwrite a given existing CGM dataset in Teamcenter. Create New allows for the CGM(s) to be created and imported as new datasets. If File Browser is selected, the Filenames field must be filled with full path filenames, other wise the Dataset Names field must be filled.
Created in NX6.0.0.
License requirements : None
Returns the color option to be used when creating the CGM.
If the color option is set to Custom Palette or Colors By Width then the CGM will be created with the user defined color attributes belonging to the CDF object.
Created in NX6.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 the dataset type to be used when exporting a CGM to Teamcenter
Created in NX6.0.0.
License requirements : None
std::vector<NXString> NXOpen::CGMBuilder::GetDatasetNames | ( | ) |
Gets the dataset names to be used when creating CGMs in a Teamcenter environment.
There will be one dataset name for each CGM.
std::vector<NXString> NXOpen::CGMBuilder::GetFilenames | ( | ) |
Gets all the CGM filenames.
This list will contain the full path for each CGM to be created.
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 the resolution of images created for export of shaded views.
Created in NX6.0.0.
License requirements : None
Returns the multiple option is used when more than one drawing is exported.
If it is set to individual, then each drawing will be saved as an individual CGM. In this case, the number of filenames must equal the number of sheets selected. If it is set to single, then all drawings will be appended to one CGM file. In this case, only one filename is needed.
Created in NX6.0.0.
License requirements : None
Returns the named reference type to be used when exporting a CGM to Teamcenter
Created in NX6.0.0.
License requirements : None
Returns the output text of the CGM.
This will determine whether the drawing text will be exported as text or as polylines.
Created in NX6.0.0.
License requirements : None
bool NXOpen::CGMBuilder::RasterImages | ( | ) |
Returns the Raster Images option.
This option determines whether or not raster images will be exported to the CGM.
Created in NX6.0.0.
License requirements : None
Returns the relation to be used when exporting a CGM to Teamcenter
Created in NX6.0.0.
License requirements : None
double NXOpen::CGMBuilder::Scale | ( | ) |
Returns the scale factor to be used when creating a CGM.
This value ranges from 0.00 to 1.00 and will only be used if the Size option is set to Scale.
Created in NX6.0.0.
License requirements : None
void NXOpen::CGMBuilder::SetAction | ( | NXOpen::CGMBuilder::ActionOption | action | ) |
Sets the action option to be used when exporting the CGM file when in Teamcenter mode.
File Browser allows for the CGM to be saved locally. Overwrite allows for the newly created CGM to overwrite a given existing CGM dataset in Teamcenter. Create New allows for the CGM(s) to be created and imported as new datasets. If File Browser is selected, the Filenames field must be filled with full path filenames, other wise the Dataset Names field must be filled.
Created in NX6.0.0.
License requirements : None
action | action |
void NXOpen::CGMBuilder::SetColors | ( | NXOpen::CGMBuilder::Color | colors | ) |
Sets the color option to be used when creating the CGM.
If the color option is set to Custom Palette or Colors By Width then the CGM will be created with the user defined color attributes belonging to the CDF object.
Created in NX6.0.0.
License requirements : None
colors | colors |
void NXOpen::CGMBuilder::SetDatasetNames | ( | std::vector< NXString > & | datasetNames | ) |
Sets all the dataset names to be used when creating CGMs in a Teamcenter environment.
The exact contents of this list will be used as the dataset names, one for each CGM.
Created in NX6.0.0.
License requirements : None
datasetNames | datasetnames |
void NXOpen::CGMBuilder::SetDatasetType | ( | const NXString & | datasetType | ) |
Sets the dataset type to be used when exporting a CGM to Teamcenter
Created in NX6.0.0.
License requirements : None
datasetType | datasettype |
void NXOpen::CGMBuilder::SetFilenames | ( | std::vector< NXString > & | filenames | ) |
Sets all the CGM filenames.
This list will contain the full path for each CGM to be created. If the Multiple option is set to Single, then only one filename is needed. If the Multiple option is set to Individual, then the number of filenames must equal the number of sheets selected for export.
Created in NX6.0.0.
License requirements : None
filenames | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::CGMBuilder::SetImageResolution | ( | NXOpen::CGMBuilder::ImageResolutionOption | imageResolution | ) |
Sets the resolution of images created for export of shaded views.
Created in NX6.0.0.
License requirements : None
imageResolution | imageresolution |
void NXOpen::CGMBuilder::SetMultiple | ( | NXOpen::CGMBuilder::MultipleOption | multiple | ) |
Sets the multiple option is used when more than one drawing is exported.
If it is set to individual, then each drawing will be saved as an individual CGM. In this case, the number of filenames must equal the number of sheets selected. If it is set to single, then all drawings will be appended to one CGM file. In this case, only one filename is needed.
Created in NX6.0.0.
License requirements : None
multiple | multiple |
void NXOpen::CGMBuilder::SetNamedReferenceType | ( | const NXString & | namedReferenceType | ) |
Sets the named reference type to be used when exporting a CGM to Teamcenter
Created in NX6.0.0.
License requirements : None
namedReferenceType | namedreferencetype |
void NXOpen::CGMBuilder::SetOutputText | ( | NXOpen::CGMBuilder::OutputTextOption | outputText | ) |
Sets the output text of the CGM.
This will determine whether the drawing text will be exported as text or as polylines.
Created in NX6.0.0.
License requirements : None
outputText | outputtext |
void NXOpen::CGMBuilder::SetRasterImages | ( | bool | rasterImages | ) |
Sets the Raster Images option.
This option determines whether or not raster images will be exported to the CGM.
Created in NX6.0.0.
License requirements : None
rasterImages | rasterimages |
void NXOpen::CGMBuilder::SetRelation | ( | NXOpen::CGMBuilder::RelationOption | relation | ) |
Sets the relation to be used when exporting a CGM to Teamcenter
Created in NX6.0.0.
License requirements : None
relation | relation |
void NXOpen::CGMBuilder::SetScale | ( | double | scale | ) |
Sets the scale factor to be used when creating a CGM.
This value ranges from 0.00 to 1.00 and will only be used if the Size option is set to Scale.
Created in NX6.0.0.
License requirements : None
scale | scale |
void NXOpen::CGMBuilder::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 NX6.0.0.
License requirements : None
shadedGeometry | shadedgeometry |
Sets the size of the CGM.
If the size is set to Scale, then the CGM will use the user-defined Scale Factor. If the size is set to dimension, then the CGM will use the user-defined X and Y dimensions.
Created in NX6.0.0.
License requirements : None
size | size |
void NXOpen::CGMBuilder::SetUnits | ( | NXOpen::CGMBuilder::UnitsOption | units | ) |
Sets the units of the X and Y dimensions to be used when Dimension has been selected from the Size option.
Created in NX6.0.0.
License requirements : None
units | units |
Sets the Virtual Display Coordinates.
This option determines whether the CGM will be created with real or integer vdc coordinates.
Created in NX6.0.0.
License requirements : None
vdc | vdc |
void NXOpen::CGMBuilder::SetWidths | ( | NXOpen::CGMBuilder::Width | widths | ) |
Sets the width option.
If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the CGM will be created with the user defined width attributes belonging to the WidthDefinition object.
Created in NX6.0.0.
License requirements : None
widths | widths |
void NXOpen::CGMBuilder::SetXDimension | ( | double | xDimension | ) |
Sets the x dimension to be used when Dimension has been selected from the Size option.
Created in NX6.0.0.
License requirements : None
xDimension | xdimension |
void NXOpen::CGMBuilder::SetYDimension | ( | double | yDimension | ) |
Sets the y dimension to be used when Dimension has been selected from the Size option.
Created in NX6.0.0.
License requirements : None
yDimension | ydimension |
bool NXOpen::CGMBuilder::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 NX6.0.0.
License requirements : None
Returns the size of the CGM.
If the size is set to Scale, then the CGM will use the user-defined Scale Factor. If the size is set to dimension, then the CGM will use the user-defined X and Y dimensions.
Created in NX6.0.0.
License requirements : None
Returns the Source builder.
The Source builder contains all data involving the selected sheets.
Created in NX6.0.0.
License requirements : None
Returns the units of the X and Y dimensions to be used when Dimension has been selected from the Size option.
Created in NX6.0.0.
License requirements : None
Returns the Virtual Display Coordinates.
This option determines whether the CGM will be created with real or integer vdc coordinates.
Created in NX6.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 CGM will be created with the user defined width attributes belonging to the WidthDefinition object.
Created in NX6.0.0.
License requirements : None
double NXOpen::CGMBuilder::XDimension | ( | ) |
Returns the x dimension to be used when Dimension has been selected from the Size option.
Created in NX6.0.0.
License requirements : None
double NXOpen::CGMBuilder::YDimension | ( | ) |
Returns the y dimension to be used when Dimension has been selected from the Size option.
Created in NX6.0.0.
License requirements : None