NXOpen .NET Reference Guide
|
Represents a NXOpen.CGMBuilder to be used when exporting the Current Display or drawing sheets to a CGM. More...
Public Types | |
enum | ActionOption { CreateNew, OverwriteExisting, FileBrowser } |
Specifies the action option to be used when running Teamcenter More... | |
enum | Color { AsDisplayed, PartColors, CustomPalette, BlackOnWhite, LegacyColors, ColorsByWidth } |
Specifies the color option to use when creating the CGM More... | |
enum | ImageResolutionOption { Draft, Low, Medium, High } |
Specifies the image resolution when exporting a raster image More... | |
enum | MultipleOption { Individual, Single } |
Specifies how to export multiple drawing sheets in Native mode More... | |
enum | OutputTextOption { Text, Polylines, Bestfit } |
Specifies the text option, as either text or polylines More... | |
enum | RelationOption { Specification, Manifestation } |
Specifies the relation to use when exporting a CGM to Teamcenter More... | |
enum | SizeOption { FullScale, ScaleFactor, Dimension } |
Specifies the size option of the CGM. More... | |
enum | UnitsOption { Metric, English } |
Specifies which units are associated to the dimensions More... | |
enum | Vdc { Integer, Real } |
Specifies the VDC coordinates to use when creating the CGM More... | |
enum | Width { StandardWidths, SingleWidth, CustomThreeWidths, CustomPalette } |
Specifies the primary selection of which type of width assignment to use. More... | |
Public Member Functions | |
unsafe NXOpen.CDF | CreateCdf () |
Creates and returns a NXOpen.CDF object representing the Color Palette. More... | |
unsafe NXOpen.WidthDefinition | CreateWidthDefinition () |
Creates and returns a NXOpen.WidthDefinition object representing the Width Palette. More... | |
unsafe NXOpen.CDF | GetCdf () |
Returns a NXOpen.CDF object representing the Color Palette. More... | |
unsafe string[] | GetDatasetNames () |
Gets the dataset names to be used when creating CGMs in a Teamcenter environment. More... | |
unsafe string[] | GetFilenames () |
Gets all the CGM filenames. More... | |
unsafe NXOpen.WidthDefinition | GetWidthDefinition () |
Returns a NXOpen.WidthDefinition object representing the Width Palette. More... | |
unsafe void | SetDatasetNames (string[] datasetNames) |
Sets all the dataset names to be used when creating CGMs in a Teamcenter environment. More... | |
unsafe void | SetFilenames (string[] filenames) |
Sets all the CGM filenames. More... | |
Public Member Functions inherited from NXOpen.Builder | |
unsafe NXOpen.NXObject | Commit () |
Commits any edits that have been applied to the builder. More... | |
unsafe void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
unsafe NXOpen.NXObject[] | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
unsafe NXOpen.NXObject | GetObject () |
Returns the object currently being edited by this builder. More... | |
unsafe void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
unsafe bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen.TaggedObject | |
void | PrintTestData (String variableName) |
<exclude> More... | |
void | PrintTestData (String variableName, int lineNumber) |
<exclude> More... | |
override string | ToString () |
Returns a String that represents the current Object. More... | |
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageCtrl | AsyncProcessMessage (IMessage msg, IMessageSink replySink) |
Asynchronously processes the given message. More... | |
IMessage | SyncProcessMessage (IMessage msg) |
Synchronously processes the given message. More... | |
Properties | |
unsafe NXOpen.CGMBuilder.ActionOption | Action [get, set] |
Returns or sets the action option to be used when exporting the CGM file when in Teamcenter mode. More... | |
unsafe NXOpen.CGMBuilder.Color | Colors [get, set] |
Returns or sets the color option to be used when creating the CGM. More... | |
unsafe bool | CustomSymbolsInForeground [get, set] |
Returns or sets the plotting custom symbols in the foreground option. More... | |
unsafe string | DatasetType [get, set] |
Returns or sets the dataset type to be used when exporting a CGM to Teamcenter More... | |
unsafe NXOpen.CGMBuilder.ImageResolutionOption | ImageResolution [get, set] |
Returns or sets the resolution of images created for export of shaded views. More... | |
unsafe NXOpen.CGMBuilder.MultipleOption | Multiple [get, set] |
Returns or sets the multiple option is used when more than one drawing is exported. More... | |
unsafe string | NamedReferenceType [get, set] |
Returns or sets the named reference type to be used when exporting a CGM to Teamcenter More... | |
unsafe NXOpen.CGMBuilder.OutputTextOption | OutputText [get, set] |
Returns or sets the output text of the CGM. More... | |
unsafe bool | RasterImages [get, set] |
Returns or sets the Raster Images option. More... | |
unsafe NXOpen.CGMBuilder.RelationOption | Relation [get, set] |
Returns or sets the relation to be used when exporting a CGM to Teamcenter More... | |
unsafe double | Scale [get, set] |
Returns or sets the scale factor to be used when creating a CGM. More... | |
unsafe bool | ShadedGeometry [get, set] |
Returns or sets the Shaded Geometry as Wireframe option. More... | |
unsafe NXOpen.CGMBuilder.SizeOption | Size [get, set] |
Returns or sets the size of the CGM. More... | |
unsafe NXOpen.PlotSourceBuilder | SourceBuilder [get] |
Returns the Source builder. More... | |
unsafe NXOpen.CGMBuilder.UnitsOption | Units [get, set] |
Returns or sets the units of the X and Y dimensions to be used when Dimension has been selected from the Size option. More... | |
unsafe NXOpen.CGMBuilder.Vdc | VdcCoordinates [get, set] |
Returns or sets the Virtual Display Coordinates. More... | |
unsafe NXOpen.CGMBuilder.Width | Widths [get, set] |
Returns or sets the width option. More... | |
unsafe double | XDimension [get, set] |
Returns or sets the x dimension to be used when Dimension has been selected from the Size option. More... | |
unsafe double | YDimension [get, set] |
Returns or sets the y dimension to be used when Dimension has been selected from the Size option. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from NXOpen.TaggedObject | |
new void | initialize () |
<exclude> More... | |
Represents a NXOpen.CGMBuilder to be used when exporting the Current Display or drawing sheets to a CGM.
This class is created using NXOpen.PlotManager .
All sheets provided must be in the displayed part.
The user must specify the sheets to be exported by setting the appropriate fields through the NXOpen.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 NXOpen.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 color option to use when creating the CGM
Specifies the primary selection of which type of width assignment to use.
|
inline |
Creates and returns a NXOpen.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.
Created in NX6.0.0
License requirements: None.
|
inline |
Creates and returns a NXOpen.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.
Created in NX6.0.0
License requirements: None.
|
inline |
Returns a NXOpen.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.
Created in NX6.0.0
License requirements: None.
|
inline |
Gets the dataset names to be used when creating CGMs in a Teamcenter environment.
There will be one dataset name for each CGM.
Created in NX6.0.0
License requirements: None.
|
inline |
Gets all the CGM filenames.
This list will contain the full path for each CGM to be created.
Created in NX6.0.0
License requirements: None.
|
inline |
Returns a NXOpen.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.
Created in NX6.0.0
License requirements: None.
|
inline |
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 |
|
inline |
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 |
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the dataset type to be used when exporting a CGM to Teamcenter
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the resolution of images created for export of shaded views.
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the named reference type to be used when exporting a CGM to Teamcenter
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the relation to be used when exporting a CGM to Teamcenter
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
get |
Returns the Source builder.
The Source builder contains all data involving the selected sheets.
Created in NX6.0.0
License requirements: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or 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 to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the x dimension to be used when Dimension has been selected from the Size option.
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the y dimension to be used when Dimension has been selected from the Size option.
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: None.