#include <fltHeader.h>
Inheritance diagram for FltHeader:
Public Types | |
enum | AttrUpdate { AU_none, AU_if_missing, AU_always } |
enum | Units { U_meters = 0, U_kilometers = 1, U_feet = 4, U_inches = 5, U_nautical_miles = 8 } |
enum | Flags { F_save_vertex_normals = 0x80000000 } |
enum | ProjectionType { PT_flat_earth = 0, PT_trapezoidal = 1, PT_round_earth = 2, PT_lambert = 3, PT_utm = 4 } |
enum | VertexStorageType { VTS_double = 1 } |
enum | DatabaseOrigin { DO_open_flight = 100, DO_dig = 200, DO_es_ct6 = 300, DO_psp = 400, DO_ge_civ = 600, DO_es_gdf = 700 } |
enum | EarthModel { EM_wgs84 = 0, EM_wgs72 = 1, EM_bessel = 2, EM_clarke_1866 = 3, EM_nad27 = 4 } |
Public Member Functions | |
FltHeader (PathReplace *path_replace) | |
The FltHeader constructor accepts a PathReplace pointer; it uses this object to automatically convert all external filename and texture references. | |
virtual void | apply_converted_filenames () |
Walks the hierarchy at this record and below and copies the _converted_filename record into the _orig_filename record, so the flt file will be written out with the converted filename instead of what was originally read in. | |
void | set_path_replace (PathReplace *path_replace) |
Replaces the PathReplace object (which specifies how to mangle paths from the source to the destination file) with a new one. | |
PathReplace * | get_path_replace () |
Returns a pointer to the PathReplace object associated with this converter. | |
const PathReplace * | get_path_replace () const |
Returns a pointer to the PathReplace object associated with this converter. | |
Filename | convert_path (const Filename &orig_filename, const DSearchPath &additional_path=DSearchPath()) |
Uses the PathReplace object to convert the named filename as read from the flt record to its actual name. | |
void | set_flt_filename (const Filename &flt_filename) |
Sets the filename--especially the directory part--in which the flt file is considered to reside. | |
const Filename & | get_flt_filename () const |
Returns the directory in which the flt file is considered to reside. | |
FltError | read_flt (Filename filename) |
Opens the indicated filename for reading and attempts to read the complete Flt file. | |
FltError | read_flt (istream &in) |
Attempts to read a complete Flt file from the already-opened stream. | |
FltError | write_flt (Filename filename) |
Opens the indicated filename for writing and attempts to write the complete Flt file. | |
FltError | write_flt (ostream &out) |
Attempts to write a complete Flt file to the already-opened stream. | |
void | set_auto_attr_update (AttrUpdate attr) |
Controls whether texture .attr files are written automatically when write_flt() is called. | |
AttrUpdate | get_auto_attr_update () const |
Returns the current setting of the auto_attr_update flag. | |
int | get_flt_version () const |
Returns the version number of the flt file as reported in the header, times 100. | |
void | set_flt_version (int version) |
Changes the version number of the flt file that will be reported in the header. | |
bool | check_version () const |
Verifies that the version number read from the header is an understood version number, and prints a warning to the user if this is not so--the read may or may not succeed. | |
DistanceUnit | get_units () const |
Returns the units indicated by the flt header, or DU_invalid if the units in the header are not understood. | |
bool | has_instance (int instance_index) const |
Returns true if a instance subtree with the given index has been defined. | |
FltInstanceDefinition * | get_instance (int instance_index) const |
Returns the instance subtree associated with the given index, or NULL if there is no such instance. | |
void | clear_instances () |
Removes all instance subtrees from the instance pool. | |
void | add_instance (FltInstanceDefinition *instance) |
Defines a new instance subtree. | |
void | remove_instance (int instance_index) |
Removes a particular instance subtree from the pool, if it exists. | |
int | get_num_vertices () const |
Returns the number of vertices in the vertex palette. | |
FltVertex * | get_vertex (int n) const |
Returns the nth vertex of the vertex palette. | |
void | clear_vertices () |
Removes all vertices from the vertex palette. | |
void | add_vertex (FltVertex *vertex) |
Adds a new vertex to the end of the vertex palette. | |
FltVertex * | get_vertex_by_offset (int offset) |
Returns the particular vertex pointer associated with the given byte offset into the vertex palette. | |
int | get_offset_by_vertex (FltVertex *vertex) |
Returns the byte offset into the vertex palette associated with the given vertex pointer. | |
int | get_num_colors () const |
Returns the total number of different colors in the color palette. | |
Colorf | get_color (int color_index) const |
Returns the four-component color corresponding to the given color index. | |
RGBColorf | get_rgb (int color_index) const |
Returns the three-component color corresponding to the given color index, ignoring the alpha component. | |
bool | has_color_name (int color_index) const |
Returns true if the given color is named, false otherwise. | |
string | get_color_name (int color_index) const |
Returns the name associated with the given color, if any. | |
int | get_closest_color (Colorf color) const |
Returns the color index of the nearest color in the palette that matches the given four-component color, including alpha. | |
int | get_closest_rgb (RGBColorf color) const |
Returns the color index of the nearest color in the palette that matches the given three-component color, ignoring alpha. | |
int | get_num_color_entries () const |
Returns the number of actual entries in the color palette. | |
int | get_num_color_shades () const |
Returns the number of shades of brightness of each entry in the color palette. | |
Colorf | get_color (int color_index, bool use_packed_color, const FltPackedColor &packed_color, int transparency) |
Decodes a MultiGen color, as stored on a face or vertex, into an actual four-component Colorf. | |
RGBColorf | get_rgb (int color_index, bool use_packed_color, const FltPackedColor &packed_color) |
Decodes a MultiGen color, as stored on a face or vertex, into an actual three-component RGBColorf. | |
bool | has_material (int material_index) const |
Returns true if a material with the given index has been defined. | |
FltMaterial * | get_material (int material_index) const |
Returns the material associated with the given index, or NULL if there is no such material. | |
void | clear_materials () |
Removes all materials from the palette. | |
void | add_material (FltMaterial *material) |
Defines a new material. | |
void | remove_material (int material_index) |
Removes a particular material from the material palette, if it exists. | |
bool | has_texture (int texture_index) const |
Returns true if a texture with the given index has been defined. | |
FltTexture * | get_texture (int texture_index) const |
Returns the texture associated with the given index, or NULL if there is no such texture. | |
void | clear_textures () |
Removes all textures from the palette. | |
void | add_texture (FltTexture *texture) |
Defines a new texture. | |
void | remove_texture (int texture_index) |
Removes a particular texture from the texture palette, if it exists. | |
bool | has_light_source (int light_index) const |
Returns true if a light source with the given index has been defined. | |
FltLightSourceDefinition * | get_light_source (int light_index) const |
Returns the light source associated with the given index, or NULL if there is no such light source. | |
void | clear_light_sources () |
Removes all light sources from the palette. | |
void | add_light_source (FltLightSourceDefinition *light_source) |
Defines a new light source. | |
void | remove_light_source (int light_index) |
Removes a particular light source from the light source palette, if it exists. | |
bool | got_eyepoint_trackplane_palette () const |
Returns true if we have read an eyepoint/trackplane palette, and at least some of the eyepoints and trackplanes are therefore expected to be meaningful. | |
void | set_eyepoint_trackplane_palette (bool flag) |
Sets the state of the eyepoint/trackplane palette flag. | |
int | get_num_eyepoints () const |
Returns the number of eyepoints in the eyepoint/trackplane palette. | |
FltEyepoint * | get_eyepoint (int n) |
Returns the nth eyepoint in the eyepoint/trackplane palette. | |
int | get_num_trackplanes () const |
Returns the number of trackplanes in the eyepoint/trackplane palette. | |
FltTrackplane * | get_trackplane (int n) |
Returns the nth trackplane in the eyepoint/trackplane palette. | |
const string & | get_id () const |
Returns the id (name) of this particular bead. | |
void | set_id (const string &id) |
Changes the id (name) of this particular bead. | |
virtual void | output (ostream &out) const |
Writes a quick one-line description of the record, but not its children. | |
virtual TypeHandle | get_type () const |
virtual TypeHandle | force_init_type () |
bool | has_transform () const |
Returns true if the bead has been transformed, false otherwise. | |
const LMatrix4d & | get_transform () const |
Returns the single-precision 4x4 matrix that represents the transform applied to this bead, or the identity matrix if the bead has not been transformed. | |
void | set_transform (const LMatrix4d &mat) |
Replaces the transform matrix on this bead. | |
void | clear_transform () |
Removes any transform matrix and all transform steps on this bead. | |
int | get_num_transform_steps () const |
Returns the number of individual steps that define the net transform on this bead as returned by set_transform(). | |
FltTransformRecord * | get_transform_step (int n) |
Returns the nth individual step that defines the net transform on this bead. | |
const FltTransformRecord * | get_transform_step (int n) const |
Returns the nth individual step that defines the net transform on this bead. | |
void | add_transform_step (FltTransformRecord *record) |
Applies the indicated transform step to the net transformation applied to the bead. | |
int | get_replicate_count () const |
Returns the replicate count of this bead. | |
void | set_replicate_count (int count) |
Changes the replicate count of this bead. | |
int | get_num_children () const |
Returns the number of child records of this record. | |
FltRecord * | get_child (int n) const |
Returns the nth child of this record. | |
void | clear_children () |
Removes all children from this record. | |
void | add_child (FltRecord *child) |
Adds a new child to the end of the list of children for this record. | |
int | get_num_subfaces () const |
Returns the number of subface records of this record. | |
FltRecord * | get_subface (int n) const |
Returns the nth subface of this record. | |
void | clear_subfaces () |
Removes all subfaces from this record. | |
void | add_subface (FltRecord *subface) |
Adds a new subface to the end of the list of subfaces for this record. | |
int | get_num_extensions () const |
Returns the number of extension attribute records for this object. | |
FltRecord * | get_extension (int n) const |
Returns the nth extension of this record. | |
void | clear_extensions () |
Removes all extensions from this record. | |
void | add_extension (FltRecord *extension) |
Adds a new extension to the end of the list of extensions for this record. | |
int | get_num_ancillary () const |
Returns the number of unsupported ancillary records of this record. | |
FltRecord * | get_ancillary (int n) const |
Returns the nth unsupported ancillary record of this record. | |
void | clear_ancillary () |
Removes all unsupported ancillary records from this record. | |
void | add_ancillary (FltRecord *ancillary) |
Adds a new unsupported ancillary record to the end of the list of ancillary records for this record. | |
bool | has_comment () const |
Returns true if this record has a nonempty comment, false otherwise. | |
const string & | get_comment () const |
Retrieves the comment for this record, or empty string if the record has no comment. | |
void | clear_comment () |
Removes the comment for this record. | |
void | set_comment (const string &comment) |
Changes the comment for this record. | |
void | check_remaining_size (const DatagramIterator &di, const string &name=string()) const |
Checks that the iterator has no bytes left, as it should at the end of a successfully read record. | |
virtual void | write (ostream &out, int indent_level=0) const |
Writes a multiple-line description of the record and all of its children. | |
int | get_type_index () const |
bool | is_of_type (TypeHandle handle) const |
bool | is_exact_type (TypeHandle handle) const |
int | get_ref_count () const |
int | ref () const |
int | unref () const |
void | test_ref_count_integrity () const |
Static Public Member Functions | |
int | min_flt_version () |
Returns the earliest flt version number that this codebase supports (times 100). | |
int | max_flt_version () |
Returns the latest flt version number that this codebase is known to support (times 100). | |
TypeHandle | get_class_type () |
void | init_type () |
Public Attributes | |
int | _format_revision_level |
int | _edit_revision_level |
string | _last_revision |
int | _next_group_id |
int | _next_lod_id |
int | _next_object_id |
int | _next_face_id |
int | _unit_multiplier |
Units | _vertex_units |
bool | _texwhite_new |
unsigned int | _flags |
ProjectionType | _projection_type |
int | _next_dof_id |
VertexStorageType | _vertex_storage_type |
DatabaseOrigin | _database_origin |
double | _sw_x |
double | _sw_y |
double | _delta_x |
double | _delta_y |
int | _next_sound_id |
int | _next_path_id |
int | _next_clip_id |
int | _next_text_id |
int | _next_bsp_id |
int | _next_switch_id |
double | _sw_lat |
double | _sw_long |
double | _ne_lat |
double | _ne_long |
double | _origin_lat |
double | _origin_long |
double | _lambert_upper_lat |
double | _lambert_lower_lat |
int | _next_light_id |
int | _next_road_id |
int | _next_cat_id |
EarthModel | _earth_model |
int | _next_adaptive_id |
int | _next_curve_id |
double | _delta_z |
double | _radius |
int | _next_mesh_id |
Protected Member Functions | |
virtual bool | extract_record (FltRecordReader &reader) |
Fills in the information in this bead based on the information given in the indicated datagram, whose opcode has already been read. | |
virtual bool | extract_ancillary (FltRecordReader &reader) |
Checks whether the given bead, which follows this bead sequentially in the file, is an ancillary record of this bead. | |
virtual bool | build_record (FltRecordWriter &writer) const |
Fills up the current record on the FltRecordWriter with data for this record, but does not advance the writer. | |
virtual FltError | write_ancillary (FltRecordWriter &writer) const |
Writes whatever ancillary records are required for this record. | |
void | write_children (ostream &out, int indent_level) const |
Assuming the current write position has been left at the end of the last line of the record description, writes out the list of children. | |
FltRecord * | create_new_record (FltOpcode opcode) const |
Creates a new FltRecord corresponding to the opcode. | |
FltError | read_record_and_children (FltRecordReader &reader) |
Extracts this record information from the current record presented in the reader, then advances the reader and continues to read any children, if present. | |
virtual FltError | write_record_and_children (FltRecordWriter &writer) const |
Writes this record out to the flt file, along with all of its ancillary records and children records. | |
Static Protected Member Functions | |
bool | is_ancillary (FltOpcode opcode) |
Returns true if the indicated opcode corresponds to an ancillary record type, false otherwise. | |
Protected Attributes | |
FltHeader * | _header |
int | _ref_count |
You always read a Flt file by creating a header and calling read_flt(), which fills in its children beads automatically; you write a Flt file by creating a header, adding its children, and calling write_flt().
Definition at line 64 of file fltHeader.h.
|
Definition at line 84 of file fltHeader.h. |
|
Definition at line 117 of file fltHeader.h. |
|
Definition at line 126 of file fltHeader.h. |
|
Definition at line 101 of file fltHeader.h. |
|
Definition at line 105 of file fltHeader.h. |
|
Definition at line 93 of file fltHeader.h. |
|
Definition at line 113 of file fltHeader.h. |
|
The FltHeader constructor accepts a PathReplace pointer; it uses this object to automatically convert all external filename and texture references. (This is necessary because the FltHeader has to look in the same directory as the texture to find the .attr file, so it must pre-convert at least the texture references.) Most of the other file converters do not have this requirement, so they do not need to pre-convert any pathname references. Definition at line 64 of file fltHeader.cxx. References FltGroup::_flags. |
|
Adds a new unsupported ancillary record to the end of the list of ancillary records for this record. This record will be written to the flt file following this record, without attempting to understand what is in it. Normally, there is no reason to use this function; if the data stored in the FltRecord requires one or more ancillary record, the appropriate records will automatically be generated when the record is written. This function is only required to output a record whose type is not supported by the flt loader. But it would be better to extend the flt loader to know about this new kind of data record. Definition at line 341 of file fltRecord.cxx. |
|
Adds a new child to the end of the list of children for this record.
Definition at line 126 of file fltRecord.cxx. References nassertr, and NULL. Referenced by FltRecord::is_ancillary(). |
|
Adds a new extension to the end of the list of extensions for this record. This should be a record of type FO_extension. Definition at line 250 of file fltRecord.cxx. Referenced by FltRecord::is_ancillary(). |
|
Defines a new instance subtree. This subtree is not itself part of the hierarchy; it marks geometry that may be instanced to various beads elsewhere in the hierarchy by creating a corresponding FltInstanceRef bead. Definition at line 659 of file fltHeader.cxx. References Colorf. Referenced by FltRecord::is_ancillary(). |
|
Defines a new light source. The light source is added in the position indicated by its light index number. If there is already a light source defined for that index number, it is replaced. Definition at line 1383 of file fltHeader.cxx. |
|
Defines a new material. The material is added in the position indicated by the material's index number. If there is already a material defined for that index number, it is replaced. Definition at line 1219 of file fltHeader.cxx. References _database_origin, _flags, _last_revision, _next_dof_id, _next_face_id, _next_group_id, _next_lod_id, _next_object_id, _projection_type, _texwhite_new, _unit_multiplier, _vertex_storage_type, and _vertex_units. |
|
Adds a new subface to the end of the list of subfaces for this record.
Definition at line 187 of file fltRecord.cxx. Referenced by FltRecord::is_ancillary(). |
|
Defines a new texture. The texture is added in the position indicated by the texture's index number. If there is already a texture defined for that index number, it is replaced. Definition at line 1301 of file fltHeader.cxx. References FO_color_palette, FO_vertex_c, FO_vertex_cn, FO_vertex_cnu, FO_vertex_cu, FO_vertex_palette, and reader(). |
|
Applies the indicated transform step to the net transformation applied to the bead.
Definition at line 201 of file fltBead.cxx. |
|
Adds a new vertex to the end of the vertex palette. If this particular vertex was already present in the palette, does nothing. Definition at line 735 of file fltHeader.cxx. |
|
Walks the hierarchy at this record and below and copies the _converted_filename record into the _orig_filename record, so the flt file will be written out with the converted filename instead of what was originally read in.
Reimplemented from FltRecord. Definition at line 146 of file fltHeader.cxx. |
|
Fills up the current record on the FltRecordWriter with data for this record, but does not advance the writer. Returns true on success, false if there is some error. Reimplemented from FltBead. Reimplemented in FltCurve, FltFace, FltGeometry, FltGroup, FltLOD, FltMesh, and FltObject. Definition at line 158 of file fltBeadID.cxx. Referenced by FltMesh::extract_ancillary(), and get_light_source(). |
|
|
Verifies that the version number read from the header is an understood version number, and prints a warning to the user if this is not so--the read may or may not succeed. Returns true if the version number is acceptable (and no warning is printed), or false if it is questionable (and a warning is printed). Definition at line 534 of file fltHeader.cxx. References nassertr. |
|
Removes all unsupported ancillary records from this record. See get_num_ancillary(). Definition at line 304 of file fltRecord.cxx. References FltRecord::_header, get_flt_version(), DatagramIterator::get_remaining_size(), TypedReferenceCount::get_type(), max_flt_version(), and nout. |
|
Removes all children from this record.
Definition at line 111 of file fltRecord.cxx. |
|
Removes the comment for this record.
Definition at line 384 of file fltRecord.cxx. |
|
Removes all extensions from this record.
Definition at line 233 of file fltRecord.cxx. |
|
Removes all instance subtrees from the instance pool.
Definition at line 638 of file fltHeader.cxx. |
|
Removes all light sources from the palette.
Definition at line 1364 of file fltHeader.cxx. |
|
Removes all materials from the palette.
Definition at line 1200 of file fltHeader.cxx. References _edit_revision_level, _format_revision_level, FltBeadID::extract_record(), FO_header, DatagramIterator::get_be_int32(), nassertr, and reader(). |
|
Removes all subfaces from this record.
Definition at line 172 of file fltRecord.cxx. |
|
Removes all textures from the palette.
Definition at line 1282 of file fltHeader.cxx. |
|
Removes any transform matrix and all transform steps on this bead.
Definition at line 123 of file fltBead.cxx. |
|
Removes all vertices from the vertex palette.
Definition at line 714 of file fltHeader.cxx. |
|
Uses the PathReplace object to convert the named filename as read from the flt record to its actual name.
Definition at line 224 of file fltHeader.cxx. References FE_could_not_open, and flt_error_abort. |
|
Creates a new FltRecord corresponding to the opcode. If the opcode is unknown, creates a FltUnsupportedRecord. Definition at line 672 of file fltRecord.cxx. References reader(). Referenced by FltRecord::is_ancillary(). |
|
Checks whether the given bead, which follows this bead sequentially in the file, is an ancillary record of this bead. If it is, extracts the relevant information and returns true; otherwise, leaves it alone and returns false. Reimplemented from FltBead. Reimplemented in FltMesh. Definition at line 132 of file fltBeadID.cxx. References FltBeadID::_id, FE_ok, FltError, FO_long_id, FltBead::write_ancillary(), and writer(). |
|
Fills in the information in this bead based on the information given in the indicated datagram, whose opcode has already been read. Returns true on success, false if the datagram is invalid. Reimplemented from FltBead. Reimplemented in FltCurve, FltFace, FltGeometry, FltGroup, FltLOD, FltMesh, and FltObject. Definition at line 106 of file fltBeadID.cxx. Referenced by clear_materials(), FltCurve::FltCurve(), FltFace::FltFace(), FltMesh::FltMesh(), and FltObject::FltObject(). |
|
Reimplemented from TypedReferenceCount. Reimplemented in FltCurve, FltFace, FltGeometry, FltGroup, FltLOD, FltMesh, and FltObject. Definition at line 61 of file fltBeadID.h. |
|
Returns the nth unsupported ancillary record of this record. See get_num_ancillary(). Definition at line 288 of file fltRecord.cxx. |
|
Returns the current setting of the auto_attr_update flag. See sett_auto_attr_update(). Definition at line 435 of file fltHeader.cxx. References DistanceUnit, DU_feet, DU_kilometers, DU_meters, U_feet, U_kilometers, and U_meters. |
|
Returns the nth child of this record.
Definition at line 97 of file fltRecord.cxx. Referenced by FltCopy::scan_flt(). |
|
Reimplemented from TypedReferenceCount. Reimplemented in FltCurve, FltFace, FltGeometry, FltGroup, FltLOD, FltMesh, and FltObject. Definition at line 62 of file fltBeadID.h. |
|
Returns the color index of the nearest color in the palette that matches the given four-component color, including alpha.
Definition at line 933 of file fltHeader.cxx. |
|
Returns the color index of the nearest color in the palette that matches the given three-component color, ignoring alpha.
Definition at line 1003 of file fltHeader.cxx. |
|
Decodes a MultiGen color, as stored on a face or vertex, into an actual four-component Colorf. Normally you need not call this directly; there are color accessors defined on faces and vertices that do this. Definition at line 1109 of file fltHeader.cxx. |
|
Returns the four-component color corresponding to the given color index. Each component will be in the range [0, 1]. Definition at line 844 of file fltHeader.cxx. Referenced by get_rgb(). |
|
Returns the name associated with the given color, if any.
Definition at line 911 of file fltHeader.cxx. |
|
Retrieves the comment for this record, or empty string if the record has no comment.
Definition at line 371 of file fltRecord.cxx. References indent(), and FltRecord::write_children(). |
|
Returns the nth extension of this record.
Definition at line 219 of file fltRecord.cxx. |
|
Returns the nth eyepoint in the eyepoint/trackplane palette.
Definition at line 1468 of file fltHeader.cxx. |
|
Returns the directory in which the flt file is considered to reside.
Definition at line 261 of file fltHeader.cxx. |
|
Returns the version number of the flt file as reported in the header, times 100. Divide by 100 to get the floating-point version number. Definition at line 452 of file fltHeader.cxx. References DU_inches, DU_nautical_miles, U_inches, and U_nautical_miles. Referenced by FltRecord::clear_ancillary(), and remove_light_source(). |
|
Returns the id (name) of this particular bead. Each MultiGen bead will have a unique name. Definition at line 50 of file fltBeadID.cxx. References FltBeadID::_id. Referenced by FltToEggConverter::convert_face(), and FltToEggConverter::convert_lod(). |
|
Returns the instance subtree associated with the given index, or NULL if there is no such instance.
Definition at line 620 of file fltHeader.cxx. Referenced by FltInstanceRef::FltInstanceRef(), and FltInstanceRef::get_instance(). |
|
Returns the light source associated with the given index, or NULL if there is no such light source.
Definition at line 1346 of file fltHeader.cxx. References _edit_revision_level, _format_revision_level, _last_revision, _next_face_id, _next_group_id, _next_lod_id, _next_object_id, Datagram::add_be_int16(), Datagram::add_be_int32(), Datagram::add_fixed_string(), FltBeadID::build_record(), FO_header, and writer(). |
|
Returns the material associated with the given index, or NULL if there is no such material.
Definition at line 1182 of file fltHeader.cxx. References FltVertex::get_record_length(). |
|
Returns the number of unsupported ancillary records of this record. These are ancillary records that appeared following this record in the flt file but that aren't directly understood by the flt loader--normally, an ancillary record is examined and decoded on the spot, and no pointer to it is kept. Definition at line 273 of file fltRecord.cxx. |
|
Returns the number of child records of this record. This reflects the normal scene graph hierarchy. Definition at line 84 of file fltRecord.cxx. References NULL. |
|
Returns the number of actual entries in the color palette. This is based on the version of the flt file, and is usually either 512 or 1024. Definition at line 1069 of file fltHeader.cxx. |
|
Returns the number of shades of brightness of each entry in the color palette. This is a fixed property of MultiGen files: each entry in the palette actually represents a range of this many colors. Definition at line 1088 of file fltHeader.cxx. |
|
Returns the total number of different colors in the color palette. This includes all different colors, and represents the complete range of alloable color indices. This is different from the actual number of color entries as read directly from the color palette, since each color entry defines a number of different intensity levels--the value returned by get_num_colors() is equal to get_num_color_entries() get_num_color_shades(). Definition at line 827 of file fltHeader.cxx. |
|
Returns the number of extension attribute records for this object. These are auxiliary nodes, presumably of type FO_extension, that have some local meaning to the object. Definition at line 206 of file fltRecord.cxx. |
|
Returns the number of eyepoints in the eyepoint/trackplane palette. This is presently fixed at 10, according to the MultiGen specs. Definition at line 1453 of file fltHeader.cxx. References FE_ok. |
|
Returns the number of subface records of this record. Normally, subfaces will only be present on object records, although it is logically possible for them to appear anywhere. Definition at line 145 of file fltRecord.cxx. |
|
Returns the number of trackplanes in the eyepoint/trackplane palette. This is presently fixed at 10, according to the MultiGen specs. Definition at line 1486 of file fltHeader.cxx. References reader(). |
|
Returns the number of individual steps that define the net transform on this bead as returned by set_transform(). Each step is a single transformation; the concatenation of all transformations will produce the matrix represented by set_transform(). Definition at line 148 of file fltBead.cxx. References FltBead::_has_transform, FltBead::_transform, and FltTransformRecord::get_matrix(). |
|
Returns the number of vertices in the vertex palette.
Definition at line 687 of file fltHeader.cxx. |
|
Returns the byte offset into the vertex palette associated with the given vertex pointer. If there is no such vertex in the palette, this generates an error message and returns 0. Definition at line 788 of file fltHeader.cxx. |
|
Returns a pointer to the PathReplace object associated with this converter. If the converter is non-const, this returns a non-const pointer, which can be adjusted. Definition at line 207 of file fltHeader.cxx. |
|
Returns a pointer to the PathReplace object associated with this converter. If the converter is non-const, this returns a non-const pointer, which can be adjusted. Definition at line 188 of file fltHeader.cxx. |
|
Returns the replicate count of this bead. If this is nonzero, it means that the bead is implicitly copied this number of additional times (for replicate_count + 1 total copies), applying the transform on this bead for each copy. In this case, the transform does not* apply to the initial copy of the bead. Definition at line 230 of file fltBead.cxx. References FO_rotate_about_edge, FO_rotate_about_point, FO_rotate_and_scale, FO_scale, and FO_translate. |
|
Decodes a MultiGen color, as stored on a face or vertex, into an actual three-component RGBColorf. Normally you need not call this directly; there are color accessors defined on faces and vertices that do this. Definition at line 1143 of file fltHeader.cxx. |
|
Returns the three-component color corresponding to the given color index, ignoring the alpha component. Each component will be in the range [0, 1]. Definition at line 871 of file fltHeader.cxx. References FltPackedColor::_b, FltPackedColor::_g, FltPackedColor::_r, Colorf, and get_color(). Referenced by FltGeometry::has_alt_color(), and has_color_name(). |
|
Returns the nth subface of this record.
Definition at line 158 of file fltRecord.cxx. |
|
Returns the texture associated with the given index, or NULL if there is no such texture.
Definition at line 1264 of file fltHeader.cxx. References _delta_z, _next_adaptive_id, _next_curve_id, _next_mesh_id, and _radius. Referenced by FltGeometry::has_texture(). |
|
Returns the nth trackplane in the eyepoint/trackplane palette.
Definition at line 1501 of file fltHeader.cxx. References FO_color_palette, nout, and reader(). |
|
Returns the single-precision 4x4 matrix that represents the transform applied to this bead, or the identity matrix if the bead has not been transformed.
Definition at line 86 of file fltBead.cxx. Referenced by FltToEggLevelState::ParentNodes::ParentNodes(). |
|
Returns the nth individual step that defines the net transform on this bead. See get_num_transform_steps(). Definition at line 184 of file fltBead.cxx. |
|
Returns the nth individual step that defines the net transform on this bead. See get_num_transform_steps(). Definition at line 165 of file fltBead.cxx. |
|
Reimplemented from TypedReferenceCount. Reimplemented in FltCurve, FltFace, FltGeometry, FltGroup, FltLOD, FltMesh, and FltObject. Definition at line 58 of file fltBeadID.h. References FltBeadID::_type_handle, TypedReferenceCount::init_type(), and register_type(). Referenced by FltBeadID::set_id(). |
|
Returns the units indicated by the flt header, or DU_invalid if the units in the header are not understood.
Definition at line 572 of file fltHeader.cxx. |
|
Returns the nth vertex of the vertex palette.
Definition at line 700 of file fltHeader.cxx. |
|
Returns the particular vertex pointer associated with the given byte offset into the vertex palette. If there is no such vertex in the palette, this generates an error message and returns NULL. Definition at line 759 of file fltHeader.cxx. References Colorf, dot(), and nassertr. Referenced by FltVertexList::add_vertex(). |
|
Returns true if we have read an eyepoint/trackplane palette, and at least some of the eyepoints and trackplanes are therefore expected to be meaningful.
Definition at line 1415 of file fltHeader.cxx. |
|
Returns true if the given color is named, false otherwise.
Definition at line 896 of file fltHeader.cxx. References FltPackedColor::_b, FltPackedColor::_g, FltPackedColor::_r, get_rgb(), and RGBColorf. |
|
Returns true if this record has a nonempty comment, false otherwise.
Definition at line 356 of file fltRecord.cxx. References TypedReferenceCount::get_type(). |
|
Returns true if a instance subtree with the given index has been defined.
Definition at line 605 of file fltHeader.cxx. References nout. |
|
Returns true if a light source with the given index has been defined.
Definition at line 1331 of file fltHeader.cxx. References FO_eyepoint_palette. |
|
Returns true if a material with the given index has been defined.
Definition at line 1167 of file fltHeader.cxx. Referenced by FltGeometry::get_texture(). |
|
Returns true if a texture with the given index has been defined.
Definition at line 1249 of file fltHeader.cxx. References _earth_model, _lambert_lower_lat, _lambert_upper_lat, _ne_long, _next_cat_id, _next_light_id, _next_road_id, _origin_lat, and _origin_long. |
|
Returns true if the bead has been transformed, false otherwise. If this returns true, get_transform() will return the single-precision net transformation, and get_num_transform_steps() will return nonzero. Definition at line 69 of file fltBead.cxx. References FltBead::_has_transform, and FltBead::_transform. |
|
Reimplemented from TypedReferenceCount. Reimplemented in FltCurve, FltFace, FltGeometry, FltGroup, FltLOD, FltMesh, and FltObject. Definition at line 65 of file fltBeadID.h. References FltBeadID::_type_handle. Referenced by ConfigureFn(). |
|
Returns true if the indicated opcode corresponds to an ancillary record type, false otherwise. In general, this function is used to identify ancillary records that are not presently supported by the FltReader; these will be ignored. Normally, ancillary records will be detected and processed by extract_ancillary(). Definition at line 575 of file fltRecord.cxx. References FltRecord::_header, FltRecord::add_child(), FltRecord::add_extension(), add_instance(), FltRecord::add_subface(), FltRecord::create_new_record(), DCAST, FltRecord::extract_ancillary(), FltRecord::extract_record(), FE_end_of_file, FE_invalid_record, FE_ok, flt_error_abort, FltError, FO_pop, FO_pop_extension, FO_pop_face, FO_push, FO_push_extension, FO_push_face, FltInstanceDefinition::get_class_type(), nout, PT, and reader(). |
|
Returns the latest flt version number that this codebase is known to support (times 100). Later versions might work, but then again they may not. Definition at line 511 of file fltHeader.cxx. Referenced by FltRecord::clear_ancillary(), and set_auto_attr_update(). |
|
Returns the earliest flt version number that this codebase supports (times 100). Earlier versions will probably not work. Definition at line 494 of file fltHeader.cxx. |
|
Writes a quick one-line description of the record, but not its children. This is a human-readable description, primarily for debugging; to write a flt file, use FltHeader::write_flt(). Reimplemented from FltRecord. Definition at line 84 of file fltBeadID.cxx. |
|
Attempts to read a complete Flt file from the already-opened stream. Returns FE_ok on success, otherwise on failure. Definition at line 304 of file fltHeader.cxx. |
|
Opens the indicated filename for reading and attempts to read the complete Flt file. Returns FE_ok on success, otherwise on failure. Definition at line 278 of file fltHeader.cxx. References FE_could_not_open. |
|
Extracts this record information from the current record presented in the reader, then advances the reader and continues to read any children, if present. On return, the reader is position on the next sibling record to this record. Returns FE_ok if successful, otherwise on error. Definition at line 740 of file fltRecord.cxx. References FE_ok. |
|
Removes a particular instance subtree from the pool, if it exists.
Definition at line 674 of file fltHeader.cxx. References RGBColorf. |
|
Removes a particular light source from the light source palette, if it exists.
Definition at line 1398 of file fltHeader.cxx. References _delta_z, _earth_model, _next_adaptive_id, _next_curve_id, Datagram::add_be_float64(), Datagram::add_be_int16(), Datagram::add_be_int32(), get_flt_version(), and Datagram::pad_bytes(). |
|
Removes a particular material from the material palette, if it exists.
Definition at line 1234 of file fltHeader.cxx. References _delta_x, _delta_y, _ne_lat, _next_bsp_id, _next_clip_id, _next_path_id, _next_sound_id, _next_switch_id, _next_text_id, _sw_lat, _sw_long, _sw_x, and _sw_y. |
|
Removes a particular texture from the texture palette, if it exists.
Definition at line 1316 of file fltHeader.cxx. References FO_14_material_palette, FO_15_material, FO_light_definition, FO_texture, and FO_texture_map_palette. |
|
Controls whether texture .attr files are written automatically when write_flt() is called. There are three possibilities: AU_none: the .attr files are not written automatically; they must be written explicitly via a call to FltTexture::write_attr_data() if you want them to be written. AU_if_missing: the .attr files are written only if they do not already exist. This will not update any .attr files, even if the data is changed. AU_always: the .attr files are always rewritten, even if they already exist and even if the data has not changed. The default is AU_if_missing. Definition at line 420 of file fltHeader.cxx. References max_flt_version(), and nout. |
|
Changes the comment for this record.
Definition at line 397 of file fltRecord.cxx. |
|
Sets the state of the eyepoint/trackplane palette flag. When this is false, the palette is believed to be meaningless, and will not be written; when it is true, the palette is believed to contain at least some meaningful data, and will be written. Definition at line 1436 of file fltHeader.cxx. References FE_ok. |
|
Sets the filename--especially the directory part--in which the flt file is considered to reside. This is also implicitly set by read_flt(). Definition at line 246 of file fltHeader.cxx. |
|
Changes the version number of the flt file that will be reported in the header. Pass in the floating-point version number times 100. Definition at line 473 of file fltHeader.cxx. References NULL. |
|
Changes the id (name) of this particular bead. This should be a name that is unique to this bead. Definition at line 65 of file fltBeadID.cxx. References FltBeadID::_id, and FltBeadID::get_type(). |
|
Replaces the PathReplace object (which specifies how to mangle paths from the source to the destination file) with a new one.
Definition at line 169 of file fltHeader.cxx. |
|
Changes the replicate count of this bead. If you are setting the replicate count to some nonzero number, you must also set a transform on the bead. See set_replicate_count(). Definition at line 249 of file fltBead.cxx. References FO_replicate. |
|
Replaces the transform matrix on this bead. This implicitly removes all of the transform steps added previously, and replaces them with a single 4x4 general matrix transform step. Definition at line 105 of file fltBead.cxx. |
|
Writes a multiple-line description of the record and all of its children. This is a human-readable description, primarily for debugging; to write a flt file, use FltHeader::write_flt(). Reimplemented in FltInstanceRef. Definition at line 504 of file fltRecord.cxx. References FO_instance, FO_instance_ref, FO_pop_extension, FO_push_extension, and nout. |
|
Writes whatever ancillary records are required for this record. Returns FE_ok on success, or something else if there is some error. Reimplemented from FltBead. Reimplemented in FltMesh. Definition at line 180 of file fltBeadID.cxx. Referenced by FltMesh::build_record(). |
|
Assuming the current write position has been left at the end of the last line of the record description, writes out the list of children.
Definition at line 522 of file fltRecord.cxx. References FltRecord::_header, FO_curve, FO_external_ref, FO_face, FO_group, FO_instance, FO_instance_ref, FO_local_vertex_pool, FO_lod, FO_mesh, FO_mesh_primitive, FO_object, FO_vector, FO_vertex_list, and nout. Referenced by FltRecord::get_comment(), and FltInstanceRef::get_instance(). |
|
Attempts to write a complete Flt file to the already-opened stream. Returns FE_ok on success, otherwise on failure. Definition at line 366 of file fltHeader.cxx. References _format_revision_level. |
|
Opens the indicated filename for writing and attempts to write the complete Flt file. Returns FE_ok on success, otherwise on failure. Definition at line 341 of file fltHeader.cxx. References _format_revision_level. |
|
Writes this record out to the flt file, along with all of its ancillary records and children records. Returns FE_ok on success, or something else on error. Reimplemented in FltInstanceRef. Definition at line 904 of file fltRecord.cxx. Referenced by FltInstanceRef::extract_record(). |
|
Definition at line 148 of file fltHeader.h. Referenced by add_material(). |
|
Definition at line 150 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 150 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 167 of file fltHeader.h. Referenced by get_texture(), and remove_light_source(). |
|
Definition at line 164 of file fltHeader.h. Referenced by has_texture(), and remove_light_source(). |
|
Definition at line 135 of file fltHeader.h. Referenced by clear_materials(), and get_light_source(). |
|
Definition at line 144 of file fltHeader.h. Referenced by add_material(). |
|
Definition at line 134 of file fltHeader.h. Referenced by clear_materials(), get_light_source(), and write_flt(). |
|
|
Definition at line 160 of file fltHeader.h. Referenced by has_texture(). |
|
Definition at line 160 of file fltHeader.h. Referenced by has_texture(). |
|
Definition at line 136 of file fltHeader.h. Referenced by add_material(), and get_light_source(). |
|
Definition at line 158 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 158 of file fltHeader.h. Referenced by has_texture(). |
|
Definition at line 165 of file fltHeader.h. Referenced by get_texture(), and remove_light_source(). |
|
Definition at line 155 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 163 of file fltHeader.h. Referenced by has_texture(). |
|
Definition at line 153 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 166 of file fltHeader.h. Referenced by get_texture(), and remove_light_source(). |
|
Definition at line 146 of file fltHeader.h. Referenced by add_material(). |
|
Definition at line 140 of file fltHeader.h. Referenced by add_material(), and get_light_source(). |
|
Definition at line 137 of file fltHeader.h. Referenced by add_material(), and get_light_source(). |
|
Definition at line 161 of file fltHeader.h. Referenced by has_texture(). |
|
Definition at line 138 of file fltHeader.h. Referenced by add_material(), and get_light_source(). |
|
Definition at line 169 of file fltHeader.h. Referenced by get_texture(). |
|
Definition at line 139 of file fltHeader.h. Referenced by add_material(), and get_light_source(). |
|
Definition at line 152 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 162 of file fltHeader.h. Referenced by has_texture(). |
|
Definition at line 151 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 156 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 154 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 159 of file fltHeader.h. Referenced by has_texture(). |
|
Definition at line 159 of file fltHeader.h. Referenced by has_texture(). |
|
Definition at line 145 of file fltHeader.h. Referenced by add_material(). |
|
Definition at line 168 of file fltHeader.h. Referenced by get_texture(). |
|
Definition at line 157 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 157 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 149 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 149 of file fltHeader.h. Referenced by remove_material(). |
|
Definition at line 143 of file fltHeader.h. Referenced by add_material(). |
|
Definition at line 141 of file fltHeader.h. Referenced by add_material(). |
|
Definition at line 147 of file fltHeader.h. Referenced by add_material(). |
|
Definition at line 142 of file fltHeader.h. Referenced by add_material(). |