Html5SaveOptions

Inheritance: java.lang.Object, com.aspose.threed.IOConfig, com.aspose.threed.SaveOptions

public class Html5SaveOptions extends SaveOptions

Save options for HTML5

Constructors

Constructor	Description
Html5SaveOptions()	Constructor of Html5SaveOptions with all default settings.

Methods

Method	Description
equals(Object arg0)
getCameraPosition()	Gets the initial position of the camera, default value is (10, 10, 10)
getClass()
getEncoding()	Gets the default encoding for text-based files.
getExportTextures()	Try to copy textures used in scene to output directory.
getFarPlane()	Gets the far plane of the camera, default value is 1000.
getFieldOfView()	Gets the field of the view, default value is 45, measured in degree.
getFileFormat()	Gets the file format that specified in current Save/Load option.
getFileName()	The file name of the exporting/importing scene.
getFileSystem()	Allow user to handle how to manage the external dependencies during load/save.
getFileSystemFactory()	Gets the factory class for FileSystem.
getLookAt()	Gets the default look at position, default value is (0, 0, 0)
getLookupPaths()	Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load.
getNearPlane()	Gets the near plane of the camera, default value is 1
getOrientationBox()	Display a orientation box.
getShowGrid()	Display a grid in the scene.
getShowRulers()	Display rulers of x/y/z axes in the scene to measure the model.
getShowUI()	Display a simple UI in the scene.
getUpVector()	Gets the up vector, value can be “x”/“y”/“z”, default value is “y”
hashCode()
notify()
notifyAll()
setCameraPosition(Vector3 value)	Sets the initial position of the camera, default value is (10, 10, 10)
setEncoding(Charset value)	Sets the default encoding for text-based files.
setExportTextures(boolean value)	Try to copy textures used in scene to output directory.
setFarPlane(double value)	Sets the far plane of the camera, default value is 1000.
setFieldOfView(double value)	Sets the field of the view, default value is 45, measured in degree.
setFileName(String value)	The file name of the exporting/importing scene.
setFileSystem(FileSystem value)	Allow user to handle how to manage the external dependencies during load/save.
setFileSystemFactory(FileSystemFactory value)	Sets the factory class for FileSystem.
setLookAt(Vector3 value)	Sets the default look at position, default value is (0, 0, 0)
setLookupPaths(ArrayList value)	Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load.
setNearPlane(double value)	Sets the near plane of the camera, default value is 1
setOrientationBox(boolean value)	Display a orientation box.
setShowGrid(boolean value)	Display a grid in the scene.
setShowRulers(boolean value)	Display rulers of x/y/z axes in the scene to measure the model.
setShowUI(boolean value)	Display a simple UI in the scene.
setUpVector(String value)	Sets the up vector, value can be “x”/“y”/“z”, default value is “y”
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Html5SaveOptions()

public Html5SaveOptions()

Constructor of Html5SaveOptions with all default settings.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getCameraPosition()

public Vector3 getCameraPosition()

Gets the initial position of the camera, default value is (10, 10, 10)

Returns: Vector3 - the initial position of the camera, default value is (10, 10, 10)

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getEncoding()

public Charset getEncoding()

Gets the default encoding for text-based files. Default value is null which means the importer/exporter will decide which encoding to use.

Returns: java.nio.charset.Charset - the default encoding for text-based files. Default value is null which means the importer/exporter will decide which encoding to use.

getExportTextures()

public boolean getExportTextures()

Try to copy textures used in scene to output directory.

Returns: boolean - Try to copy textures used in scene to output directory.

getFarPlane()

public double getFarPlane()

Gets the far plane of the camera, default value is 1000.

Returns: double - the far plane of the camera, default value is 1000.

getFieldOfView()

public double getFieldOfView()

Gets the field of the view, default value is 45, measured in degree.

Returns: double - the field of the view, default value is 45, measured in degree.

getFileFormat()

public FileFormat getFileFormat()

Gets the file format that specified in current Save/Load option.

Returns: FileFormat - the file format that specified in current Save/Load option.

getFileName()

public String getFileName()

The file name of the exporting/importing scene. This is optional, but useful when serialize external assets like OBJ’s material.

Returns: java.lang.String - The file name of the exporting/importing scene. This is optional, but useful when serialize external assets like OBJ’s material.

getFileSystem()

public FileSystem getFileSystem()

Allow user to handle how to manage the external dependencies during load/save.

Returns: FileSystem - Allow user to handle how to manage the external dependencies during load/save. Example: The default FileSystem is LocalFileSystem, it is not safe in environment like server side, But you can override the file system access by specifying a different implementation. Aspose.3D provides different FileSystem implementation like:

Memory-based file system
Directory-based file system
Dummy file system
Zip file system

And you can also use your own implementation.

Scene scene = new Scene();
             var material = new PhongMaterial();
             var boxNode = scene.getRootNode().createChildNode(new Box());
             boxNode.setMaterial(material);
 
             var opt = new ObjSaveOptions();
             var memFs = new HashMap<string, MemoryStream>();
             opt.setFileSystem(FileSystem.createMemoryFileSystem(memFs));
 			opt.setFileName("output.obj");
             try(var output = new ByteArrayOutputStream()) {
 				scene.save(output, opt);
 				//The material will be written to variable memFs named output.mtl
 				var materialInBytes = memFs["output.mtl"].toArray();
             }

getFileSystemFactory()

public static FileSystemFactory getFileSystemFactory()

Gets the factory class for FileSystem. The default factory will create com.aspose.threed.LocalFileSystem which is not suitable for server environment.

Returns: FileSystemFactory - the factory class for FileSystem. The default factory will create com.aspose.threed.LocalFileSystem which is not suitable for server environment. Example: The default FileSystem in SaveOptions/LoadOptions is directory-based file system, You can override the default implementation by specify it through IOConfig.FileSystemFactory:

IOConfig.setFileSystemFactory(new FileSystemFactory() {
 				@Override
 				public FileSystem call() {
 					return FileSystem.createDummyFileSystem();
 				}
 			});
 
             Scene scene = new Scene();
             var material = new PhongMaterial();
             var boxNode = scene.getRootNode().createChildNode(new Box());
             boxNode.setMaterial(material);
 
             //opt.FileSystem would be dummy file system now
             var opt = new ObjSaveOptions();
             scene.Save("output.obj", opt);
             //the material file output.mtl will not be written to any places because we've configured a dummy file system as default implementation.

getLookAt()

public Vector3 getLookAt()

Gets the default look at position, default value is (0, 0, 0)

Returns: Vector3 - the default look at position, default value is (0, 0, 0)

getLookupPaths()

public ArrayList<String> getLookupPaths()

Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load.

Returns: java.util.ArrayList<java.lang.String> - Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load. Example: The following code shows how to manually specify the look up textures, so the importer can find

var opt = new ObjLoadOptions();
             //Specify the lookup paths, so the textures can be located.
             opt.getLookupPaths().add("textures");
             var scene = Scene.fromFile("input.obj", opt);
             scene.save("output.glb");

getNearPlane()

public double getNearPlane()

Gets the near plane of the camera, default value is 1

Returns: double - the near plane of the camera, default value is 1

getOrientationBox()

public boolean getOrientationBox()

Display a orientation box. Default value is true.

Returns: boolean - Display a orientation box. Default value is true.

getShowGrid()

public boolean getShowGrid()

Display a grid in the scene. Default value is true.

Returns: boolean - Display a grid in the scene. Default value is true.

getShowRulers()

public boolean getShowRulers()

Display rulers of x/y/z axes in the scene to measure the model. Default value is false.

Returns: boolean - Display rulers of x/y/z axes in the scene to measure the model. Default value is false.

getShowUI()

public boolean getShowUI()

Display a simple UI in the scene. Default value is true.

Returns: boolean - Display a simple UI in the scene. Default value is true.

getUpVector()

public String getUpVector()

Gets the up vector, value can be “x”/“y”/“z”, default value is “y”

Returns: java.lang.String - the up vector, value can be “x”/“y”/“z”, default value is “y”

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCameraPosition(Vector3 value)

public void setCameraPosition(Vector3 value)

Sets the initial position of the camera, default value is (10, 10, 10)

Parameters:

Parameter	Type	Description
value	Vector3	New value

setEncoding(Charset value)

public void setEncoding(Charset value)

Sets the default encoding for text-based files. Default value is null which means the importer/exporter will decide which encoding to use.

Parameters:

Parameter	Type	Description
value	java.nio.charset.Charset	New value

setExportTextures(boolean value)

public void setExportTextures(boolean value)

Try to copy textures used in scene to output directory.

Parameters:

Parameter	Type	Description
value	boolean	New value

setFarPlane(double value)

public void setFarPlane(double value)

Sets the far plane of the camera, default value is 1000.

Parameters:

Parameter	Type	Description
value	double	New value

setFieldOfView(double value)

public void setFieldOfView(double value)

Sets the field of the view, default value is 45, measured in degree.

Parameters:

Parameter	Type	Description
value	double	New value

setFileName(String value)

public void setFileName(String value)

The file name of the exporting/importing scene. This is optional, but useful when serialize external assets like OBJ’s material.

Parameters:

Parameter	Type	Description
value	java.lang.String	New value

setFileSystem(FileSystem value)

public void setFileSystem(FileSystem value)

Allow user to handle how to manage the external dependencies during load/save.

Parameters:

Parameter	Type	Description
value	FileSystem	New value Example: The default FileSystem is LocalFileSystem, it is not safe in environment like server side, But you can override the file system access by specifying a different implementation. Aspose.3D provides different FileSystem implementation like:

Memory-based file system
Directory-based file system
Dummy file system
Zip file system

And you can also use your own implementation.

Scene scene = new Scene();
             var material = new PhongMaterial();
             var boxNode = scene.getRootNode().createChildNode(new Box());
             boxNode.setMaterial(material);
 
             var opt = new ObjSaveOptions();
             var memFs = new HashMap<string, MemoryStream>();
             opt.setFileSystem(FileSystem.createMemoryFileSystem(memFs));
 			opt.setFileName("output.obj");
             try(var output = new ByteArrayOutputStream()) {
 				scene.save(output, opt);
 				//The material will be written to variable memFs named output.mtl
 				var materialInBytes = memFs["output.mtl"].toArray();
             }
``` |

### setFileSystemFactory(FileSystemFactory value) {#setFileSystemFactory-com.aspose.threed.FileSystemFactory-}

public static void setFileSystemFactory(FileSystemFactory value)



Sets the factory class for FileSystem. The default factory will create com.aspose.threed.LocalFileSystem which is not suitable for server environment.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [FileSystemFactory](../../com.aspose.threed/filesystemfactory) | New value **Example:** The default FileSystem in SaveOptions/LoadOptions is directory-based file system, You can override the default implementation by specify it through IOConfig.FileSystemFactory:

IOConfig.setFileSystemFactory(new FileSystemFactory() { @Override public FileSystem call() { return FileSystem.createDummyFileSystem(); } });

         Scene scene = new Scene();
         var material = new PhongMaterial();
         var boxNode = scene.getRootNode().createChildNode(new Box());
         boxNode.setMaterial(material);

         //opt.FileSystem would be dummy file system now
         var opt = new ObjSaveOptions();
         scene.Save("output.obj", opt);
         //the material file output.mtl will not be written to any places because we've configured a dummy file system as default implementation.


### setLookAt(Vector3 value) {#setLookAt-com.aspose.threed.Vector3-}

public void setLookAt(Vector3 value)



Sets the default look at position, default value is (0, 0, 0)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [Vector3](../../com.aspose.threed/vector3) | New value |

### setLookupPaths(ArrayList<String> value) {#setLookupPaths-java.util.ArrayList-java.lang.String--}

public void setLookupPaths(ArrayList value)



Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.ArrayList<java.lang.String> | New value **Example:** The following code shows how to manually specify the look up textures, so the importer can find

var opt = new ObjLoadOptions(); //Specify the lookup paths, so the textures can be located. opt.getLookupPaths().add(“textures”); var scene = Scene.fromFile(“input.obj”, opt); scene.save(“output.glb”);


### setNearPlane(double value) {#setNearPlane-double-}

public void setNearPlane(double value)



Sets the near plane of the camera, default value is 1

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | double | New value |

### setOrientationBox(boolean value) {#setOrientationBox-boolean-}

public void setOrientationBox(boolean value)



Display a orientation box. Default value is true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | New value |

### setShowGrid(boolean value) {#setShowGrid-boolean-}

public void setShowGrid(boolean value)



Display a grid in the scene. Default value is true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | New value |

### setShowRulers(boolean value) {#setShowRulers-boolean-}

public void setShowRulers(boolean value)



Display rulers of x/y/z axes in the scene to measure the model. Default value is false.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | New value |

### setShowUI(boolean value) {#setShowUI-boolean-}

public void setShowUI(boolean value)



Display a simple UI in the scene. Default value is true.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | New value |

### setUpVector(String value) {#setUpVector-java.lang.String-}

public void setUpVector(String value)



Sets the up vector, value can be "x"/"y"/"z", default value is "y"

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.lang.String | New value |

### toString() {#toString--}

public String toString()





**Returns:**
java.lang.String
### wait() {#wait--}

public final void wait()





### wait(long arg0) {#wait-long-}

public final void wait(long arg0)





**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arg0 | long |  |

### wait(long arg0, int arg1) {#wait-long-int-}

public final void wait(long arg0, int arg1)





**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arg0 | long |  |
| arg1 | int |  |

HollowRectangleShape IOConfig