Varregion

Varregion

"Varregion" is a feature of OpenSimulator that enables region sizes larger than 256x256. The region is just larger so it acts like a regular region but with borders farther apart.

Restrictions

Some restrictions apply:

• The dimensions must a multiple of 256
• The dimensions must be square if used with Singularity (as of 20131104)
• There must be no adjacent regions (at least one empty 256m space bordering all sides of the large region)
• You must use BulletSim (as of 20131104, ODE has not been modified for varregions)

Configuration

Varregions and OAR Files

Things Known to be Broken

• Rezzing a prim from inventory at greater than <256,256>
• Saving/restoring heightmap when restarting region
  • Start large region, edit large part, restart region, see that edits are not saved

Implementation Notes

What follows are notes I am making as things that might need work are found in OpenSimulator.

• ITerrainLoader implementations
  • How to handle tiles.
  • How to handle large regions sizes.
  • Terrain/FileLoaders/*.cs all return an ITerrainChannel
  • Need to fix all the file reader/writers
  • FileLoaders/LLRAW.cs has several "256"s rather than constant references
• Consider moving terrain XML serialization into TerrainData
• Consider removing all instances of TerrainChannel.GetFloatsSerialized()
  • Replace with passing around TerrainData
• Code in EntityTransferModule that checks distance to decide of to make new connection
  • search for references to 'Constants.RegionSize'
  • Consider removing the distance code and replacing with call to grid service
• WorldMapModule.cs does a lot of arithmetic depending on constants that are really Contants.RegionSize
• Util.IsOutsideView uses Constants.RegionSize. Is use is ScenePresence a problem?
  • Used in ScenePresence.AdjustKnownSeeds()
  • Is this another instance like EntityTransferModule that needs to goto the grid service?
• Move all the short[] heightmap representation stuff into TerrainData.cs (partially done)
  • Is it possible to move all the patch stuff out of TerrainModule/TerrainChannel?
  • Clean up the use of m_revert. It looks like it is not saved after terrain is modified.
• Need to look through RegionCombinerModule.cs and see what safety checks are needed
  • Maybe just prevent combination if not legacy region size
• In LSL_Api.cs, llEdgeOfWorld() does some neighbor computation. Check for ok'ness.
• Blog entry on moving terrain info into class
  • Moving class from OpenSim.Region.Framework into OpenSim.Framework
• The code for cloud and wind needs to be enhanced for larger regions
  • New layer types added
• Ward3DMap/TerrainSplat.cs is filled with "256"s.
  • Doesn't even bother to use the symbolic constants.
• Warp3DMap/Warp3DImageModule.cs is filled with "256"s
• WorldMap/WorldMapModules.cs is filled with "256"S
• Services/MapImageService/MapImageService.cs relies on a constant width of 256
• Region/Framework/Scenes/Tests/BorderTests.cs might need work if non-standard regions are tested
• Verify terrain tests still work (for 256m regions)