Release Notes for Version 2.6

Release date: July 14, 2011

• IMPORTANT: In this version, some backwards compatibility with old versions of the engine has been removed. If you have problems with old world files in version 2.6, then please open those files in version 2.5.5 and save them in the World Editor before opening them in version 2.6 again. Be sure to backup your data first.

Core Engine

• A special flag named C4FASTBUILD has been added at the top of the file C4PrefixWindows.h. If this symbol is defined to be nonzero, then all of the projects are built using custom minimal header files for all Win32, DirectX, OpenGL, math library, and intrinsic functions. This greatly reduces build times at the slight risk of forward compatibility issues, but those are easily fixed. The default value of C4FASTBUILD is 1. If you experience problems compiling, then change it to 0. The C4FASTBUILD flag does not affect the linking stage.

• The Stats window has been expanded and now has three tabs named Render, World, and Physics that display information for the Graphics Manager, the World Manager, and the Physics Manager.

Physics

• A new large-scale water surface simulation system has been added to the engine. Its intended use is for bodies of water ranging in size from small ponds to large oceans, and it is designed to simulate dynamic surface waves in an interactive manner. A body of water is represented in the scene graph by a new water block node that organizes a large number of water geometry nodes in a manner similar to how a terrain block node organizes a bunch of terrain geometries. Each water geometry simulates waves occurring within its bounds, and waves automatically propagate from one water geometry to its neighbors (if they exist). A water block can optionally include special "horizon" water geometries that extend a very large (but still finite) distance from the main water area. Waves are not simulated on horizon water geometries—they are intended to be shown only in the distance where the camera would never be close enough to see a dynamic water surface.

• Water simulation for an entire water block is managed by a single water controller that is assigned to the water block. Settings for this controller allow you to specify parameters such as wave speed and fluid viscosity. The water controller automatically determines which water geometries need to be simulated based on proximity to the camera and time since they were last rendered, and inactive water geometries are put into a sleep state that consumes no processing time.

• Waves are created by attaching wave generator objects to a water controller. Each wave generator creates a disturbance in the water surface that is then propagated by the water simulation. There are currently three types of wave generator, a point generator, a line generator, and a random generator. The point wave generator creates a circular disturbance around a single point, the line wave generator creates a disturbance around a line segment between two points, and the random wave generator adds random noise to the water. Wave generators typically exist for a short amount of time (measured in the number of simulation steps) and can be used for things such as creating a disturbance when an object falls into the water or creating a wake for a ship moving through the water.

• Two new controller functions have been added for the water controller so that point and line wave generators can be created from a script. These functions allow a script to create disturbances in a water simulation at specific locations.

• The fluid force field can now be connected to a water block so that the actual water surface elevation can be used in buoyancy calculations. This is done by connecting the field node to a water block and then specifying the connector key in the settings for the fluid force assigned to the field node. When a fluid force field is connected to a water block, the top of the field volume no longer represents the water surface, but is used only to determine whether the force affects rigid bodies that intersect the field. The water surface is determined completely by the water block in this case, and the top of the field volume should be extended high enough to include rigid bodies that could be floating on the largest waves existing in the water block.

Graphics

• A new shader process called Steep Parameter has been added to the shading system. This is just a convenience process similar to the existing Smooth Parameter process, and it calculates 2t − t².

Effects

• The MarkingData structure passed to the MarkingEffect::New() function now holds a scale and offset for the texture coordinates. This allows multiple distinct marking textures to be stored in the same texture map.

• A setting called "interaction padding" has been added to panel effects. This padding controls how far away from the boundary of a panel effect the user needs to move the cursor before the panel will disengage. Setting this to a nonzero value helps avoid quick disengaging/re-engaging that can happen if the cursor moves slightly out of bounds for a moment.

World Manager

• The internal way in which node connectors work has been redesigned. Connectors now form a graph with hubs attached to the nodes that take part in the graph, and it's now possible to iterate over incoming connectors as well as outgoing connectors. For most users, these changes will have no visible effect—the functions used to link connectors are the same, and the World Editor tools have not changed.

• There is a new modifier for reference markers that links a connector on the marker to a named node in the referenced world when it is loaded.

• A shadow map can now be shared between the scenes rendered in the refraction buffer and the primary buffer. This happens automatically when a single shadow map is rendered through a remote portal that targets the refraction buffer unless the new "Render separate shadow map" box is checked for the portal.

