Panda3D
|
This corresponds to a particular assignment of a TextureImage with a PaletteGroup, and specifically describes which PaletteImage (if any), and where on the PaletteImage, the TextureImage has been assigned to. More...
#include "texturePlacement.h"
Public Types | |
typedef pvector< TextureImage * > | TextureSwaps |
Public Member Functions | |
TexturePlacement (TextureImage *texture, PaletteGroup *group) | |
void | add_egg (TextureReference *reference) |
Records the fact that a particular egg file is using this particular TexturePlacement. More... | |
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. More... | |
void | compute_tex_matrix (LMatrix3d &transform) |
Stores in the indicated matrix the appropriate texture matrix transform for the new placement of the texture. More... | |
bool | determine_size () |
Attempts to determine the appropriate size of the texture for the given placement. More... | |
void | fill_image (PNMImage &image) |
Fills in the rectangle of the palette image represented by the texture placement with the image pixels. More... | |
void | fill_swapped_image (PNMImage &image, int index) |
Fills in the rectangle of the swapped palette image represented by the texture placement with the image pixels. More... | |
void | flag_error_image (PNMImage &image) |
Sets the rectangle of the palette image represented by the texture placement to red, to represent a missing texture. More... | |
void | force_replace () |
Removes the texture from its particular PaletteImage, but does not remove it from the PaletteGroup. More... | |
DestTextureImage * | get_dest () const |
Returns the DestTextureImage that corresponds to this texture as it was copied to the install directory. More... | |
PaletteGroup * | get_group () const |
Returns the group that this placement represents. More... | |
PaletteImage * | get_image () const |
Returns the particular PaletteImage on which the texture has been placed. More... | |
const string & | get_name () const |
Returns the name of the texture that this placement represents. More... | |
OmitReason | get_omit_reason () const |
Returns the reason the texture has been omitted from a palette image, or OR_none if it has not. More... | |
PalettePage * | get_page () const |
Returns the particular PalettePage on which the texture has been placed. More... | |
double | get_placed_uv_area () const |
Returns the total area of the rectangle occupied by the UV minmax box, as it has been placed. More... | |
int | get_placed_x () const |
Returns the X pixel at which the texture has been placed within its PaletteImage. More... | |
int | get_placed_x_size () const |
Returns the size in the X dimension, in pixels, of the texture image as it has been placed within the palette. More... | |
int | get_placed_y () const |
Returns the Y pixel at which the texture has been placed within its PaletteImage. More... | |
int | get_placed_y_size () const |
Returns the size in the Y dimension, in pixels, of the texture image as it has been placed within the palette. More... | |
const TextureProperties & | get_properties () const |
Returns the grouping properties of the image. More... | |
TextureImage * | get_texture () const |
Returns the texture that this placement represents. More... | |
virtual TypeHandle | get_type () const |
double | get_uv_area () const |
Returns the total area of the rectangle occupied by the UV minmax box, in UV coordinates. More... | |
int | get_x_size () const |
Returns the size in the X dimension, in pixels, of the texture image as it must appear in the palette. More... | |
int | get_y_size () const |
Returns the size in the Y dimension, in pixels, of the texture image as it must appear in the palette. More... | |
bool | intersects (int x, int y, int x_size, int y_size) |
Returns true if the particular position this texture has been assigned to overlaps the rectangle whose top left corner is at x, y and whose size is given by x_size, y_size, or false otherwise. More... | |
bool | is_filled () const |
Returns true if the texture has been filled (i.e. More... | |
bool | is_placed () const |
Returns true if the texture has been placed on a palette image, false otherwise. More... | |
bool | is_size_known () const |
Returns true if the texture's size is known, false otherwise. More... | |
void | mark_eggs_stale () |
Marks all the egg files that reference this placement stale. More... | |
void | mark_unfilled () |
Marks the texture as unfilled, so that it will need to be copied into the palette image again. More... | |
void | not_solitary () |
Indicates that the texture, formerly indicated as solitary, is now no longer. More... | |
void | omit_solitary () |
Sets the omit reason (returned by get_omit()) to OR_solitary, indicating that the palettized version of the texture should not be used because it is the only texture on a PaletteImage. More... | |
void | place_at (PaletteImage *image, int x, int y) |
Assigns the texture to a particular position within the indicated PaletteImage. More... | |
void | remove_egg (TextureReference *reference) |
Notes that a particular egg file is no longer using this particular TexturePlacement. More... | |
void | set_dest (DestTextureImage *dest) |
Sets the DestTextureImage that corresponds to this texture as it was copied to the install directory. More... | |
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. More... | |
void | write_placed (ostream &out, int indent_level=0) |
Writes the placement position information on a line by itself. More... | |
![]() | |
TypedWritable (const TypedWritable ©) | |
virtual ReferenceCount * | as_reference_count () |
Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More... | |
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. More... | |
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. More... | |
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. More... | |
virtual TypeHandle | force_init_type () |
UpdateSeq | get_bam_modified () const |
Returns the current bam_modified counter. More... | |
void | mark_bam_modified () |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More... | |
void | operator= (const TypedWritable ©) |
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. More... | |
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. More... | |
![]() | |
TypedObject (const TypedObject ©) | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
int | get_best_parent_from_Set (const std::set< int > &) const |
int | get_type_index () const |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
bool | is_exact_type (TypeHandle handle) const |
Returns true if the current object is the indicated type exactly. More... | |
bool | is_of_type (TypeHandle handle) const |
Returns true if the current object is or derives from the indicated type. More... | |
void | operator= (const TypedObject ©) |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
static void | register_with_read_factory () |
Registers the current object as something that can be read from a Bam file. More... | |
![]() | |
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. More... | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
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. More... | |
Public Attributes | |
TextureSwaps | _textureSwaps |
Additional Inherited Members | |
![]() | |
static TypedWritable *const | Null = (TypedWritable*)0L |
This corresponds to a particular assignment of a TextureImage with a PaletteGroup, and specifically describes which PaletteImage (if any), and where on the PaletteImage, the TextureImage has been assigned to.
Definition at line 45 of file texturePlacement.h.
void TexturePlacement::add_egg | ( | TextureReference * | reference | ) |
Records the fact that a particular egg file is using this particular TexturePlacement.
Definition at line 145 of file texturePlacement.cxx.
References TextureReference::mark_egg_stale(), and remove_egg().
Referenced by get_group(), and TextureReference::set_placement().
|
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 1127 of file texturePlacement.cxx.
References TypedWritable::complete_pointers(), TypedWritable::fillin(), DatagramIterator::get_bool(), DatagramIterator::get_int32(), SortPlacementBySize::operator()(), BamReader::read_pointer(), and BamReader::read_pointers().
Referenced by write_datagram().
void TexturePlacement::compute_tex_matrix | ( | LMatrix3d & | transform | ) |
Stores in the indicated matrix the appropriate texture matrix transform for the new placement of the texture.
Definition at line 700 of file texturePlacement.cxx.
References LMatrix3d::ident_mat(), LMatrix3d::scale_mat(), LMatrix3d::translate_mat(), and write_placed().
Referenced by intersects(), and TextureReference::update_egg().
bool TexturePlacement::determine_size | ( | ) |
Attempts to determine the appropriate size of the texture for the given placement.
This is based on the UV range of the egg files that reference the texture. Returns true on success, or false if the texture size cannot be determined (e.g. the texture file is unknown).
After this returns true, get_x_size() and get_y_size() may safely be called.
Definition at line 226 of file texturePlacement.cxx.
References TextureReference::get_max_uv(), TextureReference::get_min_uv(), TextureReference::get_wrap_u(), TextureReference::get_wrap_v(), TextureReference::has_uvs(), and is_size_known().
Referenced by TextureImage::determine_placement_size(), get_dest(), and PaletteGroup::update_unknown_textures().
void TexturePlacement::fill_image | ( | PNMImage & | image | ) |
Fills in the rectangle of the palette image represented by the texture placement with the image pixels.
Definition at line 797 of file texturePlacement.cxx.
References fill_swapped_image(), PNMImageHeader::get_maxval(), PNMImageHeader::get_num_channels(), PNMImageHeader::has_alpha(), PNMImage::is_valid(), PNMImage::quick_filter_from(), PNMImage::set_alpha(), and PNMImage::set_xel().
Referenced by mark_unfilled(), PaletteImage::update_filename(), and PaletteImage::update_image().
void TexturePlacement::fill_swapped_image | ( | PNMImage & | image, |
int | index | ||
) |
Fills in the rectangle of the swapped palette image represented by the texture placement with the image pixels.
Definition at line 897 of file texturePlacement.cxx.
References flag_error_image(), PNMImageHeader::get_maxval(), PNMImageHeader::get_num_channels(), PNMImageHeader::has_alpha(), PNMImage::is_valid(), PNMImage::quick_filter_from(), TextureImage::read_source_image(), TextureImage::release_source_image(), PNMImage::set_alpha(), and PNMImage::set_xel().
Referenced by fill_image(), PaletteImage::update_filename(), and PaletteImage::update_image().
void TexturePlacement::flag_error_image | ( | PNMImage & | image | ) |
Sets the rectangle of the palette image represented by the texture placement to red, to represent a missing texture.
Definition at line 999 of file texturePlacement.cxx.
References PNMImageHeader::has_alpha(), register_with_read_factory(), PNMImage::set_alpha_val(), and PNMImage::set_xel_val().
Referenced by fill_swapped_image().
void TexturePlacement::force_replace | ( | ) |
Removes the texture from its particular PaletteImage, but does not remove it from the PaletteGroup.
It will be re-placed when the PaletteGroup::place_all() is called.
Definition at line 625 of file texturePlacement.cxx.
References omit_solitary().
Referenced by place_at(), and PaletteImage::reset_image().
DestTextureImage * TexturePlacement::get_dest | ( | ) | const |
Returns the DestTextureImage that corresponds to this texture as it was copied to the install directory.
Definition at line 208 of file texturePlacement.cxx.
References determine_size().
Referenced by TextureMemoryCounter::add_placement(), set_dest(), TextureReference::update_egg(), and TextureImage::write_scale_info().
PaletteGroup * TexturePlacement::get_group | ( | ) | const |
Returns the group that this placement represents.
Definition at line 134 of file texturePlacement.cxx.
References add_egg().
Referenced by EggFile::choose_placements(), get_properties(), and PaletteGroup::unplace().
PaletteImage * TexturePlacement::get_image | ( | ) | const |
Returns the particular PaletteImage on which the texture has been placed.
Definition at line 512 of file texturePlacement.cxx.
References get_page().
Referenced by TextureMemoryCounter::add_placement(), is_placed(), PalettePage::unplace(), PaletteImage::unplace(), TextureReference::update_egg(), and TextureImage::write_scale_info().
const string & TexturePlacement::get_name | ( | ) | const |
Returns the name of the texture that this placement represents.
Definition at line 104 of file texturePlacement.cxx.
References get_texture().
Referenced by SortPlacementBySize::operator()().
OmitReason TexturePlacement::get_omit_reason | ( | ) | const |
Returns the reason the texture has been omitted from a palette image, or OR_none if it has not.
Definition at line 442 of file texturePlacement.cxx.
References get_x_size().
Referenced by TextureMemoryCounter::add_placement(), PaletteImage::check_solitary(), TextureImage::copy_unplaced(), is_size_known(), PalettePage::place(), PaletteGroup::place_all(), TextureReference::update_egg(), PaletteGroup::write_image_info(), and TextureImage::write_scale_info().
PalettePage * TexturePlacement::get_page | ( | ) | const |
Returns the particular PalettePage on which the texture has been placed.
Definition at line 524 of file texturePlacement.cxx.
References get_placed_x().
Referenced by get_image(), PalettePage::unplace(), and PaletteGroup::unplace().
double TexturePlacement::get_placed_uv_area | ( | ) | const |
Returns the total area of the rectangle occupied by the UV minmax box, as it has been placed.
See also get_uv_area().
Definition at line 589 of file texturePlacement.cxx.
References place_at().
Referenced by get_placed_y_size().
int TexturePlacement::get_placed_x | ( | ) | const |
Returns the X pixel at which the texture has been placed within its PaletteImage.
It is an error to call this unless is_placed() returns true.
Definition at line 537 of file texturePlacement.cxx.
References get_placed_y().
Referenced by get_page(), and PaletteImage::update_filename().
int TexturePlacement::get_placed_x_size | ( | ) | const |
Returns the size in the X dimension, in pixels, of the texture image as it has been placed within the palette.
Definition at line 563 of file texturePlacement.cxx.
References get_placed_y_size().
Referenced by TextureMemoryCounter::add_placement(), PaletteImage::count_coverage(), PaletteImage::count_utilization(), get_placed_y(), and PaletteImage::update_filename().
int TexturePlacement::get_placed_y | ( | ) | const |
Returns the Y pixel at which the texture has been placed within its PaletteImage.
It is an error to call this unless is_placed() returns true.
Definition at line 550 of file texturePlacement.cxx.
References get_placed_x_size().
Referenced by get_placed_x(), and PaletteImage::update_filename().
int TexturePlacement::get_placed_y_size | ( | ) | const |
Returns the size in the Y dimension, in pixels, of the texture image as it has been placed within the palette.
Definition at line 576 of file texturePlacement.cxx.
References get_placed_uv_area().
Referenced by TextureMemoryCounter::add_placement(), PaletteImage::count_coverage(), PaletteImage::count_utilization(), get_placed_x_size(), and PaletteImage::update_filename().
const TextureProperties & TexturePlacement::get_properties | ( | ) | const |
Returns the grouping properties of the image.
Definition at line 124 of file texturePlacement.cxx.
References get_group().
Referenced by get_texture(), and PaletteGroup::place_all().
TextureImage * TexturePlacement::get_texture | ( | ) | const |
Returns the texture that this placement represents.
Definition at line 114 of file texturePlacement.cxx.
References get_properties().
Referenced by TextureMemoryCounter::add_placement(), PaletteImage::count_coverage(), get_name(), PaletteImage::update_image(), PaletteGroup::update_unknown_textures(), and PaletteGroup::write_image_info().
double TexturePlacement::get_uv_area | ( | ) | const |
Returns the total area of the rectangle occupied by the UV minmax box, in UV coordinates.
1.0 is the entire texture; values greater than 1 imply the texture repeats.
Definition at line 483 of file texturePlacement.cxx.
References is_placed().
Referenced by get_y_size(), and PaletteGroup::write_image_info().
int TexturePlacement::get_x_size | ( | ) | const |
Returns the size in the X dimension, in pixels, of the texture image as it must appear in the palette.
This accounts for any growing or shrinking of the texture due to the UV coordinate range.
Definition at line 455 of file texturePlacement.cxx.
References get_y_size().
Referenced by get_omit_reason(), SortPlacementBySize::operator()(), PaletteImage::place(), and PaletteGroup::write_image_info().
int TexturePlacement::get_y_size | ( | ) | const |
Returns the size in the Y dimension, in pixels, of the texture image as it must appear in the palette.
This accounts for any growing or shrinking of the texture due to the UV coordinate range.
Definition at line 469 of file texturePlacement.cxx.
References get_uv_area().
Referenced by get_x_size(), SortPlacementBySize::operator()(), PaletteImage::place(), and PaletteGroup::write_image_info().
bool TexturePlacement::intersects | ( | int | x, |
int | y, | ||
int | x_size, | ||
int | y_size | ||
) |
Returns true if the particular position this texture has been assigned to overlaps the rectangle whose top left corner is at x, y and whose size is given by x_size, y_size, or false otherwise.
Definition at line 679 of file texturePlacement.cxx.
References compute_tex_matrix().
Referenced by not_solitary(), and PaletteImage::update_filename().
bool TexturePlacement::is_filled | ( | ) | const |
Returns true if the texture has been filled (i.e.
fill_image() has been called) since it was placed.
Definition at line 774 of file texturePlacement.cxx.
References mark_unfilled().
Referenced by PaletteImage::update_image(), and write_placed().
bool TexturePlacement::is_placed | ( | ) | const |
Returns true if the texture has been placed on a palette image, false otherwise.
This will generally be true if get_omit_reason() returns OR_none or OR_solitary and false otherwise.
Definition at line 501 of file texturePlacement.cxx.
References get_image().
Referenced by get_uv_area(), PaletteImage::place(), PalettePage::unplace(), PaletteImage::unplace(), PaletteGroup::unplace(), and PaletteImage::update_filename().
bool TexturePlacement::is_size_known | ( | ) | const |
Returns true if the texture's size is known, false otherwise.
Usually this can only be false after determine_size() has been called there is something wrong with the texture (in which case the placement will automatically omit itself from the palette anyway).
Definition at line 431 of file texturePlacement.cxx.
References get_omit_reason().
Referenced by determine_size(), PaletteImage::place(), and PaletteGroup::update_unknown_textures().
void TexturePlacement::mark_eggs_stale | ( | ) |
Marks all the egg files that reference this placement stale.
Presumably this is called after moving the texture around in the palette or something.
Definition at line 181 of file texturePlacement.cxx.
References TextureReference::mark_egg_stale(), and set_dest().
Referenced by remove_egg(), and PaletteImage::update_filename().
void TexturePlacement::mark_unfilled | ( | ) |
Marks the texture as unfilled, so that it will need to be copied into the palette image again.
Definition at line 785 of file texturePlacement.cxx.
References fill_image().
Referenced by is_filled(), TextureImage::post_txa_file(), and PaletteImage::update_image().
void TexturePlacement::not_solitary | ( | ) |
Indicates that the texture, formerly indicated as solitary, is now no longer.
Definition at line 662 of file texturePlacement.cxx.
References intersects().
Referenced by PaletteImage::check_solitary(), and omit_solitary().
void TexturePlacement::omit_solitary | ( | ) |
Sets the omit reason (returned by get_omit()) to OR_solitary, indicating that the palettized version of the texture should not be used because it is the only texture on a PaletteImage.
However, the texture is still considered placed, and is_placed() will return true.
Definition at line 647 of file texturePlacement.cxx.
References not_solitary().
Referenced by PaletteImage::check_solitary(), and force_replace().
void TexturePlacement::place_at | ( | PaletteImage * | image, |
int | x, | ||
int | y | ||
) |
Assigns the texture to a particular position within the indicated PaletteImage.
It is an error to call this if the texture has already been placed elsewhere.
Definition at line 604 of file texturePlacement.cxx.
References force_replace().
Referenced by get_placed_uv_area(), and PaletteImage::place().
|
static |
Registers the current object as something that can be read from a Bam file.
Definition at line 1075 of file texturePlacement.cxx.
References BamReader::get_factory(), and write_datagram().
Referenced by flag_error_image().
void TexturePlacement::remove_egg | ( | TextureReference * | reference | ) |
Notes that a particular egg file is no longer using this particular TexturePlacement.
Definition at line 164 of file texturePlacement.cxx.
References TextureReference::mark_egg_stale(), and mark_eggs_stale().
Referenced by add_egg(), EggFile::remove_egg(), and TextureReference::set_placement().
void TexturePlacement::set_dest | ( | DestTextureImage * | dest | ) |
Sets the DestTextureImage that corresponds to this texture as it was copied to the install directory.
Definition at line 197 of file texturePlacement.cxx.
References get_dest().
Referenced by TextureImage::copy_unplaced(), and mark_eggs_stale().
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 1088 of file texturePlacement.cxx.
References Datagram::add_bool(), Datagram::add_int32(), complete_pointers(), TypedWritable::write_datagram(), and BamWriter::write_pointer().
Referenced by register_with_read_factory().
void TexturePlacement::write_placed | ( | ostream & | out, |
int | indent_level = 0 |
||
) |
Writes the placement position information on a line by itself.
Definition at line 741 of file texturePlacement.cxx.
References is_filled().
Referenced by compute_tex_matrix(), and PaletteImage::write_placements().