AEC DevBlog

Where is OMF SDK?

Q. Where can find OMF SDK?  

A. OMF SDK is posted on the ADN extranet http://adn.autodesk.com, the members only site.  

After logged into the ADN extranet, go to "Software & Support" >> AutoCAD Architecture >> Download >> Object Modeling Framework (OMF). Follow the link and accept the license agreement. It will take you to the download page.

Note: OMF requires a separate license agreement and is provided to the member of ADN only.  

Mikako

Using AutoCAD MEP Object Enablers in AcCoreConsole

By Jeremy Tammik.

Question: Using AcCoreConsole I'd like to move an object via AcCoreConsole.

The object type in question happens to be an AutoCAD MEP MVBlock.

Is this possible?

Would AcCoreConsole recognise the object as valid or would it be a zombie, i.e. a proxy object?

Answer: I checked with the development team and received several confirmations saying that this should work:

AcCoreConsole does recognise MVBlock, and the object can be moved in the same way as in AutoCAD.

The AutoCAD MEP object enablers get loaded on demand in AcCoreConsole.exe.

Here is a test suite proving it:

1. accoreconsole.exe: Just run accoreconsole.exe, following modules were loaded. Please note AEC modules are not loaded:

2. accoreconsole.exe /i oneBox.dwg: Open a dwg with only one box. A few more AutoCAD modules get loaded, but no AEC modules:

3. accoreconsole.exe /i oneWall.dwg: Open a dwg with only one wall. AEC modules are loaded. Also note that AECB modules are loaded, even though there are no MEP objects in the DWG:

Following is the output of list command:

4. accoreconsole.exe /i oneDuct.dwg: Open a dwg with only one duct. AEC and AECB module are loaded:

Following is the output of list command:

I hope this helps.

Problems reading an AEC side database with a mode other than SH_DENYNO

By Adam Nagy

When a side database is read in using any mode other than SH_DENYNO, some OMF functionalities do not work properly. For example, when wall properties are queried, the following error may occur:

*Area Not Found*

Solution

The problem is due to the way that AutoCAD handles the reading of side databases, thus AutoCAD Architecture cannot do much in this regard.

You'll also find that some of the ACA/MEP entities do not behave as you'd expect them in case of using RealDWG to open AutoCAD Architecture or MEP drawings. E.g. the ACA/MEP entities might not call the drawing primitives of your AcGi implementation when you make them draw themselves.

If side databases are opened with SH_DENYNO, they are fully loaded and the relationship graph will be complete.

If they are loaded any other way, you need to call AecAppDbx::drawingPromoterAndIniter() or AcDbDatabase::closeInput() on it. That forces all objects to be pulled from the disk.

This is not ideal, but it is the only way that AutoCAD Architecture can guarantee that the relationship graph is complete. This function always needs to be called to make sure that the necessary promotion and cleanup takes place.

So, the solution is to either open the side database with SH_DENYNO, or call AecAppDbx::drawingPromoterAndIniter() or AcDbDatabase::closeInput() on the opened database.

Creating a new Multi-View Block definition using OMF

By Katsuaki Takamizawa

Issue:

We would like to create a new Multi-View Block definition. Our program will fill in Name and Description and will need to create "General", "Model", "Plan 1-100", "Plan 1-50" and "Reflected" on Display Representation list box. For "General" and "Model", they will have view block names in View Blocks list box with View Directions assigned. Just like one can do in 'Multi-View Block Definition Properties' dialog box. Please provide some sample.

Solution:

A sample code below demonstrates how to create a MultiView block definition from OMF. This sample adds a new MultiViewBlock definition named "myMvBlockDefOMF". It assumes that a block definition named "myBlock" exists. Please make one beforehand. (Just a circle would do.) This sample adds only one AecMvBlockDispRepDef, but you can add more as you need. Same for AecMvBlockViewDefinition. Try changing the value in the code below and compare them in UI. You will see the correspondence between UI and OMF code.

  AcDbDatabase* pDb = acdbHostApplicationServices()->workingDatabase();
  Acad::ErrorStatus es; 

  // hard coding the name of MvBlock definition for simplicity.
  AecRmCString sMvBlockDefName=_T("myMvBlockDefOMF"); 

  // get the MvBlock Def dictionary.
  AecDictMvBlockDef dictMvBlockDef(pDb);
  if(!dictMvBlockDef.isValid()){
    acutPrintf(_T("failed to get the MultiBlock definition dictionary!\n"));
    return ;
  }

  // add a record to the dictionary.
  AecDbMvBlockDef *pMvBlockDef = AecDbMvBlockDef::cast(dictMvBlockDef.newEntry());
  if(pMvBlockDef == NULL) {
    acutPrintf(_T("failed to create a new MvBlockDef dictionary record.\n")); 
    return;
  }
  es = dictMvBlockDef.addNewRecord(sMvBlockDefName, pMvBlockDef);
  if(es != Acad::eOk){
    acutPrintf(_T("failed to add a new MvBlockDef \"%s\" \n"), sMvBlockDefName.c_str());
    delete pMvBlockDef;
    return;
  }

  //  Now, we need to fill in MvBlockDef.
  // 

  //  fill in the description
  pMvBlockDef->setDescription(_T("This is MvBlock Definition added from OMF."));

  //  create a new MvBlock's DispRepDef.
  //  you can create more than one if you want.
  AecMvBlockDispRepDef* pMvBlockDispRepDef = new AecMvBlockDispRepDef;

  //  get a list of disp rep works with MvBlock.
  AecDispRepMgr *pDRM = AecBaseServices::service()->dispRepMgr(pDb);

  AcDbObjectIdArray ids;
  pDRM->getAllViewsFor(AecDbMvBlockRef::desc(), ids);

  //  for the simplicity we will use the first rep only.
  if(ids.length()>0) pMvBlockDispRepDef->setDisplayRep(ids[0]); 

  AecMvBlockViewDefinition *pMvBlockViewDef = new AecMvBlockViewDefinition;
  AcDbObjectId blockObjId; 
  es = Aec::getBlockTableRecordId(_T("myBlock"), pDb, blockObjId);   // we assume we have it defined.

  pMvBlockViewDef->setBlockId(blockObjId);
  pMvBlockViewDef->setViewOn(Aec::ViewDirection::kViewDirTop, Adesk::kTrue);
  pMvBlockViewDef->setViewOn(Aec::ViewDirection::kViewDirBottom, Adesk::kTrue);

  es = pMvBlockDispRepDef->addViewBlock(pMvBlockViewDef);

  es = pMvBlockDef->addDispRepDef(pMvBlockDispRepDef);

  //  finishing up. 
  es = pMvBlockDef->close();

  // We have a new MultiBlock definition now.
  acutPrintf(_T("\nA new MultiBlock definiton \"%s\" is created. \n"), sMvBlockDefName.c_str());

Inserting a multiple view block instance with associated attributes using OMF

By Katsuaki Takamizawa

Issue:

How can I insert a multiple view block instance (AecDbMvBlockRef) with associated attributes using OMF? For example, I'd like to insert a column grid tag and provide a tag number to it.

Solution:

A multiple view block instance (AecDbMvBlockRef) is a display reference to one of the multiple view block definitions (AecDbMvBlockDef) which are stored in the dictionary AecDictMvBlockDef. AecDbMvBlockDef contains many view blocks (AecMvBlockView) which are used by individual display representations for different view directions. Each view block instance (AecMvBlockViewInstance) can contain many multiple view attributes (AecMvBlockAttribute) which are just wrappers of AutoCAD attribute objects (AcDbAttribute).

The appended code demonstrates how to achieve the desired task. This can be easily applied to other multiple block definitions. When you do so, please make sure that the name of multiple view block definition is provided correctly, the number of attributes is checked, proper attribute tags are retrieved from the view block definition, and the attributes and multiple view block reference are updated.

 

  //  get a multi view block definition.
  //  for example, "StandardGridBubble". (We assume we have it defined.)
  //
  AecRmCString mvName = "StandardGridBubble";
  AcDbObjectId mvBlkDefId;
  AcDbDatabase *pDb = acdbHostApplicationServices()->workingDatabase();

  AecDictMvBlockDef mvDict(pDb);
  if( mvDict.isValid() != Adesk::kTrue )
    return;

  if( mvDict.has(mvName) ) 
    mvDict.getAt(mvName, mvBlkDefId); 
  else
    return;

  //  create a multi view block reference.
  //
  AecDbMvBlockRef* mvBlkRef = new AecDbMvBlockRef; 
  assert(mvBlkRef != NULL);
  mvBlkRef->subSetDatabaseDefaults( pDb );
  mvBlkRef->setToStandard( pDb );
  mvBlkRef->setBlockDefId(mvBlkDefId); 
  mvBlkRef->setLocation(AcGePoint3d(0,0,0));
  mvBlkRef->setRotation(0);
  AcGeScale3d scale3d(350);
  mvBlkRef->setScale(scale3d);

  //  set the attributes.
  if( mvBlkRef->hasAttributes() )
  {
    //  Here we choose the first view instance for the simplicity.
    // 
    AecMvBlockViewInstance* blkViewIns = mvBlkRef->getViewBlockAt(0); 
    assert(blkViewIns != NULL);

    //  set the "Label" attribute to "A0".
    int indexFoundAt;
    if( blkViewIns->findAttribute(_DNT("LABEL"), indexFoundAt)==Adesk::kTrue )
    {
      AecMvBlockAttribute *mvBlkAtt;
      AcDbAttribute *acadAtt;
      mvBlkAtt = blkViewIns->getAttributeAt(indexFoundAt);
      assert(mvBlkAtt != NULL);
      acadAtt = mvBlkAtt->attributeForWrite( );
      assert(acadAtt != NULL);
      acadAtt->setTextString(_DNT("A0"));
      acadAtt->close();
      mvBlkAtt->setNeedsUpdate(Adesk::kTrue);
    }
  }

  mvBlkRef->updateViewBlocks(); 

  Aec::transformToWcs(mvBlkRef, pDb); 
  Aec::addToCurrentSpaceAndClose(mvBlkRef);

Anchoring an AecDbMvBlockRef as a schedule tag using OMF

By Katsuaki Takamizawa

Issue:

I want to add an anchor onto AecDbMvBlockRef in order to programmatically make it a schedule tag for another ACA object. How can I do that in OMF?

Solution:

We can use AecDbAnchorTagToEnt to do the intended task. The following sample code inserts a metric window tag and anchors it to a window. This sample uses "M_Aec6_Window_Tag" multi view block definition. If it hasn't been imported yet, please drag and drop it from the Design Center before you run the sample.

Note that with this sample, the number in the tag will not be filled automatically. You need to add a property set to the window beforehand to have the tag retrieve the value. You can add a window property set manually. If you want to use OMF, please refer to a blog post Adding a property set programmatically using OMF.

 

  Acad::ErrorStatus es;
  // We use a multi view block definition M_Aec3_Window_Tag here.
  // (If it hasn't been imported yet, please drag and drop it
  // from Design Center.)
  AecRmCString mvName = _T("M_Aec6_Window_Tag");
  AcDbObjectId mvBlkDefId;
  AcDbDatabase *pDb = acdbHostApplicationServices()->workingDatabase();

  AecDictMvBlockDef mvDict(pDb);
  if( mvDict.isValid() != Adesk::kTrue )
    return;
  if( mvDict.has(mvName) ) 
    mvDict.getAt(mvName, mvBlkDefId); 
  else
    return;

  AecDbMvBlockRef* mvBlkRef = new AecDbMvBlockRef; 
  AEC_ASSERT(mvBlkRef != NULL);
  mvBlkRef->subSetDatabaseDefaults( pDb );
  mvBlkRef->setToStandard( pDb );
  mvBlkRef->setBlockDefId(mvBlkDefId); 

  // Set the tag location as picked by the user
  ads_point pt1;
  acedGetPoint(NULL,_T("\nInsertion point: "), pt1);
  mvBlkRef->setLocation(AcGePoint3d(pt1[0], pt1[1], pt1[2]));

  // Here, we hard code the rotation and scale factor for simplicity.
  // It should work well on Metric template.
  mvBlkRef->setRotation(0);
  AcGeScale3d scale3d(350);
  mvBlkRef->setScale(scale3d);

  AecDbAnchorTagToEnt* pAnchor = new AecDbAnchorTagToEnt();

  // Select a window to anchor the tag to.
  AcDbObjectId winId;
  AecUiPrEntity promptEnt(_T("Select a window"), NULL);
  promptEnt.addAllowedClass(AecDbWindow::desc());
  if(promptEnt.go() != AecUiPr::kOk)
  {
    acutPrintf(_T("\nNot a window."));
    return;
  }
  pAnchor->appendReferenceObject( promptEnt.objectId(), AecObjReferenceInfo::kOwnedBy );

  // Set the anchor to the tag.
  es = mvBlkRef->setAnchor( pAnchor );
  AEC_ASSERT( Acad::eOk == es );
  pAnchor->close();

  Aec::transformToWcs(mvBlkRef, pDb);
  Aec::addToCurrentSpaceAndClose(mvBlkRef);

