SoListenerPositionElement Class Reference

The SoListenerPositionElement holds the position of the current listener. More...

#include <Inventor/elements/SoListenerPositionElement.h>

Inheritance diagram for SoListenerPositionElement:

Public Member Functions
virtual void	init (SoState *state)
virtual void	print (FILE *file) const
	Prints contents of element (not implemented)
Public Member Functions inherited from SoReplacedElement
virtual SoElement *	copyMatchInfo () const
SbUniqueId	getNodeId () const
virtual SbBool	matches (const SoElement *element) const
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	push (SoState *state)
void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)
static const SbVec3f &	get (SoState *const state)
	Returns the current listener position.
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
static SbBool	isSetByListener (SoState *const state)
static void	set (SoState *const state, SoNode *const node, const SbVec3f &position, SbBool setbylistener)
Static Public Member Functions inherited from SoReplacedElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static SoType	getIdFromStackIndex (const int stackIndex)
static int	getNumStackIndices (void)
static void	initClass (void)
static void	initElements (void)

Protected Member Functions
virtual	~SoListenerPositionElement ()
Protected Member Functions inherited from SoReplacedElement
virtual	~SoReplacedElement ()
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
virtual void	captureThis (SoState *state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)

Protected Attributes
SbVec3f	position
SbBool	setbylistener
Protected Attributes inherited from SoReplacedElement
SbUniqueId	nodeId
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId

Additional Inherited Members
Static Protected Member Functions inherited from SoReplacedElement
static SoElement *	getElement (SoState *const state, const int stackIndex, SoNode *const node)
Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static SoElement *	getElement (SoState *const state, const int stackIndex)
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

Detailed Description

The SoListenerPositionElement holds the position of the current listener.

This position is set by SoListener nodes and SoCamera Nodes during audio rendering. When a SoListener is visited by the SoAudioRenderAction, it will add a new SoListenerPositionElement to the state, holding its position and with the setbylistener flag set. When a SoCamera is visited by SoAudioRenderAction, it will add a new SoListenerPositionElement only if there are no previous elements with the setbylistener flag set.

The SoListenerPositionElement is used when the SoVRMLSound nodes render themselves.

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since

Coin 2.0

Constructor & Destructor Documentation

~SoListenerPositionElement()

SoListenerPositionElement::~SoListenerPositionElement ( void )

protectedvirtual

Destructor.

Member Function Documentation

createInstance()

void * SoListenerPositionElement::createInstance ( void )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

getClassStackIndex()

int SoListenerPositionElement::getClassStackIndex ( void )

static

This static method returns the state stack index for the class.

getClassTypeId()

SoType SoListenerPositionElement::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

init()

void SoListenerPositionElement::init ( SoState * state )

virtual

Initializes the element to its default value. The default value for the position is (0.0, 0.0, 0.0) and the default value for the setByListener flag is FALSE.

Reimplemented from SoReplacedElement.

initClass()

void SoListenerPositionElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

isSetByListener()

SbBool SoListenerPositionElement::isSetByListener ( SoState *const state )

static

Returns TRUE if the position was set by a SoListener node, and FALSE if it was set by a SoCamera node

print()

void SoListenerPositionElement::print ( FILE * file ) const

virtual

Prints contents of element (not implemented)

Reimplemented from SoReplacedElement.

set()

void SoListenerPositionElement::set ( SoState *const state, SoNode *const node, const SbVec3f & position, SbBool setbylistener )

static

Sets the current listener position, and indicates if it was set by a SoListener node or a SoCamera node.

Member Data Documentation

position

SoListenerPositionElement::position

protected

The position of the listener in world space. Can be set by the SoListener class or the SoCamera class.

---

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

• SoListenerPositionElement.h
• SoListenerPositionElement.cpp