Skip to content

Commit

Permalink
Update file(s) "/." from "aspose-3d/Aspose.3D-API-References"
Browse files Browse the repository at this point in the history
  • Loading branch information
lexchou-aspose committed Jan 9, 2025
1 parent dbc2891 commit 50a46e3
Show file tree
Hide file tree
Showing 3,824 changed files with 20,371 additions and 8,080 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
16 changes: 8 additions & 8 deletions content/sites/aspose/3d/english/java/com.aspose.threed/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@ url: /java/com.aspose.threed/
| [BindPoint](../com.aspose.threed/bindpoint) | A [BindPoint](../com.aspose.threed/bindpoint) is usually created on an object's property, some property types contains multiple component fields(like a Vector3 field), [BindPoint](../com.aspose.threed/bindpoint) will generate channel for each component field and connects the field to one or more keyframe sequence instance(s) through the channels. |
| [Bone](../com.aspose.threed/bone) | A bone defines the subset of the geometry's control point, and defined blend weight for each control point. |
| [BonePose](../com.aspose.threed/bonepose) | The [BonePose](../com.aspose.threed/bonepose) contains the transformation matrix for a bone node |
| [BoundingBox](../com.aspose.threed/boundingbox) | The axis-aligned bounding box |
| [BoundingBox](../com.aspose.threed/boundingbox) | The axis-aligned bounding box **Example:** The following code shows how to get a bounding box from an Entity instance. |
| [BoundingBox2D](../com.aspose.threed/boundingbox2d) | The axis-aligned bounding box for [Vector2](../com.aspose.threed/vector2) |
| [Box](../com.aspose.threed/box) | Box. |
| [CShape](../com.aspose.threed/cshape) | IFC compatible C-shape profile that defined by parameters. |
| [Camera](../com.aspose.threed/camera) | The camera describes the eye point of the viewer looking at the scene. |
| [Cancellation](../com.aspose.threed/cancellation) | This class allows you to manually abort a load/save task. |
| [CenterLineProfile](../com.aspose.threed/centerlineprofile) | IFC compatible center line profile |
| [Circle](../com.aspose.threed/circle) | A [Circle](../com.aspose.threed/circle) curve consists of a set of points in the edge of the circle shape. |
| [CircleShape](../com.aspose.threed/circleshape) | IFC compatible circle profile, which can be used to construct a mesh through [LinearExtrusion](../com.aspose.threed/linearextrusion) |
| [ColladaSaveOptions](../com.aspose.threed/colladasaveoptions) | Save options for collada |
Expand All @@ -46,10 +47,9 @@ url: /java/com.aspose.threed/
| [Discreet3dsLoadOptions](../com.aspose.threed/discreet3dsloadoptions) | Load options for 3DS file. |
| [Discreet3dsSaveOptions](../com.aspose.threed/discreet3dssaveoptions) | Save options for 3DS file. |
| [Dish](../com.aspose.threed/dish) | Parameterized dish. |
| [DracoFormat](../com.aspose.threed/dracoformat) | Google Draco format |
| [DracoFormat](../com.aspose.threed/dracoformat) | Google Draco format **Example:** The following code shows how to encode and decode a Mesh to/from byte array: |
| [DracoSaveOptions](../com.aspose.threed/dracosaveoptions) | Save options for Google draco files |
| [DriverException](../com.aspose.threed/driverexception) | The exception raised by internal rendering drivers. |
| [DummyFileSystem](../com.aspose.threed/dummyfilesystem) | Read/write operations are dummy operations. |
| [Ellipse](../com.aspose.threed/ellipse) | An [Ellipse](../com.aspose.threed/ellipse) defines a set of points that form the shape of ellipse. |
| [EllipseShape](../com.aspose.threed/ellipseshape) | IFC compatible ellipse shape that defined by parameters. |
| [EndPoint](../com.aspose.threed/endpoint) | The end point to trim the curve, can be a parameter value or a Cartesian point. |
Expand Down Expand Up @@ -85,6 +85,7 @@ url: /java/com.aspose.threed/
| [ImportException](../com.aspose.threed/importexception) | Exception when Aspose.3D failed to open the specified source |
| [InitializationException](../com.aspose.threed/initializationexception) | Exceptions in render pipeline initialization |
| [JavaXImageCodec](../com.aspose.threed/javaximagecodec) | |
| [JtLoadOptions](../com.aspose.threed/jtloadoptions) | Load options for Siemens JT |
| [KeyFrame](../com.aspose.threed/keyframe) | A key frame is mainly defined by a time and a value, for some interpolation types, tangent/tension/bias/continuity is also used by calculating the final sampled value. |
| [KeyframeSequence](../com.aspose.threed/keyframesequence) | The sequence of key-frames, it describes the transformation of a sampled value over time. |
| [LShape](../com.aspose.threed/lshape) | IFC compatible L-shape profile that defined by parameters. |
Expand All @@ -94,13 +95,13 @@ url: /java/com.aspose.threed/
| [Line](../com.aspose.threed/line) | A polyline is a path defined by a set of points with [Geometry.\#getControlPoints](../com.aspose.threed/geometry\#getControlPoints), and connected by [Line.\#getSegments](../com.aspose.threed/line\#getSegments), which means it can also be a set of connected line segments. |
| [LinearExtrusion](../com.aspose.threed/linearextrusion) | Linear extrusion takes a 2D shape as input and extends the shape in the 3rd dimension. |
| [LoadOptions](../com.aspose.threed/loadoptions) | The base class to configure options in file loading for different types |
| [LocalFileSystem](../com.aspose.threed/localfilesystem) | The [LocalFileSystem](../com.aspose.threed/localfilesystem) will maps the read/write operations to local directory. |
| [Material](../com.aspose.threed/material) | Material defines the parameters necessary for visual appearance of geometry. |
| [MathUtils](../com.aspose.threed/mathutils) | A set of useful mathematical utilities. |
| [Matrix4](../com.aspose.threed/matrix4) | 4x4 matrix implementation. |
| [MemoryFileSystem](../com.aspose.threed/memoryfilesystem) | The [MemoryFileSystem](../com.aspose.threed/memoryfilesystem) will maps the read/write operations to memory. |
| [Mesh](../com.aspose.threed/mesh) | A mesh is made of many n-sided polygons. |
| [Metered](../com.aspose.threed/metered) | Provides methods to set metered key. |
| [Microsoft3MFFormat](../com.aspose.threed/microsoft3mfformat) | File format instance for Microsoft 3MF with 3MF related utilities. |
| [Microsoft3MFSaveOptions](../com.aspose.threed/microsoft3mfsaveoptions) | Save options for Microsoft 3MF file. |
| [MirroredProfile](../com.aspose.threed/mirroredprofile) | IFC compatible mirror profile. |
| [MorphTargetChannel](../com.aspose.threed/morphtargetchannel) | A MorphTargetChannel is used by [MorphTargetDeformer](../com.aspose.threed/morphtargetdeformer) to organize the target geometries. |
| [MorphTargetDeformer](../com.aspose.threed/morphtargetdeformer) | MorphTargetDeformer provides per-vertex animation. |
Expand All @@ -116,7 +117,7 @@ url: /java/com.aspose.threed/
| [PatchDirection](../com.aspose.threed/patchdirection) | Patch's U and V direction. |
| [PbrMaterial](../com.aspose.threed/pbrmaterial) | Material for physically based rendering based on albedo color/metallic/roughness |
| [PbrSpecularMaterial](../com.aspose.threed/pbrspecularmaterial) | Material for physically based rendering based on diffuse color/specular/glossiness |
| [PdfFormat](../com.aspose.threed/pdfformat) | Adobe's Portable Document Format |
| [PdfFormat](../com.aspose.threed/pdfformat) | Adobe's Portable Document Format **Example:** The following code shows how to extract all supported 3D scenes from a 3D PDF file, and write them to obj format. |
| [PdfLoadOptions](../com.aspose.threed/pdfloadoptions) | Options for PDF loading |
| [PdfSaveOptions](../com.aspose.threed/pdfsaveoptions) | The save options in PDF exporting. |
| [PhongMaterial](../com.aspose.threed/phongmaterial) | Material for blinn-phong shading model. |
Expand Down Expand Up @@ -224,13 +225,12 @@ url: /java/com.aspose.threed/
| [WindowHandle](../com.aspose.threed/windowhandle) | Encapsulated window handle for different platforms. |
| [XLoadOptions](../com.aspose.threed/xloadoptions) | The Load options for DirectX X files. |
| [ZShape](../com.aspose.threed/zshape) | IFC compatible Z-shape profile defined by parameters. |
| [ZipArchiveFileSystem](../com.aspose.threed/ziparchivefilesystem) | File system to provide to the read-only access to speicified zip file or zip stream. |

## Interfaces

| Interface | Description |
| --- | --- |
| [FileSystemFactory](../com.aspose.threed/filesystemfactory) | [SaveOptions](../com.aspose.threed/saveoptions) and [LoadOptions](../com.aspose.threed/loadoptions) will create a [LocalFileSystem](../com.aspose.threed/localfilesystem) for default. |
| [FileSystemFactory](../com.aspose.threed/filesystemfactory) | [SaveOptions](../com.aspose.threed/saveoptions) and [LoadOptions](../com.aspose.threed/loadoptions) will create a com.aspose.threed.LocalFileSystem for default. |
| [IBuffer](../com.aspose.threed/ibuffer) | The base interface of all managed buffers used in rendering |
| [ICommandList](../com.aspose.threed/icommandlist) | Encodes a sequence of commands which will be sent to GPU to render. |
| [IDescriptorSet](../com.aspose.threed/idescriptorset) | The descriptor sets describes different resources that can be used to bind to the render pipeline like buffers, textures |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public String getName()
Gets the name.

**Returns:**
java.lang.String
java.lang.String - the name.
### getProperties() {#getProperties--}
```
public PropertyCollection getProperties()
Expand All @@ -124,7 +124,7 @@ public PropertyCollection getProperties()
Gets the collection of all properties.

**Returns:**
[PropertyCollection](../../com.aspose.threed/propertycollection)
[PropertyCollection](../../com.aspose.threed/propertycollection) - the collection of all properties.
### getProperty(String property) {#getProperty-java.lang.String-}
```
public Object getProperty(String property)
Expand Down Expand Up @@ -192,10 +192,10 @@ Remove the specified property identified by name
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| property | java.lang.String | |
| property | java.lang.String | Which property to remove |

**Returns:**
boolean
boolean - true if the property is successfully removed
### setName(String value) {#setName-java.lang.String-}
```
public void setName(String value)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ 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
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.
### getExportMetaData() {#getExportMetaData--}
```
public boolean getExportMetaData()
Expand All @@ -101,7 +101,7 @@ public boolean getExportMetaData()
Export meta data associated with Scene/Node to client Default value is true

**Returns:**
boolean
boolean - Export meta data associated with Scene/Node to client Default value is true
### getExportTextures() {#getExportTextures--}
```
public boolean getExportTextures()
Expand All @@ -111,7 +111,7 @@ public boolean getExportTextures()
Try to copy textures used in scene to output directory.

**Returns:**
boolean
boolean - Try to copy textures used in scene to output directory.
### getFileFormat() {#getFileFormat--}
```
public FileFormat getFileFormat()
Expand All @@ -121,7 +121,7 @@ public FileFormat getFileFormat()
Gets the file format that specified in current Save/Load option.

**Returns:**
[FileFormat](../../com.aspose.threed/fileformat)
[FileFormat](../../com.aspose.threed/fileformat) - the file format that specified in current Save/Load option.
### getFileName() {#getFileName--}
```
public String getFileName()
Expand All @@ -131,7 +131,7 @@ 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
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() {#getFileSystem--}
```
public FileSystem getFileSystem()
Expand All @@ -141,17 +141,60 @@ public FileSystem getFileSystem()
Allow user to handle how to manage the external dependencies during load/save.

**Returns:**
[FileSystem](../../com.aspose.threed/filesystem)
[FileSystem](../../com.aspose.threed/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() {#getFileSystemFactory--}
```
public static FileSystemFactory getFileSystemFactory()
```


Gets the factory class for FileSystem. The default factory will create [LocalFileSystem](../../com.aspose.threed/localfilesystem) which is not suitable for server environment.
Gets the factory class for FileSystem. The default factory will create com.aspose.threed.LocalFileSystem which is not suitable for server environment.

**Returns:**
[FileSystemFactory](../../com.aspose.threed/filesystemfactory)
[FileSystemFactory](../../com.aspose.threed/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.
```
### getLookupPaths() {#getLookupPaths--}
```
public ArrayList<String> getLookupPaths()
Expand All @@ -161,7 +204,15 @@ 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>
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");
```
### getMetaDataPrefix() {#getMetaDataPrefix--}
```
public String getMetaDataPrefix()
Expand All @@ -171,7 +222,7 @@ public String getMetaDataPrefix()
If this property is non-null, only the properties of Scene/Node that start with this prefix will be exported, and the prefix will be removed.

**Returns:**
java.lang.String
java.lang.String - If this property is non-null, only the properties of Scene/Node that start with this prefix will be exported, and the prefix will be removed.
### hashCode() {#hashCode--}
```
public native int hashCode()
Expand Down Expand Up @@ -261,20 +312,63 @@ Allow user to handle how to manage the external dependencies during load/save.
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [FileSystem](../../com.aspose.threed/filesystem) | New value |
| value | [FileSystem](../../com.aspose.threed/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 [LocalFileSystem](../../com.aspose.threed/localfilesystem) which is not suitable for server environment.
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 |
| 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.
``` |
### setLookupPaths(ArrayList<String> value) {#setLookupPaths-java.util.ArrayList-java.lang.String--}
```
Expand All @@ -287,7 +381,15 @@ Some files like OBJ depends on external file, the lookup paths will allows Aspos
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.util.ArrayList<java.lang.String> | New value |
| 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");
``` |
### setMetaDataPrefix(String value) {#setMetaDataPrefix-java.lang.String-}
```
Expand Down
Loading

0 comments on commit 50a46e3

Please sign in to comment.