PlyFormat

Inheritance: java.lang.Object, com.aspose.threed.FileFormat

public class PlyFormat extends FileFormat

The PLY format.

Fields

FieldDescription
AMFAdditive manufacturing file format
ASE3D Studio Max’s ASCII Scene Exporter format.
ASPOSE3D_WEBAspose.3D Web format.
COLLADACollada file format
DISCREET3DS3D Studio’s file format
DRACOGoogle Draco Mesh
DXFAutoCAD DXF
FBX6100ASCIIASCII FBX file format, with 6.1.0 version
FBX6100_BINARYBinary FBX file format, with 6.1.0 version
FBX7200ASCIIASCII FBX file format, with 7.2.0 version
FBX7200_BINARYBinary FBX file format, with 7.2.0 version
FBX7300ASCIIASCII FBX file format, with 7.3.0 version
FBX7300_BINARYBinary FBX file format, with 7.3.0 version
FBX7400ASCIIASCII FBX file format, with 7.4.0 version
FBX7400_BINARYBinary FBX file format, with 7.4.0 version
FBX7500ASCIIASCII FBX file format, with 7.5.0 version
FBX7500_BINARYBinary FBX file format, with 7.5.0 version
FBX7600ASCIIASCII FBX file format, with 7.6.0 version
FBX7600_BINARYBinary FBX file format, with 7.6.0 version
FBX7700ASCIIASCII FBX file format, with 7.7.0 version
FBX7700_BINARYBinary FBX file format, with 7.7.0 version
GLTFKhronos Group’s glTF
GLTF2Khronos Group’s glTF version 2.0
GLTF2_BINARYKhronos Group’s glTF version 2.0
GLTF_BINARYKhronos Group’s glTF in Binary format
HTML5HTML5 File
IFCISO 16739-1 Industry Foundation Classes data model.
MAYAASCIIAutodesk Maya in ASCII format
MAYA_BINARYAutodesk Maya in Binary format
MICROSOFT3MFMicrosoft 3D Manufacturing Format
PCDPCL Point Cloud Data file in ASCII mode
PCD_BINARYPCL Point Cloud Data file in Binary mode
PDFAdobe’s Portable Document Format
PLYPolygon File Format or Stanford Triangle Format
RVM_BINARYAVEVA Plant Design Management System Model in binary format
RVM_TEXTAVEVA Plant Design Management System Model in text format
SIEMENSJT8Siemens JT File Version 8
SIEMENSJT9Siemens JT File Version 9
STLASCIIASCII STL file format
STL_BINARYBinary STL file format
UNIVERSAL3DUniversal3D file format
USDUniversal Scene Description
USDAUniversal Scene Description in ASCII format.
USDZCompressed Universal Scene Description
VRMLThe Virtual Reality Modeling Language
WAVEFRONTOBJWavefront’s Obj file format
XYZXyz point cloud file
X_BINARYDirectX X File in binary format
X_TEXTDirectX X File in binary format
ZIPZip archive that contains other 3d file format.

Methods

MethodDescription
createLoadOptions()Create a default load options for this file format
createSaveOptions()Create a default save options for this file format
decode(Stream stream)Decode a point cloud or mesh from the specified stream.
decode(Stream stream, PlyLoadOptions opt)Decode a point cloud or mesh from the specified stream.
decode(String fileName)Decode a point cloud or mesh from the specified stream.
decode(String fileName, PlyLoadOptions opt)Decode a point cloud or mesh from the specified stream.
detect(Stream stream, String fileName)Detect the file format from data stream, file name is optional for guessing types that has no magic header.
detect(String fileName)Detect the file format from file name, file must be readable so Aspose.3D can detect the file format through file header.
encode(Entity entity, Stream stream)Encode the entity and save the result into the stream.
encode(Entity entity, Stream stream, PlySaveOptions opt)Encode the entity and save the result into the stream.
encode(Entity entity, String fileName)Encode the entity and save the result into an external file.
encode(Entity entity, String fileName, PlySaveOptions opt)Encode the entity and save the result into an external file.
equals(Object arg0)
getCanExport()Gets whether Aspose.3D supports export scene to current file format.
getCanImport()Gets whether Aspose.3D supports import scene from current file format.
getClass()
getContentType()Gets file format content type Example:
getExtension()Gets the extension name of this type.
getExtensions()Gets the extension names of this type.
getFileFormatType()Gets file format type
getFormatByExtension(String extensionName)Gets the preferred file format from the file extension name The extension name should starts with a dot(’.’).
getVersion()Gets file format version
hashCode()
notify()
notifyAll()
toString()Formats to string
wait()
wait(long arg0)
wait(long arg0, int arg1)

AMF

public static final FileFormat AMF

Additive manufacturing file format

ASE

public static final FileFormat ASE

3D Studio Max’s ASCII Scene Exporter format.

ASPOSE3D_WEB

public static final FileFormat ASPOSE3D_WEB

Aspose.3D Web format.

COLLADA

public static final FileFormat COLLADA

Collada file format

DISCREET3DS

public static final FileFormat DISCREET3DS

3D Studio’s file format

DRACO

public static final DracoFormat DRACO

Google Draco Mesh

DXF

public static final FileFormat DXF

AutoCAD DXF

FBX6100ASCII

public static final FileFormat FBX6100ASCII

ASCII FBX file format, with 6.1.0 version

FBX6100_BINARY

public static final FileFormat FBX6100_BINARY

Binary FBX file format, with 6.1.0 version

FBX7200ASCII

public static final FileFormat FBX7200ASCII

ASCII FBX file format, with 7.2.0 version

FBX7200_BINARY

public static final FileFormat FBX7200_BINARY

Binary FBX file format, with 7.2.0 version

FBX7300ASCII

public static final FileFormat FBX7300ASCII

ASCII FBX file format, with 7.3.0 version

FBX7300_BINARY

public static final FileFormat FBX7300_BINARY

Binary FBX file format, with 7.3.0 version

FBX7400ASCII

public static final FileFormat FBX7400ASCII

ASCII FBX file format, with 7.4.0 version

FBX7400_BINARY

public static final FileFormat FBX7400_BINARY

Binary FBX file format, with 7.4.0 version

FBX7500ASCII

public static final FileFormat FBX7500ASCII

ASCII FBX file format, with 7.5.0 version

FBX7500_BINARY

public static final FileFormat FBX7500_BINARY

Binary FBX file format, with 7.5.0 version

FBX7600ASCII

public static final FileFormat FBX7600ASCII

ASCII FBX file format, with 7.6.0 version

FBX7600_BINARY

public static final FileFormat FBX7600_BINARY

Binary FBX file format, with 7.6.0 version

FBX7700ASCII

public static final FileFormat FBX7700ASCII

ASCII FBX file format, with 7.7.0 version

FBX7700_BINARY

public static final FileFormat FBX7700_BINARY

Binary FBX file format, with 7.7.0 version

GLTF

public static final FileFormat GLTF

Khronos Group’s glTF

GLTF2

public static final FileFormat GLTF2

Khronos Group’s glTF version 2.0

GLTF2_BINARY

public static final FileFormat GLTF2_BINARY

Khronos Group’s glTF version 2.0

GLTF_BINARY

public static final FileFormat GLTF_BINARY

Khronos Group’s glTF in Binary format

HTML5

public static final FileFormat HTML5

HTML5 File

IFC

public static final FileFormat IFC

ISO 16739-1 Industry Foundation Classes data model.

MAYAASCII

public static final FileFormat MAYAASCII

Autodesk Maya in ASCII format

MAYA_BINARY

public static final FileFormat MAYA_BINARY

Autodesk Maya in Binary format

MICROSOFT3MF

public static final FileFormat MICROSOFT3MF

Microsoft 3D Manufacturing Format

PCD

public static final FileFormat PCD

PCL Point Cloud Data file in ASCII mode

PCD_BINARY

public static final FileFormat PCD_BINARY

PCL Point Cloud Data file in Binary mode

PDF

public static final PdfFormat PDF

Adobe’s Portable Document Format

PLY

public static final PlyFormat PLY

Polygon File Format or Stanford Triangle Format

RVM_BINARY

public static final RvmFormat RVM_BINARY

AVEVA Plant Design Management System Model in binary format

RVM_TEXT

public static final RvmFormat RVM_TEXT

AVEVA Plant Design Management System Model in text format

SIEMENSJT8

public static final FileFormat SIEMENSJT8

Siemens JT File Version 8

