SPIN Framework
Public Member Functions

spin::SoundNode Class Reference

Represents a point sound source (or sink). More...

#include <SoundNode.h>

Inheritance diagram for spin::SoundNode:
spin::DSPNode spin::GroupNode spin::ReferencedNode

List of all members.

Public Member Functions

 SoundNode (SceneManager *sceneManager, const char *initID)
virtual void callbackUpdate (osg::NodeVisitor *nv)
virtual void setParam (const char *paramName, const char *paramValue)
virtual void setParam (const char *paramName, float paramValue)
virtual void setTranslation (float x, float y, float z)
virtual void setOrientation (float p, float r, float y)
virtual void setOrientationQuat (float x, float y, float z, float w)
virtual void setRadius (float f)
virtual void setURI (const char *uri)
virtual std::vector< lo_message > getState () const

Detailed Description

Represents a point sound source (or sink).

The SoundNode class allows for the positioning of a sound node in 3D space, and controlling various aspects such as directivity and visual rendering for debugging purposes.


Member Function Documentation

void spin::SoundNode::callbackUpdate ( osg::NodeVisitor *  nv) [virtual]

For nodes that require regular programmatic control, there is a callback that is evaluated with every refresh. This function can thus be used for animations, or any other periodic updates.

Note that changes to the scene graph structure (eg, moving/deleting nodes should NOT be done within this callback because traversals stacks will become corrupted. The technique is rather to enable a flag and then do the actual change in the SceneManager::updateGraph() method.

Reimplemented from spin::DSPNode.

std::vector< lo_message > spin::SoundNode::getState ( ) const [virtual]

For each subclass of ReferencedNode, we override the getState() method to fill the vector with the correct set of methods for this particular node

Reimplemented from spin::DSPNode.

void spin::SoundNode::setOrientation ( float  pitch,
float  roll,
float  yaw 
) [virtual]

The local orientation offset for this node with respect to it's parent

Reimplemented from spin::GroupNode.

void spin::SoundNode::setOrientationQuat ( float  x,
float  y,
float  z,
float  w 
) [virtual]

Set the orientation offset as a quaternion

Reimplemented from spin::GroupNode.

void spin::SoundNode::setTranslation ( float  x,
float  y,
float  z 
) [virtual]

The local translation offset for this node with respect to it's parent

Reimplemented from spin::GroupNode.

void spin::SoundNode::setURI ( const char *  uri) [virtual]

Set the media for the sound node using a URI pattern.

Examples: file://soundfilename.wav file:///home/johndoe/soundfilename.wav http://www.server.com/soundfile.wav adc://1:1 adc://1 content://media/external/audio/media/710 mms://some_media_stream rtsp://127.0.0.1:12311 pd_plugin://audio_plugin_patch.pd

Reimplemented from spin::DSPNode.


The documentation for this class was generated from the following files: