AutoRevit.Generator 0.0.4

AutoRevit.Generator

介绍

Revit 二次开发源生成器库，快速且轻松的使用revit相关api。

安装教程

dotnet add package AutoRevit.Generator

使用说明

快速开始

public class AutoCommand
{
    [AutoExternalCommand]
    internal static Result GetWall(ExternalCommandData CommandData, ref string msg)
    {
        try
        {
            // 业务代码

            return Result.Succeeded;
        }
        catch (Exception ex)
        {
            msg = ex.Message;
            return Result.Failed;
        }
    }
}

根据给静态方法标注特性 [AutoExternalCommandAttribute] 生成继承了 Autodesk.Revit.UI.IExternalCommand 的扩展命令类并调用静态方法:

namespace AutoRevitDemo.TestExternalCommand;

[global::Autodesk.Revit.Attributes.Transaction(global::Autodesk.Revit.Attributes.TransactionMode.Manual)]
public class GetWallAutoExternalCommand : global::Autodesk.Revit.UI.IExternalCommand
{
    public global::Autodesk.Revit.UI.Result Execute(global::Autodesk.Revit.UI.ExternalCommandData commandData, ref string message, global::Autodesk.Revit.DB.ElementSet elements)
    {
        global::Autodesk.Revit.UI.Result result = global::AutoLiteDemo.TestExternalCommand.AutoCommand.GetWall(commandData, ref message);
        return result;
    }
}

生成的类名称默认为 [方法名称]AutoExternalCommand

要求

• 标注特性 [AutoExternalCommandAttribute]

• 函数的类修饰符为 internal 或 public

• 函数为静态且修饰符为internal 或 public

• 函数返回值为 Autodesk.Revit.UI.Result

• 函数允许的参数类型 Autodesk.Revit.UI.ExternalCommandData、 string、 Autodesk.Revit.DB.ElementSet、 AutoRevit.Entry.Command.IRevitData

• 如果参数包含string类型则需要添加ref关键字

• 如果参数类型为AutoRevit.Entry.Command.IRevitData则需要引用NuGet包 AutoRevit >= 0.1.6版本

• 入参数类型的顺序可以不固定

AutoExternalCommandAttribute 说明

namespace AutoRevit;

[AttributeUsage(AttributeTargets.Method)]
[System.Diagnostics.Conditional("AutoExternalCommandGenerator_DEBUG")]
internal sealed class AutoExternalCommandAttribute : Attribute
{
    public string? ClassName { get; set; }

    public string? TransactionMode { get; set; }

    public string? JournalingMode { get; set; }

    public string? RegenerationOption { get; set; }
}

• ClassName: 定义生成的类名
• TransactionMode: 定义扩展命令类的特性

Autodesk.Revit.Attributes.Transaction(global::Autodesk.Revit.Attributes.TransactionMode.[TransactionMode]) 

默认为空则为

Autodesk.Revit.Attributes.Transaction(global::Autodesk.Revit.Attributes.TransactionMode.Manual) 

• JournalingMode: 定义扩展命令类的特性

[global::Autodesk.Revit.Attributes.Journaling(global::Autodesk.Revit.Attributes.JournalingMode.[UsingCommandData])]

• RegenerationOption: 定义扩展命令类的特性

[global::Autodesk.Revit.Attributes.Regeneration(global::Autodesk.Revit.Attributes.RegenerationOption.[Manual])]

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request