Merge pull request #481 from DomCR/viewport-scale-factor

Viewport scale factor

src/ACadSharp/CadDocument.cs

@@ -249,7 +249,7 @@ public void CreateDefaults()
 			this.Header = new CadHeader(this);
 			this.SummaryInfo = new CadSummaryInfo();
 
-			//The order of the elements is rellevant for the handles assignation
+			//The order of the elements is relevant for the handles assignation
 
 			//Initialize tables
 			this.BlockRecords ??= new BlockRecordsTable(this);

src/ACadSharp/Entities/Viewport.cs

@@ -56,6 +56,9 @@ public class Viewport : Entity
 		/// <summary>
 		/// Viewport ID.
 		/// </summary>
+		/// <remarks>
+		/// The first value for a PaperSpace will represent the paper image in the screen.
+		/// </remarks>
 		[DxfCodeValue(69)]
 		public short Id
 		{
@@ -326,7 +329,7 @@ public double ViewWidth
 		//Soft pointer reference to viewport object (for layer VP property override)
 
 		/// <summary>
-		/// 
+		/// Scale assigned for this viewport.
 		/// </summary>
 		public Scale Scale
 		{
@@ -348,6 +351,28 @@ public Scale Scale
 			}
 		}
 
+		/// <summary>
+		/// Scale factor applied in this viewport.
+		/// </summary>
+		/// <remarks>
+		/// Represents the scale applied to all the entities in the model when are visualized in the paper.
+		/// </remarks>
+		public double ScaleFactor => 1 / (this.ViewHeight / this.Height);
+
+		/// <summary>
+		/// Flag that set for those viewports that represent the paper in the view.
+		/// </summary>
+		/// <remarks>
+		/// A paper viewport is only for boundaries only, does not visualize anything.
+		/// </remarks>
+		public bool RepresentsPaper
+		{
+			get
+			{
+				return this.Id == PaperViewId;
+			}
+		}
+
 		private Scale _scale;
 
 		/// <inheritdoc/>
@@ -368,7 +393,10 @@ public override BoundingBox GetBoundingBox()
 			return new BoundingBox(min, max);
 		}
 
-		/// <inheritdoc/>
+		/// <summary>
+		/// Gets the bounding box of this viewport in the model space.
+		/// </summary>
+		/// <returns></returns>
 		public BoundingBox GetModelBoundingBox()
 		{
 			XYZ min = new XYZ(this.ViewCenter.X - this.ViewWidth / 2, this.ViewCenter.Y - this.ViewHeight / 2, 0);

src/ACadSharp/Objects/PlotSettings.cs

@@ -159,7 +159,7 @@ public double DenominatorScale
 		public PlotPaperUnits PaperUnits { get; set; } = PlotPaperUnits.Milimeters;
 
 		/// <summary>
-		/// Plot paper units.
+		/// Plot paper rotation.
 		/// </summary>
 		[DxfCodeValue(73)]
 		public PlotRotation PaperRotation { get; set; }

src/ACadSharp/Objects/Scale.cs

@@ -1,4 +1,5 @@
 using ACadSharp.Attributes;
+using CSMath;
 
 namespace ACadSharp.Objects
 {
@@ -13,6 +14,8 @@ namespace ACadSharp.Objects
 	[DxfSubClass(DxfSubclassMarker.Scale)]
 	public class Scale : NonGraphicalObject
 	{
+		public static Scale Default { get { return new Scale { Name = "1:1", PaperUnits = 1.0, DrawingUnits = 1.0, IsUnitScale = true }; } }
+
 		/// <inheritdoc/>
 		public override ObjectType ObjectType { get { return ObjectType.UNLISTED; } }
 
@@ -56,10 +59,30 @@ public override string Name
 		[DxfCodeValue(290)]
 		public bool IsUnitScale { get; set; }
 
+		public double ScaleFactor => this.PaperUnits / this.DrawingUnits;
+
 		public Scale() { }
 
 		public Scale(string name) : base(name)
 		{
 		}
+
+		public double ApplyTo(double value)
+		{
+			return value * ScaleFactor;
+		}
+
+		public T ApplyTo<T>(T value)
+			where T : IVector, new()
+		{
+			T result = new();
+
+			for (int i = 0; i < value.Dimension; i++)
+			{
+				result[i] = ApplyTo(value[i]);
+			}
+
+			return result;
+		}
 	}
 }

src/ACadSharp/Tables/BlockRecord.cs

@@ -88,19 +88,19 @@ public static BlockRecord PaperSpace
 		public new BlockTypeFlags Flags { get { return this.BlockEntity.Flags; } set { this.BlockEntity.Flags = value; } }
 
 		/// <summary>
-		/// Specifies whether the block can be exploded
+		/// Specifies whether the block can be exploded.
 		/// </summary>
 		[DxfCodeValue(DxfReferenceType.Optional, 280)]
 		public bool IsExplodable { get; set; }
 
 		/// <summary>
-		/// Specifies the scaling allowed for the block
+		/// Specifies the scaling allowed for the block.
 		/// </summary>
 		[DxfCodeValue(DxfReferenceType.Optional, 281)]
 		public bool CanScale { get; set; } = true;
 
 		/// <summary>
-		/// DXF: Binary data for bitmap preview
+		/// DXF: Binary data for bitmap preview.
 		/// </summary>
 		/// <remarks>
 		/// Optional
@@ -109,7 +109,7 @@ public static BlockRecord PaperSpace
 		public byte[] Preview { get; set; }
 
 		/// <summary>
-		/// Associated Layout
+		/// Associated Layout.
 		/// </summary>
 		[DxfCodeValue(DxfReferenceType.Handle, 340)]
 		public Layout Layout
@@ -144,7 +144,7 @@ public bool HasAttributes
 		}
 
 		/// <summary>
