An abstract class implementing procedure to read OBJ file. More...

#include <RWObj_Reader.hxx>

Inheritance diagram for RWObj_Reader:

[legend]

Data Structures
struct	ObjVec3iHasher
	Hasher for 3 ordered integers. More...

class	VectorOfVertices
	Auxiliary structure holding vertex data either with single or double floating point precision. More...

Public Member Functions
	RWObj_Reader ()
	Empty constructor.

Standard_Boolean	Read (const TCollection_AsciiString &theFile, const Message_ProgressRange &theProgress)
	Open stream and pass it to Read method Returns true if success, false on error.

Standard_Boolean	Read (std::istream &theStream, const TCollection_AsciiString &theFile, const Message_ProgressRange &theProgress)
	Reads data from OBJ file. Unicode paths can be given in UTF-8 encoding. Returns true if success, false on error or user break.

Standard_Boolean	Probe (const TCollection_AsciiString &theFile, const Message_ProgressRange &theProgress)
	Open stream and pass it to Probe method.

Standard_Boolean	Probe (std::istream &theStream, const TCollection_AsciiString &theFile, const Message_ProgressRange &theProgress)
	Probe data from OBJ file (comments, external references) without actually reading mesh data. Although mesh data will not be collected, the full file content will be parsed, due to OBJ format limitations.

const TCollection_AsciiString &	FileComments () const
	Returns file comments (lines starting with # at the beginning of file).

const NCollection_IndexedMap< TCollection_AsciiString > &	ExternalFiles () const
	Return the list of external file references.

Standard_Integer	NbProbeNodes () const
	Number of probed nodes.

Standard_Integer	NbProbeElems () const

Standard_Size	MemoryLimit () const
	Returns memory limit in bytes; -1 (no limit) by default.

void	SetMemoryLimit (Standard_Size theMemLimit)
	Specify memory limit in bytes, so that import will be aborted by specified limit before memory allocation error occurs.

const RWMesh_CoordinateSystemConverter &	Transformation () const
	Return transformation from one coordinate system to another; no transformation by default.

void	SetTransformation (const RWMesh_CoordinateSystemConverter &theCSConverter)
	Setup transformation from one coordinate system to another. OBJ file might be exported following various coordinate system conventions, so that it might be useful automatically transform data during file reading.

Standard_Boolean	IsSinglePrecision () const
	Return single precision flag for reading vertex data (coordinates); FALSE by default.

void	SetSinglePrecision (Standard_Boolean theIsSinglePrecision)
	Setup single/double precision flag for reading vertex data (coordinates).

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
Standard_Boolean	read (std::istream &theStream, const TCollection_AsciiString &theFile, const Message_ProgressRange &theProgress, const Standard_Boolean theToProbe)
	Reads data from OBJ file. Unicode paths can be given in UTF-8 encoding. Returns true if success, false on error or user break.

interface methods which should be implemented by sub-class
virtual Standard_Boolean	addMesh (const RWObj_SubMesh &theMesh, const RWObj_SubMeshReason theReason)=0
	Add new sub-mesh. Basically, this method will be called multiple times for the same group with different reason, so that implementation should decide if previously allocated sub-mesh should be used or new one to be allocated. Sub-mesh command can be skipped if previous sub-mesh is empty, or if the reason is out of interest for particular reader (e.g. if materials are ignored, reader may ignore RWObj_SubMeshReason_NewMaterial reason).

virtual gp_Pnt	getNode (Standard_Integer theIndex) const =0
	Retrieve sub-mesh node position, added by addNode().

virtual Standard_Integer	addNode (const gp_Pnt &thePnt)=0
	Callback function to be implemented in descendant. Should create new node with specified coordinates in the target model, and return its ID as integer.

virtual void	setNodeNormal (const Standard_Integer theIndex, const Graphic3d_Vec3 &theNorm)=0
	Callback function to be implemented in descendant. Should set normal coordinates for specified node.

virtual void	setNodeUV (const Standard_Integer theIndex, const Graphic3d_Vec2 &theUV)=0
	Callback function to be implemented in descendant. Should set texture coordinates for specified node.

virtual void	addElement (Standard_Integer theN1, Standard_Integer theN2, Standard_Integer theN3, Standard_Integer theN4)=0
	Callback function to be implemented in descendant. Should create new element (triangle or quad if 4th index is != -1) built on specified nodes in the target model.

implementation details
NCollection_IndexedMap< TCollection_AsciiString >	myExternalFiles
	list of external file references

TCollection_AsciiString	myFileComments
	file header comments

TCollection_AsciiString	myFolder
	folder containing the OBJ file

RWMesh_CoordinateSystemConverter	myCSTrsf
	coordinate system flipper

Standard_Size	myMemLimitBytes
	memory limit in bytes

Standard_Size	myMemEstim
	estimated memory occupation in bytes

Standard_Integer	myNbLines
	number of parsed lines (e.g. current line)

Standard_Integer	myNbProbeNodes
	number of probed nodes

Standard_Integer	myNbProbeElems
	number of probed elements

Standard_Integer	myNbElemsBig
	number of big elements (polygons with 5+ nodes)

Standard_Boolean	myToAbort
	flag indicating abort state (e.g. syntax error)

VectorOfVertices	myObjVerts
	temporary vector of vertices

NCollection_Vector< Graphic3d_Vec2 >	myObjVertsUV
	temporary vector of UV parameters

NCollection_Vector< Graphic3d_Vec3 >	myObjNorms
	temporary vector of normals

NCollection_DataMap< Graphic3d_Vec3i, Standard_Integer, ObjVec3iHasher >	myPackedIndices
	list of external file references

NCollection_DataMap< TCollection_AsciiString, RWObj_Material >	myMaterials
	map of known materials

RWObj_SubMesh	myActiveSubMesh
	active sub-mesh definition

std::vector< Standard_Integer >	myCurrElem
	indices for the current element

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

An abstract class implementing procedure to read OBJ file.

This class is not bound to particular data structure and can be used to read the file directly into arbitrary data model. To use it, create descendant class and implement interface methods.

Call method Read() to read the file.

Constructor & Destructor Documentation

◆ RWObj_Reader()

RWObj_Reader::RWObj_Reader ( )

Empty constructor.

Member Function Documentation

◆ addElement()

virtual void RWObj_Reader::addElement	(	Standard_Integer	theN1,
		Standard_Integer	theN2,
		Standard_Integer	theN3,
		Standard_Integer	theN4 )

protectedpure virtual

Callback function to be implemented in descendant. Should create new element (triangle or quad if 4th index is != -1) built on specified nodes in the target model.

Implemented in RWObj_TriangulationReader.

◆ addMesh()

virtual Standard_Boolean RWObj_Reader::addMesh	(	const RWObj_SubMesh &	theMesh,
		const RWObj_SubMeshReason	theReason )

protectedpure virtual

Add new sub-mesh. Basically, this method will be called multiple times for the same group with different reason, so that implementation should decide if previously allocated sub-mesh should be used or new one to be allocated. Sub-mesh command can be skipped if previous sub-mesh is empty, or if the reason is out of interest for particular reader (e.g. if materials are ignored, reader may ignore RWObj_SubMeshReason_NewMaterial reason).

Parameters

theMesh	mesh definition
theReason	reason to create new sub-mesh

Returns: TRUE if new sub-mesh should be started since this point

Implemented in RWObj_TriangulationReader.

◆ addNode()

virtual Standard_Integer RWObj_Reader::addNode ( const gp_Pnt & thePnt )

protectedpure virtual

Callback function to be implemented in descendant. Should create new node with specified coordinates in the target model, and return its ID as integer.

Implemented in RWObj_TriangulationReader.

◆ ExternalFiles()

const NCollection_IndexedMap< TCollection_AsciiString > & RWObj_Reader::ExternalFiles ( ) const

inline

Return the list of external file references.

◆ FileComments()

const TCollection_AsciiString & RWObj_Reader::FileComments ( ) const

inline

Returns file comments (lines starting with # at the beginning of file).

◆ getNode()

virtual gp_Pnt RWObj_Reader::getNode ( Standard_Integer theIndex ) const

protectedpure virtual

Retrieve sub-mesh node position, added by addNode().

Implemented in RWObj_TriangulationReader.

◆ IsSinglePrecision()

Standard_Boolean RWObj_Reader::IsSinglePrecision ( ) const

inline

Return single precision flag for reading vertex data (coordinates); FALSE by default.

◆ MemoryLimit()

Standard_Size RWObj_Reader::MemoryLimit ( ) const

inline

Returns memory limit in bytes; -1 (no limit) by default.

◆ NbProbeElems()

Standard_Integer RWObj_Reader::NbProbeElems ( ) const

inline

◆ NbProbeNodes()

Standard_Integer RWObj_Reader::NbProbeNodes ( ) const

inline

Number of probed nodes.

number of probed polygon elements (of unknown size).

◆ Probe() [1/2]

Standard_Boolean RWObj_Reader::Probe	(	const TCollection_AsciiString &	theFile,
		const Message_ProgressRange &	theProgress )

inline

Open stream and pass it to Probe method.

Parameters

theFile	path to the file
theProgress	progress indicator

Returns: TRUE if success, FALSE on error or user break.

See also: FileComments(), ExternalFiles(), NbProbeNodes(), NbProbeElems().

◆ Probe() [2/2]

Standard_Boolean RWObj_Reader::Probe	(	std::istream &	theStream,
		const TCollection_AsciiString &	theFile,
		const Message_ProgressRange &	theProgress )

inline

Probe data from OBJ file (comments, external references) without actually reading mesh data. Although mesh data will not be collected, the full file content will be parsed, due to OBJ format limitations.

Parameters

theStream	input stream
theFile	path to the file
theProgress	progress indicator

Returns: TRUE if success, FALSE on error or user break.

See also: FileComments(), ExternalFiles(), NbProbeNodes(), NbProbeElems().

◆ Read() [1/2]

Standard_Boolean RWObj_Reader::Read	(	const TCollection_AsciiString &	theFile,
		const Message_ProgressRange &	theProgress )

inline

Open stream and pass it to Read method Returns true if success, false on error.

◆ Read() [2/2]

Standard_Boolean RWObj_Reader::Read	(	std::istream &	theStream,
		const TCollection_AsciiString &	theFile,
		const Message_ProgressRange &	theProgress )

inline

Reads data from OBJ file. Unicode paths can be given in UTF-8 encoding. Returns true if success, false on error or user break.

◆ read()

Standard_Boolean RWObj_Reader::read	(	std::istream &	theStream,
		const TCollection_AsciiString &	theFile,
		const Message_ProgressRange &	theProgress,
		const Standard_Boolean	theToProbe )

protected

Reads data from OBJ file. Unicode paths can be given in UTF-8 encoding. Returns true if success, false on error or user break.

◆ SetMemoryLimit()

void RWObj_Reader::SetMemoryLimit ( Standard_Size theMemLimit )

inline

Specify memory limit in bytes, so that import will be aborted by specified limit before memory allocation error occurs.

◆ setNodeNormal()

virtual void RWObj_Reader::setNodeNormal	(	const Standard_Integer	theIndex,
		const Graphic3d_Vec3 &	theNorm )

protectedpure virtual

Callback function to be implemented in descendant. Should set normal coordinates for specified node.

Parameters

theIndex	node ID as returned by addNode()
theNorm	normal vector

Implemented in RWObj_TriangulationReader.

◆ setNodeUV()

virtual void RWObj_Reader::setNodeUV	(	const Standard_Integer	theIndex,
		const Graphic3d_Vec2 &	theUV )

protectedpure virtual

Callback function to be implemented in descendant. Should set texture coordinates for specified node.

Parameters

theIndex	node ID as returned by addNode()
theUV	UV texture coordinates

Implemented in RWObj_TriangulationReader.

◆ SetSinglePrecision()

void RWObj_Reader::SetSinglePrecision ( Standard_Boolean theIsSinglePrecision )

inline

Setup single/double precision flag for reading vertex data (coordinates).

◆ SetTransformation()

void RWObj_Reader::SetTransformation ( const RWMesh_CoordinateSystemConverter & theCSConverter )

inline

Setup transformation from one coordinate system to another. OBJ file might be exported following various coordinate system conventions, so that it might be useful automatically transform data during file reading.

◆ Transformation()

const RWMesh_CoordinateSystemConverter & RWObj_Reader::Transformation ( ) const

inline

Return transformation from one coordinate system to another; no transformation by default.

Field Documentation

◆ myActiveSubMesh

RWObj_SubMesh RWObj_Reader::myActiveSubMesh

protected

active sub-mesh definition

◆ myCSTrsf

RWMesh_CoordinateSystemConverter RWObj_Reader::myCSTrsf

protected

coordinate system flipper

◆ myCurrElem

std::vector<Standard_Integer> RWObj_Reader::myCurrElem

protected

indices for the current element

◆ myExternalFiles

NCollection_IndexedMap<TCollection_AsciiString> RWObj_Reader::myExternalFiles

protected

list of external file references

◆ myFileComments

TCollection_AsciiString RWObj_Reader::myFileComments

protected

file header comments

◆ myFolder

TCollection_AsciiString RWObj_Reader::myFolder

protected

folder containing the OBJ file

◆ myMaterials

NCollection_DataMap<TCollection_AsciiString, RWObj_Material> RWObj_Reader::myMaterials

protected

map of known materials

◆ myMemEstim

Standard_Size RWObj_Reader::myMemEstim

protected

estimated memory occupation in bytes

◆ myMemLimitBytes

Standard_Size RWObj_Reader::myMemLimitBytes

protected

memory limit in bytes

◆ myNbElemsBig

Standard_Integer RWObj_Reader::myNbElemsBig

protected

number of big elements (polygons with 5+ nodes)

◆ myNbLines

Standard_Integer RWObj_Reader::myNbLines

protected

number of parsed lines (e.g. current line)

◆ myNbProbeElems

Standard_Integer RWObj_Reader::myNbProbeElems

protected

number of probed elements

◆ myNbProbeNodes

Standard_Integer RWObj_Reader::myNbProbeNodes

protected

number of probed nodes

◆ myObjNorms

NCollection_Vector<Graphic3d_Vec3> RWObj_Reader::myObjNorms

protected

temporary vector of normals

◆ myObjVerts

VectorOfVertices RWObj_Reader::myObjVerts

protected

temporary vector of vertices

◆ myObjVertsUV

NCollection_Vector<Graphic3d_Vec2> RWObj_Reader::myObjVertsUV

protected

temporary vector of UV parameters

◆ myPackedIndices

NCollection_DataMap<Graphic3d_Vec3i, Standard_Integer, ObjVec3iHasher> RWObj_Reader::myPackedIndices

protected

list of external file references

◆ myToAbort

Standard_Boolean RWObj_Reader::myToAbort

protected

flag indicating abort state (e.g. syntax error)

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

RWObj_Reader.hxx

Data Structures

Public Member Functions

Protected Member Functions

implementation details

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RWObj_Reader()

Member Function Documentation

◆ addElement()

◆ addMesh()

◆ addNode()

◆ ExternalFiles()

◆ FileComments()

◆ getNode()

◆ IsSinglePrecision()

◆ MemoryLimit()

◆ NbProbeElems()

◆ NbProbeNodes()

◆ Probe() [1/2]

◆ Probe() [2/2]

◆ Read() [1/2]

◆ Read() [2/2]

◆ read()

◆ SetMemoryLimit()

◆ setNodeNormal()

◆ setNodeUV()

◆ SetSinglePrecision()

◆ SetTransformation()

◆ Transformation()

Field Documentation

◆ myActiveSubMesh

◆ myCSTrsf

◆ myCurrElem

◆ myExternalFiles

◆ myFileComments

◆ myFolder

◆ myMaterials

◆ myMemEstim

◆ myMemLimitBytes

◆ myNbElemsBig

◆ myNbLines

◆ myNbProbeElems

◆ myNbProbeNodes

◆ myObjNorms

◆ myObjVerts

◆ myObjVertsUV

◆ myPackedIndices

◆ myToAbort