Adding a property definition to a property set definition using OMF

By Katsuaki Takamizawa

Issue:

How to add a property definition to a property set definition using OMF?

Solution:

You can access to a property set definition stored in the dictionary "AEC_PROPERTY_SET_DEFS" under AutoCAD Named Object Dictionary) and add a property definition. The following code shows how to do it. This code finds property sets attached to a door and finds definitions. Please set a least one door property set to the door before testing the code. The code adds a property definition “Area” and then sets the value of 15.98.

 

  // get working database
  AcDbDatabase *pCurDb = acdbHostApplicationServices()->workingDatabase();
  if(pCurDb == NULL)
    return;

  // select a door
  AecUiPrEntity promptEnt(_T("Select a door"), NULL);
  promptEnt.addAllowedClass(AecDbDoor::desc());
  if(promptEnt.go() != AecUiPr::kOk)
  {
    acutPrintf(_T("\nAborting command..."));
    return;
  }

  // open the door for read
  Acad::ErrorStatus es;
  AecDbDoor *pEnt;
  es = AecDbDoor::open(pEnt, promptEnt.objectId(), AcDb::kForRead);
  if(es != Acad::eOk)
  {
    acutPrintf(_T("\nCan not open the Door entity."));
    return;
  }

  AcDbObjectId propSetDefId, propSetId;
  AecDbPropertySet* propSet;
  Adesk::UInt32 propId;

  // get property sets from extension dictionary of the selected door
  AcDbObjectIdArray propSetIds;
  es = AecDbPropertySet::getPropertySets( (AcDbObject*) pEnt, propSetIds);
  if(es != Acad::eOk)
  {
    acutPrintf(_T("\nThere are no property sets in this AEC entity."));
    pEnt->close();
    return;
  }
  pEnt->close();

  // iterate through all the property sets
  for(int iPropSet=0; iPropSet < propSetIds.length(); iPropSet++) {
    // get property set object
    AecDbPropertySet *propSet = NULL;
    AecDbPropertySet::open( propSet, propSetIds[iPropSet], AcDb::kForRead);

    AcDbObjectId propSetDefId = propSet->propertySetDef();
    propSet->close();

    AecDbPropertySetDef* propSetDef;
    es = AecDbPropertySetDef::open(propSetDef, propSetDefId, AcDb::kForWrite);

    // Add a propertydef to propertyset def
    // Create property
    AecPropertyDef* pdefArea = new AecPropertyDef;
    pdefArea->subSetDatabaseDefaults ( pCurDb) ;

    es = pdefArea->setName(_T("Area"));
    es = pdefArea->setAutomatic (false);
    es = pdefArea->setDataType (AecPropertyDef::kReal );

    // Add to Property Set
    es = propSetDef->addPropertyDef(pdefArea);

    propSetDef->close();

    // Open again to make modifications
    es = AecDbPropertySet::open(propSet, propSetIds[iPropSet], AcDb::kForWrite);
    es = propSet->propertyNameToId(_T("Area"), propId);
    es = propSet->setAt(propId, 15.98);

    propSet->close();
  }

Adding a property set programmatically using OMF

By Katsuaki Takamizawa

Issue:

Using the command _AecPropertyDataEdit and Add button, we can add a property set to an AEC object. How can I do this programmatically in OMF?

Solution:

