panda3d/panda/src/pgraph/lightRampAttrib.cxx
2008-05-06 22:02:26 +00:00

351 lines
14 KiB
C++

// Filename: lightRampAttrib.cxx
// Created by: drose (04Mar02)
//
////////////////////////////////////////////////////////////////////
//
// PANDA 3D SOFTWARE
// Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved
//
// All use of this software is subject to the terms of the Panda 3d
// Software license. You should have received a copy of this license
// along with this source code; you will also find a current copy of
// the license at http://etc.cmu.edu/panda3d/docs/license/ .
//
// To contact the maintainers of this program write to
// panda3d-general@lists.sourceforge.net .
//
////////////////////////////////////////////////////////////////////
#include "lightRampAttrib.h"
#include "attribSlots.h"
#include "graphicsStateGuardianBase.h"
#include "dcast.h"
#include "bamReader.h"
#include "bamWriter.h"
#include "datagram.h"
#include "datagramIterator.h"
TypeHandle LightRampAttrib::_type_handle;
CPT(RenderAttrib) LightRampAttrib::_default;
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_default
// Access: Published, Static
// Description: Constructs a new LightRampAttrib object. This
// is the standard OpenGL lighting ramp, which clamps
// the final light total to the 0-1 range.
////////////////////////////////////////////////////////////////////
CPT(RenderAttrib) LightRampAttrib::
make_default() {
if (_default == 0) {
LightRampAttrib *attrib = new LightRampAttrib();
_default = return_new(attrib);
}
return _default;
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_identity
// Access: Published, Static
// Description: Constructs a new LightRampAttrib object. This
// differs from the usual OpenGL lighting model in that
// it does not clamp the final lighting total to (0,1).
////////////////////////////////////////////////////////////////////
CPT(RenderAttrib) LightRampAttrib::
make_identity() {
LightRampAttrib *attrib = new LightRampAttrib();
attrib->_mode = LRT_identity;
return return_new(attrib);
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_single_threshold
// Access: Published, Static
// Description: Constructs a new LightRampAttrib object. This
// causes the luminance of the diffuse lighting
// contribution to be quantized using a single threshold:
//
// if (original_luminance > threshold0) {
// luminance = level0;
// } else {
// luminance = 0.0;
// }
//
////////////////////////////////////////////////////////////////////
CPT(RenderAttrib) LightRampAttrib::
make_single_threshold(float thresh0, float val0) {
LightRampAttrib *attrib = new LightRampAttrib();
attrib->_mode = LRT_single_threshold;
attrib->_threshold[0] = thresh0;
attrib->_level[0] = val0;
return return_new(attrib);
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_double_threshold
// Access: Published, Static
// Description: Constructs a new LightRampAttrib object. This
// causes the luminance of the diffuse lighting
// contribution to be quantized using two thresholds:
//
// if (original_luminance > threshold1) {
// luminance = level1;
// } else if (original_luminance > threshold0) {
// luminance = level0;
// } else {
// luminance = 0.0;
// }
//
////////////////////////////////////////////////////////////////////
CPT(RenderAttrib) LightRampAttrib::
make_double_threshold(float thresh0, float val0, float thresh1, float val1) {
LightRampAttrib *attrib = new LightRampAttrib();
attrib->_mode = LRT_single_threshold;
attrib->_threshold[0] = thresh0;
attrib->_level[0] = val0;
attrib->_threshold[1] = thresh1;
attrib->_level[1] = val1;
return return_new(attrib);
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_hdr0
// Access: Published, Static
// Description: Constructs a new LightRampAttrib object. This causes
// an HDR tone mapping operation to be applied.
//
// Normally, brightness values greater than 1 cannot be
// distinguished from each other, causing very brightly lit
// objects to wash out white and all detail to be erased.
// HDR tone mapping remaps brightness values in the range
// 0-infinity into the range (0,1), making it possible to
// distinguish detail in scenes whose brightness exceeds 1.
//
// However, the monitor has finite contrast. Normally, all
// of that contrast is used to represent brightnesses in
// the range 0-1. The HDR0 tone mapping operator 'steals'
// one quarter of that contrast to represent brightnesses in
// the range 1-infinity.
//
// FINAL_RGB = (RGB^3 + RGB^2 + RGB) / (RGB^3 + RGB^2 + RGB + 1)
//
////////////////////////////////////////////////////////////////////
CPT(RenderAttrib) LightRampAttrib::
make_hdr0() {
LightRampAttrib *attrib = new LightRampAttrib();
attrib->_mode = LRT_hdr0;
return return_new(attrib);
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_hdr1
// Access: Published, Static
// Description: Constructs a new LightRampAttrib object. This causes
// an HDR tone mapping operation to be applied.
//
// Normally, brightness values greater than 1 cannot be
// distinguished from each other, causing very brightly lit
// objects to wash out white and all detail to be erased.
// HDR tone mapping remaps brightness values in the range
// 0-infinity into the range (0,1), making it possible to
// distinguish detail in scenes whose brightness exceeds 1.
//
// However, the monitor has finite contrast. Normally, all
// of that contrast is used to represent brightnesses in
// the range 0-1. The HDR1 tone mapping operator 'steals'
// one third of that contrast to represent brightnesses in
// the range 1-infinity.
//
// FINAL_RGB = (RGB^2 + RGB) / (RGB^2 + RGB + 1)
//
////////////////////////////////////////////////////////////////////
CPT(RenderAttrib) LightRampAttrib::
make_hdr1() {
LightRampAttrib *attrib = new LightRampAttrib();
attrib->_mode = LRT_hdr1;
return return_new(attrib);
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_hdr2
// Access: Published, Static
// Description: Constructs a new LightRampAttrib object. This causes
// an HDR tone mapping operation to be applied.
//
// Normally, brightness values greater than 1 cannot be
// distinguished from each other, causing very brightly lit
// objects to wash out white and all detail to be erased.
// HDR tone mapping remaps brightness values in the range
// 0-infinity into the range (0,1), making it possible to
// distinguish detail in scenes whose brightness exceeds 1.
//
// However, the monitor has finite contrast. Normally, all
// of that contrast is used to represent brightnesses in
// the range 0-1. The HDR2 tone mapping operator 'steals'
// one half of that contrast to represent brightnesses in
// the range 1-infinity.
//
// FINAL_RGB = (RGB) / (RGB + 1)
//
////////////////////////////////////////////////////////////////////
CPT(RenderAttrib) LightRampAttrib::
make_hdr2() {
LightRampAttrib *attrib = new LightRampAttrib();
attrib->_mode = LRT_hdr2;
return return_new(attrib);
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::output
// Access: Public, Virtual
// Description:
////////////////////////////////////////////////////////////////////
void LightRampAttrib::
output(ostream &out) const {
out << get_type() << ":";
switch (_mode) {
case LRT_identity:
out << "identity()";
break;
case LRT_single_threshold:
out << "single_threshold(" << _level[0] << "," << _level[1] << "," << _threshold[0] << ")";
break;
case LRT_double_threshold:
out << "double_threshold(" << _level[0] << "," << _level[1] << "," << _level[2] << "," << _threshold[0] << "," << _threshold[0] << ")";
break;
}
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::compare_to_impl
// Access: Protected, Virtual
// Description: Intended to be overridden by derived LightRampAttrib
// types to return a unique number indicating whether
// this LightRampAttrib is equivalent to the other one.
//
// This should return 0 if the two LightRampAttrib objects
// are equivalent, a number less than zero if this one
// should be sorted before the other one, and a number
// greater than zero otherwise.
//
// This will only be called with two LightRampAttrib
// objects whose get_type() functions return the same.
////////////////////////////////////////////////////////////////////
int LightRampAttrib::
compare_to_impl(const RenderAttrib *other) const {
const LightRampAttrib *ta;
DCAST_INTO_R(ta, other, 0);
int compare_result = ((int)_mode - (int)ta->_mode) ;
if (compare_result!=0) {
return compare_result;
}
for (int i=0; i<2; i++) {
if (_level[i] != ta->_level[i]) {
return (_level[i] < ta->_level[i]) ? -1 : 1;
}
}
for (int i=0; i<2; i++) {
if (_threshold[i] != ta->_threshold[i]) {
return (_threshold[i] < ta->_threshold[i]) ? -1 : 1;
}
}
return 0;
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_default_impl
// Access: Protected, Virtual
// Description: Intended to be overridden by derived LightRampAttrib
// types to specify what the default property for a
// LightRampAttrib of this type should be.
//
// This should return a newly-allocated LightRampAttrib of
// the same type that corresponds to whatever the
// standard default for this kind of LightRampAttrib is.
////////////////////////////////////////////////////////////////////
RenderAttrib *LightRampAttrib::
make_default_impl() const {
return new LightRampAttrib;
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::store_into_slot
// Access: Public, Virtual
// Description: Stores this attrib into the appropriate slot of
// an object of class AttribSlots.
////////////////////////////////////////////////////////////////////
void LightRampAttrib::
store_into_slot(AttribSlots *slots) const {
slots->_light_ramp = this;
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::register_with_read_factory
// Access: Public, Static
// Description: Tells the BamReader how to create objects of type
// LightRampAttrib.
////////////////////////////////////////////////////////////////////
void LightRampAttrib::
register_with_read_factory() {
BamReader::get_factory()->register_factory(get_class_type(), make_from_bam);
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::write_datagram
// Access: Public, Virtual
// Description: Writes the contents of this object to the datagram
// for shipping out to a Bam file.
////////////////////////////////////////////////////////////////////
void LightRampAttrib::
write_datagram(BamWriter *manager, Datagram &dg) {
RenderAttrib::write_datagram(manager, dg);
dg.add_int8(_mode);
for (int i=0; i<2; i++) {
dg.add_float32(_level[i]);
}
for (int i=0; i<2; i++) {
dg.add_float32(_threshold[i]);
}
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::make_from_bam
// Access: Protected, Static
// Description: This function is called by the BamReader's factory
// when a new object of type LightRampAttrib is encountered
// in the Bam file. It should create the LightRampAttrib
// and extract its information from the file.
////////////////////////////////////////////////////////////////////
TypedWritable *LightRampAttrib::
make_from_bam(const FactoryParams &params) {
LightRampAttrib *attrib = new LightRampAttrib;
DatagramIterator scan;
BamReader *manager;
parse_params(params, scan, manager);
attrib->fillin(scan, manager);
return attrib;
}
////////////////////////////////////////////////////////////////////
// Function: LightRampAttrib::fillin
// Access: Protected
// Description: This internal function is called by make_from_bam to
// read in all of the relevant data from the BamFile for
// the new LightRampAttrib.
////////////////////////////////////////////////////////////////////
void LightRampAttrib::
fillin(DatagramIterator &scan, BamReader *manager) {
RenderAttrib::fillin(scan, manager);
_mode = (LightRampMode)scan.get_int8();
for (int i=0; i<2; i++) {
_level[i] = scan.get_float32();
}
for (int i=0; i<2; i++) {
_threshold[i] = scan.get_float32();
}
}