Aspose.3D FOSS for Python

API reference for Aspose.3d FOSS for Python v26.1.0. 305 public types organized by module.

Core API

ClassDescription
A3DObjectA3DObject is the base class for named objects and provides methods to find, get, set, and remove custom properties.
A3dwSaveOptionsSave options for A3DW.
AlphaSourceSource of alpha channel for textures.
AmfSaveOptionsSave options for AMF.
AnimationChannelAnimationChannel stores keyframe data; you can reset it, add keyframes with time, value, and interpolation, and manage custom properties.
AnimationClipAnimationClip groups multiple AnimationNode objects and exposes start, stop, and scene references for playback control.
AnimationNodeAnimationNode.find_bind_point returns the BindPoint matching the given target object and name.
ApertureModeCamera aperture modes.
ArbitraryProfileThis class allows you to construct a 2D profile directly from arbitrary curve.
ArrayListAdapterAdapter class that wraps List[T] and implements IArrayList[T].
AssetInfoAssetInfo.title stores the title of the 3D asset.
AxisThe coordinate axis.
AxisSystemAxis system is an combination of coordinate system, up vector and front vector.
BasicLoadOptionsSimple LoadOptions subclass for basic loading options.
BinaryTokenizerBinaryTokenizer.tokenize() parses the binary data stream and advances the cursor accordingly.
BindPointBindPoint links a property to one or more AnimationChannel objects, allowing channel creation, retrieval, and reset.
BlendFactorBlend factor specify pixel arithmetic.
BoneBone objects expose weight management via get_weight and set_weight methods, enabling skinning calculations.
BoneLinkModeClass with 3 members.
BonePoseClass with 6 methods and 5 properties.
BooleanOperandThis class encapsulates the transformed mesh as Boolean operation’s operand.
BooleanOperationClass with 3 members.
BooleanOperatorBoolean operator allows you to apply Boolean operation on two IMeshConvertible instances.
BoundingBoxBoundingBox offers static constructors get_null() and get_infinite(), as well as instance methods merge(), contains(arg), and overlaps_with(box) for spatial queries.
BoundingBox2DThe axis-aligned bounding box for Vector2.
BoundingBoxExtentThe extent of the bounding box.
BoxClass with 16 methods and 18 properties.
CShapeIFC compatible C-shape profile that defined by parameters.
CameraCamera properties near_plane and far_plane define the depth range for the view frustum calculations.
CenterLineProfileIFC compatible center line profile.
CircleClass with 16 methods and 16 properties.
CircleShapeIFC compatible circle profile.
ColladaExporterColladaExporter.supports_format returns true if the exporter can handle the given file format.
ColladaFormatColladaFormat.create_load_options creates and returns a Collada load options object for importing.
ColladaFormatDetectorColladaFormatDetector.detect determines the 3D file format of a stream, optionally using the file name.
ColladaImporterColladaImporter.supports_format returns True if the specified file format is supported by this importer.
ColladaLoadOptionsColladaLoadOptions.flip_coordinate_system determines whether the Y and Z axes are swapped during import.
ColladaPluginColladaPlugin supplies factory methods to obtain the ColladaFormat, its importer, exporter, and format detector for seamless integration.
ColladaSaveOptionsColladaSaveOptions.flip_coordinate_system determines whether the Y and Z axes are swapped when saving.
ColladaTransformStyleThe node’s transformation style of node.
CompareFunctionCompare function for depth/stencil testing.
ComposeOrderThe order to compose transform matrix.
CompositeCurveA CompositeCurve is consisting of several curve segments.
CoordinateSystemThe left handed or right handed coordinate system.
CubeFaceCube face enumeration.
CullFaceModeCull face mode for face culling.
CurveClass with 7 methods and 7 properties.
CurveDimensionClass with 2 members.
CustomObjectClass with 5 methods and 2 properties.
CylinderCylinder.to_mesh() converts the cylinder primitive into a Mesh object for further processing.
DeformerClass with 5 methods and 3 properties.
DescriptorSetUpdaterDescriptor set updater for shader resources.
Discreet3dsLoadOptionsLoad options for Discreet 3DS.
Discreet3dsSaveOptionsSave options for Discreet 3DS.
DishDish.to_mesh() creates a Mesh from a dish primitive, and its radius and height properties control its size.
DracoCompressionLevelCompression level for draco file.
DracoFormatGoogle Draco format.
DracoSaveOptionsSave options for Draco.
DrawOperationDraw operation type.
DriverExceptionException thrown when rendering driver fails.
EllipseEllipse.to_mesh() converts an ellipse primitive into a Mesh object that can be added to a scene.
EllipseShapeIFC compatible ellipse profile.
EndPointThe end point to trim the curve, can be a parameter value or a Cartesian point.
EntityEntity objects expose get_bounding_box() for spatial queries and a full set of property‑management methods (find_property, get_property, set_property, remove_property).
EntityRendererBase class for rendering entities.
EntityRendererFeaturesFeatures supported by an entity renderer.
EntityRendererKeyThe key of registered entity renderer.
ExportExceptionExceptions when Aspose.3D failed to export the scene to file.
ExporterExporter objects let you verify format support with supports_format() before calling export() to write a scene to a stream.
ExtrapolationExtrapolation.type represents the extrapolation mode applied to animation curves.
FMatrix4Matrix 4x4 with all component in float type.
FVector2FVector2.normalize returns a new FVector2 with the same direction and unit length.
FVector3FVector3.zero returns a vector with all components set to 0.
FVector4FVector4.x represents the X component of the 4‑dimensional vector.
FbxElementFbxElement.add_token adds the given Token to the element’s token collection.
FbxExporterFbxExporter.save saves the given Scene to a file path using specified FbxSaveOptions.
FbxFormatFbxFormat.detect(stream, file_name) returns the detected file format, enabling dynamic handling of unknown input files.
FbxFormatDetectorFbxFormatDetector.detect determines the FBX format of the provided stream, optionally using the file name.
FbxImporterFbxImporter.supports_format returns True if the given file format is supported for import.
FbxLoadOptionsFbxLoadOptions exposes properties such as keep_builtin_global_settings, compatible_mode, file_format, encoding, file_system, lookup_paths, and file_name to customize FBX import behavior.
FbxParserFbxParser parses token streams and exposes a root_scope property for navigating the parsed FBX hierarchy.
FbxPluginFbxPlugin provides factory methods to obtain an importer, exporter, format detector, and to create load and save option objects for FBX processing.
FbxSaveOptionsFbxSaveOptions provides export_textures, embed_textures, export_legacy_material_properties, and other flags to control how FBX files are written.
FbxScopeFbxScope.add_element(element) adds a new element to the scope, and get_elements(key) retrieves all elements of the specified type.
FbxTokenizerFbxTokenizer.tokenize() returns a list of Token objects representing the lexical elements of an FBX file.
FileContentTypeFile content type.
FileFormatFileFormat can detect a file’s format from a stream and file name, and can create matching load and save option objects.
FileFormatTypeFile format type.
FileSystemFile system encapsulation.
FontFileFont file contains definitions for glyphs, this is used to create text profile.
FormatDetectorFormatDetector.detect detects the file format of the provided stream, using the optional file name, and returns a FileFormat.
FrontFaceFront face winding order.
FrustumFrustum.to_mesh() generates a Mesh representation of a viewing frustum, useful for visual debugging of camera volumes.
GLSLSourceGLSL shader source.
GeometryGeometry class methods let developers create vertex elements, UV mappings, and manage deformers for mesh data.
GlobalTransformThe GlobalTransform class exposes translation, scale, euler_angles, rotation, and transform_matrix properties for direct manipulation of an entity’s world transform.
GltfEmbeddedImageFormatEmbedded image format for GLTF.
GltfExporterGltfExporter can export a scene to the glTF format and first checks support with supports_format(file_format).
GltfFormatGltfFormat.create_load_options creates a GLTF-specific load options object for importing scenes.
GltfFormatDetectorGltfFormatDetector.detect(stream, file_name) returns a FileFormat value that identifies the format of the supplied data.
GltfImporterGltfImporter.supports_format returns true when the specified file format can be imported.
GltfLoadOptionsGltfLoadOptions.flip_tex_coord_v indicates whether to invert the V component of texture coordinates during GLTF import.
GltfPluginGltfPlugin.get_file_format returns the GltfFormat object representing the GLTF file format.
GltfSaveOptionsGltfSaveOptions.file_format specifies the output file format for saving, using the FileFormat enum.
GroupA Group represents the logical relationships of Node.
HShapeIFC compatible H-shape profile.
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.
Html5SaveOptionsSave options for HTML5.
ImageRenderOptionsImageRenderOptions lets you configure rendering parameters such as background_color, enable_shadows, and asset_directories before passing the options to a renderer.
ImportExceptionException when Aspose.3D failed to open the specified source.
ImporterImporter.supports_format(file_format) returns true when the specified FileFormat is supported for import.
IndexDataTypeData type for indices.
InitializationExceptionException thrown when rendering initialization fails.
InvalidOperationExceptionInvalidOperationException is raised when an operation is not supported by the current object state.
JtLoadOptionsLoad options for JT.
KeyFrameKeyFrame properties such as time, value, interpolation, and tangent_weight_mode allow fine‑grained control of animation curves.
KeyframeSequenceKeyframeSequence lets developers create animation curves with per‑keyframe interpolation and tangent control.
LShapeIFC compatible L-shape profile that defined by parameters.
LambertMaterialLambertMaterial provides basic diffuse shading with support for emissive, ambient, diffuse, and transparent colors, and texture slots like MAP_DIFFUSE.
LightThe Light class lets you configure lighting parameters such as near_plane, far_plane, aspect, ortho_height, and up direction for scene illumination.
LightTypeLight types.
LineA polyline is a path defined by a set of points with control_points, and connected by segments.
LinearExtrusionLinearExtrusion converts a 2D shape into a 3D mesh by extruding along a direction with configurable height, slices, and twist.
LoadOptionsClass with 1 method and 5 properties.
MappingModeClass with 5 members.
MaterialMaterial class lets you manage texture maps and custom properties, supporting specular, diffuse, emissive, ambient, and normal maps.
MathUtilsA set of useful mathematical utilities.
Matrix4Matrix4.get_identity() returns a new identity Matrix4 instance that can be used as a starting point for building transformation chains.
MeshMesh.optimize(vertex_elements, tolerance_control_point, tolerance_normal, tolerance_uv) reduces mesh complexity while preserving visual fidelity.
Microsoft3MFFormatMicrosoft 3MF format.
Microsoft3MFSaveOptionsSave options for Microsoft 3MF.
MirroredProfileIFC compatible mirror profile.
MorphTargetChannelMorphTargetChannel.get_weight(target) returns the weight value for a specific morph target.
MorphTargetDeformerMorphTargetDeformer enables geometry deformation by managing multiple MorphTargetChannel objects, each with per‑target weight control.
NodeNode.create_child_node(name, entity, material) creates a new child Node and optionally attaches an entity and a material in one call.
NurbsCurveClass with 9 methods and 15 properties.
NurbsDirectionClass with 1 method and 7 properties.
NurbsSurfaceNurbsSurface objects can be converted to mesh geometry via the to_mesh() method, supporting NURBS‑based modeling workflows.
NurbsTypeClass with 3 members.
ObjExporterObjExporter supports writing OBJ data with the export(scene, stream, options) method.
ObjFormatObjFormat.create_load_options creates and returns an ObjLoadOptions instance for importing OBJ files.
ObjFormatDetectorClass with 2 methods.
ObjImporterObjImporter provides the import_scene(scene, stream, options) method to read OBJ files into a Scene object.
ObjLoadOptionsObjLoadOptions.flip_coordinate_system swaps the Y and Z axes when loading an OBJ file.
ObjPluginObjPlugin.get_file_format returns the ObjFormat object representing the OBJ file format.
ObjSaveOptionsObjSaveOptions.apply_unit_scale applies the scene’s unit scaling when saving to OBJ.
ParameterizedProfileThe base class of all parameterized profiles.
ParseExceptionException when Aspose.3D failed to parse the input.
PatchPatch objects allow creation of custom vertex elements via create_element and create_element_uv methods.
PatchDirectionClass with 1 method and 4 properties.
PatchDirectionTypeClass with 5 members.
PbrMaterialPbrMaterial provides PBR‑compatible properties such as albedo, metallic_factor, roughness_factor and texture slots like albedo_texture and normal_texture.
PbrSpecularMaterialMaterial for physically based rendering based on diffuse color/specular/glossiness.
PdfFormatAdobe’s Portable Document Format.
PdfLightingSchemeLighting scheme for PDF export.
PdfLoadOptionsLoad options for PDF.
PdfRenderModeRender mode for PDF export.
PdfSaveOptionsSave options for PDF.
PhongMaterialPhongMaterial.specular_color defines the RGB color of the specular highlight.
PixelFormatPixel format for render targets.
PixelMapModePixel mapping mode.
PixelMappingPixel mapping configuration.
PlaneThe Plane class can be converted to a Mesh by calling its to_mesh() method, enabling further mesh processing.
PluginPlugin.get_exporter() returns an Exporter object that can be used to write supported 3D formats.
PlyFormatPLY format.
PlyLoadOptionsLoad options for PLY.
PlySaveOptionsSave options for PLY.
PointCloudClass with 4 methods and 1 property.
PolygonBuilderThe PolygonBuilder class lets you construct polygon vertex indices by calling begin(), add_vertex(index) for each vertex, and end() to finalize the polygon.
PolygonModePolygon rendering mode.
PolygonModifierPolygonModifier.triangulate can return None, a Mesh object, or a list of triangle index arrays, giving developers flexibility in handling polygon data.
PosePose.add_bone_pose(node, matrix, local_matrix) records a bone transformation for skeletal animation within a Pose object.
PostProcessingPost-processing effect.
PresetShadersPredefined shaders.
PrimitiveClass with 15 methods and 12 properties.
Profile2D Profile in xy plane.
ProjectionTypeCamera’s projection types.
PropertyProperty.get_extra returns the extra attribute identified by the given name.
PropertyCollectionPropertyCollection.find_property returns the property object matching the given name or None.
PropertyFlagsProperty’s flags.
PushConstantPush constant for shaders.
PyramidParameterized pyramid.
QuaternionQuaternion.normalize() returns a new Quaternion with unit length without modifying the original instance.
RectA class to represent the rectangle.
RectangleShapeIFC compatible rectangle profile.
RectangularTorusParameterized rectangular torus entity.
ReferenceModeClass with 3 members.
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 creates all resources that represented in rendering pipeline.
RenderParametersParameters for rendering.
RenderQueueGroupIdRender queue group ID.
RenderResourceBase class for render resources.
RenderStageRender stage in the pipeline.
RenderStateRender state configuration.
RendererThe context about renderer.
RendererVariableManagerManages renderer variables.
RevolvedAreaSolidRevolvedAreaSolid entity.
RotationModeThe frustum’s rotation mode.
RotationOrderThe order controls which rx ry rz are applied in the transformation matrix.
RvmFormatRVM format.
RvmLoadOptionsLoad options for RVM.
RvmSaveOptionsSave options for RVM.
SPIRVSourceSPIRV shader source.
SaveOptionsSaveOptions.export_textures determines if textures are included in the exported file.
SceneThe Scene class provides a high‑level API for loading, saving, rendering, and animating 3D content.
SceneObjectSceneObject provides find_property, get_property, and set_property methods to manage custom metadata attached to any scene object.
SemanticAttributeAllow user to use their own structure for static declaration of VertexDeclaration.
ShaderExceptionException thrown when shader compilation/linking fails.
ShaderMaterialA shader material allows to describe the material by external rendering engine or shader language.
ShaderProgramShader program.
ShaderSetSet of shaders for rendering.
ShaderSourceShader source code.
ShaderStageShader stage.
ShaderTechniqueA technique in shader material describes the concrete rendering details.
ShaderVariableShader variable.
ShapeBase class for all shape entities.
SkeletonThe Skeleton is mainly used by CAD software to help designer to manipulate the transformation of skeletal structure, it’s usually useless outside the CAD softwares.
SkeletonTypeSkeleton type enum.
SkinDeformerClass with 5 methods and 4 properties.
SphereClass with 16 methods and 19 properties.
SplitMeshPolicyShare vertex/control point data between sub-meshes or each sub-mesh has its own compacted data.
StencilActionStencil action.
StencilStateStencil state configuration.
StlExporterStlExporter.supports_format returns True if the given file format is supported for STL export.
StlFormatStlFormat.create_load_options creates an STL-specific load options object.
StlFormatDetectorStlFormatDetector.detect returns the detected FileFormat for a stream (optional file name) or None.
StlImporterStlImporter.supports_format returns true when the specified file format can be handled by this importer.
StlLoadOptionsClass with 1 method and 7 properties.
StlPluginStlPlugin.get_file_format returns the StlFormat object representing the STL file format.
StlSaveOptionsStlSaveOptions.scale specifies a uniform scaling factor applied to all coordinates during STL export.
SweptAreaSolidSweptAreaSolid entity.
TShapeIFC compatible T-shape defined by parameters.
TextText profile, this profile describes contours using font and text.
TextureThis class defines the texture from an external file.
TextureBaseBase class for all texture types.
TextureCodecTexture codec.
TextureDataTexture data.
TextureFilterTexture filter type.
TextureMappingClass with 12 members.
TextureSlotTexture slot name.
TextureTypeTexture type.
ThreeMfExporterThreeMfExporter.export writes the provided Scene to the given stream using optional export settings.
ThreeMfFormatThreeMfFormat.is_buildable(node) returns a boolean indicating whether a node can be used as a printable build object.
ThreeMfFormatDetectorThreeMfFormatDetector.detect determines the 3MF file format from a stream and optional file name, returning a FileFormat.
ThreeMfImporterThreeMfImporter.import_scene(scene, stream, options) reads a 3MF file from a stream and populates the given Scene instance.
ThreeMfLoadOptionsThreeMfLoadOptions.flip_coordinate_system swaps Y and Z coordinates when loading a 3MF file.
ThreeMfPluginThreeMfPlugin.get_exporter() returns the exporter object that implements export(scene, stream, options) for 3MF output.
ThreeMfSaveOptionsThreeMfSaveOptions.enable_compression enables compression of the exported 3MF file.
TokenToken.type indicates the token’s classification as an integer code.
TokenTypeTokenType.to_string(t) returns the textual representation of a token such as OPEN_BRACKET or DATA.
TorusParameterized torus entity.
TransformTransform.set_translation sets the translation components (tx, ty, tz) and returns the Transform.
TransformBuilderThe TransformBuilder is used to build transform matrix by a chain of transformations.
TransformedCurveTransformedCurve entity.
TrapeziumShapeIFC compatible Trapezium shape defined by parameters.
TriMeshTriMesh is a triangle mesh that stores triangles.
TrialExceptionThis is raised in Scene.Open/Scene.Save when no licenses are applied.
TrimmedCurveTrimmedCurve entity.
U3dLoadOptionsLoad options for U3D.
U3dSaveOptionsSave options for U3D.
UShapeIFC compatible U-shape defined by parameters.
UsdSaveOptionsSave options for USD.
Vector2Vector2.set sets the vector’s x and y components to the provided float values.
Vector3Vector3 offers dot product, cross product, normalization, angle calculation, and component‑wise trigonometric functions.
Vector4Vector4.set assigns new component values to the vector’s x, y, z, and w fields.
VertexVertex reference, used to access the raw vertex in TriMesh.
VertexDeclarationThe declaration of a custom defined vertex’s structure.
VertexElementVertexElement.set_indices sets the element’s index list to the provided integer list.
VertexElementBinormalClass with 7 methods and 6 properties.
VertexElementDoublesTemplateA helper class for defining concrete implementations.
VertexElementEdgeCreaseDefines the edge crease values for specified components.
VertexElementFVectorVertexElementFVector.set_data replaces the element’s data list with the provided FVector4 collection.
VertexElementHoleDefines the hole information for specified components.
VertexElementIntsTemplateA helper class for defining concrete implementations with int data.
VertexElementMaterialDefines the material for specified components.
VertexElementNormalVertexElementNormal.set_data(data) expects an iterable of normal vectors matching the mesh’s vertex count.
VertexElementPolygonGroupDefines the polygon group for specified components.
VertexElementSmoothingGroupClass with 6 methods and 6 properties.
VertexElementSpecularDefines the specular color for specified components.
VertexElementTangentVertexElementTangent.set_data(data) assigns tangent vectors to the specified vertices, while set_indices() can map them to polygon vertices when needed.
VertexElementTemplateA helper class for defining concrete implementations of vertex elements with typed data.
VertexElementTypeVertexElementType enum defines the set of supported vertex element categories, including NORMAL, TANGENT, UV, VERTEX_COLOR, SMOOTHING_GROUP, EDGE_CREASE, and others.
VertexElementUVVertexElementUV includes a texture_mapping property that describes how UV coordinates map to texture layers.
VertexElementUserDataDefines the user data for specified components.
VertexElementVector4Defines the vector4 data for specified components.
VertexElementVertexColorClass with 7 methods and 6 properties.
VertexElementVertexCreaseDefines the vertex crease values for specified components.
VertexElementVisibilityDefines the visibility for specified components.
VertexElementWeightDefines the weight for specified components.
VertexFieldVertex’s field memory layout description.
VertexFieldDataTypeVertex field’s data type.
VertexFieldSemanticThe semantic of the vertex field.
ViewportViewport for rendering.
WatermarkUtility to encode/decode blind watermark to/from a mesh.
WindowHandleWindow handle for render window.
WrapModeWrap mode for texture coordinates.
XLoadOptionsLoad options for X format.
ZShapeIFC compatible Z-shape profile that defined by parameters.

Enumerations

EnumerationDescription
ExtrapolationTypeEnum with 5 members.
InterpolationEnum with 6 members.
PoseTypeEnum with 2 members.
StepModeEnum with 2 members.
WeightedModeWeightedMode enum values NONE, OUT_WEIGHT, NEXT_IN_WEIGHT, and BOTH let developers specify how vertex weights are applied during mesh processing.

See Also

 English