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

Represents a CGMBuilder to be used when exporting the Current Display or drawing sheets to a CGM. More...

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

List of all members.

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::CDFCreateCdf ()
 Creates and returns a CDF object representing the Color Palette.
NXOpen::WidthDefinitionCreateWidthDefinition ()
 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::CDFGetCdf ()
 Returns a CDF object representing the Color Palette.
std::vector< NXStringGetDatasetNames ()
 Gets the dataset names to be used when creating CGMs in a Teamcenter environment.
std::vector< NXStringGetFilenames ()
 Gets all the CGM filenames.
NXOpen::WidthDefinitionGetWidthDefinition ()
 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::PlotSourceBuilderSourceBuilder ()
 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.

Detailed Description

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.


Member Enumeration Documentation

Specifies the action option to be used when running Teamcenter.

Enumerator:
ActionOptionCreateNew 

Creates a new dataset in Teamcenter.

ActionOptionOverwriteExisting 

Overwrites an existing dataset in Teamcenter.

ActionOptionFileBrowser 

Option allows for export of CGM file to local location when running Teamcenter.

Specifies the color option to use when creating the CGM.

Enumerator:
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 image resolution when exporting a raster image.

Enumerator:
ImageResolutionOptionDraft 

Draft Resolution.

ImageResolutionOptionLow 

Low Resolution.

ImageResolutionOptionMedium 

Medium Resolution.

ImageResolutionOptionHigh 

High Resolution.

Specifies how to export multiple drawing sheets in Native mode.

Enumerator:
MultipleOptionIndividual 

Save Multiple sheets as individual CGMs.

MultipleOptionSingle 

Save Multiple sheets as one CGM.

Specifies the text option, as either text or polylines.

Enumerator:
OutputTextOptionText 

Text is kept as text.

OutputTextOptionPolylines 

Text is exported as polylines.

OutputTextOptionBestfit 

NX fonts are polylines, standard fonts are text.

Specifies the relation to use when exporting a CGM to Teamcenter.

Enumerator:
RelationOptionSpecification 

Specification.

RelationOptionManifestation 

Manifestation.

Specifies the size option of the CGM.

Enumerator:
SizeOptionFullScale 

Full Scale.

SizeOptionScaleFactor 

Scale Factor, scales the CGM based on user defined scale field.

SizeOptionDimension 

Dimension, uses the units along with X and Y dimensions to determine CGM size.

Specifies which units are associated to the dimensions.

Enumerator:
UnitsOptionMetric 

Metric units.

UnitsOptionEnglish 

English units.

Specifies the VDC coordinates to use when creating the CGM.

Enumerator:
VdcInteger 

Integer.

VdcReal 

Real.

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

Enumerator:
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.


Member Function Documentation

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 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 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:
WidthDefinition object
Created in NX6.0.0.

License requirements : None

Returns the dataset type to be used when exporting a CGM to Teamcenter
Created in NX6.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 NX6.0.0.

License requirements : None

Gets the dataset names to be used when creating CGMs in a Teamcenter environment.

There will be one dataset name for each CGM.

Returns:

Created in NX6.0.0.

License requirements : None

Gets all the CGM filenames.

This list will contain the full path for each CGM to be created.

Returns:

Created in NX6.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 NX6.0.0.

License requirements : None

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

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

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

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

Parameters:
actionaction

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

Parameters:
colorscolors
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

Parameters:
datasetNamesdatasetnames
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

Parameters:
datasetTypedatasettype
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

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

Sets the resolution of images created for export of shaded views.


Created in NX6.0.0.

License requirements : None

Parameters:
imageResolutionimageresolution

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

Parameters:
multiplemultiple
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

Parameters:
namedReferenceTypenamedreferencetype

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

Parameters:
outputTextoutputtext
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

Parameters:
rasterImagesrasterimages

Sets the relation to be used when exporting a CGM to Teamcenter
Created in NX6.0.0.



License requirements : None

Parameters:
relationrelation
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

Parameters:
scalescale
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

Parameters:
shadedGeometryshadedgeometry

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

Parameters:
sizesize

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

Parameters:
unitsunits

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

Parameters:
vdcvdc

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

Parameters:
widthswidths
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

Parameters:
xDimensionxdimension
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

Parameters:
yDimensionydimension

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

Returns the x dimension to be used when Dimension has been selected from the Size option.


Created in NX6.0.0.

License requirements : None

Returns the y dimension to be used when Dimension has been selected from the Size option.


Created in NX6.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.