This abstract node type is used to derive node types that can stream PCM sound data from a file. More...
#include <H3D/H3DSoundFileNode.h>
Inheritance diagram for H3D::H3DSoundFileNode:
Classes | |
| struct | FileReaderRegistration |
| Class used to register a class to the registered file readers. More... | |
Public Types | |
| typedef bool(* | SupportsFileFunc) (const string &url) |
| Function ptr type for | |
 Public Types inherited from H3D::Node | |
| typedef std::map< Node *, Node * > | DeepCopyMap |
| A map type used during a deep copy clone() to map from original nodes to cloned nodes. | |
Public Member Functions | |
| virtual unsigned int | load (const string &_url)=0 |
| Load a sound file from the given url that will be used to generate PCM data. | |
| Public Member Functions inherited from H3D::H3DSoundStreamNode | |
| virtual void | reset ()=0 |
| Reset the stream to the beginning of the sound stream. | |
| virtual unsigned int | read (char *buffer, unsigned int size)=0 |
| Read PCM data from the stream into the buffer. More... | |
| virtual unsigned int | bitsPerSample ()=0 |
| Returns the number of bits for a sample. | |
| virtual unsigned int | samplesPerSecond ()=0 |
| Returns the number of samples per second for the current PCM data stream. | |
| virtual unsigned int | nrChannels ()=0 |
| Returns the number of channels per second for the current PCM data stream. | |
| virtual unsigned int | totalDataSize ()=0 |
| Returns the total size of the PCM data of the current stream. | |
| virtual H3DTime | duration ()=0 |
| The duration in seconds for the the PCM data. | |
| Public Member Functions inherited from H3D::Node | |
| Node () | |
| Constructor. | |
| virtual Node * | clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL) |
| Returns a new instance of this node type with the same state as this one. More... | |
| virtual | ~Node () |
| Destructor. | |
| X3DPrototypeInstance * | getProtoInstanceParent () |
| If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More... | |
| void | setProtoInstanceParent (X3DPrototypeInstance *p) |
| Set the X3DPrototypeInstance this node is the the root node if applicaple. | |
| virtual void | render () |
| the render() function is used for the depth-first rendering traversal of the scene-graph. More... | |
| virtual void | traverseSG (TraverseInfo &ti) |
| traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More... | |
| virtual bool | lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result) |
| Detect intersection between a line segment and the Node. More... | |
| virtual void | closestPoint (const Vec3f &p, NodeIntersectResult &result) |
| Find closest point on Node to p. More... | |
| virtual bool | movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result) |
| Detect collision between a moving sphere and the Node. More... | |
| virtual string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. More... | |
| virtual Field * | getField (const string &_name) const |
| return a pointer to the field specified by name within this instance | |
| int | addDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| int | removeDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
Static Public Member Functions | |
| static H3DSoundFileNode * | getSupportedFileReader (const string &url) |
| Given an url to a file, it returns an instance of a H3DSoundFileNode class that can handle that file type. More... | |
| static void | registerFileReader (const string &name, CreateNodeFunc create, SupportsFileFunc supports) |
| Register a file reader that can then be returned by getSupportedFileReader(). More... | |
| static void | registerFileReader (const FileReaderRegistration &fr) |
| Register a file reader that can then be returned by getSupportedFileReader(). | |
| Static Public Member Functions inherited from H3D::Node | |
| static unsigned int | nrNodesAlive () |
| Returns the nr of nodes currently alive, i.e. nodes created but not destructed. | |
| static int | nrNodesCreated () |
| Returns the number of nodes created in total since the start of the program. | |
Additional Inherited Members | |
| Protected Member Functions inherited from H3D::Node | |
| void | cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for the clone() method. More... | |
| Static Protected Member Functions inherited from H3D::Node | |
| static Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
Detailed Description
This abstract node type is used to derive node types that can stream PCM sound data from a file.
It also upholds a database over all subclasses that registers itself. The getSupportedFileReader function can then be used to get an instance of a H3DSoundFileNode that supports a certain file type.
Member Function Documentation
◆ getSupportedFileReader()
|
static |
Given an url to a file, it returns an instance of a H3DSoundFileNode class that can handle that file type.
If no such class is registered NULL is returns.
◆ registerFileReader()
|
inlinestatic |
Register a file reader that can then be returned by getSupportedFileReader().
- Parameters
-
name The name of the class create A function for creating an instance of that class. supports A function to determine if the class supports a given file type.
The documentation for this class was generated from the following files:
