Merge pull request #576 from DomCR/issue-575_write-group

DomCR · web-flow · commit e0bc2deb0475 · 2025-03-12T18:27:14.000+01:00
Write Group
diff --git a/src/ACadSharp.Tests/IO/WriterSingleObjectTests.cs b/src/ACadSharp.Tests/IO/WriterSingleObjectTests.cs
@@ -672,11 +672,8 @@ public void CreateGroup()
 
 				Group group = new Group();
 				group.Name = "MyGroup";
-				group.Entities.Add(circle.Handle, circle);
-				circle.AddReactor(group);
-				group.Entities.Add(line.Handle, line);
-				line.AddReactor(group);
-				group.Selectable = true;
+				group.Add( circle);
+				group.Add(line);
 
 				this.Document.Groups.Add(group);
 
diff --git a/src/ACadSharp.Tests/Objects/GroupTests.cs b/src/ACadSharp.Tests/Objects/GroupTests.cs
@@ -0,0 +1,52 @@
+﻿using ACadSharp.Entities;
+using ACadSharp.Objects;
+using System;
+using Xunit;
+
+namespace ACadSharp.Tests.Objects
+{
+	public class GroupTests : NonGraphicalObjectTests<Group>
+	{
+		[Fact]
+		public void AddTest()
+		{
+			CadDocument doc = new CadDocument();
+			Line l = new Line();
+			var group = new Group();
+
+			group.Add(l);
+
+			Assert.Contains(group, l.Reactors);
+			Assert.Throws<InvalidOperationException>(() => doc.Groups.Add(group));
+
+			group.Clear();
+
+			Assert.DoesNotContain(group, l.Reactors);
+
+			doc.Groups.Add(group);
+			Assert.Contains(group, doc.Groups);
+
+			Assert.Throws<InvalidOperationException>(() => group.Add(l));
+
+			doc.Entities.Add(l);
+			group.Add(l);
+
+			Assert.Contains(l, group.Entities);
+		}
+
+		[Fact]
+		public void IsUnnamedTest()
+		{
+			var group = new Group();
+
+			Assert.True(group.IsUnnamed);
+			group.Name = null;
+			Assert.True(group.IsUnnamed);
+			group.Name = " ";
+			Assert.True(group.IsUnnamed);
+
+			group.Name = "my_group";
+			Assert.False(group.IsUnnamed);
+		}
+	}
+}
diff --git a/src/ACadSharp/CadDocument.cs b/src/ACadSharp/CadDocument.cs
@@ -250,7 +250,7 @@ public bool TryGetCadObject<T>(ulong handle, out T cadObject)
 		}
 
 		/// <summary>
-		/// 
+		/// Create the default entries and objects for the <see cref="CadDocument"/>.
 		/// </summary>
 		public void CreateDefaults()
 		{
diff --git a/src/ACadSharp/CadObject.cs b/src/ACadSharp/CadObject.cs
@@ -59,14 +59,7 @@ public IEnumerable<CadObject> Reactors
 		{
 			get
 			{
-				if (this.Document == null)
-				{
-					return Enumerable.Empty<CadObject>();
-				}
-				else
-				{
-					return this._reactors;
-				}
+				return this._reactors;
 			}
 		}
 
@@ -174,10 +167,20 @@ public void CleanReactors()
 		/// <remarks>
 		/// The <see cref="CadObject"/> and its reactors must be in the same <see cref="CadDocument"/> to be valid.
 		/// </remarks>
-		/// <param name="cadObject"></param>
-		public void AddReactor(CadObject cadObject)
+		/// <param name="reactor"></param>
+		public void AddReactor(CadObject reactor)
+		{
+			this._reactors.Add(reactor);
+		}
+
+		/// <summary>
+		/// Remove a reactor linked to this object.
+		/// </summary>
+		/// <param name="reactor"></param>
+		/// <returns></returns>
+		public bool RemoveReactor(CadObject reactor)
 		{
-			this._reactors.Add(cadObject);
+			return this._reactors.Remove(reactor);
 		}
 
 		internal virtual void AssignDocument(CadDocument doc)
diff --git a/src/ACadSharp/DxfFileToken.cs b/src/ACadSharp/DxfFileToken.cs
@@ -131,6 +131,7 @@ public static class DxfFileToken
 		public const string ObjectBlockVisibilityParameter = "BLOCKVISIBILITYPARAMETER";
 		public const string ObjectTableContent = "TABLECONTENT";
 		public const string ObjectGeoData = "GEODATA";
+		public const string ObjectGroup = "GROUP";
 
 		#endregion
 	}