The property set object is added to AEC object's extension dictionary named "AEC_PROPERTY_SETS". Its name will be anonymous (starting with "*"). In order to create it correctly, a property set definition must be referenced, as in the UI. The latter is stored in the dictionary "AEC_PROPERTY_SET_DEFS" under AutoCAD Named Object Dictionary). The following code shows exactly how to do it.

  // get working database
  Acad::ErrorStatus es;
  AcDbDatabase *pCurDb = acdbHostApplicationServices()->workingDatabase();
  if(pCurDb == NULL)
    return;

  // get a property set definition name, e.g. Door, Frame, etc.
  AecUiPrString promptStr(_T("Input property set definition name"), Adesk::kFalse);
  if(promptStr.go() != AecUiPr::kOk)
    return;

  // get dictionary of property set definition
  AecDictPropertySetDef dictPropSet(pCurDb);
  if( !dictPropSet.isValid() )
  {
    acutPrintf(_T("\nCan not find any property set definitions."));
    return;
  }

  // get the specific PropSetDef Id
  AcDbObjectId objId;
  es = dictPropSet.getAt(promptStr.value(), objId);
  if( es != Acad::eOk )
  {
    acutPrintf(_T("\nThe %s property set does not exist."),
      promptStr.value());
    return;
  }

  // select a door
  AecUiPrEntity promptEnt(_T("Select an Door"), NULL);
  promptEnt.addAllowedClass(AecDbDoor::desc());
  if(promptEnt.go() != AecUiPr::kOk)
  {
    acutPrintf(_T("\nI am only able to work on AEC entities. :-("));
    return;
  }

  // open the door for write
  AecDbDoor *pEnt;
  es = AecDbDoor::open(pEnt, promptEnt.objectId(), AcDb::kForWrite);
  if(es != Acad::eOk)
  {
    acutPrintf(_T("\nCan not open this AEC entities to write."));
    return;
  }

  // add property set to door
  es = AecDbPropertySet::addPropertySet(pEnt, objId);
  if(es != Acad::eOk)
  {
    acutPrintf(_T("\nCan not add property set."));
    return;
  }

  pEnt->close();

DictionaryRecordNameTranslator - what is the usage?

By Mikako Harada

Issue

I see a class called DictionaryRecordNameTranslator in the ACA .NET API.  What is the usage of it?  This would be great if I don't need to translate the property sets, etc., but just add a translator runtime. 

Solution

The name "Translator" is probably misleading and adding a confusion here.  Unfortunately this class is not meant for translation.   

DictionaryRecordnameTranslator class (or AecNameTranslator in OMF) does not actually translate anything; i.e., it doesn’t know how to translate English to German, for example. All it really does is provide a named object a way to identify where its global and local name are located. Some objects store their global name in the ‘Name’ field and local name in the ‘AlternateName’ field, while others are reversed. We needed some way for UI elements to say ‘give me your local name’, rather than always assuming the ‘Name’ is what they wanted. This means that the object still needs to provide translated strings! Simply put, an AecNameTranslator does not provide a translation, it just says where the translation is located.

Here is some additional note from OMF reference guide:

"An AecNameTranslator is a class that contains a mapping of global names to localized names. It is intended to be used by programmatic objects that are normally defined by users, such as the classifications used in Space standards, to define a global name that is used by the creator of the programmatic object while displaying a translated name to the user. 

Derived classes can be used to define where the global name comes from. For example, AecNameTranslatorDictRecordName defines a displayName function that takes an AecDbDictRecord parameter, gets the dictionary name from it, and returns the corresponding localized name. Alternatively, AecNameTranslatorDictRecordName returns the localized name corresponding to the dictionary record's alternate name." 

This class was added in ACA 2009.

Bound Spaces property

By Katsuaki Takamizawa

In AutoCAD Architecture(ACA),  entities such as polylines designed to form the boundary of an associative space must have their Bound Spaces property set to Yes before generating the space.

This value is stored in XData of the entity with Application Name AEC_XDTA_BOUND_SPACE and DXF code 1070. The entity can be a boundary if the value is 0, and can not if the value is 1. Initially, the value of always set to ‘No’. It is hardcode internally and no way to change the initial value. The AEC_XDTA_BOUND_SPACE XData entry is created when this property is accessed in Property Palette first time.