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

SourceTextureImage Class Reference

This is a texture image reference as it appears in an egg file: the source image of the texture. More...

#include <sourceTextureImage.h>

Inheritance diagram for SourceTextureImage:


Public Member Functions
	SourceTextureImage (TextureImage *texture, const Filename &filename, const Filename &alpha_filename, int alpha_file_channel)
TextureImage *	get_texture () const
	Returns the particular texture that this image is one of the sources for.
void	increment_egg_count ()
	Increments by one the number of egg files that are known to reference this SourceTextureImage.
int	get_egg_count () const
	Returns the number of egg files that share this SourceTextureImage.
bool	get_size ()
	Determines the size of the SourceTextureImage, if it is not already known.
bool	read_header ()
	Reads the actual image header to determine the image properties, like its size.
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 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 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 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_SourceTextureImage (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
	SourceTextureImage ()
	The default constructor is only for the convenience of the Bam reader.
Private Attributes
TextureImage *	_texture
int	_egg_count
bool	_read_header
bool	_successfully_read_header
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

This is a texture image reference as it appears in an egg file: the source image of the texture.

Definition at line 40 of file sourceTextureImage.h.

Constructor & Destructor Documentation

SourceTextureImage::SourceTextureImage ( ) [private]

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

Definition at line 45 of file sourceTextureImage.cxx.
References ImageFile::_alpha_file_channel, ImageFile::_alpha_filename, _egg_count, ImageFile::_filename, and _read_header.

SourceTextureImage::SourceTextureImage ( TextureImage * texture,

const Filename & filename,

const Filename & alpha_filename,

int alpha_file_channel

)

Definition at line 61 of file sourceTextureImage.cxx.
References _successfully_read_header.

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 SourceTextureImage::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 ImageFile.
Definition at line 260 of file sourceTextureImage.cxx.

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 SourceTextureImage::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 305 of file sourceTextureImage.cxx.
Referenced by register_with_read_factory().

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 SourceTextureImage::get_class_type ( void ) [inline, static]

Reimplemented from ImageFile.
Definition at line 74 of file sourceTextureImage.h.
Referenced by read_header().

int SourceTextureImage::get_egg_count ( ) const

Returns the number of egg files that share this SourceTextureImage.

Definition at line 114 of file sourceTextureImage.cxx.

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::DestTextureImage(), and TexturePlacement::get_name().

bool SourceTextureImage::get_size ( void )

Determines the size of the SourceTextureImage, if it is not already known.
Returns true if the size was successfully determined (or if was already known), or false if the size could not be determined (for instance, because the image file is missing). After this call returns true, get_x_size() etc. may be safely called to return the size.
Definition at line 139 of file sourceTextureImage.cxx.
Referenced by TextureImage::is_used(), and TextureImage::mark_eggs_stale().

TextureImage * SourceTextureImage::get_texture ( void ) const

Returns the particular texture that this image is one of the sources for.

Definition at line 84 of file sourceTextureImage.cxx.
Referenced by TextureReference::get_egg_file().

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

Reimplemented from ImageFile.
Definition at line 82 of file sourceTextureImage.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::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::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 SourceTextureImage::increment_egg_count ( )

Increments by one the number of egg files that are known to reference this SourceTextureImage.

Definition at line 99 of file sourceTextureImage.cxx.
References ImageFile::_size_known, and read_header().

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

Reimplemented from ImageFile.
Definition at line 77 of file sourceTextureImage.h.

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::DestTextureImage(), TexturePlacement::mark_eggs_stale(), and TextureImage::read_source_image().

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.

TypedWritable * SourceTextureImage::make_SourceTextureImage ( 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 282 of file sourceTextureImage.cxx.
Referenced by read_header().

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(), get_type(), and DestTextureImage::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.

bool SourceTextureImage::read_header ( )

Reads the actual image header to determine the image properties, like its size.
Returns true if the image header is successfully read (or if has previously been successfully read this session), false otherwise. After this call returns true, get_x_size() etc. may be safely called to return the newly determined size.
Definition at line 167 of file sourceTextureImage.cxx.
References get_class_type(), BamReader::get_factory(), and make_SourceTextureImage().
Referenced by increment_egg_count().

void SourceTextureImage::register_with_read_factory ( void ) [static]

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

Definition at line 212 of file sourceTextureImage.cxx.
References fillin(), params, and parse_params().

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.

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 SourceTextureImage::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 230 of file sourceTextureImage.cxx.
References ImageFile::fillin(), and BamReader::read_pointer().

Member Data Documentation

int ImageFile::_alpha_file_channel [protected, inherited]

Definition at line 84 of file imageFile.h.
Referenced by 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(), ImageFile::unlink(), and ImageFile::write().

int SourceTextureImage::_egg_count [private]

Definition at line 58 of file sourceTextureImage.h.
Referenced by SourceTextureImage().

Filename ImageFile::_filename [protected, inherited]

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

TextureProperties ImageFile::_properties [protected, inherited]

Definition at line 81 of file imageFile.h.
Referenced by DestTextureImage::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 SourceTextureImage::_read_header [private]

Definition at line 59 of file sourceTextureImage.h.
Referenced by SourceTextureImage().

bool ImageFile::_size_known [protected, inherited]

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

bool SourceTextureImage::_successfully_read_header [private]

Definition at line 60 of file sourceTextureImage.h.
Referenced by SourceTextureImage().

TextureImage* SourceTextureImage::_texture [private]

Definition at line 57 of file sourceTextureImage.h.

TypeHandle SourceTextureImage::_type_handle [static, private]

Reimplemented from ImageFile.
Definition at line 32 of file sourceTextureImage.cxx.

int ImageFile::_x_size [protected, inherited]

Definition at line 87 of file imageFile.h.
Referenced by PaletteImage::check_solitary(), PaletteImage::ClearedRegion::ClearedRegion(), DestTextureImage::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::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/sourceTextureImage.h
pandatool/src/egg-palettize/sourceTextureImage.cxx

Generated on Fri May 2 03:27:59 2003 for Panda-Tool by

1.3

SourceTextureImage Class Reference

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation