Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

DestTextureImage Class Reference

This represents a texture filename as it has been resized and copied to the map directory (e.g. More...

#include <destTextureImage.h>

Inheritance diagram for DestTextureImage:


Public Member Functions
	DestTextureImage (TexturePlacement *placement)
void	copy (TextureImage *texture)
	Unconditionally copies the source texture into the appropriate filename.
void	copy_if_stale (const DestTextureImage other, TextureImage texture)
	Copies the source texture into the appropriate filename only if the indicated old reference, which represents the way it was last copied, is now out-of-date.
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.
virtual TypeHandle	get_type () const
void	make_shadow_image (const string &basename)
	Sets up the ImageFile as a "shadow image" of a particular PaletteImage.
bool	is_size_known () const
	Returns true if the size of the image file is known, false otherwise.
int	get_x_size () const
	Returns the size of the image file in pixels in the X direction.
int	get_y_size () const
	Returns the size of the image file in pixels in the Y direction.
bool	has_num_channels () const
	Returns true if the number of channels in the image is known, false otherwise.
int	get_num_channels () const
	Returns the number of channels of the image.
const TextureProperties &	get_properties () const
	Returns the grouping properties of the image.
void	clear_basic_properties ()
	Resets the properties to a neutral state, for instance in preparation for calling update_properties() with all the known contributing properties.
void	update_properties (const TextureProperties &properties)
	If the indicate TextureProperties structure is more specific than this one, updates this one.
void	set_filename (PaletteGroup *group, const string &basename)
	Sets the filename, and if applicable, the alpha_filename, from the indicated basename.
void	set_filename (const string &dirname, const string &basename)
	Sets the filename, and if applicable, the alpha_filename, from the indicated basename.
const Filename &	get_filename () const
	Returns the primary filename of the image file.
const Filename &	get_alpha_filename () const
	Returns the alpha filename of the image file.
int	get_alpha_file_channel () const
	Returns the particular channel number of the alpha image file from which the alpha channel should be extracted.
bool	exists () const
	Returns true if the file or files named by the image file exist, false otherwise.
bool	read (PNMImage &image) const
	Reads in the image (or images, if the alpha_filename is separate) and stores it in the indicated PNMImage.
bool	write (const PNMImage &image) const
	Writes out the image in the indicated PNMImage to the _filename and/or _alpha_filename.
void	unlink ()
	Deletes the image file or files.
void	update_egg_tex (EggTexture *egg_tex) const
	Sets the indicated EggTexture to refer to this file.
void	output_filename (ostream &out) const
	Writes the filename (or pair of filenames) to the indicated output stream.
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.
virtual void	finalize ()
virtual TypeHandle	force_init_type (void)
int	get_type_index () const
bool	is_of_type (TypeHandle handle) const
bool	is_exact_type (TypeHandle handle) const
Static Public Member Functions
void	register_with_read_factory ()
	Registers the current object as something that can be read from a Bam file.
TypeHandle	get_class_type ()
void	init_type ()
Static Public Attributes
TypedWritable *const	Null
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
TypedWritable *	make_DestTextureImage (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.
Protected Attributes
TextureProperties	_properties
Filename	_filename
Filename	_alpha_filename
int	_alpha_file_channel
bool	_size_known
int	_x_size
int	_y_size
Private Member Functions
	DestTextureImage ()
	The default constructor is only for the convenience of the Bam reader.
Static Private Member Functions
int	to_power_2 (int value)
	Returns the largest power of 2 less than or equal to value.
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

This represents a texture filename as it has been resized and copied to the map directory (e.g.

for an unplaced texture).

Definition at line 43 of file destTextureImage.h.

Constructor & Destructor Documentation

DestTextureImage::DestTextureImage ( ) [private]

The default constructor is only for the convenience of the Bam reader.

Definition at line 47 of file destTextureImage.cxx.
References ImageFile::_properties, ImageFile::_size_known, ImageFile::_x_size, ImageFile::_y_size, ImageFile::get_properties(), TexturePlacement::get_texture(), ImageFile::get_x_size(), ImageFile::get_y_size(), and ImageFile::is_size_known().

DestTextureImage::DestTextureImage ( TexturePlacement * placement )

Definition at line 58 of file destTextureImage.cxx.
References ImageFile::_x_size, ImageFile::_y_size, pal, and to_power_2().

Member Function Documentation

void ImageFile::clear_basic_properties ( ) [inherited]

Resets the properties to a neutral state, for instance in preparation for calling update_properties() with all the known contributing properties.

Definition at line 187 of file imageFile.cxx.

int ImageFile::complete_pointers ( TypedWritable ** p_list,

BamReader * manager

) [virtual, inherited]

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.
Reimplemented in PaletteImage, SourceTextureImage, and TextureImage.
Definition at line 609 of file imageFile.cxx.
Referenced by PaletteImage::find_overlap().

void DestTextureImage::copy ( TextureImage * texture )

Unconditionally copies the source texture into the appropriate filename.

Definition at line 86 of file destTextureImage.cxx.

void DestTextureImage::copy_if_stale ( const DestTextureImage * other,

TextureImage * texture

)

Copies the source texture into the appropriate filename only if the indicated old reference, which represents the way it was last copied, is now out-of-date.

Definition at line 117 of file destTextureImage.cxx.
References x.

bool ImageFile::exists ( ) const [inherited]

Returns true if the file or files named by the image file exist, false otherwise.

Definition at line 361 of file imageFile.cxx.
References ImageFile::_alpha_filename, TextureProperties::_alpha_type, TextureProperties::_color_type, ImageFile::_filename, ImageFile::_properties, Filename::empty(), Filename::exists(), PNMImage::get_maxval(), PNMImage::get_x_size(), PNMImage::get_y_size(), PNMImage::has_alpha(), Filename::make_dir(), FilenameUnifier::make_user_filename(), nassertr, nout, NULL, Filename::unlink(), PNMImage::write(), x, and y.
Referenced by TextureImage::is_used().

void DestTextureImage::fillin ( DatagramIterator & scan,

BamReader * manager

) [protected]

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

Reimplemented from ImageFile.
Definition at line 224 of file destTextureImage.cxx.

int ImageFile::get_alpha_file_channel ( ) const [inherited]

Returns the particular channel number of the alpha image file from which the alpha channel should be extracted.
This is normally 0 to represent the grayscale combination of r, g, and b; or it may be a 1-based channel number (for instance, 4 for the alpha channel of a 4-component image).
Definition at line 345 of file imageFile.cxx.

const Filename & ImageFile::get_alpha_filename ( ) const [inherited]

Returns the alpha filename of the image file.
This is the name of the file that contains the alpha channel, if it is stored in a separate file, or the empty string if it is not.
Definition at line 322 of file imageFile.cxx.

TypeHandle DestTextureImage::get_class_type ( void ) [inline, static]

Reimplemented from ImageFile.
Definition at line 67 of file destTextureImage.h.

const Filename & ImageFile::get_filename ( ) const [inherited]

Returns the primary filename of the image file.

Definition at line 303 of file imageFile.cxx.
References ImageFile::_properties, and nout.
Referenced by TextureImage::clear_source_basic_properties(), TextureImage::get_preferred_source(), TextureImage::is_newer_than(), TextureImage::is_used(), and PaletteImage::unplace().

int ImageFile::get_num_channels ( ) const [inherited]

Returns the number of channels of the image.
It is an error to call this unless has_num_channels() returns true.
Definition at line 155 of file imageFile.cxx.
References ImageFile::_properties.
Referenced by TextureImage::mark_eggs_stale().

const TextureProperties & ImageFile::get_properties ( ) const [inherited]

Returns the grouping properties of the image.

Definition at line 168 of file imageFile.cxx.
References Palettizer::_map_dirname, PaletteGroup::get_dirname(), NULL, and pal.
Referenced by TextureMemoryCounter::add_texture(), TextureImage::copy_unplaced(), DestTextureImage(), and TexturePlacement::get_name().

virtual TypeHandle DestTextureImage::get_type ( void ) const [inline, virtual]

Reimplemented from ImageFile.
Definition at line 75 of file destTextureImage.h.
References INLINE, ostream, and ImageFile::output_filename().

int ImageFile::get_x_size ( ) const [inherited]

Returns the size of the image file in pixels in the X direction.
It is an error to call this unless is_size_known() returns true.
Definition at line 104 of file imageFile.cxx.
References ImageFile::_properties, and TextureProperties::has_num_channels().
Referenced by TextureImage::copy_unplaced(), DestTextureImage(), TextureImage::is_used(), and TextureImage::mark_eggs_stale().

int ImageFile::get_y_size ( ) const [inherited]

Returns the size of the image file in pixels in the Y direction.
It is an error to call this unless is_size_known() returns true.
Definition at line 122 of file imageFile.cxx.
Referenced by TextureImage::copy_unplaced(), DestTextureImage(), TextureImage::is_used(), and TextureImage::mark_eggs_stale().

bool ImageFile::has_num_channels ( ) const [inherited]

Returns true if the number of channels in the image is known, false otherwise.

Definition at line 138 of file imageFile.cxx.
References ImageFile::_properties, and TextureProperties::clear_basic().

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

Reimplemented from ImageFile.
Definition at line 70 of file destTextureImage.h.
References _type_handle.

bool ImageFile::is_size_known ( ) const [inherited]

Returns true if the size of the image file is known, false otherwise.

Definition at line 87 of file imageFile.cxx.
References ImageFile::_y_size, and nassertr.
Referenced by TextureImage::copy_unplaced(), DestTextureImage(), TexturePlacement::mark_eggs_stale(), and TextureImage::read_source_image().

TypedWritable * DestTextureImage::make_DestTextureImage ( 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 201 of file destTextureImage.cxx.

void ImageFile::make_shadow_image ( const string & basename ) [inherited]

Sets up the ImageFile as a "shadow image" of a particular PaletteImage.
This is a temporary ImageFile that's used to read and write the shadow palette image, which is used to keep a working copy of the palette.
Definition at line 69 of file imageFile.cxx.
References ImageFile::_size_known.

void ImageFile::output_filename ( ostream & out ) const [inherited]

Writes the filename (or pair of filenames) to the indicated output stream.

Definition at line 561 of file imageFile.cxx.
Referenced by TextureImage::copy_unplaced(), SourceTextureImage::get_type(), and get_type().

bool ImageFile::read ( PNMImage & image ) const [inherited]

Reads in the image (or images, if the alpha_filename is separate) and stores it in the indicated PNMImage.
Returns true on success, false on failure.
Definition at line 389 of file imageFile.cxx.

void DestTextureImage::register_with_read_factory ( void ) [static]

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

Definition at line 164 of file destTextureImage.cxx.

void ImageFile::set_filename ( const string & dirname,

const string & basename

) [inherited]

Sets the filename, and if applicable, the alpha_filename, from the indicated basename.
The extension appropriate to the image file type specified in _color_type (and _alpha_type) is automatically applied.
Definition at line 269 of file imageFile.cxx.
References ImageFile::_alpha_filename, TextureProperties::_alpha_type, ImageFile::_filename, ImageFile::_properties, Filename::empty(), Filename::exists(), NULL, and TextureProperties::uses_alpha().

void ImageFile::set_filename ( PaletteGroup * group,

const string & basename

) [inherited]

Sets the filename, and if applicable, the alpha_filename, from the indicated basename.
The extension appropriate to the image file type specified in _color_type (and _alpha_type) is automatically applied.
Definition at line 223 of file imageFile.cxx.

int DestTextureImage::to_power_2 ( int value ) [static, private]

Returns the largest power of 2 less than or equal to value.

Definition at line 145 of file destTextureImage.cxx.
References ImageFile::write_datagram(), and writer().
Referenced by DestTextureImage().

void ImageFile::unlink ( ) [inherited]

Deletes the image file or files.

Definition at line 513 of file imageFile.cxx.
References ImageFile::_alpha_file_channel, ImageFile::_alpha_filename, ImageFile::_filename, Palettizer::_read_pi_version, and DatagramIterator::get_uint8().

void ImageFile::update_egg_tex ( EggTexture * egg_tex ) const [inherited]

Sets the indicated EggTexture to refer to this file.

Definition at line 533 of file imageFile.cxx.
Referenced by TextureReference::get_placement().

void ImageFile::update_properties ( const TextureProperties & properties ) [inherited]

If the indicate TextureProperties structure is more specific than this one, updates this one.

Definition at line 202 of file imageFile.cxx.
References TextureProperties::_color_type, ImageFile::_filename, ImageFile::_properties, Filename, PNMFileType::get_suggested_extension(), NULL, and Filename::set_extension().

bool ImageFile::write ( const PNMImage & image ) const [inherited]

Writes out the image in the indicated PNMImage to the _filename and/or _alpha_filename.
Returns true on success, false on failure.
Definition at line 459 of file imageFile.cxx.
References ImageFile::_alpha_filename, and ImageFile::_properties.

void DestTextureImage::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 ImageFile.
Definition at line 182 of file destTextureImage.cxx.

Member Data Documentation

int ImageFile::_alpha_file_channel [protected, inherited]

Definition at line 84 of file imageFile.h.
Referenced by SourceTextureImage::SourceTextureImage(), and ImageFile::unlink().

Filename ImageFile::_alpha_filename [protected, inherited]

Definition at line 83 of file imageFile.h.
Referenced by ImageFile::exists(), ImageFile::set_filename(), SourceTextureImage::SourceTextureImage(), ImageFile::unlink(), and ImageFile::write().

Filename ImageFile::_filename [protected, inherited]

Definition at line 82 of file imageFile.h.
Referenced by ImageFile::exists(), ImageFile::set_filename(), SourceTextureImage::SourceTextureImage(), ImageFile::unlink(), and ImageFile::update_properties().

TextureProperties ImageFile::_properties [protected, inherited]

Definition at line 81 of file imageFile.h.
Referenced by DestTextureImage(), ImageFile::exists(), ImageFile::get_filename(), ImageFile::get_num_channels(), ImageFile::get_x_size(), ImageFile::has_num_channels(), TextureImage::mark_eggs_stale(), ImageFile::set_filename(), ImageFile::update_properties(), and ImageFile::write().

bool ImageFile::_size_known [protected, inherited]

Definition at line 86 of file imageFile.h.
Referenced by DestTextureImage(), SourceTextureImage::increment_egg_count(), ImageFile::make_shadow_image(), and TextureImage::mark_eggs_stale().

TypeHandle DestTextureImage::_type_handle [static, private]

Reimplemented from ImageFile.
Definition at line 33 of file destTextureImage.cxx.
Referenced by init_type().

int ImageFile::_x_size [protected, inherited]

Definition at line 87 of file imageFile.h.
Referenced by PaletteImage::check_solitary(), PaletteImage::ClearedRegion::ClearedRegion(), DestTextureImage(), TextureImage::mark_eggs_stale(), TextureImage::pre_txa_file(), PaletteImage::setup_shadow_image(), and PaletteImage::unplace().

int ImageFile::_y_size [protected, inherited]

Definition at line 87 of file imageFile.h.
Referenced by PaletteImage::check_solitary(), PaletteImage::ClearedRegion::ClearedRegion(), DestTextureImage(), ImageFile::is_size_known(), TextureImage::mark_eggs_stale(), TextureImage::pre_txa_file(), PaletteImage::setup_shadow_image(), and PaletteImage::unplace().

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

pandatool/src/egg-palettize/destTextureImage.h
pandatool/src/egg-palettize/destTextureImage.cxx

Generated on Fri May 2 03:26:05 2003 for Panda-Tool by

1.3

DestTextureImage Class Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation