// Filename: cullBinAttrib.cxx
// Created by:  drose (01Mar02)
//
////////////////////////////////////////////////////////////////////
//
// 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 "cullBinAttrib.h"
#include "attribSlots.h"
#include "bamReader.h"
#include "bamWriter.h"
#include "datagram.h"
#include "datagramIterator.h"

TypeHandle CullBinAttrib::_type_handle;

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::make
//       Access: Published, Static
//  Description: Constructs a new CullBinAttrib assigning geometry
//               into the named bin.  If the bin name is the empty
//               string, the default bin is used.
//
//               The draw_order specifies further ordering information
//               which is relevant only to certain kinds of bins (in
//               particular CullBinFixed type bins).
////////////////////////////////////////////////////////////////////
CPT(RenderAttrib) CullBinAttrib::
make(const string &bin_name, int draw_order) {
  CullBinAttrib *attrib = new CullBinAttrib;
  attrib->_bin_name = bin_name;
  attrib->_draw_order = draw_order;
  return return_new(attrib);
}

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::output
//       Access: Public, Virtual
//  Description: 
////////////////////////////////////////////////////////////////////
void CullBinAttrib::
output(ostream &out) const {
  out << get_type() << ":";
  if (_bin_name.empty()) {
    out << "(default)";
  } else {
    out << _bin_name << "," << _draw_order;
  }
}

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::compare_to_impl
//       Access: Protected, Virtual
//  Description: Intended to be overridden by derived CullBinAttrib
//               types to return a unique number indicating whether
//               this CullBinAttrib is equivalent to the other one.
//
//               This should return 0 if the two CullBinAttrib 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 CullBinAttrib
//               objects whose get_type() functions return the same.
////////////////////////////////////////////////////////////////////
int CullBinAttrib::
compare_to_impl(const RenderAttrib *other) const {
  const CullBinAttrib *ta;
  DCAST_INTO_R(ta, other, 0);
  if (_draw_order != ta->_draw_order) {
    return _draw_order - ta->_draw_order;
  }
  return strcmp(_bin_name.c_str(), ta->_bin_name.c_str());
}

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::make_default_impl
//       Access: Protected, Virtual
//  Description: Intended to be overridden by derived CullBinAttrib
//               types to specify what the default property for a
//               CullBinAttrib of this type should be.
//
//               This should return a newly-allocated CullBinAttrib of
//               the same type that corresponds to whatever the
//               standard default for this kind of CullBinAttrib is.
////////////////////////////////////////////////////////////////////
RenderAttrib *CullBinAttrib::
make_default_impl() const {
  return new CullBinAttrib;
}

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::store_into_slot
//       Access: Public, Virtual
//  Description: Stores this attrib into the appropriate slot of
//               an object of class AttribSlots.
////////////////////////////////////////////////////////////////////
void CullBinAttrib::
store_into_slot(AttribSlots *slots) const {
  slots->_cull_bin = this;
}

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::register_with_read_factory
//       Access: Public, Static
//  Description: Tells the BamReader how to create objects of type
//               CullBinAttrib.
////////////////////////////////////////////////////////////////////
void CullBinAttrib::
register_with_read_factory() {
  BamReader::get_factory()->register_factory(get_class_type(), make_from_bam);
}

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::write_datagram
//       Access: Public, Virtual
//  Description: Writes the contents of this object to the datagram
//               for shipping out to a Bam file.
////////////////////////////////////////////////////////////////////
void CullBinAttrib::
write_datagram(BamWriter *manager, Datagram &dg) {
  RenderAttrib::write_datagram(manager, dg);

  dg.add_string(_bin_name);
  dg.add_int32(_draw_order);
}

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::make_from_bam
//       Access: Protected, Static
//  Description: This function is called by the BamReader's factory
//               when a new object of type CullBinAttrib is encountered
//               in the Bam file.  It should create the CullBinAttrib
//               and extract its information from the file.
////////////////////////////////////////////////////////////////////
TypedWritable *CullBinAttrib::
make_from_bam(const FactoryParams &params) {
  CullBinAttrib *attrib = new CullBinAttrib;
  DatagramIterator scan;
  BamReader *manager;

  parse_params(params, scan, manager);
  attrib->fillin(scan, manager);

  return attrib;
}

////////////////////////////////////////////////////////////////////
//     Function: CullBinAttrib::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 CullBinAttrib.
////////////////////////////////////////////////////////////////////
void CullBinAttrib::
fillin(DatagramIterator &scan, BamReader *manager) {
  RenderAttrib::fillin(scan, manager);

  _bin_name = scan.get_string();
  _draw_order = scan.get_int32();
}
