DwgDxfDataSet Class
A dataset that reads CAD databases in the file formats DWG and DXF, as used by AutoCAD.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEDwgDxf assembly)
Syntax
public class DwgDxfDataSet : MultiFileDataSet,
IReadAttributes,
ISearchableRemarks
This dataset reads CAD databases in the file formats DWG and DXF, as used by AutoCAD. Files written by AutoCAD 2021 and earlier versions are supported.
The dataset reads the objects from the CAD file and splits them up into simple point, line and polygon features. A few object types are not supported, specifically spline curves and all 3D surfaces. Multi-line text objects will be split into separate text objects.
All features that are read from the dataset will have a set of attributes, indicating how they should be visualized. This includes for instance color, line width, text label and font, depending on the feature type. Line styles are only partly supported; the name of the line style will be supplied as attribute, but there is no simple way to create a line style instance to render the line. Polygon patterns are currently not supported at all.
The attributes that are common to all features are:
Attribute name | Type | Description |
|---|---|---|
COLOR | Integer | Color index. Depending of the DWG file, this may only be an indication to use the color value of the layer, so this attribute may not be useful. If that is the case, you can use the COLORRGB attribute instead. |
COLOR_RGB | String | Contains a string with RGBA color values in the form "rgba(r, g, b, a)". This can be used as an indirect value for the color property of any visualizer. |
LAYER | String | The name of the layer that the object belongs to. |
LAYER_COMP | Atom | An atom that represents the layer that the object belongs to (for fast comparison). |
LAYER_OFF | Bool | If the layer that the feature belongs to is turned off in the data file, this attribute will be set to True, otherwise it will not be set at all. This can be used to hide objects from layers that are turned off in the data file. |
LAYER_FROZEN | Bool | If the layer that the feature belongs to is frozen in the data file, this attribute will be set to True, otherwise it will not be set at all. This can be used to hide objects from frozen layers. |
Point features may have additional attributes:
Attribute name | Type | Description |
|---|---|---|
TEXT | String | A text label. |
FONT | String | A font description, in the format "family-size-bold-italic". This can be used as an indirect value for the font property of text visualizers. |
ROTATION | Double | Specifies the rotation of the text label. Value is in degrees, clock-wise from positive X axis. |
ALIGN_X | Integer | An integer value, 0, 2 or 6, corresponding to left, right or center horizontal alignment. This can be used as an indirect value for the alignX property of text visualizers. |
ALIGN_Y | Integer | An integer value, 0, 8, 24 or 99, corresponding to top, bottom, baseline or center vertical alignment. This can be used as an indirect value for the alignY property of text visualizers. |
Line features may have additional attributes:
Attribute name | Type | Description |
|---|---|---|
LINE_WEIGHT | Integer | Specifies the weight of the line, as a value between -1 and 251. -1 indicates default weight. |
LINE_STYLE | String | The name of the line style, as defined in the DWGDXF file. There is currently no way to pass the definition of the line style and use it automatically in a line visualizer, but you can define the line styles yourself and use this attribute to select the right one. |
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
DataSet
FileDataSet
MultiFileDataSet
DwgDxfDataSet
Platforms
Windows, Linux
DwgDxfDataSet Members
The DwgDxfDataSet type has the following members.
Constructors
| Name | Description |
|---|---|
| DwgDxfDataSet | Initializes a new instance of the DwgDxfDataSet class. |
Properties
| Name | Description |
|---|---|
| ArcAccuracy | Gets or sets a value controlling how accurate line arcs will be modeled with line features with straight segments. |
| IReadAttributes.Attributes | Gets a collection whose contents determine which attributes will be read the DataSet. Inherited from IReadAttributes |
| Crs | Gets or sets the coordinate reference system of the DwgDxfDataSet. Inherited from DataSet |
| Description | Gets or sets a short description of the dataset. Inherited from DataSet |
| DisplayName | Gets or sets a display name for the dataset. Inherited from DataSet |
| FileName | Gets or sets the name of the file to read from. Inherited from FileDataSet |
| ISearchable.HasSearchIndex | Gets a value that tells whether a dataset has a search index. Inherited from ISearchable |
| Id | Gets a unique identifier for this dataset instance. Inherited from DataSet |
| IndexFileName | Gets or sets an explicit index file name used for the generated index files in IndexPath. Inherited from MultiFileDataSet |
| IndexPath | Gets or sets the directory where the dataset index files are saved. Inherited from MultiFileDataSet |
| IsDisposed | Gets a value that tells whether the current DwgDxfDataSet has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path to an ISO 19139 metadata document for the dataset. Inherited from DataSet |
| Name | Gets or sets the name of the DwgDxfDataSet. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current DwgDxfDataSet represents. Inherited from EngineObject |
| Path | Gets or sets the path to the file or files to read from. Inherited from FileDataSet |
| IReadAttributes.ReadAttributes | Gets or sets a value indicating whether the DataSet reads attributes. Inherited from IReadAttributes |
| SearchableAttributes | The attributes that will be used to create a search index for the dataset. |
| SearchableCondition | Gets or sets a condition that determines which features will be included in the search index for the dataset. |
| SearchSubdirectories | Gets or sets a flag indicating if the dataset will search for data files recursively. Inherited from MultiFileDataSet |
| SuppressInitializationErrors | Gets or sets a flag indicating how errors during dataset initialization are handled. Inherited from DataSet |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| VerifyIndexFiles | Gets or sets a flag indicating if the contents of index files should be verified before use. Inherited from MultiFileDataSet |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from DataSet |
| FlushCache | Frees any information the dataset may have cached, including all cached features. Inherited from DataSet |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from DataSet |
| GetDataCoverage | Gets coverage information for this dataset in a given area. Inherited from DataSet |
 GetDataSetById | Looks up an existing dataset instance from a dataset identity. Inherited from DataSet |
