Class BlenderLauncher

java.lang.Object

org.web3d.x3d.jsail.BlenderLauncher

public class BlenderLauncher
extends Object

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

See Also:

• Blender
• Blender Quickstart Introduction
• Blender API Introduction
• Blender Python API Documentation
• Scripting & Extending Blender
• Blender 3D: Noob to Pro
• Blender 3D: Noob to Pro/Advanced Tutorials/Python Scripting/Introduction
• Video: Blender Tutorial Introduction to Python Scripting: Writing a Script That Makes a Simple 3D Model
• Java Tutorials: Understanding (Static) Class Members
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLENDER_PATH_DEFAULT_LINUX	Default Blender path default for Linux operating system, possibly unneeded if blender is in path already.
static final String	BLENDER_PATH_DEFAULT_MACOS	Default Blender path default for macOS operating system, possibly unneeded if blender is in path already.
static final String	BLENDER_PATH_DEFAULT_WINDOWS	Default Blender path default for Windows operating system, possibly unneeded if blender is in path already.
static final String	BLENDER_PYTHON_SCRIPT_STL_TO_X3D	Blender python script for converting STL model into X3D model.
static final String	BLENDER_PYTHON_SCRIPT_X3D_TO_PNG	Blender python script for converting X3D model into PNG image.
static final String	BLENDER_URL	Blender website URL
static final String	USAGE	Usage: java [-classpath X3DJSAIL.*.jar] org.web3d.x3d.jsail.BlenderLauncher sourceFile [-convert [resultFile]] [-toImage [snapshotName.*]] [-home | -help | -version | -properties fileName.properties | -BLENDER_PATH directoryPath]

Constructor Summary

Constructors

Constructor	Description
BlenderLauncher()	Default constructor

Method Summary

Modifier and Type	Method	Description
static void	checkBlenderPath()	Check Blender local path and reset to operating system default, if necessary.
static boolean	convertModel(String inputFileName, String outputFileName)	TODO: Use Blender to convert model from one file to another.
static boolean	convertModel(String path, String inputFileName, String outputFileName)	TODO: Use Blender to convert model from one file to another based on filename extensions.
protected static String	executeCommand(String command)	Launch blender in operating system and run command.
static String	exportSTL(X3D modelToExport)	TODO: Use blender to export geometry to STL
static boolean	exportSTLtoFile(X3D modelToExport, String path, String fileName)	TODO: Use blender to export geometry to file
static String	getBlenderAnalytics(X3D modelOfInterest)	TODO: Get Blender metrics for X3D model of interest.
static MetadataSet	getBlenderAnalyticsX3dMetadataSet(X3D modelOfInterest)	TODO: Get Blender metrics as MetadataSet object.
static final String	getBlenderExecutableName()	Get directory path for location of blender program: blender.exe on Windows, blender otherwise.
static String	getBlenderHelp()	Get Blender help.
static final String	getBlenderPath()	Get preference for XSLT transformation engine to use: ConfigurationProperties.XSLT_ENGINE_SAXON or ConfigurationProperties.XSLT_ENGINE_NATIVE_JAVA.
static String	getBlenderVersion()	Get Blender version.
static boolean	hasBlender()	Determine if Blender is locally available.
static X3D	importModel(String path, String fileName)	TODO: Use blender to import model to X3D
static X3D	importSTL(String path, String fileName)	TODO finish: Use blender to import STL geometry as X3D model
static final void	initialize()	Initialize this BlenderLauncher instance to default values.
static void	launchBlenderWebPage()	Open Blender 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	setBlenderPath(String newValue)	Set preference for XSLT transformation engine to use: ConfigurationProperties.XSLT_ENGINE_SAXON or ConfigurationProperties.XSLT_ENGINE_NATIVE_JAVA.
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

BLENDER_URL

public static final String BLENDER_URL

Blender website URL

See Also:

• launchBlenderWebPage()
• Constant Field Values

BLENDER_PATH_DEFAULT_WINDOWS

public static final String BLENDER_PATH_DEFAULT_WINDOWS

Default Blender path default for Windows operating system, possibly unneeded if blender is in path already. Can also set BLENDER_PATH property in X3DJSAIL.properties, or BLENDER_PATH environment variable in operating system. Warning: local settings vary, configure path if necessary.

See Also:

• checkBlenderPath()
• setBlenderPath(String)
• X3DJSAIL documentation: properties
• Blender Command Line
• Blender Download
• Constant Field Values

BLENDER_PATH_DEFAULT_MACOS

public static final String BLENDER_PATH_DEFAULT_MACOS

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

See Also:

• checkBlenderPath()
• setBlenderPath(String)
• X3DJSAIL documentation: properties
• Blender Command Line
• Constant Field Values

BLENDER_PATH_DEFAULT_LINUX

public static final String BLENDER_PATH_DEFAULT_LINUX

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

See Also:

• checkBlenderPath()
• setBlenderPath(String)
• X3DJSAIL documentation: properties
• Blender Command Line
• Constant Field Values

BLENDER_PYTHON_SCRIPT_X3D_TO_PNG

public static final String BLENDER_PYTHON_SCRIPT_X3D_TO_PNG

Blender python script for converting X3D model into PNG image.

See Also:

• Constant Field Values

BLENDER_PYTHON_SCRIPT_STL_TO_X3D

public static final String BLENDER_PYTHON_SCRIPT_STL_TO_X3D

Blender python script for converting STL model into X3D model.

See Also:

• Constant Field Values

USAGE

public static final String USAGE

Usage: java [-classpath X3DJSAIL.*.jar] org.web3d.x3d.jsail.BlenderLauncher sourceFile [-convert [resultFile]] [-toImage [snapshotName.*]] [-home | -help | -version | -properties fileName.properties | -BLENDER_PATH directoryPath]

See Also:

• Constant Field Values

Constructor Details

BlenderLauncher

public BlenderLauncher()

Default constructor

Method Details

getBlenderExecutableName

public static final String getBlenderExecutableName()

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

Returns:

name of blender program

See Also:

• checkBlenderPath()
• setBlenderPath(String)

getBlenderPath

public static final String getBlenderPath()

Get preference for XSLT transformation engine to use: ConfigurationProperties.XSLT_ENGINE_SAXON or ConfigurationProperties.XSLT_ENGINE_NATIVE_JAVA.

Returns:

String constant regarding current configuration: XSLT_ENGINE_SAXON (default) or XSLT_ENGINE_NATIVE_JAVA

setBlenderPath

public static final void setBlenderPath(String newValue)

Set preference for XSLT transformation engine to use: ConfigurationProperties.XSLT_ENGINE_SAXON or ConfigurationProperties.XSLT_ENGINE_NATIVE_JAVA.

Parameters:

newValue - is new value to assign

initialize

public static final void initialize()

Initialize this BlenderLauncher 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[])

launchBlenderWebPage

public static void launchBlenderWebPage()

Open Blender page

See Also:

• Blender
• Wikipedia: Blender (software)
• BLENDER_URL

checkBlenderPath

public static void checkBlenderPath()

Check Blender local path and reset to operating system default, if necessary.

See Also:

• setBlenderPath(String)
• Blender
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments
• Blender Manual: Importing and Exporting Files

wasPriorCommandSuccessful

public static boolean wasPriorCommandSuccessful()

Report whether prior command execution was successful.

Returns:

whether prior command execution was successful.

See Also:

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

executeCommand

protected static String executeCommand(String command)

Launch blender in operating system and run command.

Parameters:

command - Blender invocation

Returns:

console results

See Also:

• Blender
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments
• Blender Manual: Importing and Exporting Files
• 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)

TODO: Use Blender 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)

TODO: Use Blender to convert model from one file to another based on filename extensions.

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 path,
 String fileName)

TODO: Use blender to import model to X3D

Parameters:

path - directory path to file of interest

fileName - for input file

Returns:

result, null if unsuccessful

See Also:

• Blender
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments
• Blender Manual: Importing and Exporting Files

importSTL

public static X3D importSTL(String path,
 String fileName)

TODO finish: Use blender 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:

• Blender
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments
• Blender Manual: Importing and Exporting Files

exportSTL

public static String exportSTL(X3D modelToExport)

TODO: Use blender to export geometry to STL

Parameters:

modelToExport - X3D model of interest

Returns:

plain-text STL file

See Also:

• STL (file format)
• Blender
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments
• Blender Manual: Importing and Exporting Files

exportSTLtoFile

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

TODO: Use blender 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)
• Blender
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments
• Blender Manual: Importing and Exporting Files

getBlenderAnalytics

public static String getBlenderAnalytics(X3D modelOfInterest)

TODO: Get Blender metrics for X3D model of interest.

Parameters:

modelOfInterest - X3D model to analyze

Returns:

Blender output

See Also:

• Blender
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments

getBlenderAnalyticsX3dMetadataSet

public static MetadataSet getBlenderAnalyticsX3dMetadataSet(X3D modelOfInterest)

TODO: Get Blender metrics as MetadataSet object.

Parameters:

modelOfInterest - X3D model to analyze

Returns:

Blender output

See Also:

• Blender Manual: Command Line
• Blender Manual: Command Line Arguments

getBlenderVersion

public static String getBlenderVersion()

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

Returns:

Blender version.

See Also:

• www.blender.org
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments

getBlenderHelp

public static String getBlenderHelp()

Get Blender help. Warning: ensure BLENDER_HOME or local path is set correctly, especially if more than one version is installed.

Returns:

Blender version.

See Also:

• www.blender.org
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments

hasBlender

public static boolean hasBlender()

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

Returns:

whether Blender is found.

See Also:

• www.blender.org
• Blender Manual: Command Line
• Blender Manual: Command Line Arguments