Here is some information about the Terrain Scene Manager.
Note: The scene manager will work up to Ogre 1.7. Ogre 1.8 and newer versions won't support this scene manager, because of the new Ogre Terrain System with many improvements (which released with Ogre 1.7).
Table of contents
- Configuration Parameters
- Using Custom Materials
- Dirty notes
- See also
- 1. Definitions
- 2. Fair Use Rights
- 3. License Grant
- 4. Restrictions
- 5. Representations, Warranties and Disclaimer
- 6. Limitation on Liability.
- 7. Termination
- 8. Miscellaneous
The shape and coloration of the terrain in your scene is computed from a heightmap, a terrain texture and a detail texture. The heightmap is a simple greyscale image in which each pixel represents a height value, where 0 is ground level and 255 (resp. 65535 at 16 bit) represents the highest point in your terrain. The samples include a heightmap called terrain.png which you can use for experimentation.
The terrain is textured with an image that is stretched over the terrain. These terrain textures are typically mottled brown, green, white or grey for earth, grass, snow or rock terrain. Since terrain textures are normally much smaller than the terrain being covered, terrain normally appears blurred when viewed close up. To help with this, a detail texture is used, which is blended with the terrain texture when viewed from close distances. The detail texture is not stretched as much as the terrain texture, removing the blurriness of terrains viewed close up. The samples include textures called terrain_texture.jpg and terrain_detail.jpg which you can use for experimentation.
Terrains are divided into a grid of terrain tiles. Terrain tiles may be displayed by the scene manager at a differing level of detail, depending on the topology of the tile and the distance from the viewer.
The entire terrain is projected within a world coordinate space which specifies the dimensions of the terrain in 3-space.
The -LOD calculation for the Terrain Scene Manager is based on this paper.
Terrain Scene Manager uses GeoMipmapping. The -LOD of the terrain chunks are chosen based on camera distance, and they are organised and culled inside an Octree (since the TerrainSceneManager builds on the OctreeSceneManager).
The Terrain Scene Manager is configured via the terrain.cfg script.
The basic parameters from this script are:
- __WorldTexture''': Specifies the name of the terrain texture.
- DetailTexture: Specifies the name of the detail texture.
- DetailTile: This specifies the number of times that the detail texture will be repeated in each terrain tile. I.e., if the value is n, the detail texture will be displayed in an nxn grid within each terrain tile. Setting this can involve some experimentation. If this number is low, the terrain may appear blurry at close distances. If this number is high, the terrain may appear to have repeating patterns when viewed over a distance.
- PageSource: Specifies the source of the heightmap. By default, Heightmap.
- Heightmap.image: The image file from which the heightmap is drawn. Thus must be a square where each dimension is of size 2^n+1, for some integer n. The larger the size of the heightmap, the more detail the terrain will have, but the more resources your application will consume (including longer application start time.) 8 bits or 16 bits height maps are supported. Important: The image format must be saved in monochrome mode - height maps in RGB mode (24bit) will throw an exception.
- PageSize: The terrain will be PageSize x PageSize vertices large. PageSize must have the same value as the dimension of the heightmap image, and so must also have a value 2^n+1 for some integer n.
- TileSize: Terrain tiles have the dimension TileSize x TileSize vertices. This number must be smaller than PageSize. TileSize must have a value 2^n+1 for some integer n''. Making tile size too small impacts performance significantly while making tiles too large may result in unnecessarily high detail in some parts of the scene.
- MaxPixelError: This specifies the maximum error tolerated when determining which level of detail to use. Setting this value too high can result in seams in the terrain. Setting the value too low can impact performance. This is the main way to control the distance at which the terrain displays LODs — it is not a distance in world units but rather how much error can appear on the screen. The more error allowed, the less detailed the LODs can become.
- PageWorldX, PageWorldZ: This sets the extents of the terrain in world coordinates. The larger the terrain, the lower the detail will be in the terrain, as the number of vertices used for the terrain is based on the heightmap, not the world size. This can be used to scale the terrain to any size you want.
- MaxHeight: The maximum height of the terrain in world coordinates. The 0..255 (resp. 0..65535) range from the heightmap is scaled to 0..MaxHeight in world coordinates.
- MaxMipMapLevel: Specifies the number of levels of detail that will be used in rendering the terrain. Terrain that is distant or is relatively flat can be rendered with less detail.
Some heightmap generators save data in a raw format rather than an image format. The following parameters describe the raw format.
- Heightmap.raw.size: Specifies the dimension of one side of the heightmap. This must be a value 2^n+1 for some integer n.
- Heightmap.raw.bpp: Specifies the bytes per pixel in the file. (1 for 8 bits, 2 for 16 bits, maybe also 3 for 24 bits support?)
- Heightmap.flip: When set to true, flips the heightmap. Required for Terragen heightmaps.
The following parameters control other aspects of the scene manager's operation. Can someone fill in better descriptions for these?
- VertexNormals: This makes the TerrainSceneManager calculate and set vertex normals in the hardware buffer. If you use lighting or a GPU program that requires it, you should turn this on.
- VertexColours: This makes the TerrainSceneManager calculate and set the vertex colors in the hardware buffer. Turn this on if you use a GPU program that needs this information.
- UseTriStrips: When set to yes, optimizes the order in which terrain triangles are sent to the GPU so that fewer vertices are sent (though on most newer graphics cards this does not make a difference in framerate). Because this causes "cracks" to appear in some video cards and has little or no performance benefit, it is recommended that you turn this off.
- VertexProgramMorph: Use vertex program to morph -LODs, if available.
- LODMorphStart: The proportional distance range at which the -LOD morph starts to take effect. This is as a proportion of the distance between the current LODs effective range, and the effective range of the next lower LOD.
Instead of using the terrain and detail textures to shade the terrain, you can provide your own shading routines, specified in your own material. A typical use of this would be to provide vertex programs in your material.
- MorphLODFactorParamName: This option is used if VertexProgramMorph is set to yes and your custom material includes a high-level vertex program. This option specifies the name of the vertex program parameter to which you wish to bind the morph LOD. This parameter is 0 when there is no adjustment (highest) to 1 when the morph takes it completely to the same position as the next lower LOD.
- MorphLODFactorParamIndex: This option is used if VertexProgramMorph is set to yes and your custom material includes an assemler-level vertex program. This option represents the index of the vertex program parameter to which you wish to bind the morph -LOD factor. This is 0 when there is no adjustment (highest) to 1 when the morph takes it completely to the same position as the next lower LOD.
- CustomMaterialName: The name of the material you will define to shade the terrain.
You can use custom materials to render your terrain. If your material contains a vertex program, the following parameters are available:
- two sets of texture coordinates (index 0 is world texture, index 1 is detail texture)
- Normals, if enabled
- Per-vertex delta values, for morphing a higher -LOD tile into a lower -LOD tile. This is one float per vertex bound as 'blend weight'. If you want to use this you also have to provide the name or index of the parameter you wish to receive the morph factor.
Here are some plain notes. The style etc. has to be improved later. Also remove of redundancy.
... some of my points got lost by a Firefox crash /-:
- The image dimensions of Heightmap.image has to be equal to PageSize
- The Terrain is constructed as a page of terrain tiles
- Terrain Scene Manager (TSM) has only one tile
- Paging Scene Manager is an improved version of TSM (right??) that support different tiles
- Related to the last point is a strange thing:
- TileSize has to be defined and must be smaller than PageSize
# How large is a page of tiles (in vertices)? Must be (2§64d9ef338a19bd9582f05cd5127523bb§n)+1 PageSize=513 # How large is each tile? Must be (2§905d5658f24a2751b8770617fc63b91c§n)+1 and be smaller than PageSize TileSize=129
- The terrain is composed of PageSize^2 vertices
- World coordinates range from (0, 0, 0) to (PageWorldX, MaxHeight, PageWorldZ)
- The WorldTexture is stretched over the entire world
- And for the Paging Scene Manager for each tile ?? (please fill in if you know)
- Common used file formats are JPG and PNG
- PageSource can have any value that has been registered as a TerrainPageSource
- TSM is a sub-class of OctreeSceneManager and uses an octree for culling.
- The mipmaps in terrain.cfg are about -LOD, how many levels of -LOD to provide for the terrain tiles.
- VertexNormals=yes makes Ogre compute normals at each vertex for use with dynamic lighting of the terrain
- VertexColours=yes creates a vertex element for diffuse colours
- is implemented yet?
- maybe VertexColors instead? (without U at colours)
- UseTriStrips=yes as it implies, whether to use tri strips for rendering the terrain
- The terrain of TSM can't be used for collision detection in combination with Newton physics engine
- alternatively see Using PLSM2 with Newton
- Ogre API for TerrainSceneManager
- Basic Tutorial 3 - about Terrain, Sky, Fog, and the Root object
- Terrain Alpha Splatting - a working example using the standard terrain scenemanager, complete with CG shader
- its Terrain Configuration File - an example configuration
- Paging Scene Manager
- Terrain Howto
- Ogre Compatible HeightMap - code snippet for function getHeightAt(x,z)
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
- "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
- "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
- "Licensor" means the individual or entity that offers the Work under the terms of this License.
- "Original Author" means the individual or entity who created the Work.
- "Work" means the copyrightable work of authorship offered under the terms of this License.
- "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
- "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.
Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.
Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
- to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
- to create and reproduce Derivative Works;
- to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
- to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
- For the avoidance of doubt, where the work is a musical composition:
- Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
- Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
- Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).
The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.
The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
- You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
- You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
- If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.
UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
- This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
- Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
- Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
- Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
- If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
- No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
- This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.