-
-
Notifications
You must be signed in to change notification settings - Fork 983
/
Copy pathOgreTerrain.cpp
4741 lines (4259 loc) · 151 KB
/
OgreTerrain.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2014 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#include "OgreTerrain.h"
#include "OgreTerrainQuadTreeNode.h"
#include "OgreStreamSerialiser.h"
#include "OgreMath.h"
#include "OgreImage.h"
#include "OgrePixelFormat.h"
#include "OgreSceneManager.h"
#include "OgreSceneNode.h"
#include "OgreException.h"
#include "OgreBitwise.h"
#include "OgreStringConverter.h"
#include "OgreViewport.h"
#include "OgreLogManager.h"
#include "OgreHardwarePixelBuffer.h"
#include "OgreTextureManager.h"
#include "OgreRoot.h"
#include "OgreRenderSystem.h"
#include "OgreRay.h"
#include "OgrePlane.h"
#include "OgreTerrainMaterialGeneratorA.h"
#include "OgreMaterialManager.h"
#include "OgreHardwareBufferManager.h"
#include "OgreDeflate.h"
#if OGRE_PLATFORM == OGRE_PLATFORM_APPLE_IOS
#include "macUtils.h"
#endif
#if OGRE_COMPILER == OGRE_COMPILER_MSVC
// we do lots of conversions here, casting them all is tedious & cluttered, we know what we're doing
# pragma warning (disable : 4244)
#endif
namespace Ogre
{
//---------------------------------------------------------------------
const uint32 Terrain::TERRAIN_CHUNK_ID = StreamSerialiser::makeIdentifier("TERR");
const uint16 Terrain::TERRAIN_CHUNK_VERSION = 2;
const uint32 Terrain::TERRAINGENERALINFO_CHUNK_ID = StreamSerialiser::makeIdentifier("TGIN");
const uint16 Terrain::TERRAINGENERALINFO_CHUNK_VERSION = 1;
const uint32 Terrain::TERRAINLAYERDECLARATION_CHUNK_ID = StreamSerialiser::makeIdentifier("TDCL");
const uint16 Terrain::TERRAINLAYERDECLARATION_CHUNK_VERSION = 1;
const uint32 Terrain::TERRAINLAYERSAMPLER_CHUNK_ID = StreamSerialiser::makeIdentifier("TSAM");
const uint16 Terrain::TERRAINLAYERSAMPLER_CHUNK_VERSION = 1;
const uint32 Terrain::TERRAINLAYERSAMPLERELEMENT_CHUNK_ID = StreamSerialiser::makeIdentifier("TSEL");
const uint16 Terrain::TERRAINLAYERSAMPLERELEMENT_CHUNK_VERSION = 1;
const uint32 Terrain::TERRAINLAYERINSTANCE_CHUNK_ID = StreamSerialiser::makeIdentifier("TLIN");
const uint16 Terrain::TERRAINLAYERINSTANCE_CHUNK_VERSION = 1;
const uint32 Terrain::TERRAINDERIVEDDATA_CHUNK_ID = StreamSerialiser::makeIdentifier("TDDA");
const uint16 Terrain::TERRAINDERIVEDDATA_CHUNK_VERSION = 1;
// since 129^2 is the greatest power we can address in 16-bit index
const uint16 Terrain::TERRAIN_MAX_BATCH_SIZE = 129;
const uint16 Terrain::WORKQUEUE_DERIVED_DATA_REQUEST = 1;
const uint64 Terrain::TERRAIN_GENERATE_MATERIAL_INTERVAL_MS = 100;
const uint16 Terrain::WORKQUEUE_GENERATE_MATERIAL_REQUEST = 2;
const size_t Terrain::LOD_MORPH_CUSTOM_PARAM = 1001;
const uint8 Terrain::DERIVED_DATA_DELTAS = 1;
const uint8 Terrain::DERIVED_DATA_NORMALS = 2;
const uint8 Terrain::DERIVED_DATA_LIGHTMAP = 4;
// This MUST match the bitwise OR of all the types above with no extra bits!
const uint8 Terrain::DERIVED_DATA_ALL = 7;
//-----------------------------------------------------------------------
template<> TerrainGlobalOptions* Singleton<TerrainGlobalOptions>::msSingleton = 0;
TerrainGlobalOptions* TerrainGlobalOptions::getSingletonPtr(void)
{
return msSingleton;
}
TerrainGlobalOptions& TerrainGlobalOptions::getSingleton(void)
{
assert( msSingleton ); return ( *msSingleton );
}
//---------------------------------------------------------------------
TerrainGlobalOptions::TerrainGlobalOptions()
: mSkirtSize(30)
, mLightMapDir(Vector3(1, -1, 0).normalisedCopy())
, mCastsShadows(false)
, mMaxPixelError(3.0)
, mRenderQueueGroup(RENDER_QUEUE_MAIN)
, mVisibilityFlags(0xFFFFFFFF)
, mQueryFlags(0xFFFFFFFF)
, mUseRayBoxDistanceCalculation(false)
, mLayerBlendMapSize(1024)
, mDefaultLayerTextureWorldSize(10)
, mDefaultGlobalColourMapSize(1024)
, mLightmapSize(1024)
, mCompositeMapSize(1024)
, mCompositeMapAmbient(ColourValue::White)
, mCompositeMapDiffuse(ColourValue::White)
, mCompositeMapDistance(4000)
, mResourceGroup(ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
, mUseVertexCompressionWhenAvailable(true)
{
}
//---------------------------------------------------------------------
void TerrainGlobalOptions::setDefaultMaterialGenerator(TerrainMaterialGeneratorPtr gen)
{
mDefaultMaterialGenerator = gen;
}
//---------------------------------------------------------------------
TerrainMaterialGeneratorPtr TerrainGlobalOptions::getDefaultMaterialGenerator()
{
if (mDefaultMaterialGenerator.isNull())
{
// default
mDefaultMaterialGenerator.bind(OGRE_NEW TerrainMaterialGeneratorA());
}
return mDefaultMaterialGenerator;
}
//---------------------------------------------------------------------
//---------------------------------------------------------------------
NameGenerator Terrain::msBlendTextureGenerator = NameGenerator("TerrBlend");
//---------------------------------------------------------------------
Terrain::Terrain(SceneManager* sm)
: mSceneMgr(sm)
, mResourceGroup(StringUtil::BLANK)
, mIsLoaded(false)
, mModified(false)
, mHeightDataModified(false)
, mHeightData(0)
, mDeltaData(0)
, mAlign(ALIGN_X_Z)
, mWorldSize(0)
, mSize(0)
, mMaxBatchSize(0)
, mMinBatchSize(0)
, mPos(Vector3::ZERO)
, mQuadTree(0)
, mNumLodLevels(0)
, mNumLodLevelsPerLeafNode(0)
, mTreeDepth(0)
, mBase(0)
, mScale(0)
, mSkirtSize(0)
, mRenderQueueGroup(0)
, mVisibilityFlags(0)
, mQueryFlags(0)
, mDirtyGeometryRect(0, 0, 0, 0)
, mDirtyDerivedDataRect(0, 0, 0, 0)
, mDirtyGeometryRectForNeighbours(0, 0, 0, 0)
, mDirtyLightmapFromNeighboursRect(0, 0, 0, 0)
, mDerivedDataUpdateInProgress(false)
, mDerivedUpdatePendingMask(0)
, mGenerateMaterialInProgress(false)
, mPrepareInProgress(false)
, mMaterialGenerationCount(0)
, mMaterialDirty(false)
, mMaterialParamsDirty(false)
, mLayerBlendMapSize(0)
, mLayerBlendMapSizeActual(0)
, mGlobalColourMapSize(0)
, mGlobalColourMapEnabled(false)
, mCpuColourMapStorage(0)
, mLightmapSize(0)
, mLightmapSizeActual(0)
, mCpuLightmapStorage(0)
, mCompositeMapSize(0)
, mCompositeMapSizeActual(0)
, mCpuCompositeMapStorage(0)
, mCompositeMapDirtyRect(0, 0, 0, 0)
, mCompositeMapUpdateCountdown(0)
, mLastMillis(0)
, mCompositeMapDirtyRectLightmapUpdate(false)
, mLodMorphRequired(false)
, mNormalMapRequired(false)
, mLightMapRequired(false)
, mLightMapShadowsOnly(true)
, mCompositeMapRequired(false)
, mCpuTerrainNormalMap(0)
, mLastLODCamera(0)
, mLastLODFrame(0)
, mLastViewportHeight(0)
, mCustomGpuBufferAllocator(0)
, mLodManager(0)
{
mRootNode = sm->getRootSceneNode()->createChildSceneNode();
sm->addListener(this);
WorkQueue* wq = Root::getSingleton().getWorkQueue();
mWorkQueueChannel = wq->getChannel("Ogre/Terrain");
wq->addRequestHandler(mWorkQueueChannel, this);
wq->addResponseHandler(mWorkQueueChannel, this);
// generate a material name, it's important for the terrain material
// name to be consistent & unique no matter what generator is being used
// so use our own pointer as identifier, use FashHash rather than just casting
// the pointer to a long so we support 64-bit pointers
Terrain* pTerrain = this;
mMaterialName = "OgreTerrain/" + StringConverter::toString(FastHash((const char*)&pTerrain, sizeof(Terrain*)));
memset(mNeighbours, 0, sizeof(Terrain*) * NEIGHBOUR_COUNT);
}
//---------------------------------------------------------------------
Terrain::~Terrain()
{
mDerivedUpdatePendingMask = 0;
waitForDerivedProcesses();
WorkQueue* wq = Root::getSingleton().getWorkQueue();
wq->removeRequestHandler(mWorkQueueChannel, this);
wq->removeResponseHandler(mWorkQueueChannel, this);
removeFromNeighbours();
freeLodData();
freeTemporaryResources();
freeGPUResources();
freeCPUResources();
if (mSceneMgr)
{
mSceneMgr->destroySceneNode(mRootNode);
mSceneMgr->removeListener(this);
}
}
//---------------------------------------------------------------------
const AxisAlignedBox& Terrain::getAABB() const
{
if (!mQuadTree)
return AxisAlignedBox::BOX_NULL;
else
return mQuadTree->getAABB();
}
//---------------------------------------------------------------------
AxisAlignedBox Terrain::getWorldAABB() const
{
Matrix4 m = Matrix4::IDENTITY;
m.setTrans(getPosition());
AxisAlignedBox ret = getAABB();
ret.transformAffine(m);
return ret;
}
//---------------------------------------------------------------------
Real Terrain::getMinHeight() const
{
if (!mQuadTree)
return 0;
else
return mQuadTree->getMinHeight();
}
//---------------------------------------------------------------------
Real Terrain::getMaxHeight() const
{
if (!mQuadTree)
return 0;
else
return mQuadTree->getMaxHeight();
}
//---------------------------------------------------------------------
Real Terrain::getBoundingRadius() const
{
if (!mQuadTree)
return 0;
else
return mQuadTree->getBoundingRadius();
}
//---------------------------------------------------------------------
void Terrain::save(const String& filename)
{
// force to load highest lod, or quadTree may contain hole
load(0,true);
#if OGRE_PLATFORM == OGRE_PLATFORM_APPLE_IOS
DataStreamPtr stream = Root::getSingleton().createFileStream(iOSDocumentsDirectory() + "/" + filename,
_getDerivedResourceGroup(), true);
#else
DataStreamPtr stream = Root::getSingleton().createFileStream(filename,
_getDerivedResourceGroup(), true);
#endif
StreamSerialiser ser(stream);
save(ser);
}
//---------------------------------------------------------------------
void Terrain::save(StreamSerialiser& stream)
{
// wait for any queued processes to finish
waitForDerivedProcesses();
if (mHeightDataModified)
{
// When modifying, for efficiency we only increase the max deltas at each LOD,
// we never reduce them (since that would require re-examining more samples)
// Since we now save this data in the file though, we need to make sure we've
// calculated the optimal
Rect rect;
rect.top = 0; rect.bottom = mSize;
rect.left = 0; rect.right = mSize;
calculateHeightDeltas(rect);
finaliseHeightDeltas(rect, false);
}
stream.writeChunkBegin(TERRAIN_CHUNK_ID, TERRAIN_CHUNK_VERSION);
stream.writeChunkBegin(TERRAINGENERALINFO_CHUNK_ID, TERRAINGENERALINFO_CHUNK_VERSION);
uint8 align = (uint8)mAlign;
stream.write(&align);
stream.write(&mSize);
stream.write(&mWorldSize);
stream.write(&mMaxBatchSize);
stream.write(&mMinBatchSize);
stream.write(&mPos);
stream.writeChunkEnd(TERRAINGENERALINFO_CHUNK_ID);
TerrainLodManager::saveLodData(stream,this);
// start compressing
stream.startDeflate();
writeLayerDeclaration(mLayerDecl, stream);
// Layers
checkLayers(false);
uint8 numLayers = (uint8)mLayers.size();
writeLayerInstanceList(mLayers, stream);
// Packed layer blend data
if(!mCpuBlendMapStorage.empty())
{
// save from CPU data if it's there, it means GPU data was never created
stream.write(&mLayerBlendMapSize);
// load packed CPU data
int numBlendTex = getBlendTextureCount(numLayers);
for (int i = 0; i < numBlendTex; ++i)
{
PixelFormat fmt = getBlendTextureFormat(i, numLayers);
size_t channels = PixelUtil::getNumElemBytes(fmt);
size_t dataSz = channels * mLayerBlendMapSize * mLayerBlendMapSize;
uint8* pData = mCpuBlendMapStorage[i];
stream.write(pData, dataSz);
}
}
else
{
if (mLayerBlendMapSize != mLayerBlendMapSizeActual)
{
LogManager::getSingleton().stream() <<
"WARNING: blend maps were requested at a size larger than was supported "
"on this hardware, which means the quality has been degraded";
}
stream.write(&mLayerBlendMapSizeActual);
uint8* tmpData = (uint8*)OGRE_MALLOC(mLayerBlendMapSizeActual * mLayerBlendMapSizeActual * 4, MEMCATEGORY_GENERAL);
uint8 texIndex = 0;
for (TexturePtrList::iterator i = mBlendTextureList.begin(); i != mBlendTextureList.end(); ++i, ++texIndex)
{
// Must blit back in CPU format!
PixelFormat cpuFormat = getBlendTextureFormat(texIndex, getLayerCount());
PixelBox dst(mLayerBlendMapSizeActual, mLayerBlendMapSizeActual, 1, cpuFormat, tmpData);
(*i)->getBuffer()->blitToMemory(dst);
size_t dataSz = PixelUtil::getNumElemBytes((*i)->getFormat()) *
mLayerBlendMapSizeActual * mLayerBlendMapSizeActual;
stream.write(tmpData, dataSz);
}
OGRE_FREE(tmpData, MEMCATEGORY_GENERAL);
}
// other data
// normals
if (mNormalMapRequired)
{
stream.writeChunkBegin(TERRAINDERIVEDDATA_CHUNK_ID, TERRAINDERIVEDDATA_CHUNK_VERSION);
String normalDataType("normalmap");
stream.write(&normalDataType);
stream.write(&mSize);
if (mCpuTerrainNormalMap)
{
// save from CPU data if it's there, it means GPU data was never created
stream.write((uint8*)mCpuTerrainNormalMap->data, mSize * mSize * 3);
}
else
{
uint8* tmpData = (uint8*)OGRE_MALLOC(mSize * mSize * 3, MEMCATEGORY_GENERAL);
PixelBox dst(mSize, mSize, 1, PF_BYTE_RGB, tmpData);
mTerrainNormalMap->getBuffer()->blitToMemory(dst);
stream.write(tmpData, mSize * mSize * 3);
OGRE_FREE(tmpData, MEMCATEGORY_GENERAL);
}
stream.writeChunkEnd(TERRAINDERIVEDDATA_CHUNK_ID);
}
// colourmap
if (mGlobalColourMapEnabled)
{
stream.writeChunkBegin(TERRAINDERIVEDDATA_CHUNK_ID, TERRAINDERIVEDDATA_CHUNK_VERSION);
String colourDataType("colourmap");
stream.write(&colourDataType);
stream.write(&mGlobalColourMapSize);
if (mCpuColourMapStorage)
{
// save from CPU data if it's there, it means GPU data was never created
stream.write(mCpuColourMapStorage, mGlobalColourMapSize * mGlobalColourMapSize * 3);
}
else
{
uint8* tmpData = (uint8*)OGRE_MALLOC(mGlobalColourMapSize * mGlobalColourMapSize * 3, MEMCATEGORY_GENERAL);
PixelBox dst(mGlobalColourMapSize, mGlobalColourMapSize, 1, PF_BYTE_RGB, tmpData);
mColourMap->getBuffer()->blitToMemory(dst);
stream.write(tmpData, mGlobalColourMapSize * mGlobalColourMapSize * 3);
OGRE_FREE(tmpData, MEMCATEGORY_GENERAL);
}
stream.writeChunkEnd(TERRAINDERIVEDDATA_CHUNK_ID);
}
// lightmap
if (mLightMapRequired)
{
stream.writeChunkBegin(TERRAINDERIVEDDATA_CHUNK_ID, TERRAINDERIVEDDATA_CHUNK_VERSION);
String lightmapDataType("lightmap");
stream.write(&lightmapDataType);
stream.write(&mLightmapSize);
if (mCpuLightmapStorage)
{
// save from CPU data if it's there, it means GPU data was never created
stream.write(mCpuLightmapStorage, mLightmapSize * mLightmapSize);
}
else
{
uint8* tmpData = (uint8*)OGRE_MALLOC(mLightmapSize * mLightmapSize, MEMCATEGORY_GENERAL);
PixelBox dst(mLightmapSize, mLightmapSize, 1, PF_L8, tmpData);
mLightmap->getBuffer()->blitToMemory(dst);
stream.write(tmpData, mLightmapSize * mLightmapSize);
OGRE_FREE(tmpData, MEMCATEGORY_GENERAL);
}
stream.writeChunkEnd(TERRAINDERIVEDDATA_CHUNK_ID);
}
// composite map
if (mCompositeMapRequired)
{
stream.writeChunkBegin(TERRAINDERIVEDDATA_CHUNK_ID, TERRAINDERIVEDDATA_CHUNK_VERSION);
String compositeMapDataType("compositemap");
stream.write(&compositeMapDataType);
stream.write(&mCompositeMapSize);
if (mCpuCompositeMapStorage)
{
// save from CPU data if it's there, it means GPU data was never created
stream.write(mCpuCompositeMapStorage, mCompositeMapSize * mCompositeMapSize * 4);
}
else
{
// composite map is 4 channel, 3x diffuse, 1x specular mask
uint8* tmpData = (uint8*)OGRE_MALLOC(mCompositeMapSize * mCompositeMapSize * 4, MEMCATEGORY_GENERAL);
PixelBox dst(mCompositeMapSize, mCompositeMapSize, 1, PF_BYTE_RGBA, tmpData);
mCompositeMap->getBuffer()->blitToMemory(dst);
stream.write(tmpData, mCompositeMapSize * mCompositeMapSize * 4);
OGRE_FREE(tmpData, MEMCATEGORY_GENERAL);
}
stream.writeChunkEnd(TERRAINDERIVEDDATA_CHUNK_ID);
}
// write the quadtree
mQuadTree->save(stream);
// stop compressing
stream.stopDeflate();
stream.writeChunkEnd(TERRAIN_CHUNK_ID);
mModified = false;
mHeightDataModified = false;
}
//---------------------------------------------------------------------
void Terrain::writeLayerDeclaration(const TerrainLayerDeclaration& decl, StreamSerialiser& stream)
{
// Layer declaration
stream.writeChunkBegin(TERRAINLAYERDECLARATION_CHUNK_ID, TERRAINLAYERDECLARATION_CHUNK_VERSION);
// samplers
uint8 numSamplers = (uint8)decl.samplers.size();
stream.write(&numSamplers);
for (TerrainLayerSamplerList::const_iterator i = decl.samplers.begin();
i != decl.samplers.end(); ++i)
{
const TerrainLayerSampler& sampler = *i;
stream.writeChunkBegin(TERRAINLAYERSAMPLER_CHUNK_ID, TERRAINLAYERSAMPLER_CHUNK_VERSION);
stream.write(&sampler.alias);
uint8 pixFmt = (uint8)sampler.format;
stream.write(&pixFmt);
stream.writeChunkEnd(TERRAINLAYERSAMPLER_CHUNK_ID);
}
// elements
uint8 numElems = (uint8)decl.elements.size();
stream.write(&numElems);
for (TerrainLayerSamplerElementList::const_iterator i = decl.elements.begin();
i != decl.elements.end(); ++i)
{
const TerrainLayerSamplerElement& elem= *i;
stream.writeChunkBegin(TERRAINLAYERSAMPLERELEMENT_CHUNK_ID, TERRAINLAYERSAMPLERELEMENT_CHUNK_VERSION);
stream.write(&elem.source);
uint8 sem = (uint8)elem.semantic;
stream.write(&sem);
stream.write(&elem.elementStart);
stream.write(&elem.elementCount);
stream.writeChunkEnd(TERRAINLAYERSAMPLERELEMENT_CHUNK_ID);
}
stream.writeChunkEnd(TERRAINLAYERDECLARATION_CHUNK_ID);
}
//---------------------------------------------------------------------
bool Terrain::readLayerDeclaration(StreamSerialiser& stream, TerrainLayerDeclaration& targetdecl)
{
if (!stream.readChunkBegin(TERRAINLAYERDECLARATION_CHUNK_ID, TERRAINLAYERDECLARATION_CHUNK_VERSION))
return false;
// samplers
uint8 numSamplers;
stream.read(&numSamplers);
targetdecl.samplers.resize(numSamplers);
for (uint8 s = 0; s < numSamplers; ++s)
{
if (!stream.readChunkBegin(TERRAINLAYERSAMPLER_CHUNK_ID, TERRAINLAYERSAMPLER_CHUNK_VERSION))
return false;
stream.read(&(targetdecl.samplers[s].alias));
uint8 pixFmt;
stream.read(&pixFmt);
targetdecl.samplers[s].format = (PixelFormat)pixFmt;
stream.readChunkEnd(TERRAINLAYERSAMPLER_CHUNK_ID);
}
// elements
uint8 numElems;
stream.read(&numElems);
targetdecl.elements.resize(numElems);
for (uint8 e = 0; e < numElems; ++e)
{
if (!stream.readChunkBegin(TERRAINLAYERSAMPLERELEMENT_CHUNK_ID, TERRAINLAYERSAMPLERELEMENT_CHUNK_VERSION))
return false;
stream.read(&(targetdecl.elements[e].source));
uint8 sem;
stream.read(&sem);
targetdecl.elements[e].semantic = (TerrainLayerSamplerSemantic)sem;
stream.read(&(targetdecl.elements[e].elementStart));
stream.read(&(targetdecl.elements[e].elementCount));
stream.readChunkEnd(TERRAINLAYERSAMPLERELEMENT_CHUNK_ID);
}
stream.readChunkEnd(TERRAINLAYERDECLARATION_CHUNK_ID);
return true;
}
//---------------------------------------------------------------------
void Terrain::writeLayerInstanceList(const Terrain::LayerInstanceList& layers, StreamSerialiser& stream)
{
uint8 numLayers = (uint8)layers.size();
stream.write(&numLayers);
for (LayerInstanceList::const_iterator i = layers.begin(); i != layers.end(); ++i)
{
const LayerInstance& inst = *i;
stream.writeChunkBegin(TERRAINLAYERINSTANCE_CHUNK_ID, TERRAINLAYERINSTANCE_CHUNK_VERSION);
stream.write(&inst.worldSize);
for (StringVector::const_iterator t = inst.textureNames.begin();
t != inst.textureNames.end(); ++t)
{
stream.write(&(*t));
}
stream.writeChunkEnd(TERRAINLAYERINSTANCE_CHUNK_ID);
}
}
//---------------------------------------------------------------------
bool Terrain::readLayerInstanceList(StreamSerialiser& stream, size_t numSamplers, Terrain::LayerInstanceList& targetlayers)
{
uint8 numLayers;
stream.read(&numLayers);
targetlayers.resize(numLayers);
for (uint8 l = 0; l < numLayers; ++l)
{
if (!stream.readChunkBegin(TERRAINLAYERINSTANCE_CHUNK_ID, TERRAINLAYERINSTANCE_CHUNK_VERSION))
return false;
stream.read(&targetlayers[l].worldSize);
targetlayers[l].textureNames.resize(numSamplers);
for (size_t t = 0; t < numSamplers; ++t)
{
stream.read(&(targetlayers[l].textureNames[t]));
}
stream.readChunkEnd(TERRAINLAYERINSTANCE_CHUNK_ID);
}
return true;
}
//---------------------------------------------------------------------
const String& Terrain::_getDerivedResourceGroup() const
{
if (mResourceGroup.empty())
return TerrainGlobalOptions::getSingleton().getDefaultResourceGroup();
else
return mResourceGroup;
}
//---------------------------------------------------------------------
bool Terrain::prepare(const String& filename)
{
DataStreamPtr stream = ResourceGroupManager::getSingleton().openResource(filename, _getDerivedResourceGroup());
return prepare(stream);
}
//---------------------------------------------------------------------
bool Terrain::prepare(DataStreamPtr& stream)
{
freeLodData();
mLodManager = OGRE_NEW TerrainLodManager( this, stream );
StreamSerialiser ser(stream);
return prepare(ser);
}
//---------------------------------------------------------------------
bool Terrain::prepare(StreamSerialiser& stream)
{
mPrepareInProgress = true;
freeTemporaryResources();
freeCPUResources();
if(mLodManager == NULL)
{
mLodManager = OGRE_NEW TerrainLodManager( this );
}
copyGlobalOptions();
const StreamSerialiser::Chunk *mainChunk = stream.readChunkBegin(TERRAIN_CHUNK_ID, TERRAIN_CHUNK_VERSION);
if (!mainChunk)
return false;
if(mainChunk->version > 1)
stream.readChunkBegin(Terrain::TERRAINGENERALINFO_CHUNK_ID, Terrain::TERRAINGENERALINFO_CHUNK_VERSION);
uint8 align;
stream.read(&align);
mAlign = (Alignment)align;
stream.read(&mSize);
stream.read(&mWorldSize);
stream.read(&mMaxBatchSize);
stream.read(&mMinBatchSize);
stream.read(&mPos);
mRootNode->setPosition(mPos);
updateBaseScale();
determineLodLevels();
if(mainChunk->version > 1)
stream.readChunkEnd(Terrain::TERRAINGENERALINFO_CHUNK_ID);
size_t numVertices = mSize * mSize;
mHeightData = OGRE_ALLOC_T(float, numVertices, MEMCATEGORY_GEOMETRY);
mDeltaData = OGRE_ALLOC_T(float, numVertices, MEMCATEGORY_GEOMETRY);
// As we may not load full data, so we should make it clean first
memset(mHeightData, 0.0f, sizeof(float)*numVertices);
memset(mDeltaData, 0.0f, sizeof(float)*numVertices);
if(mainChunk->version > 1)
{
// skip height/delta data
for (int i = 0; i < mNumLodLevels; i++)
{
stream.readChunkBegin(TerrainLodManager::TERRAINLODDATA_CHUNK_ID, TerrainLodManager::TERRAINLODDATA_CHUNK_VERSION);
stream.readChunkEnd(TerrainLodManager::TERRAINLODDATA_CHUNK_ID);
}
// start uncompressing
stream.startDeflate( mainChunk->length - stream.getOffsetFromChunkStart() );
}
else
{
stream.read(mHeightData, numVertices);
}
// Layer declaration
if (!readLayerDeclaration(stream, mLayerDecl))
return false;
checkDeclaration();
// Layers
if (!readLayerInstanceList(stream, mLayerDecl.samplers.size(), mLayers))
return false;
deriveUVMultipliers();
// Packed layer blend data
uint8 numLayers = (uint8)mLayers.size();
stream.read(&mLayerBlendMapSize);
mLayerBlendMapSizeActual = mLayerBlendMapSize; // for now, until we check
// load packed CPU data
int numBlendTex = getBlendTextureCount(numLayers);
for (int i = 0; i < numBlendTex; ++i)
{
PixelFormat fmt = getBlendTextureFormat(i, numLayers);
size_t channels = PixelUtil::getNumElemBytes(fmt);
size_t dataSz = channels * mLayerBlendMapSize * mLayerBlendMapSize;
uint8* pData = (uint8*)OGRE_MALLOC(dataSz, MEMCATEGORY_RESOURCE);
stream.read(pData, dataSz);
mCpuBlendMapStorage.push_back(pData);
}
// derived data
while (!stream.isEndOfChunk(TERRAIN_CHUNK_ID) &&
stream.peekNextChunkID() == TERRAINDERIVEDDATA_CHUNK_ID)
{
stream.readChunkBegin(TERRAINDERIVEDDATA_CHUNK_ID, TERRAINDERIVEDDATA_CHUNK_VERSION);
// name
String name;
stream.read(&name);
uint16 sz;
stream.read(&sz);
if (name == "normalmap")
{
mNormalMapRequired = true;
uint8* pData = static_cast<uint8*>(OGRE_MALLOC(sz * sz * 3, MEMCATEGORY_GENERAL));
mCpuTerrainNormalMap = OGRE_NEW PixelBox(sz, sz, 1, PF_BYTE_RGB, pData);
stream.read(pData, sz * sz * 3);
}
else if (name == "colourmap")
{
mGlobalColourMapEnabled = true;
mGlobalColourMapSize = sz;
mCpuColourMapStorage = static_cast<uint8*>(OGRE_MALLOC(sz * sz * 3, MEMCATEGORY_GENERAL));
stream.read(mCpuColourMapStorage, sz * sz * 3);
}
else if (name == "lightmap")
{
mLightMapRequired = true;
mLightmapSize = sz;
mCpuLightmapStorage = static_cast<uint8*>(OGRE_MALLOC(sz * sz, MEMCATEGORY_GENERAL));
stream.read(mCpuLightmapStorage, sz * sz);
}
else if (name == "compositemap")
{
mCompositeMapRequired = true;
mCompositeMapSize = sz;
mCpuCompositeMapStorage = static_cast<uint8*>(OGRE_MALLOC(sz * sz * 4, MEMCATEGORY_GENERAL));
stream.read(mCpuCompositeMapStorage, sz * sz * 4);
}
stream.readChunkEnd(TERRAINDERIVEDDATA_CHUNK_ID);
}
if(mainChunk->version == 1)
{
// Load delta data
mDeltaData = OGRE_ALLOC_T(float, numVertices, MEMCATEGORY_GEOMETRY);
stream.read(mDeltaData, numVertices);
}
// Create & load quadtree
mQuadTree = OGRE_NEW TerrainQuadTreeNode(this, 0, 0, 0, mSize, mNumLodLevels - 1, 0, 0);
mQuadTree->prepare(stream);
// stop uncompressing
if(mainChunk->version > 1)
stream.stopDeflate();
stream.readChunkEnd(TERRAIN_CHUNK_ID);
mModified = false;
mHeightDataModified = false;
mPrepareInProgress = false;
return true;
}
//---------------------------------------------------------------------
bool Terrain::prepare(const ImportData& importData)
{
mPrepareInProgress = true;
freeTemporaryResources();
freeLodData();
freeCPUResources();
mLodManager = OGRE_NEW TerrainLodManager( this );
copyGlobalOptions();
// validate
if (!(Bitwise::isPO2(importData.terrainSize - 1) && Bitwise::isPO2(importData.minBatchSize - 1)
&& Bitwise::isPO2(importData.maxBatchSize - 1)))
{
OGRE_EXCEPT(Exception::ERR_INVALIDPARAMS,
"terrainSize, minBatchSize and maxBatchSize must all be 2^n + 1",
"Terrain::prepare");
}
if (importData.minBatchSize > importData.maxBatchSize)
{
OGRE_EXCEPT(Exception::ERR_INVALIDPARAMS,
"minBatchSize must be less than or equal to maxBatchSize",
"Terrain::prepare");
}
if (importData.maxBatchSize > TERRAIN_MAX_BATCH_SIZE)
{
OGRE_EXCEPT(Exception::ERR_INVALIDPARAMS,
"maxBatchSize must be no larger than " +
StringConverter::toString(TERRAIN_MAX_BATCH_SIZE),
"Terrain::prepare");
}
mAlign = importData.terrainAlign;
mSize = importData.terrainSize;
mWorldSize = importData.worldSize;
mLayerDecl = importData.layerDeclaration;
checkDeclaration();
mLayers = importData.layerList;
checkLayers(false);
deriveUVMultipliers();
mMaxBatchSize = importData.maxBatchSize;
mMinBatchSize = importData.minBatchSize;
setPosition(importData.pos);
updateBaseScale();
determineLodLevels();
size_t numVertices = mSize * mSize;
mHeightData = OGRE_ALLOC_T(float, numVertices, MEMCATEGORY_GEOMETRY);
if (importData.inputFloat)
{
if (Math::RealEqual(importData.inputBias, 0.0) && Math::RealEqual(importData.inputScale, 1.0))
{
// straight copy
memcpy(mHeightData, importData.inputFloat, sizeof(float) * numVertices);
}
else
{
// scale & bias
float* src = importData.inputFloat;
float* dst = mHeightData;
for (size_t i = 0; i < numVertices; ++i)
*dst++ = (*src++ * importData.inputScale) + importData.inputBias;
}
}
else if (importData.inputImage)
{
Image* img = importData.inputImage;
if (img->getWidth() != mSize || img->getHeight() != mSize)
img->resize(mSize, mSize);
// convert image data to floats
// Do this on a row-by-row basis, because we describe the terrain in
// a bottom-up fashion (ie ascending world coords), while Image is top-down
unsigned char* pSrcBase = img->getData();
for (size_t i = 0; i < mSize; ++i)
{
size_t srcy = mSize - i - 1;
unsigned char* pSrc = pSrcBase + srcy * img->getRowSpan();
float* pDst = mHeightData + i * mSize;
PixelUtil::bulkPixelConversion(pSrc, img->getFormat(),
pDst, PF_FLOAT32_R, mSize);
}
if (!Math::RealEqual(importData.inputBias, 0.0) || !Math::RealEqual(importData.inputScale, 1.0))
{
float* pAdj = mHeightData;
for (size_t i = 0; i < numVertices; ++i)
{
*pAdj = (*pAdj * importData.inputScale) + importData.inputBias;
++pAdj;
}
}
}
else
{
// start with flat terrain
if (importData.constantHeight == 0)
memset(mHeightData, 0, sizeof(float) * mSize * mSize);
else
{
float* pFloat = mHeightData;
for (long i = 0 ; i < mSize * mSize; ++i)
*pFloat++ = importData.constantHeight;
}
}
mDeltaData = OGRE_ALLOC_T(float, numVertices, MEMCATEGORY_GEOMETRY);
memset(mDeltaData, 0, sizeof(float) * numVertices);
mQuadTree = OGRE_NEW TerrainQuadTreeNode(this, 0, 0, 0, mSize, mNumLodLevels - 1, 0, 0);
mQuadTree->prepare();
// calculate entire terrain
Rect rect;
rect.top = 0; rect.bottom = mSize;
rect.left = 0; rect.right = mSize;
calculateHeightDeltas(rect);
finaliseHeightDeltas(rect, true);
distributeVertexData();
// Imported data is treated as modified because it's not saved
mModified = true;
mHeightDataModified = true;
mPrepareInProgress = false;
return true;
}
//---------------------------------------------------------------------
void Terrain::copyGlobalOptions()
{
TerrainGlobalOptions& opts = TerrainGlobalOptions::getSingleton();
mSkirtSize = opts.getSkirtSize();
mRenderQueueGroup = opts.getRenderQueueGroup();
mVisibilityFlags = opts.getVisibilityFlags();
mQueryFlags = opts.getQueryFlags();
mLayerBlendMapSize = opts.getLayerBlendMapSize();
mLayerBlendMapSizeActual = mLayerBlendMapSize; // for now, until we check
mLightmapSize = opts.getLightMapSize();
mLightmapSizeActual = mLightmapSize; // for now, until we check
mCompositeMapSize = opts.getCompositeMapSize();
mCompositeMapSizeActual = mCompositeMapSize; // for now, until we check
}
//---------------------------------------------------------------------
void Terrain::determineLodLevels()
{
/* On a leaf-node basis, LOD can vary from maxBatch to minBatch in
number of vertices. After that, nodes will be gathered into parent
nodes with the same number of vertices, but they are combined with
3 of their siblings. In practice, the number of LOD levels overall
is:
LODlevels = log2(size - 1) - log2(minBatch - 1) + 1
TreeDepth = log2((size - 1) / (maxBatch - 1)) + 1
.. it's just that at the max LOD, the terrain is divided into
(size - 1) / (maxBatch - 1) tiles each of maxBatch vertices, and
at the lowest LOD the terrain is made up of one single tile of
minBatch vertices.
Example: size = 257, minBatch = 17, maxBatch = 33
LODlevels = log2(257 - 1) - log2(17 - 1) + 1 = 8 - 4 + 1 = 5
TreeDepth = log2((size - 1) / (maxBatch - 1)) + 1 = 4
LOD list - this assumes everything changes at once, which rarely happens of course
in fact except where groupings must occur, tiles can change independently
LOD 0: 257 vertices, 8 x 33 vertex tiles (tree depth 3)
LOD 1: 129 vertices, 8 x 17 vertex tiles (tree depth 3)
LOD 2: 65 vertices, 4 x 17 vertex tiles (tree depth 2)
LOD 3: 33 vertices, 2 x 17 vertex tiles (tree depth 1)
LOD 4: 17 vertices, 1 x 17 vertex tiles (tree depth 0)
Notice how we only have 2 sizes of index buffer to be concerned about,
17 vertices (per side) or 33. This makes buffer re-use much easier while
still giving the full range of LODs.
*/
mNumLodLevelsPerLeafNode = (uint16) (Math::Log2(mMaxBatchSize - 1.0f) - Math::Log2(mMinBatchSize - 1.0f) + 1.0f);
mNumLodLevels = (uint16) (Math::Log2(mSize - 1.0f) - Math::Log2(mMinBatchSize - 1.0f) + 1.0f);
//mTreeDepth = Math::Log2(mMaxBatchSize - 1) - Math::Log2(mMinBatchSize - 1) + 2;
mTreeDepth = mNumLodLevels - mNumLodLevelsPerLeafNode + 1;
LogManager::getSingleton().stream() << "Terrain created; size=" << mSize
<< " minBatch=" << mMinBatchSize << " maxBatch=" << mMaxBatchSize
<< " treeDepth=" << mTreeDepth << " lodLevels=" << mNumLodLevels
<< " leafLods=" << mNumLodLevelsPerLeafNode;
}
//---------------------------------------------------------------------
void Terrain::distributeVertexData()
{
/* Now we need to figure out how to distribute vertex data. We want to
use 16-bit indexes for compatibility, which means that the maximum patch
size that we can address (even sparsely for lower LODs) is 129x129
(the next one up, 257x257 is too big).
So we need to split the vertex data into chunks of 129. The number of
primary tiles this creates also indicates the point above which in
the node tree that we can no longer merge tiles at lower LODs without
using different vertex data. For example, using the 257x257 input example
above, the vertex data would have to be split in 2 (in each dimension)
in order to fit within the 129x129 range. This data could be shared by
all tree depths from 1 onwards, it's just that LODs 3-1 would sample