Tham chiếu API cho aspose-3d-foss 26.1.0 (Python 3.7 – 3.12, giấy phép MIT).
Tất cả các lớp được nhập từ aspose.threed gói hoặc các gói con của nó. Lệnh nhập gốc là:
Đồ thị Cảnh Cốt lõi
| Properties | Properties |
|---|
Scene | Bộ chứa cấp cao nhất cho tất cả dữ liệu cảnh 3D. Chứa nút gốc, siêu dữ liệu tài sản và các đoạn hoạt hình. Cung cấp from_file(), open(), và save() như các điểm vào I/O chính. |
Node | Một nút có tên trong cây cảnh. Sở hữu một danh sách các nút con và một danh sách các đối tượng được đính kèm Entity các đối tượng như lưới, máy ảnh và đèn. Mang một cục bộ Transform. |
Entity | Lớp cơ sở trừu tượng cho tất cả các đối tượng có thể được gắn vào một Node. Cung cấp tên và danh tính nhưng không có hình học riêng. |
SceneObject | Lớp cơ sở được chia sẻ bởi Node và Entity. Cung cấp giao diện bộ sưu tập thuộc tính được sử dụng cho siêu dữ liệu do người dùng định nghĩa. |
A3DObject | Lớp cơ sở gốc cho tất cả các đối tượng được quản lý Aspose.3D. Tiết lộ thuộc tính tên và the Properties bộ sưu tập. |
INamedObject | Giao diện đảm bảo một name thuộc tính. Được triển khai bởi Node, Entity, và một số loại mô tả đặc thù cho định dạng. |
Hình học và Lưới
| Properties | Properties |
|---|
Mesh | Thực thể lưới đa giác. Lưu trữ các điểm điều khiển (vị trí đỉnh dưới dạng Vector4), danh sách mặt đa giác (danh sách các chỉ số điểm điều khiển), và các lớp phần tử đỉnh (bình thường, UV, màu đỉnh). |
Geometry | Cơ sở trừu tượng cho các loại hình học dạng lưới. Định nghĩa mảng điểm điều khiển và tập hợp của VertexElement các lớp. Mesh kế thừa từ Geometry. |
VertexElement | Lớp cơ sở trừu tượng cho một lớp dữ liệu gắn vào hình học (normals, UVs, colours, v.v.). Mang mapping_mode, reference_mode, và một data danh sách. |
VertexElementNormal | Lưu trữ một vector pháp tuyến cho mỗi đỉnh hoặc mỗi góc đa giác, tùy thuộc vào mapping_mode. Các giá trị dữ liệu là FVector4 các thể hiện (độ chính xác đơn) với w không sử dụng. |
VertexElementUV | Lưu trữ dữ liệu tọa độ texture dưới dạng FVector4 theo đỉnh hoặc theo góc đa giác (chỉ x và y các thành phần được sử dụng cho UV). Một lưới có thể chứa nhiều lớp UV cho các kênh texture khác nhau. |
VertexElementVertexColor | Lưu trữ dữ liệu màu RGBA theo-đỉnh hoặc theo-góc dưới dạng FVector4 (r, g, b, a trong khoảng 0–1). |
VertexElementSmoothingGroup | Lưu trữ các ID số nguyên của nhóm làm mịn theo-đa giác, được trình nhập OBJ sử dụng để tái tạo các phân công nhóm làm mịn gốc từ tệp nguồn. |
VertexElementType | Liệt kê xác định vai trò ngữ nghĩa của lớp phần tử đỉnh: NORMAL, UV, VERTEX_COLOR, SMOOTHING_GROUP, và các phần khác. Truyền các giá trị tới Mesh.get_element(). |
MappingMode | Liệt kê kiểm soát primitive nào mà giá trị phần tử đỉnh sẽ ánh xạ tới: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, hoặc ALL_SAME. |
ReferenceMode | Liệt kê kiểm soát cách các giá trị được đánh chỉ mục: DIRECT (một giá trị cho mỗi primitive ánh xạ) hoặc INDEX_TO_DIRECT (mảng giá trị cộng với một mảng chỉ mục riêng biệt). |
PolygonModifier | Lớp tiện ích tĩnh với các phương thức để tạo tam giác Mesh các đối tượng và toàn bộ Scene đồ thị. |
Biến đổi và Không gian
| Properties | Properties |
|---|
Transform | Biến đổi cục bộ được gắn vào một Node. Cung cấp phép dịch, quay (như Quaternion), và các thành phần tỉ lệ, cộng thêm các thuộc tính tiện lợi cho góc Euler. |
GlobalTransform | Chế độ xem chỉ đọc của biến đổi không gian thế giới của một nút sau khi hợp nhất tất cả các biến đổi của tổ tiên. Truy cập qua Node.global_transform. |
AssetInfo | Khối siêu dữ liệu được gắn vào một Scene. Lưu trữ tên ứng dụng tạo, tên đơn vị, hệ số tỉ lệ đơn vị, định nghĩa trục hệ tọa độ, và dấu thời gian tạo/điều chỉnh. |
Vật liệu và Đổ bóng
| Properties | Properties |
|---|
Material | Lớp cơ sở trừu tượng cho mọi loại vật liệu. Cung cấp một tên và một bộ sưu tập thuộc tính cho các tham số số và màu sắc. |
LambertMaterial | Mô hình vật liệu chỉ khuếch tán. Lưu trữ màu môi trường, màu khuếch tán, màu phát sáng và độ trong suốt. Được tải từ các tệp OBJ sử dụng cơ bản Ka/Kd/Ke các khai báo. |
PhongMaterial | Properties LambertMaterial với màu phản chiếu và độ bóng (số mũ phản chiếu). Được tải từ các tệp OBJ sử dụng Ks/Ns các khai báo. |
PbrMaterial | Vật liệu Đồ họa Dựa trên Vật lý. Lưu trữ albedo, hệ số kim loại, hệ số độ nhám và các texture liên quan. Được sử dụng bởi glTF 2.0 và các định dạng hỗ trợ PBR khác. |
Camera và Chiếu sáng
| Properties | Properties |
|---|
Camera | Thực thể Camera. Chỉ projection_type và name hoạt động trong phiên bản này; tất cả các thuộc tính số khác (near_plane, far_plane, field_of_view, aspect_ratio) là các stub trả về giá trị mặc định. Được gắn vào một Node để định nghĩa các phép biến đổi góc nhìn. |
Light | Thực thể nguồn sáng. Kế thừa từ Camera như một lớp stub; Light lớp này không tiết lộ các thuộc tính bổ sung nào trong phiên bản này. |
LightType | Liệt kê các danh mục ánh sáng được hỗ trợ: POINT, DIRECTIONAL, SPOT, AREA, VOLUME. |
ProjectionType | Liệt kê các chế độ chiếu máy ảnh: PERSPECTIVE và ORTHOGRAPHIC. |
Tiện ích toán học
| Properties | Properties |
|---|
Vector2 | Vector 2 thành phần Double-precision (x, y). Được dùng cho tọa độ texture UV. |
Vector3 | Vector 3 thành phần Double-precision (x, y, z). Được dùng cho vị trí, hướng và tỉ lệ. |
Vector4 | Vector 4 thành phần Double-precision (x, y, z, w). Được dùng cho các điểm điều khiển (vị trí đồng nhất) và dữ liệu pháp tuyến. |
FVector2 | Vector float 2 thành phần Single-precision. Được sử dụng nội bộ để lưu trữ gọn gàng trong các mảng dữ liệu phần tử đỉnh. |
FVector3 | Vector float 3 thành phần Single-precision. Xuất hiện trong các mảng dữ liệu phần tử đỉnh cho các pháp tuyến và tiếp tuyến. |
FVector4 | Vector số thực 4 thành phần độ chính xác đơn. Kiểu lưu trữ của VertexElementFVector.data. |
Quaternion | Quaternion đơn vị để biểu diễn các phép quay (w, x, y, z). Được sử dụng bởi Transform.rotation. |
Matrix4 | 4×4 double-precision transformation matrix. Used for world/local transform computations and can be constructed from TRS decompositions. |
BoundingBox | Hộp bao trùm căn trục được định nghĩa bởi minimum và maximum Vector3 các góc. Được sử dụng cho các truy vấn không gian và các công cụ hỗ trợ frustum culling. |
Properties
| Properties | Properties |
|---|
AnimationClip | Bộ chứa có tên cho một tập hợp các kênh hoạt hình bao phủ một khoảng thời gian phát lại. Một Scene có thể chứa nhiều clip (ví dụ: “Walk”, “Run”). |
AnimationNode | Liên kết một AnimationClip đến một nút cảnh hoặc thuộc tính cụ thể. Hoạt động như cầu nối giữa dữ liệu clip và các đối tượng đồ thị cảnh. |
AnimationChannel | Một luồng thuộc tính được hoạt hình duy nhất trong một clip, nhắm mục tiêu vào một thuộc tính có tên trên một đối tượng (ví dụ:., Transform.translation.x). |
KeyFrame | Một mẫu thời gian–giá trị duy nhất trong một KeyframeSequence. Lưu trữ thời gian (theo giây) và giá trị tại thời điểm đó. |
KeyframeSequence | Một danh sách có thứ tự của KeyFrame các đối tượng cho một kênh vô hướng, cùng với các cài đặt nội suy và ngoại suy. |
Interpolation | Liệt kê các chế độ nội suy giữa các khung chính: CONSTANT, LINEAR, BEZIER, B_SPLINE, CARDINAL_SPLINE, TCB_SPLINE. |
ExtrapolationType | Liệt kê các hành vi ngoài khung chính đầu tiên và cuối cùng: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE. |
Đầu vào/Đầu ra Định dạng
| Properties | Properties |
|---|
Scene.from_file(path) | Phương thức tĩnh. Mở tệp tại path, phát hiện định dạng từ phần mở rộng, và trả về một Scene. Bắt lỗi khi không tìm thấy tệp hoặc định dạng không được hỗ trợ. |
Scene.open(path, options=None) | Phương thức thể hiện. Mở tệp vào một Scene thể hiện, tùy chọn sử dụng một LoadOptions lớp con. |
Scene.save(path, options=None) | Phương thức instance. Chuỗi hoá cảnh thành path sử dụng định dạng được suy ra từ phần mở rộng, tùy chọn sử dụng một định dạng‑cụ thể SaveOptions lớp con. |
FileFormat | Danh bạ các định dạng tệp được hỗ trợ. Chứa các mục như FileFormat.WAVEFRONT_OBJ, FileFormat.GLTF, FileFormat.FBX7400ASCII, FileFormat.MICROSOFT_3MF. Các biến thể định dạng‑cụ thể được truy cập qua các lớp tùy chọn (ví dụ,., ColladaSaveOptions, GltfSaveOptions). |
IOService | Trừu tượng I/O nội bộ được các bộ nhập và xuất định dạng sử dụng. Thông thường không được mã ứng dụng sử dụng trực tiếp. |
LoadOptions | Lớp cơ sở cho tất cả các đối tượng tùy chọn tải‑định dạng‑cụ thể. Được kế thừa bởi ObjLoadOptions, StlLoadOptions, GltfLoadOptions, FbxLoadOptions, ColladaLoadOptions, ThreeMfLoadOptions. |
SaveOptions | Lớp cơ sở cho tất cả các đối tượng tùy chọn lưu‑định dạng‑cụ thể. Được kế thừa bởi ObjSaveOptions, StlSaveOptions, GltfSaveOptions, FbxSaveOptions, ColladaSaveOptions, ThreeMfSaveOptions. |
Định dạng OBJ
| Properties | Properties |
|---|
ObjImporter | Lớp nhập nội bộ phân tích các tệp Wavefront OBJ và MTL. Được gọi tự động bởi Scene.from_file() cho .obj các phần mở rộng. |
ObjLoadOptions | Tùy chọn tải cho các tệp Wavefront OBJ. Các thuộc tính chính: flip_coordinate_system, scale, enable_materials, normalize_normal. |
ObjSaveOptions | Tùy chọn lưu cho đầu ra Wavefront OBJ. Kiểm soát normals, UVs, material references, và point-cloud mode. |
ObjFormat | Bộ mô tả định dạng cho Wavefront OBJ. Có thể truy cập dưới dạng FileFormat.WAVEFRONT_OBJ(). |
Định dạng STL
| Properties | Properties |
|---|
StlImporter | Bộ nhập nội bộ đọc cả các tệp STL nhị phân và ASCII. Được chọn tự động theo phần mở rộng. |
StlExporter | Bộ xuất nội bộ ghi STL. |
StlLoadOptions | Tải các tùy chọn cho tệp STL. Hỗ trợ flip_coordinate_system và scale. |
StlSaveOptions | Lưu các tùy chọn cho đầu ra STL. Điều khiển binary_mode, scale, và flip_coordinate_system. |
StlFormat | Mô tả định dạng cho STL. |
Định dạng glTF
| Properties | Properties |
|---|
GltfLoadOptions | Tải các tùy chọn cho tệp glTF 2.0 và GLB. Thuộc tính chính: flip_tex_coord_v. |
GltfSaveOptions | Lưu các tùy chọn cho đầu ra glTF 2.0. Sử dụng binary_mode=True cho một gói GLB tự chứa. |
GltfFormat | Mô tả định dạng cho glTF 2.0 / GLB. Truy cập dưới dạng FileFormat.GLTF2(). |
Định dạng FBX
| Properties | Properties |
|---|
FbxLoadOptions | Tùy chọn tải cho tệp FBX. Các thuộc tính chính: keep_builtin_global_settings, compatible_mode. |
FbxSaveOptions | Tùy chọn lưu cho đầu ra FBX. Kiểm soát nén, nhúng texture, và các thuộc tính vật liệu. |
FbxFormat | Mô tả định dạng cho FBX. Truy cập dưới dạng FileFormat.FBX7400ASCII(). |
Định dạng COLLADA
| Properties | Properties |
|---|
ColladaLoadOptions | Tùy chọn tải cho COLLADA (.dae) tệp. Kiểm soát việc ánh xạ lại trục và tỷ lệ đơn vị khi nhập. |
ColladaSaveOptions | Tùy chọn lưu cho đầu ra COLLADA. Kiểm soát indented, flip_coordinate_system, và xuất vật liệu. |
ColladaFormat | Mô tả định dạng cho COLLADA. Được tự động xác định từ .dae phần mở rộng tệp. |
3MF Format
| Properties | Properties |
|---|
ThreeMfLoadOptions | Tùy chọn tải cho 3MF (.3mf) tệp. |
ThreeMfSaveOptions | Tùy chọn lưu cho đầu ra 3MF. 3MF là định dạng ưu tiên cho quy trình in 3D. |
ThreeMfFormat | Mô tả định dạng cho 3MF. Có thể truy cập dưới dạng FileFormat.MICROSOFT_3MF_FORMAT(). |
Properties
| Properties | Properties |
|---|
TextureMapping | Xác định cách một texture được ánh xạ lên hình học: DIFFUSE, SPECULAR, EMISSIVE, NORMAL, AMBIENT, v.v. |
BooleanOperation | Kiểu thao tác Boolean CSG: UNION, DIFFERENCE, INTERSECTION. |
Hệ thống Thuộc tính
| Properties | Properties |
|---|
Property | Một thuộc tính có tên và kiểu duy nhất trên một A3DObject. Lưu trữ tên thuộc tính, mô tả kiểu, và giá trị hiện tại. |
PropertyCollection | Bộ sưu tập có thể lặp lại của Property các đối tượng được gắn vào một A3DObject. Hỗ trợ tra cứu theo tên và lặp lại tất cả các thuộc tính đã định nghĩa. |
CustomObject | Một phiên bản nhẹ A3DObject lớp con chỉ mang một tên và một arbitrary PropertyCollection. Được sử dụng để lưu trữ siêu dữ liệu do người dùng định nghĩa trên các đối tượng trong cảnh. |
Hình ảnh và Kết xuất
| Properties | Properties |
|---|
ImageRenderOptions | Các tùy chọn cho software rasterisation khi rendering một cảnh vào bộ đệm hình ảnh. Lưu trữ màu nền, kích thước hình ảnh và tham chiếu camera. Tính năng này có sẵn trong các cấu hình được hỗ trợ. |
Xem thêm