org.apache.commons.geometry.io.euclidean.threed.obj

Class PolygonObjParser

java.lang.Object

org.apache.commons.geometry.io.euclidean.threed.obj.AbstractObjParser

org.apache.commons.geometry.io.euclidean.threed.obj.PolygonObjParser

public class PolygonObjParser
extends AbstractObjParser

Low-level parser class for reading 3D polygon (face) data in the OBJ file format. This class provides access to OBJ data structures but does not retain any of the parsed data. For example, it is up to callers to store vertices as they are parsed for later reference. This allows callers to determine what values are stored and in what format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PolygonObjParser.Face Class representing an OBJ face definition.
static class	PolygonObjParser.VertexAttributes Class representing a set of attributes for a face vertex.

Constructor Summary

Constructors

Constructor and Description
PolygonObjParser(Reader reader) Construct a new instance for parsing OBJ content from the given reader.
PolygonObjParser(SimpleTextParser parser) Construct a new instance for parsing OBJ content from the given text parser.

Method Summary

Modifier and Type	Method and Description
int	getTextureCoordinateCount() Get the number of texture coordinate keywords parsed so far.
int	getVertexCount() Get the number of vertex keywords parsed so far.
int	getVertexNormalCount() Get the number of vertex normal keywords parsed so far.
protected void	handleKeyword(String keywordValue) Method called when a keyword is encountered in the parsed OBJ content.
boolean	isFailOnNonPolygonKeywords() Return true if the instance is configured to throw an IllegalStateException when OBJ keywords not commonly used with files containing only polygon data are encountered.
PolygonObjParser.Face	readFace() Read an OBJ face definition from the current line.
void	setFailOnNonPolygonKeywords(boolean failOnNonPolygonKeywords) Set the flag determining if the instance should throw an IllegalStateException when encountering keywords not commonly used with OBJ files containing only polygon data.

Methods inherited from class org.apache.commons.geometry.io.euclidean.threed.obj.AbstractObjParser

discardDataLine, discardDataLineWhitespace, getCurrentKeyword, getTextParser, nextDataLineContent, nextDouble, nextKeyword, readDataLine, readDoubles, readVector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolygonObjParser

public PolygonObjParser(Reader reader)

Construct a new instance for parsing OBJ content from the given reader.

Parameters:

reader - reader to parser content from

PolygonObjParser

public PolygonObjParser(SimpleTextParser parser)

Construct a new instance for parsing OBJ content from the given text parser.

Parameters:

parser - text parser to read content from

Method Detail

getVertexCount

public int getVertexCount()

Get the number of vertex keywords parsed so far.

Returns:

the number of vertex keywords parsed so far

getVertexNormalCount

public int getVertexNormalCount()

Get the number of vertex normal keywords parsed so far.

Returns:

the number of vertex normal keywords parsed so far

getTextureCoordinateCount

public int getTextureCoordinateCount()

Get the number of texture coordinate keywords parsed so far.

Returns:

the number of texture coordinate keywords parsed so far

isFailOnNonPolygonKeywords

public boolean isFailOnNonPolygonKeywords()

Return true if the instance is configured to throw an IllegalStateException when OBJ keywords not commonly used with files containing only polygon data are encountered. The default value is false, meaning that no keyword validation is performed. When set to true, only the following keywords are accepted:

• v
• vn
• vt
• f
• o
• g
• s
• mtllib
• usemtl

Returns:

true if the instance is configured to fail when a non-polygon keyword is encountered

setFailOnNonPolygonKeywords

public void setFailOnNonPolygonKeywords(boolean failOnNonPolygonKeywords)

Set the flag determining if the instance should throw an IllegalStateException when encountering keywords not commonly used with OBJ files containing only polygon data. If true, only the following keywords are accepted:

• v
• vn
• vt
• f
• o
• g
• s
• mtllib
• usemtl

If false, all keywords are accepted.

Parameters:

failOnNonPolygonKeywords - new flag value

handleKeyword

protected void handleKeyword(String keywordValue)

Method called when a keyword is encountered in the parsed OBJ content. Subclasses should use this method to validate the keyword and/or update any internal state.

Specified by:

handleKeyword in class AbstractObjParser

Parameters:

keywordValue - keyword encountered in the OBJ content

readFace

public PolygonObjParser.Face readFace()

Read an OBJ face definition from the current line.

Returns:

OBJ face definition read from the current line

Throws:

IllegalStateException - if a face definition is not able to be parsed

UncheckedIOException - if an I/O error occurs