Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions

PaletteGroups Class Reference

A set of PaletteGroups. More...

#include "paletteGroups.h"

Inheritance diagram for PaletteGroups:
TypedWritable TypedObject MemoryBase

List of all members.

Public Types

typedef Groups::const_iterator const_iterator
typedef Groups::const_pointer const_pointer
typedef Groups::const_reference const_reference
typedef
Groups::const_reverse_iterator 
const_reverse_iterator
typedef Groups::difference_type difference_type
typedef Groups::const_iterator iterator
typedef Groups::const_pointer pointer
typedef Groups::const_reference reference
typedef
Groups::const_reverse_iterator 
reverse_iterator
typedef Groups::size_type size_type

Public Member Functions

 PaletteGroups (const PaletteGroups &copy)
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
iterator begin () const
 Returns an iterator suitable for traversing the set.
void clear ()
 Empties the set.
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Called after the object is otherwise completely read from a Bam file, this function's job is to store the pointers that were retrieved from the Bam file for each pointer object written.
size_type count (PaletteGroup *group) const
 Returns the number of times the given group appears in the set.
bool empty () const
 Returns true if the set is empty, false otherwise.
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
iterator end () const
 Returns an iterator suitable for traversing the set.
void fillin (DatagramIterator &scan, BamReader *manager)
 Reads the binary data from the given datagram iterator, which was written by a previous call to write_datagram().
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.
virtual TypeHandle force_init_type ()
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter.
int get_best_parent_from_Set (const std::set< int > &) const
virtual TypeHandle get_type () const
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
void insert (PaletteGroup *group)
 Inserts a new group to the set, if it is not already there.
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
void make_complete (const PaletteGroups &a)
 Completes the set with the transitive closure of all dependencies: for each PaletteGroup already in the set a, all of the groups that it depends on are added to the set, and so on.
void make_intersection (const PaletteGroups &a, const PaletteGroups &b)
 Computes the intersection of PaletteGroups a and b, and stores the result in this object.
void make_union (const PaletteGroups &a, const PaletteGroups &b)
 Computes the union of PaletteGroups a and b, and stores the result in this object.
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void operator= (const PaletteGroups &copy)
void output (ostream &out) const
void remove_null ()
 Removes the special "null" group from the set.
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.
size_type size () const
 Returns the number of elements in the set.
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.
void write (ostream &out, int indent_level=0) const
virtual void write_datagram (BamWriter *writer, Datagram &datagram)
 Fills the indicated datagram up with a binary representation of the current object, in preparation for writing to a Bam file.

Static Public Member Functions

static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string.
static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.
static void register_with_read_factory ()
 Registers the current object as something that can be read from a Bam file.

Static Public Attributes

static TypedWritable *const Null = (TypedWritable*)0L

Static Protected Member Functions

static TypedWritablemake_PaletteGroups (const FactoryParams &params)
 This method is called by the BamReader when an object of this type is encountered in a Bam file; it should allocate and return a new object with all the data read.

Detailed Description

A set of PaletteGroups.

This presents an interface very like an STL set, with a few additional functions.

Definition at line 31 of file paletteGroups.h.


Member Function Documentation

ReferenceCount * TypedWritable::as_reference_count ( ) [virtual, inherited]

Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.

Reimplemented in PandaNode, and TypedWritableReferenceCount.

Definition at line 155 of file typedWritable.cxx.

Referenced by BamReader::change_pointer(), BamReader::register_change_this(), and BamReader::resolve().

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 110 of file typedObject.I.

PaletteGroups::iterator PaletteGroups::begin ( ) const
void PaletteGroups::clear ( void  )

Empties the set.

Definition at line 203 of file paletteGroups.cxx.

Referenced by EggFile::build_cross_links(), PaletteGroup::clear_depends(), and EggFile::match_txa_groups().

int PaletteGroups::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
) [virtual]

Called after the object is otherwise completely read from a Bam file, this function's job is to store the pointers that were retrieved from the Bam file for each pointer object written.

The return value is the number of pointers processed from the list.

Reimplemented from TypedWritable.

Definition at line 359 of file paletteGroups.cxx.

Referenced by TextureImage::complete_pointers(), PaletteGroup::complete_pointers(), and EggFile::complete_pointers().

PaletteGroups::size_type PaletteGroups::count ( PaletteGroup group) const

Returns the number of times the given group appears in the set.

This is either 1 if it appears at all, or 0 if it does not appear.

Definition at line 77 of file paletteGroups.cxx.

Referenced by EggFile::choose_placements().

bool TypedWritable::decode_raw_from_bam_stream ( TypedWritable *&  ptr,
ReferenceCount *&  ref_ptr,
const string &  data,
BamReader reader = NULL 
) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string.

Returns true on success, false on on error.

This variant sets the TypedWritable and ReferenceCount pointers separately; both are pointers to the same object. The reference count is not incremented; it is the caller's responsibility to manage the reference count.

Note that this method cannot be used to retrieve objects that do not inherit from ReferenceCount, because these objects cannot persist beyond the lifetime of the BamReader that reads them. To retrieve these objects from a bam stream, you must construct a BamReader directly.

If you happen to know that the particular object in question inherits from TypedWritableReferenceCount or PandaNode, consider calling the variant of decode_from_bam_stream() defined for those methods, which presents a simpler interface.

Definition at line 353 of file typedWritable.cxx.

References BamReader::init(), DatagramInputFile::open(), DatagramInputFile::read_header(), BamReader::read_object(), ReferenceCount::ref(), BamReader::resolve(), BamReader::set_source(), and ReferenceCount::unref().

