AutoCAD DevBlog

How to Create a Custom Toggle Button

By Madhukar Moogala

Here in this blog I have shown how to create a Ribbon Toggle Button using AutoCAD Ribbon Runtime API.

https://adndevblog.typepad.com/autocad/2015/03/how-to-use-toggle-button-ribbon-api.html

This code sample shows how can we register a custom ribbon control on AutoCAD Ribbon bar, to illustrate I created a simple toggle button, but however this logic can be extended to any other fancy controls.

Logic:

• Create a ResourceDictionary to hold resources and controls in XAML

• Implement the binding logic to manage the state of ToggleButton.

  • Create a SystemVariable to hold the state of ToggleButton

      public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
          {
              return IsChecked(value);
          }
      public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
          {
              bool isOn = (bool)value;
              if (isOn && !string.IsNullOrEmpty(OnMacro))
                  RunMacro(OnMacro);
              else if (!isOn && !string.IsNullOrEmpty(OffMacro))
                  RunMacro(OffMacro);
              return DataBindings.DoNothing;
          }
  
      

• Load this XAML in to AutoCAD Runtime, so this custom dictionary gets merged in to the AutoCAD main resource dictionary and you will see a unfied UX.

• If you are preparing CUIX using CUI editor, make sure, the key of ToggleButton should be same as the Id of ToggleButton in CUI. For example "XyzToggleButton"

	    string menuName = (string)Application.GetSystemVariable("MENUNAME");           
            CustomizationSection cs = new CustomizationSection(menuName + ".cuix");
            var ribbonRoot = cs.MenuGroup.RibbonRoot;
            var homeTab = ribbonRoot.FindTab("ID_TabHome");
            var elementId = "ID_TogglePanel";
            var ribbonPanelSourceReference = homeTab.Find(elementId);
            if(ribbonPanelSourceReference is null)
            {
                var panel = homeTab.AddNewPanel(elementId, "TogglePanel");
                var row = panel.AddNewRibbonRow();
                row.AddNewToggleButton("XyzToggleButton", "XYZSTATE\nToggle", null, RibbonButtonStyle.LargeWithText);
                cs.Save();
            }

<adw:RibbonToggleButton 
        x:Uid="RibbonToggleButton-Xyz" 
        x:Key="XyzToggleButton"
        Name="XYZ Toggle"
        Tag="XYZSTATE">
        <adw:RibbonToggleButton.IsCheckedBinding>
            <Binding Source="{x:Static acmgd:Application.UIBindings}" Path="SystemVariables[XYZSTATE].Value" Converter="{StaticResource XyzToggleButtonConverter}"/>
        </adw:RibbonToggleButton.IsCheckedBinding>
        <adw:RibbonToggleButton.Image>
            <BitmapImage x:Uid="BitmapImage_1" UriSource="Resources/Toggle.bmp" />
        </adw:RibbonToggleButton.Image>
        <adw:RibbonToggleButton.LargeImage>
            <BitmapImage x:Uid="BitmapImage_2" UriSource="Resources/Toggle.bmp"/>
        </adw:RibbonToggleButton.LargeImage>
    </adw:RibbonToggleButton>

Complete sample with source code is available at Github : SimpleToggleButton

How to Find if Drawing is a TrustedDWG

By Madhukar Moogala

TrustedDWG is a key function of AutoCAD and AutoCAD LT that analyses DWG files as they are being opened. The function checks to see if the DWG file was last saved with an Autodesk product or by a software developer who is licensed to use the RealDWG toolkit. If the file does not pass the TrustedDWG analysis, it will inform you in various ways that the DWG file may not be compatible, nor guarantee its integrity when used with AutoCAD or AutoCAD LT.

The visibility of these warnings is controlled by the DWGCHECK system variable. DWGCHECK is an integer variable, and is saved in the registry

When a drawing is not a TrustedDWG, and you open the drawing in AutoCAD or LT, you get this message or pop dialog.

Non Autodesk DWG. This DWG file was saved by a software application that was not developed or licensed by Autodesk. Autodesk cannot guarantee the application compatibility or integrity of this file.

