Aspose.3D FOSS for Java

API reference for aspose-3d-foss 26.1.0 (Java 21+, MIT license).

All classes reside in the com.aspose.threed root package. The root import is:

import com.aspose.threed.*;

Package layout: Nearly all public classes are in com.aspose.threed. The only sub-package typically used is com.aspose.threed.shading (for PbrMaterial). The com.aspose.threed.formats sub-package contains internal importers/exporters and is not usually imported directly.

Java naming convention: All properties use getter/setter methods. For example, use node.getTransform() instead of node.transform, and transform.setTranslation(...) instead of transform.translation = .... Note that Vector3, Vector4, Quaternion, Matrix4, and FVector types use public fields (v.x, v.y, v.z) rather than getters for component access.

Core Scene Graph

Class	Description
`Scene`	Top-level container for all 3D scene data. Holds the root node, asset metadata, and animation clips. Exposes `fromFile()`, `open()`, and `save()` as the primary I/O entry points.
`Node`	A named node in the scene hierarchy. Owns a list of child nodes and a list of attached `Entity` objects such as meshes, cameras, and lights. Carries a local `Transform`.
`Entity`	Abstract base class for all objects that can be attached to a `Node`. Provides name and identity but no geometry of its own.
`SceneObject`	Base class shared by `Node` and `Entity`. Provides the property collection interface used for user-defined metadata.
`A3DObject`	Root base class for all Aspose.3D managed objects. Exposes the name property and the `Properties` collection.
`INamedObject`	Interface that guarantees a `getName()` method. Implemented by `Node`, `Entity`, and several format-specific descriptor types.

Geometry and Mesh

Class	Description
`Mesh`	Polygon mesh entity. Stores control points (vertex positions as `Vector4`), polygon face lists (lists of control-point indices), and vertex element layers (normals, UVs, vertex colours).
`Geometry`	Abstract base for mesh-like geometry types. Defines the control-point array and the collection of `VertexElement` layers. `Mesh` inherits from `Geometry`.
`VertexElement`	Abstract base for a data layer attached to geometry (normals, UVs, colours, etc.). Carries `getMappingMode()`, `getReferenceMode()`, and a data list.
`VertexElementNormal`	Stores one normal vector per vertex or per polygon corner, depending on mapping mode. Data values are `Vector4` instances with `w` unused.
`VertexElementUV`	Stores texture-coordinate pairs (`Vector2`) per vertex or per polygon corner. A mesh may carry multiple UV layers for different texture channels.
`VertexElementVertexColor`	Stores per-vertex or per-corner RGBA colour data as `Vector4` (r, g, b, a in the range 0–1).
`VertexElementType`	Enumeration identifying the semantic role of a vertex element layer: `NORMAL`, `UV`, `VERTEX_COLOR`, and others. Pass values to `Mesh.getElement()`.
`MappingMode`	Enumeration controlling which primitive a vertex element value maps to: `CONTROL_POINT`, `POLYGON_VERTEX`, or `POLYGON`.
`ReferenceMode`	Enumeration controlling how values are indexed: `DIRECT` (one value per mapping primitive) or `INDEX_TO_DIRECT` (values array plus a separate indices array).

Transform and Spatial

Class	Description
`Transform`	Local transformation attached to a `Node`. Provides translation, rotation (as `Quaternion`), and scale components, plus convenience methods for Euler angles.
`GlobalTransform`	Read-only view of a node’s world-space transformation after composing all ancestor transforms. Accessed via `node.getGlobalTransform()`.
`AssetInfo`	Metadata block attached to a `Scene`. Stores authoring application name, unit name, unit scale factor, coordinate system axis definitions, and creation/modification timestamps.

Materials and Shading

Class	Description
`Material`	Abstract base class for all material types. Provides a name and a property collection for numeric and colour parameters.
`PbrMaterial`	Physically Based Rendering material. Stores albedo, metallic factor, roughness factor, emissive color, transparency, and associated textures. Used by glTF 2.0 and other PBR-capable formats. Import: `com.aspose.threed.shading.PbrMaterial`.

Camera

Class	Description
`Camera`	Camera entity. Inherits from `Entity`. No format-specific properties are exposed in the Java FOSS edition beyond the inherited name and property collection. Attached to a `Node` to define viewpoint transforms.

Note: The Light class is not available in the Java edition of Aspose.3D FOSS. Scene lighting data from imported files is stored as generic Entity objects.

Math Utilities

Class	Description
`Vector2`	Double-precision 2-component vector (`x`, `y`). Used for UV texture coordinates.
`Vector3`	Double-precision 3-component vector (`x`, `y`, `z`). Used for positions, directions, and scale.
`Vector4`	Double-precision 4-component vector (`x`, `y`, `z`, `w`). Used for control points (homogeneous positions) and normal data.
`FVector3`	Single-precision 3-component float vector. Appears in vertex element data arrays for normals and tangents.
`FVector4`	Single-precision 4-component float vector. The storage type of `VertexElementFVector` data.
`Quaternion`	Unit quaternion for representing rotations (`w`, `x`, `y`, `z`). Used by `Transform.getRotation()`.
`Matrix4`	4x4 double-precision transformation matrix. Used for world/local transform computations and can be constructed from TRS decompositions.
`BoundingBox`	Axis-aligned bounding box defined by `getMinimum()` and `getMaximum()` `Vector3` corners. Used for spatial queries and frustum culling helpers.

Animation

Class	Description
`AnimationClip`	Named container for an animation range. A `Scene` may hold multiple clips (e.g., “Walk”, “Run”). Declaration stub — keyframe data and playback are not yet implemented.

Format I/O

Symbol	Description
`Scene.fromFile(path)`	Static method. Opens the file at `path`, detects the format from the extension, and returns a populated `Scene`. Throws on file-not-found or unsupported format.
`Scene.open(path, options)`	Instance method. Opens a file into an existing `Scene` instance, optionally using a format-specific `LoadOptions` subclass.
`Scene.save(path, options)`	Instance method. Serialises the scene to `path` using the format inferred from the extension, optionally using a format-specific `SaveOptions` subclass.
`FileFormat`	Registry of supported file formats. Contains entries such as `FileFormat.WAVEFRONT_OBJ()`, `FileFormat.GLTF2()`, `FileFormat.FBX7400ASCII()`.
`IOService`	Internal I/O abstraction used by format importers and exporters. Not typically used directly by application code.
`LoadOptions`	Base class for all format-specific load-option objects. Subclassed by `ObjLoadOptions`, `StlLoadOptions`, `GltfLoadOptions`, `FbxLoadOptions`.
`SaveOptions`	Base class for all format-specific save-option objects. Subclassed by `ObjSaveOptions`, `StlSaveOptions`, `GltfSaveOptions`.

OBJ Format

Class	Description
`ObjImporter`	Internal importer class that parses Wavefront OBJ and MTL files. Invoked automatically by `Scene.fromFile()` for `.obj` extensions.
`ObjLoadOptions`	Load options for Wavefront OBJ files. Key properties: `setFlipCoordinateSystem()`, `setScale()`, `setEnableMaterials()`, `setNormalizeNormal()`.
`ObjSaveOptions`	Save options for Wavefront OBJ output. Controls normals, UVs, material references, and point-cloud mode.
`ObjFormat`	Format descriptor for Wavefront OBJ. Accessible as `FileFormat.WAVEFRONT_OBJ()`.

STL Format

Class	Description
`StlImporter`	Internal importer that reads both binary and ASCII STL files. Selected automatically by extension.
`StlExporter`	Internal exporter that writes STL.
`StlLoadOptions`	Load options for STL files. Supports `setFlipCoordinateSystem()`, `setRecalculateNormal()`, and `setContentType()`.
`StlSaveOptions`	Save options for STL output. Controls `setFlipCoordinateSystem()`, `setAxisSystem()`, and `setContentType()`.
`StlFormat`	Format descriptor for STL.

glTF Format

Class	Description
`GltfLoadOptions`	Load options for glTF 2.0 and GLB files. Key properties: `setFlipCoordinateSystem()`, `setPrettyPrint()`.
`GltfSaveOptions`	Save options for glTF 2.0 and GLB output. Use `setContentType(FileContentType.BINARY)` to produce a self-contained `.glb` package.
`GltfFormat`	Format descriptor for glTF 2.0 / GLB. Accessible as `FileFormat.GLTF2()`.

FBX Format

FBX is supported for import only. Export to FBX is not available in the Java FOSS edition.

Class	Description
`FbxLoadOptions`	Load options for FBX files. Key property: `setFlipCoordinateSystem()`.
`FbxFormat`	Format descriptor for FBX. Accessible as `FileFormat.FBX7400ASCII()`.

Enumerations

Enumeration	Description
`Axis`	Identifies a coordinate axis: `X_AXIS`, `Y_AXIS`, `Z_AXIS`. Used in coordinate-system remapping options.
`CoordinateSystem`	Specifies handedness convention: `RIGHT_HANDED` or `LEFT_HANDED`.
`TextureMapping`	Identifies how a texture is mapped to geometry: `DIFFUSE`, `SPECULAR`, `EMISSIVE`, `NORMAL`, `AMBIENT`, etc.
`BooleanOperation`	CSG Boolean operation type: `UNION`, `DIFFERENCE`, `INTERSECTION`.

Properties System

Class	Description
`Property`	A single named typed property on an `A3DObject`. Stores the property name, type descriptor, and current value.
`PropertyCollection`	Iterable collection of `Property` objects attached to an `A3DObject`. Supports lookup by name and iteration over all defined properties.
`CustomObject`	A lightweight `A3DObject` subclass that carries only a name and an arbitrary `PropertyCollection`. Used for storing user-defined metadata on scene objects.

Image and Render

Class	Description
`ImageRenderOptions`	Options for software rasterisation when rendering a scene to an image buffer. Stores background colour, image dimensions, and camera reference. This feature is available in supported configurations.