SIEMENSJT9

public static final FileFormat SIEMENSJT9

Siemens JT File Version 9

STLASCII

public static final FileFormat STLASCII

ASCII STL file format

STL_BINARY

public static final FileFormat STL_BINARY

Binary STL file format

UNIVERSAL3D

public static final FileFormat UNIVERSAL3D

Universal3D file format

USD

public static final FileFormat USD

Universal Scene Description

USDA

public static final FileFormat USDA

Universal Scene Description in ASCII format.

USDZ

public static final FileFormat USDZ

Compressed Universal Scene Description

VRML

public static final FileFormat VRML

The Virtual Reality Modeling Language

WAVEFRONTOBJ

public static final FileFormat WAVEFRONTOBJ

Wavefront’s Obj file format

XYZ

public static final FileFormat XYZ

Xyz point cloud file

X_BINARY

public static final FileFormat X_BINARY

DirectX X File in binary format

X_TEXT

public static final FileFormat X_TEXT

DirectX X File in binary format

ZIP

public static final FileFormat ZIP

Zip archive that contains other 3d file format.

createLoadOptions()

public LoadOptions createLoadOptions()

Create a default load options for this file format

Returns: LoadOptions

createSaveOptions()

public SaveOptions createSaveOptions()

Create a default save options for this file format

Returns: SaveOptions

decode(Stream stream)

public Geometry decode(Stream stream)

Decode a point cloud or mesh from the specified stream.

Parameters:

ParameterTypeDescription
streamcom.aspose.csporter.helpers.StreamThe input stream

Returns: Geometry - A Mesh or PointCloud instance

decode(Stream stream, PlyLoadOptions opt)

public Geometry decode(Stream stream, PlyLoadOptions opt)

Decode a point cloud or mesh from the specified stream.

Parameters:

ParameterTypeDescription
streamcom.aspose.csporter.helpers.StreamThe input stream
optPlyLoadOptionsThe load option of PLY format

Returns: Geometry - A Mesh or PointCloud instance

decode(String fileName)

public Geometry decode(String fileName)

Decode a point cloud or mesh from the specified stream.

Parameters:

ParameterTypeDescription
fileNamejava.lang.StringThe input stream

Returns: Geometry - A Mesh or PointCloud instance

decode(String fileName, PlyLoadOptions opt)

public Geometry decode(String fileName, PlyLoadOptions opt)

Decode a point cloud or mesh from the specified stream.

Parameters:

ParameterTypeDescription
fileNamejava.lang.StringThe input stream
optPlyLoadOptionsThe load option of PLY format

Returns: Geometry - A Mesh or PointCloud instance

detect(Stream stream, String fileName)

public static FileFormat detect(Stream stream, String fileName)

Detect the file format from data stream, file name is optional for guessing types that has no magic header.

Parameters:

ParameterTypeDescription
streamcom.aspose.csporter.helpers.Stream
fileNamejava.lang.StringExample:
byte[] bytes = new byte[100];//take the bytes from your source
     var fmt = FileFormat.detect(new MemoryStream(bytes), "input-file");
     System.out.printf("Input data format: %s", fmt);