Using API DwgFileWasSavedByAutodeskSoftware

        public void IsTrustedDWG()
        {
            Document doc = CoreApp.DocumentManager.MdiActiveDocument;
            if (doc == null) return;
            Editor ed = doc.Editor;
            var presult = ed.GetString(new PromptStringOptions("Enter Drawing File Path"));
            if (presult.Status != PromptStatus.OK) return;
            var db = HostApplicationServices.WorkingDatabase;
            Database sideDb = new Database(false, true);
            sideDb.ReadDwgFile(presult.StringResult, System.IO.FileShare.Read, true, null);
            HostApplicationServices.WorkingDatabase = sideDb;
            bool isTrustedDWG = sideDb.DwgFileWasSavedByAutodeskSoftware;
            if (isTrustedDWG)
            {
                ed.WriteMessage("Is Trusted DWG\n");
            }
            HostApplicationServices.WorkingDatabase = db;

        }

Embedding an image in a drawing

By Balaji Ramamoorthy

In this blog post we will look at creating a custom object derived from AcDbRasterImageDef that saves/loads the image data to/from the drawing using ATIL. This will ensure that your drawing is independent of the external image file and the image data will get loaded to the AcDbRasterImageDef if the arx is loaded in AutoCAD.

For other ways to embed an image in a drawing without having a dependency on an external image file, please refer to this blog post :

