PlySaveOptions

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

public class PlySaveOptions extends SaveOptions

Save options for exporting scene as PLY file.

Constructors

ConstructorDescription
PlySaveOptions()Constructor of PlySaveOptions
PlySaveOptions(FileContentType contentType)Constructor of PlySaveOptions

Methods

MethodDescription
equals(Object arg0)
getAxisSystem()Gets the axis system in the exported stl file.
getClass()
getColorComponents()The component names for vertex color, default value is (“red”, “green”, “blue”)
getEncoding()Gets the default encoding for text-based files.
getExportTextures()Try to copy textures used in scene to output directory.
getFaceElement()The element name for the face data, default value is “face”
getFaceProperty()The property name for the face data, default value is “vertex_index”
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.
getFlipCoordinate()Flip the coordinate while saving the scene, default value is true
getLookupPaths()Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load.
getNormalComponents()The component names for normal data, default value is (“nx”, “ny”, “nz”)
getPointCloud()Export the scene as point cloud, the default value is false.
getPositionComponents()The component names for position data, default value is (“x”, “y”, “z”)
getTextureCoordinateComponents()The component names for texture coordinate data, default value is (“u”, “v”)
getVertexElement()The element name for the vertex data, default value is “vertex”
hashCode()
notify()
notifyAll()
setAxisSystem(AxisSystem value)Sets the axis system in the exported stl file.
setColorComponents(Tuple_3<String,String,String> value)The component names for vertex color, default value is (“red”, “green”, “blue”)
setEncoding(Charset value)Sets the default encoding for text-based files.
setExportTextures(boolean value)Try to copy textures used in scene to output directory.
setFaceElement(String value)The element name for the face data, default value is “face”
setFaceProperty(String value)The property name for the face data, default value is “vertex_index”
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.
setFlipCoordinate(boolean value)Flip the coordinate while saving the scene, default value is true
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.
setNormalComponents(Tuple_3<String,String,String> value)The component names for normal data, default value is (“nx”, “ny”, “nz”)
setPointCloud(boolean value)Export the scene as point cloud, the default value is false.
setPositionComponents(Tuple_3<String,String,String> value)The component names for position data, default value is (“x”, “y”, “z”)
setTextureCoordinateComponents(Tuple_2<String,String> value)The component names for texture coordinate data, default value is (“u”, “v”)
setVertexElement(String value)The element name for the vertex data, default value is “vertex”
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

PlySaveOptions()

public PlySaveOptions()

Constructor of PlySaveOptions

PlySaveOptions(FileContentType contentType)

public PlySaveOptions(FileContentType contentType)

Constructor of PlySaveOptions

Parameters:

ParameterTypeDescription
contentTypeFileContentType

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getAxisSystem()

public AxisSystem getAxisSystem()

Gets the axis system in the exported stl file.

Returns: AxisSystem - the axis system in the exported stl file. Remarks: FlipCoordinateSystem must be enabled to utilize this feature.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getColorComponents()

public Tuple_3<String,String,String> getColorComponents()

The component names for vertex color, default value is (“red”, “green”, “blue”)

Returns: com.aspose.threed.Tuple_3<java.lang.String,java.lang.String,java.lang.String> - The component names for vertex color, default value is (“red”, “green”, “blue”)

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.

getFaceElement()

public String getFaceElement()

The element name for the face data, default value is “face”

Returns: java.lang.String - The element name for the face data, default value is “face”

getFaceProperty()

public String getFaceProperty()

The property name for the face data, default value is “vertex_index”

Returns: java.lang.String - The property name for the face data, default value is “vertex_index”

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.

getFlipCoordinate()

public boolean getFlipCoordinate()

Flip the coordinate while saving the scene, default value is true

Returns: boolean - Flip the coordinate while saving the scene, default value is true

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");

getNormalComponents()

public Tuple_3<String,String,String> getNormalComponents()

The component names for normal data, default value is (“nx”, “ny”, “nz”)

Returns: com.aspose.threed.Tuple_3<java.lang.String,java.lang.String,java.lang.String> - The component names for normal data, default value is (“nx”, “ny”, “nz”)

getPointCloud()

public boolean getPointCloud()

Export the scene as point cloud, the default value is false.

Returns: boolean - Export the scene as point cloud, the default value is false.

getPositionComponents()

public Tuple_3<String,String,String> getPositionComponents()

The component names for position data, default value is (“x”, “y”, “z”)

Returns: com.aspose.threed.Tuple_3<java.lang.String,java.lang.String,java.lang.String> - The component names for position data, default value is (“x”, “y”, “z”)

getTextureCoordinateComponents()

public Tuple_2<String,String> getTextureCoordinateComponents()

The component names for texture coordinate data, default value is (“u”, “v”)

Returns: com.aspose.threed.Tuple_2<java.lang.String,java.lang.String> - The component names for texture coordinate data, default value is (“u”, “v”)

getVertexElement()

public String getVertexElement()

The element name for the vertex data, default value is “vertex”

Returns: java.lang.String - The element name for the vertex data, default value is “vertex”

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAxisSystem(AxisSystem value)

public void setAxisSystem(AxisSystem value)

Sets the axis system in the exported stl file.

Parameters:

ParameterTypeDescription
valueAxisSystemNew value Remarks: FlipCoordinateSystem must be enabled to utilize this feature.

setColorComponents(Tuple_3<String,String,String> value)

public void setColorComponents(Tuple_3<String,String,String> value)

The component names for vertex color, default value is (“red”, “green”, “blue”)

Parameters:

ParameterTypeDescription
valuecom.aspose.threed.Tuple_3<java.lang.String,java.lang.String,java.lang.String>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:

ParameterTypeDescription
valuejava.nio.charset.CharsetNew value

setExportTextures(boolean value)

public void setExportTextures(boolean value)

Try to copy textures used in scene to output directory.

Parameters:

ParameterTypeDescription
valuebooleanNew value

setFaceElement(String value)

public void setFaceElement(String value)

The element name for the face data, default value is “face”

Parameters:

ParameterTypeDescription
valuejava.lang.StringNew value

setFaceProperty(String value)

public void setFaceProperty(String value)

The property name for the face data, default value is “vertex_index”

Parameters:

ParameterTypeDescription
valuejava.lang.StringNew 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:

ParameterTypeDescription
valuejava.lang.StringNew value

setFileSystem(FileSystem value)

public void setFileSystem(FileSystem value)

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

Parameters:

ParameterTypeDescription
valueFileSystemNew 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.


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

public void setFlipCoordinate(boolean value)



Flip the coordinate while saving the scene, default value is true

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | 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”);


### setNormalComponents(Tuple_3<String,String,String> value) {#setNormalComponents-com.aspose.threed.Tuple-3-java.lang.String-java.lang.String-java.lang.String--}

public void setNormalComponents(Tuple_3<String,String,String> value)



The component names for normal data, default value is ("nx", "ny", "nz")

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.threed.Tuple_3<java.lang.String,java.lang.String,java.lang.String> | New value |

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

public void setPointCloud(boolean value)



Export the scene as point cloud, the default value is false.

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

### setPositionComponents(Tuple_3<String,String,String> value) {#setPositionComponents-com.aspose.threed.Tuple-3-java.lang.String-java.lang.String-java.lang.String--}

public void setPositionComponents(Tuple_3<String,String,String> value)



The component names for position data, default value is ("x", "y", "z")

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.threed.Tuple_3<java.lang.String,java.lang.String,java.lang.String> | New value |

### setTextureCoordinateComponents(Tuple_2<String,String> value) {#setTextureCoordinateComponents-com.aspose.threed.Tuple-2-java.lang.String-java.lang.String--}

public void setTextureCoordinateComponents(Tuple_2<String,String> value)



The component names for texture coordinate data, default value is ("u", "v")

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.threed.Tuple_2<java.lang.String,java.lang.String> | New value |

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

public void setVertexElement(String value)



The element name for the vertex data, default value is "vertex"

**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 |  |
PlyLoadOptions PointCloud