---

FltLightSourceDefinition Class Reference

Represents a single entry in the light source palette. More...

#include <fltLightSourceDefinition.h>

Inheritance diagram for FltLightSourceDefinition:

List of all members.

Public Types
enum	LightType { LT_infinite = 0, LT_local = 1, LT_spot = 2 }
Public Member Functions
	FltLightSourceDefinition (FltHeader *header)
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
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	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.
virtual void	output (ostream &out) const
	Writes a quick one-line description of the record, but not its children.
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
TypeHandle	get_class_type ()
void	init_type ()
Public Attributes
int	_light_index
string	_light_name
Colorf	_ambient
Colorf	_diffuse
Colorf	_specular
LightType	_light_type
float	_exponential_dropoff
float	_cutoff_angle
float	_yaw
float	_pitch
float	_constant_coefficient
float	_linear_coefficient
float	_quadratic_coefficient
bool	_modeling_light
Protected Member Functions
virtual bool	extract_record (FltRecordReader &reader)
	Fills in the information in this record based on the information given in the indicated datagram, whose opcode has already been read.
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.
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 bool	extract_ancillary (FltRecordReader &reader)
	Checks whether the given record, which follows this record sequentially in the file, is an ancillary record of this record.
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.
virtual FltError	write_ancillary (FltRecordWriter &writer) const
	Writes whatever ancillary records are required for this record.
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
Static Private Attributes
TypeHandle	_type_handle
Friends
class	FltHeader

---

Detailed Description

Represents a single entry in the light source palette.

This completely defines the color, etc. of a single light source, which may be referenced later by a FltLightSource bead in the hierarchy.

Definition at line 44 of file fltLightSourceDefinition.h.

---

Member Enumeration Documentation

enum FltLightSourceDefinition::LightType

Enumeration values: LT_infinite  LT_local  LT_spot  Definition at line 48 of file fltLightSourceDefinition.h.

---

Constructor & Destructor Documentation

FltLightSourceDefinition::FltLightSourceDefinition (  FltHeader *  header  )

Definition at line 36 of file fltLightSourceDefinition.cxx. References _constant_coefficient, _cutoff_angle, _exponential_dropoff, _light_type, _linear_coefficient, _modeling_light, _pitch, _quadratic_coefficient, _yaw, and LT_infinite.

---

Member Function Documentation

void FltRecord::add_ancillary (  FltRecord *  ancillary  )  [inherited]

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.

void FltRecord::add_child (  FltRecord *  child  )  [inherited]

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().

void FltRecord::add_extension (  FltRecord *  extension  )  [inherited]

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().

void FltRecord::add_subface (  FltRecord *  subface  )  [inherited]

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().

void FltRecord::apply_converted_filenames (   )  [virtual, inherited]

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 in FltExternalReference, FltHeader, and FltTexture. Definition at line 460 of file fltRecord.cxx. References FO_15_material, FO_bsp, FO_color_palette, FO_dof, FO_external_ref, FO_eyepoint_palette, FO_face, FO_group, FO_header, FO_light_definition, FO_light_point, FO_lod, FO_mesh, FO_mesh_primitive, FO_morph_list, FO_name_table, FO_object, FO_texture, FO_texture_map_palette, FO_vertex_cn, FO_vertex_cnu, FO_vertex_cu, and FO_vertex_list. Referenced by FltExternalReference::FltExternalReference().

bool FltLightSourceDefinition::build_record (  FltRecordWriter &  writer  )  const [protected, virtual]

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 FltRecord. Definition at line 122 of file fltLightSourceDefinition.cxx.

void FltRecord::check_remaining_size (  const DatagramIterator &  di, const string &  name = string() )  const [inherited]

Checks that the iterator has no bytes left, as it should at the end of a successfully read record. If there *are* remaining bytes, print a warning message but otherwise don't worry about it. If we are attempting to read a flt file whose version is newer than the newest this program understands, don't even print a warning message, since this is exactly the sort of thing we expect. Definition at line 426 of file fltRecord.cxx. References FO_14_material_palette, FO_bounding_box, FO_bounding_cylinder, FO_bounding_sphere, FO_bv_center, FO_bv_orientation, FO_cat_data, FO_comment, FO_general_matrix, FO_local_vertex_pool, FO_long_id, FO_multitexture, FO_put, FO_replicate, FO_road_zone, FO_rotate_about_edge, FO_rotate_about_point, FO_rotate_and_scale, FO_scale, FO_transform_matrix, FO_translate, FO_uv_list, FO_vector, FO_vertex_c, and FO_vertex_palette. Referenced by FltLocalVertexPool::FltLocalVertexPool(), FltVectorRecord::get_vector(), FltTransformScale::recompute_matrix(), FltTransformRotateAboutPoint::recompute_matrix(), FltTransformRotateAboutEdge::recompute_matrix(), FltTransformGeneralMatrix::set_matrix(), and FltInstanceRef::write().