diff --git a/src/ACadSharp/IO/DWG/DwgStreamReaders/DwgObjectReader.cs b/src/ACadSharp/IO/DWG/DwgStreamReaders/DwgObjectReader.cs
@@ -5015,15 +5015,15 @@ private CadTemplate readGeoData()
 		private CadTemplate readGroup()
 		{
 			Group group = new Group();
-			DwgGroupTemplate template = new DwgGroupTemplate(group);
+			CadGroupTemplate template = new CadGroupTemplate(group);
 
 			this.readCommonNonEntityData(template);
 
 			//Str TV name of group
 			group.Description = this._textReader.ReadVariableText();
 
 			//Unnamed BS 1 if group has no name
-			group.IsUnnamed = this._objectReader.ReadBitShort() > 0;
+			bool isUnnamed = this._objectReader.ReadBitShort() > 0;
 			//Selectable BS 1 if group selectable
 			group.Selectable = this._objectReader.ReadBitShort() > 0;
 
diff --git a/src/ACadSharp/IO/DWG/DwgStreamWriters/DwgObjectWriter.Objects.cs b/src/ACadSharp/IO/DWG/DwgStreamWriters/DwgObjectWriter.Objects.cs
@@ -356,11 +356,11 @@ private void writeGroup(Group group)
 			this._writer.WriteBitShort((short)(group.Selectable ? 1 : 0));
 
 			//Numhandles BL # objhandles in this group
-			this._writer.WriteBitLong(group.Entities.Count);
-			foreach (ulong h in group.Entities.Keys)
+			this._writer.WriteBitLong(group.Entities.Count());
+			foreach (var e in group.Entities)
 			{
 				//the entries in the group(hard pointer)
-				this._writer.HandleReference(DwgReferenceType.HardPointer, h);
+				this._writer.HandleReference(DwgReferenceType.HardPointer, e);
 			}
 		}
 
diff --git a/src/ACadSharp/IO/DXF/DxfStreamReader/DxfObjectsSectionReader.cs b/src/ACadSharp/IO/DXF/DxfStreamReader/DxfObjectsSectionReader.cs
@@ -70,6 +70,8 @@ private CadTemplate readObject()
 					return this.readObjectCodes<PdfUnderlayDefinition>(new CadNonGraphicalObjectTemplate(new PdfUnderlayDefinition()), this.readObjectSubclassMap);
 				case DxfFileToken.ObjectSortEntsTable:
 					return this.readSortentsTable();
+				case DxfFileToken.ObjectGroup:
+					return this.readObjectCodes<Group>(new CadGroupTemplate(), this.readGroup);
 				case DxfFileToken.ObjectGeoData:
 					return this.readObjectCodes<GeoData>(new CadGeoDataTemplate(), this.readGeoData);
 				case DxfFileToken.ObjectScale:
@@ -236,6 +238,22 @@ private bool readLayout(CadTemplate template, DxfMap map)
 			}
 		}
 
