AutoCAD DevBlog

Mimic Line Number > New feature on Plant 3D – 2.0

By Augusto Goncalves

This is an expanded version of what as previously posted here, hence the 2.0

But what was missing on version 1.0?

Actually it considered just one element at a time. Also, it ignored the related elements, like connectors, for instance. Now the sample below get a selection of entities, then find related elements (like P3dConnector and Universal) and add them all to the newly create group.

Thanks to Jens Dorstewitz (ADN Partner) for helping improve it.

[CommandMethod("customNewTag")]
public static void CmdCustomNewTag()
{
  Editor ed = Application.DocumentManager.MdiActiveDocument.Editor;
 
  PromptSelectionResult  per = ed.GetSelection();
  if (per.Status != PromptStatus.OK) return;
 
  PromptResult pr = ed.GetString("\nEnter new tag: ");
  if (pr.Status != PromptStatus.OK) return;
 
  ObjectIdCollection ids = new ObjectIdCollection();
  foreach (SelectedObject selObj in per.Value)
    ids.Add(selObj.ObjectId);
 
  CreateNewTag(ids, pr.StringResult);
}
 
private static void CreateNewTag(ObjectIdCollection itemIds, string newTagValue)
{
  PlantProject currentProj = PlantApplication.CurrentProject;
  PipingProject pipeProj = (PipingProject)currentProj.ProjectParts["Piping"];
  DataLinksManager dlm = pipeProj.DataLinksManager;
  PnPDatabase db = dlm.GetPnPDatabase();
 
  // create new line group
  PnPTable p3dLineGroupTable = db.Tables["P3dLineGroup"];
  PnPRow lgRow = p3dLineGroupTable.NewRow();
  lgRow["Tag"] = newTagValue;
  p3dLineGroupTable.Rows.Add(lgRow);
  int newLineGroupId = lgRow.RowId;
 
  // rowIds of the selected items
  List<int> rowIds = new List<int>();
  foreach (ObjectId itemId in itemIds)
    rowIds.Add(dlm.FindAcPpRowId(itemId));
 
  // now the rowIds list contain only the 
  // items selected on screen, but we need more
  // elements related to those
  List<int> relateRowIds = new List<int>();
  foreach (int itemRowId in rowIds)
  {
    // only Olet, skip others.
    if (db.GetRowTableName(itemRowId) != "Olet") continue;
 
    // get the P3dConnectors
    List<int> p3dConnectorIds = new List<int>();
    p3dConnectorIds.AddRange(
      dlm.GetRelatedRowIds("P3dPartConnection",
      "Part1", itemRowId, "Part2"));
    p3dConnectorIds.AddRange(
      dlm.GetRelatedRowIds("P3dPartConnection",
      "Part2", itemRowId, "Part1"));
 
    List<int> universals = new List<int>();
    foreach (int connectorId in p3dConnectorIds)
    {
      // now the Universal:
      // the PnPDataLinks table should contain both
      // P3dConnector and Universal, and both share the 
      // same DwgHandleLow value, so find the first and
      // use this value to find the second
      PnPTable datalinksTable = db.Tables["PnPDataLinks"];
      PnPRow[] rows = datalinksTable.Select(
        string.Format("\"RowId\"={0}", connectorId));
      foreach(PnPRow row in rows)
      {
        PnPRow[] universalRow = datalinksTable.Select(
          string.Format("\"DwgHandleLow\"={0} AND \"DwgSubIndex\"=1",
          row["DwgHandleLow"]));
        universals.Add(int.Parse(universalRow[0]["RowId"].ToString()));
      }
    }
 
    // add what we found to the main list
    relateRowIds.AddRange(p3dConnectorIds);
    relateRowIds.AddRange(universals);
  }
 
  // finally a list with the selected elements
  // plus all related elements
  // now the rowIds should contain everything
  // that needs to be added to the new line group
  rowIds.AddRange(relateRowIds);
 
  // .Distinct avoid duplicated
  foreach (int itemRowId in rowIds.Distinct<int>().ToList<int>()) 
  {
    // get all line groups related to the items we found
    PnPRowIdArray priorGroupIds = dlm.GetRelatedRowIds(
      "P3dLineGroupPartRelationship", "Part", itemRowId, "LineGroup");
 
    // remove them from any previous group
    if (priorGroupIds.Count != 1)
    {
      foreach (int id in priorGroupIds)
      {
        dlm.Unrelate("P3dLineGroupPartRelationship",
          "LineGroup", id, "Part", itemRowId);
      }
    }
 
    // make the new relation
    if (newLineGroupId != -1 && itemRowId != -1)
    {
      dlm.Relate("P3dLineGroupPartRelationship",
        "LineGroup", newLineGroupId, "Part", itemRowId);
    }
  }
 
  // relate the drawing to the line group
  int dwgId = dlm.GetDrawingId(
    Application.DocumentManager.MdiActiveDocument.Database);
  if (dwgId != -1)
  {
    dlm.Relate("P3dDrawingLineGroupRelationship",
                "Drawing", dwgId,
                "LineGroup", newLineGroupId);
  }
}

