Aspose.3D FOSS for Java

API reference for Aspose.3d FOSS for Java v26.5.0. 266 public types organized by module.

Core API

ClassDescription
A3DObjectA3DObject provides a PropertyCollection that can be queried, added to, or removed from via findProperty, getProperty, setProperty, and removeProperty methods.
A3dwSaveOptionsOptions for A3DW saving.
AmfSaveOptionsOptions for AMF saving.
AnimationChannelAnimation channel.
AnimationClipAnimationClip.AnimationClip creates a new animation clip with an empty name.
AnimationNodeAnimation node.
ArbitraryProfileThis class allows you to construct a 2D profile directly from arbitrary curve.
ArrayListAdapterClass with 23 methods and 1 property.
AssetInfoAssetInfo.AssetInfo creates a new AssetInfo instance with default values.
AxisSystemAxisSystem enables conversion between coordinate systems; its transformTo method returns a Matrix4 that maps the current system to a target AxisSystem.
BoneA bone defines the subset of the geometry’s control point, and defined blend weight for each control point.
BonePoseThe BonePose contains the transformation matrix for a bone node /.
BooleanOperandThis class encapsulates the transformed mesh as Boolean operation’s operand.
BooleanOperatorBoolean operator allows you to apply Boolean operation on two IMeshConvertible instances.
BoundingBoxThe axis-aligned bounding box /.
BoundingBox2DThe axis-aligned bounding box for Vector2 /.
BoxBox primitive.
CShapeIFC compatible C-shape profile that defined by parameters.
CameraCamera provides methods to get and set aperture mode, field of view, aspect ratio, width, height, magnification and projection type, allowing full configuration of perspective and orthographic cameras.
CancellationCancellation offers a lightweight way to request and check for operation cancellation via cancel() and isCancelled().
CenterLineProfileIFC compatible center line profile.
CircleA Circle curve consists of a set of points in the edge of the circle shape.
CircleShapeIFC compatible circle profile, which can be used to construct a mesh through LinearExtrusion.
ColladaSaveOptionsColladaSaveOptions configures export of a scene to the Collada format, offering options for indentation and transform representation style.
CompositeCurveA CompositeCurve is consisting of several curve segments.
CryptoUtilsUtility class for cryptographic operations.
CullFaceModeWhat face to cull.
CurveThe base class of all curve implementations.
CustomObjectCustomObject provides a lightweight container for user‑defined data, exposing a name and a PropertyCollection for arbitrary key/value pairs.
CylinderParameterized Cylinder.
DeformerDeformer.Deformer creates a new Deformer instance with default settings.
Discreet3dsLoadOptionsLoad options for 3DS file.
Discreet3dsSaveOptionsSave options for 3DS file.
DishParameterized dish.
DracoFormatGoogle Draco format Example: The following code shows how to encode and decode a Mesh to/from byte array: Mesh mesh = (new Sphere()).toMesh(); //encode mesh.
DracoSaveOptionsOptions for Draco compression.
DrawOperationDrawOperation enum provides rendering primitives such as POINTS, LINES, TRIANGLES, and others for low‑level drawing commands.
DummyFileSystemClass with 8 methods.
EllipseAn Ellipse defines a set of points that form the shape of ellipse.
EllipseShapeIFC compatible ellipse profile, which can be used to construct a mesh through LinearExtrusion.
EndPointThe end point to trim the curve, can be a parameter value or a Cartesian point.
EntityEntity serves as the common base for scene objects, exposing parent node management, bounding box access, and a generic property bag.
EntityRendererKeyThe key of registered entity renderer.
ExportExceptionExportException can be constructed with a message or with a message and a cause to represent errors during export operations.
ExtrapolationExtrapolation defines how to do when sampled value is out of the range which defined by the first and last key-frames.
FMatrix4FMatrix4 provides a full 4×4 matrix implementation with methods to concatenate, transpose, invert, and multiply matrices or vectors for 3D transformations.
FVector2Class with 17 methods.
FVector3FVector3.FVector3 creates a vector with all components set to zero.
FVector4FVector4.FVector4 creates a vector with all components initialized to zero.
FbxLoadOptionsLoad options for FBX format.
FbxSaveOptionsSave options for FBX format.
FileFormatClass with 17 methods and 59 properties.
FileFormatTypeFileFormatType.getExtension() returns the associated file extension string.
FileStreamFile stream for reading and writing files.
FileSystemFile system encapsulation.
FrustumThe base class of Camera and Light /.
GeometryGeometry objects expose control points via getControlPoints() and allow creation of custom vertex elements with createElement(type).
GlobalTransformGlobal transform is similar to Transform but it’s immutable while it represents the final evaluated transformation.
GltfLoadOptionsLoad options for glTF format.
GltfSaveOptionsSave options for glTF format.
GroupA Group represents the logical relationships of Node.
HShapeThe HShape provides the defining parameters of an ‘H’ or ‘I’ shape.
HalfSpaceHalfSpace represents a infinity space which is split by a plane, this can be used with BooleanOperator.
HollowCircleShapeIFC compatible hollow circle profile.
HollowRectangleShapeIFC compatible hollow rectangular shape with both inner/outer rounding corners.
Html5SaveOptionsOptions for HTML5 saving.
IOConfigIO config for serialization/deserialization.
IOExtensionUtilities to write matrix/vector to binary writer.
ImageRenderOptionsThe ImageRenderOptions class enables developers to render scenes to image files with configurable background color, shadow support, and output file format.
ImportExceptionImportException.ImportException creates an exception with a detail message.
InitializationExceptionInitialization exception /.
JtLoadOptionsOptions for JPEG2000 loading.
KeyFrameKeyFrame and KeyframeSequence classes let developers define animated properties over time with support for multiple interpolation types.
KeyframeSequenceThe sequence of key-frames, it describes the transformation of a sampled value over time.
LShapeIFC compatible L-shape profile that defined by parameters.
LambertMaterialMaterial for lambert shading model.
LicenseLicense management class (not available in FOSS version).
LightLight objects can be configured with color, intensity, falloff distances, inner and outer cone angles, and attached to a node hierarchy for scene illumination.
LineA polyline is a path defined by a set of points with getControlPoints(), and connected by getSegments(), which means it can also be a set of connected line segments.
LinearExtrusionLinear extrusion takes a 2D shape as input and extends the shape in the 3rd dimension.
LoadOptionsThe base class to configure options in file loading for different types.
LocalFileSystemLocalFileSystem enables access to files on the local disk and can create zip, dummy, or memory file systems via its static factory methods.
MaterialMaterial defines the parameters necessary for visual appearance of geometry.
MathUtilsUtility class with mathematical functions.
Matrix4Matrix4 provides chainable transformations; call translate, rotate, and scale to build a transformation matrix for positioning objects.
MemoryFileSystemMemoryFileSystem provides an in‑memory file system for reading and writing files without touching the local disk.
MemoryStreamMemory stream for reading and writing data in memory.
MeshMesh.triangulate() returns a new Mesh instance where all polygons have been converted into triangles.
MeteredMetered license management class (not available in FOSS version).
Microsoft3MFSaveOptionsMicrosoft3MFSaveOptions extends SaveOptions and adds the exportTextures flag to include or exclude textures when saving to the 3MF format.
MirroredProfileIFC compatible mirror profile.
MorphTargetChannelA MorphTargetChannel is used by MorphTargetDeformer to organize the target geometries.
MorphTargetDeformerMorphTargetDeformer provides per-vertex animation.
NodeNode represents a scene‑graph element; you can create child nodes, assign an Entity, and control visibility via getVisible/setVisible.
NotImplementedExceptionException thrown when a feature is not implemented.
NurbsCurveNURBS curve is a curve represented by NURBS(Non-uniform rational basis spline), A NURBS curve is defined by its getOrder(), a set of weighted Geometry.getControlPoints() and a getKnotVectors() The w.
NurbsDirectionClass with 12 methods and 7 properties.
ObjLoadOptionsObjLoadOptions lets developers control OBJ import behavior, including flipping the coordinate system, scaling the model, and enabling or disabling material loading.
ObjSaveOptionsObjSaveOptions provides options for exporting OBJ files, including unit scaling, point‑cloud export, material handling, and coordinate system flipping.
ObjectPropertyConcrete property implementation for Object values.
ParameterizedProfileThe base class of all parameterized profiles.
ParseExceptionParseException.ParseException creates an exception with the specified error message.
PbrMaterialMaterial for physically based rendering based on albedo color/metallic/roughness.
PbrSpecularMaterialMaterial for physically based rendering based on diffuse color/specular/glossiness /.
PdfLoadOptionsOptions for PDF loading.
PdfSaveOptionsThe save options in PDF exporting.
PhongMaterialMaterial for blinn-phong shading model.
PlaneParameterized plane.
PlyLoadOptionsPlyLoadOptions and PlySaveOptions give developers the ability to import and export PLY point‑cloud files with configurable encoding and file‑system handling.
PlySaveOptionsClass with 17 methods and 7 properties.
PointCloudA point cloud represents a collection of points in 3D space.
PolygonModifierPolygon modifier utilities.
PoseThe pose is used to store transformation matrix when the geometry is skinned.
PrimitiveBase class for all primitives.
Profile2D Profile in xy plane.
PropertyClass to hold user-defined properties.
PropertyCollectionPropertyCollection offers methods to add, remove, find, and iterate over Property objects by name or index.
PyramidParameterized pyramid.
QuaternionQuaternion provides static factory methods to create quaternions from Euler angles or an angle‑axis pair, as well as instance methods for normalization and multiplication.
RectA class to represent the rectangle /.
RectangleShapeIFC compatible rectangular shape with rounding corners.
RectangularTorusParameterized rectangular torus.
RelativeRectangleRelative rectangle The formula between relative component to absolute value is: Scale * (Reference Width) + offset So if we want it to represent an absolute value, leave all scale fields zero, and use offset fields instead.
RenderFactoryRenderFactory supplies factory methods to create render textures, descriptor sets, shader programs, pipelines and other low‑level rendering resources.
RenderParametersClass with 1 method.
RenderQueueGroupIdClass with 1 method.
RenderResourceClass with 1 method.
RenderStageRenderStage provides a default constructor to create a new rendering stage for custom rendering pipelines.
RenderStateClass with 1 method.
RendererClass with 1 method.
RendererExceptionClass with 1 method.
RendererVariableManagerRendererVariableManager provides a container for variables that influence rendering behavior.
RevolvedAreaSolidThis class represents a solid model by revolving a cross section provided by a profile about an axis.
RvmLoadOptionsLoad options for AVEVA Plant Design Management System’s RVM file.
RvmSaveOptionsSave options for Aveva PDMS RVM file.
SaveOptionsThe base class to configure options in file saving for different types.
SceneScene.open(filePath) loads a 3D file, automatically detecting its format based on the file extension.
SceneObjectSceneObject extends A3DObject, adding a reference to its parent Scene and exposing scene‑level properties.
SegmentSegment of CompositeCurve.
ShaderMaterialA shader material that allows describing the material by external rendering engine or shader language.
ShaderProgramClass with 1 method.
ShaderSourceClass in the 3D JAVA API.
ShaderTechniqueA shader technique represents a concrete rendering implementation.
ShapeThe shape describes the deformation on a set of control points, which is similar to the cluster deformer in Maya.
SkeletonA skeleton defines a hierarchical structure of bones for skinning.
SkinDeformerA skin deformer contains multiple bones to work, each bone blends a part of the geometry by control point’s weights.
SphereParameterized sphere.
StlLoadOptionsLoad options for STL.
StlSaveOptionsSave options for STL.
StreamCreated by lexchou on 12/14/2016.
StructsBase class of struct array.
TShapeIFC compatible T-shape defined by parameters.
TextureThis class defines the texture from an external file.
TextureBaseBase class for all concrete textures.
TextureDataTextureData.TextureData creates a new instance of TextureData.
TextureSlotTexture slot in Material, can be enumerated through material instance.
TorusParameterized torus.
TransformThe Transform class lets developers define translation, scaling, and rotation using vectors, quaternions, or Euler angles.
TransformBuilderUtility class for building transformation matrices.
TrapeziumShapeIFC compatible Trapezium shape defined by parameters.
TriMeshA TriMesh contains raw data that can be used by GPU directly.
TrialExceptionTrial exception for evaluation mode.
U3dLoadOptionsOptions for U3D loading.
U3dSaveOptionsSave options for universal 3d.
UShapeIFC compatible U-shape defined by parameters.
UsdSaveOptionsOptions for USD saving.
Vector2Vector2 and Vector3 classes provide basic vector math operations such as dot, cross, normalization, and length calculation.
Vector3Class with 40 methods and 7 properties.
Vector4Vector4.Vector4 initializes a vector with the specified x, y, z, and w component values.
VersionVersion.Version(major:int, minor:int) creates a version with specified major and minor numbers.
VertexVertex reference, used to access the raw vertex in TriMesh.
VertexDeclarationVertexDeclaration.addField(dataType, semantic, index, alias) creates a new VertexField describing a vertex attribute layout.
VertexElementBase class for all vertex element types.
VertexElementBinormalVertexElementBinormal.VertexElementBinormal creates a binormal vertex element with specified mapping and reference modes.
VertexElementDoublesTemplateClass with 17 methods and 6 properties.
VertexElementEdgeCreaseClass with 18 methods and 6 properties.
VertexElementFVectorClass with 19 methods and 6 properties.
VertexElementHoleClass with 3 methods and 1 property.
VertexElementIntsTemplateClass with 17 methods and 6 properties.
VertexElementMaterialVertexElementMaterial.VertexElementMaterial creates a material vertex element using the given mapping and reference modes.
VertexElementNormalVertexElementNormal.clone(withData, withIndices) creates a deep copy of a normal element, optionally preserving its data and index buffers.
VertexElementPolygonGroupClass with 18 methods and 6 properties.
VertexElementSmoothingGroupClass with 18 methods and 6 properties.
VertexElementSpecularClass with 20 methods and 6 properties.
VertexElementTangentVertexElementTangent.VertexElementTangent creates a tangent vertex element using the given mappingMode and referenceMode.
VertexElementTemplateVertexElementTemplate.getData() returns the generic list of stored values, allowing custom templated vertex attributes to be inspected or modified.
VertexElementUVVertexElementUV.addData(data) appends a new UV coordinate to the element’s data collection.
VertexElementUserDataVertexElementUserData.clone(withData, withIndices) returns a generic VertexElement that carries an arbitrary Object payload.
VertexElementVector4Class with 17 methods and 6 properties.
VertexElementVertexColorClass with 21 methods and 6 properties.
VertexElementVertexCreaseClass with 18 methods and 6 properties.
VertexElementVisibilityVertexElementVisibility.clear() removes any stored visibility flags, resetting the element to its default state.
VertexElementWeightVertexElementWeight.setData(List) assigns weight values to vertices for skinning operations.
VertexFieldVertexField definitions allow developers to describe custom vertex buffer layouts by specifying data type, semantic, offset and size.
WatermarkUtility to encode/decode blind watermark to/from a mesh.
WeightedModeWeighted mode.
WindowHandleWindowHandle offers static factory methods fromWayland, fromXlib, and fromWin32 to create a platform‑specific window handle for rendering contexts.
XLoadOptionsOptions for X (DirectX) loading.
ZShapeIFC compatible Z-shape profile defined by parameters.
ZipFileSystemZipFileSystem can be constructed from a file path or an InputStream and provides readFile and writeFile methods to access files inside a ZIP archive as streams.