• There is a new setting for remote portals that lets you specify a different clear color for scenes rendered to the reflection or refraction buffer. This is useful for specifying a clear color for underwater parts of a scene that is different from the main clear color use for the above-water parts.

• Remote portals also have a new "Portal plane offset" setting that moves the portal clipping plane outward by the specified distance for the purposes of rendering. This is useful when a remote portal is used to render refractions for water that has waves because it ensures that geometry up to the specified distance above the water plane is included in the refraction rendering.

• A remote portal can now be configured so that only infinitely distant parts of the scene are rendered through it. This currently means that only the skybox is rendered through a remote portal with this flag set.

• Skyboxes have a new option that specifies a vertical texture coordinate adjustment for the four sides of the box that cross the horizon. This can be used to cause the bottom of the textures to dip below the horizon a little bit.

Time Manager

• The DeferredEvent class has been renamed to DeferredTask, and the behavior has changed a little bit. A deferred task is now fired exactly one time and then automatically removed from the Time Manager's task list, so it won't keep firing every frame once it has been triggered, and there's no need to explicitly remove it from the task list.

System Utilities

• The Job Manager now supports job batches, and it's possible to block the main thread and wait for an entire batch to finish instead of waiting for each individual job separately.

• There is a new static SetReservedProcessorCount() function in the JobMgr class that can be used to reduce the number of worker threads created by the Job Manager. This function must be called in the WinMain() or main() function before the Engine::New() function is called, or it will have no effect.

Math Library

• New classes called Integer2D, Integer3D, Fixed2D, and Fixed3D have been added to the engine for two- and three-dimension integer and fixed-point vectors. The Point class has been removed in favor of Integer2D, and the Coordinates class has been removed in favor of Fixed3D.

Plugins

Browser Plugin

• There is a new browser plugin (for both Windows and Mac OS X) that defines a browser widget. A browser widget can be placed in windows or in-game panel effects just like any other widget, and it renders and interacts with web pages using Awesomium.

• Several controller functions have been added to control browser widgets. These functions are able to navigate forward and back, navigate to a particular hard-coded address or to an address held in a text-based widget, reload the current page, or stop loading the current page.

Movies Plugin

• The movie widget has a new setting that enables alpha blending using the alpha channel in the movie itself.

Tools

World Editor

• A new Water page has been added to the editor, and it includes a tool for drawing water blocks. When a water block is drawn, a dialog appears in which different settings pertaining to the resolution of the water surface can be specified. This dialog also lets you specify whether horizon water geometries are created in the east, west, north, and south directions.

• The popup menu in the Water page includes a command for generating land height data. This command generates land height and gradient information at every vertex for each selected water geometry, and this information is available to shaders so that various effects can be created based on the depth of the water and the direction in which the land is sloping at every point.

• The Optimize Terrain and Resize Terrain Block commands have been removed from the Geometry menu. These commands can now be accessed from a menu button in the top-right corner of the Terrain tool page.

• New bulldozer tools have been added to the Terrain tool page. These tools tend to level out the ground where they are applied, one tool in an additive manner and one tool in a subtractive manner. A bias slider has also been added that can cause the bulldozer to tend to slope upward or downward.

• A fuzziness slider has been added to the Terrain tool page, and it affects the texture blending paint brushes. Higher fuzziness means softer edges where textures blend together. The blend tool has also been split into two blend tools, one for painting the primary texture and another for painting the secondary texture.

• A button has been added to the Placement page that causes the placement modifier settings to be applied to the current selection. This causes placement modifiers to be applied to selected referenced worlds, models, and locator markers regardless of whether the placement modifiers are enabled for newly created nodes.

• The material pickup tool can now be used to grab the material from a skybox or impostor node by clicking on them in the scene graph viewport.

Texture Importer

• A new option in the texture importer can apply a layer of haze to skybox textures with the appropriate warping along the horizon.

• New options have been added to the texture importer to scale texture maps to one-half resolution. One option scales the whole texture, and this can be useful if the original source image is larger and more detailed than necessary for the game. The other option scales only the horizon maps that can be generated when a normal map is imported, and this saves a lot of space without a significant decrease in quality because the shadows cast by horizon maps are generally soft.

Collada Importer

• Some new workarounds have been added to the Collada Importer in order to support illegal XML formats written by some exporters.