diff options
author | Paul Gilbert | 2017-05-30 14:16:01 -0400 |
---|---|---|
committer | Paul Gilbert | 2017-05-30 14:16:01 -0400 |
commit | c6f079b1ef10b60e75d89073639866015e85a5dc (patch) | |
tree | 6faea02a056025f1589540598a38b5c6a3b15fc9 /engines/titanic/star_control | |
parent | 867f06a2b4ff8bae65c0249f5d8c16ca55f8bbfb (diff) | |
download | scummvm-rg350-c6f079b1ef10b60e75d89073639866015e85a5dc.tar.gz scummvm-rg350-c6f079b1ef10b60e75d89073639866015e85a5dc.tar.bz2 scummvm-rg350-c6f079b1ef10b60e75d89073639866015e85a5dc.zip |
TITANIC: Further commenting of CPhotoCrosshairs class
Diffstat (limited to 'engines/titanic/star_control')
-rw-r--r-- | engines/titanic/star_control/photo_crosshairs.cpp | 31 | ||||
-rw-r--r-- | engines/titanic/star_control/photo_crosshairs.h | 13 |
2 files changed, 37 insertions, 7 deletions
diff --git a/engines/titanic/star_control/photo_crosshairs.cpp b/engines/titanic/star_control/photo_crosshairs.cpp index 9df14d3729..94bb7c5c4b 100644 --- a/engines/titanic/star_control/photo_crosshairs.cpp +++ b/engines/titanic/star_control/photo_crosshairs.cpp @@ -34,61 +34,84 @@ CPhotoCrosshairs::CPhotoCrosshairs() : _matchIndex(-1), _entryIndex(-1) { void CPhotoCrosshairs::selectStar(int index, CVideoSurface *surface, CStarField *starField, CStarMarkers *markers) { if (_entryIndex >= 0) { + // There are existing selected stars already if (_entryIndex == _matchIndex) { - if (_matchIndex != 2) { + // All the stars selected so far have been matched. Only allow + // a selection addition if not all three stars have been found + if (!isSolved()) { + // Don't allow the most recent match to be re-selected if (_positions[index] != _entries[_entryIndex]) { surface->lock(); + // Draw crosshairs around the selected star CSurfaceArea surfaceArea(surface); drawStar(index, &surfaceArea); surface->unlock(); + // Copy the star into the list of selected ones ++_entryIndex; CStarPosition &newP = _entries[_entryIndex]; newP = _positions[index]; + // Set up a marker in the main starfield for that same star const CBaseStarEntry *starP = starField->getDataPtr(newP._index1); markers->addStar(starP); } } } else if (_entryIndex == _matchIndex + 1) { + // There is a most recently selected star that has not yet been matched. + // So we allow the user to reselect it to remove the selection, or shift + // the selection to some other star if (_positions[index] == _entries[_entryIndex]) { + // Remove the crosshairs for the previously selected star surface->lock(); CSurfaceArea surfaceArea(surface); - drawCurrent(&surfaceArea); + eraseCurrent(&surfaceArea); surface->unlock(); + // Decrement number of selections --_entryIndex; + + // Call the markers addStar method, which will remove the existing marker const CBaseStarEntry *starP = starField->getDataPtr(_positions[index]._index1); markers->addStar(starP); } else { + // Erase the prior selection and draw the new one surface->lock(); CSurfaceArea surfaceArea(surface); - drawCurrent(&surfaceArea); + eraseCurrent(&surfaceArea); drawStar(index, &surfaceArea); surface->unlock(); + // Remove the old selection from the starfield markers const CBaseStarEntry *starP; starP = starField->getDataPtr(_entries[_entryIndex]._index1); markers->addStar(starP); + + // Add the new selection to the markers list starP = starField->getDataPtr(_positions[index]._index1); markers->addStar(starP); + // Copy the newly selected star's details into our selections list CStarPosition &newP = _entries[_entryIndex]; newP = _positions[index]; } } } else { + // Very first star being selected + // Draw crosshairs around the selected star surface->lock(); CSurfaceArea surfaceArea(surface); drawStar(index, &surfaceArea); surface->unlock(); + // Copy the star into the list of selected ones ++_entryIndex; const CStarPosition &srcPos = _positions[index]; CStarPosition &destPos = _entries[_entryIndex]; destPos = srcPos; + // Set up a marker in the main starfield for that same star const CBaseStarEntry *starP = starField->getDataPtr(destPos._index1); markers->addStar(starP); } @@ -200,7 +223,7 @@ void CPhotoCrosshairs::drawEntry(int index, CVideoSurface *surface, CStarField * markers->addStar(starP); } -void CPhotoCrosshairs::drawCurrent(CSurfaceArea *surfaceArea) { +void CPhotoCrosshairs::eraseCurrent(CSurfaceArea *surfaceArea) { assert(_entryIndex >= 0); const CStarPosition &pt = _entries[_entryIndex]; drawAt(pt, surfaceArea); diff --git a/engines/titanic/star_control/photo_crosshairs.h b/engines/titanic/star_control/photo_crosshairs.h index de896d7b3c..9f78a2d760 100644 --- a/engines/titanic/star_control/photo_crosshairs.h +++ b/engines/titanic/star_control/photo_crosshairs.h @@ -98,22 +98,29 @@ public: void drawEntry(int index, CVideoSurface *surface, CStarField *starField, CStarMarkers *markers); /** - * Draw crosshairs for the most recently selected star + * Erase crosshairs for the most recently selected star */ - void drawCurrent(CSurfaceArea *surfaceArea); + void eraseCurrent(CSurfaceArea *surfaceArea); /** * Draw crosshairs at the given position */ void drawAt(const FPoint &pt, CSurfaceArea *surfaceArea); - + /** + * Returns the position of the most recently selected star + */ FPoint getPosition() const; /** * Returns the index of an entry in the rects list a given point falls within */ int indexOf(const Common::Point &pt) const; + + /** + * Returns true if the starfield is solved + */ + bool isSolved() const { return _matchIndex == 2; } }; } // End of namespace Titanic |