| GetDataSetInfo | Returns a dataset info that describes the contents of this dataset. Inherited from DataSet |
| GetDataSetInfoAsync | Makes an asynchronous call to GetDataSetInfo. Inherited from DataSet |
| GetFeature | Gets the feature with the specified identity. Inherited from DataSet |
| GetFeatures | Overloaded. Gets features from the dataset. Inherited from DataSet |
| GetFloatValueAt | Overloaded. Gets the float raster value from a cell at the specified position. Inherited from DataSet |
| GetFloatValuesAt | Overloaded. Gets a number of float raster values. Inherited from DataSet |
| GetLocalizedDescription | Gets a localized version of the dataset description in a specific language. Inherited from DataSet |
| GetLocalizedDisplayName | Gets a localized version of the dataset display name in a specific language. Inherited from DataSet |
| GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from DataSet |
| GetNormalizedFloatValueAt | Overloaded. Gets the raster value from a cell at the specified position, normalized by Scale and Offset. Inherited from DataSet |
| GetNormalizedFloatValuesAt | Overloaded. Gets a number of raster values, normalized by Scale and Offset. Inherited from DataSet |
| GetValueAt | Overloaded. Gets the integer value from a raster cell at the specified position. Inherited from DataSet |
| GetValuesAt | Overloaded. Gets a number of raster values. Inherited from DataSet |
| HasLocalizedDescription | Checks if a localized version of the dataset description is available in a specific language. Inherited from DataSet |
| HasLocalizedDisplayName | Checks if a localized version of the dataset display name is available in a specific language. Inherited from DataSet |
| HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from DataSet |
| HighestRasterValue | Finds the highest raster value inside the given polygon. Inherited from DataSet |
| Initialize | Initializes the dataset. Inherited from DataSet |
| ISearchable.Search | Overloaded. Searches for features with an attribute whose value match the specified search text. Inherited from ISearchable |
| SetLocalizedDescription | Sets a dataset description in a specific language. Inherited from DataSet |
| SetLocalizedDisplayName | Sets a dataset display name in a specific language. Inherited from DataSet |
| SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the dataset, for a specific language. Inherited from DataSet |
| TryGetFloatValueAt | Overloaded. Gets the float value from a raster cell at the specified position. Inherited from DataSet |
| TryGetNormalizedFloatValueAt | Overloaded. Gets the float value from a raster cell at the specified position, normalized by Scale and Offset. Inherited from DataSet |
| TryGetValueAt | Overloaded. Gets the integer value from a raster cell at the specified position. Inherited from DataSet |