void FltRecord::clear_ancillary (   )  [inherited]

Removes all unsupported ancillary records from this record. See get_num_ancillary(). Definition at line 304 of file fltRecord.cxx. References FltRecord::_header, FltHeader::get_flt_version(), DatagramIterator::get_remaining_size(), TypedReferenceCount::get_type(), FltHeader::max_flt_version(), and nout.

void FltRecord::clear_children (   )  [inherited]

Removes all children from this record. Definition at line 111 of file fltRecord.cxx.

void FltRecord::clear_comment (   )  [inherited]

Removes the comment for this record. Definition at line 384 of file fltRecord.cxx.

void FltRecord::clear_extensions (   )  [inherited]

Removes all extensions from this record. Definition at line 233 of file fltRecord.cxx.

void FltRecord::clear_subfaces (   )  [inherited]

Removes all subfaces from this record. Definition at line 172 of file fltRecord.cxx. References nassertr, and NULL.

FltRecord * FltRecord::create_new_record (  FltOpcode  opcode  )  const [protected, inherited]

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().

bool FltRecord::extract_ancillary (  FltRecordReader &  reader  )  [protected, virtual, inherited]

Checks whether the given record, which follows this record sequentially in the file, is an ancillary record of this record. If it is, extracts the relevant information and returns true; otherwise, leaves it alone and returns false. Reimplemented in FltBead, FltBeadID, and FltMesh. Definition at line 882 of file fltRecord.cxx. Referenced by FltRecord::is_ancillary().

bool FltLightSourceDefinition::extract_record (  FltRecordReader &  reader  )  [protected, virtual]

Fills in the information in this record 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 FltRecord. Definition at line 67 of file fltLightSourceDefinition.cxx. References _ambient, _constant_coefficient, _cutoff_angle, _diffuse, _exponential_dropoff, _light_type, _linear_coefficient, _modeling_light, _pitch, _quadratic_coefficient, _specular, and _yaw.

virtual TypeHandle FltLightSourceDefinition::force_init_type (  void   )  [inline, virtual]

Reimplemented from TypedReferenceCount. Definition at line 81 of file fltLightSourceDefinition.h.

FltRecord * FltRecord::get_ancillary (  int  n  )  const [inherited]

Returns the nth unsupported ancillary record of this record. See get_num_ancillary(). Definition at line 288 of file fltRecord.cxx.

FltRecord * FltRecord::get_child (  int  n  )  const [inherited]

Returns the nth child of this record. Definition at line 97 of file fltRecord.cxx. Referenced by FltCopy::scan_flt().

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

Reimplemented from TypedReferenceCount. Definition at line 82 of file fltLightSourceDefinition.h. References _type_handle.

const string & FltRecord::get_comment (   )  const [inherited]

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().

FltRecord * FltRecord::get_extension (  int  n  )  const [inherited]

Returns the nth extension of this record. Definition at line 219 of file fltRecord.cxx. References nassertr, and NULL.

int FltRecord::get_num_ancillary (   )  const [inherited]

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.

int FltRecord::get_num_children (   )  const [inherited]

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.

int FltRecord::get_num_extensions (   )  const [inherited]

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.

int FltRecord::get_num_subfaces (   )  const [inherited]

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.

FltRecord * FltRecord::get_subface (  int  n  )  const [inherited]

Returns the nth subface of this record. Definition at line 158 of file fltRecord.cxx.

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

Reimplemented from TypedReferenceCount. Definition at line 78 of file fltLightSourceDefinition.h.

bool FltRecord::has_comment (   )  const [inherited]

Returns true if this record has a nonempty comment, false otherwise. Definition at line 356 of file fltRecord.cxx. References TypedReferenceCount::get_type().

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