-		/// Viewports attached to this block
+		/// ViewPorts attached to this block
 		/// </summary>
 		public IEnumerable<Viewport> Viewports
 		{

src/ACadSharp/Types/Lineweight.cs → src/ACadSharp/Types/LineWeightType.cs

@@ -5,116 +5,116 @@ public enum LineweightType : short
 		ByDIPs = -4,
 
 		/// <summary>
-		/// Default lineweight.
+		/// Default line weight.
 		/// </summary>
 		Default = -3,
 
 		/// <summary>
-		/// Lineweight defined by block.
+		/// Line weight defined by block.
 		/// </summary>
 		ByBlock = -2,
 
 		/// <summary>
-		/// Lineweight defined by layer.
+		/// Line weight defined by layer.
 		/// </summary>
 		ByLayer = -1,
 
 		/// <summary>
-		/// Lineweight value 0.00 mm (hairline).
+		/// Line weight value 0.00 mm (hairline).
 		/// </summary>
 		W0 = 0,
 
 		/// <summary>
-		/// Lineweight value 0.05 mm.
+		/// Line weight value 0.05 mm.
 		/// </summary>
 		W5 = 5,
 
 		/// <summary>
-		/// Lineweight value 0.09 mm.
+		/// Line weight value 0.09 mm.
 		/// </summary>
 		W9 = 9,
 		/// <summary>
-		/// Lineweight value 0.13 mm.
+		/// Line weight value 0.13 mm.
 		/// </summary>
 		W13 = 13,
 		/// <summary>
-		/// Lineweight value 0.15 mm.
+		/// Line weight value 0.15 mm.
 		/// </summary>
 		W15 = 15,
 		/// <summary>
-		/// Lineweight value 0.18 mm.
+		/// Line weight value 0.18 mm.
 		/// </summary>
 		W18 = 18,
 		/// <summary>
-		/// Lineweight value 0.20 mm.
+		/// Line weight value 0.20 mm.
 		/// </summary>
 		W20 = 20,
 		/// <summary>
-		/// Lineweight value 0.25 mm.
+		/// Line weight value 0.25 mm.
 		/// </summary>
 		W25 = 25,
 		/// <summary>
-		/// Lineweight value 0.30 mm.
+		/// Line weight value 0.30 mm.
 		/// </summary>
 		W30 = 30,
 		/// <summary>
-		/// Lineweight value 0.35 mm.
+		/// Line weight value 0.35 mm.
 		/// </summary>
 		W35 = 35,
 		/// <summary>
-		/// Lineweight value 0.40 mm.
+		/// Line weight value 0.40 mm.
 		/// </summary>
 		W40 = 40,
 		/// <summary>
-		/// Lineweight value 0.50 mm.
+		/// Line weight value 0.50 mm.
 		/// </summary>
 		W50 = 50,
 		/// <summary>
-		/// Lineweight value 0.53 mm.
+		/// Line weight value 0.53 mm.
 		/// </summary>
 		W53 = 53,
 		/// <summary>
-		/// Lineweight value 0.60 mm.
+		/// Line weight value 0.60 mm.
 		/// </summary>
 		W60 = 60,
 		/// <summary>
-		/// Lineweight value 0.70 mm.
+		/// Line weight value 0.70 mm.
 		/// </summary>
 		W70 = 70,
 		/// <summary>
-		/// Lineweight value 0.80 mm.
+		/// Line weight value 0.80 mm.
 		/// </summary>
 		W80 = 80,
 		/// <summary>
-		/// Lineweight value 0.90 mm.
+		/// Line weight value 0.90 mm.
 		/// </summary>
 		W90 = 90,
 		/// <summary>
-		/// Lineweight value 1.00 mm.
+		/// Line weight value 1.00 mm.
 		/// </summary>
 		W100 = 100,
 		/// <summary>
-		/// Lineweight value 1.06 mm.
+		/// Line weight value 1.06 mm.
 		/// </summary>
 		W106 = 106,
 		/// <summary>
-		/// Lineweight value 1.20 mm.
+		/// Line weight value 1.20 mm.
 		/// </summary>
 		W120 = 120,
 		/// <summary>
-		/// Lineweight value 1.40 mm.
+		/// Line weight value 1.40 mm.
 		/// </summary>
 		W140 = 140,
 		/// <summary>
-		/// Lineweight value 1.58 mm.
+		/// Line weight value 1.58 mm.
 		/// </summary>
 		W158 = 158,
 		/// <summary>
-		/// Lineweight value 2.00 mm.
+		/// Line weight value 2.00 mm.
 		/// </summary>
 		W200 = 200,
 		/// <summary>
-		/// Lineweight value 2.11 mm.
+		/// Line weight value 2.11 mm.
 		/// </summary>
 		W211 = 211
 	}