FbxLoadOptions
Inheritance: java.lang.Object, com.aspose.threed.IOConfig, com.aspose.threed.LoadOptions
public class FbxLoadOptions extends LoadOptions
Load options for Fbx format.
Constructors
Constructor | Description |
---|---|
FbxLoadOptions(FileFormat format) | Constructor of FbxLoadOptions |
FbxLoadOptions() | Constructor of FbxLoadOptions |
Methods
Method | Description |
---|---|
equals(Object arg0) | |
getClass() | |
getCompatibleMode() | Gets whether to enable compatible mode. |
getEncoding() | Gets the default encoding for text-based files. |
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. |
getKeepBuiltinGlobalSettings() | Gets whether to keep the builtin properties in GlobalSettings which have a native property replacement in AssetInfo. |
getLookupPaths() | Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load. |
hashCode() | |
notify() | |
notifyAll() | |
setCompatibleMode(boolean value) | Sets whether to enable compatible mode. |
setEncoding(Charset value) | Sets the default encoding for text-based files. |
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. |
setKeepBuiltinGlobalSettings(boolean value) | Sets whether to keep the builtin properties in GlobalSettings which have a native property replacement in AssetInfo. |
setLookupPaths(ArrayList | Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load. |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
FbxLoadOptions(FileFormat format)
public FbxLoadOptions(FileFormat format)
Constructor of FbxLoadOptions
Parameters:
Parameter | Type | Description |
---|---|---|
format | FileFormat | Instance of getFileFormat, it should be a valid FBX format. |
FbxLoadOptions()
public FbxLoadOptions()
Constructor of FbxLoadOptions
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
Parameter | Type | Description |
---|---|---|
arg0 | java.lang.Object |
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCompatibleMode()
public boolean getCompatibleMode()
Gets whether to enable compatible mode. Compatible mode will try to support non-standard FBX definitions like PBR materials exported by Blender. Default value is false.
Returns: boolean - whether to enable compatible mode. Compatible mode will try to support non-standard FBX definitions like PBR materials exported by Blender. Default value is false.
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.
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.
getKeepBuiltinGlobalSettings()
public boolean getKeepBuiltinGlobalSettings()
Gets whether to keep the builtin properties in GlobalSettings which have a native property replacement in AssetInfo. Set this to true if you want the full properties in GlobalSettings Default value is false
Returns: boolean - whether to keep the builtin properties in GlobalSettings which have a native property replacement in AssetInfo. Set this to true if you want the full properties in GlobalSettings Default value is false
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");
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setCompatibleMode(boolean value)
public void setCompatibleMode(boolean value)
Sets whether to enable compatible mode. Compatible mode will try to support non-standard FBX definitions like PBR materials exported by Blender. Default value is false.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | 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 |
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.
### setKeepBuiltinGlobalSettings(boolean value) {#setKeepBuiltinGlobalSettings-boolean-}
public void setKeepBuiltinGlobalSettings(boolean value)
Sets whether to keep the builtin properties in GlobalSettings which have a native property replacement in [AssetInfo](../../com.aspose.threed/assetinfo). Set this to true if you want the full properties in GlobalSettings Default value is false
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | New value |
### setLookupPaths(ArrayList<String> value) {#setLookupPaths-java.util.ArrayList-java.lang.String--}
public void setLookupPaths(ArrayList
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”);
### 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 | |