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"

Inheritance diagram for TexturePlacement:

List of all members.

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.
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.
void	compute_tex_matrix (LMatrix3d &transform)
	Stores in the indicated matrix the appropriate texture matrix transform for the new placement of the texture.
bool	determine_size ()
	Attempts to determine the appropriate size of the texture for the given placement.
void	fill_image (PNMImage &image)
	Fills in the rectangle of the palette image represented by the texture placement with the image pixels.
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.
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.
void	force_replace ()
	Removes the texture from its particular PaletteImage, but does not remove it from the PaletteGroup.
DestTextureImage *	get_dest () const
	Returns the DestTextureImage that corresponds to this texture as it was copied to the install directory.
PaletteGroup *	get_group () const
	Returns the group that this placement represents.
PaletteImage *	get_image () const
	Returns the particular PaletteImage on which the texture has been placed.
const string &	get_name () const
	Returns the name of the texture that this placement represents.
OmitReason	get_omit_reason () const
	Returns the reason the texture has been omitted from a palette image, or OR_none if it has not.
PalettePage *	get_page () const
	Returns the particular PalettePage on which the texture has been placed.
double	get_placed_uv_area () const
	Returns the total area of the rectangle occupied by the UV minmax box, as it has been placed.
int	get_placed_x () const
	Returns the X pixel at which the texture has been placed within its PaletteImage.
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.
int	get_placed_y () const
	Returns the Y pixel at which the texture has been placed within its PaletteImage.
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.
const TextureProperties &	get_properties () const
	Returns the grouping properties of the image.