bool PaletteGroups::empty ( ) const
string TypedWritable::encode_to_bam_stream ( ) const [inline, inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.

Returns empty string on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 86 of file typedWritable.I.

bool TypedWritable::encode_to_bam_stream ( string &  data,
BamWriter writer = NULL 
) const [inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

Returns true on success, false on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 283 of file typedWritable.cxx.

References BamWriter::init(), DatagramOutputFile::open(), BamWriter::set_target(), DatagramOutputFile::write_header(), and BamWriter::write_object().

PaletteGroups::iterator PaletteGroups::end ( ) const
void PaletteGroups::fillin ( DatagramIterator scan,
BamReader manager 
) [virtual]

Reads the binary data from the given datagram iterator, which was written by a previous call to write_datagram().

Reimplemented from TypedWritable.

Definition at line 396 of file paletteGroups.cxx.

References DatagramIterator::get_int32(), and BamReader::read_pointers().

Referenced by TextureImage::fillin(), PaletteGroup::fillin(), EggFile::fillin(), and make_PaletteGroups().

void TypedWritable::finalize ( BamReader manager) [virtual, inherited]

Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.

Reimplemented in PartBundle, Geom, GeomPrimitive, GeomVertexArrayData, GeomVertexArrayFormat, GeomVertexData, InternalName, GeomNode, LightAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderState, PaletteGroup, and Palettizer.

Definition at line 145 of file typedWritable.cxx.

Referenced by BamReader::finalize_now().

UpdateSeq TypedWritable::get_bam_modified ( ) const [inline, inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

Definition at line 66 of file typedWritable.I.

Referenced by BamWriter::consider_update(), and BamWriter::write_pointer().

int TypedObject::get_type_index ( ) const [inline, inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

This is equivalent to get_type().get_index().

Definition at line 52 of file typedObject.I.

References TypeHandle::get_index().

static void PaletteGroups::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedWritable.

Definition at line 96 of file paletteGroups.h.

void PaletteGroups::insert ( PaletteGroup group)

Inserts a new group to the set, if it is not already there.

Definition at line 65 of file paletteGroups.cxx.

Referenced by TextureImage::assign_groups(), EggFile::build_cross_links(), PaletteGroup::group_with(), and TxaLine::parse().

bool TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
bool TypedObject::is_of_type ( TypeHandle  handle) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

void PaletteGroups::make_complete ( const PaletteGroups a)

Completes the set with the transitive closure of all dependencies: for each PaletteGroup already in the set a, all of the groups that it depends on are added to the set, and so on.

The indicated set a may be the same as this set.

Definition at line 91 of file paletteGroups.cxx.

Referenced by EggFile::build_cross_links(), PaletteGroup::get_complete_placements(), and Palettizer::report_statistics().

void PaletteGroups::make_intersection ( const PaletteGroups a,
const PaletteGroups b 
)

Computes the intersection of PaletteGroups a and b, and stores the result in this object.

The result may be the same object as either a or b.

Definition at line 154 of file paletteGroups.cxx.

Referenced by TextureImage::assign_groups(), and EggFile::choose_placements().

TypedWritable * PaletteGroups::make_PaletteGroups ( const FactoryParams params) [static, protected]

This method is called by the BamReader when an object of this type is encountered in a Bam file; it should allocate and return a new object with all the data read.

Definition at line 378 of file paletteGroups.cxx.

References fillin().

Referenced by register_with_read_factory().

void PaletteGroups::make_union ( const PaletteGroups a,
const PaletteGroups b 
)

Computes the union of PaletteGroups a and b, and stores the result in this object.

The result may be the same object as either a or b.

Definition at line 110 of file paletteGroups.cxx.

Referenced by TextureImage::assign_groups(), TxaLine::match_texture(), and EggFile::match_txa_groups().

void TypedWritable::mark_bam_modified ( ) [inline, inherited]
void PaletteGroups::register_with_read_factory ( ) [static]

Registers the current object as something that can be read from a Bam file.

Definition at line 326 of file paletteGroups.cxx.

References BamReader::get_factory(), and make_PaletteGroups().

void PaletteGroups::remove_null ( )

Removes the special "null" group from the set.

This is a special group that egg files may be assigned to, but which textures never are; it indicates that the egg file should not influence the palette assignment.

Definition at line 187 of file paletteGroups.cxx.

Referenced by TextureImage::assign_groups(), and TxaLine::match_texture().

bool TypedWritable::require_fully_complete ( ) const [virtual, inherited]

Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.

If this is the case, override this method to return true, and be careful with circular references (which would make the object unreadable from a bam file).

Reimplemented in GeomVertexData, ClipPlaneAttrib, and RenderEffects.

Definition at line 118 of file typedWritable.cxx.

PaletteGroups::size_type PaletteGroups::size ( ) const

Returns the number of elements in the set.

Definition at line 223 of file paletteGroups.cxx.

Referenced by Palettizer::report_statistics().

void TypedWritable::update_bam_nested ( BamWriter manager) [virtual, inherited]

Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.

Reimplemented in CFDoCullCommand, and PandaNode.

Definition at line 77 of file typedWritable.cxx.

void PaletteGroups::write_datagram ( BamWriter writer,
Datagram datagram 
) [virtual]

Fills the indicated datagram up with a binary representation of the current object, in preparation for writing to a Bam file.

Reimplemented from TypedWritable.

Definition at line 339 of file paletteGroups.cxx.

References Datagram::add_uint32(), and BamWriter::write_pointer().

Referenced by TextureImage::write_datagram(), PaletteGroup::write_datagram(), and EggFile::write_datagram().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations