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