Aspose.3D FOSS for .NET

Справочник API для Aspose.3D.Converter 1.0.0 (.NET 10.0+, лицензия MIT).

Все классы находятся в Aspose.ThreeD корневом пространстве имён. Корневая директива using:

using Aspose.ThreeD;

Конвенция именования в C#: Все свойства используют стандартный синтаксис свойств C#. Например, используйте scene.RootNode вместо scene.getRootNode(), и transform.Translation = ... вместо transform.setTranslation(...). Vector3, Vector4, Quaternion, Matrix4, и FVector типы используют публичные поля (v.X, v.Y, v.Z) для доступа к компоненту.


Основной граф сцены

ClassDescription
A3DObjectThe base class of all Aspose.ThreeD objects, all sub classes will support dynamic properties.
AnimationChannelAnimationChannel.AnimationChannel creates a new animation channel with no target specified.
AnimationClipThe Animation clip is a collection of animations.
AnimationNodeAspose.3D’s supports animation hierarchy, each animation can be composed by several animations and animation’s key-frame definition.
ArrayListAspose.3D has its own highly optimized implementation of List{T} for better loading/saving performance Only this interface is exposed for user with IList{T} compatible and similar interfaces.
AssetInfoInformation of asset.
AxisSystemСистема осей представляет собой сочетание системы координат, вектора вверх и фронтального.
BasicLoadOptionsBasic load options.
BindPointA BindPoint is usually created on an object’s property, some property types contains multiple component fields(like a Vector3 field), will generate channel for each component field and connects the field to one or more keyframe sequence instance(s) through the channels.
BoneКость определяет подмножество контрольной точки геометрии и определяют вес смеси для каждой контрольного пункта.
BooleanOperandЭтот класс включает преобразованную сетку в качестве операнда булевой операции.
BooleanOperatorClass with 12 methods and 9 properties.
BoxBox.
CameraКамера описывает точку зрения зрителя, наблюдающего за сценой.
CircleКривая состоит из множества точек на краю формы круга.
ColladaSaveOptionsSave options for Collada format.
CompositeCurveA состоит из нескольких сегментов кривой.
CurveБазовый класс всех кривых.
CustomObjectRepresents custom object data.
CylinderParameterized Cylinder.
DeformerBase class for and.
DishParameterized dish.
DracoFormatGoogle Draco format.
DracoSaveOptionsSave options for Google draco files.
EllipseЭллипс определяет набор точек, которые образуют форму эллипса.
EntityБазовый класс всех сущностей.
EntityRendererKeyКлюч рендера регистрационного объекта.
ExportExceptionExport exception.
ExtrapolationExtrapolation.Type gets or sets the extrapolation mode using the ExtrapolationType enum.
FbxLoadOptionsLoad options for FBX format.
FbxSaveOptionsSave options for FBX format.
FileFormatFile format definition.
FileFormatTypeFile format type.
FileSystemFile system encapsulation.
FileSystemFactoryFactory class for FileSystem.
FrustumThe base class of Camera and Light.
GeometryБазовый класс всех геометрических объектов, которые могут быть представлены (например, сетка, коробка, цилиндр и т.д.).
GlobalTransformГлобальная трансформация похожа на но неизменна, пока она представляет собой окончательную оцененную трансформацию.
GltfLoadOptionsLoad options for glTF format.
GltfSaveOptionsSave options for glTF format.
GroupGroup.Group(name:string) creates a Group with the specified name.
HalfSpacerepresents a infinity space which is split by a plane, this can be used with.
IOConfigКонфигурация IO для сериализации/десериализации.
IOExtensionIOExtension.Write writes the Matrix4 value to the provided BinaryWriter.
ImageRenderOptionsImage render options.
ImportExceptionImport exception.
KeyFrameKeyFrame.KeyFrame creates a new empty key frame instance.
KeyframeSequenceKeyframeSequence.KeyframeSequence creates an empty keyframe sequence with no property name.
LambertMaterialМатериал для модели тень Ламберта.
LicenseLicense management class (not available in FOSS version).
LightСвет освещает сцену.
LineПолилиния - это путь, определенный набором точек с сегментами и связанные краями. Это означает, что он также может быть наборам соединенных линейных сегментов.
LinearExtrusionЛинейная экструзия принимает 2-мерную форму в качестве входа и расширяет ее в 3-м измерении.
LoadOptionsBase class of load options.
MaterialМатериал определяет параметры, необходимые для визуального внешнего вида геометрии.
MathUtilsMathUtils.CalcNormal calculates the normal vector of a polygon defined by an array of Vector3 points.
MeshA mesh is made of many n-sided polygons.
MeteredКласс управления лицензией с измерением (не доступен в версии FOSS).
Microsoft3MFFormatФормат файла для Microsoft 3MF с связанными утилитами.
Microsoft3MFSaveOptionsClass with 2 methods and 7 properties.
MorphTargetChannelA MorphTargetChannel is used by to organize the target geometries.
MorphTargetDeformerMorphTargetDeformer provides per-vertex animation.
NodeПредставляет элемент в графике сцены.
NurbsCurveNURBS curve is a curve represented by NURBS(Non-uniform rational basis spline), A NURBS curve is defined by its control points, a set of weighted control points and a knot vector The w component in co.
NurbsDirectionA 3D surface has two direction, the U and V, the NurbsDirection defines data for each direction.
NurbsSurfaceявляется поверхностью, представленной NURBS ((Неодинаковый рациональный основной шплин), A определяется двумя и .
ObjLoadOptionsLoad options for Wavefront OBJ format.
ObjSaveOptionsSave options for Wavefront OBJ format.
ParseExceptionParseException.ParseException creates a new ParseException with the provided error message.
PatchA - это параметрическая поверхность моделирования, аналогичная , она также определяется двумя, и .
PatchDirectionPatch’s U and V direction.
PbrMaterialМатериал для физического отображения на основе цвета/металлической/грубости альбедо.
PdfFormatAdobe’s Portable Document Format.
PdfLoadOptionsOptions for PDF loading.
PdfSaveOptionsThe save options in PDF exporting.
PhongMaterialМатериал для модели затенения блинн-фонга.
PlaneParameterized plane.
PlyFormatThe PLY format.
PlyLoadOptionsPlyLoadOptions.PlyLoadOptions creates a new instance with default options for loading PLY files.
PlySaveOptionsPlySaveOptions.PlySaveOptions constructs a new instance with default PLY save settings.
PointCloudОблако точек не содержит информацию о топологии, а только контрольные точки и элементы вершин.
PolygonBuilderA helper class to build polygon for.
PolygonModifierPolygonModifier.Triangulate triangulates all faces of the supplied Mesh into triangles.
PosePose.
PrimitiveБазовый класс для всех примитивных.
Profile2D Profile in xy plane.
PropertyClass to hold user-defined properties.
PropertyCollectionThe collection of properties.
PyramidParameterized pyramid.
RectangularTorusParameterized rectangular torus.
RevolvedAreaSolidЭтот класс представляет собой твердую модель, вращая сечение поперечного проката, обеспечиваемое профилем вокруг оси.
RvmFormatThe RVM Format.
SaveOptionsBase class of save options.
SceneA scene is a top-level object that contains the nodes, geometries, materials, textures, animation, poses, sub-scenes and etc.
SceneObjectКорневой класс объектов, которые будут храниться внутри сцены.
SegmentСегмент в композитной кривой.
SemanticAttributeSemanticAttribute.SemanticAttribute creates a new attribute with the specified vertex field semantic.
ShapeФорма описывает деформацию на наборе контрольных точек, что похоже на кластерный деформер в Майя.
SkeletonСкелет используется в основном программным обеспечением CAD, чтобы помочь дизайнеру манипулировать трансформацией скелетной структуры. Обычно он бесполезен за пределами программного обеспечения CAD.
SkinDeformerДеформатор кожи содержит множество костей, каждая из которых смешивает часть геометрии с помощью веса контрольной точки.
SphereParameterized sphere.
StlLoadOptionsLoad options for STL format.
StlSaveOptionsSave options for STL format.
SweptAreaSolidA SweptAreaSolid constructs a geometry by sweeping a profile along a directrix.
TextureЭтот класс определяет текстуру из внешнего файла.
TextureBaseБазовый класс для всех конструкций бетона.
TextureSlotТекстура слота в Материале, может быть перечислена через материальный пример.
TorusParameterized torus.
TransformТрансформация содержит информацию, которая позволяет получить доступ к матрице трансформирования/масштабирования / вращения объекта при минимальных затратах. Это используется локальным трансформатором .
TransformBuilderTransformBuilder lets developers compose, prepend, or append transformation matrices with a selectable composition order, simplifying complex object placement.
TransformedCurveA TransformedCurve gives a curve a placement by using a transformation matrix.
TriMeshA TriMesh contains raw data that can be used by GPU directly.
TrialExceptionTrial exception.
TrimmedCurveОграниченная кривая, которая обрезает базовую кривую на обоих концах.
VertexVertex.ReadVector3(field) reads a 3‑component vector from the specified vertex field, enabling extraction of position data.
VertexDeclarationVertexDeclaration.VertexDeclaration creates a new, empty vertex declaration instance.
VertexElementBase class of vertex elements A vertex element type is identified by VertexElementType.
VertexElementBinormalVertexElementBinormal.VertexElementBinormal() creates a new instance with default mapping and reference modes.
VertexElementDoublesTemplateПомощник для определения конкретных реализаций.
VertexElementEdgeCreaseDefines the edge crease for specified components.
VertexElementFVectorПомощник для определения конкретных реализаций.
VertexElementHoleDefines if specified polygon is hole.
VertexElementIntsTemplateПомощник для определения конкретных реализаций.
VertexElementMaterialVertex element with material index.
VertexElementNormalVertexElementNormal.VertexElementNormal(mappingMode, referenceMode) creates a new VertexElementNormal using the given mapping and reference modes.
VertexElementPolygonGroupОпределяет группу многоугольников для определенных компонентов, чтобы сгруппировать связанные между собой многовуголи.
VertexElementSmoothingGroupГруппа гладкого изготовления - это группа многоугольников в сетке, которые должны выглядеть так, будто образуют гладующую поверхность.
VertexElementSpecularDefines specular color for specified components.
VertexElementTangentVertexElementTangent.Tangents provides a list of Vector4 objects representing per‑vertex tangent data.
VertexElementTemplateПомощник для определения конкретных реализаций.
VertexElementUVVertex element with UV coordinates.
VertexElementUserDataDefines custom user data for specified components.
VertexElementVertexColorVertex element with vector data (normals, tangents, etc.) /// /// Vertex element with color data.
VertexElementVertexCreaseDefines the vertex crease for specified components.
VertexElementVisibilityDefines if specified components is visible.
VertexElementWeightОпределяет массу смеси для определенных компонентов.
VertexFieldVertexField class lets developers define a vertex field by specifying data type, semantic, index, alias, offset, and size, and provides hashing, equality, and comparison operations.
WatermarkWatermark utilities enable embedding and extracting text watermarks in 3D files, with optional password protection and permanence.

Геометрия и сетка

InterfaceDescription
IArrayListAspose.3D has its own highly optimized implementation of List{T} for better loading/saving performance Only this interface is exposed for user with IList{T} compatible and similar interfaces.
IIndexedVertexElementVertexElement with indices data.
IMeshConvertibleEntities that implemented this interface can be converted to mesh.
INamedObjectObject that has a name.
IOrientableСубъекты, подлежащие ориентации, должны внедрять этот интерфейс.

Встроенные примитивы

StructDescription
BoundingBoxThe axis-aligned bounding box.
BoundingBox2DBoundingBox2D.BoundingBox2D initializes a new 2‑D bounding box with the specified minimum and maximum vectors.
EndPointКонечная точка для обрезания кривой может быть параметром или картографической точкой.
FMatrix4FMatrix4.FMatrix4 creates a matrix from 16 float values representing each element.
FVector2FVector2.FVector2 creates a 2‑D vector with the given x and y float components.
FVector3Represents a 3D vector.
FVector4FVector4.FVector4(x:float, y:float, z:float, w:float) creates a 4‑D vector with given x, y, z, w values.
Matrix4Matrix4.Matrix4 constructs a 4x4 matrix from the 16 supplied float components.
QuaternionA quaternion is usually used to represent a rotation in 3D space.
RectRect представляет прямоугольник с положением и размером, предлагая метод Contains для проверки того, находится ли точка внутри него.
RelativeRectangleRelativeRectangle.RelativeRectangle creates a rectangle with given left, top, width, height offsets.
Vector2Vector2.Vector2 creates a vector with both components set to the given scalar.
Vector3Класс Vector3 обеспечивает полную 3D-векторную математику, включая точечный продукт, перекрестный продукт и расчет углов между направлениями.
Vector4Vector4.Vector4 creates a vector from a Vector3 and a double w component.

Трансформ и Spatial

EnumerationDescription
AlphaSourceОпределяет, содержит ли текстура альфа-канал.
ApertureModeCamera aperture modes.
AxisAxis.
AxisAxis.XAxis represents the X axis direction.
BoneLinkModeРежим связи кости относится к тому, как кость соединена или связана с ее родительской костью в иерархической структуре.
BooleanOperationMesh’s Boolean operation.
BoundingBoxExtentРасстояние граничного поля.
ColladaTransformStyleThe node’s transformation style of node.
ComposeOrderПорядок составления матрицы трансформации.
CoordinateSystemCoordinate system.
CurveDimensionРазмеры кривых.
DracoCompressionLevelCompression level for draco file.
ExtrapolationTypeExtrapolation type.
FileContentTypeFile content type.
InterpolationThe key frame’s interpolation type.
LightTypeLight types.
MappingModeMapping mode.
NurbsTypeNURBS types.
PatchDirectionTypePatch direction’s types.
PdfLightingSchemeLightingScheme specifies the lighting to apply to 3D artwork.
PdfRenderModeРежим рендеринга определяет стиль, в котором 3D-изображение рейндеры.
ProjectionTypeCamera’s projection types.
PropertyFlagsProperty flags.
ReferenceModeReference mode.
RotationModeThe frustum’s rotation mode.
RotationOrderПорядок контролирует, какие rx ry rz применяются в матрице трансформации.
SkeletonTypeSkeleton type.
SplitMeshPolicySplit mesh policy.
StepModeStepMode.PREVIOUS_VALUE represents stepping to the previous value in a sequence.
TextureFilterВарианты фильтрации во время отбора образцов текстуры.
TextureMappingTexture mapping.
VertexElementTypeVertex element type.
VertexFieldDataTypeVertex field’s data type.
VertexFieldSemanticСемантика поля вершин.
WeightedModeWeightedMode enum describes how vertex weights are applied, supporting None, OutWeight, NextInWeight, and Both.
WrapModeTexture’s wrap mode.

Материалы и затенение

ExampleExample
MaterialАбстрактный базовый класс для всех типов материалов. Предоставляет имя и коллекцию свойств.
LambertMaterialКлассический материал, отражающий только диффузно, с Ambient, Diffuse, Emissive, Reflective, Transparency, и Texture свойства. Пространство имён: Aspose.ThreeD.Shading.
PhongMaterialРасширяет Lambert с Specular, Shininess, и SpecularPower свойства. Пространство имён: Aspose.ThreeD.Shading.
PbrMaterialМатериал физически основанного рендеринга с BaseColor, Metallic, Roughness, Occlusion, и свойства слотов текстур. Namespace: Aspose.ThreeD.Shading.

Example

ExampleExample
CameraСущность камеры. Наследует от Frustum. Прикреплено к Node для определения трансформаций точки зрения. Свойства, специфичные для формата, не раскрыты в этом издании.

Математические утилиты

ExampleExample
Vector2Вектор одинарной точности с 2 компонентами (X, Y). Используется для UV‑текстурных координат.
Vector3Вектор одинарной точности с 3 компонентами (X, Y, Z). Универсальный пространственный вектор.
Vector4Вектор из 4 компонентов одинарной точности (X, Y, Z, W). Используется для контрольных точек и данных о нормалях.
FVector3Вектор из 3 компонентов одинарной точности (float). Используется Transform.Translation и Transform.Scale.
FVector4Вектор из 4 компонентов одинарной точности (float).
QuaternionУнитарный кватернион для представления вращений (W, X, Y, Z). Используется Transform.Rotation.
Matrix44x4 transformation matrix. Used for world/local transform computations and by GlobalTransform.Matrix.
BoundingBoxОсиально-выравненный ограничивающий прямоугольник, определённый Minimum и Maximum FVector3 углами.

Example

ExampleExample
AnimationClipИменованный контейнер для диапазона анимации. A Scene может содержать несколько клипов. Заглушка декларации — данные ключевых кадров и воспроизведение пока не реализованы.

Ввод/вывод форматов

ExampleExample
Scene.Open(path)Открывает файл, определяет формат по расширению и заполняет сцену.
Scene.Open(path, options)Открывает файл с учётом формата LoadOptions.
Scene.Open(stream)Открывает из потока, автоматически определяя формат по содержимому.
Scene.Open(stream, options)Открывает из потока, зависящего от формата. LoadOptions.
Scene.Save(path)Сохраняет сцену в файл; формат определяется по расширению.
Scene.Save(path, options)Сохраняет с учётом специфики формата. SaveOptions.
Scene.Save(stream, options)Сохраняет в поток с учётом специфики формата. SaveOptions.
FileFormatРеестр поддерживаемых форматов файлов. Содержит записи, такие как FileFormat.WavefrontOBJ, FileFormat.GLTF2, FileFormat.FBX7400ASCII.
IOServiceВнутренняя абстракция ввода/вывода. Предоставляет DetectFormat() для обнаружения формата на основе потока.
LoadOptionsБазовый класс для параметров загрузки, специфичных для формата.
SaveOptionsБазовый класс для параметров сохранения, специфичных для формата.

Формат OBJ

ExampleExample
ObjLoadOptionsПараметры загрузки файлов Wavefront OBJ.
ObjSaveOptionsПараметры сохранения вывода Wavefront OBJ.

Формат STL

ExampleExample
StlLoadOptionsПараметры загрузки файлов STL.
StlSaveOptionsПараметры сохранения для вывода STL.

Формат glTF

ExampleExample
GltfLoadOptionsПараметры загрузки для файлов glTF 2.0 и GLB.
GltfSaveOptionsПараметры сохранения для вывода glTF 2.0 и GLB. Свойства, специфичные для формата, в этом издании не доступны; используйте .glb расширение для бинарного вывода.

Формат FBX

ExampleExample
FbxLoadOptionsПараметры загрузки для файлов FBX.
FbxSaveOptionsПараметры сохранения для вывода FBX. Используйте IsAscii для переключения режима ASCII/бинарного.

3MF Format

ExampleExample
TmfLoadOptionsЗагрузить параметры для файлов 3MF.
TmfSaveOptionsСохранить параметры для вывода 3MF.

Example

ExampleExample
FileContentTypeДескриптор типа содержимого: ASCII, Binary. Доступно как свойство у FileFormat.
AxisИдентифицирует координатную ось: XAxis, YAxis, ZAxis.
CoordinateSystemУказывает конвенцию правосторонности: RightHand или LeftHand.

Система свойств

ExampleExample
PropertyОдин именованный типизированный свойство на A3DObject.
PropertyCollectionИтерируемая коллекция Property объекты, прикреплённые к A3DObject.

См. также

 Русский