Interfaces

InterfaceDescription
EnumerableGeneric enumerable interface for collection of type T /.
EnumeratorGeneric enumerator for collection of type T /.
EventCallbackEvent callback interface for handling events with arguments.
FileSystemFactoryFactory for creating file system instances.
IBufferInterface in the 3D JAVA API.
IDescriptorSetInterface in the 3D JAVA API.
IIndexBufferInterface in the 3D JAVA API.
IIndexedVertexElementVertexElement with indices data.
IMeshConvertibleIMeshConvertible.toMesh converts the implementing object to a Mesh instance.
INamedObjectINamedObject.getName returns the object’s current name.
IOrientableOrientable entities shall implement this interface.
IPipelineInterface in the 3D JAVA API.
IRenderQueueInterface in the 3D JAVA API.
IRenderTargetInterface in the 3D JAVA API.
IRenderTextureInterface in the 3D JAVA API.
IRenderWindowInterface in the 3D JAVA API.
ITextureUnitInterface in the 3D JAVA API.
IVertexBufferInterface in the 3D JAVA API.
MaterialConverterCustom converter to convert the geometry’s original material to GLTF’s PBR material.
NodeVisitorA callback to travel through the whole node hierarchy.
StructStruct.clone() creates a copy of the struct instance while preserving its generic type.

