RealDWG-Web

AutoCAD RealDWG is a software development toolkit (SDK) provided by Autodesk that allows developers to read, write, and create DWG and DXF files (AutoCAD's native drawing file formats) without needing AutoCAD installed.

The target of this project is to create one web-version of AutoCAD RealDWG by providing the similar API. For now, it supports reading DWG and DXF file only. In the future, it will support write DWG and DXF too.

• 🌐 DWG/DXF JSON Viewer
• 🌐 API Docs

Converter Registration Mechanism

To support reading both DXF and DWG files (and potentially other formats in the future), this project provides a flexible mechanism for registering and unregistering file converters. This is managed by the AcDbDatabaseConverterManager class.

How It Works

• Each file type (e.g., DXF, DWG) is associated with a converter class that knows how to parse and import that file format into the drawing database.
• The AcDbDatabaseConverterManager maintains a registry of these converters, allowing you to register or unregister converters for specific file types at runtime.
• By default, the DXF converter is registered. You can add your own DWG converter or replace existing ones as needed.

Registering a Converter

To register a converter for a file type:

import { AcDbDatabaseConverterManager, AcDbFileType } from '@mlightcad/data-model';
import { AcDbLibreDwgConverter } from '@mlightcad/libredwg-converter';

const converter = new AcDbLibreDwgConverter({
  convertByEntityType: false,
  useWorker: true,
  parserWorkerUrl: './assets/libredwg-parser-worker.js'
})
AcDbDatabaseConverterManager.instance.register(
  AcDbFileType.DWG,
  converter
)
Copy

Unregistering a Converter

To unregister a converter for a file type:

import { AcDbDatabaseConverterManager, AcDbFileType } from '@mlightcad/data-model';

// Unregister the DWG converter
AcDbDatabaseConverterManager.instance.unregister(AcDbFileType.DWG);
Copy

Getting a Converter

To get the converter for a specific file type:

const converter = AcDbDatabaseConverterManager.instance.get(AcDbFileType.DXF);
Copy

Read DWG/DXF File

Once a File object is selected via an HTML file input control, you can read and parse the DWG/DXF file using the following code.

const buffer = await file.arrayBuffer();
const fileExtension = file.name.split('.').pop()?.toLocaleLowerCase();
const database = new AcDbDatabase();
// The following step is very important. The working database must be set before parsing DWG/DXF file
acdbHostApplicationServices().workingDatabase = database;
const options: AcDbOpenDatabaseOptions = {
  minimumChunkSize: 1000,
  readOnly: true
};
await database.read(
  buffer,
  options,
  fileExtension == 'dwg' ? AcDbFileType.DWG : AcDbFileType.DXF
);
Copy

For a complete example, see the example project.

Extensibility

This mechanism allows you to:

• Add support for new file types by implementing and registering new converters.
• Replace or remove converters at runtime as needed.
• Listen for registration/unregistration events if you need to react to changes in available converters.

This design ensures the system is open for extension and can easily adapt to new requirements or file formats in the future.

Architecture

AutoCAD holds an absolute dominant position in the 2D CAD field. A large number of vertical applications and third-party plugins have been developed based on AutoCAD ObjectARX, and there are many software engineers familiar with AutoCAD ObjectARX. Therefore, this project mimics the architecture of AutoCAD ObjectARX and adopts similar API interfaces to AutoCAD ObjectARX.

libdxfrw-converter (DWG file support)

This module provides a DWG file converter for the RealDWG-Web ecosystem, enabling reading and conversion of DWG files into the drawing database. It is powered by the libdxfrw library compiled to WebAssembly and is designed to be registered with the converter manager for DWG file support.

libredwg-converter (DWG file support)

This module provides a DWG file converter for the RealDWG-Web ecosystem, enabling reading and conversion of DWG files into the drawing database. It is powered by the LibreDWG library compiled to WebAssembly and is designed to be registered with the converter manager for DWG file support.

geometry-engine (AcGe classes in AutoCAD ObjectARX)

This module provides geometric entities, operations, and transformations. It consists of two kinds of classes.

• Math: focuses on mathematical operations that underpin geometric calculations. This includes concepts such as vectors, matrices, transformations, and other linear algebra operations that are essential for performing geometric calculations in AutoCAD. To simplify implementation of math classes, most of math classes are 'stolen' from THREE.js by modifying their class name.
• Geometry: focuses on more complex geometric entities and their operations. This includes lines, curves, surfaces, and intersections, among others. These classes define how geometric objects behave and how they interact in 2D or 3D space.

The key classes in this module are as follows.

• AcGePoint3d, AcGePoint2d: Represent 3D and 2D points.
• AcGeVector3d, AcGeVector2d: Represent 3D and 2D vectors.
• AcGeMatrix3d: AcGeMatrix2d: transformations in 3D space.
• AcGeLine3d, AcGeLine2d: Represent lines in 3D and 2D.
• AcGeCurve3d, AcGeCurve2d: Abstract base class for curves in 3D and 2D.
• ...

data-model (AcDb classes in AutoCAD ObjectARX)

The same drawing database structure is used in this project so that it is easier for AutoCAD ObjectARX developers to develop their own application based on SDK of this project. Please refer to AutoCAD Database Overview to get more information on AutoCAD drawing database structure.

This module contains the core classes for interacting with AutoCAD's database and entities (e.g., lines, circles, blocks, etc.).

• Defining and manipulating AutoCAD entities.
• Handling entity attributes and geometric data.
• Storing and retrieving data from the drawing database.

The key classes in this module are as follows.

• AcDbObject: Base class for database-resident objects.
• AcDbEntity: The base class for all objects that can be drawn in AutoCAD (e.g., lines, circles).
• AcDbBlockReference: Represents a reference to a block.
• AcDbPolyline: Represents a polyline entity.
• ...

Please refer to AcDb classes in AutoCAD ObjectARX Reference Guide to get more details on those classes.

graphic-interface (AcGi classes in AutoCAD ObjectARX)

The differnt API interfaces from AutoCAD ObjectARX are used in this module because of the following reasons.

• It isn't friendly to implement API interfaces defined in AcGi classes in AutoCAD ObjectARX.
• Classes in AcGi module aren't used very frequently by AutoCAD ObjectARX developers.

This module provides the graphics interface to control how AutoCAD entities are displayed on the screen.

• Rendering entities to drawble objects.
• Customizing how objects are displayed, including handling colors, layers, and visibility.

The key classes in this module are as follows.

• AcGiEntity: Base class for drawable objects.
• AcGiRenderer: Interface used to render entities to drawble objects.
• ...