Panda3D
|
This is the base class of both TextureImage and PaletteImage. More...
#include "imageFile.h"
Public Member Functions | |
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. 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... | |
bool | exists () const |
Returns true if the file or files named by the image file exist, false otherwise. More... | |
int | get_alpha_file_channel () const |
Returns the particular channel number of the alpha image file from which the alpha channel should be extracted. More... | |
const Filename & | get_alpha_filename () const |
Returns the alpha filename of the image file. More... | |
const Filename & | get_filename () const |
Returns the primary filename of the image file. More... | |
int | get_num_channels () const |
Returns the number of channels of the image. More... | |
const TextureProperties & | get_properties () const |
Returns the grouping properties of the image. More... | |
virtual TypeHandle | get_type () const |
int | get_x_size () const |
Returns the size of the image file in pixels in the X direction. More... | |
int | get_y_size () const |
Returns the size of the image file in pixels in the Y direction. More... | |
bool | has_num_channels () const |
Returns true if the number of channels in the image is known, false otherwise. More... | |
bool | is_size_known () const |
Returns true if the size of the image file is known, false otherwise. More... | |
bool | make_shadow_image (const string &basename) |
Sets up the ImageFile as a "shadow image" of a particular PaletteImage. More... | |
void | output_filename (ostream &out) const |
Writes the filename (or pair of filenames) to the indicated output stream. More... | |
bool | read (PNMImage &image) const |
Reads in the image (or images, if the alpha_filename is separate) and stores it in the indicated PNMImage. More... | |
bool | set_filename (PaletteGroup *group, const string &basename) |
Sets the filename, and if applicable, the alpha_filename, from the indicated basename. More... | |
bool | set_filename (const string &dirname, const string &basename) |
Sets the filename, and if applicable, the alpha_filename, from the indicated basename. More... | |
void | unlink () |
Deletes the image file or files. More... | |
void | update_egg_tex (EggTexture *egg_tex) const |
Sets the indicated EggTexture to refer to this file. More... | |
void | update_properties (const TextureProperties &properties) |
If the indicate TextureProperties structure is more specific than this one, updates this one. More... | |
bool | write (const PNMImage &image) const |
Writes out the image in the indicated PNMImage to the _filename and/or _alpha_filename. 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... | |
![]() | |
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 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... | |
Additional Inherited Members | |
![]() | |
static TypedWritable *const | Null = (TypedWritable*)0L |
This is the base class of both TextureImage and PaletteImage.
It encapsulates all the information specific to an image file that can be assigned as a texture image to egg geometry.
Definition at line 36 of file imageFile.h.
void ImageFile::clear_basic_properties | ( | ) |
Resets the properties to a neutral state, for instance in preparation for calling update_properties() with all the known contributing properties.
Definition at line 153 of file imageFile.cxx.
References TextureProperties::clear_basic(), and update_properties().
Referenced by TextureImage::clear_source_basic_properties(), and get_properties().
|
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.
Reimplemented in TextureImage, PaletteImage, and SourceTextureImage.
Definition at line 519 of file imageFile.cxx.
References TypedWritable::complete_pointers(), TextureProperties::complete_pointers(), TypedWritable::fillin(), TextureProperties::fillin(), FilenameUnifier::get_bam_filename(), DatagramIterator::get_bool(), DatagramIterator::get_int32(), DatagramIterator::get_string(), and DatagramIterator::get_uint8().
Referenced by SourceTextureImage::complete_pointers(), PaletteImage::complete_pointers(), TextureImage::complete_pointers(), and write_datagram().
bool ImageFile::exists | ( | ) | const |
Returns true if the file or files named by the image file exist, false otherwise.
Definition at line 303 of file imageFile.cxx.
References Filename::exists(), read(), and TextureProperties::uses_alpha().
Referenced by get_alpha_file_channel(), and TextureImage::get_preferred_source().
int ImageFile::get_alpha_file_channel | ( | ) | const |
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 291 of file imageFile.cxx.
References exists().
Referenced by TextureImage::complete_pointers(), get_alpha_filename(), and PaletteGroup::prepare().
const Filename & ImageFile::get_alpha_filename | ( | ) | const |
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 276 of file imageFile.cxx.
References get_alpha_file_channel().
Referenced by TextureImage::complete_pointers(), get_filename(), and PaletteGroup::prepare().
const Filename & ImageFile::get_filename | ( | ) | const |
Returns the primary filename of the image file.
Definition at line 263 of file imageFile.cxx.
References get_alpha_filename().
Referenced by TextureImage::complete_pointers(), DestTextureImage::copy_if_stale(), TextureImage::copy_unplaced(), TextureImage::get_preferred_source(), TextureImage::is_newer_than(), PaletteGroup::prepare(), set_filename(), PaletteImage::update_image(), and TextureImage::write_scale_info().
int ImageFile::get_num_channels | ( | ) | const |
Returns the number of channels of the image.
It is an error to call this unless has_num_channels() returns true.
Definition at line 130 of file imageFile.cxx.
References TextureProperties::get_num_channels(), and get_properties().
Referenced by DestTextureImage::copy(), DestTextureImage::copy_if_stale(), TextureReference::from_egg(), has_num_channels(), TextureImage::post_txa_file(), TextureMemoryCounter::report(), TextureReference::update_egg(), and TextureImage::write_scale_info().
const TextureProperties & ImageFile::get_properties | ( | ) | const |
Returns the grouping properties of the image.
Definition at line 140 of file imageFile.cxx.
References clear_basic_properties().
Referenced by get_num_channels(), TextureImage::pre_txa_file(), TextureMemoryCounter::report(), and TextureImage::write_source_pathnames().
int ImageFile::get_x_size | ( | ) | const |
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 93 of file imageFile.cxx.
References get_y_size(), and is_size_known().
Referenced by DestTextureImage::copy_if_stale(), PaletteImage::count_coverage(), TextureImage::get_preferred_source(), is_size_known(), TxaLine::match_texture(), TextureImage::post_txa_file(), TextureMemoryCounter::report(), TextureImage::write_scale_info(), and TextureImage::write_source_pathnames().
int ImageFile::get_y_size | ( | ) | const |
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 106 of file imageFile.cxx.
References has_num_channels(), and is_size_known().
Referenced by DestTextureImage::copy_if_stale(), PaletteImage::count_coverage(), TextureImage::get_preferred_source(), get_x_size(), TxaLine::match_texture(), TextureImage::post_txa_file(), TextureMemoryCounter::report(), TextureImage::write_scale_info(), and TextureImage::write_source_pathnames().
bool ImageFile::has_num_channels | ( | ) | const |
Returns true if the number of channels in the image is known, false otherwise.
Definition at line 118 of file imageFile.cxx.
References get_num_channels(), and TextureProperties::has_num_channels().
Referenced by get_y_size(), and TextureReference::update_egg().
bool ImageFile::is_size_known | ( | ) | const |
Returns true if the size of the image file is known, false otherwise.
Definition at line 81 of file imageFile.cxx.
References get_x_size().
Referenced by get_x_size(), get_y_size(), make_shadow_image(), TextureImage::write_scale_info(), and TextureImage::write_source_pathnames().
bool ImageFile::make_shadow_image | ( | const string & | basename | ) |
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.
Returns true if the filename changes from what it was previously, false otherwise.
Definition at line 56 of file imageFile.cxx.
References is_size_known(), and set_filename().
void ImageFile::output_filename | ( | ostream & | out | ) | const |
Writes the filename (or pair of filenames) to the indicated output stream.
Definition at line 483 of file imageFile.cxx.
References FilenameUnifier::make_user_filename(), TextureProperties::uses_alpha(), and write_datagram().
Referenced by update_egg_tex(), PalettePage::write_image_info(), and TextureImage::write_source_pathnames().
bool ImageFile::read | ( | PNMImage & | image | ) | const |
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 326 of file imageFile.cxx.
References PNMImage::add_alpha(), Filename::exists(), PNMImage::get_alpha(), PNMImage::get_channel_val(), PNMImage::get_gray(), PNMImageHeader::get_num_channels(), PNMImageHeader::get_x_size(), PNMImageHeader::get_y_size(), FilenameUnifier::make_user_filename(), PNMImage::read(), PNMImage::set_alpha(), PNMImageHeader::set_type(), and write().
Referenced by exists(), and TextureImage::read_source_image().
bool ImageFile::set_filename | ( | PaletteGroup * | group, |
const string & | basename | ||
) |
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.
Returns true if the filename changes from what it was previously, false otherwise.
Definition at line 181 of file imageFile.cxx.
References PaletteGroup::get_dirname().
Referenced by make_shadow_image(), and update_properties().
bool ImageFile::set_filename | ( | const string & | dirname, |
const string & | basename | ||
) |
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.
Returns true if the filename changes from what it was previously, false otherwise.
Definition at line 223 of file imageFile.cxx.
References get_filename(), Filename::get_fullpath_wo_extension(), PNMFileType::get_suggested_extension(), Filename::set_extension(), and Filename::standardize().
void ImageFile::unlink | ( | ) |
Deletes the image file or files.
Definition at line 442 of file imageFile.cxx.
References Filename::exists(), FilenameUnifier::make_user_filename(), Filename::unlink(), and update_egg_tex().
Referenced by write().
void ImageFile::update_egg_tex | ( | EggTexture * | egg_tex | ) | const |
Sets the indicated EggTexture to refer to this file.
Definition at line 459 of file imageFile.cxx.
References EggTexture::clear_alpha_file_channel(), FilenameUnifier::make_egg_filename(), output_filename(), EggTexture::set_alpha_file_channel(), EggTexture::set_alpha_filename(), TextureProperties::update_egg_tex(), and TextureProperties::uses_alpha().
Referenced by unlink(), and TextureReference::update_egg().
void ImageFile::update_properties | ( | const TextureProperties & | properties | ) |
If the indicate TextureProperties structure is more specific than this one, updates this one.
Definition at line 164 of file imageFile.cxx.
References set_filename(), and TextureProperties::update_properties().
Referenced by TextureReference::apply_properties_to_source(), clear_basic_properties(), and TextureReference::from_egg().
bool ImageFile::write | ( | const PNMImage & | image | ) | const |
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 391 of file imageFile.cxx.
References Filename::exists(), PNMImage::get_alpha_val(), PNMImageHeader::get_maxval(), PNMImageHeader::get_x_size(), PNMImageHeader::get_y_size(), PNMImageHeader::has_alpha(), Filename::make_dir(), FilenameUnifier::make_user_filename(), PNMImage::remove_alpha(), PNMImage::set_gray_val(), unlink(), Filename::unlink(), and PNMImage::write().
Referenced by DestTextureImage::copy(), read(), and PaletteImage::update_image().
Fills the indicated datagram up with a binary representation of the current object, in preparation for writing to a Bam file.
Reimplemented from TypedWritable.
Reimplemented in TextureImage, PaletteImage, SourceTextureImage, and DestTextureImage.
Definition at line 498 of file imageFile.cxx.
References Datagram::add_bool(), Datagram::add_int32(), Datagram::add_string(), Datagram::add_uint8(), complete_pointers(), FilenameUnifier::make_bam_filename(), TypedWritable::write_datagram(), and TextureProperties::write_datagram().
Referenced by output_filename(), DestTextureImage::write_datagram(), SourceTextureImage::write_datagram(), PaletteImage::write_datagram(), and TextureImage::write_datagram().