Embedding an image in a drawing

 // AcDbMyRasterImageDef.h 

 class  DLLIMPEXP AcDbMyRasterImageDef : 

 	public  AcDbRasterImageDef 

 {

 protected :

 	static  Adesk::UInt32 kCurrentVersionNumber;

 public :

 	ACRX_DECLARE_MEMBERS(AcDbMyRasterImageDef) ;

 	AcDbMyRasterImageDef () ;

 	virtual  ~AcDbMyRasterImageDef () ;

 	virtual  Acad::ErrorStatus 

 		dwgOutFields (AcDbDwgFiler *pFiler) const  ;

 	virtual  Acad::ErrorStatus dwgInFields 

 		(AcDbDwgFiler *pFiler) ;

 	//----- deepClone 

 	virtual  Acad::ErrorStatus 

 		subDeepClone (AcDbObject *pOwnerObject, 

 		AcDbObject *&pClonedObject, AcDbIdMapping &idMap, 

 		Adesk::Boolean isPrimary =true ) const  ;

 	//----- wblockClone 

 	virtual  Acad::ErrorStatus subWblockClone 

 		(AcRxObject *pOwnerObject, AcDbObject *&pClonedObject, 

 		AcDbIdMapping &idMap, Adesk::Boolean isPrimary =true )

 		const  ;

 	Acad::ErrorStatus 

 		setEmbeddedImage(const  ACHAR* imageFilePath);

 private :

 	void  *operator  new [](size_t) throw (){ return  (void *)0;}

     void  operator  delete [](void  *) {};

     void  *operator  new [](size_t , const  char  *, int  ) throw ()

 	{ return  (void *)0;}

 	Atil::Image *m_pAtilImage;

 };

 // AcDbMyRasterImageDef.cpp 

 AcDbMyRasterImageDef::AcDbMyRasterImageDef () 

 	: AcDbRasterImageDef () 

 {

 	m_pAtilImage = NULL;

 }

 AcDbMyRasterImageDef::~AcDbMyRasterImageDef() 

 {

 	if (m_pAtilImage != NULL)

 	{

 		delete  m_pAtilImage;

 		m_pAtilImage = NULL;

 	}

 }

 Acad::ErrorStatus AcDbMyRasterImageDef::dwgOutFields

 	(AcDbDwgFiler *pFiler) const  {

 	assertReadEnabled () ;

 	//----- Save parent class information first. 

 	Acad::ErrorStatus es =

 		AcDbRasterImageDef::dwgOutFields (pFiler) ;

 	if  ( es != Acad::eOk )

 		return  (es) ;

 	//----- Object version number needs to be saved first 

 	if  ( (es =pFiler->writeUInt32 

 		(AcDbMyRasterImageDef::kCurrentVersionNumber))

 		!= Acad::eOk )

 		return  (es) ;

 	if (m_pAtilImage)

 	{

 		Atil::Size size = m_pAtilImage->size();

 		Int32 width = size.width;

 		Int32 height = size.height;

 		pFiler->writeInt32(width);

 		pFiler->writeInt32(height);

 		// Write the image data on to the Atil image 

 		// using an Image Context 

 		Atil::Offset upperLeft(0,0);

 		Atil::ImageContext *pImgContext 

 			= m_pAtilImage->createContext(

 				Atil::ImageContext::kRead,

 				size,

 				upperLeft);

 		if  (pImgContext != NULL)

 		{

 			for  (int  xf=0;xf<width;xf++)

 			{

 				for  (int  yf=0;yf<height;yf++)

 				{

 					Atil::RgbColor p;

 					p = pImgContext->get32(xf, yf);

 					pFiler->writeInt32(p.packed);

 				}

 			}

 		}

 		pImgContext->flush();

 		delete  pImgContext;

 	}

 	return  (pFiler->filerStatus ()) ;

 }

 Acad::ErrorStatus AcDbMyRasterImageDef::dwgInFields

 	(AcDbDwgFiler *pFiler) 

 {

 	assertWriteEnabled () ;

 	Acad::ErrorStatus es =

 		AcDbRasterImageDef::dwgInFields (pFiler) ;

 	if  ( es != Acad::eOk )

 		return  (es) ;

 	Adesk::UInt32 version =0 ;

 	if  ( (es =pFiler->readUInt32 (&version)) 

 		!= Acad::eOk )

 		return  (es) ;

 	if  ( version > 

 		AcDbMyRasterImageDef::kCurrentVersionNumber)

 		return  (Acad::eMakeMeProxy) ;

 	Int32 width = 0;

 	Int32 height = 0;

 	pFiler->readInt32(&width);

 	pFiler->readInt32(&height);

 	// Create an Atil::Image. 

     // The AcDbRasterImageDef::setImage requires it 

     Atil::ImagePixel initialImage;

     initialImage.setToZero();

     initialImage.type 

 		= Atil::DataModelAttributes::kBgra;

     initialImage.value.rgba = 0xff000000;

     Atil::Size size(width, height);

     const  Atil::RgbModel *pDm 

 		= new  Atil::RgbModel(

         Atil::RgbModelAttributes::k4Channels,

         Atil::DataModelAttributes::kBlueGreenRedAlpha);

 	if (m_pAtilImage != NULL)

 	{

 		delete  m_pAtilImage;

 		m_pAtilImage = NULL;

 	}

     m_pAtilImage

 		= new  Atil::Image(size, pDm, initialImage);

 	// Write the image data on to the Atil image 

 	// using an Image Context 

 	Atil::Offset upperLeft(0,0);

 	Atil::ImageContext *pImgContext 

 		= m_pAtilImage->createContext(

 				Atil::ImageContext::kWrite,

 				size,

 				upperLeft);

 	if  (pImgContext != NULL)

 	{

 		for  (int  xf=0;xf<width;xf++)

 		{

 			for  (int  yf=0;yf<height;yf++)

 			{

 				Int32 value;

 				pFiler->readInt32(&value);

 				pImgContext->put32(xf, yf, value);

 			}

 		}

 	}

 	pImgContext->flush();

 	delete  pImgContext;

 	setImage (m_pAtilImage, NULL) ;

 	return  (pFiler->filerStatus ()) ;

 }

 //----- deepClone 

 Acad::ErrorStatus AcDbMyRasterImageDef::subDeepClone 

 	(AcDbObject *pOwnerObject, AcDbObject *&pClonedObject, 

 	AcDbIdMapping &idMap, Adesk::Boolean isPrimary) const  

 {

 	assertReadEnabled () ;

 	return  (AcDbRasterImageDef::subDeepClone 

 		(pOwnerObject, pClonedObject, idMap, isPrimary)) ;

 }

 //----- wblockClone 

 Acad::ErrorStatus AcDbMyRasterImageDef::subWblockClone 

 	(AcRxObject *pOwnerObject, AcDbObject *&pClonedObject, 

 	AcDbIdMapping &idMap, Adesk::Boolean isPrimary) const  

 {

 	assertReadEnabled () ;

 	return  (AcDbRasterImageDef::subWblockClone 

 		(pOwnerObject, pClonedObject, idMap, isPrimary)) ;

 }

 Acad::ErrorStatus  AcDbMyRasterImageDef::setEmbeddedImage

 							(const  ACHAR* imageFilePath)

 {

     AcString imagePath(imageFilePath);

     AcTcImage tc;

     tc.Load(imagePath);

     HBITMAP bmp=0;

     tc.GetHBITMAP(RGB(0xff,0xff,0xff),bmp);

     if  (bmp == NULL)

 		return  Acad::eFileNotFound;

     BITMAP _bmp={0};

     GetObject(bmp,sizeof  BITMAP,&_bmp);

     HDC hdcScr=GetDC(NULL);

     HDC    hdcMem=CreateCompatibleDC(hdcScr);

     SelectObject(hdcMem,bmp);

     Atil::ImagePixel initialImage;

     initialImage.setToZero();

 	initialImage.type = Atil::DataModelAttributes::kBgra;

     initialImage.value.rgba = 0xff000000;

     Atil::Size size(_bmp.bmWidth, _bmp.bmHeight);

     const  Atil::RgbModel *pDm = new  Atil::RgbModel(

         Atil::RgbModelAttributes::k4Channels,

         Atil::DataModelAttributes::kBlueGreenRedAlpha);

 	if (m_pAtilImage != NULL)

 	{

 		delete  m_pAtilImage;

 		m_pAtilImage = NULL;

 	}

     m_pAtilImage 

 		= new  Atil::Image(size, pDm, initialImage);

     Atil::Offset upperLeft(0,0);

     Atil::ImageContext *pImgContext

         = m_pAtilImage->createContext(

                     Atil::ImageContext::kWrite,

                     size,

                     upperLeft);

     if  (pImgContext != NULL)

     {

         for  (int  xf=0;xf<_bmp.bmWidth;xf++)

         {

             for  (int  yf=0;yf<_bmp.bmHeight;yf++)

             {

                 BYTE alpha= 0xff;

                 COLORREF pix=GetPixel(hdcMem,xf,yf);

                 BYTE rr = (pix&0xff);

                 BYTE gg = (pix>>8)&0xff;

                 BYTE bb = (pix>>16)&0xff;

                 Atil::RgbColor p;

                 p.set(rr, gg, bb, alpha);

                 pImgContext->put32(xf, yf, p);

             }

         }

     }

     pImgContext->flush();

     delete  pImgContext;

     bool  isImageValid = m_pAtilImage->isValid();

     assert(isImageValid);

     // Cleanup 

     DeleteDC(hdcMem);

     ReleaseDC(NULL,hdcScr);

     DeleteObject( bmp);

 	return  setImage (m_pAtilImage, NULL) ;

 }

 // Embed image command 

 static  void  AdskMyTestEmbedImage(void )

 {

 	AcDbMyRasterImageDef *pImageDef 

 		= new  AcDbMyRasterImageDef();

 	pImageDef->setEmbeddedImage(

 		ACRX_T("D:\\TestFiles\\MyTexture.jpg" ));

 	Acad::ErrorStatus es 

 		= InsertImageInDwg(pImageDef);

 	if (es != Acad::eOk)

 	{

 		delete  pImageDef;

 		return ;

 	}

 }

 static  Acad::ErrorStatus 

 	InsertImageInDwg(AcDbRasterImageDef *pImageDef)

 {

 	Acad::ErrorStatus es;

 	if (! pImageDef->isLoaded())

 	{

 		es = pImageDef->load();

 		if (es != Acad::eOk)

 			return  es;

 	}

 	AcApDocument *pActiveDoc 

 		= acDocManager->mdiActiveDocument();

 	AcDbDatabase *pDB = pActiveDoc->database();

 	// Get the image dictionary 

 	// Create it if not available already 

 	AcDbObjectId dictID

 	= AcDbRasterImageDef::imageDictionary(pDB);

 	if (dictID == AcDbObjectId::kNull)

 	{

 		es = AcDbRasterImageDef::createImageDictionary

 			(pDB, dictID);

 		if (es != Acad::eOk)

 			return  es;

 	}

 	AcDbDictionary* pDict;

 	es = acdbOpenObject(pDict, dictID, AcDb::kForWrite);

 	if (es != Acad::eOk)

 			return  es;

 	ACHAR *DICT_NAME = ACRX_T("RASTER_USING_BUFFER" );

 	BOOL bExist = pDict->has(DICT_NAME);

 	AcDbObjectId objID = AcDbObjectId::kNull;

 	if  (!bExist)

 	{

 		es = pDict->setAt(DICT_NAME, pImageDef, objID);

 		if (es != Acad::eOk)

 		{

 			pDict->close();

 			return  es;

 		}

 	}

 	else 

 	{

 		pDict->getAt(DICT_NAME,

 					(AcDbObject*&)pImageDef,

 					AcDb::kForWrite);

 		objID = pImageDef->objectId();

 	}

 	// close Dictionary and Definition. 

 	pDict->close();

 	pImageDef->close();

 	// Create a raster image using the RasterImage Def 

 	AcDbRasterImage* pImage = new  AcDbRasterImage;

 	es = pImage->setImageDefId(objID);

 	if  (es != Acad::eOk)

 	{

 		delete  pImage;

 		return  es;

 	}

 	// Add the raster image to the model space 

 	AcDbBlockTable* pBlockTable;

 	AcDbBlockTableRecord* pBTRecord;

 	es = acdbCurDwg()->getBlockTable(pBlockTable,

 							AcDb::kForRead);

 	assert(es == Acad::eOk);

 	es = pBlockTable->getAt(ACDB_MODEL_SPACE,

 							pBTRecord,

 							AcDb::kForWrite);

 	assert(es == Acad::eOk);

 	es = pBTRecord->appendAcDbEntity(pImage);

 	assert(es == Acad::eOk);

 	pBTRecord->close();

 	pBlockTable->close();

 	AcDbObjectId entID = pImage->objectId();

 	AcDbObjectPointer<AcDbRasterImageDefReactor>

 						rasterImageDefReactor;

 	rasterImageDefReactor.create();

 	es = rasterImageDefReactor->setOwnerId(

 							pImage->objectId());

 	if  (es == Acad::eOk)

 	{

 		AcDbObjectId defReactorId;

 		es = curDoc()->database()->addAcDbObject(

 				defReactorId,

 				rasterImageDefReactor.object());

 		if  (es == Acad::eOk)

 		{

 			pImage->setReactorId(defReactorId);

 			AcDbObjectPointer<AcDbRasterImageDef> 

 				rasterImagedef

 				(pImage->imageDefId(), AcDb::kForWrite);

 			if  (rasterImagedef.openStatus() == Acad::eOk)

 			{

 				rasterImagedef->addPersistentReactor

 						(defReactorId);

 			}

 		}

 	}

 	pImageDef->close();

 	pImage->close();

 	return  Acad::eOk;

 }

 virtual  AcRx::AppRetCode On_kInitAppMsg (void  *pkt) 

 {

 	AcRx::AppRetCode retCode =

 		AcRxArxApp::On_kInitAppMsg (pkt) ;

 	acrxDynamicLinker->loadModule

 		(L"acismobj20.dbx" ,true ); 

 	AcDbMyRasterImageDef::rxInit();

 	acrxBuildClassHierarchy();

 	return  (retCode) ;

 }

The sample project can be downloaded here :

Download EmbedImage

If you are looking to create an embedded raster image using the AutoCAD .Net API, a way to do it is by creating a managed wrapper for the custom object that we created. A .Net only solution is not possible at present since custom objects can only be created using C++. Also, ATIL is a C++ only library which we use in this case.

A way to access it in .Net is demonstrated in the following sample project. To try this sample, appload the .arx and netload the managed wrapper and custom .Net module. Run the "EmbedImageMgd" command.

Download CustomRasterImageDef

 

Update:

the broker code is fixed and updated to ObjectARX 2022, is posted in Github

https://github.com/MadhukarMoogala/EmbedRasterImage

 

AutoCAD .NET API: IExtensionApplication.Terminate () Not Called

Issue

I am creating and running an add-in application with the AutoCAD .NET API, but after applying the AutoCAD 2020.1 Update, IExtensionApplication.Terminate() is no longer called. 

The same is true for AutoCAD 2020.1.2 Update and AutoCAD 2021 including all updates.

Was there a specification change?

Solution

The new feature add-in Save to Autodesk Web and Mobile introduced in AutoCAD is conflicting with other plugins unloading mechanism.

We have two solutions to fix this -

If you are not using the SAVETOWEBMOBILE command, uninstalling the Save to Autodesk Web and Mobile add-in from the Windows Control Panel.

If you are using then enter the command SAVETOWEBMOBILE on AutoCAD Command Line Interface, it will pop up for update.

Please go ahead and update.

Is it possible to emulate command LIVESECTION with AutoCAD .NET AP

By Madhukar Moogala

This question is coming from one of our beloved Forum contributor and Mentor Alexander Rivilis

I am working with code which change color of Intersection Fill of Live Section. But although the color is changed, but this is not visible on the screen until I turn off and turn LIVESECTION:

I made slight changes to have this working

Note: To work this make sure LIVESECTION is not turned on

This code will change color of SECTION which converted to LIVESECTION

    public void SetSectionColor()
       {
          Document doc = Application.DocumentManager.MdiActiveDocument;
          if (doc == null) return;
          Editor ed = doc.Editor;

          PromptEntityOptions peo = 
                new PromptEntityOptions("\nSelect section: ");
          peo.SetRejectMessage("\nIt is not a section!");
          peo.AddAllowedClass(typeof(Section), true);
          PromptEntityResult per = ed.GetEntity(peo);
          if (per.Status != PromptStatus.OK) return;
          ObjectId idSecSets = ObjectId.Null;
          using (Transaction tr =
          doc.TransactionManager.StartOpenCloseTransaction())
          {
              Section sec =
              tr.GetObject(per.ObjectId,
                           OpenMode.ForWrite) as Section;
              sec.IsLiveSectionEnabled = true;                
              idSecSets = sec.Settings;
              tr.Commit();
          }
        using (Transaction tr = doc.TransactionManager
                                     .StartOpenCloseTransaction())
        {
          SectionSettings secset = tr.GetObject(idSecSets, 
                                   OpenMode.ForWrite) as SectionSettings;
          secset.CurrentSectionType = SectionType.LiveSection;
          Color clr = secset.Color(SectionType.LiveSection,
                                   SectionGeometry.IntersectionFill);
          ColorDialog cd = new ColorDialog
          {
              Color = clr
          };
          System.Windows.Forms.DialogResult dr = cd.ShowDialog();
          if (dr != System.Windows.Forms.DialogResult.OK) return;
          ed.WriteMessage("\nSelected Color: " + cd.Color.ToString());
          clr = cd.Color;
          // Define that color we change
          secset.SetColor(SectionType.LiveSection,
          SectionGeometry.IntersectionFill, clr);
          tr.Commit();
        }  
    }

Gif

How to Import Step (.stp) Files to AutoCAD

By Madhukar Moogala

Though there is not a direct API to import a Step file in to AutoCAD drawing unlike Body.AcisIn, we use Editor.Command API to invoke Import command

public void StepIn()
{
Document doc = Application.DocumentManager.MdiActiveDocument;
Editor ed = doc.Editor;            
ed.Command(new object[] { "_.IMPORT",
	                 "D:\\Work\\CADFiles\\Scafolf_Bracket_Asy.stp"});
}

Separate Solid Complexes into Separate Solids

By Madhukar Moogala

You can try using Solid3d.SeparateBody Method

This method separates the solid into a list of solids representing the additional disjoint volumes.
This solid is reduced to a solid with one volume.
The calling application is responsible for the resulting entities (either appending them to a database or deleting them when they are no longer needed).
When the calling application closes this Solid3d, the resulting solid will be committed to the database.
So, if the other solids are not appended to the database, you will lose some data.

To separate solids interactively in UI, refer this knowledge article.

Please note, you need a Solid which is logical one, but visually it appears to be two or more, i.e, you can move or copy multiple disjoint solids as one.
I have attached one drawing.

public static void SepSolid()
{
Document doc = Application.DocumentManager.MdiActiveDocument;
Database db = doc.Database;
Editor ed = doc.Editor;
PromptEntityOptions peo = new PromptEntityOptions("\nSelect solid:");
peo.SetRejectMessage("\nMust be a 3D solid.");
peo.AddAllowedClass(typeof(Solid3d), false);
PromptEntityResult per = ed.GetEntity(peo);
if (per.Status != PromptStatus.OK) return;
Transaction tr = db.TransactionManager.StartTransaction();
using (tr)
{
Solid3d sol = tr.GetObject(per.ObjectId, OpenMode.ForRead)
as Solid3d;
if (sol != null)
{
sol.UpgradeOpen();
//The solid must have multiple lumps
Solid3d[] disjointSolids = sol.SeparateBody();
foreach (Solid3d v in disjointSolids)
{
    Vector3d dispVector = Point3d.Origin.GetVectorTo(v.MassProperties.Centroid);
    v.TransformBy(Matrix3d.Displacement(dispVector));
    v.ColorIndex = 3;
    using (OpenCloseTransaction oct = new OpenCloseTransaction())
    {
        // Open the Block table for read
        BlockTable acBlkTbl;
        acBlkTbl = oct.GetObject(db.BlockTableId,
                                            OpenMode.ForRead) as BlockTable;
        // Open the Block table record Model space for write
        BlockTableRecord acBlkTblRec;
        acBlkTblRec = oct.GetObject(acBlkTbl[BlockTableRecord.ModelSpace],
                                                OpenMode.ForWrite) as BlockTableRecord;
        acBlkTblRec.AppendEntity(v);
        oct.AddNewlyCreatedDBObject(v, true);
        // Save the new objects to the database
        oct.Commit();
    }
}
}
tr.Commit();

}
}

