SoSoundElement.h

#ifndef COIN_SOSOUNDELEMENT_H
#define COIN_SOSOUNDELEMENT_H

/**************************************************************************\
 * Copyright (c) Kongsberg Oil & Gas Technologies AS
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/

#include <Inventor/elements/SoReplacedElement.h>

class COIN_DLL_API SoSoundElement : public SoReplacedElement {
  typedef SoReplacedElement inherited;

  SO_ELEMENT_HEADER(SoSoundElement);
public:
  static void initClass(void);
protected:
  virtual ~SoSoundElement();

public:
  virtual void init(SoState * state);
  static void set(SoState * const state, SoNode * const node,
                  SbBool scenegraphhassoundnode, 
                  SbBool soundnodeisplaying,
                  SbBool ispartofactivescenegraph);

  static SbBool setSceneGraphHasSoundNode(SoState * const state, SoNode * const node,
                                          SbBool flag);
  static SbBool sceneGraphHasSoundNode(SoState * const state);

  static SbBool setSoundNodeIsPlaying(SoState * const state, SoNode * const node,
                                    SbBool flag);
  static SbBool soundNodeIsPlaying(SoState * const state);

  static SbBool setIsPartOfActiveSceneGraph(SoState * const state, SoNode * const node,
                                            SbBool flag);
  static SbBool isPartOfActiveSceneGraph(SoState * const state);

  virtual void push(SoState * state);
  virtual void pop(SoState * state, const SoElement * prevTopElement);

  virtual void print(FILE * file) const;

protected:
  void setDefaultValues();

  SbBool scenegraphhassoundnode;
  SbBool soundnodeisplaying;
  SbBool ispartofactivescenegraph;
};

#endif // !COIN_SOSOUNDELEMENT_H