Создание плагинов для AutoCAD с помощью .NET API (часть 3 – работа со слоями)

Лично я никогда не работал с большими чертежами и никогда этим свойством не пользовался.

На эти переключатели действительно стоит обратить внимание: при написании плагина не всегда всё получается с первого раза, и порой приходится применять «ручное управление».

На самом деле список запрещенных к удалению слоев несколько длиннее:

К сожалению, автору данного поста не приходилось сталкиваться ни с Defpoints, ни с Xref-dependent layers, поэтому проработку этих элементарных вопросов оставим читателям в качестве несложного домашнего задания. ^__^

using System;
using Autodesk.AutoCAD.Runtime;
using Autodesk.Windows;
 
namespace MyAutoCADDll
{
    public class Commands : IExtensionApplication
    {
        // эта функция будет вызываться при выполнении в AutoCAD команды "TestCommand"
        [CommandMethod("TestCommand")]
        public void MyCommand()
        {
 
        }
 
        // Функции Initialize() и Terminate() необходимы, чтобы реализовать интерфейс IExtensionApplication
        public void Initialize()
        {
 
        }
 
        public void Terminate()
        {
 
        }
    }
}

using System;
using System.IO;
using Autodesk.AutoCAD.Runtime;
using Autodesk.AutoCAD.ApplicationServices;
using Autodesk.AutoCAD.DatabaseServices;
 
namespace HabrPlug_Layers
{
    public class Commands : IExtensionApplication
    {
        // эта функция будет вызываться при выполнении в AutoCAD команды "TestCommand"
        [CommandMethod("TestCommand")]
        public void MyCommand()
        {
            // получаем текущий документ и его БД
            Document acDoc = Autodesk.AutoCAD.ApplicationServices.Application.DocumentManager.MdiActiveDocument;
            Database acCurDb = acDoc.Database;
 
            // блокируем документ
            using (DocumentLock docloc = acDoc.LockDocument())
            {
                // начинаем транзакцию
                using (Transaction tr = acCurDb.TransactionManager.StartTransaction())
                {
                    // открываем таблицу слоев документа
                    LayerTable acLyrTbl = tr.GetObject(acCurDb.LayerTableId, OpenMode.ForWrite) as LayerTable;
 
                    // создаем новый слой и задаем ему имя
                    LayerTableRecord acLyrTblRec = new LayerTableRecord();
                    acLyrTblRec.Name = "HabrLayer";
 
                    // заносим созданный слой в таблицу слоев
                    acLyrTbl.Add(acLyrTblRec);
 
                    // добавляем созданный слой в документ
                    tr.AddNewlyCreatedDBObject(acLyrTblRec, true);
 
                    // фиксируем транзакцию
                    tr.Commit();
                }
            }
        }
 
        // Функции Initialize() и Terminate() необходимы, чтобы реализовать интерфейс IExtensionApplication
        public void Initialize()
        {
 
        }
 
        public void Terminate()
        {
 
        }
    }
}

using (DocumentLock docloc = acDoc.LockDocument())

Документация Autocad говорит, что запросы на изменение объектов или на доступ к AutoCAD могут выполняться в любом контексте и от любого количества приложений. Чтобы предотвратить конфликты с другими запросами, программист должен сам обеспечить блокировку документа перед его изменением. Невыполнение этого требования в некоторых случаях приводит к возникновению ошибки при изменении базы данных документа.

После выполнения всех необходимых изменений в базе данных её следует разблокировать, используя метод Dispose() объекта DocumentLock. Также можно использовать блок using с объявлением в нём объекта DocumentLock — в этом случае при выходе из блока база данных разблокируется автоматически. (источник, зеркало)

using (Transaction tr = acCurDb.TransactionManager.StartTransaction())
…
tr.GetObject(acCurDb.LayerTableId, OpenMode.ForWrite) as LayerTable;
…
tr.AddNewlyCreatedDBObject(acLyrTblRec, true);
…
tr.Commit();

В документации (зеркало) указано, что при работе с объектами, такими как отрезки, окружности и полилинии, или с таблицей идентификаторов и ее записями необходимо открывать объект для чтения или записи.

Попытки игнорировать это требование ни к чему хорошему не приведут — могут возникнуть весьма неприятные (в том числе с точки зрения отладки) ошибки.

Можно выделить несколько основных этапов работы с транзакцией:

1. начало новой транзакции;
2. открытие объекта на чтение или запись;
3. если объект создается впервые (его еще нет в документе) — добавление его в базу данных документа;
4. фиксация транзакции;
5. завершение транзакции.

Все эти пункты подробно рассмотрены в документации по ссылкам выше.

Как и в случае с DocumentLock, необходимо или вызывать метод Dispose() после окончания работы с транзакцией, или использовать конструкцию using.

acCurDb .Clayer = acLyrTbl["HabrLayer"];

Достаточно вставить эту строку в предыдущий пример, прямо перед фиксацией транзакции.

using System;
using System.IO;
using Autodesk.AutoCAD.Runtime;
using Autodesk.AutoCAD.ApplicationServices;
using Autodesk.AutoCAD.DatabaseServices;
 
namespace HabrPlug_Layers
{
    public class Commands : IExtensionApplication
    {
        // эта функция будет вызываться при выполнении в AutoCAD команды "TestCommand"
        [CommandMethod("TestCommand")]
        public void MyCommand()
        {
            // получаем текущий документ и его БД
            Document acDoc = Autodesk.AutoCAD.ApplicationServices.Application.DocumentManager.MdiActiveDocument;
            Database acCurDb = acDoc.Database;
 
            // блокируем документ
            using (DocumentLock docloc = acDoc.LockDocument())
            {
                // начинаем транзакцию
                using (Transaction tr = acCurDb.TransactionManager.StartTransaction())
                {
                    // открываем таблицу слоев документа
                    LayerTable acLyrTbl = tr.GetObject(acCurDb.LayerTableId, OpenMode.ForWrite) as LayerTable;
 
                    // создаем новый слой и задаем ему имя
                    LayerTableRecord acLyrTblRec = new LayerTableRecord();
                    acLyrTblRec.Name = "HabrLayer";
 
                    // заносим созданный слой в таблицу слоев
                    acLyrTbl.Add(acLyrTblRec);
 
                    // добавляем созданный слой в документ
                    tr.AddNewlyCreatedDBObject(acLyrTblRec, true);
 
                    // фиксируем транзакцию
                    tr.Commit();
                }
            }
        }
 
        // эта функция будет вызываться при выполнении в AutoCAD команды "NewCommand"
        [CommandMethod("NewCommand")]
        public void NewCommand()
        {
            // получаем текущий документ и его БД
            Document acDoc = Autodesk.AutoCAD.ApplicationServices.Application.DocumentManager.MdiActiveDocument;
            Database acCurDb = acDoc.Database;
 
            // блокируем документ
            using (DocumentLock docloc = acDoc.LockDocument())
            {
                // начинаем транзакцию
                using (Transaction tr = acCurDb.TransactionManager.StartTransaction())
                {
                    // открываем таблицу слоев документа
                    LayerTable acLyrTbl = tr.GetObject(acCurDb.LayerTableId, OpenMode.ForWrite) as LayerTable;
 
                    // если в таблице слоев нет нашего слоя - прекращаем выполнение команды
                    if (acLyrTbl.Has("HabrLayer") == false)
                    {
                        return;
                    }
 
                    // получаем запись слоя для изменения
                    LayerTableRecord acLyrTblRec = tr.GetObject(acLyrTbl["HabrLayer"], OpenMode.ForWrite) as LayerTableRecord;
 
                    // скрываем и блокируем слой
                    acLyrTblRec.Name = "test";
                    acLyrTblRec.IsOff = true;
                    acLyrTblRec.IsLocked = true;
 
                    // фиксируем транзакцию
                    tr.Commit();
                }
            }
        }
 
        // Функции Initialize() и Terminate() необходимы, чтобы реализовать интерфейс IExtensionApplication
        public void Initialize()
        {
 
        }
 
        public void Terminate()
        {
 
        }
    }
}

using System;
using System.IO;
using Autodesk.AutoCAD.Runtime;
using Autodesk.AutoCAD.ApplicationServices;
using Autodesk.AutoCAD.DatabaseServices;
 
namespace HabrPlug_Layers
{
    public class Commands : IExtensionApplication
    {
        // эта функция будет вызываться при выполнении в AutoCAD команды "TestCommand"
        [CommandMethod("TestCommand")]
        public void MyCommand()
        {
            // получаем текущий документ и его БД
            Document acDoc = Autodesk.AutoCAD.ApplicationServices.Application.DocumentManager.MdiActiveDocument;
            Database acCurDb = acDoc.Database;
 
            // блокируем документ
            using (DocumentLock docloc = acDoc.LockDocument())
            {
                // начинаем транзакцию
                using (Transaction tr = acCurDb.TransactionManager.StartTransaction())
                {
                    // открываем таблицу слоев документа
                    LayerTable acLyrTbl = tr.GetObject(acCurDb.LayerTableId, OpenMode.ForWrite) as LayerTable;
 
                    // создаем новый слой и задаем ему имя
                    LayerTableRecord acLyrTblRec = new LayerTableRecord();
                    acLyrTblRec.Name = "HabrLayer";
 
                    // заносим созданный слой в таблицу слоев
                    acLyrTbl.Add(acLyrTblRec);
 
                    // добавляем созданный слой в документ
                    tr.AddNewlyCreatedDBObject(acLyrTblRec, true);
 
                    // фиксируем транзакцию
                    tr.Commit();
                }
            }
        }
 
        // эта функция будет вызываться при выполнении в AutoCAD команды "TestCommand"
        [CommandMethod("NewCommand")]
        public void NewCommand()
        {
            // получаем текущий документ и его БД
            Document acDoc = Autodesk.AutoCAD.ApplicationServices.Application.DocumentManager.MdiActiveDocument;
            Database acCurDb = acDoc.Database;
 
            // блокируем документ
            using (DocumentLock docloc = acDoc.LockDocument())
            {
                // начинаем транзакцию
                using (Transaction tr = acCurDb.TransactionManager.StartTransaction())
                {
                    // открываем таблицу слоев документа
                    LayerTable acLyrTbl = tr.GetObject(acCurDb.LayerTableId, OpenMode.ForWrite) as LayerTable;
 
                    // если в таблице слоев нет нашего слоя - прекращаем выполнение команды
                    if (acLyrTbl.Has("HabrLayer") == false)
                    {
                        return;
                    }
 
                    // устанавливаем нулевой слой в качестве текущего
                    acCurDb.Clayer = acLyrTbl["0"];
 
                    // убеждаемся, что на удаляемый слой не ссылаются другие объекты
                    ObjectIdCollection acObjIdColl = new ObjectIdCollection();
                    acObjIdColl.Add(acLyrTbl["HabrLayer"]);
                    acCurDb.Purge(acObjIdColl);
 
                    if (acObjIdColl.Count > 0)
                    {
                        // получаем запись слоя для изменения
                        LayerTableRecord acLyrTblRec = tr.GetObject(acObjIdColl[0], OpenMode.ForWrite) as LayerTableRecord;
 
                        try
                        {
                            // удаляем слой
                            acLyrTblRec.Erase(true);
 
                            // фиксируем транзакцию
                            tr.Commit();
                        }
                        catch (Autodesk.AutoCAD.Runtime.Exception Ex)
                        {
                            // если произошла ошибка - значит, слой удалить нельзя
                            Application.ShowAlertDialog("Ошибка:n" + Ex.Message);
                        }
                    }
                }
            }
        }
 
        // Функции Initialize() и Terminate() необходимы, чтобы реализовать интерфейс IExtensionApplication
        public void Initialize()
        {
 
        }
 
        public void Terminate()
        {
 
        }
    }
}

using System;
using System.IO;
using Autodesk.AutoCAD.Runtime;
using Autodesk.AutoCAD.ApplicationServices;
using Autodesk.AutoCAD.DatabaseServices;

namespace HabrPlug_Layers
{
    public class Commands : IExtensionApplication
    {
        // переменная для хранения старого значения затемнения заблокированных слоев
        int old_LAYLOCKFADECTL = 0;
        
        // действия при загрузке плагина
        public void Initialize()
        {
            // запоминаем текущее значение затемнения заблокированных слоев
            old_LAYLOCKFADECTL = System.Convert.ToInt32(Autodesk.AutoCAD.ApplicationServices.Application.GetSystemVariable("LAYLOCKFADECTL"));
            // устанавливаем новое значение затемнения заблокированных слоев равным 0
            Autodesk.AutoCAD.ApplicationServices.Application.SetSystemVariable("LAYLOCKFADECTL", 0);
        }

        // действия при закрытии AutoCAD
        public void Terminate()
        {
            // возвращаем то значение затемнения заблокированных слоев, которое было установлено до загрузки плагина
            Autodesk.AutoCAD.ApplicationServices.Application.SetSystemVariable("LAYLOCKFADECTL", old_LAYLOCKFADECTL);
        }
    }
}