Panda3D
Classes | Public Member Functions | Static Public Member Functions | List of all members
PaletteImage Class Reference

This is a single palette image, one of several within a PalettePage, which is in turn one of several pages within a PaletteGroup. More...

#include "paletteImage.h"

Inheritance diagram for PaletteImage:
ImageFile TypedWritable TypedObject MemoryBase

Public Member Functions

 PaletteImage (PalettePage *page, int index)
 
 PaletteImage (PalettePage *page, int index, unsigned swapIndex)
 
void check_solitary ()
 To be called after all textures have been placed on the image, this checks to see if there is only one texture on the image. 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...
 
double count_coverage () const
 Returns the a weighted average of the fraction of coverage represented by all of the textures placed on the palette. More...
 
double count_utilization () const
 Returns the fraction of the PaletteImage that is actually used by any textures. More...
 
PalettePageget_page () const
 Returns the particular PalettePage this image is associated with. More...
 
virtual TypeHandle get_type () const
 
bool is_empty () const
 Returns true if there are no textures, or only one "solitary" texture, placed on the image. More...
 
void optimal_resize ()
 Attempts to resize the palette image to as small as it can go. More...
 
bool place (TexturePlacement *placement)
 Attempts to place the indicated texture on the image. More...
 
void reset_image ()
 Unpacks each texture that has been placed on this image, resetting the image to empty. More...
 
bool resize_image (int x_size, int y_size)
 Attempts to resize the palette image, and repack all of the textures within the new size. More...
 
void resize_swapped_image (int x_size, int y_size)
 Attempts to resize the palette image, and repack all of the textures within the new size. More...
 
void setup_shadow_image ()
 Ensures the _shadow_image has the correct filename and image types, based on what was supplied on the command line and in the .txa file. More...
 
void unplace (TexturePlacement *placement)
 Removes the texture from the image. More...
 
bool update_filename ()
 Changes the image filename to match the current naming scheme, assuming something has changed since the image was created. More...
 
void update_image (bool redo_all)
 If the palette has changed since it was last written out, updates the image and writes out a new one. 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_placements (std::ostream &out, int indent_level=0) const
 Writes a list of the textures that have been placed on this image to the indicated output stream, one per line. More...
 
- Public Member Functions inherited from ImageFile
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...
 
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 Filenameget_alpha_filename () const
 Returns the alpha filename of the image file. More...
 
const Filenameget_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 TexturePropertiesget_properties () const
 Returns the grouping properties of the image. More...
 
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 std::string &basename)
 Sets up the ImageFile as a "shadow image" of a particular PaletteImage. More...
 
void output_filename (std::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 std::string &basename)
 Sets the filename, and if applicable, the alpha_filename, from the indicated basename. More...
 
bool set_filename (const std::string &dirname, const std::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...
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
vector_uchar encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) 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 &copy)
 
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...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_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...
 
TypedObjectoperator= (const TypedObject &copy)=default
 

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 Public Member Functions inherited from ImageFile
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
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

- Public Attributes inherited from TypedObject
 get_type
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

This is a single palette image, one of several within a PalettePage, which is in turn one of several pages within a PaletteGroup.

Each palette image is a collage of several different textures that were all assigned to the same PaletteGroup, and all share the same properties of the PalettePage.

Definition at line 32 of file paletteImage.h.

Member Function Documentation

◆ check_solitary()

void PaletteImage::check_solitary ( )

To be called after all textures have been placed on the image, this checks to see if there is only one texture on the image.

If there is, it is flagged as 'solitary' so that the egg files will not needlessly reference the palettized image.

However, if pal->_omit_solitary is false, we generally don't change textures to solitary state.

Definition at line 323 of file paletteImage.cxx.

Referenced by PalettePage::place_all().

◆ complete_pointers()

int PaletteImage::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 1016 of file paletteImage.cxx.

References ImageFile::complete_pointers().

◆ count_coverage()

double PaletteImage::count_coverage ( ) const

Returns the a weighted average of the fraction of coverage represented by all of the textures placed on the palette.

This number represents the fraction of wasted pixels in the palette image consumed by copying the same pixels multiple times into the palette, or if the number is negative, it represents the fraction of pixels saved by not having to copy the entire texture into the palette.

