Panda3D Manual: Geometrical MipMapping
<<prev | top | next>> |
The GeoMipTerrain generates terrain geometry from a heightfield image, but it does more than any bruteforce terrain generator: the GeoMipTerrain divides the terrain into multiple chunks, where each of them can have a different level of detail. The advantage of this approach is that, when the focal point (the place where the terrain has the highest quality, probably the camera) moves, not the entire terrain has to be regenerated to match the correct detail level, like the HeightfieldTesselator, but only the chunks that have a different LOD can be regenerated. Also, it improves culling and collision detection. ### Basic Usage Using the GeoMipTerrain is quite easy, it does not require to write much complicated calculations:
    from pandac.PandaModules import GeoMipTerrain

    terrain = GeoMipTerrain("mySimpleTerrain")
    terrain.setHeightfield(Filename("yourHeightField.png"))
    #terrain.setBruteforce(True)
    terrain.getRoot().reparentTo(render)
    terrain.generate()
First, the code creates a GeoMipTerrain instance. The `setHeightfield` call loads in a heightfield (8-bits greyscale) image. Preferrably this is a size of a power of two plus one (like 129, 257, 513, 1025, etc.), but if it is not, the GeoMipTerrain will automatically scale it up to the nearest correct size (which is quite slow). `setHeightfield` can take a PNMImage, Texture or Filename instance. The `setBruteforce(True)` call sets the terrain to bruteforce rendering -- this means that the terrain is created at the highest quality (the lowest detail level), and LOD is not applied. In the next section we will explain how to set a LOD level and a Focal Point. The `getRoot()` call returns the NodePath of the terrain. It is then reparented to `render` to be a part of the scene graph. You can apply Common State Changes to this NodePath. Finally, the `generate()` call generates the terrain geometry. Note that if the terrain is still quite flat, you will have to scale the terrain NodePath in the Z direction, because by default, the Z positions are between 0 and 1. To fix this, scale the terrain up in the Z direction: (before generating it, otherwise it might require you to regenerate it.)
    terrain.getRoot().setSz(100)
### Dynamic Terrains This code shows a dynamically updated terrain with LOD:
    # Set up the GeoMipTerrain
    terrain = GeoMipTerrain("myDynamicTerrain")
    terrain.setHeightfield(Filename("yourHeightField.png"))

    # Set terrain properties
    terrain.setBlockSize(32)
    terrain.setFactor(100)
    terrain.setFocalPoint(base.camera)

    # Store the root NodePath for convenience
    root = terrain.getRoot()
    root.reparentTo(render)
    root.setSz(100)

    # Generate it.
    terrain.generate()
    # Add a task to keep updating the terrain
    def updateTask(task):
      terrain.update()
      return task.cont
    taskMgr.add(updateTask, "update")
This code shows a dynamically updated terrain, which is updated every frame with the camera as focal point. You see that a few functions are called: The blocksize is set to 32. This means that GeoMipTerrain has to divide the terrain in chunks of 32x32 quads. Next, the factor is set. This is a quality factor, where 0 is a very low quality, and if you make this level higher, the terrain chunks will have a higher quality, depending on the distance to the focal point. Also, the focal point is set to the Camera's NodePath; you can specify any NodePath you want, but also a Point2 or Point3. If you specify the latter, please note that only the X and Y positions are used to calculate the distance; the Z position is disregarded. Note that you need to experiment with those values to get a good quality terrain while still maintaining a good performance. Next, for convenience, the terrain root is stored in a separate variable, which is scaled and placed in the scene graph. The terrain is then initially generated, and a task is created which calls `terrain.update()` every frame. This function calculates the new LOD levels based on the movement of the focal point and updates the chunks which have got a new LOD level. ### Advanced Control The GeoMipTerrain provides some advanced features over the terrain: Minimum Level You can specify a minimum LOD level to GeoMipTerrain. You can do this if you find the terrain a bit too high quality near the focal point, and this could waste your performance. If you set a minimum LOD level, you can prevent this and force the chunks to have a minimum level of detail:
    terrain.setMinLevel(2)
If you make the value higher, it will decrease the quality level near the focal point. Automatic Flattening Since flattening the terrain root might interfere with the updating system, GeoMipTerrain provides an auto-flattening function, which can be really useful if you have too many meshes in your scene. This function calls one of NodePath's flattening functions every time the terrain is regenerated, and each time before the chunks are modified the terrain is restored from a backup node.
    terrain.setAutoFlatten(GeoMipTerrain.AFMStrong)
There are multiple options: AFMStrong, for flattenStrong(), AFMMedium, for flattenMedium(), AFMLight, for flattenLight(), and AFMOff, for no flattening at all. After setting the AutoFlattenMode, GeoMipTerrain will automatically take care of it at the next update() call. ### Notes For a full function overview, see the API page. The GeoMipTerrain generates texture coordinates between 0 and 1, making the texture stretched over the entire terrain. If you are using a shader, please do not directly base the coordinates on the `vtx_position`, because since the terrain can have multiple chunks the vertex position is relative to the chunk. Instead, base your shader calculations on the `vtx_texcoord0` generated by the GeoMipTerrain. The GeoMipTerrain class implements part of the GeoMipMapping algorithm, described in this paper by Willem H. de Boer. In Panda3D versions 1.5.1 and 1.5.2 there is a bug in the bruteforce generator, which might cause your application to crash. It has been fixed in 1.5.3, please upgrade your Panda3D version if you are experiencing this crash. PGMM / GeoMipTerrain is a community-contributed algorithm that is included in Panda3D from version 1.5.1. If you are using an older version of Panda3D, you can download a limited version at the original forum topic. ## Incomplete Section Note: this section is incomplete. It will be updated soon.
<<prev | top | next>> |