Panda3D
rectangleLight.cxx
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 rectangleLight.cxx
10 * @author rdb
11 * @date 2016-12-19
12 */
13
14#include "rectangleLight.h"
16#include "bamWriter.h"
17#include "bamReader.h"
18#include "datagram.h"
19#include "datagramIterator.h"
20
21TypeHandle RectangleLight::_type_handle;
22
23/**
24 *
25 */
26CycleData *RectangleLight::CData::
27make_copy() const {
28 return new CData(*this);
29}
30
31/**
32 * Writes the contents of this object to the datagram for shipping out to a
33 * Bam file.
34 */
35void RectangleLight::CData::
36write_datagram(BamWriter *manager, Datagram &dg) const {
37 dg.add_stdfloat(_max_distance);
38}
39
40/**
41 * This internal function is called by make_from_bam to read in all of the
42 * relevant data from the BamFile for the new Light.
43 */
44void RectangleLight::CData::
45fillin(DatagramIterator &scan, BamReader *manager) {
46 _max_distance = scan.get_stdfloat();
47}
48
49/**
50 *
51 */
52RectangleLight::
53RectangleLight(const std::string &name) :
54 LightLensNode(name)
55{
56}
57
58/**
59 * Do not call the copy constructor directly; instead, use make_copy() or
60 * copy_subgraph() to make a copy of a node.
61 */
62RectangleLight::
63RectangleLight(const RectangleLight &copy) :
64 LightLensNode(copy),
65 _cycler(copy._cycler)
66{
67}
68
69/**
70 * Returns a newly-allocated PandaNode that is a shallow copy of this one. It
71 * will be a different pointer, but its internal data may or may not be shared
72 * with that of the original PandaNode. No children will be copied.
73 */
75make_copy() const {
76 return new RectangleLight(*this);
77}
78
79/**
80 *
81 */
82void RectangleLight::
83write(std::ostream &out, int indent_level) const {
84 LightLensNode::write(out, indent_level);
85 indent(out, indent_level) << *this << "\n";
86}
87
88/**
89 * Returns the relative priority associated with all lights of this class.
90 * This priority is used to order lights whose instance priority
91 * (get_priority()) is the same--the idea is that other things being equal,
92 * AmbientLights (for instance) are less important than DirectionalLights.
93 */
95get_class_priority() const {
96 return (int)CP_area_priority;
97}
98
99/**
100 *
101 */
102void RectangleLight::
103bind(GraphicsStateGuardianBase *gsg, const NodePath &light, int light_id) {
104}
105
106/**
107 * Tells the BamReader how to create objects of type RectangleLight.
108 */
111 BamReader::get_factory()->register_factory(get_class_type(), make_from_bam);
112}
113
114/**
115 * Writes the contents of this object to the datagram for shipping out to a
116 * Bam file.
117 */
119write_datagram(BamWriter *manager, Datagram &dg) {
121 manager->write_cdata(dg, _cycler);
122}
123
124/**
125 * This function is called by the BamReader's factory when a new object of
126 * type RectangleLight is encountered in the Bam file. It should create the
127 * RectangleLight and extract its information from the file.
128 */
129TypedWritable *RectangleLight::
130make_from_bam(const FactoryParams &params) {
131 RectangleLight *node = new RectangleLight("");
132 DatagramIterator scan;
133 BamReader *manager;
134
135 parse_params(params, scan, manager);
136 node->fillin(scan, manager);
137
138 return node;
139}
140
141/**
142 * This internal function is called by make_from_bam to read in all of the
143 * relevant data from the BamFile for the new RectangleLight.
144 */
145void RectangleLight::
146fillin(DatagramIterator &scan, BamReader *manager) {
147 LightLensNode::fillin(scan, manager);
148
149 manager->read_cdata(scan, _cycler);
150}
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
void parse_params(const FactoryParams &params, DatagramIterator &scan, BamReader *&manager)
Takes in a FactoryParams, passed from a WritableFactory into any TypedWritable's make function,...
Definition: bamReader.I:275
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
This is the fundamental interface for extracting binary objects from a Bam file, as generated by a Ba...
Definition: bamReader.h:110
void read_cdata(DatagramIterator &scan, PipelineCyclerBase &cycler)
Reads in the indicated CycleData object.
Definition: bamReader.cxx:695
static WritableFactory * get_factory()
Returns the global WritableFactory for generating TypedWritable objects.
Definition: bamReader.I:177
This is the fundamental interface for writing binary objects to a Bam file, to be extracted later by ...
Definition: bamWriter.h:63
void write_cdata(Datagram &packet, const PipelineCyclerBase &cycler)
Writes out the indicated CycleData object.
Definition: bamWriter.cxx:425
A single page of data maintained by a PipelineCycler.
Definition: cycleData.h:50
A class to retrieve the individual data elements previously stored in a Datagram.
PN_stdfloat get_stdfloat()
Extracts either a 32-bit or a 64-bit floating-point number, according to Datagram::set_stdfloat_doubl...
An ordered list of data elements, formatted in memory for transmission over a socket or writing to a ...
Definition: datagram.h:38
void add_stdfloat(PN_stdfloat value)
Adds either a 32-bit or a 64-bit floating-point number, according to set_stdfloat_double().
Definition: datagram.I:133
An instance of this class is passed to the Factory when requesting it to do its business and construc...
Definition: factoryParams.h:36
void register_factory(TypeHandle handle, CreateFunc *func, void *user_data=nullptr)
Registers a new kind of thing the Factory will be able to create.
Definition: factory.I:73
This is a base class for the GraphicsStateGuardian class, which is itself a base class for the variou...
A derivative of Light and of Camera.
Definition: lightLensNode.h:33
virtual void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
NodePath is the fundamental system for disambiguating instances, and also provides a higher-level int...
Definition: nodePath.h:159
A basic node of the scene graph or data graph.
Definition: pandaNode.h:65
This is a type of area light that is an axis aligned rectangle, pointing along the Y axis in the posi...
virtual int get_class_priority() const
Returns the relative priority associated with all lights of this class.
virtual void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
virtual PandaNode * make_copy() const
Returns a newly-allocated PandaNode that is a shallow copy of this one.
static void register_with_read_factory()
Tells the BamReader how to create objects of type RectangleLight.
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.
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
std::ostream & indent(std::ostream &out, int indent_level)
A handy function for doing text formatting.
Definition: indent.cxx:20
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.