Definition at line 243 of file paletteImage.cxx.

◆ count_utilization()

double PaletteImage::count_utilization ( ) const

Returns the fraction of the PaletteImage that is actually used by any textures.

This is 1.0 if every pixel in the PaletteImage is used, or 0.0 if none are. Normally it will be somewhere in between.

Definition at line 216 of file paletteImage.cxx.

◆ get_page()

PalettePage * PaletteImage::get_page ( ) const

Returns the particular PalettePage this image is associated with.

Definition at line 184 of file paletteImage.cxx.

◆ is_empty()

bool PaletteImage::is_empty ( ) const

Returns true if there are no textures, or only one "solitary" texture, placed on the image.

In either case, the PaletteImage need not be generated.

Definition at line 194 of file paletteImage.cxx.

Referenced by optimal_resize(), update_image(), and PalettePage::write_image_info().

◆ optimal_resize()

void PaletteImage::optimal_resize ( )

Attempts to resize the palette image to as small as it can go.

Definition at line 361 of file paletteImage.cxx.

References is_empty().

Referenced by PalettePage::optimal_resize().

◆ place()

bool PaletteImage::place ( TexturePlacement placement)

Attempts to place the indicated texture on the image.

Returns true if successful, or false if there was no available space.

Definition at line 272 of file paletteImage.cxx.

◆ register_with_read_factory()

void PaletteImage::register_with_read_factory ( )
static

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

Definition at line 972 of file paletteImage.cxx.

References BamReader::get_factory().

Referenced by init_palettizer().

◆ reset_image()

void PaletteImage::reset_image ( )

Unpacks each texture that has been placed on this image, resetting the image to empty.

Definition at line 492 of file paletteImage.cxx.

Referenced by PalettePage::reset_images().

◆ resize_image()

bool PaletteImage::resize_image ( int  x_size,
int  y_size 
)

Attempts to resize the palette image, and repack all of the textures within the new size.

Returns true if successful, false otherwise. If this fails, it will still result in repacking all the textures in the original size.

Definition at line 404 of file paletteImage.cxx.

◆ resize_swapped_image()

void PaletteImage::resize_swapped_image ( int  x_size,
int  y_size 
)

Attempts to resize the palette image, and repack all of the textures within the new size.

Returns true if successful, false otherwise. If this fails, it will still result in repacking all the textures in the original size.

Definition at line 468 of file paletteImage.cxx.

◆ setup_shadow_image()

void PaletteImage::setup_shadow_image ( )

Ensures the _shadow_image has the correct filename and image types, based on what was supplied on the command line and in the .txa file.

Definition at line 511 of file paletteImage.cxx.

References ImageFile::make_shadow_image(), and setup_shadow_image().

Referenced by setup_shadow_image(), and PalettePage::setup_shadow_images().

◆ unplace()

void PaletteImage::unplace ( TexturePlacement placement)

Removes the texture from the image.

Definition at line 301 of file paletteImage.cxx.

Referenced by TexturePlacement::force_replace().

◆ update_filename()

bool PaletteImage::update_filename ( )

Changes the image filename to match the current naming scheme, assuming something has changed since the image was created.

Returns true if the image filename changes (which means update_image() should be called).

Definition at line 663 of file paletteImage.cxx.

References ImageFile::get_filename().

◆ update_image()

void PaletteImage::update_image ( bool  redo_all)

If the palette has changed since it was last written out, updates the image and writes out a new one.

If redo_all is true, regenerates the image from scratch and writes it out again, whether it needed it or not.

Definition at line 528 of file paletteImage.cxx.

References is_empty().

Referenced by PalettePage::update_images().

◆ write_datagram()

void PaletteImage::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 982 of file paletteImage.cxx.

References Datagram::add_uint32(), and ImageFile::write_datagram().

◆ write_placements()

void PaletteImage::write_placements ( std::ostream &  out,
int  indent_level = 0 
) const

Writes a list of the textures that have been placed on this image to the indicated output stream, one per line.

Definition at line 479 of file paletteImage.cxx.

Referenced by PalettePage::write_image_info().


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