OpenSceneGraph 3.6.5
ImageStream
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_IMAGESTREAM
15#define OSG_IMAGESTREAM 1
16
17#include <osg/Image>
18#include <osg/AudioStream>
19
20namespace osg {
21
22// forward declare of osg::Texture
23class Texture;
24
29{
30 public:
32
35
36 virtual Object* cloneType() const { return new ImageStream(); }
37 virtual Object* clone(const CopyOp& copyop) const { return new ImageStream(*this,copyop); }
38 virtual bool isSameKindAs(const Object* obj) const { return dynamic_cast<const ImageStream*>(obj)!=0; }
39 virtual const char* libraryName() const { return "osg"; }
40 virtual const char* className() const { return "ImageStream"; }
41
43 virtual int compare(const Image& rhs) const;
44
52
53 virtual void seek(double /*time*/) {}
54
55 virtual void play() { _status=PLAYING; }
56
57 virtual void pause() { _status=PAUSED; }
58
59 virtual void rewind() { _status=REWINDING; }
60
61 virtual void quit(bool /*waitForThreadToExit*/ = true) {}
62
63 StreamStatus getStatus() const { return _status; }
64
65
71
73 {
74 if (_loopingMode == mode) return;
75
76 _loopingMode = mode;
78 }
79
81
82 virtual double getCreationTime() const { return HUGE_VAL; }
83 virtual double getLength() const { return 0.0; }
84 virtual double getFrameRate() const { return 0.0; }
85 virtual double getCurrentTime() const { return 0.0; }
86
87 virtual void setReferenceTime(double) {}
88 virtual double getReferenceTime() const { return 0.0; }
89
90 virtual void setTimeMultiplier(double) {}
91 virtual double getTimeMultiplier() const { return 0.0; }
92
93 virtual void setVolume(float) {}
94 virtual float getVolume() const { return 0.0f; }
95
97 virtual float getAudioBalance() { return 0.0f; }
98 virtual void setAudioBalance(float /*b*/) {}
99
100 typedef std::vector< osg::ref_ptr<osg::AudioStream> > AudioStreams;
101 void setAudioStreams(const AudioStreams& asl) { _audioStreams = asl; }
103 const AudioStreams& getAudioStreams() const { return _audioStreams; }
104
110
111 protected:
112 virtual void applyLoopingMode() {}
113
114 virtual ~ImageStream() {}
115
118
120};
121
122} // namespace
123
124#endif
The core osg library provides the basic scene graph classes such as Nodes, State and Drawables,...
Definition AlphaFunc:19
Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...
Definition CopyOp:41
@ SHALLOW_COPY
Definition CopyOp:47
virtual float getVolume() const
Definition ImageStream:94
virtual bool isSameKindAs(const Object *obj) const
Definition ImageStream:38
virtual double getCurrentTime() const
Definition ImageStream:85
StreamStatus _status
Definition ImageStream:116
virtual void setReferenceTime(double)
Definition ImageStream:87
AudioStreams _audioStreams
Definition ImageStream:119
virtual void setVolume(float)
Definition ImageStream:93
StreamStatus getStatus() const
Definition ImageStream:63
virtual float getAudioBalance()
set the balance of the audio: -1 = left, 0 = center, 1 = right
Definition ImageStream:97
virtual void applyLoopingMode()
Definition ImageStream:112
virtual const char * className() const
return the name of the object's class type.
Definition ImageStream:40
std::vector< osg::ref_ptr< osg::AudioStream > > AudioStreams
Definition ImageStream:100
LoopingMode getLoopingMode() const
Definition ImageStream:80
virtual double getFrameRate() const
Definition ImageStream:84
void setLoopingMode(LoopingMode mode)
Definition ImageStream:72
virtual osg::Texture * createSuitableTexture()
create a suitable texture for this imagestream, return NULL, if not supported implement this method i...
Definition ImageStream:109
virtual void rewind()
Definition ImageStream:59
virtual void setTimeMultiplier(double)
Definition ImageStream:90
virtual void quit(bool=true)
Definition ImageStream:61
virtual Object * cloneType() const
Clone the type of an object, with Object* return type.
Definition ImageStream:36
virtual int compare(const Image &rhs) const
Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual double getTimeMultiplier() const
Definition ImageStream:91
virtual void play()
Definition ImageStream:55
StreamStatus
Definition ImageStream:46
@ REWINDING
Definition ImageStream:50
@ PLAYING
Definition ImageStream:48
@ INVALID
Definition ImageStream:47
@ PAUSED
Definition ImageStream:49
virtual Object * clone(const CopyOp &copyop) const
Clone an object, with Object* return type.
Definition ImageStream:37
virtual void pause()
Definition ImageStream:57
virtual double getReferenceTime() const
Definition ImageStream:88
virtual double getLength() const
Definition ImageStream:83
virtual void seek(double)
Definition ImageStream:53
void setAudioStreams(const AudioStreams &asl)
Definition ImageStream:101
const AudioStreams & getAudioStreams() const
Definition ImageStream:103
LoopingMode
Definition ImageStream:67
@ LOOPING
Definition ImageStream:69
@ NO_LOOPING
Definition ImageStream:68
virtual const char * libraryName() const
return the name of the object's library.
Definition ImageStream:39
virtual double getCreationTime() const
Definition ImageStream:82
virtual void setAudioBalance(float)
Definition ImageStream:98
LoopingMode _loopingMode
Definition ImageStream:117
ImageStream(const ImageStream &image, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
Copy constructor using CopyOp to manage deep vs shallow copy.
virtual ~ImageStream()
Definition ImageStream:114
AudioStreams & getAudioStreams()
Definition ImageStream:102
Base class/standard interface for objects which require IO support, cloning and reference counting.
Definition Object:61
Texture pure virtual base class that encapsulates OpenGL texture functionality common to the various ...
Definition Texture:422
#define NULL
Definition Export:55
#define OSG_EXPORT
Definition Export:39

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.