Package org.web3d.x3d.jsail

Class MeshLabLauncher

java.lang.Object

org.web3d.x3d.jsail.MeshLabLauncher

public class MeshLabLauncher
extends Object

Utility class for invoking and launching MeshLab via local operating system to perform a variety of conversion tasks. Note use of static methods.

See Also:

• STL (file format)
• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python
• SourceForge: meshlab in command-line?
• SourceForge: Automating Meshlab conversion
• GitHub: meshlabserver.txt command-line help
• GitHub: TheNerdJedi/MeshlabAuto
• Mr. P. MeshLab Tutorials: MeshLab Basics
• Mr. P. MeshLab Tutorials: 3D Scanning pipeline
• Mr. P. MeshLab Tutorials: Features
• Mr. P. MeshLab Tutorials: Cleaning
• StackOverflow: MeshLab
• GitHub: MeshlabAuto
• GitHub: issues
• MeshLab References
• Java Tutorials: Understanding (Static) Class Members
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESHLAB_PATH_DEFAULT_LINUX	Default MeshLab path default for Linux operating system, possibly unneeded if meshlabserver is in path already.
static final String	MESHLAB_PATH_DEFAULT_MACOS	Default MeshLab path default for macOS operating system, possibly unneeded if meshlabserver is in path already.
static final String	MESHLAB_PATH_DEFAULT_WINDOWS	Default MeshLab path default for Windows operating system.
static final String	MESHLAB_URL	MeshLab website URL
static final String	MESHLABSERVER_ERROR_NOTICE	meshlabserver warning
static final String	USAGE	Usage: java [-classpath X3DJSAIL.*.jar] org.web3d.x3d.jsail.MeshLabLauncher sourceFile [-convert [resultFile]] [-home | -help | -properties fileName.properties | -MESHLAB_PATH directoryPath]

Constructor Summary

Constructors

Constructor	Description
MeshLabLauncher()

Method Summary

Modifier and Type	Method	Description
static void	checkMeshLabPath()	Check MeshLab local path and also executable name, reset to operating system defaults if necessary.
static boolean	convertModel(String inputFileName, String outputFileName)	Use meshLab to convert model from one file to another.
static boolean	convertModel(String path, String inputFileName, String outputFileName)	Use meshLab to convert model from one file to another.
protected static String	executeCommand(String command)	Launch MeshLab in operating system and run command.
static boolean	exportModelToFile(X3D modelToExport, String path, String fileName)	TODO: Use MeshLab to export geometry to STL
static boolean	exportSTLtoFile(X3D modelToExport, String path, String fileName)	TODO: Use MeshLab to export geometry to file
static String	getMeshLabAnalytics(X3D modelOfInterest)	TODO: Get MeshLab metrics for X3D model of interest.
static MetadataSet	getMeshLabAnalyticsX3dMetadataSet(X3D modelOfInterest)	TODO: Get MeshLab metrics as MetadataSet object.
static String	getMeshLabHelp()	Get default MeshLab help message (from invocation without command-line parameters).
static final String	getMeshLabPath()	Get directory path for location of meshlabserver program.
static final String	getMeshLabServerExecutableName()	Get directory path for location of meshlabserver program: meshlabserver.exe on Windows, meshlabserver otherwise.
static String	getMeshLabVersion()	Get MeshLab version.
static String	getPriorMeshLabTraceLogContents()	Get contents of MeshLab trace log file produced during most recent MeshLab operation.
static String	getPriorMeshLabTraceLogFilePath()	Get name of MeshLab trace log file produced during most recent MeshLab operation.
static boolean	hasMeshLab()	Determine if MeshLab is locally available.
static X3D	importModel(String fileName)	Use meshLab to import model to X3D.
static X3D	importModel(String path, String fileName)	Use meshLab to import model to X3D.
X3D	importSTL(String path, String fileName)	TODO: Use meshLab to import STL geometry as X3D model
static final void	initialize()	Initialize this MeshLabLauncher instance to default values.
static void	launchMeshLabWebPage()	Open MeshLab page
static void	main(String[] args)	Default main() method provided for test and debugging purposes, invoking run() method.
static void	run(String singleStringArguments)	Utility run() method provided for test and debugging purposes, allowing invocation with a single String (rather than a String[] array).
static void	run(String[] args)	Default run() method provided for test and debugging purposes, first initializing ConfigurationProperties then reading properties file (if any) and processing arguments.
static final void	setMeshLabPath(String newValue)	Set directory path for location of meshlabserver program.
static final void	setMeshLabServerExecutableName(String newValue)	Set meshLabServerExecutableName for alternate name of meshlabserver program.
static void	setPriorMeshLabTraceLogFilePath(String value)	Set name of MeshLab trace log file produced during most recent MeshLab operation.
static boolean	wasPriorCommandSuccessful()	Report whether prior command execution was successful.