Snoop Plant 3D database with PnPTest

By Augusto Goncalves

Plant 3D database is actually a .dcf file, when stored locally. These files are stored at the project folder, at the same location of the Project.xml main file. 

Like other databases, we can read tables with columns and rows. Click here to download it.

AcDbObject::dwgOutFields can crash on custom object

By Augusto Goncalves

When implementing a custom object (derived from AcDbObject or AcDbEntity) the dwgOutFields method is required, otherwise AutoCAD will not save our data. Usually the first step is call the base implementation, but that can crash. Why?

One reason is the safe check implemented to avoid null or erased AcDbDictionary referenced by the object, basically a isNull and isErased check.

Remember to configure and enable AutoCAD Debug Symbols on Visual Studio, that will help spot problems on internal calls.

Validate Plant P&ID drawings

By Augusto Goncalves

Inside Plant P&ID we can Validate, via ribbon Home>Validate>Run Validation or right-click on a drawing and select “Validate”. More details here.

Using APIs there is a ValidationSingleton object that has a ValidateDrawings or ValidareProject method. After run this, the Errors property will contain a list of validation errors. Actually there is one class for each type, so you’ll need to cast or, like in the sample below, simply get the error name.

Important: this API method will *only* show the validation errors after you run it via built-in command.

[CommandMethod("validateDrawings")]
public static void CmdValidateDrawings()
{
  Editor ed = Application.DocumentManager.
    MdiActiveDocument.Editor;
 
  // Validation manager
  AcPpValidationManager vmgr = ValidationSingleton.Manager;
 
  // prepare a list of drawings
  AcPpValidationAllOpenedDrawingManager dsd =
    new AcPpValidationAllOpenedDrawingManager();
  foreach (Document doc in Application.DocumentManager)
  {
    dsd.Add(doc.Database);
  }
 
  // clear the list of error 
  // (in case you're running several times)
  vmgr.Errors.Clear();
 
  // the actual validation occurs here
  vmgr.ValidateProject(dsd);
 
  // now check the list of errors
  if (vmgr.Errors.Count > 0)
  {

    AcPpValidationErrorCollection errorList = vmgr.Errors;
    foreach (IAcPpValidationError item1 in errorList)
    {
      // can be classes from namespace
      // Autodesk.ProcessPower.PnIDDwgValidation          
 
 
      // for now, let's write the error class name
      ed.WriteMessage("\n{0}", 
        item1.GetType().Name.PascalCaseToText());
    }
  }
}

// nice sample Regular expression from here. 
public static string PascalCaseToText(this string text)
{
  return System.Text.RegularExpressions.Regex.Replace(
    text, "([a-z](?=[A-Z])|[A-Z](?=[A-Z][a-z]))", "$1 ");
}

Track value change on Plant 3D Database

By Augusto Goncalves

On AutoCAD entities we cannot track changes, although we can simulate some sort of tracking mechanism, see this blog post. So if you need to track geometric properties, like position, you’ll probably need something as described.

Now on Plant 3D there is a actual database storing information: the PnPDatabase, which includes a list of tables (PnPTable), that represent the classes. And there are some interesting events, such as ColumnChanged event.

Below is a sample that uses this event to track changes on database values (in this case, the Manufacturer) of EngineeringItems.

[CommandMethod("trackTableChanges")]
public static void CmdTrackChanges()
{
  TrackDBTableChanges(
    "EngineeringItems",
    new string[] { "Manufacturer" });
}
 
private static void TrackDBTableChanges(
  string tableName, string[] columns)
{
  PlantProject currentProj =
    PlantApplication.CurrentProject;
  PipingProject pipeProj =
    (PipingProject)currentProj.ProjectParts["Piping"];
  DataLinksManager dlm = pipeProj.DataLinksManager;
  PnPDatabase db = dlm.GetPnPDatabase();
 
  // the table we want to track
  PnPTable engItemsTable = db.Tables[tableName];
 
  // just the columns we want to track
  _collunsToTrack = new List<string>(columns);
 
  // start tracking
  engItemsTable.ColumnChanged +=
    engItemsTable_ColumnChanged;
}
 
private static List<string> _collunsToTrack = null;
 
static void engItemsTable_ColumnChanged
  (object sender, PnPColumnChangeEventArgs e)
{
  // filter by column name
  if (!(_collunsToTrack.Contains(e.Column.Name))) return;
 
  // simple output
  Application.DocumentManager.MdiActiveDocument.
    Editor.WriteMessage(
    "{0} of item {1} changed from {2} to {3}",
    e.Column.Name, e.Row.RowId,
    e.CurrentValue, e.ProposedValue);
}

Custom code snippet on Visual Studio

By Augusto Goncalves

Today’s post is focused on productivity, an aspect that is sometimes left behind due our intense work load…And I believe that small improvements can make a huge difference on our daily work.

Now the idea is to save us some time typing a new command for AutoCAD, that includes, for instance, database, editor and transaction. Sure you can adjust the code.

How make this work? Simple:

1. Create a .snippet file using any text editor (Notepad can do the trick).
2. Copy & paste the XML content below
3. Save at [My Documents]\Visual Studio 2012\Code Snippets\Visual C#\My Code Snippets\ folder, or other version that you have.
4. At your Visual Studio code, type AcadCmd and press TAB, the code should appear, press TAB again to move between command name and method name, both marked in yellow.

