1
/* OpenSceneGraph example, osgkeystone.
3
* Permission is hereby granted, free of charge, to any person obtaining a copy
4
* of this software and associated documentation files (the "Software"), to deal
5
* in the Software without restriction, including without limitation the rights
6
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
* copies of the Software, and to permit persons to whom the Software is
8
* furnished to do so, subject to the following conditions:
10
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
11
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
12
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
13
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
14
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
15
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20
#include <osg/io_utils>
21
#include <osg/DisplaySettings>
22
#include <osg/ValueObject>
24
#include <osgDB/WriteFile>
25
#include <osgDB/ReadFile>
27
#include <osgViewer/Keystone>
29
using namespace osgViewer;
32
keystoneEditingEnabled(false),
33
gridColour(1.0f,1.0f,1.0f,1.0f),
34
bottom_left(-1.0,-1.0),
35
bottom_right(1.0,-1.0),
39
Keystone::Keystone(const Keystone& rhs, const osg::CopyOp & copyop):
40
osg::Object(rhs, copyop),
41
keystoneEditingEnabled(rhs.keystoneEditingEnabled),
42
gridColour(rhs.gridColour),
43
bottom_left(rhs.bottom_left),
44
bottom_right(rhs.bottom_right),
45
top_left(rhs.top_left),
46
top_right(rhs.top_right) {}
49
void Keystone::reset()
51
bottom_left.set(-1.0,-1.0);
52
bottom_right.set(1.0,-1.0);
53
top_left.set(-1.0,1.0);
54
top_right.set(1.0,1.0);
57
Keystone& Keystone::operator = (const Keystone& rhs)
59
if (&rhs==this) return *this;
60
keystoneEditingEnabled = rhs.keystoneEditingEnabled;
61
gridColour = rhs.gridColour;
62
bottom_left = rhs.bottom_left;
63
bottom_right = rhs.bottom_right;
64
top_left = rhs.top_left;
65
top_right = rhs.top_right;
69
void Keystone::compute3DPositions(osg::DisplaySettings* ds, osg::Vec3& tl, osg::Vec3& tr, osg::Vec3& br, osg::Vec3& bl) const
71
double tr_x = ((top_right-bottom_right).length()) / ((top_left-bottom_left).length());
72
double r_left = sqrt(tr_x);
73
double r_right = r_left/tr_x;
75
double tr_y = ((top_right-top_left).length()) / ((bottom_right-bottom_left).length());
76
double r_bottom = sqrt(tr_y);
77
double r_top = r_bottom/tr_y;
79
double screenDistance = ds->getScreenDistance();
80
double screenWidth = ds->getScreenWidth();
81
double screenHeight = ds->getScreenHeight();
83
tl = osg::Vec3(screenWidth*0.5*top_left.x(), screenHeight*0.5*top_left.y(), -screenDistance)*r_left*r_top;
84
tr = osg::Vec3(screenWidth*0.5*top_right.x(), screenHeight*0.5*top_right.y(), -screenDistance)*r_right*r_top;
85
br = osg::Vec3(screenWidth*0.5*bottom_right.x(), screenHeight*0.5*bottom_right.y(), -screenDistance)*r_right*r_bottom;
86
bl = osg::Vec3(screenWidth*0.5*bottom_left.x(), screenHeight*0.5*bottom_left.y(), -screenDistance)*r_left*r_bottom;
89
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
91
// Keystone helper functions
93
struct KeystoneCullCallback : public osg::Drawable::CullCallback
95
KeystoneCullCallback(Keystone* keystone=0):_keystone(keystone) {}
96
KeystoneCullCallback(const KeystoneCullCallback&, const osg::CopyOp&) {}
98
META_Object(osg,KeystoneCullCallback);
100
/** do customized cull code, return true if drawable should be culled.*/
101
virtual bool cull(osg::NodeVisitor* /*nv*/, osg::Drawable* /*drawable*/, osg::RenderInfo* /*renderInfo*/) const
103
return _keystone.valid() ? !_keystone->getKeystoneEditingEnabled() : true;
106
osg::ref_ptr<Keystone> _keystone;
110
struct KeystoneUpdateCallback : public osg::Drawable::UpdateCallback
112
KeystoneUpdateCallback(Keystone* keystone=0):_keystone(keystone) {}
113
KeystoneUpdateCallback(const KeystoneUpdateCallback&, const osg::CopyOp&) {}
115
META_Object(osg,KeystoneUpdateCallback);
117
/** do customized update code.*/
118
virtual void update(osg::NodeVisitor*, osg::Drawable* drawable)
120
update(dynamic_cast<osg::Geometry*>(drawable));
123
void update(osg::Geometry* geometry)
125
if (!geometry) return;
127
osg::Vec3Array* vertices = dynamic_cast<osg::Vec3Array*>(geometry->getVertexArray());
128
if (!vertices) return;
130
osg::Vec2Array* texcoords = dynamic_cast<osg::Vec2Array*>(geometry->getTexCoordArray(0));
131
if (!texcoords) return;
133
osg::Vec3 tl, tr, br, bl;
135
_keystone->compute3DPositions(osg::DisplaySettings::instance().get(), tl, tr, br, bl);
137
for(unsigned int i=0; i<vertices->size(); ++i)
139
osg::Vec3& v = (*vertices)[i];
140
osg::Vec2& t = (*texcoords)[i];
141
v = bl * ((1.0f-t.x())*(1.0f-t.y())) +
142
br * ((t.x())*(1.0f-t.y())) +
143
tl * ((1.0f-t.x())*(t.y())) +
144
tr * ((t.x())*(t.y()));
146
geometry->dirtyBound();
149
osg::ref_ptr<Keystone> _keystone;
153
osg::Geode* Keystone::createKeystoneDistortionMesh()
155
osg::ref_ptr<osg::Geode> geode = new osg::Geode;
157
osg::ref_ptr<osg::Geometry> geometry = new osg::Geometry;
158
geode->addDrawable(geometry.get());
160
geometry->setUseDisplayList(false);
162
osg::ref_ptr<KeystoneUpdateCallback> kuc = new KeystoneUpdateCallback(this);
163
geometry->setUpdateCallback(kuc.get());
165
osg::ref_ptr<osg::Vec4Array> colours = new osg::Vec4Array;
166
colours->push_back(osg::Vec4(1.0f,1.0f,1.0f,1.0f));
167
geometry->setColorArray(colours.get(), osg::Array::BIND_OVERALL);
169
osg::ref_ptr<osg::Vec3Array> vertices = new osg::Vec3Array;
170
geometry->setVertexArray(vertices.get());
172
osg::ref_ptr<osg::Vec2Array> texcoords = new osg::Vec2Array;
173
geometry->setTexCoordArray(0, texcoords.get());
175
unsigned int numRows = 7;
176
unsigned int numColumns = 7;
177
unsigned int numVertices = numRows*numColumns;
179
vertices->resize(numVertices);
180
texcoords->resize(numVertices);
182
for(unsigned j=0; j<numRows; j++)
184
for(unsigned i=0; i<numColumns; i++)
186
osg::Vec2& t = (*texcoords)[j*numColumns+i];
187
t.set(static_cast<float>(i)/static_cast<float>(numColumns-1), static_cast<float>(j)/static_cast<float>(numRows-1));
191
osg::ref_ptr<osg::DrawElementsUShort> elements = new osg::DrawElementsUShort(GL_TRIANGLES);
192
geometry->addPrimitiveSet(elements.get());
193
for(unsigned j=0; j<numRows-1; j++)
195
for(unsigned i=0; i<numColumns-1; i++)
197
unsigned int vi = j*numColumns+i;
199
elements->push_back(vi+numColumns);
200
elements->push_back(vi);
201
elements->push_back(vi+1);
203
elements->push_back(vi+numColumns);
204
elements->push_back(vi+1);
205
elements->push_back(vi+1+numColumns);
209
geometry->getOrCreateStateSet()->setMode(GL_LIGHTING, osg::StateAttribute::OFF);
210
geometry->getOrCreateStateSet()->setRenderBinDetails(0, "RenderBin");
212
kuc->update(geometry.get());
214
return geode.release();
217
osg::Node* Keystone::createGrid()
219
osg::ref_ptr<osg::Geode> geode = new osg::Geode;
221
osg::ref_ptr<osg::Geometry> geometry = new osg::Geometry;
222
geode->addDrawable(geometry.get());
224
geometry->setUseDisplayList(false);
226
osg::ref_ptr<KeystoneUpdateCallback> kuc = new KeystoneUpdateCallback(this);
227
geometry->setUpdateCallback(kuc.get());
229
geometry->setCullCallback(new KeystoneCullCallback(this));
231
osg::ref_ptr<osg::Vec4Array> colours = new osg::Vec4Array;
232
colours->push_back(getGridColor());
233
geometry->setColorArray(colours.get(), osg::Array::BIND_OVERALL);
235
osg::ref_ptr<osg::Vec3Array> vertices = new osg::Vec3Array;
236
geometry->setVertexArray(vertices.get());
238
osg::ref_ptr<osg::Vec2Array> texcoords = new osg::Vec2Array;
239
geometry->setTexCoordArray(0, texcoords.get());
241
osg::Vec2 origin(0.0f, 0.0f);
242
osg::Vec2 widthVector(1.0f, 0.0f);
243
osg::Vec2 heightVector(0.0f, 1.0f);
245
unsigned int numIntervals = 7;
249
unsigned int vi = texcoords->size();
250
texcoords->push_back(origin);
251
texcoords->push_back(origin+widthVector);
252
texcoords->push_back(origin+widthVector+heightVector);
253
texcoords->push_back(origin+heightVector);
254
geometry->addPrimitiveSet(new osg::DrawArrays(GL_LINE_LOOP, vi, 4));
259
unsigned int vi = texcoords->size();
260
osg::Vec2 v = origin;
261
osg::Vec2 dv = (widthVector+heightVector)/static_cast<float>(numIntervals-1);
262
for(unsigned int i=0; i<numIntervals; ++i)
264
texcoords->push_back(v);
267
geometry->addPrimitiveSet(new osg::DrawArrays(GL_LINE_STRIP, vi, numIntervals));
269
vi = texcoords->size();
270
v = origin+heightVector;
271
dv = (widthVector-heightVector)/static_cast<float>(numIntervals-1);
272
for(unsigned int i=0; i<numIntervals; ++i)
274
texcoords->push_back(v);
277
geometry->addPrimitiveSet(new osg::DrawArrays(GL_LINE_STRIP, vi, numIntervals));
282
unsigned int vi = texcoords->size();
283
osg::Vec2 dv = widthVector/6.0;
284
osg::Vec2 bv = origin+dv;
285
osg::Vec2 tv = bv+heightVector;
286
for(unsigned int i=0; i<5; ++i)
288
texcoords->push_back(bv);
289
texcoords->push_back(tv);
293
geometry->addPrimitiveSet(new osg::DrawArrays(GL_LINES, vi, 10));
298
unsigned int vi = texcoords->size();
299
osg::Vec2 dv = heightVector/6.0;
300
osg::Vec2 bv = origin+dv;
301
osg::Vec2 tv = bv+widthVector;
302
for(unsigned int i=0; i<5; ++i)
304
texcoords->push_back(bv);
305
texcoords->push_back(tv);
309
geometry->addPrimitiveSet(new osg::DrawArrays(GL_LINES, vi, 10));
312
vertices->resize(texcoords->size());
314
geometry->getOrCreateStateSet()->setMode(GL_LIGHTING, osg::StateAttribute::OFF);
315
geometry->getOrCreateStateSet()->setMode(GL_DEPTH_TEST, osg::StateAttribute::OFF);
316
geometry->getOrCreateStateSet()->setRenderBinDetails(1, "RenderBin");
318
kuc->update(geometry.get());
320
return geode.release();
323
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
327
KeystoneHandler::KeystoneHandler(Keystone* keystone):
329
_defaultIncrement(0.0,0.0),
330
_ctrlIncrement(1.0,1.0),
331
_shiftIncrement(0.1,0.1),
332
_keyIncrement(0.005, 0.005),
333
_selectedRegion(NONE_SELECTED)
335
_startControlPoints = new Keystone;
336
_currentControlPoints = keystone; //new Keystone;
339
KeystoneHandler::Region KeystoneHandler::computeRegion(const osgGA::GUIEventAdapter& ea) const
341
float x = ea.getXnormalized();
342
float y = ea.getYnormalized();
346
if (y<-0.33) return BOTTOM_LEFT;
347
else if (y<0.33) return LEFT;
348
else return TOP_LEFT;
353
if (y<-0.33) return BOTTOM;
354
else if (y<0.33) return CENTER;
360
if (y<-0.33) return BOTTOM_RIGHT;
361
else if (y<0.33) return RIGHT;
362
else return TOP_RIGHT;
364
return NONE_SELECTED;
367
void KeystoneHandler::move(Region region, const osg::Vec2d& delta)
372
_currentControlPoints->getTopLeft() += delta;
375
_currentControlPoints->getTopLeft() += delta;
376
_currentControlPoints->getTopRight() += delta;
379
_currentControlPoints->getTopRight() += delta;
382
_currentControlPoints->getTopRight() += delta;
383
_currentControlPoints->getBottomRight() += delta;
386
_currentControlPoints->getBottomRight() += delta;
389
_currentControlPoints->getBottomRight() += delta;
390
_currentControlPoints->getBottomLeft() += delta;
393
_currentControlPoints->getBottomLeft() += delta;
396
_currentControlPoints->getBottomLeft() += delta;
397
_currentControlPoints->getTopLeft() += delta;
400
_currentControlPoints->getBottomLeft() += delta;
401
_currentControlPoints->getTopLeft() += delta;
402
_currentControlPoints->getBottomRight() += delta;
403
_currentControlPoints->getTopRight() += delta;
410
osg::Vec2d KeystoneHandler::incrementScale(const osgGA::GUIEventAdapter& ea) const
412
if (_ctrlIncrement!=osg::Vec2d(0.0,0.0) && (ea.getModKeyMask()==osgGA::GUIEventAdapter::MODKEY_LEFT_CTRL || ea.getModKeyMask()==osgGA::GUIEventAdapter::MODKEY_RIGHT_CTRL )) return _ctrlIncrement;
413
if (_shiftIncrement!=osg::Vec2d(0.0,0.0) && (ea.getModKeyMask()==osgGA::GUIEventAdapter::MODKEY_LEFT_SHIFT || ea.getModKeyMask()==osgGA::GUIEventAdapter::MODKEY_RIGHT_SHIFT )) return _shiftIncrement;
414
return _defaultIncrement;
417
bool KeystoneHandler::handle(const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& /*aa*/, osg::Object* obj, osg::NodeVisitor* /*nv*/)
419
osg::Camera* camera = dynamic_cast<osg::Camera*>(obj);
420
osg::Viewport* viewport = camera ? camera->getViewport() : 0;
422
if (!viewport) return false;
424
if (ea.getEventType()==osgGA::GUIEventAdapter::KEYDOWN && ((ea.getModKeyMask()==osgGA::GUIEventAdapter::MODKEY_LEFT_CTRL || ea.getModKeyMask()==osgGA::GUIEventAdapter::MODKEY_RIGHT_CTRL)))
426
if (ea.getUnmodifiedKey()=='g')
428
setKeystoneEditingEnabled(!getKeystoneEditingEnabled());
431
if (ea.getUnmodifiedKey()=='r')
433
_selectedRegion = NONE_SELECTED;
434
_startControlPoints->reset();
435
_currentControlPoints->reset();
438
else if (ea.getUnmodifiedKey()=='s')
440
_keystone->writeToFile();
445
bool haveCameraMatch = false;
446
float x = ea.getXnormalized();
447
float y = ea.getYnormalized();
448
for(unsigned int i=0; i<ea.getNumPointerData(); ++i)
450
const osgGA::PointerData* pd = ea.getPointerData(i);
453
haveCameraMatch = true;
454
x = pd->getXnormalized();
455
y = pd->getYnormalized();
460
if (!haveCameraMatch || !getKeystoneEditingEnabled()) return false;
462
switch(ea.getEventType())
464
case(osgGA::GUIEventAdapter::PUSH):
466
osg::Vec2d scale = incrementScale(ea);
467
if (scale.length2()!=0.0)
469
_selectedRegion = computeRegion(ea);
470
(*_startControlPoints) = (*_currentControlPoints);
471
_startPosition.set(x,y);
475
_selectedRegion = NONE_SELECTED;
479
case(osgGA::GUIEventAdapter::DRAG):
481
if (_selectedRegion!=NONE_SELECTED)
483
(*_currentControlPoints) = (*_startControlPoints);
484
osg::Vec2d currentPosition(x, y);
485
osg::Vec2d delta(currentPosition-_startPosition);
486
osg::Vec2d scale = incrementScale(ea);
487
move(_selectedRegion, osg::Vec2d(delta.x()*scale.x(), delta.y()*scale.y()) );
492
case(osgGA::GUIEventAdapter::RELEASE):
494
_selectedRegion = NONE_SELECTED;
497
case(osgGA::GUIEventAdapter::KEYDOWN):
499
if (ea.getKey()==osgGA::GUIEventAdapter::KEY_Up)
501
move(computeRegion(ea), osg::Vec2d(0.0, _keyIncrement.y()*incrementScale(ea).y()) );
503
else if (ea.getKey()==osgGA::GUIEventAdapter::KEY_Down)
505
move(computeRegion(ea), osg::Vec2d(0.0, -_keyIncrement.y()*incrementScale(ea).y()) );
507
else if (ea.getKey()==osgGA::GUIEventAdapter::KEY_Left)
509
move(computeRegion(ea), osg::Vec2d(-_keyIncrement.x()*incrementScale(ea).x(), 0.0) );
511
else if (ea.getKey()==osgGA::GUIEventAdapter::KEY_Right)
513
move(computeRegion(ea), osg::Vec2d(_keyIncrement.x()*incrementScale(ea).x(), 0.0) );
515
else if (ea.getKey()==osgGA::GUIEventAdapter::KEY_KP_7 || ea.getKey()==osgGA::GUIEventAdapter::KEY_KP_Home)
517
_currentControlPoints->setTopLeft(osg::Vec2d(x, y));
519
else if (ea.getKey()==osgGA::GUIEventAdapter::KEY_KP_9 || ea.getKey()==osgGA::GUIEventAdapter::KEY_KP_Page_Up)
521
_currentControlPoints->setTopRight(osg::Vec2d(x, y));
523
else if (ea.getKey()==osgGA::GUIEventAdapter::KEY_KP_3 || ea.getKey()==osgGA::GUIEventAdapter::KEY_KP_Page_Down)
525
_currentControlPoints->setBottomRight(osg::Vec2d(x, y));
527
else if (ea.getKey()==osgGA::GUIEventAdapter::KEY_KP_1 || ea.getKey()==osgGA::GUIEventAdapter::KEY_KP_End)
529
_currentControlPoints->setBottomLeft(osg::Vec2d(x, y));
538
bool Keystone::writeToFile()
540
std::string filename;
541
if (getUserDataContainer()!=0 && getUserValue("filename", filename))
543
// we don't want to write the UDC to the keystone file so take a reference to it, and set the pointer to NULL.
544
osg::ref_ptr<osg::UserDataContainer> temp_udc = getUserDataContainer();
545
setUserDataContainer(0);
547
OSG_NOTICE<<"Writing keystone to: "<<filename<<std::endl;
549
// write the keystone out to disk
550
osgDB::writeObjectFile(*this, filename);
553
setUserDataContainer(temp_udc.get());
564
bool Keystone::loadKeystoneFiles(osg::DisplaySettings* ds)
566
bool keystonesLoaded = false;
567
if (!ds->getKeystoneFileNames().empty())
569
for(osg::DisplaySettings::FileNames::iterator itr = ds->getKeystoneFileNames().begin();
570
itr != ds->getKeystoneFileNames().end();
573
const std::string& filename = *itr;
574
osg::ref_ptr<osgViewer::Keystone> keystone = osgDB::readFile<osgViewer::Keystone>(filename);
575
if (keystone.valid())
577
keystone->setUserValue("filename",filename);
578
ds->getKeystones().push_back(keystone.get());
579
keystonesLoaded = true;
583
OSG_NOTICE<<"Creating Keystone for filename entry: "<<filename<<std::endl;
584
keystone = new Keystone;
585
keystone->setUserValue("filename",filename);
586
ds->getKeystones().push_back(keystone.get());
587
keystonesLoaded = true;
591
return keystonesLoaded;