+		private bool readGroup(CadTemplate template, DxfMap map)
+		{
+			CadGroupTemplate tmp = template as CadGroupTemplate;
+
+			switch (this._reader.Code)
+			{
+				case 70:
+					return true;
+				case 340:
+					tmp.Handles.Add(this._reader.ValueAsHandle);
+					return true;
+				default:
+					return this.tryAssignCurrentValue(template.CadObject, map.SubClasses[template.CadObject.SubclassMarker]);
+			}
+		}
+
 		private bool readGeoData(CadTemplate template, DxfMap map)
 		{
 			CadGeoDataTemplate tmp = template as CadGeoDataTemplate;
diff --git a/src/ACadSharp/IO/DXF/DxfStreamWriter/DxfObjectsSectionWriter.cs b/src/ACadSharp/IO/DXF/DxfStreamWriter/DxfObjectsSectionWriter.cs
@@ -362,7 +362,7 @@ protected void writeGroup(Group group)
 			this._writer.Write(70, group.IsUnnamed ? (short)1 : (short)0);
 			this._writer.Write(71, group.Selectable ? (short)1 : (short)0);
 
-			foreach (Entity entity in group.Entities.Values)
+			foreach (Entity entity in group.Entities)
 			{
 				this._writer.WriteHandle(340, entity);
 			}
diff --git a/src/ACadSharp/IO/Templates/CadGroupTemplate.cs b/src/ACadSharp/IO/Templates/CadGroupTemplate.cs
@@ -4,11 +4,13 @@
 
 namespace ACadSharp.IO.Templates
 {
-	internal class DwgGroupTemplate : CadTemplate<Group>
+	internal class CadGroupTemplate : CadTemplate<Group>
 	{
 		public List<ulong> Handles { get; set; } = new List<ulong>();
 
-		public DwgGroupTemplate(Group group) : base(group) { }
+		public CadGroupTemplate() : base(new Group()) { }
+
+		public CadGroupTemplate(Group group) : base(group) { }
 
 		public override void Build(CadDocumentBuilder builder)
 		{
@@ -18,7 +20,7 @@ public override void Build(CadDocumentBuilder builder)
 			{
 				if (builder.TryGetCadObject<Entity>(handle, out Entity e))
 				{
-					this.CadObject.Entities.Add(handle, e);
+					this.CadObject.Add(e);
 				}
 				else
 				{
diff --git a/src/ACadSharp/IObservableCadCollection.cs b/src/ACadSharp/IObservableCadCollection.cs
@@ -11,12 +11,12 @@ public interface IObservableCadCollection<T> : IEnumerable<T>
 		where T : CadObject
 	{
 		/// <summary>
-		/// Event triggerrs when an object is added to the collection
+		/// Event triggerrs when an object is added to the collection.
 		/// </summary>
 		event EventHandler<CollectionChangedEventArgs> OnAdd;
 
 		/// <summary>
-		/// Event triggerrs when an object is removed from the collection
+		/// Event triggerrs when an object is removed from the collection.
 		/// </summary>
 		event EventHandler<CollectionChangedEventArgs> OnRemove;
 	}
diff --git a/src/ACadSharp/Objects/Collections/GroupCollection.cs b/src/ACadSharp/Objects/Collections/GroupCollection.cs
@@ -1,10 +1,75 @@
-﻿namespace ACadSharp.Objects.Collections
+﻿using ACadSharp.Entities;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.RegularExpressions;
+
+namespace ACadSharp.Objects.Collections
 {
 	public class GroupCollection : ObjectDictionaryCollection<Group>
 	{
 		public GroupCollection(CadDictionary dictionary) : base(dictionary)
 		{
 			this._dictionary = dictionary;
 		}
+
+		/// <inheritdoc/>
+		public override void Add(Group entry)
+		{
+			foreach (var e in entry.Entities)
+			{
+				if (e.Document != this._dictionary.Document)
+				{
+					throw new InvalidOperationException("Entities in a group must be in the same document as the group being added.");
+				}
+			}
+
+			if (entry.IsUnnamed)
+			{
+				int next = 0;
+				foreach (Group group in this.Where(g => g.IsUnnamed))
+				{
+					var num = int.Parse(Regex.Match(group.Name, @"\d+").Value);
+					if (num > next)
+					{
+						next = num;
+					}
+				}
+
+				entry.Name = $"*D{next++}";
+			}
+
+			base.Add(entry);
+		}
+
+		/// <summary>
+		/// Creates a group with a collection of entities.
+		/// </summary>
+		/// <remarks>
+		/// The entities must be assigned to the owner <see cref="CadDocument"/> of this collection.
+		/// </remarks>
+		/// <param name="entities"></param>
+		/// <returns></returns>
+		public Group CreateGroup(IEnumerable<Entity> entities)
+		{
+			return this.CreateGroup(string.Empty, entities);
+		}
+
+		/// <summary>
+		/// Creates a group with a collection of entities.
+		/// </summary>
+		/// <remarks>
+		/// The entities must be assigned to the owner <see cref="CadDocument"/> of this collection.
+		/// </remarks>
+		/// <param name="name"></param>
+		/// <param name="entities"></param>
+		/// <returns></returns>
+		public Group CreateGroup(string name, IEnumerable<Entity> entities)
+		{
+			var group = new Group(name);
+			this.Add(group);
+			group.AddRange(entities);
+			return group;
+		}
 	}
 }
diff --git a/src/ACadSharp/Objects/Group.cs b/src/ACadSharp/Objects/Group.cs
diff --git a/src/CodeMaid.config b/src/CodeMaid.config

Original file line number	Diff line number	Diff line change
`@@ -250,7 +250,7 @@ public bool TryGetCadObject<T>(ulong handle, out T cadObject)`
`250`	`250`	`}`
`251`	`251`
`252`	`252`	`/// <summary>`
`253`		`- ///`
	`253`	`+ /// Create the default entries and objects for the <see cref="CadDocument"/>.`
`254`	`254`	`/// </summary>`
`255`	`255`	`public void CreateDefaults()`
`256`	`256`	`{`
Original file line number	Diff line number	Diff line change
`@@ -131,6 +131,7 @@ public static class DxfFileToken`
`131`	`131`	`public const string ObjectBlockVisibilityParameter = "BLOCKVISIBILITYPARAMETER";`
`132`	`132`	`public const string ObjectTableContent = "TABLECONTENT";`
`133`	`133`	`public const string ObjectGeoData = "GEODATA";`
	`134`	`+ public const string ObjectGroup = "GROUP";`
`134`	`135`
`135`	`136`	`#endregion`
`136`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -356,11 +356,11 @@ private void writeGroup(Group group)`
`356`	`356`	`this._writer.WriteBitShort((short)(group.Selectable ? 1 : 0));`
`357`	`357`
`358`	`358`	`//Numhandles BL # objhandles in this group`
`359`		`- this._writer.WriteBitLong(group.Entities.Count);`
`360`		`- foreach (ulong h in group.Entities.Keys)`
	`359`	`+ this._writer.WriteBitLong(group.Entities.Count());`
	`360`	`+ foreach (var e in group.Entities)`
`361`	`361`	`{`
`362`	`362`	`//the entries in the group(hard pointer)`
`363`		`- this._writer.HandleReference(DwgReferenceType.HardPointer, h);`
	`363`	`+ this._writer.HandleReference(DwgReferenceType.HardPointer, e);`
`364`	`364`	`}`
`365`	`365`	`}`
`366`	`366`
Original file line number	Diff line number	Diff line change
`@@ -362,7 +362,7 @@ protected void writeGroup(Group group)`
`362`	`362`	`this._writer.Write(70, group.IsUnnamed ? (short)1 : (short)0);`
`363`	`363`	`this._writer.Write(71, group.Selectable ? (short)1 : (short)0);`
`364`	`364`
`365`		`- foreach (Entity entity in group.Entities.Values)`
	`365`	`+ foreach (Entity entity in group.Entities)`
`366`	`366`	`{`
`367`	`367`	`this._writer.WriteHandle(340, entity);`
`368`	`368`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,13 @@`
`4`	`4`
`5`	`5`	`namespace ACadSharp.IO.Templates`
`6`	`6`	`{`
`7`		`- internal class DwgGroupTemplate : CadTemplate<Group>`
	`7`	`+ internal class CadGroupTemplate : CadTemplate<Group>`
`8`	`8`	`{`
`9`	`9`	`public List<ulong> Handles { get; set; } = new List<ulong>();`
`10`	`10`
`11`		`- public DwgGroupTemplate(Group group) : base(group) { }`
	`11`	`+ public CadGroupTemplate() : base(new Group()) { }`
	`12`	`+`
	`13`	`+ public CadGroupTemplate(Group group) : base(group) { }`
`12`	`14`
`13`	`15`	`public override void Build(CadDocumentBuilder builder)`
`14`	`16`	`{`
`@@ -18,7 +20,7 @@ public override void Build(CadDocumentBuilder builder)`
`18`	`20`	`{`
`19`	`21`	`if (builder.TryGetCadObject<Entity>(handle, out Entity e))`
`20`	`22`	`{`
`21`		`- this.CadObject.Entities.Add(handle, e);`
	`23`	`+ this.CadObject.Add(e);`
`22`	`24`	`}`
`23`	`25`	`else`
`24`	`26`	`{`