Like it? You may adjust to other commands or other pieces that you use repeatedly. Here is the .snippet for download.

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2008/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>AutoCAD Command</Title>
      <Shortcut>AcadCmd</Shortcut>
      <Description>Code snippet for AutoCAD command method with transaction</Description>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>COMMAND_NAME</ID>
          <ToolTip>Replace with the command name</ToolTip>
          <Default>myCommandName</Default>
        </Literal>
        <Object>
          <ID>METHOD_NAME</ID>
          <ToolTip>Replace with the method name</ToolTip>
          <Default>myMethodName</Default>
        </Object>
      </Declarations>
      <Code Language="CSharp">
        <![CDATA[
        [CommandMethod("$COMMAND_NAME$")]
        public static void $METHOD_NAME$()
        {
            Database db = Application.DocumentManager.MdiActiveDocument.Database;
            Editor ed = Application.DocumentManager.MdiActiveDocument.Editor;
            using (Transaction trans = db.TransactionManager.StartTransaction())
            { 
 
            }
        }
        ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

Mimic Line Number > New feature on Plant 3D

By Augusto Goncalves

This post is actually inspired on create a new line group previous post, but with some changes. This will actually mimic the Line Number >> New >> Assign Tag feature on Plant 3D.

First, remove previous group related to the pipe, in order to avoid belong to more than one line group, which can be a modeling error. Second, just make the code simpler to include on your code. Note this will run for individual pipe making each pipe into a different line group (therefore different ISO production from each of them), you may adjust to a group of pipes.

private static void CreateNewTag(ObjectId partId, string newTagValue)
{
  PlantProject currentProj = PlantApplication.CurrentProject;
  PipingProject pipeProj = (PipingProject)currentProj.ProjectParts["Piping"];
  DataLinksManager dlm = pipeProj.DataLinksManager;
  PnPDatabase db = dlm.GetPnPDatabase();
 
  PnPTable p3dLineGroupTable = db.Tables["P3dLineGroup"];
  PnPRow lgRow = p3dLineGroupTable.NewRow();
  lgRow["Tag"] = newTagValue;
  p3dLineGroupTable.Rows.Add(lgRow);
 
  int prRowId = dlm.FindAcPpRowId(partId);
  PnPRow prRow = db.GetRow(prRowId); // not used yet
 
  // remove all line groups already related 
  // to this pipe, if any, to avoid this pipe
  // belong to multiple line groups
  PnPRowIdArray priorGroupIds = dlm.GetRelatedRowIds(
    "P3dLineGroupPartRelationship", "Part",
    prRowId, "LineGroup");
  if (priorGroupIds.Count != 1)
  {
    foreach (int id in priorGroupIds)
    {
      dlm.Unrelate("P3dLineGroupPartRelationship",
        "LineGroup", id, "Part", prRowId);
    }
  }
 
  // make the relation
  if (lgRow.RowId != -1 && prRowId != -1)
  {
    dlm.Relate("P3dLineGroupPartRelationship",
      "LineGroup", lgRow.RowId, "Part", prRowId);
  }

}

And here is a simple command to invoke this routine

[CommandMethod("customNewTag")]
public static void CmdCustomNewTag()
{
  Editor ed = Application.DocumentManager.MdiActiveDocument.Editor;
 
  PromptEntityOptions peo = new PromptEntityOptions("\nSelect pipe: ");
  peo.SetRejectMessage("\nOnly pipes");
  peo.AddAllowedClass(typeof(Pipe), true);
  PromptEntityResult per = ed.GetEntity(peo);
  if (per.Status != PromptStatus.OK) return;
 
  PromptResult pr = ed.GetString("\nEnter new tag: ");
  if (pr.Status != PromptStatus.OK) return;
 
  CreateNewTag(per.ObjectId, pr.StringResult);
}

Custom file selection obeying FILEDIA sysvar

By Augusto Goncalves

When we create a custom command, we want it to integrate with AutoCAD built-in behavior. One of those expected behaviors is the FILEDIA system variable, that indicates if a dialog will show when selecting files.

Many developer make direct use of Autodesk.AutoCAD.Windows.OpenFileDialog class, but this will call directly a dialog. The alternative is PromptSaveFileOptions, that can used with the Editor and has the FILEDIA behavior implemented.

The following code snippet show how to implement it.

Editor ed = Application.DocumentManager.MdiActiveDocument.Editor;
PromptSaveFileOptions pfso = new PromptSaveFileOptions("Select a file: ");
PromptFileNameResult pfnr = ed.GetFileNameForSave(pfso);
if (pfnr.Status != PromptStatus.OK) return;
 
string fileName = pfnr.StringResult;

// do something with the file

Simple drawable overrule skeleton

By Augusto Goncalves

We have a few samples of our blog showing how create drawable overrule. But what’s the skeleton to set up? This is actually a recurrent question on our support, so I decided to share what is my recommendation.

To make it work you’ll need a class that implements the DrawableOverrule class and the WorldDraw method (and the ViewportDraw is more specific). I prefer have a command to active/deactivate the overrule and make it as startup command (using bundle format). The command will check the variable and Add or Remove the overrule. Finally, remember to call Regen(), otherwise the new geometry will not appear.

The sample below should work for MText (for other types, just replace the class name).

[CommandMethod("simpleOverrule")]
public void CmdSimpleOverrule()
{
  if (_overrule == null)
  {
    _overrule = new TextOverrule();
    Overrule.AddOverrule(
      RXClass.GetClass(typeof(MText)),
      _overrule, false);
  }
  else
  {
    Overrule.RemoveOverrule(
      RXClass.GetClass(typeof(MText)),
      _overrule);
    _overrule = null;
  }
  Application.DocumentManager.MdiActiveDocument.Editor.Regen();
}
 
private static TextOverrule _overrule = null;
 
public class TextOverrule : DrawableOverrule
{
  public override bool WorldDraw(Drawable drawable, WorldDraw wd)
  {
    // draw the base class
    bool ret = base.WorldDraw(drawable, wd);
 
    // your custom code here
    //
    //
 
    // return the base
    return ret;
  }
}

Reset Pipe tags

By Augusto Goncalves

On the UI it’s possible to select Pipes, erase the Tag (set as unassigned) and then set it back. In some cases, this is a workflow to fix tag problems on Pipes, that can reflect on ISO generation.

The idea of this code is: on the database level (DataLinksManager), get all the PipeRunComponents, Fasteners and P3dConnector, then finally Unrelate and Relate again. The purpose is to force Plant 3D to rebuild its structure and restore.

Thanks to Jorge Lopez (big) help on this!

Important: if you plan to use this, ensure you have a backup of your project.

[CommandMethod("tryFixPipeTag")]
public static void CmdTryFixLineTag()
{
  Editor ed = Application.DocumentManager.
    MdiActiveDocument.Editor;
 
  PlantProject currentProj = 
    PlantApplication.CurrentProject;
  PipingProject pipeProj = 
    (PipingProject)currentProj.ProjectParts["Piping"];
  DataLinksManager dlm = 
    pipeProj.DataLinksManager;
 
  PnPDatabase db = dlm.GetPnPDatabase();
 
  db.StartTransaction();
 
  int dwgRowId = dlm.GetDrawingId(
    Application.DocumentManager.MdiActiveDocument.Database);
  PnPRowIdArray groupIds = dlm.GetRelatedRowIds(
    "P3dDrawingLineGroupRelationship", "Drawing",
    dwgRowId, "LineGroup");
 
  foreach (int groupId in groupIds)
  {
    List<PnPRow> rowsToFix = new List<PnPRow>();
    PnPRow rowLineGroup = db.GetRow(groupId);
 
    string tag = rowLineGroup["Tag"] as string;
    if (string.IsNullOrWhiteSpace(tag)) continue;
 
    ed.WriteMessage("\n{0}", tag);
    System.Diagnostics.Debug.WriteLine(
      string.Format("\n{0}", tag));
 
    // Get pipe run components
    //
    PnPTable tblPipes = db.Tables["PipeRunComponent"];
    PnPRow[] rowsPipes = tblPipes.Select(
      string.Format("LineNumberTag='{0}'", tag));
 
    AddRowsToUniqueList(rowsToFix, rowsPipes);
 
    // Get fasteners
    //
    PnPTable tblFastener = db.Tables["Fasteners"];
    PnPRow[] rowsFastener = tblFastener.Select(
      string.Format("LineNumberTag='{0}'", tag));
 
    AddRowsToUniqueList(rowsToFix, rowsFastener);
 
    // Get P3dConnectors
    //
    PnPTable tblConnector = db.Tables["P3dConnector"];
    // just in case, make sure all rows are loaded in
    tblConnector.Select();  
 
    foreach (PnPRow rowFastener in rowsFastener)
    {
      PpObjectIdArray arr = dlm.FindAcPpObjectIds(rowFastener.RowId);
      foreach (PpObjectId ppId in arr)
      {
        PpObjectId ppConnectorId = new PpObjectId(
          ppId.DwgId, ppId.dbHandle, 0);
        int rowIdConnector = dlm.FindAcPpRowId(ppConnectorId);
        PnPRow jointRow = db.GetRow(rowIdConnector);
 
        AddRowToUniqueList(rowsToFix, jointRow);
      }
    }
 
    // Fix: Catches the following situations:
    //
    // 1. where tag does not match actual group
    // 2. when there is more than one group per part
    // 3. when the relationship is missing
    //
    foreach (PnPRow row in rowsToFix)
    {
      PnPRowIdArray priorGroupIds = 
        dlm.GetRelatedRowIds(
        "P3dLineGroupPartRelationship",
        "Part", row.RowId, "LineGroup");
      if (priorGroupIds.Count == 1 &&
        priorGroupIds.First.Value == rowLineGroup.RowId)
      {
        continue;
      }
 
      foreach (int id in priorGroupIds)
      {
        dlm.Unrelate("P3dLineGroupPartRelationship",
          "LineGroup", id, "Part", row.RowId);
      }
 
      dlm.Relate("P3dLineGroupPartRelationship", 
        "LineGroup", rowLineGroup.RowId, "Part", row.RowId);
    }
  }
 
  db.CommitTransaction();
}
 
private static void AddRowToUniqueList(
  List<PnPRow> rowsToFix, PnPRow jointRow)
{
  AddRowsToUniqueList(rowsToFix, new PnPRow[] { jointRow });
}
 
private static void AddRowsToUniqueList(
  List<PnPRow> rowsToFix, PnPRow[] rowsPipes)
{
  rowsToFix.AddRange(rowsPipes);
}