Demo

Redefining Help Shortcut Key with CUI API

By Madhukar Moogala

There is common need to change shortcut assigned for Help from F1 to some other key, if you look at keypad layout F1 and ESC keys are adjacent to each other, designers often use ESC to cancel running command, or deselect the objects from selection. As the F1 key is adjacent chances of pressing this key accidently is quite high, F1 pops up a Help window, which in said cases is counter productive.

To avoid this, we can assign F1 to a Cancel command and CTRL+ALT+F1 to Help.

 public static void RedefineHelpKey()
{
string mainCuiFile = (string)Application.GetSystemVariable("MENUNAME");
mainCuiFile += ".cuix";
var doc = Application.DocumentManager.MdiActiveDocument;
var db = doc.Database;
var ed = doc.Editor;
CustomizationSection cs = new CustomizationSection(mainCuiFile);
AcceleratorCollection acCollection = cs.MenuGroup.Accelerators;

//This is to get Help menu macro.
var macros = from MacroGroup mg in cs.MenuGroup.MacroGroups
        from MenuMacro mm in mg.MenuMacros
        where mm.ElementID.Equals("ID_Help") || mm.ElementID.Equals("ID_Cancel")
        select mm;
foreach(MenuMacro menuMacro in macros)
{
if (menuMacro.ElementID.Equals("ID_Help"))
{

MenuAccelerator macHelp = new MenuAccelerator(menuMacro,
                            /*ShortCutKeyCombination*/"CTRL+ALT+H",
                                cs.MenuGroup);
if (acCollection.Contains(macHelp))
{
    ed.WriteMessage($"\n True MenuAccelerator Contains.");
}
else
{
    acCollection.Add(macHelp);
}
                    

}
if (menuMacro.ElementID.Equals("ID_Cancel"))
{
//Assigning Cancel to F1
MenuAccelerator macCancel = new MenuAccelerator(menuMacro,
                                        /*ShortCutKeyCombination*/"F1",
                                        cs.MenuGroup);
if (acCollection.Contains(macCancel))
{
    ed.WriteMessage($"\n True MenuAccelerator Contains.");
}
else
{
    acCollection.Add(macCancel);
}                 

}
}


//This will create backup CUIX!
cs.Save(true);
            

}            	

Note:

If the changes don't reflect immediately, a restart of AutoCAD is needed, this is because, we are attempting to change the main CUI.

A utility function to list shortcut keys we have redefined

[CommandMethod("LISTMAC")]
public static void ListMenuAccelerators()
{
var doc = Application.DocumentManager.MdiActiveDocument;
var db = doc.Database;
var ed = doc.Editor;
string mainCuiFile = (string)Application.GetSystemVariable("MENUNAME");
mainCuiFile += ".cuix";
CustomizationSection cs = new CustomizationSection(mainCuiFile);
AcceleratorCollection acCollection = cs.MenuGroup.Accelerators;
var q = from MenuAccelerator menuAcltr in acCollection
        where menuAcltr.Name.Contains("Help") || 
	      menuAcltr.Name.Contains("Cancel")
        select menuAcltr;
if (q != null && q.ToList().Count > 0)
{


    foreach (var m in q.ToList())
    {
        ed.WriteMessage($"\n Name: {m.Name}\n\tAccerlerator ShortcutKey: {m.AcceleratorShortcutKey}");
    }

                
}
}

Demo

Editor.Snap Method to change the snap mode of point

By Deepak Nadig

In your workflow of using Editor.GetEntity you may sometimes want to retrieve
all the co-ordinates of pickpoint used to select the entity.

For example consider the following case by constructing a circle at point (0,0,5) and radius 5 on WCS XY-plane with top view.
On selecting a point on circle using Editor.GetEntity, PromptEntityResult.PickedPoint returns : (3.50064192661003 , 3.35618169844321 , 0)

To get all the co-ordinates,it may be useful to change the point to nearest snap mode using Editor.Snap that returns the Z co-ordinate as well. 

Code:

[CommandMethod("getEntityPickPoint")]
public static void getEntityPickPoint()
{
    Document doc = Application.DocumentManager.MdiActiveDocument;
    Database db = doc.Database;
    Editor ed = doc.Editor;

    PromptEntityOptions peo = new PromptEntityOptions("\nSelect Entity");
    PromptEntityResult per = ed.GetEntity(peo);
    if (per.Status == PromptStatus.OK)
    {
        Point3d pickedPoint = per.PickedPoint;
        Point3d pickedPtOsnap = ed.Snap("_near", pickedPoint);

        ed.WriteMessage("\n Selected pick point: {0}", pickedPoint.ToString());
        ed.WriteMessage("\n Selected Picked Point Osnap near: {0}", pickedPtOsnap);
    }
}

Result:

Command: GETENTITYPICKPOINT
Select Entity:
Selected pick point: (3.50064192661003,3.35618169844321,0)
Selected Picked Point Osnap near: (3.60921996485993,3.46027907043009,5)

 

More about object osnaps :
https://knowledge.autodesk.com/de/search-result/caas/CloudHelp/cloudhelp/2017/DEU/AutoCAD-AutoLISP/files/GUID-4EEE5488-01D8-454F-9386-79E493E55D6E-htm.html

RealDWG: Extracting Color Information from Solids

By Madhukar Moogala

Using RealDWG SDK,  following code extracts the color information of 3d solids in AutoCAD drawings.

To extract color from sub elements of Solid we will use BREP api, you need to refer AcDbMgdBrep.dll module from sdk.

You can use – Testdrawing 

        private void DumpSolid3d(Transaction tr, ObjectId solId)
        {
            using (OpenCloseTransaction oct = new OpenCloseTransaction())
            {
                Solid3d solid = tr.GetObject(solId, OpenMode.ForRead) as Solid3d;

                ObjectId[] ids = new ObjectId[] { solid.ObjectId };

                FullSubentityPath path =
                  new FullSubentityPath(
                    ids,
                    new SubentityId(SubentityType.Null, IntPtr.Zero)
                  );

                // For storing SubentityIds of cylindrical faces

                List subentIds = new List();

                using (Brep brep = new Brep(path))
                {
                    foreach (Autodesk.AutoCAD.BoundaryRepresentation.Face face in brep.Faces)
                    {
                        /*
                        // How to get colors of only cylinderical
                         
                        Autodesk.AutoCAD.Geometry.Surface surf = face.Surface;
                        var ebSurf = surf as Autodesk.AutoCAD.Geometry.ExternalBoundedSurface;
                        if (ebSurf != null && ebSurf.IsCylinder)
                        {
                            subentIds.Add(face.SubentityPath.SubentId);
                        }
                        
                         */
                        subentIds.Add(face.SubentityPath.SubentId);
                    }
                }

                if (subentIds.Count > 0)
                {
                    List> ColorSubEntityPairs
		     = GetColors(solid, subentIds);
                    foreach (var item in ColorSubEntityPairs)
                    {
                        var color = item.Key as Color;
                        SubentityId id = item.Value;
                        Console.WriteLine($"\nColor - {color.ColorNameForDisplay}
					 | SubEntity Index - {id.IndexPtr}");
                    }
                }
               oct.Commit();
            }
        }

        List< KeyValuePair< Color,SubentityId >> 
	GetColors(Solid3d solid, List subentIds)
        {
            List < KeyValuePair < Color, SubentityId >> ColorSubEntityPairs
		= new List< KeyValuePair >();
            foreach (SubentityId subentId in subentIds)
            {
                try
                {
                    Color col = solid.GetSubentityColor(subentId);
                    ColorSubEntityPairs.Add(new KeyValuePair(col, subentId));
                }
                catch (Autodesk.AutoCAD.BoundaryRepresentation.Exception ex)
                {
                    if(ex.ErrorStatus == ErrorStatus.NotApplicable)
                    continue;
                }
                

                
            }
            return ColorSubEntityPairs;
        }

Output

SolidColors.exe "C:\rd2020\RealDWG 2020\Samples\SolidColors\testBox.dwg"

BlockTable -*Model_Space

Color - 250 | SubEntity Index - 1

Color - 250 | SubEntity Index - 2

Color - 250 | SubEntity Index - 3

Color - 250 | SubEntity Index - 4

Color - 250 | SubEntity Index - 5

Color - 250 | SubEntity Index - 6

Color - 250 | SubEntity Index - 7

Color - 50 | SubEntity Index - 8

Color - 50 | SubEntity Index - 9

Color - 50 | SubEntity Index - 10

Color - 50 | SubEntity Index - 11

Color - 50 | SubEntity Index - 12

Color - 50 | SubEntity Index - 13

BlockTable -*Paper_Space

BlockTable -*Paper_Space0

Source code