sheep::OBJLoader Class Reference

#include <objloader.h>

Inheritance diagram for sheep::OBJLoader:

List of all members.

Public Member Functions
	OBJLoader ()
virtual void	Load (const std::string &filename, IMeshBuilder &builder, int option_mask=DEFAULT_CONFIGURATION_BIT, ProgressMonitor *progmon=0) throw (LoadingException)
Private Types
typedef std::map< std::string, IMeshBuilder::FeatureId >	string_to_feature_id_map
enum	symbol {   END_OF_FILE = 256, END_OF_LINE, IDENTIFIER, INTEGER,   DOUBLE, D, F, G,   ILLUM, KA, KD, KS,   MAP_KD, MTLLIB, NEWMTL, O,   S, TR, USEMTL, V,   VN, VT }
Private Member Functions
void	parse_error ()
int	look_ahead ()
void	eat_leading_blanks ()
void	eat_blanks ()
void	eat_line ()
void	accept_char (int ref)
void	accept_newline ()
int	accept_integer ()
double	accept_double ()
std::string	accept_string ()
bool	is_eol ()
void	select_submesh ()
void	parse_file ()
void	parse_f_statement ()
void	parse_mtllib_statement ()
void	parse_usemtl_statement ()
void	parse_v_statement ()
void	parse_vt_statement ()
void	parse_vn_statement ()
void	load_material_file (const std::string &filename)
void	parse_material_file ()
void	parse_ka_statement ()
void	parse_kd_statement ()
void	parse_ks_statement ()
void	parse_map_kd_statement ()
void	parse_newmtl_statement ()
Private Attributes
KeywordTable	m_keyword_table
std::string	m_path
IMeshBuilder::IGeometryBuilder *	m_geombuilder
IMeshBuilder::IMaterialBuilder *	m_matbuilder
int	m_option_mask
ProgressMonitor *	m_progmon
	May be 0.
FILE *	m_file
int	m_line
string_to_feature_id_map	m_material_id
std::vector< Vector3 >	m_vertices
	All features are stored in these vectors as the file is parsed.
std::vector< Vector3 >	m_normals
std::vector< Vector2 >	m_texcoords
std::map< int, IMeshBuilder::FeatureId >	m_global_vertex_id
bool	m_create_submesh
	If true, create a new submesh before processing new faces.
bool	m_set_submesh_material
	If true, apply the material specified by 'm_material_id' to the new submesh.
IMeshBuilder::FeatureId	m_submesh_material_id
	Id of the material to apply to the new submesh.
bool	m_inside_submesh_def
	If true, we are currently in the middle of a submesh definition.
bool	m_inside_material_def
	If true, we are currently in the middle of a material definition.

---

Member Typedef Documentation

typedef std::map<std::string, IMeshBuilder::FeatureId> sheep::OBJLoader::string_to_feature_id_map [private]

Definition at line 113 of file objloader.h.

---

Member Enumeration Documentation

enum sheep::OBJLoader::symbol [private]

Enumeration values: END_OF_FILE  END_OF_LINE  IDENTIFIER  INTEGER  DOUBLE  D  Material transparency (same as TR). F  Face. G  Group name. ILLUM  Illumination model. KA  Material ambient color. KD  Material diffuse color. KS  Material specular color. MAP_KD  Material diffuse map. MTLLIB  Material library. NEWMTL  New material. O  Object name. S  Smoothing group. TR  Material transparency (same as D). USEMTL  Material name. V  Geometric vertex. VN  Vertex normal. VT  Texture vertex. Definition at line 75 of file objloader.h.

---

Constructor & Destructor Documentation

OBJLoader::OBJLoader (   )

Definition at line 41 of file objloader.cpp. References D, F, G, ILLUM, sheep::KeywordTable::Insert(), KA, KD, KS, MAP_KD, MTLLIB, NEWMTL, S, TR, USEMTL, V, VN, and VT.

---

Member Function Documentation

void OBJLoader::accept_char (  int  ref  )  [inline, private]

Definition at line 204 of file objloader.h. Referenced by parse_f_statement().

double OBJLoader::accept_double (   )  [private]

Definition at line 203 of file objloader.cpp. References look_ahead(), and parse_error(). Referenced by parse_ka_statement(), parse_kd_statement(), parse_ks_statement(), parse_v_statement(), parse_vn_statement(), and parse_vt_statement().

int OBJLoader::accept_integer (   )  [private]

Definition at line 187 of file objloader.cpp. References look_ahead(), and parse_error(). Referenced by parse_f_statement().

void OBJLoader::accept_newline (   )  [inline, private]

Definition at line 217 of file objloader.h. Referenced by parse_f_statement(), parse_ka_statement(), parse_kd_statement(), parse_ks_statement(), parse_map_kd_statement(), parse_mtllib_statement(), parse_newmtl_statement(), parse_usemtl_statement(), parse_v_statement(), parse_vn_statement(), and parse_vt_statement().

string OBJLoader::accept_string (   )  [private]

Definition at line 219 of file objloader.cpp. References parse_error(). Referenced by parse_file(), parse_map_kd_statement(), parse_material_file(), parse_mtllib_statement(), parse_newmtl_statement(), and parse_usemtl_statement().

void OBJLoader::eat_blanks (   )  [private]

Definition at line 146 of file objloader.cpp. Referenced by parse_f_statement(), parse_ka_statement(), parse_kd_statement(), parse_ks_statement(), parse_map_kd_statement(), parse_mtllib_statement(), parse_newmtl_statement(), parse_usemtl_statement(), parse_v_statement(), parse_vn_statement(), and parse_vt_statement().

void OBJLoader::eat_leading_blanks (   )  [private]

Definition at line 112 of file objloader.cpp. Referenced by parse_file(), and parse_material_file().

void OBJLoader::eat_line (   )  [private]

Definition at line 171 of file objloader.cpp. Referenced by parse_file(), and parse_material_file().

bool OBJLoader::is_eol (   )  [inline, private]

Definition at line 229 of file objloader.h. Referenced by parse_f_statement(), parse_mtllib_statement(), parse_usemtl_statement(), parse_v_statement(), and parse_vt_statement().

void OBJLoader::Load (  const std::string &  filename, IMeshBuilder &  builder, int  option_mask = DEFAULT_CONFIGURATION_BIT, ProgressMonitor *  progmon = 0 )  throw (LoadingException) [virtual]

Implements sheep::IMeshLoader. Definition at line 60 of file objloader.cpp. References sheep::ProgressMonitor::Done(), sheep::IMeshBuilder::IGeometryBuilder::EndSubMesh(), sheep::IMeshBuilder::GeometryBuilder(), m_create_submesh, m_inside_submesh_def, m_set_submesh_material, m_submesh_material_id, sheep::IMeshBuilder::MaterialBuilder(), parse_file(), and sheep::ProgressMonitor::StartJob().

void OBJLoader::load_material_file (  const std::string &  filename  )  [private]

Definition at line 635 of file objloader.cpp. References sheep::IMeshBuilder::IMaterialBuilder::EndMaterial(), m_inside_material_def, parse_material_file(), and sheep::TryOpeningFile(). Referenced by parse_mtllib_statement().

int OBJLoader::look_ahead (   )  [inline, private]

Definition at line 192 of file objloader.h. Referenced by accept_double(), accept_integer(), parse_f_statement(), parse_file(), and parse_material_file().

void OBJLoader::parse_error (   )  [private]

Definition at line 107 of file objloader.cpp. Referenced by accept_double(), accept_integer(), accept_string(), parse_f_statement(), parse_ka_statement(), parse_kd_statement(), parse_ks_statement(), and parse_map_kd_statement().

void OBJLoader::parse_f_statement (   )  [private]

Definition at line 339 of file objloader.cpp. References accept_char(), accept_integer(), accept_newline(), sheep::IMeshBuilder::IGeometryBuilder::AppendFace(), sheep::IMeshBuilder::IGeometryBuilder::AppendNormal(), sheep::IMeshBuilder::IGeometryBuilder::AppendTexCoord(), sheep::IMeshBuilder::IGeometryBuilder::AppendVertex(), eat_blanks(), sheep::IMeshBuilder::IGeometryBuilder::EndSubMesh(), fix_vector_index(), is_eol(), look_ahead(), m_global_vertex_id, parse_error(), sheep::IMeshBuilder::IGeometryBuilder::SetFaceNormals(), sheep::IMeshBuilder::IGeometryBuilder::SetFaceTexCoords(), and sheep::TriangulatePolygon3(). Referenced by parse_file().

void OBJLoader::parse_file (   )  [private]

Definition at line 281 of file objloader.cpp. References accept_string(), eat_leading_blanks(), eat_line(), F, sheep::KeywordTable::GetSymbol(), look_ahead(), MTLLIB, parse_f_statement(), parse_mtllib_statement(), parse_usemtl_statement(), parse_v_statement(), parse_vn_statement(), parse_vt_statement(), select_submesh(), sheep::ProgressMonitor::SetJobProgress(), USEMTL, V, VN, and VT. Referenced by Load().

void OBJLoader::parse_ka_statement (   )  [private]

Definition at line 697 of file objloader.cpp. References accept_double(), accept_newline(), eat_blanks(), m_inside_material_def, parse_error(), and sheep::IMeshBuilder::IMaterialBuilder::SetAmbientColor(). Referenced by parse_material_file().

void OBJLoader::parse_kd_statement (   )  [private]

Definition at line 717 of file objloader.cpp. References accept_double(), accept_newline(), eat_blanks(), m_inside_material_def, parse_error(), and sheep::IMeshBuilder::IMaterialBuilder::SetDiffuseColor(). Referenced by parse_material_file().

void OBJLoader::parse_ks_statement (   )  [private]

Definition at line 737 of file objloader.cpp. References accept_double(), accept_newline(), eat_blanks(), m_inside_material_def, parse_error(), and sheep::IMeshBuilder::IMaterialBuilder::SetSpecularColor(). Referenced by parse_material_file().

void OBJLoader::parse_map_kd_statement (   )  [private]

Definition at line 757 of file objloader.cpp. References accept_newline(), accept_string(), eat_blanks(), sheep::IMeshBuilder::IMaterialBuilder::EndMaterial(), m_inside_material_def, parse_error(), sheep::IMeshBuilder::IMaterialBuilder::SetTexture(), and sheep::TryLoadingImage(). Referenced by parse_material_file().

void OBJLoader::parse_material_file (   )  [private]

Definition at line 666 of file objloader.cpp. References accept_string(), eat_leading_blanks(), eat_line(), sheep::KeywordTable::GetSymbol(), KA, KD, KS, look_ahead(), MAP_KD, NEWMTL, parse_ka_statement(), parse_kd_statement(), parse_ks_statement(), parse_map_kd_statement(), and parse_newmtl_statement(). Referenced by load_material_file().

void OBJLoader::parse_mtllib_statement (   )  [private]

Definition at line 516 of file objloader.cpp. References accept_newline(), accept_string(), eat_blanks(), is_eol(), and load_material_file(). Referenced by parse_file().

void OBJLoader::parse_newmtl_statement (   )  [private]

Definition at line 798 of file objloader.cpp. References accept_newline(), accept_string(), sheep::IMeshBuilder::IMaterialBuilder::BeginMaterial(), eat_blanks(), sheep::IMeshBuilder::IMaterialBuilder::EndMaterial(), m_inside_material_def, and m_material_id. Referenced by parse_material_file().

void OBJLoader::parse_usemtl_statement (   )  [private]

Definition at line 539 of file objloader.cpp. References accept_newline(), accept_string(), eat_blanks(), is_eol(), m_create_submesh, m_material_id, m_set_submesh_material, and m_submesh_material_id. Referenced by parse_file().

void OBJLoader::parse_v_statement (   )  [private]

Definition at line 574 of file objloader.cpp. References accept_double(), accept_newline(), eat_blanks(), is_eol(), sheep::Vector3::m_x, sheep::Vector3::m_y, and sheep::Vector3::m_z. Referenced by parse_file().

void OBJLoader::parse_vn_statement (   )  [private]

Definition at line 615 of file objloader.cpp. References accept_double(), accept_newline(), eat_blanks(), sheep::Vector3::m_x, sheep::Vector3::m_y, sheep::Vector3::m_z, and sheep::Vector3::Normalize(). Referenced by parse_file().

void OBJLoader::parse_vt_statement (   )  [private]

Definition at line 596 of file objloader.cpp. References accept_double(), accept_newline(), eat_blanks(), is_eol(), sheep::Vector2::m_x, and sheep::Vector2::m_y. Referenced by parse_file().

void OBJLoader::select_submesh (   )  [private]

Definition at line 255 of file objloader.cpp. References sheep::IMeshBuilder::IGeometryBuilder::BeginSubMesh(), sheep::IMeshBuilder::IGeometryBuilder::EndSubMesh(), m_create_submesh, m_global_vertex_id, m_inside_submesh_def, m_set_submesh_material, m_submesh_material_id, and sheep::IMeshBuilder::IGeometryBuilder::SetMaterial(). Referenced by parse_file().

---

Member Data Documentation

bool sheep::OBJLoader::m_create_submesh [private]

If true, create a new submesh before processing new faces. Definition at line 126 of file objloader.h. Referenced by Load(), parse_usemtl_statement(), and select_submesh().

FILE* sheep::OBJLoader::m_file [private]

Definition at line 110 of file objloader.h.

IMeshBuilder::IGeometryBuilder* sheep::OBJLoader::m_geombuilder [private]

Definition at line 103 of file objloader.h.

std::map<int, IMeshBuilder::FeatureId> sheep::OBJLoader::m_global_vertex_id [private]

This vector is used to avoid inserting duplicate vertices into the current mesh. It is cleared each time a new mesh is created. Definition at line 124 of file objloader.h. Referenced by parse_f_statement(), and select_submesh().

bool sheep::OBJLoader::m_inside_material_def [private]

If true, we are currently in the middle of a material definition. Definition at line 130 of file objloader.h. Referenced by load_material_file(), parse_ka_statement(), parse_kd_statement(), parse_ks_statement(), parse_map_kd_statement(), and parse_newmtl_statement().

bool sheep::OBJLoader::m_inside_submesh_def [private]

If true, we are currently in the middle of a submesh definition. Definition at line 129 of file objloader.h. Referenced by Load(), and select_submesh().

KeywordTable sheep::OBJLoader::m_keyword_table [private]

Definition at line 99 of file objloader.h.

int sheep::OBJLoader::m_line [private]

Definition at line 111 of file objloader.h.

IMeshBuilder::IMaterialBuilder* sheep::OBJLoader::m_matbuilder [private]

Definition at line 104 of file objloader.h.

string_to_feature_id_map sheep::OBJLoader::m_material_id [private]

Definition at line 115 of file objloader.h. Referenced by parse_newmtl_statement(), and parse_usemtl_statement().

std::vector<Vector3> sheep::OBJLoader::m_normals [private]

Definition at line 119 of file objloader.h.

int sheep::OBJLoader::m_option_mask [private]

Definition at line 106 of file objloader.h.

std::string sheep::OBJLoader::m_path [private]

Definition at line 101 of file objloader.h.

ProgressMonitor* sheep::OBJLoader::m_progmon [private]

May be 0. Definition at line 108 of file objloader.h.

bool sheep::OBJLoader::m_set_submesh_material [private]

If true, apply the material specified by 'm_material_id' to the new submesh. Definition at line 127 of file objloader.h. Referenced by Load(), parse_usemtl_statement(), and select_submesh().

IMeshBuilder::FeatureId sheep::OBJLoader::m_submesh_material_id [private]

Id of the material to apply to the new submesh. Definition at line 128 of file objloader.h. Referenced by Load(), parse_usemtl_statement(), and select_submesh().

std::vector<Vector2> sheep::OBJLoader::m_texcoords [private]

Definition at line 120 of file objloader.h.

std::vector<Vector3> sheep::OBJLoader::m_vertices [private]

All features are stored in these vectors as the file is parsed. Definition at line 118 of file objloader.h.

---

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

• objloader.h
• objloader.cpp
• objloader.inl

---