com.io7m.jobj.core

Interface JOParserEventListenerType

public interface JOParserEventListenerType

The type of parser event listeners.

Method Summary

Modifier and Type	Method and Description
void	onCommandFFinished(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index) An f command was completed successfully.
void	onCommandFStarted(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index) An f command was encountered.
void	onCommandFVertexV_VN(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index, int v, int vn) A v//vn vertex was specified for an f command.
void	onCommandFVertexV_VT_VN(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index, int v, int vt, int vn) A v/vt/vn vertex was specified for an f command.
void	onCommandFVertexV_VT(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index, int v, int vt) A v/vt/ vertex was specified for an f command.
void	onCommandFVertexV(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index, int v) A v// vertex was specified for an f command.
void	onCommandMtllib(com.io7m.jlexing.core.LexicalPositionType<Path> p, String name) An mtllib command was encountered.
void	onCommandO(com.io7m.jlexing.core.LexicalPositionType<Path> p, String name) An o command was encountered.
void	onCommandS(com.io7m.jlexing.core.LexicalPositionType<Path> p, int group_number) An s command was encountered.
void	onCommandUsemtl(com.io7m.jlexing.core.LexicalPositionType<Path> p, String name) A usemtl command was encountered.
void	onCommandV(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index, double x, double y, double z, double w) A v command was encountered.
void	onCommandVN(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index, double x, double y, double z) A vn command was encountered.
void	onCommandVT(com.io7m.jlexing.core.LexicalPositionType<Path> p, int index, double x, double y, double z) A vt command was encountered.
void	onComment(com.io7m.jlexing.core.LexicalPositionType<Path> p, String text) A comment was encountered.
void	onEOF(com.io7m.jlexing.core.LexicalPositionType<Path> p) EOF has been reached.
void	onError(com.io7m.jlexing.core.LexicalPositionType<Path> p, JOParserErrorCode e, String message) A non-fatal error has occurred.
void	onFatalError(com.io7m.jlexing.core.LexicalPositionType<Path> p, Optional<Throwable> e, String message) A fatal error has occurred.
void	onLine(com.io7m.jlexing.core.LexicalPositionType<Path> p, String line) The given line is about to be parsed.

Method Detail

onFatalError

void onFatalError(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                  Optional<Throwable> e,
                  String message)

A fatal error has occurred. Parsing will cease when this method returns (if it returns).

Parameters:

p - The lexical position

e - The exception, if any

message - The error message

onError

void onError(com.io7m.jlexing.core.LexicalPositionType<Path> p,
             JOParserErrorCode e,
             String message)

A non-fatal error has occurred.

Parameters:

p - The lexical position

e - The error code

message - The error message

onLine

void onLine(com.io7m.jlexing.core.LexicalPositionType<Path> p,
            String line)

The given line is about to be parsed.

Parameters:

p - The lexical position

line - The line

onEOF

void onEOF(com.io7m.jlexing.core.LexicalPositionType<Path> p)

EOF has been reached.

Parameters:

p - The lexical position

onComment

void onComment(com.io7m.jlexing.core.LexicalPositionType<Path> p,
               String text)

A comment was encountered.

Parameters:

p - The lexical position

text - The comment text (including '#')

onCommandUsemtl

void onCommandUsemtl(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                     String name)

A usemtl command was encountered.

Parameters:

p - The lexical position

name - The material name

onCommandMtllib

void onCommandMtllib(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                     String name)

An mtllib command was encountered.

Parameters:

p - The lexical position

name - The material file name

onCommandO

void onCommandO(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                String name)

An o command was encountered.

Parameters:

p - The lexical position

name - The object name

onCommandS

void onCommandS(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                int group_number)

An s command was encountered.

Parameters:

p - The lexical position

group_number - The group number

onCommandV

void onCommandV(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                int index,
                double x,
                double y,
                double z,
                double w)

A v command was encountered.

Parameters:

p - The lexical position

index - The index

x - The X value

y - The Y value

z - The Z value

w - The W value

onCommandVN

void onCommandVN(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                 int index,
                 double x,
                 double y,
                 double z)

A vn command was encountered.

Parameters:

p - The lexical position

index - The index

x - The X value

y - The Y value

z - The Z value

onCommandVT

void onCommandVT(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                 int index,
                 double x,
                 double y,
                 double z)

A vt command was encountered.

Parameters:

p - The lexical position

index - The index

x - The X value

y - The Y value

z - The Z value

onCommandFVertexV_VT_VN

void onCommandFVertexV_VT_VN(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                             int index,
                             int v,
                             int vt,
                             int vn)

A v/vt/vn vertex was specified for an f command.

Parameters:

p - The lexical position

index - The index

v - The v value

vt - The vt value

vn - The vn value

onCommandFVertexV_VT

void onCommandFVertexV_VT(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                          int index,
                          int v,
                          int vt)

A v/vt/ vertex was specified for an f command.

Parameters:

p - The lexical position

index - The index

v - The v value

vt - The vt value

onCommandFVertexV_VN

void onCommandFVertexV_VN(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                          int index,
                          int v,
                          int vn)

A v//vn vertex was specified for an f command.

Parameters:

p - The lexical position

index - The index

v - The v value

vn - The vn value

onCommandFVertexV

void onCommandFVertexV(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                       int index,
                       int v)

A v// vertex was specified for an f command.

Parameters:

p - The lexical position

index - The index

v - The v value

onCommandFStarted

void onCommandFStarted(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                       int index)

An f command was encountered. Vertices will be delivered via the FVertex* methods, with (LexicalPositionType, int) signalling the end of the face. If any errors are encountered during parsing of vertices, (LexicalPositionType, JOParserErrorCode, String) will be called instead of onCommandFFinished(LexicalPositionType, int).

Parameters:

p - The lexical position

index - The index

See Also:

onCommandFVertexV(LexicalPositionType, int, int), onCommandFVertexV_VN(LexicalPositionType, int, int, int), onCommandFVertexV_VT(LexicalPositionType, int, int, int), onCommandFVertexV_VT_VN(LexicalPositionType, int, int, int, int), onCommandFFinished(LexicalPositionType, int)

onCommandFFinished

void onCommandFFinished(com.io7m.jlexing.core.LexicalPositionType<Path> p,
                        int index)

An f command was completed successfully.

Parameters:

p - The lexical position

index - The index