Reimplemented from TypedReferenceCount. Definition at line 85 of file fltLightSourceDefinition.h.

bool FltRecord::is_ancillary (  FltOpcode  opcode  )  [static, protected, inherited]

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(), FltHeader::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().

void FltRecord::output (  ostream &  out  )  const [virtual, inherited]

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 in FltBeadID, FltExternalReference, FltUnsupportedRecord, and FltVertexList. Definition at line 485 of file fltRecord.cxx. References FO_cat, FO_clip_region, FO_curve, FO_extension, FO_light_source, FO_pop, FO_pop_attribute, FO_pop_face, FO_push, FO_push_attribute, FO_push_face, FO_road_construction, FO_road_path, FO_road_segment, FO_sound, FO_switch, and FO_text.

FltError FltRecord::read_record_and_children (  FltRecordReader &  reader  )  [protected, inherited]

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.

void FltRecord::set_comment (  const string &  comment  )  [inherited]

Changes the comment for this record. Definition at line 397 of file fltRecord.cxx.

void FltRecord::write (  ostream &  out, int  indent_level = 0 )  const [virtual, inherited]

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.

FltError FltRecord::write_ancillary (  FltRecordWriter &  writer  )  const [protected, virtual, inherited]

Writes whatever ancillary records are required for this record. Returns FE_ok on success, or something else if there is some error. Reimplemented in FltBead, FltBeadID, and FltMesh. Definition at line 1020 of file fltRecord.cxx. Referenced by FltBead::extract_ancillary().

void FltRecord::write_children (  ostream &  out, int  indent_level )  const [protected, inherited]

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().

FltError FltRecord::write_record_and_children (  FltRecordWriter &  writer  )  const [protected, virtual, inherited]

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().

---

Friends And Related Function Documentation

friend class FltHeader [friend]

Definition at line 94 of file fltLightSourceDefinition.h.

---

Member Data Documentation

Colorf FltLightSourceDefinition::_ambient

Definition at line 56 of file fltLightSourceDefinition.h. Referenced by extract_record().

float FltLightSourceDefinition::_constant_coefficient

Definition at line 68 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

float FltLightSourceDefinition::_cutoff_angle

Definition at line 61 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

Colorf FltLightSourceDefinition::_diffuse

Definition at line 57 of file fltLightSourceDefinition.h. Referenced by extract_record().

float FltLightSourceDefinition::_exponential_dropoff

Definition at line 60 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

FltHeader* FltRecord::_header [protected, inherited]

Definition at line 107 of file fltRecord.h. Referenced by FltVertexList::add_vertex(), FltRecord::clear_ancillary(), FltVertexList::extract_record(), FltInstanceRef::extract_record(), FltGroup::extract_record(), FltInstanceRef::FltInstanceRef(), FltLocalVertexPool::FltLocalVertexPool(), FltGeometry::get_alt_rgb(), FltInstanceRef::get_instance(), FltGeometry::get_texture(), FltGeometry::has_alt_color(), FltGeometry::has_texture(), FltRecord::is_ancillary(), and FltRecord::write_children().

int FltLightSourceDefinition::_light_index

Definition at line 54 of file fltLightSourceDefinition.h.

string FltLightSourceDefinition::_light_name

Definition at line 55 of file fltLightSourceDefinition.h.

LightType FltLightSourceDefinition::_light_type

Definition at line 59 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

float FltLightSourceDefinition::_linear_coefficient

Definition at line 69 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

bool FltLightSourceDefinition::_modeling_light

Definition at line 71 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

float FltLightSourceDefinition::_pitch

Definition at line 66 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

float FltLightSourceDefinition::_quadratic_coefficient

Definition at line 70 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

Colorf FltLightSourceDefinition::_specular

Definition at line 58 of file fltLightSourceDefinition.h. Referenced by extract_record().

TypeHandle FltLightSourceDefinition::_type_handle [static, private]

Reimplemented from TypedReferenceCount. Definition at line 26 of file fltLightSourceDefinition.cxx. Referenced by get_class_type().

float FltLightSourceDefinition::_yaw

Definition at line 65 of file fltLightSourceDefinition.h. Referenced by extract_record(), and FltLightSourceDefinition().

---

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

• pandatool/src/flt/fltLightSourceDefinition.h
• pandatool/src/flt/fltLightSourceDefinition.cxx

---