Re^7: Naming ordinals in the presence of 3D rotation? (A better explanation of the problem?))

[BrowserUk]

Okay. I can see that I've made a total hash of explaining this in words; so I'll try with the aid of a couple of diagrams ('scuse the crudity).

The first shows the 3 faces of a bounding box furthest from the viewer, complete with their grid (tick) lines and showing the local coordinate system (at the current rotations):

              +Z
              /________________________
             /\    \    \    \    \    \
            /  \____\____\____\____\____\
           /\  /\    \    \    \    \    \
          /  \/  \____\____\____\____\____\
         /\  /\  /\    \    \b   \    \    \
        /  \/  \/  \____\____\____\____\____\
       /\  /\  /\  /\    \    \    \    \    \
      /  \/  \/  \/  \____\____\____\____\____\
 +Y  /\  /\  /\  /\  /\    \    \    \    \    \
   \/  \/  \/a \/  \/  \____\____\____\____\____\
   /\  /\  /\  /\  /\  /    /    /    /    /    /
 -Z  \/  \/  \/  \/  \/____/____/____/____/____/
      \  /\  /\  /\  /    /    /    /    /    /
       \/  \/  \/  \/____/____/____/____/____/
        \  /\  /\  /    /    / c  /    /    /
         \/  \/  \/____/____/____/____/____/
          \  /\  /    /    /    /    /    /
           \/  \/____/____/____/____/____/
            \  /    /    /    /    /    /
            _\/____/____/____/____/____/_  
          -X  \                          +X
              -Y

Each of the points (ends of lines) is maintained internally as a 3D point (x,y,z) commensurate with the local coordinate system.

The boundingBoxDraw() code:

<Reveal this spoiler or all spoilers in this node or all in this thread>

But, the same, single routine is used to draw the faces and gridlines. So, when drawing face?:

1. The x-coordinate selects the face. (Actually, one of two: either at minX or maxX depending upon the rotation.)

   And the 'horizontal' index counter has to set the z-coordinate of the line segments;

   And the 'vertical' index counter sets the y-coordinate of the line segments;

2. The z-coordinate selects the face. (Actually, one of two: either at minZ or maxZ depending upon the rotation.)

   And the 'horizontal' index counter has to set the x-coordinate of the line segments;

   And the 'vertical' index counter sets the y-coordinate of the line segments;

3. The y-coordinate selects the face. (Actually, one of two: either at minY or maxY depending upon the rotation.)

   And the 'horizontal' index counter has to set the x-coordinate of the line segments;

   And the 'vertical' index counter sets the z-coordinate of the line segments;

This diagram shows the 2D representations of the 3 faces from above:

   +Y                                +Y                               
+ +Z
 -Z +----+----+----+----+----+ +Z  -X +----+----+----+----+----+ +X  -
+X +----+----+----+----+----+ +X
    |    |    |    |    |    |        |    |    |    |    |    |      
+  |    |    |    |    |    |
    +----+----+----+----+----+        +----+----+----+----+----+      
+  +----+----+----+----+----+   
    |    |    |    |    |    |        |    |    |    |    |    |      
+  |    |    |    |    |    |
    +----+----+----+----+----+        +----+----+----+----+----+      
+  +----+----+----+----+----+   
    |    |    | a  |    |    |        |    |    | b  |    |    |      
+  |    |    | c  |    |    |
    +----+----+----+----+----+        +----+----+----+----+----+      
+  +----+----+----+----+----+   
    |    |    |    |    |    |        |    |    |    |    |    |      
+  |    |    |    |    |    |
    +----+----+----+----+----+        +----+----+----+----+----+      
+  +----+----+----+----+----+   
    |    |    |    |    |    |        |    |    |    |    |    |      
+  |    |    |    |    |    |
    +----+----+----+----+----+        +----+----+----+----+----+      
+  +----+----+----+----+----+   
   -Y                                -Y                               
+ -Z

The drawFace() function (currently) looks like this:

<Reveal this spoiler>

Note that the nomenclature of the 3 minOrMax? conditions from the drawBoundingBox routine, now make no sense in this routine. At this level, the first of the 3 conditions simply selects which position (end) of the face coordinate this face is drawn at.

The other two conditions aren't used at this (drawFace()) level. They are only used at the next level down, -- drawGrid(), which is called twice, once for the 'horizontal' lines, and once for the vertical, and each condition is only needed for one of those two calls -- to determine which end of each of the two sets of parallel lines, the tick marks, values and axis labels get drawn.

This is the drawGrid() (which should probably be called drawHalfTheGrid()):

<Reveal this spoiler>

Note that the horizontal & vertical nomenclature is wrong at this level. Because the same routine is drawing both, the two coordinates (Z&Y or X&Y or X&Z depending upon the face the grid is being drawn on), switch when drawing the two sets of parallel lines; effectively rotating the 2D face in the process.

I hope that explains the problem of naming things such that they make sense each (deeper) level of reused abstraction?

(Final note: I'm still not happy with some of the naming in the above routines, but I'm getting there; however, the general question about finding a good way to deal with the problem remains.)

[bitingduck]

I think the nomenclature isn't so bad. Coordinate transformations often leave you with something that doesn't make sense if you think of it in the new frame or orientation, and if you walk up to them cold take a lot of time reading detailed specs to make sense of. They're tedious to read through and make sense of and easy to mess up when tracing through. I've had to work with stuff that had 7 C-sized sheets packed with notes (and some figures) to define the "base" coordinate system and the transformations to get to mine. You've got what looks like a relatively straightforward set of routines and a lot of detailed description, so I don't think I'd complain about your naming. Most of my experience with nomenclature for this is based on sitting next to someone saying "show me it sliced at the yz plane at x = 'about here' finger point looking from putting +x pointing this way another finger point." Where the finger points would refer to the global coordinates or vectors if I had to write code.

[BrowserUk]

I think the nomenclature isn't so bad.

Well yeah! But I've been worrying away at this on and off for the best part of a week.

You'd have to look back at what I started with and see the number of times I've vacillated and changed the names I currently have to appreciate the thought that's gone into what I have now. (And I just changed some of them again :)