File Location, and Naming

For developers with Scaleform source code, it is useful to get familiar with the Scaleform source code tree organization.

As a general rule, the file system tree follows the structure of namespace nesting, with short filenames being used for files based on their contained class, namespace or purpose. The files are organized into directories, with directory names being identical to the namespace names. Two exceptions to this rule are: • The root “Scaleform” namespace will reside at the Src directory level. • All root namespace base types, containers and algorithms will be located under the “Src/Kernel” directory.

This results in a directory structure like this:

The Src tree contains both public and private header files, alongside their corresponding cpp file. See the following section for more information on including Public headers.