Справочник API для aspose-3d-foss 26.1.0 (Python 3.7 – 3.12, лицензия MIT).
Все классы импортируются из aspose.threed пакета или его подпакетов. Корневой импорт:
Основной граф сцены
| Example | Example |
|---|
Scene | Контейнер верхнего уровня для всех данных 3D‑сцены. Содержит корневой узел, метаданные ресурсов и анимационные клипы. Предоставляет from_file(), open(), и save() в качестве основных точек входа ввода/вывода. |
Node | Именованный узел в иерархии сцены. Содержит список дочерних узлов и список присоединённых Entity объектов, таких как меши, камеры и источники света. Содержит локальный Transform. |
Entity | Абстрактный базовый класс для всех объектов, которые могут быть присоединены к Node. Предоставляет имя и идентичность, но не имеет собственной геометрии. |
SceneObject | Базовый класс, общий для Node и Entity. Предоставляет интерфейс коллекции свойств, используемый для пользовательских метаданных. |
A3DObject | Корневой базовый класс для всех управляемых объектов Aspose.3D. Предоставляет свойство name и the Properties коллекция. |
INamedObject | Интерфейс, который гарантирует name свойство. Реализуется в Node, Entity, и несколько специфичных для формата типов дескрипторов. |
Геометрия и сетка
| Example | Example |
|---|
Mesh | Сущность полигональной сетки. Хранит контрольные точки (позиции вершин как Vector4), списки граней полигонов (списки индексов контрольных точек), и слои элементов вершин (нормали, UV, цвета вершин). |
Geometry | Абстрактная база для типов геометрии, похожей на сетку. Определяет массив контрольных точек и коллекцию VertexElement слоёв. Mesh наследуется от Geometry. |
VertexElement | Абстрактная база для слоя данных, привязанного к геометрии (нормали, UV, цвета и т.д.). Содержит mapping_mode, reference_mode, и data список. |
VertexElementNormal | Сохраняет один вектор нормали на вершину или на угол полигона, в зависимости от mapping_mode. Значения данных FVector4 экземпляры (одинарной точности) с w не используется. |
VertexElementUV | Сохраняет данные координат текстуры как FVector4 по вершине или по углу полигона (только x и y компоненты используются для UV). Сетка может содержать несколько UV-слоёв для разных текстурных каналов. |
VertexElementVertexColor | Сохраняет данные цвета RGBA по вершине или по углу как FVector4 (r, g, b, a в диапазоне 0–1). |
VertexElementSmoothingGroup | Сохраняет целочисленные идентификаторы групп сглаживания по полигону, используемые импортёром OBJ для восстановления оригинальных назначений групп сглаживания из исходного файла. |
VertexElementType | Перечисление, определяющее семантическую роль слоя элемента вершины: NORMAL, UV, VERTEX_COLOR, SMOOTHING_GROUP, и другие. Передайте значения в Mesh.get_element(). |
MappingMode | Перечисление, определяющее, к какому примитиву сопоставляется значение элемента вершины: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, или ALL_SAME. |
ReferenceMode | Перечисление, определяющее, как индексируются значения: DIRECT (одно значение на каждый примитив отображения) или INDEX_TO_DIRECT (массив значений плюс отдельный массив индексов). |
PolygonModifier | Статический вспомогательный класс с методами для триангуляции Mesh объектов и целых Scene графы. |
Трансформация и пространство
| Example | Example |
|---|
Transform | Локальное преобразование, прикреплённое к Node. Предоставляет перемещение, вращение (как Quaternion), и компоненты масштабирования, а также удобные свойства для углов Эйлера. |
GlobalTransform | Только для чтения представление преобразования узла в мировом пространстве после композиции всех преобразований предков. Доступно через Node.global_transform. |
AssetInfo | Блок метаданных, прикреплённый к Scene. Сохраняет название приложения‑создателя, название единицы, коэффициент масштаба единицы, определения осей системы координат и метки времени создания/изменения. |
Материалы и затенение
| Example | Example |
|---|
Material | Абстрактный базовый класс для всех типов материалов. Предоставляет имя и коллекцию свойств для числовых и цветовых параметров. |
LambertMaterial | Материал только с диффузным отражением. Сохраняет цвет окружающего света, диффузный цвет, эмиссионный цвет и прозрачность. Загружается из OBJ‑файлов, использующих базовые Ka/Kd/Ke объявления. |
PhongMaterial | Example LambertMaterial с зеркальным (спекулярным) цветом и блеском (спекулярный показатель). Загружается из OBJ‑файлов, использующих Ks/Ns объявления. |
PbrMaterial | Материал физически основанного рендеринга (Physically Based Rendering). Сохраняет альбедо, коэффициент металличности, коэффициент шероховатости и связанные текстуры. Используется в glTF 2.0 и других форматах, поддерживающих PBR. |
Камера и освещение
| Example | Example |
|---|
Camera | Сущность камеры. Только projection_type и name работают в этом издании; все остальные числовые свойства (near_plane, far_plane, field_of_view, aspect_ratio) являются заглушками, которые возвращают значения по умолчанию. Прикреплены к a Node для определения трансформаций точки зрения. |
Light | Сущность источника света. Наследуется от Camera как заглушка‑класс; Light сам класс не раскрывает дополнительных свойств в этом выпуске. |
LightType | Перечисление поддерживаемых категорий света: POINT, DIRECTIONAL, SPOT, AREA, VOLUME. |
ProjectionType | Перечисление режимов проекции камеры: PERSPECTIVE и ORTHOGRAPHIC. |
Математические утилиты
| Example | Example |
|---|
Vector2 | Вектор двойной точности с 2 компонентами (x, y). Используется для UV‑текстурных координат. |
Vector3 | Вектор двойной точности с 3 компонентами (x, y, z). Используется для позиций, направлений и масштаба. |
Vector4 | Вектор двойной точности с 4 компонентами (x, y, z, w). Используется для контрольных точек (однородных позиций) и данных о нормалях. |
FVector2 | Вектор одинарной точности с 2 компонентами типа float. Используется внутри для компактного хранения в массивах данных элементов вершин. |
FVector3 | Вектор одинарной точности с 3 компонентами типа float. Содержится в массивах данных элементов вершин для нормалей и тангенсов. |
FVector4 | Вектор с плавающей точкой одинарной точности из 4 компонентов. Тип хранения VertexElementFVector.data. |
Quaternion | Единичный кватернион для представления вращений (w, x, y, z). Используется Transform.rotation. |
Matrix4 | 4×4 double-precision transformation matrix. Used for world/local transform computations and can be constructed from TRS decompositions. |
BoundingBox | Осиально-выравненный ограничивающий короб (AABB), определённый minimum и maximum Vector3 углами. Используется для пространственных запросов и вспомогательных функций отсечения фрустума. |
Example
| Example | Example |
|---|
AnimationClip | Именованный контейнер для набора анимированных каналов, охватывающих один диапазон воспроизведения. A Scene может содержать несколько клипов (например, «Walk», «Run»). |
AnimationNode | Привязывает AnimationClip к конкретному узлу сцены или свойству. Служит мостом между данными клипа и объектами графа сцены. |
AnimationChannel | Один поток анимированного свойства внутри клипа, направленный на именованное свойство объекта (например,., Transform.translation.x). |
KeyFrame | Один образец времени‑значения внутри KeyframeSequence. Сохраняет время (в секундах) и значение в этот момент. |
KeyframeSequence | Упорядоченный список KeyFrame объектов для одного скалярного канала, вместе с настройками интерполяции и экстраполяции. |
Interpolation | Перечисление режимов интерполяции между ключевыми кадрами: CONSTANT, LINEAR, BEZIER, B_SPLINE, CARDINAL_SPLINE, TCB_SPLINE. |
ExtrapolationType | Перечисление поведения за пределами первого и последнего ключевого кадра: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE. |
Ввод/вывод форматов
| Example | Example |
|---|
Scene.from_file(path) | Статический метод. Открывает файл по адресу path, определяет формат по расширению и возвращает заполненный Scene. Вызывает исключение при отсутствии файла или неподдерживаемом формате. |
Scene.open(path, options=None) | Метод экземпляра. Открывает файл в существующем Scene экземпляре, при необходимости используя специфичный для формата LoadOptions подкласс. |
Scene.save(path, options=None) | Метод экземпляра. Сериализует сцену в path используя формат, определяемый по расширению, при необходимости используя специфичный для формата SaveOptions подкласс. |
FileFormat | Реестр поддерживаемых форматов файлов. Содержит записи, такие как FileFormat.WAVEFRONT_OBJ, FileFormat.GLTF, FileFormat.FBX7400ASCII, FileFormat.MICROSOFT_3MF. Варианты, зависящие от формата, доступны через классы опций (например,., ColladaSaveOptions, GltfSaveOptions). |
IOService | Внутренняя абстракция ввода/вывода, используемая импортёрами и экспортёрами форматов. Обычно не используется напрямую кодом приложения. |
LoadOptions | Базовый класс для всех объектов опций загрузки, зависящих от формата. Подклассы: ObjLoadOptions, StlLoadOptions, GltfLoadOptions, FbxLoadOptions, ColladaLoadOptions, ThreeMfLoadOptions. |
SaveOptions | Базовый класс для всех объектов опций сохранения, зависящих от формата. Подклассы: ObjSaveOptions, StlSaveOptions, GltfSaveOptions, FbxSaveOptions, ColladaSaveOptions, ThreeMfSaveOptions. |
Формат OBJ
| Example | Example |
|---|
ObjImporter | Внутренний класс импортера, который разбирает файлы Wavefront OBJ и MTL. Вызывается автоматически by Scene.from_file() для .obj расширения. |
ObjLoadOptions | Параметры загрузки для файлов Wavefront OBJ. Ключевые свойства: flip_coordinate_system, scale, enable_materials, normalize_normal. |
ObjSaveOptions | Параметры сохранения для вывода Wavefront OBJ. Управляет нормалями, UV‑координатами, ссылками на материалы и режимом облака точек. |
ObjFormat | Дескриптор формата для Wavefront OBJ. Доступен как FileFormat.WAVEFRONT_OBJ(). |
Формат STL
| Example | Example |
|---|
StlImporter | Внутренний импортер, который читает как бинарные, так и ASCII‑файлы STL. Выбирается автоматически по расширению. |
StlExporter | Внутренний экспортер, который записывает STL. |
StlLoadOptions | Параметры загрузки для файлов STL. Поддерживает flip_coordinate_system и scale. |
StlSaveOptions | Параметры сохранения для вывода STL. Управляет binary_mode, scale, и flip_coordinate_system. |
StlFormat | Дескриптор формата для STL. |
Формат glTF
| Example | Example |
|---|
GltfLoadOptions | Параметры загрузки для файлов glTF 2.0 и GLB. Ключевое свойство: flip_tex_coord_v. |
GltfSaveOptions | Параметры сохранения для вывода glTF 2.0. Используйте binary_mode=True для автономного пакета GLB. |
GltfFormat | Описание формата для glTF 2.0 / GLB. Доступно как FileFormat.GLTF2(). |
Формат FBX
| Example | Example |
|---|
FbxLoadOptions | Параметры загрузки для файлов FBX. Ключевые свойства: keep_builtin_global_settings, compatible_mode. |
FbxSaveOptions | Параметры сохранения для вывода FBX. Управляет сжатием, встраиванием текстур и свойствами материалов. |
FbxFormat | Описание формата для FBX. Доступно как FileFormat.FBX7400ASCII(). |
Формат COLLADA
| Example | Example |
|---|
ColladaLoadOptions | Параметры загрузки для COLLADA (.dae) файлов. Управляет переназначением осей и масштабом единиц при импорте. |
ColladaSaveOptions | Параметры сохранения для вывода COLLADA. Управляет indented, flip_coordinate_system, а также экспортом материалов. |
ColladaFormat | Дескриптор формата для COLLADA. Определяется автоматически из .dae расширения файла. |
3MF Format
| Example | Example |
|---|
ThreeMfLoadOptions | Параметры загрузки для 3MF (.3mf) файлов. |
ThreeMfSaveOptions | Параметры сохранения для вывода 3MF. 3MF является предпочтительным форматом для рабочих процессов 3D‑печати. |
ThreeMfFormat | Дескриптор формата для 3MF. Доступен как FileFormat.MICROSOFT_3MF_FORMAT(). |
Example
| Example | Example |
|---|
TextureMapping | Определяет, как текстура отображается на геометрию: DIFFUSE, SPECULAR, EMISSIVE, NORMAL, AMBIENT, и т.д. |
BooleanOperation | Тип булевой операции CSG: UNION, DIFFERENCE, INTERSECTION. |
Система свойств
| Example | Example |
|---|
Property | Один именованный типизированный параметр на A3DObject. Сохраняет имя свойства, дескриптор типа и текущее значение. |
PropertyCollection | Итерируемая коллекция Property объекты, прикреплённые к A3DObject. Поддерживает поиск по имени и итерацию по всем определённым свойствам. |
CustomObject | Лёгкий A3DObject подкласс, который содержит только имя и произвольный PropertyCollection. Используется для хранения пользовательских метаданных в объектах сцены. |
Изображение и рендер
| Example | Example |
|---|
ImageRenderOptions | Опции программной растеризации при рендеринге сцены в буфер изображения. Сохраняет цвет фона, размеры изображения и ссылку на камеру. Эта функция доступна в поддерживаемых конфигурациях. |
См. также