Legacy/UE4 Transform Calculus - Part 1

From UE4: Community Wiki
Jump to: navigation, search

UE4 Transform Calculus - Part 1

Motivation

Slate often has to deal with deep and wide hierarchies of widgets, expressing the sizes and positions of children in terms of their parents. Sometimes these are simple relationships like text in a button, but sometimes those relationships are much more complex, like a graph editing panel that might be panning and zooming across a virtual canvas.

As hierarchies get deeper, this relationship becomes layered. For instance, if we apply a global DPI (dots per inch) scale to our application, which itself sits in a window at some arbitrary location on the desktop, there are a series of zooms and offsets that combine to form the final position of a widget on the screen.

Calc1img1.png

[The complex relationship of slate widgets. A UE4 Editor view displaying blueprint widgets within a virtual panel within a tabwell within a window, all having a global application scale applied. The Blueprint editor must reason about the widgets in virtual canvas space, implement mouse events in desktop space, and render the widgets in window space.]

Slate must not only be able to unwind these hierarchies internally, but also provide straightforward ways for widget authors to reason about widgets in multiple spaces (ie, local, virtual canvas, window, desktop). With the addition of Render Transforms to Slate, the math for computing a childÔÇÖs relationship to its parent became much more involved than a simple scale and offset.

Calc1img2.png

[SlateViewer can apply an arbitrary render transform to the entire application. Now whatÔÇÖs the relationship of one of these widgets to its parent, or the window, or the desktop?]

In fact, the historical simplicity of a child widgetÔÇÖs transform with respect to its parent in Slate contributed to an overall daunting task of updating hundreds of widgets to support arbitrary render transforms. We chose to focus on the core widgets that most widgets are composed of, but lots of legacy functions still exist in Slate that are used by other widgets that donÔÇÖt support render transforms. This series of posts will focus on a new notation for manipulating transforms, along with a C++ implementation in UE4 that Slate is using to assist with this sometimes mind-bending task.

Target Audience

For this discussion, I assume you are already aware of basic linear algebra and have at least cursory experience working with rigid body hierarchies in code. You should be comfortable with vectors and matrices, be able to perform basic calculations with them, and be familiar with the idea of using them to represent transformations like translation, rotation, scale, shear, etc. Some familiarity with alternate representations like quaternions etc may also be useful when we start discussing the code implementation. If youÔÇÖve ever tried to use a physics engine or render something in OpenGL or Direct3D, you likely have more than enough exposure to these concepts.

I will generally try to keep a conversational tone, but will occasionally stray into math-heavy territory. When I do, IÔÇÖll try to summarize the salient points and provide links to read up more if youÔÇÖd like. The reason for ÔÇ£getting mathyÔÇØ sometimes is to establish the mathematical foundation for the notation we are developing, not to rigorously prove it. IÔÇÖm a programmer, not a mathematician.

Why ÔÇ£Calculus?ÔÇØ

So, a word about why I chose the term ÔÇ£Transform CalculusÔÇØ instead of something less presumptive (like Framework or API). This document in fact describes a logical calculus, or a formalization of a logical theory[1]. These are concepts that provide a mathematical notation for uniformly expressing and manipulating transforms that transcends the representation (ie, a matrix or quaternion).

There happens to be an implementation in UE4, but that implementation is secondary to the underlying concepts. Also, the implementation sometimes has to make compromises to work within the C++ language and UE4 Core types, so is not a pure expression of these concepts.

To be clear, I'm not inventing anything "novel", IÔÇÖm just wrapped some well-known math concepts in a higher level abstraction. That said, I do feel all the focus on notation is a critical part of the journey, as one can't use the library effectively without understanding the notation. For that reason, simply referring to this as a Framework or API seemed insufficient.

One could perhaps more accurately refer to this an an algebra, as itÔÇÖs closed over the affine vector space. But I donÔÇÖt prove this, and frankly IÔÇÖve been using the term calculus for years, so it seemed too late to turn back now. CÔÇÖest la vie. :)

Rigid Body Hierarchies

Slate UI hierarchies are conceptually identical to rigid body hierarchies that physics engines utilize. WeÔÇÖll start with a quick overview of rigid body hierarchies to establish the concepts. I expect anyone reading this to be familiar already, so I wonÔÇÖt dwell on details.

Calc1img3.png

Hierarchies as Attachments

One way to think about the hierarchy is as each part being ÔÇ£attachedÔÇØ to its parent by a transformation. This transformation places a child part relative to its parent. To place a part in the world we start at the root of the tree (ÔÇ£world spaceÔÇØ) and successively transform the part all the way down to the leaf node where the part is located.

Calc1imgIV.png

If one thinks of these transformations as simple offsets, then it is easy to conceptualize. However, most rigid body systems allow more complex transformations like scale, rotate, and/or shear. Reasoning about partsÔÇÖ relations to each other in such a hierarchy can quickly become very complicated.

Hierarchies as Frames of Reference

