Skip to main content
A
Anonymous
April 27, 2024
Answered

Script, Guides & Snap

  • April 27, 2024
  • 5 replies
  • 818 views

Hello,
I am experiencing an issue of inaccurate magnetism with guides added in JavaScript. Here is an example:
1. I add two guides using the code below.
2. With Snap enabled, I draw a selection.
3. This selection should be 200px, but I often end up with 201px.
4. If I manually add the guides, everything is fine.
Does anyone know where this problem comes from?

app.activeDocument.guides.add (Direction.HORIZONTAL, 600);
app.activeDocument.guides.add (Direction.HORIZONTAL, 800);

 

This topic has been closed for replies.
Correct answer r-bin

Yes, a really interesting bug.

Try using this code to add guides.

 

var d = new ActionDescriptor();
var d1 = new ActionDescriptor();
d1.putUnitDouble(stringIDToTypeID("position"), stringIDToTypeID("pixelsUnit"), 600);
d1.putEnumerated(stringIDToTypeID("orientation"), stringIDToTypeID("orientation"), stringIDToTypeID("horizontal"));
d.putObject(stringIDToTypeID("new"), stringIDToTypeID("guide"), d1);
executeAction(stringIDToTypeID("make"), d, DialogModes.NO);


var d = new ActionDescriptor();
var d1 = new ActionDescriptor();
d1.putUnitDouble(stringIDToTypeID("position"), stringIDToTypeID("pixelsUnit"), 800);
d1.putEnumerated(stringIDToTypeID("orientation"), stringIDToTypeID("orientation"), stringIDToTypeID("horizontal"));
d.putObject(stringIDToTypeID("new"), stringIDToTypeID("guide"), d1);
executeAction(stringIDToTypeID("make"), d, DialogModes.NO);

 

The snap seems to be working as it should.

5 replies

R
r-bin
Legend
April 28, 2024
It looks like I found the cause of this "bug".
Guides created through DOM and AM code are no different.
This is confirmed by a bit-by-bit comparison of psd files with such guides.
When using DOM guides.add(), some internal information is not updated and it appears that the SnapTo function does not see or know about the new guides.
If you save the file and then Revert or re-open it, then SnapTo starts working as it should for such guides.
 
This is definitely a bug.
    Stephen Marsh
    Community Expert
    Stephen MarshCommunity Expert
    Community Expert
    April 28, 2024

    As this appears to be an ExtendScript DOM issue, I was curious to see what happens with the UXP DOM as a .psjs in v2024:

     

    https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/guides/#add

     

    It's a shame that I couldn't get a result!

     

    Stephen Marsh
    Community Expert
    Stephen MarshCommunity Expert
    Community Expert
    April 27, 2024

    What happens when you explicitly set the ruler units via the DOM (which is always a good practice)?

     

    var origRulerUnits = app.preferences.rulerUnits;
app.preferences.rulerUnits = Units.PIXELS;
app.activeDocument.guides.add (Direction.HORIZONTAL, 600);
app.activeDocument.guides.add(Direction.HORIZONTAL, 800);
app.preferences.rulerUnits = origRulerUnits;

     

      R
      r-bin
      Legend
      April 27, 2024
      @Stephen Marsh wrote:

      What happens when you explicitly set the ruler units via the DOM (which is always a good practice)?

       

       

      That's not the point.
       
      P.S. A good practice would be to use UnitValue(800, "px") instead of just 800. But that doesn't help in this case.
      R
      r-binCorrect answer
      Legend
      April 27, 2024

      Yes, a really interesting bug.

      Try using this code to add guides.

       

      var d = new ActionDescriptor();
var d1 = new ActionDescriptor();
d1.putUnitDouble(stringIDToTypeID("position"), stringIDToTypeID("pixelsUnit"), 600);
d1.putEnumerated(stringIDToTypeID("orientation"), stringIDToTypeID("orientation"), stringIDToTypeID("horizontal"));
d.putObject(stringIDToTypeID("new"), stringIDToTypeID("guide"), d1);
executeAction(stringIDToTypeID("make"), d, DialogModes.NO);


var d = new ActionDescriptor();
var d1 = new ActionDescriptor();
d1.putUnitDouble(stringIDToTypeID("position"), stringIDToTypeID("pixelsUnit"), 800);
d1.putEnumerated(stringIDToTypeID("orientation"), stringIDToTypeID("orientation"), stringIDToTypeID("horizontal"));
d.putObject(stringIDToTypeID("new"), stringIDToTypeID("guide"), d1);
executeAction(stringIDToTypeID("make"), d, DialogModes.NO);

       

      The snap seems to be working as it should.

        A
        Anonymous
        April 27, 2024

        Thank you @r-bin 

        Should I conclude that ActionDescriptor is the way to go when possible?

        R
        r-bin
        Legend
        April 27, 2024
        quote

        Thank you @r-bin 

        Should I conclude that ActionDescriptor is the way to go when possible?


        By @35626004

         

        You didn’t specify whether, when creating guides using this code, everything is fine with snapping the selection to the guides?
         
        Classic DOM methods, such as guides.add(), are based (according to unverified rumors) on AM code and the use of ActionDescriptor and executeAction. So if it is more convenient in the code, then it is not forbidden to use it. However, as you yourself noticed in your case, there may be some oddities and bugs when using only DOM methods.
          pixxxelschubser
          Community Expert
          pixxxelschubserCommunity Expert
          Community Expert
          April 27, 2024

          Please show your ruler unit.

            Terms & ConditionsAccessibility statement
            Using the community Terms of use Privacy Cookie preferences Do not sell or share my personal information ad choicesAdChoices