Panda3D
audioVolumeAttrib.h
1 // Filename: audioVolumeAttrib.h
2 // Created by: darren (15Dec06)
3 //
4 ////////////////////////////////////////////////////////////////////
5 //
6 // PANDA 3D SOFTWARE
7 // Copyright (c) Carnegie Mellon University. All rights reserved.
8 //
9 // All use of this software is subject to the terms of the revised BSD
10 // license. You should have received a copy of this license along
11 // with this source code in a file named "LICENSE."
12 //
13 ////////////////////////////////////////////////////////////////////
14 
15 #ifndef AUDIOVOLUMEATTRIB_H
16 #define AUDIOVOLUMEATTRIB_H
17 
18 #include "pandabase.h"
19 
20 #include "renderAttrib.h"
21 #include "luse.h"
22 
23 class FactoryParams;
24 
25 ////////////////////////////////////////////////////////////////////
26 // Class : AudioVolumeAttrib
27 // Description : Applies a scale to audio volume for positional sounds
28 // in the scene graph.
29 ////////////////////////////////////////////////////////////////////
30 class EXPCL_PANDA_PGRAPH AudioVolumeAttrib : public RenderAttrib {
31 protected:
32  AudioVolumeAttrib(bool off, PN_stdfloat volume);
33  INLINE AudioVolumeAttrib(const AudioVolumeAttrib &copy);
34 
35 PUBLISHED:
36  static CPT(RenderAttrib) make_identity();
37  static CPT(RenderAttrib) make(PN_stdfloat volume);
38  static CPT(RenderAttrib) make_off();
39  static CPT(RenderAttrib) make_default();
40 
41  INLINE bool is_off() const;
42  INLINE bool has_volume() const;
43  INLINE PN_stdfloat get_volume() const;
44  CPT(RenderAttrib) set_volume(PN_stdfloat volume) const;
45 
46 public:
47  virtual void output(ostream &out) const;
48 
49 protected:
50  virtual int compare_to_impl(const RenderAttrib *other) const;
51  virtual size_t get_hash_impl() const;
52  virtual CPT(RenderAttrib) compose_impl(const RenderAttrib *other) const;
53  virtual CPT(RenderAttrib) invert_compose_impl(const RenderAttrib *other) const;
54 
55 private:
56  bool _off;
57  bool _has_volume;
58  PN_stdfloat _volume;
59  static CPT(RenderAttrib) _identity_attrib;
60 
61 PUBLISHED:
62  static int get_class_slot() {
63  return _attrib_slot;
64  }
65  virtual int get_slot() const {
66  return get_class_slot();
67  }
68 
69 public:
70  static void register_with_read_factory();
71  virtual void write_datagram(BamWriter *manager, Datagram &dg);
72 
73 protected:
74  static TypedWritable *make_from_bam(const FactoryParams &params);
75  void fillin(DatagramIterator &scan, BamReader *manager);
76 
77 public:
78  static TypeHandle get_class_type() {
79  return _type_handle;
80  }
81  static void init_type() {
82  RenderAttrib::init_type();
83  register_type(_type_handle, "AudioVolumeAttrib",
84  RenderAttrib::get_class_type());
85  _attrib_slot = register_slot(_type_handle, 100, make_default);
86  }
87  virtual TypeHandle get_type() const {
88  return get_class_type();
89  }
90  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
91 
92 private:
93  static TypeHandle _type_handle;
94  static int _attrib_slot;
95 };
96 
97 #include "audioVolumeAttrib.I"
98 
99 #endif
100 
static int register_slot(TypeHandle type_handle, int sort, RenderAttribRegistry::MakeDefaultFunc *make_default_func)
Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot ...
Definition: renderAttrib.I:163
This is the base class for a number of render attributes (other than transform) that may be set on sc...
Definition: renderAttrib.h:60
This is the fundamental interface for extracting binary objects from a Bam file, as generated by a Ba...
Definition: bamReader.h:122
Base class for objects that can be written to and read from Bam files.
Definition: typedWritable.h:37
This is the fundamental interface for writing binary objects to a Bam file, to be extracted later by ...
Definition: bamWriter.h:73
virtual void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:40
A class to retrieve the individual data elements previously stored in a Datagram. ...
TypeHandle is the identifier used to differentiate C++ class types.
Definition: typeHandle.h:85
An ordered list of data elements, formatted in memory for transmission over a socket or writing to a ...
Definition: datagram.h:43
Applies a scale to audio volume for positional sounds in the scene graph.