From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNLSOUND_1_1IPlayable.html | 368 ++++++++++++++++++++++++ 1 file changed, 368 insertions(+) create mode 100644 docs/doxygen/nel/classNLSOUND_1_1IPlayable.html (limited to 'docs/doxygen/nel/classNLSOUND_1_1IPlayable.html') diff --git a/docs/doxygen/nel/classNLSOUND_1_1IPlayable.html b/docs/doxygen/nel/classNLSOUND_1_1IPlayable.html new file mode 100644 index 00000000..c686de15 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1IPlayable.html @@ -0,0 +1,368 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + + 		+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NLSOUND::IPlayable Class Reference

Playable object interface, typically one sound source or a set of sound sources. +More... +

+#include <playable.h> +

+

Inheritance diagram for NLSOUND::IPlayable: +

+ +NLMISC::IStreamable +NLMISC::IClassable +NLSOUND::CAmbiantSource +NLSOUND::CSourceUser + +List of all members. + + + + + + + + + + + + + + + + +

Public Methods

virtual void serial (NLMISC::IStream &s)=0
 Serialize useful data. More...

virtual void initPos (const NLMISC::CVector *posvector)
 Init. More...

virtual void moveTo (const NLMISC::CVector &pos)
 Set the position. More...

virtual void enable (bool toplay, float gain)=0
 Enable (play with high priority) and set general gain, or disable (stop and set low priority). More...

virtual void update ()
 Update. More...

virtual ~IPlayable ()
 Destructor. More...


Protected Methods

 IPlayable ()
 Constructor. More...

+

Detailed Description

+Playable object interface, typically one sound source or a set of sound sources. +

+This class is used by CEnvSound to handle in the same way center sources and ambiant sources. +

+

+Author:
+Olivier Cado , Nevrax France
+Date:
+2001
+

+ +

+Definition at line 47 of file playable.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
virtual NLSOUND::IPlayable::~IPlayable (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+Destructor. +

+ +

+Definition at line 66 of file playable.h.

+

+ + + + +
+ + + + + + + + + +
NLSOUND::IPlayable::IPlayable (   )  [inline, protected]
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 71 of file playable.h.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual void NLSOUND::IPlayable::enable ( bool   toplay,
float   gain
)  [pure virtual]
+
+ + + + + +
+   + + +

+Enable (play with high priority) and set general gain, or disable (stop and set low priority). +

+ +

+Implemented in NLSOUND::CAmbiantSource.

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::IPlayable::initPos ( const NLMISC::CVector *   posvector )  [inline, virtual]
+
+ + + + + +
+   + + +

+Init. +

+You can pass a position vector to link to (if the playable has stereo source(s)) When reading from a stream, call init() *after* serial(). +

+Reimplemented in NLSOUND::CAmbiantSource. +

+Definition at line 56 of file playable.h.

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::IPlayable::moveTo ( const NLMISC::CVector &   pos )  [inline, virtual]
+
+ + + + + +
+   + + +

+Set the position. +

+ +

+Reimplemented in NLSOUND::CSourceUser. +

+Definition at line 58 of file playable.h.

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::IPlayable::serial ( NLMISC::IStream &   s )  [pure virtual]
+
+ + + + + +
+   + + +

+Serialize useful data. +

+ +

+Implements NLMISC::IStreamable. +

+Implemented in NLSOUND::CAmbiantSource.

+

+ + + + +
+ + + + + + + + + + +
virtual void NLSOUND::IPlayable::update ( void   )  [inline, virtual]
+
+ + + + + +
+   + + +

+Update. +

+ +

+Reimplemented in NLSOUND::CAmbiantSource. +

+Definition at line 62 of file playable.h.

+

The documentation for this class was generated from the following file: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1