Methods inherited from class java.lang.Object

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

Field Details

MESHLAB_URL

public static final String MESHLAB_URL

MeshLab website URL

See Also:

• launchMeshLabWebPage()
• Constant Field Values

MESHLABSERVER_ERROR_NOTICE

public static final String MESHLABSERVER_ERROR_NOTICE

meshlabserver warning

See Also:

• launchMeshLabWebPage()
• Constant Field Values

MESHLAB_PATH_DEFAULT_WINDOWS

public static final String MESHLAB_PATH_DEFAULT_WINDOWS

Default MeshLab path default for Windows operating system. Can also set MESHLAB_PATH environment variable in operating system. Warning: local settings vary, configure path if necessary.

See Also:

• checkMeshLabPath()
• setMeshLabPath(String)
• X3DJSAIL documentation: properties
• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python
• Constant Field Values

MESHLAB_PATH_DEFAULT_MACOS

public static final String MESHLAB_PATH_DEFAULT_MACOS

Default MeshLab path default for macOS operating system, possibly unneeded if meshlabserver is in path already. Warning: local settings vary, configure path if necessary.

See Also:

• checkMeshLabPath()
• setMeshLabPath(String)
• X3DJSAIL documentation: properties
• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python
• Constant Field Values

MESHLAB_PATH_DEFAULT_LINUX

public static final String MESHLAB_PATH_DEFAULT_LINUX

Default MeshLab path default for Linux operating system, possibly unneeded if meshlabserver is in path already. Warning: local settings vary, configure path if necessary.

See Also:

• checkMeshLabPath()
• setMeshLabPath(String)
• X3DJSAIL documentation: properties
• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python
• Constant Field Values

USAGE

public static final String USAGE

Usage: java [-classpath X3DJSAIL.*.jar] org.web3d.x3d.jsail.MeshLabLauncher sourceFile [-convert [resultFile]] [-home | -help | -properties fileName.properties | -MESHLAB_PATH directoryPath]

See Also:

• Constant Field Values

Constructor Details

MeshLabLauncher

public MeshLabLauncher()

Method Details

getMeshLabServerExecutableName

public static final String getMeshLabServerExecutableName()

Get directory path for location of meshlabserver program: meshlabserver.exe on Windows, meshlabserver otherwise.

Returns:

name of meshlabserver program

See Also:

• checkMeshLabPath()
• setMeshLabPath(String)

setMeshLabServerExecutableName

public static final void setMeshLabServerExecutableName(String newValue)

Set meshLabServerExecutableName for alternate name of meshlabserver program.

Parameters:

newValue - is new value to assign `

getMeshLabPath

public static final String getMeshLabPath()

Get directory path for location of meshlabserver program.

Returns:

directory path for location of meshlabserver program

setMeshLabPath

public static final void setMeshLabPath(String newValue)

Set directory path for location of meshlabserver program.

Parameters:

newValue - is new value to assign

checkMeshLabPath

public static void checkMeshLabPath()

Check MeshLab local path and also executable name, reset to operating system defaults if necessary. Executable name: meshlabserver.exe on Windows, meshlabserver otherwise.

See Also:

• checkMeshLabPath()
• setMeshLabPath(String)
• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python
• getMeshLabServerExecutableName()
• setMeshLabServerExecutableName(String)

wasPriorCommandSuccessful

public static boolean wasPriorCommandSuccessful()

Report whether prior command execution was successful.

Returns:

whether prior command execution was successful. [warning] meshlabserver may popup an exception window while running headless (not very smart) which can cause exception to be lost following timeout.

See Also:

• StackOverflow: possible to capture pop-up message box?

executeCommand

protected static String executeCommand(String command)

Launch MeshLab in operating system and run command. [warning] meshlabserver may popup an exception window while running headless (not very smart) which can cause exception to be lost following timeout.

Parameters:

command - MeshLab invocation

Returns:

console results

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python
• StackOverflow: possible to capture pop-up message box?
• Why does Runtime.exec(String) work for some but not all commands?
• StackOverflow: Runtime.getRuntime().exec(cmd) hanging
• StackOverflow: Executing another application from Java
• java.lang.Runtime
• java.lang.ProcessBuilder

convertModel

public static boolean convertModel(String inputFileName,
 String outputFileName)

Use meshLab to convert model from one file to another.

Parameters:

inputFileName - for input file

outputFileName - for output file

Returns:

whether successful

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

convertModel

public static boolean convertModel(String path,
 String inputFileName,
 String outputFileName)

Use meshLab to convert model from one file to another.

Parameters:

path - directory path to file of interest

inputFileName - for input file

outputFileName - for output file

Returns:

whether successful

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

importModel

public static X3D importModel(String fileName)

Use meshLab to import model to X3D.

Parameters:

fileName - for input file

Returns:

result, null if unsuccessful

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

importModel

public static X3D importModel(String path,
 String fileName)

Use meshLab to import model to X3D.

Parameters:

path - directory path to file of interest

fileName - for input file

Returns:

result, null if unsuccessful

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

importSTL

public X3D importSTL(String path,
 String fileName)

TODO: Use meshLab to import STL geometry as X3D model

Parameters:

path - directory path to file of interest

fileName - for input file

Returns:

result, null if unsuccessful

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

exportModelToFile

public static boolean exportModelToFile(X3D modelToExport,
 String path,
 String fileName)

TODO: Use MeshLab to export geometry to STL

Parameters:

modelToExport - X3D model of interest

path - directory path for X3D model of interest

fileName - file name for X3D model of interest

Returns:

plain-text STL file

See Also:

• STL (file format)
• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

exportSTLtoFile

public static boolean exportSTLtoFile(X3D modelToExport,
 String path,
 String fileName)

TODO: Use MeshLab to export geometry to file

Parameters:

modelToExport - X3D model of interest

path - directory path to file of interest

fileName - for output file

Returns:

whether successful

See Also:

• STL (file format)
• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

getMeshLabAnalytics

public static String getMeshLabAnalytics(X3D modelOfInterest)

TODO: Get MeshLab metrics for X3D model of interest.

Parameters:

modelOfInterest - X3D model to analyze

Returns:

MeshLab output

See Also:

• STL (file format)
• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

getMeshLabAnalyticsX3dMetadataSet

public static MetadataSet getMeshLabAnalyticsX3dMetadataSet(X3D modelOfInterest)

TODO: Get MeshLab metrics as MetadataSet object.

Parameters:

modelOfInterest - X3D model to analyze

Returns:

MeshLab output

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

getMeshLabVersion

public static String getMeshLabVersion()

Get MeshLab version. Warning: ensure MESHLAB_HOME or local path is set correctly, especially if more than one version is installed.

Returns:

MeshLab version.

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

hasMeshLab

public static boolean hasMeshLab()

Determine if MeshLab is locally available. Warning: ensure MESHLAB_HOME or local path is set correctly, especially if more than one version is installed.

Returns:

whether MeshLab is found.

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

getMeshLabHelp

public static String getMeshLabHelp()

Get default MeshLab help message (from invocation without command-line parameters).

Returns:

MeshLab help message.

See Also:

• MeshLab
• Wikipedia: MeshLab
• PyMeshLab for Python

getPriorMeshLabTraceLogFilePath

public static String getPriorMeshLabTraceLogFilePath()

Get name of MeshLab trace log file produced during most recent MeshLab operation.

Returns:

name of most recent MeshLab trace log file

setPriorMeshLabTraceLogFilePath

public static void setPriorMeshLabTraceLogFilePath(String value)

Set name of MeshLab trace log file produced during most recent MeshLab operation.

Parameters:

value - new path and file name for meshLabTraceLogFilePath

getPriorMeshLabTraceLogContents

public static String getPriorMeshLabTraceLogContents()

Get contents of MeshLab trace log file produced during most recent MeshLab operation.

Returns:

contents of most recent MeshLab trace log file

initialize

public static final void initialize()

Initialize this MeshLabLauncher instance to default values.

main

public static void main(String[] args)

Default main() method provided for test and debugging purposes, invoking run() method.

Parameters:

args - the command line arguments

See Also:

• run(String[])
• X3D.handleArguments(String[])

run

public static void run(String singleStringArguments)

Utility run() method provided for test and debugging purposes, allowing invocation with a single String (rather than a String[] array). When invoked without parameters then reports results of validate() self-checks to system output.

Parameters:

singleStringArguments - the command line arguments

See Also:

• run(String[])

run

public static void run(String[] args)

Default run() method provided for test and debugging purposes, first initializing ConfigurationProperties then reading properties file (if any) and processing arguments. When invoked without parameters then reports results of validate() self-checks to system output.

Parameters:

args - the command line arguments

See Also:

• main(String[])
• ConfigurationProperties
• X3D.handleArguments(String[])

launchMeshLabWebPage

public static void launchMeshLabWebPage()

Open MeshLab page

See Also:

• https://www.MeshLab.net
• MESHLAB_URL