Status bar: add % as an available unit of measurement

This allows things like mouse coordinates, ruler notches, distances, layer dimensions, and selection sizes to be displayed as a percentage of total image size, which should be very helpful for alignment purposes.

(A lot of random tools and UI bits were affected by this change, but all measurement conversions should now be using a central converter that standardizes things like significant digits on a per-unit basis.  This greatly improves consistency and cuts a bunch of redundant unit display code.)

Author: tannerhelland

Controls/pdRuler.ctl

@@ -390,7 +390,7 @@ Private Sub UpdateControlLayout(Optional ByVal redrawImmediately As Boolean = Fa
         With imgRectCurUnit
 
             Select Case m_RulerUnit
-            
+                
                 'Pixels are the primary unit, and we can just use coordinates as-is
                 Case mu_Pixels
                     .Left = m_imgCoordRectF.Left
@@ -400,10 +400,10 @@ Private Sub UpdateControlLayout(Optional ByVal redrawImmediately As Boolean = Fa
 
                 'Other units require conversion
                 Case Else
-                    .Left = Units.ConvertPixelToOtherUnit(m_RulerUnit, m_imgCoordRectF.Left, curImgDPI)
-                    .Top = Units.ConvertPixelToOtherUnit(m_RulerUnit, m_imgCoordRectF.Top, curImgDPI)
-                    .Width = Units.ConvertPixelToOtherUnit(m_RulerUnit, m_imgCoordRectF.Width, curImgDPI)
-                    .Height = Units.ConvertPixelToOtherUnit(m_RulerUnit, m_imgCoordRectF.Height, curImgDPI)
+                    .Left = Units.ConvertPixelToOtherUnit(m_RulerUnit, m_imgCoordRectF.Left, curImgDPI, PDImages.GetActiveImage.Width)
+                    .Top = Units.ConvertPixelToOtherUnit(m_RulerUnit, m_imgCoordRectF.Top, curImgDPI, PDImages.GetActiveImage.Height)
+                    .Width = Units.ConvertPixelToOtherUnit(m_RulerUnit, m_imgCoordRectF.Width, curImgDPI, PDImages.GetActiveImage.Width)
+                    .Height = Units.ConvertPixelToOtherUnit(m_RulerUnit, m_imgCoordRectF.Height, curImgDPI, PDImages.GetActiveImage.Height)
 
             End Select
 
@@ -797,7 +797,7 @@ Private Function GetConvertedValue(ByVal srcValue As Double) As Long
     If (m_RulerUnit = mu_Pixels) Then
         GetConvertedValue = Int(srcValue)
     Else
-        If (m_LastDPI <> 0#) Then GetConvertedValue = Int(Units.ConvertOtherUnitToPixels(m_RulerUnit, srcValue, m_LastDPI) + 0.5)
+        If (m_LastDPI <> 0#) Then GetConvertedValue = Int(Units.ConvertOtherUnitToPixels(m_RulerUnit, srcValue, m_LastDPI, IIf(m_Orientation = pdo_Horizontal, PDImages.GetActiveImage.Width, PDImages.GetActiveImage.Height)) + 0.5)
     End If
 
 End Function

Controls/pdStatusBar.ctl

@@ -312,14 +312,7 @@ Public Sub DisplayCanvasCoordinates(ByVal xCoord As Double, ByVal yCoord As Doub
     'The position displayed changes based on the current measurement unit (px, in, cm)
     Else
         If PDImages.IsImageActive() Then
-            Select Case m_UnitOfMeasurement
-                Case mu_Pixels
-                    lblCoordinates(0).Caption = "(" & Int(xCoord) & "," & Int(yCoord) & ")"
-                Case mu_Inches, mu_Centimeters
-                    lblCoordinates(0).Caption = "(" & Format$(Units.ConvertPixelToOtherUnit(m_UnitOfMeasurement, xCoord, PDImages.GetActiveImage.GetDPI()), "0.0##") & "," & Format$(Units.ConvertPixelToOtherUnit(m_UnitOfMeasurement, yCoord, PDImages.GetActiveImage.GetDPI()), "0.0##") & ")"
-                Case mu_Millimeters, mu_Points, mu_Picas
-                    lblCoordinates(0).Caption = "(" & Format$(Units.ConvertPixelToOtherUnit(m_UnitOfMeasurement, xCoord, PDImages.GetActiveImage.GetDPI()), "0.0#") & "," & Format$(Units.ConvertPixelToOtherUnit(m_UnitOfMeasurement, yCoord, PDImages.GetActiveImage.GetDPI()), "0.0#") & ")"
-            End Select
+            lblCoordinates(0).Caption = "(" & Units.GetValueFormattedForUnit_FromPixel(m_UnitOfMeasurement, xCoord, PDImages.GetActiveImage.GetDPI(), PDImages.GetActiveImage.Width, False) & "," & Units.GetValueFormattedForUnit_FromPixel(m_UnitOfMeasurement, yCoord, PDImages.GetActiveImage.GetDPI(), PDImages.GetActiveImage.Height, False) & ")"
         End If
     End If
 
@@ -348,32 +341,23 @@ Public Sub DisplayImageSize(ByRef srcImage As pdImage, Optional ByVal clearSize
     'When size IS displayed, we must also refresh the status bar (now that it dynamically aligns its contents)
     Else
 
+        Const TEXT_BETWEEN_DIMENSIONS As String = " x "
+        
         Dim unitWidth As Double, unitHeight As Double
         Dim sizeString As String
 
-        'Convert pixel measurements to the current unit
-        If (m_UnitOfMeasurement <> mu_Pixels) Then
+        'Convert pixel measurements to the current unit, then convert those to a string.
+        ' (Different measurements support different significant digits in the size readout.)
+        If (m_UnitOfMeasurement = mu_Pixels) Or (m_UnitOfMeasurement = mu_Percent) Then
+            unitWidth = CStr(srcImage.Width)
+            unitHeight = CStr(srcImage.Height)
+            sizeString = Units.GetValueFormattedForUnit_FromPixel(mu_Pixels, unitWidth) & TEXT_BETWEEN_DIMENSIONS & Units.GetValueFormattedForUnit_FromPixel(mu_Pixels, unitHeight)
+        Else
             unitWidth = ConvertPixelToOtherUnit(m_UnitOfMeasurement, srcImage.Width, srcImage.GetDPI(), srcImage.Width)
             unitHeight = ConvertPixelToOtherUnit(m_UnitOfMeasurement, srcImage.Height, srcImage.GetDPI(), srcImage.Height)
+            sizeString = Units.GetValueFormattedForUnit_FromPixel(m_UnitOfMeasurement, unitWidth, srcImage.GetDPI(), srcImage.Width) & TEXT_BETWEEN_DIMENSIONS & Units.GetValueFormattedForUnit_FromPixel(m_UnitOfMeasurement, unitHeight, srcImage.GetDPI(), srcImage.Height)
         End If
 
-        'Different measurements support different significant digits in the size readout
-        Select Case m_UnitOfMeasurement
-            
-            Case mu_Pixels
-                sizeString = srcImage.Width & " x " & srcImage.Height
-                
-            Case mu_Inches
-                sizeString = Format$(unitWidth, "0.0##") & " x " & Format$(unitHeight, "0.0##")
-            
-            Case mu_Centimeters, mu_Millimeters
-                sizeString = Format$(unitWidth, "0.0#") & " x " & Format$(unitHeight, "0.0#")
-                
-            Case mu_Points, mu_Picas
-                sizeString = Format$(unitWidth, "0.0") & " x " & Format$(unitHeight, "0.0")
-            
-        End Select
-        
         lblImgSize.Caption = sizeString
         ReflowStatusBar True
 
@@ -407,12 +391,12 @@ Public Sub PopulateSizeUnits()
     cmbSizeUnit.Clear
 
     Dim i As Long
-    For i = 1 To Units.GetNumOfAvailableUnits()
-        cmbSizeUnit.AddItem Units.GetNameOfUnit(i, True), i - 1
+    For i = 0 To Units.GetNumOfAvailableUnits()
+        cmbSizeUnit.AddItem Units.GetNameOfUnit(i, True), i
     Next i
 
 
-    cmbSizeUnit.ListIndex = 0
+    cmbSizeUnit.ListIndex = 1
     cmbSizeUnit.SetAutomaticRedraws True, True
 
 End Sub
@@ -486,20 +470,9 @@ Public Sub SetSelectionState(ByVal newSelectionState As Boolean)
                     Dim cString As pdString
                     Set cString = New pdString
 
-                    Select Case m_UnitOfMeasurement
-                        Case mu_Pixels
-                            cString.Append Int(selectRect.Width + 0.5)
-                            cString.Append LOWERCASE_X
-                            cString.Append Int(selectRect.Height + 0.5)
-                        Case mu_Inches, mu_Centimeters
-                            cString.Append Format$(Units.ConvertPixelToOtherUnit(m_UnitOfMeasurement, selectRect.Width, PDImages.GetActiveImage.GetDPI()), "0.0##")
-                            cString.Append LOWERCASE_X
-                            cString.Append Format$(Units.ConvertPixelToOtherUnit(m_UnitOfMeasurement, selectRect.Height, PDImages.GetActiveImage.GetDPI()), "0.0##")
-                        Case mu_Millimeters, mu_Points, mu_Picas
-                            cString.Append Format$(Units.ConvertPixelToOtherUnit(m_UnitOfMeasurement, selectRect.Width, PDImages.GetActiveImage.GetDPI()), "0.0#")
-                            cString.Append LOWERCASE_X
-                            cString.Append Format$(Units.ConvertPixelToOtherUnit(m_UnitOfMeasurement, selectRect.Height, PDImages.GetActiveImage.GetDPI()), "0.0#")
-                    End Select
+                    cString.Append Units.GetValueFormattedForUnit_FromPixel(m_UnitOfMeasurement, selectRect.Width, PDImages.GetActiveImage.GetDPI(), PDImages.GetActiveImage.Width, False)
+                    cString.Append LOWERCASE_X
+                    cString.Append Units.GetValueFormattedForUnit_FromPixel(m_UnitOfMeasurement, selectRect.Height, PDImages.GetActiveImage.GetDPI(), PDImages.GetActiveImage.Height, False)
 
                     'Also append the selection's aspect ratio, in the form X : 1
                     If (selectRect.Height <> 0!) Then
@@ -536,10 +509,10 @@ Public Sub SetSelectionState(ByVal newSelectionState As Boolean)
 End Sub
 
 Private Sub cmbSizeUnit_Click()
-    m_UnitOfMeasurement = cmbSizeUnit.ListIndex + 1
+    m_UnitOfMeasurement = cmbSizeUnit.ListIndex
     If PDImages.IsImageActive() Then
         Me.DisplayImageSize PDImages.GetActiveImage()
-        FormMain.MainCanvas(0).NotifyRulerUnitChange cmbSizeUnit.ListIndex + 1
+        FormMain.MainCanvas(0).NotifyRulerUnitChange cmbSizeUnit.ListIndex
         If (g_CurrentTool = ND_MEASURE) Then Tools_Measure.NotifyUnitChange
         If (g_CurrentTool = NAV_MOVE) Then Viewport.Stage4_FlipBufferAndDrawUI PDImages.GetActiveImage, FormMain.MainCanvas(0)
     End If

Forms/Toolpanel_Measure.frm

@@ -324,8 +324,8 @@ Attribute VB_Exposed = False
 'PhotoDemon Measurement Tool Panel
 'Copyright 2013-2024 by Tanner Helland
 'Created: 11/July/18
-'Last updated: 09/November/21
-'Last update: convert to new flyout-driven UI
+'Last updated: 28/May/24
+'Last update: support for percent as a measurement unit
 '
 'PD's measurement tool is pretty straightforward: measure the distance and angle between two points,
 ' and relay those values to the user.  Can't beat that for simplicity!
@@ -416,7 +416,6 @@ Public Sub UpdateUIText()
 
             Dim newUnit As PD_MeasurementUnit
             newUnit = FormMain.MainCanvas(0).GetRulerUnit()
-            measurementUnitText = Units.GetNameOfUnit(newUnit, True)
 
             'Ensure the display elements are visible
             If (Not lblValue(4).Visible) Then
@@ -429,7 +428,7 @@ Public Sub UpdateUIText()
             'Repeat the same steps that we used for pixels, but this time, perform an additional conversion
             ' into the target unit space
             If Tools_Measure.GetDistanceInPx(measureValue) Then
-                lblValue(4).Caption = Format$(Units.ConvertPixelToOtherUnit(newUnit, measureValue, PDImages.GetActiveImage.GetDPI), "0.0##") & " " & measurementUnitText
+                lblValue(4).Caption = Units.GetValueFormattedForUnit_FromPixel(newUnit, measureValue, PDImages.GetActiveImage.GetDPI, PDImages.GetActiveImage.Width, True)
             Else
                 lblValue(4).Caption = m_NullTextString
             End If
@@ -444,10 +443,10 @@ Public Sub UpdateUIText()
             End If
 
             'Width
-            lblValue(6).Caption = Format$(Units.ConvertPixelToOtherUnit(newUnit, Abs(firstPoint.x - secondPoint.x), PDImages.GetActiveImage.GetDPI), "0.0##") & " " & measurementUnitText
+            lblValue(6).Caption = Units.GetValueFormattedForUnit_FromPixel(newUnit, Abs(firstPoint.x - secondPoint.x), PDImages.GetActiveImage.GetDPI, PDImages.GetActiveImage.Width, True)
 
             'Height
-            lblValue(7).Caption = Format$(Units.ConvertPixelToOtherUnit(newUnit, Abs(firstPoint.y - secondPoint.y), PDImages.GetActiveImage.GetDPI), "0.0##") & " " & measurementUnitText
+            lblValue(7).Caption = Units.GetValueFormattedForUnit_FromPixel(newUnit, Abs(firstPoint.y - secondPoint.y), PDImages.GetActiveImage.GetDPI, PDImages.GetActiveImage.Height, True)
 
         'If the current unit is "pixels", hide the extra info area
         Else

Modules/Drawing.bas

@@ -1113,7 +1113,7 @@ Private Sub DrawLayerDistances_Interior(ByRef dstCanvas As pdCanvas, ByRef srcIm
     PD2D.DrawLineF_FromPtF cSurface, cPen, pt1, pt2
 
     'Calculate height text, then draw it
-    layerSizeAsString = Units.GetValueFormattedForUnit_FromPixel(FormMain.MainCanvas(0).GetRulerUnit(), srcLayer.GetLayerHeight(True), PDImages.GetActiveImage.GetDPI(), PDImages.GetActiveImage.Width, False)
+    layerSizeAsString = Units.GetValueFormattedForUnit_FromPixel(FormMain.MainCanvas(0).GetRulerUnit(), srcLayer.GetLayerHeight(True), PDImages.GetActiveImage.GetDPI(), PDImages.GetActiveImage.Height, False)
     RenderTextWithBackgroundBox layerSizeAsString, cText, ptMid, cSurface, cBrush
 
     'Restore original font color, then free the font from the target DC

Modules/MeasureTool.bas

@@ -3,8 +3,8 @@ Attribute VB_Name = "Tools_Measure"
 'Measure tool interface
 'Copyright 2018-2024 by Tanner Helland
 'Created: 11/July/17
-'Last updated: 13/July/17
-'Last update: wrap up initial build
+'Last updated: 28/May/14
+'Last update: add support for percent as a measurement unit
 '
 'PD's Measure tool is very straightforward.  Additional details can be found in the associated form
 ' (toolpanel_Measure).
@@ -405,8 +405,8 @@ Public Sub Rotate2ndPoint90Degrees()
 
 End Sub
 
-'NOTE: this code is a duplicate of the FormStraighten command string generator.  Any changes here need to
-' also be mirrored there.
+'NOTE: this code is a duplicate of the FormStraighten command string generator.
+' Any changes here also need to be mirrored there.
 Public Sub StraightenImageToMatch()
 
     Dim curAngle As Double

Modules/Units.bas

@@ -200,29 +200,36 @@ Public Function GetValueFormattedForUnit_FromPixel(ByVal curUnit As PD_Measureme
     Select Case curUnit
 
         Case mu_Percent
-            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.00%")
+            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.0#")
 
         Case mu_Pixels
             GetValueFormattedForUnit_FromPixel = CStr(Int(srcPixelValue + 0.5))
 
         Case mu_Inches
-            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.000")
+            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.0##")
 
         Case mu_Centimeters
-            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.00")
+            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.0#")
 
         Case mu_Millimeters
-            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.0")
+            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.0#")
 
         Case mu_Points
-            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.00")
+            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.0#")
 
         Case mu_Picas
-            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.00")
+            GetValueFormattedForUnit_FromPixel = Format$(srcPixelValue, "0.0#")
 
     End Select
 
-    If appendUnitAsText Then GetValueFormattedForUnit_FromPixel = GetValueFormattedForUnit_FromPixel & " " & Units.GetNameOfUnit(curUnit, True)
+    If appendUnitAsText Then
+        If (curUnit = mu_Percent) Then
+            Const PERCENT_SIGN As String = "%"
+            GetValueFormattedForUnit_FromPixel = GetValueFormattedForUnit_FromPixel & PERCENT_SIGN
+        Else
+            GetValueFormattedForUnit_FromPixel = GetValueFormattedForUnit_FromPixel & " " & Units.GetNameOfUnit(curUnit, True)
+        End If
+    End If
 
 End Function
 

PhotoDemon.vbp

@@ -527,7 +527,7 @@ Description="PhotoDemon Photo Editor"
 CompatibleMode="0"
 MajorVer=2024
 MinorVer=4
-RevisionVer=19
+RevisionVer=21
 AutoIncrementVer=1
 ServerSupportFiles=0
 VersionComments="Copyright 2000-2024 Tanner Helland - photodemon.org"