DYT/Tool/OpenSceneGraph-3.6.5/include/osgEarth/TimeControl

72 lines
2.2 KiB
Plaintext
Raw Normal View History

2024-12-24 23:49:36 +00:00
/* -*-c++-*- */
/* osgEarth - Geospatial SDK for OpenSceneGraph
* Copyright 2020 Pelican Mapping
* http://osgearth.org
*
* osgEarth is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>
*/
#ifndef OSGEARTH_TIME_CONTROL_H
#define OSGEARTH_TIME_CONTROL_H 1
#include <osgEarth/Common>
#include <osg/FrameStamp>
#include <vector>
#include <string>
namespace osgEarth
{
/**
* Information about one of the frames in a sequence.
*/
struct SequenceFrameInfo
{
std::string timeIdentifier;
};
/**
* Interface to an object that is subject to time controls.
* Pure virtual.
*/
class SequenceControl
{
public:
/** Whether the implementation supports these methods */
virtual bool supportsSequenceControl() const =0;
/** Starts playback */
virtual void playSequence() =0;
/** Stops playback */
virtual void pauseSequence() =0;
/** Seek to a specific frame */
virtual void seekToSequenceFrame(unsigned frame) =0;
/** Whether the object is in playback mode */
virtual bool isSequencePlaying() const =0;
/** Gets data about the current frame in the sequence */
virtual const std::vector<SequenceFrameInfo>& getSequenceFrameInfo() const =0;
/** Gets the index of the current frame. */
virtual int getCurrentSequenceFrameIndex( const osg::FrameStamp* ) const =0;
};
}
#endif // OSGEARTH_TIME_CONTROL_H