Enumerations

EnumerationDescription
AlphaSourceDefines whether the texture contains the alpha channel.
ApertureModeCamera aperture modes.
AxisAxis enum supplies constants for the six principal directions, allowing developers to specify orientation vectors such as X_AXIS or NEGATIVE_Z_AXIS.
BindPointAnimation binding point.
BlendFactorBlend factor specify pixel arithmetic.
BoneLinkModeA bone’s link mode refers to the way in which a bone is connected or linked to its parent bone within a hierarchical structure.
BooleanOperationMesh’s Boolean operation /.
BoundingBoxExtentThe extent of the bounding box.
ColladaTransformStyleColladaTransformStyle enum defines two ways to write transforms in Collada files: as separate components or as a single matrix.
CompareFunctionThe compare function used in depth/stencil testing.
ComposeOrderThe order to compose transform matrix.
CoordinateSystemCoordinateSystem.RIGHT_HANDED represents a right‑handed coordinate system orientation.
CubeFaceEnum with 6 members.
CurveDimensionThe dimension of the curves.
DracoCompressionLevelCompression level for Draco format.
ExtrapolationTypeExtrapolation type.
FileContentTypeFileContentType.BINARY represents a binary file content type.
FrontFaceDefine front- and back-facing polygons.
GltfEmbeddedImageFormatHow glTF exporter will embed the textures during the exporting.
IndexDataTypeEnum with 2 members.
InterpolationThe Interpolation enum defines the supported interpolation curves for key‑frame animation, including CONSTANT, LINEAR, BEZIER, B_SPLINE, CARDINAL_SPLINE, and TCB_SPLINE.
LightTypeLightType enum defines the supported categories of lights: DIRECTIONAL, POINT, SPOT, AREA, and ENVIRONMENT.
MappingModeMappingMode.CONTROL_POINT represents mapping values per control point.
NurbsTypeNURBS types.
PatchDirectionThe direction of a patch.
PatchDirectionTypeThe type of patch direction.
PdfLightingSchemeLightingScheme specifies the lighting to apply to 3D artwork.
PdfRenderModeRender mode specifies the style in which the 3D artwork is rendered.
PolygonModeThe polygon rasterization mode.
PoseTypePose type.
PresetShadersEnum with 2 members.
ProjectionTypeCamera’s projection types.
ReferenceModeReferenceMode enum defines how vertex attributes reference data, supporting DIRECT, INDEX_TO_DIRECT, and INDEX modes.
RotationModeThe frustum’s rotation mode /.
RotationOrderThe order controls which rx ry rz are applied in the transformation matrix.
SkeletonTypeThe type of skeleton.
SplitMeshPolicyShare vertex/control point data between sub-meshes or each sub-mesh has its own compacted data.
StepModeInterpolation step mode.
TextureFilterFilter options during texture sampling.
TextureMappingTextureMapping enum enumerates material texture slots such as DIFFUSE, NORMAL, SPECULAR, BUMP, and others.
TextureTypeEnum with 5 members.
VertexElementTypeVertexElementType enum defines the set of supported vertex element categories such as NORMAL, TANGENT, UV, and MATERIAL.
VertexFieldDataTypeVertex field’s data type.
VertexFieldSemanticThe semantic of the vertex field.
WrapModeTexture’s wrap mode.

See Also

 English