Another way to look at the hierarchy is that each part is a camera, and the transformation is taking the part from itÔÇÖs local the coordinate system into that of the parent. So each part is essentially in itÔÇÖs own coordinate system, or ÔÇ£frame of referenceÔÇØ relative to its parent. The representation is logically equivalent to the attachment point of view described above, but instead of viewing all parts as placed at different points in the same coordinate system, each part has its own local coordinate system. This makes it easier to conceptualize the parent-child relationship as more than a simple offset. To place a child in the world, we chain, or composite, these transformations in succession just as we did when thinking of them as attachments.

Calc1img5.png

Transform Calculus

This notion of a hierarchy as a chain of transformations taking us from one frame of reference to another is very powerful. In linear algebra, a frame of reference is like a vector basis[2], and the transformation to another frame of reference is a change of basis. In code, we often represent this transformation as a matrix and composite them using matrix multiplication[3]. For efficiency, we sometimes represent a transform using narrower representations like euler angles, quaternions, translations, or even scalars. Regardless of the representation we use, a transformation is essentially a function over a vector space that maps one frame of reference to another. We can represent this function along with operations to manipulate it using a common notation, or calculus:

Transform Calculus Operations
Transformation TA->B(V) Evaluating T transforms V from frame A to frame B
  • Frame A is the ÔÇ£input frameÔÇØ
  • Frame B is the ÔÇ£output frameÔÇØ
Inversion TA->B-1  TB->A T-1 reverses the input and output frames, so A->B becomes B->A.
Composition (⊕) TA->B⊕TB->C ÔçÆ TA->C composition forms a ÔÇ£chainÔÇØ, going from frame A to frame B to frame C.

Note that composition (⊕) is a transitive relation -- the output frame of the first must match the input frame of the second, otherwise the composition is invalid:

Composition is Transitive
TA->B⊕TB->C Valid (output Frame B matches input Frame B)
TA->B⊕TC->B Invalid (output Frame B mismatches input Frame C)
TA->B⊕TC->B-1 ÔçÆ TA->B⊕TB->C Valid (inversion swaps the input and output Frame)

IÔÇÖm using the mysterious symbol for composition because it is a conceptual operation, and the calculation is not important right now. For instance, something like the multiply or addition operator might seem attractive to use instead, but could be misleading. For instance, two matrices are indeed composited using multiplication, but two translation vectors are composited using addition. However, they are both conceptually a composition of two transformations. I want to convey the concept of composition without focusing on the specific math required to achieve it, which is more tied to the representation used for the transform. IÔÇÖll discuss this more in the next post.

LetÔÇÖs go back to our rigid body tank example and express some transformations using this new calculus:

Tgun->world = Tgun->turret⊕Tturret->chassis⊕Tchassis->world
Tgun->wheel1 = Tgun->turret⊕Tturret->chassis⊕Twheel1->chassis-1


This is makes logical sense: to determine the transformation from the gunÔÇÖs frame of reference to the worldÔÇÖs, chain the gun-to-turret transform to the turret-to-chassis transform to the chassis-to-world transform. Each step moves UP the hierarchy to the root. Note in the second example how we use the inverse to go back DOWN the hierarchy to get to the lower wheel1 node, preserving the transitive chain of operations.

Transforming Vectors and Points

As discussed, a transformation is a mapping function over the vector space. But we use points to describe geometry. So whatÔÇÖs the difference between a vector and a point? Well, a point is a distinct location in space, while a vector is a displacement between two points (like a vertex normal). Luckily, both points AND vectors can be represented using homogeneous coordinates, the former with a homogeneous coordinate of 1, and the latter with a 0[4]. By thinking of our transforms as operating on affine spaces using homogeneous coordinates, we can transform points and vectors the same way:

TA->B(P)  Transformation of homogeneous point P from frame A to frame B
TA->B(V)  Transformation of homogeneous vector V from frame A to frame B

Summary

We have outlined a formal notation, or calculus, for expressing a rigid body hierarchy as a tree of coordinate transformations taking us from the frame of reference of a child node to its parent. We can composite and invert these transformations using a logical notation that allows us to reason about any node from the perspective of any other node, regardless of how that transform is represented. Finally, we can apply these transformations to a set of vectors or points to reason about specific geometry associated with those nodes. This is something Slate has to do all the time.

In the next post IÔÇÖll discuss how these operations are actually implemented using several transformation representations available in UE4 and demonstrate how the calculus allows us to simplify real-world code by expressing the concept rather than focusing on the math itself.

Continue to Part 2 >



Footnotes

1IÔÇÖm applying symbols for particular operations/semantics, so I guess itÔÇÖs technically a logico-mathematical calculus, but who really cares?
2 Technically, itÔÇÖs an affine space as we also need an offset to place the basis at a point in space, but the mathematical properties we are concerned with are equivalent, as affine spaces are in fact vector subspaces. However, studying vector bases leads us more directly to the properties we want to consider.
3This is known as composition of linear transformations, which form what is called an associative algebra. This algebra gives us many useful properties like associativity and distributivity.
4This StackExchange link gives a good technical explanation without getting too mathy..