Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoListenerOrientationElement Class Reference

The SoListenerOrientationElement holds the orientation of the current listener. More...

#include <Inventor/elements/SoListenerOrientationElement.h>

Inheritance diagram for SoListenerOrientationElement:
SoReplacedElement SoElement

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

virtual ~SoListenerOrientationElement ()
 
- 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
 
void setTypeId (const SoType typeId)
 
void setStackIndex (const int index)
 
SoElementgetNextInStack (void) const
 
SoElementgetNextFree (void) const
 

Protected Attributes

SbRotation orientation
 
SbBool setbylistener
 
- Protected Attributes inherited from SoReplacedElement
SbUniqueId nodeId
 
- Protected Attributes inherited from SoElement
SoType typeId
 
int stackIndex
 
int depth
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoReplacedElement
static SoElementgetElement (SoState *const state, const int stackIndex, SoNode *const node)
 
- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *const state, const int stackIndex)
 
static const SoElementgetConstElement (SoState *const state, const int stackIndex)
 
static int createStackIndex (const SoType id)
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 
static SoTypeListstackToType
 

Detailed Description

The SoListenerOrientationElement holds the orientation of the current listener.

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

The SoListenerOrientationElement 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

◆ ~SoListenerOrientationElement()

SoListenerOrientationElement::~SoListenerOrientationElement ( void  )
protectedvirtual

The destructor.

Member Function Documentation

◆ createInstance()

void * SoListenerOrientationElement::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.

◆ initClass()

void SoListenerOrientationElement::initClass ( void  )
static

This static method initializes static data for the SoListenerOrientationElement class.

◆ init()

void SoListenerOrientationElement::init ( SoState state)
virtual

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

Reimplemented from SoReplacedElement.

◆ set()

void SoListenerOrientationElement::set ( SoState *const  state,
SoNode *const  node,
const SbRotation orientation,
SbBool  setbylistener 
)
static

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

◆ isSetByListener()

SbBool SoListenerOrientationElement::isSetByListener ( SoState *const  state)
static

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

Member Data Documentation

◆ orientation

SoListenerOrientationElement::orientation
protected

The orientation of the listener. Can be set by the SoListener class or the SoCamera class.


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