``` |

**Returns:**
[FileFormat](../../com.aspose.threed/fileformat)
### detect(String fileName) {#detect-java.lang.String-}

public static FileFormat detect(String fileName)



Detect the file format from file name, file must be readable so Aspose.3D can detect the file format through file header.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | java.lang.String | **Example:**

var fmt = FileFormat.detect(“input.fbx”); System.out.printf(“Input file format: %s”, fmt);


**Returns:**
[FileFormat](../../com.aspose.threed/fileformat)
### encode(Entity entity, Stream stream) {#encode-com.aspose.threed.Entity-com.aspose.csporter.helpers.Stream-}

public void encode(Entity entity, Stream stream)



Encode the entity and save the result into the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| entity | [Entity](../../com.aspose.threed/entity) | The entity to encode |
| stream | com.aspose.csporter.helpers.Stream | The stream to write to, this method will not close this stream |

### encode(Entity entity, Stream stream, PlySaveOptions opt) {#encode-com.aspose.threed.Entity-com.aspose.csporter.helpers.Stream-com.aspose.threed.PlySaveOptions-}

public void encode(Entity entity, Stream stream, PlySaveOptions opt)



Encode the entity and save the result into the stream.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| entity | [Entity](../../com.aspose.threed/entity) | The entity to encode |
| stream | com.aspose.csporter.helpers.Stream | The stream to write to, this method will not close this stream |
| opt | [PlySaveOptions](../../com.aspose.threed/plysaveoptions) | Save options |

### encode(Entity entity, String fileName) {#encode-com.aspose.threed.Entity-java.lang.String-}

public void encode(Entity entity, String fileName)



Encode the entity and save the result into an external file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| entity | [Entity](../../com.aspose.threed/entity) | The entity to encode |
| fileName | java.lang.String | The file to write to |

### encode(Entity entity, String fileName, PlySaveOptions opt) {#encode-com.aspose.threed.Entity-java.lang.String-com.aspose.threed.PlySaveOptions-}

public void encode(Entity entity, String fileName, PlySaveOptions opt)



Encode the entity and save the result into an external file.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| entity | [Entity](../../com.aspose.threed/entity) | The entity to encode |
| fileName | java.lang.String | The file to write to |
| opt | [PlySaveOptions](../../com.aspose.threed/plysaveoptions) | Save options |

### equals(Object arg0) {#equals-java.lang.Object-}

public boolean equals(Object arg0)





**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| arg0 | java.lang.Object |  |

**Returns:**
boolean
### getCanExport() {#getCanExport--}

public boolean getCanExport()



Gets whether Aspose.3D supports export scene to current file format. **Example:** The following code shows how to check if exporting to specified format is supported.

var outputFormat = “.glb”; var format = FileFormat.getFormatByExtension(outputFormat); if (format.getCanExport()) System.out.printf(“Can export to %s”, outputFormat);


**Returns:**
boolean
### getCanImport() {#getCanImport--}

public boolean getCanImport()



Gets whether Aspose.3D supports import scene from current file format. **Example:** The following code shows how to check if importing from specified format is supported.

var outputFormat = “.glb”; var format = FileFormat.getFormatByExtension(outputFormat); if (format.getCanImport()) System.out.printf(“Can import from %s”, outputFormat);


**Returns:**
boolean
### getClass() {#getClass--}

public final native Class getClass()





**Returns:**
java.lang.Class<?>
### getContentType() {#getContentType--}

public FileContentType getContentType()



Gets file format content type **Example:**

var format = FileFormat.MAYA_BINARY; if (format.getContentType() == FileContentType.BINARY) System.out.printf("%s is binary format", format); else System.out.printf("%s is text-based format", format);


**Returns:**
[FileContentType](../../com.aspose.threed/filecontenttype)
### getExtension() {#getExtension--}

public String getExtension()



Gets the extension name of this type. **Example:**

var format = FileFormat.MAYA_BINARY; System.out.printf(“Extension of %s is %s”, format, format.getExtension());


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

public String[] getExtensions()



Gets the extension names of this type.

**Returns:**
java.lang.String[]
### getFileFormatType() {#getFileFormatType--}

public FileFormatType getFileFormatType()



Gets file format type

**Returns:**
[FileFormatType](../../com.aspose.threed/fileformattype)
### getFormatByExtension(String extensionName) {#getFormatByExtension-java.lang.String-}

public static FileFormat getFormatByExtension(String extensionName)



Gets the preferred file format from the file extension name The extension name should starts with a dot('.').

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

**Returns:**
[FileFormat](../../com.aspose.threed/fileformat) - Instance of [FileFormat](../../com.aspose.threed/fileformat), otherwise null returned. **Example:** The following code shows how to save scene to memory using specified format

Scene scene = new Scene(new Box()); var outputFormat = “.glb”; var format = FileFormat.getFormatByExtension(outputFormat); var output = new ByteArrayOutputStream(); try(var stream = Stream.wrap(output)) { scene.save(stream); }

### getVersion() {#getVersion--}

public Version getVersion()



Gets file format version

**Returns:**
com.aspose.csporter.helpers.Version
### hashCode() {#hashCode--}

public native int hashCode()





**Returns:**
int
### notify() {#notify--}

public final native void notify()





### notifyAll() {#notifyAll--}

public final native void notifyAll()





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

public String toString()



Formats to string

**Returns:**
java.lang.String - Object 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 |  |