TextureImage *	get_texture () const
	Returns the texture that this placement represents.
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.
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.
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.
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.
bool	is_filled () const
	Returns true if the texture has been filled (i.e.
bool	is_placed () const
	Returns true if the texture has been placed on a palette image, false otherwise.
bool	is_size_known () const
	Returns true if the texture's size is known, false otherwise.
void	mark_eggs_stale ()
	Marks all the egg files that reference this placement stale.
void	mark_unfilled ()
	Marks the texture as unfilled, so that it will need to be copied into the palette image again.
void	not_solitary ()
	Indicates that the texture, formerly indicated as solitary, is now no longer.
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.
void	place_at (PaletteImage *image, int x, int y)
	Assigns the texture to a particular position within the indicated PaletteImage.
void	remove_egg (TextureReference *reference)
	Notes that a particular egg file is no longer using this particular TexturePlacement.
void	set_dest (DestTextureImage *dest)
	Sets the DestTextureImage that corresponds to this texture as it was copied to the install directory.
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.
void	write_placed (ostream &out, int indent_level=0)
	Writes the placement position information on a line by itself.
Static Public Member Functions
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.
Public Attributes
TextureSwaps	_textureSwaps
Protected Member Functions
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().
Static Protected Member Functions
static TypedWritable *	make_TexturePlacement (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

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.

Member Function Documentation

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().

Referenced by TextureReference::set_placement().

int TexturePlacement::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 1127 of file texturePlacement.cxx.

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 ImageFile::get_x_size(), ImageFile::get_y_size(), LMatrix3d::ident_mat(), is_placed(), LMatrix3d::scale_mat(), and LMatrix3d::translate_mat().

Referenced by fill_image(), fill_swapped_image(), 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 force_replace(), TextureImage::get_coverage_threshold(), TextureReference::get_max_uv(), TextureReference::get_min_uv(), TextureImage::get_omit(), TextureImage::get_txa_wrap_u(), TextureImage::get_txa_wrap_v(), get_uv_area(), TextureReference::get_wrap_u(), TextureReference::get_wrap_v(), TextureReference::has_uvs(), PaletteGroup::is_none_texture_swap(), is_placed(), ImageFile::is_size_known(), and mark_eggs_stale().

Referenced by TextureImage::determine_placement_size(), 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 compute_tex_matrix(), flag_error_image(), PNMImageHeader::get_maxval(), PNMImageHeader::get_num_channels(), ImageFile::get_x_size(), ImageFile::get_y_size(), PNMImageHeader::has_alpha(), is_placed(), PNMImage::is_valid(), PNMImage::quick_filter_from(), TextureImage::read_source_image(), TextureImage::release_source_image(), PNMImage::set_alpha(), and PNMImage::set_xel().

Referenced by 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 compute_tex_matrix(), flag_error_image(), PNMImageHeader::get_maxval(), PNMImageHeader::get_num_channels(), ImageFile::get_x_size(), ImageFile::get_y_size(), PNMImageHeader::has_alpha(), is_placed(), PNMImage::is_valid(), PNMImage::quick_filter_from(), TextureImage::read_source_image(), TextureImage::release_source_image(), PNMImage::set_alpha(), and PNMImage::set_xel().

Referenced by PaletteImage::update_image().

void TexturePlacement::fillin	(	DatagramIterator &	scan,
		BamReader *	manager
	)		`[protected, 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 1195 of file texturePlacement.cxx.

References TexturePosition::fillin(), DatagramIterator::get_bool(), DatagramIterator::get_int32(), BamReader::read_pointer(), and BamReader::read_pointers().

Referenced by make_TexturePlacement().

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(), is_placed(), PNMImage::set_alpha_val(), and PNMImage::set_xel_val().

Referenced by fill_image(), and 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 mark_eggs_stale(), and PaletteImage::unplace().

Referenced by determine_size(), 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.

Referenced by TextureMemoryCounter::add_placement(), 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.

Referenced by EggFile::choose_placements(), 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 is_placed().

Referenced by TextureMemoryCounter::add_placement(), 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.

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.

Referenced by TextureMemoryCounter::add_placement(), PaletteImage::check_solitary(), TextureImage::copy_unplaced(), 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 PaletteImage::get_page(), and is_placed().

Referenced by 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 is_placed().

Referenced by write_placed().

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 is_placed().

Referenced by write_placed().

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 is_placed().

Referenced by TextureMemoryCounter::add_placement(), PaletteImage::count_coverage(), PaletteImage::count_utilization(), and write_placed().

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 is_placed().

Referenced by write_placed().

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 is_placed().

Referenced by TextureMemoryCounter::add_placement(), PaletteImage::count_coverage(), PaletteImage::count_utilization(), and write_placed().

const TextureProperties & TexturePlacement::get_properties ( ) const

Returns the grouping properties of the image.

Definition at line 124 of file texturePlacement.cxx.

References ImageFile::get_properties().

Referenced by PaletteGroup::place_all().

TextureImage * TexturePlacement::get_texture ( ) const

Returns the texture that this placement represents.

Definition at line 114 of file texturePlacement.cxx.

Referenced by TextureMemoryCounter::add_placement(), PaletteImage::count_coverage(), PaletteImage::update_image(), PaletteGroup::update_unknown_textures(), PaletteGroup::write_image_info(), and write_placed().

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.

Referenced by determine_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.

Referenced by 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.

Referenced by SortPlacementBySize::operator()(), PaletteImage::place(), and PaletteGroup::write_image_info().

static void TexturePlacement::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 141 of file texturePlacement.h.

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 is_placed().

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.

Referenced by PaletteImage::update_image().

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.

Referenced by compute_tex_matrix(), determine_size(), fill_image(), fill_swapped_image(), flag_error_image(), get_image(), get_page(), get_placed_uv_area(), get_placed_x(), get_placed_x_size(), get_placed_y(), get_placed_y_size(), intersects(), not_solitary(), omit_solitary(), PaletteImage::place(), place_at(), PalettePage::unplace(), PaletteImage::unplace(), PaletteGroup::unplace(), and write_placed().

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.

Referenced by PaletteImage::place(), and PaletteGroup::update_unknown_textures().

TypedWritable * TexturePlacement::make_TexturePlacement ( 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 1177 of file texturePlacement.cxx.

References fillin().

Referenced by register_with_read_factory().

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().

Referenced by determine_size(), force_replace(), not_solitary(), omit_solitary(), 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.

Referenced by 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 is_placed(), and mark_eggs_stale().

Referenced by PaletteImage::check_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 is_placed(), and mark_eggs_stale().

Referenced by PaletteImage::check_solitary().

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 is_placed().

Referenced by PaletteImage::place().

void TexturePlacement::register_with_read_factory ( ) [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 make_TexturePlacement().

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().

Referenced by 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.

Referenced by TextureImage::copy_unplaced().

void TexturePlacement::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 1088 of file texturePlacement.cxx.

References Datagram::add_bool(), Datagram::add_int32(), TexturePosition::write_datagram(), and BamWriter::write_pointer().

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 get_placed_uv_area(), get_placed_x(), get_placed_x_size(), get_placed_y(), get_placed_y_size(), get_texture(), and is_placed().

Referenced by PaletteImage::write_placements().

The documentation for this class was generated from the following files:

pandatool/src/palettizer/texturePlacement.h
pandatool/src/palettizer/texturePlacement.cxx

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation