Aspose.3D FOSS for Python

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

Core API

ClassDescription
A3DObjectA3DObject.find_property returns the property object matching the given name if it exists.
AnimationChannelAnimationChannel.component_type specifies the data type of the animated component.
AnimationClipAnimationClip.create_animation_node creates a new AnimationNode for the given node name.
AnimationNodeAnimationNode.find_bind_point returns the BindPoint matching the given target object and name.
AssetInfoAssetInfo.title stores the title of the 3D asset.
BinaryTokenizerBinaryTokenizer.tokenize() parses the binary data stream and advances the cursor accordingly.
BindPointBindPoint.add_channel adds a new animation channel with the specified name, value and type, returning True on success.
BooleanOperationBooleanOperation.ADD represents a union boolean operation that adds geometry.
BoundingBoxBoundingBox.get_null returns a BoundingBox representing an empty or null volume.
BoundingBoxExtentBoundingBoxExtent.extent_x represents the size of the bounding box along the X axis.
CameraCamera.move_forward moves the camera forward by the specified distance.
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.get_file_format returns the ColladaFormat object describing the Collada file type.
ColladaSaveOptionsColladaSaveOptions.flip_coordinate_system determines whether the Y and Z axes are swapped when saving.
ColladaTransformStyleColladaTransformStyle.COMPONENTS returns the transform style that uses separate translation, rotation, and scale components.
CustomObjectClass with 5 methods and 2 properties.
EntityEntity.get_bounding_box returns the axis-aligned bounding box that encloses the entity.
ExporterExporter.supports_format returns true when the exporter can handle the specified FileFormat.
ExtrapolationExtrapolation.type represents the extrapolation mode applied to animation curves.
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.create_load_options creates and returns a default FBX load options object.
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.keep_builtin_global_settings determines whether built‑in global settings are preserved when loading an FBX file.
FbxParserFbxParser.parse_value parses the provided Token and returns its evaluated value.
FbxPluginFbxPlugin.get_file_format returns the identifier or name of the FBX file format handled by the plugin.
FbxSaveOptionsFbxSaveOptions.export_textures enables exporting of texture files when saving an FBX.
FbxScopeFbxScope.add_element adds the given FbxElement to the scope’s collection.
FbxTokenizerFbxTokenizer.tokenize returns a list of Token objects representing the parsed FBX data.
FileFormatClass with 9 methods and 8 properties and 49 members.
FormatDetectorFormatDetector.detect detects the file format of the provided stream, using the optional file name, and returns a FileFormat.
GeometryGeometry.create_element creates a VertexElement of the given type, mapping and reference modes.
GlobalTransformGlobalTransform.translation is a Vector3 representing the positional offset of the transform.
GltfExporterGltfExporter.visit_node processes an individual node while traversing the scene hierarchy during export.
GltfFormatGltfFormat.create_load_options creates a GLTF-specific load options object for importing scenes.
GltfFormatDetectorGltfFormatDetector.detect determines the FileFormat of the provided stream, optionally using the file name.
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.
ImageRenderOptionsImageRenderOptions.background_color specifies the clear color used when rendering the image.
ImporterImporter.supports_format(file_format) returns true when the specified FileFormat is supported for import.
KeyFrameKeyFrame.time represents the timestamp of the keyframe in seconds.
KeyframeSequenceKeyframeSequence.reset resets the sequence to its initial empty state.
LambertMaterialLambertMaterial.emissive_color defines the RGB color that the material appears to emit as light.
LightClass with 8 methods and 24 properties.
LightTypeLightType.POINT represents a point light source emitting uniformly in all directions.
LoadOptionsClass with 1 method and 5 properties.
MappingModeMappingMode.CONTROL_POINT represents mapping based on each mesh control point individually.
MaterialMaterial.get_texture retrieves the texture assigned to the specified slot name.
Matrix4Matrix4.transpose returns a new Matrix4 that is the transpose of this matrix.
MeshMesh.create_polygon creates a new polygon and returns its index.
NodeNode.add_entity adds the given Entity to this node’s entity collection.
ObjExporterClass with 3 methods.
ObjFormatObjFormat.create_load_options creates and returns an ObjLoadOptions instance for importing OBJ files.
ObjFormatDetectorClass with 2 methods.
ObjImporterObjImporter.import_scene loads OBJ data from a stream into a Scene using ObjLoadOptions.
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.
PbrMaterialPbrMaterial.from_material creates a PbrMaterial from an existing Material instance.
PhongMaterialPhongMaterial.specular_color defines the RGB color of the specular highlight.
PluginPlugin.get_file_format returns the FileFormat object describing the supported 3D file format.
PolygonModifierPolygonModifier.triangulate triangulates polygon data and returns None, a Mesh, or a list of triangle index lists.
ProjectionTypeProjectionType.PERSPECTIVE represents a perspective projection where objects appear smaller with distance.
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.
QuaternionQuaternion.get_IDENTITY returns the identity quaternion (no rotation).
ReferenceModeReferenceMode.DIRECT represents a reference mode where vertex data is stored directly without indexing.
SaveOptionsSaveOptions.export_textures determines if textures are included in the exported file.
SceneScene.clear removes all nodes, assets, and animation data from the scene.
SceneObjectSceneObject.scene provides the Scene instance that contains this object.
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.
TextureMappingTextureMapping.AMBIENT represents the ambient texture mapping channel.
ThreeMfExporterThreeMfExporter.export writes the provided Scene to the given stream using optional export settings.
ThreeMfFormatThreeMfFormat.extension provides the primary file extension for the 3MF format.
ThreeMfFormatDetectorThreeMfFormatDetector.detect determines the 3MF file format from a stream and optional file name, returning a FileFormat.
ThreeMfImporterThreeMfImporter.supports_format returns true if the specified file format is supported.
ThreeMfLoadOptionsThreeMfLoadOptions.flip_coordinate_system swaps Y and Z coordinates when loading a 3MF file.
ThreeMfPluginThreeMfPlugin.get_file_format returns the ThreeMfFormat object that identifies the 3MF file format.
ThreeMfSaveOptionsThreeMfSaveOptions.enable_compression enables compression of the exported 3MF file.
TokenToken.type indicates the token’s classification as an integer code.
TokenToken.type indicates the token’s classification as an integer code.
TokenTypeTokenType.to_string(t) returns the name of the token type t as a string.
TokenTypeTokenType.to_string(t) returns the name of the token type t as a string.
TransformTransform.set_translation sets the translation components (tx, ty, tz) and returns the Transform.
Vector2Vector2.set sets the vector’s x and y components to the provided float values.
Vector3Vector3.dot returns the dot product of this vector with another Vector3.
Vector4Vector4.set assigns new component values to the vector’s x, y, z, and w fields.
VertexElementVertexElement.set_indices sets the element’s index list to the provided integer list.
VertexElementBinormalClass with 5 methods and 6 properties.
VertexElementFVectorVertexElementFVector.set_data replaces the element’s data list with the provided FVector4 collection.
VertexElementIntsTemplateVertexElementIntsTemplate.set_data replaces the internal integer data list with the provided list.
VertexElementNormalClass with 5 methods and 6 properties.
VertexElementSmoothingGroupClass with 5 methods and 6 properties.
VertexElementTangentClass with 5 methods and 6 properties.
VertexElementTypeVertexElementType.BINORMAL represents the per-vertex binormal vector used for tangent space calculations.
VertexElementUVVertexElementUV.texture_mapping gets or sets the texture mapping mode for the UV element.
VertexElementVertexColorClass with 5 methods and 6 properties.

Enumerations

EnumerationDescription
ExtrapolationTypeExtrapolationType.CONSTANT represents a constant extrapolation that holds the last keyframe value.
InterpolationInterpolation.CONSTANT represents a constant interpolation where values do not change over time.
StepModeStepMode.PREVIOUS_VALUE represents a step mode that selects the previous value in a sequence.
WeightedModeWeightedMode.NONE represents no weighting applied.

See Also

 English