H3D API  2.4.1
SimpleAudioClip.h
Go to the documentation of this file.
1 // Copyright 2004-2019, SenseGraphics AB
3 //
4 // This file is part of H3D API.
5 //
6 // H3D API is free software; you can redistribute it and/or modify
7 // it under the terms of the GNU General Public License as published by
8 // the Free Software Foundation; either version 2 of the License, or
9 // (at your option) any later version.
10 //
11 // H3D API is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
15 //
16 // You should have received a copy of the GNU General Public License
17 // along with H3D API; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // A commercial license is also available. Please contact us at
21 // www.sensegraphics.com for more information.
22 //
23 //
27 //
29 #ifndef __SIMPLEAUDIOCLIP_H__
30 #define __SIMPLEAUDIOCLIP_H__
31 
32 #include <H3D/AudioClip.h>
33 
34 
35 namespace H3D {
48  class H3DAPI_API SimpleAudioClip : public AudioClip {
49  public:
50 
51 
52 
53  class UpdateAudioPlay: public TypedField< AutoUpdate< SFBool >,
54  Types< SFBool, SFBool, SFBool,
55  MFString, SFBool > >{
56  public:
57  virtual void update();
58  };
59 
62  Inst< SFString> _description = 0,
63  Inst< SFBool > _loop = 0,
64  Inst< SFNode > _metadata = 0,
65  Inst< SFTime > _pauseTime = 0,
66  Inst< SFFloat > _pitch = 0,
67  Inst< SFTime > _resumeTime = 0,
68  Inst< StartTime > _startTime = 0,
69  Inst< StopTime > _stopTime = 0,
70  Inst< MFString> _url = 0,
71  Inst< SFTime > _duration_changed = 0,
72  Inst< SFTime > _elapsedTime = 0,
73  Inst< SFBool > _isActive = 0,
74  Inst< SFBool > _isPaused = 0,
75  Inst< TimeHandler > _time_handler = 0,
76  Inst< SFBool > _play = 0,
77  Inst< SFBool > _stop = 0,
78  Inst< SFBool > _pause = 0,
79  Inst< SFString > _audioState = 0);
80 
83 
91  H3DUniquePtr< SFBool > play;
92 
99  H3DUniquePtr< SFBool > stop;
100 
108  H3DUniquePtr< SFBool > pause;
109 
115  H3DUniquePtr< SFString > audioState;
116 
117  protected:
119  H3DUniquePtr< UpdateAudioPlay > updateAudioPlay;
120  };
121 }
122 
123 #endif
Header file for AudioClip, X3D scene-graph node.
An AudioClip node specifies audio data that can be referenced by Sound nodes.
Definition: AudioClip.h:108
SimpleAudioClip is a node for playing audio with a simpler interface than the audio clip node.
Definition: SimpleAudioClip.h:48
H3DUniquePtr< SFString > audioState
audioState describe if the audio is being playing, paused or stopped Access type: outputOnly Default...
Definition: SimpleAudioClip.h:115
H3DUniquePtr< SFBool > play
If a true event is received by the "play" field the audio will start playing, if it paused or stopped...
Definition: SimpleAudioClip.h:91
H3DUniquePtr< SFBool > pause
If a true event is received by the "pause" field the audio will be paused.
Definition: SimpleAudioClip.h:108
static H3DNodeDatabase database
The H3DNodeDatabase for this node.
Definition: SimpleAudioClip.h:82
H3DUniquePtr< SFBool > stop
If a true event is received by the "stop" field the audio will stop playing.
Definition: SimpleAudioClip.h:99
H3DUniquePtr< UpdateAudioPlay > updateAudioPlay
update the playing of audio
Definition: SimpleAudioClip.h:119
A template modifier class for adding type checking on the routes to any Field class.
Definition: TypedField.h:84
H3D API namespace.
Definition: Anchor.h:38
The H3DNodeDatabase contains a mapping between a name of a Node and the constructor for the Node with...
Definition: H3DNodeDatabase.h:194