PdfSaveOptions

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

public class PdfSaveOptions extends SaveOptions

The save options in PDF exporting.

Constructors

Constructor	Description
PdfSaveOptions()	Constructor of PdfSaveOptions

Methods

Method	Description
equals(Object arg0)
getAuxiliaryColor()	Gets the auxiliary color to be used when rendering the 3D content.
getBackgroundColor()	Background color of the 3D view in PDF file.
getClass()
getEmbedTextures()	Embed the external textures into the PDF file, default value is false.
getEncoding()	Gets the default encoding for text-based files.
getExportTextures()	Try to copy textures used in scene to output directory.
getFaceColor()	Gets the face color to be used when rendering the 3D content.
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.
getFlipCoordinateSystem()	Gets to flip the coordinate system of the scene during exporting.
getLightingScheme()	LightingScheme specifies the lighting to apply to 3D artwork.
getLookupPaths()	Some files like OBJ depends on external file, the lookup paths will allows Aspose.3D to look for external file to load.
getRenderMode()	Render mode specifies the style in which the 3D artwork is rendered.
hashCode()
notify()
notifyAll()
setAuxiliaryColor(Vector3 value)	Sets the auxiliary color to be used when rendering the 3D content.
setBackgroundColor(Vector3 value)	Background color of the 3D view in PDF file.
setEmbedTextures(boolean value)	Embed the external textures into the PDF file, default value is false.
setEncoding(Charset value)	Sets the default encoding for text-based files.
setExportTextures(boolean value)	Try to copy textures used in scene to output directory.
setFaceColor(Vector3 value)	Sets the face color to be used when rendering the 3D content.
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.
setFlipCoordinateSystem(boolean value)	Sets to flip the coordinate system of the scene during exporting.
setLightingScheme(PdfLightingScheme value)	LightingScheme specifies the lighting to apply to 3D artwork.
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.
setRenderMode(PdfRenderMode value)	Render mode specifies the style in which the 3D artwork is rendered.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

PdfSaveOptions()

public PdfSaveOptions()

Constructor of PdfSaveOptions

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAuxiliaryColor()

public Vector3 getAuxiliaryColor()

Gets the auxiliary color to be used when rendering the 3D content. The interpretation of this color depends on the getRenderMode

Returns: Vector3 - the auxiliary color to be used when rendering the 3D content. The interpretation of this color depends on the getRenderMode

getBackgroundColor()

public Vector3 getBackgroundColor()

Background color of the 3D view in PDF file.

Returns: Vector3 - Background color of the 3D view in PDF file.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getEmbedTextures()

public boolean getEmbedTextures()

Embed the external textures into the PDF file, default value is false.

Returns: boolean - Embed the external textures into the PDF file, 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.

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.

getFaceColor()

public Vector3 getFaceColor()

Gets the face color to be used when rendering the 3D content. This is only relevant only when the getRenderMode has a value of Illustration.

Returns: Vector3 - the face color to be used when rendering the 3D content. This is only relevant only when the getRenderMode has a value of Illustration.

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.

getFlipCoordinateSystem()

public boolean getFlipCoordinateSystem()

Gets to flip the coordinate system of the scene during exporting.

Returns: boolean - to flip the coordinate system of the scene during exporting.

getLightingScheme()

public PdfLightingScheme getLightingScheme()

LightingScheme specifies the lighting to apply to 3D artwork.

Returns: PdfLightingScheme - LightingScheme specifies the lighting to apply to 3D artwork.

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

getRenderMode()

public PdfRenderMode getRenderMode()

Render mode specifies the style in which the 3D artwork is rendered.

Returns: PdfRenderMode - Render mode specifies the style in which the 3D artwork is rendered.

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAuxiliaryColor(Vector3 value)

public void setAuxiliaryColor(Vector3 value)

Sets the auxiliary color to be used when rendering the 3D content. The interpretation of this color depends on the getRenderMode

Parameters:

Parameter	Type	Description
value	Vector3	New value

setBackgroundColor(Vector3 value)

public void setBackgroundColor(Vector3 value)

Background color of the 3D view in PDF file.

Parameters:

Parameter	Type	Description
value	Vector3	New value

setEmbedTextures(boolean value)

public void setEmbedTextures(boolean value)

Embed the external textures into the PDF file, 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

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

setFaceColor(Vector3 value)

public void setFaceColor(Vector3 value)

Sets the face color to be used when rendering the 3D content. This is only relevant only when the getRenderMode has a value of Illustration.

Parameters:

Parameter	Type	Description
value	Vector3	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.


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

public void setFlipCoordinateSystem(boolean value)



Sets to flip the coordinate system of the scene during exporting.

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

### setLightingScheme(PdfLightingScheme value) {#setLightingScheme-com.aspose.threed.PdfLightingScheme-}

public void setLightingScheme(PdfLightingScheme value)



LightingScheme specifies the lighting to apply to 3D artwork.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [PdfLightingScheme](../../com.aspose.threed/pdflightingscheme) | 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”);


### setRenderMode(PdfRenderMode value) {#setRenderMode-com.aspose.threed.PdfRenderMode-}

public void setRenderMode(PdfRenderMode value)



Render mode specifies the style in which the 3D artwork is rendered.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [PdfRenderMode](../../com.aspose.threed/pdfrendermode) | 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 |  |

PdfLoadOptions PhongMaterial