API Overview — @aspose/3d for TypeScript

Paquet: @aspose/3d (v24.12.0) Llenguatge: TypeScript / Node.js 18+ Llicència: MIT

@aspose/3d és una biblioteca amb llicència MIT per llegir, construir i exportar escenes 3D a Node.js. Ve amb definicions de tipus TypeScript completes, una única dependència d’execució (xmldom), i admet set formats de fitxer 3D principals. Tot l’E/S és sincrònic. No es requereixen complements natius.


Enumerations

npm install @aspose/3d

Enumerations tsconfig.json paràmetres per a la resolució correcta de subcamins:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "moduleResolution": "node",
    "esModuleInterop": true,
    "strict": true
  }
}

Classes principals

Enumerations

El contenidor arrel d’una escena 3D. Tot el contingut; nodes, geometria, materials i animacions; s’emmagatzema en un arbre arrelat a scene.rootNode.Utilitzeu open() / openFromBuffer() per carregar un fitxer i save() / saveToBuffer() per exportar.

EnumerationsEnumerationsEnumerations
rootNodeNodeArrel del gràfic de l’escena
assetInfoAssetInfoMetadades del fitxer (creador, unitats, sistema de coordenades)
animationClipsAnimationClip[]Tots els clips d’animació de l’escena
open(path, opts?)(string, LoadOptions?) → voidCarrega un fitxer des del disc
openFromBuffer(buf, opts?)(Buffer, LoadOptions?) → voidCarrega des d’un buffer en memòria
save(path, opts?)(string, SaveOptions?) → voidDesa al disc (format inferit de l’extensió)
saveToBuffer(ext, opts?)(string, SaveOptions?) → BufferDesa a un buffer en memòria
createAnimationClip(name)(string) → AnimationClipCrea i registra un nou clip d’animació

Enumerations

Un node d’arbre amb nom al gràfic de l’escena. Els nodes porten un opcional Entity (malla, càmera, llum) i una Transform que posiciona el node respecte del seu pare.

EnumerationsEnumerationsEnumerations
namestringNom del node
childNodesNode[]Nodes fills directes
entity`Entitynull`
transformTransformTraducció, rotació i escala locals
materialsMaterial[]Materials assignats a aquest node
createChildNode(name)(string) → NodeAfegeix un node fill
getChildNode(name)`(string) → Nodenull`

Enumerations

Malla de polígons; el tipus de geometria principal. Estén Geometry.

EnumerationsEnumerationsEnumerations
controlPointsVector4[]Posicions dels vèrtexs (w=1 per a posicions)
polygonCountnumberNombre de polígons
createPolygon(indices)(number[]) → voidAfegeix un polígon (triangle o quad)
getElement(type)`(VertexElementType) → VertexElementnull`
createElement(type)(VertexElementType) → VertexElementCrea un element de vèrtex

Enumerations

Transformació local aplicada a un node.

EnumerationsEnumerationsEnumerations
translationVector3Posició local
eulerAnglesVector3Rotació d’Euler en graus (ordre XYZ)
rotationQuaternionRotació com a quaternió
scalingVector3Escala local

Classes de material

EnumerationsEnumerationsPropietats clau
LambertMaterialOmbrejat difús + ambientdiffuseColor, ambientColor, transparency
PhongMaterialAfegeix especular + emissiu a LambertspecularColor, shininess, emissiveColor
PbrMaterialBasat en la física per a glTF 2.0albedo, metallicFactor, roughnessFactor, emissiveColor

Classes matemàtiques

EnumerationsEnumerations
Vector33-component double-precision vector (x, y, z)
Vector44-component vector for homogeneous math (x, y, z, w)
FVector3Variant de precisió simple utilitzada en dades de vèrtex
Matrix44×4 transformation matrix; multiply, invert, decompose
QuaternionQuaternió de rotació; fromEulerAngle, toEulerAngles, slerp
BoundingBoxCaixa delimitadora alineada a l’eix; minimum, maximum, center, size, merge

Classes d’animació

EnumerationsEnumerations
AnimationClipClip anomenat; conté AnimationNode llista; accedida via scene.animationClips
AnimationNodeEnllaça un clip a un node d’escena anomenat; conté AnimationChannel llista
AnimationChannelApunta a una única propietat (p. ex. translació X); conté un KeyframeSequence
KeyframeSequenceLlista ordenada de KeyFrame objectes amb interpolation i extrapolation
KeyFrameParell únic de temps/valor

Enumerations

EnumerationsEnumerationsEnumerations
VertexElementTypeNORMAL, UV, VERTEX_COLOR, BINORMAL, TANGENTSemàntica de l’element vèrtex
MappingModeCONTROL_POINT, POLYGON_VERTEX, POLYGON, ALL_SAMECom es mapen les dades a la geometria
ReferenceModeDIRECT, INDEX, INDEX_TO_DIRECTEstratègia d’indexació per a les dades de l’element vèrtex
InterpolationCONSTANT, LINEAR, BEZIERInterpolació de fotogrames clau
ExtrapolationCONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATEComportament fora de l’interval de fotogrames clau

Mòduls de format

Les classes d’opcions específiques de format s’exporten des de mòduls de subcamins. Importeu-les per separat:

import { ObjLoadOptions } from '@aspose/3d/formats/obj';
import { GltfSaveOptions, GltfFormat } from '@aspose/3d/formats/gltf';
import { StlLoadOptions, StlSaveOptions } from '@aspose/3d/formats/stl';
import { FbxLoadOptions, FbxSaveOptions } from '@aspose/3d/formats/fbx';
import { ColladaLoadOptions } from '@aspose/3d/formats/collada';
import { ThreeMfSaveOptions } from '@aspose/3d/formats/3mf';

Mòdul OBJ (@aspose/3d/formats/obj)

EnumerationsOpcions clau
ObjLoadOptionsenableMaterials, flipCoordinateSystem, scale, normalizeNormal

Mòdul glTF/GLB (@aspose/3d/formats/gltf)

EnumerationsOpcions clau
GltfSaveOptionsbinaryMode (true → .glb), flipTexCoordV
GltfFormatGltfFormat.getInstance(): instància de format per a scene.save()

Mòdul STL (@aspose/3d/formats/stl)

EnumerationsOpcions clau
StlLoadOptionsN/A
StlSaveOptionsbinaryMode (fals → ASCII, cert → binari)

Mòdul FBX (@aspose/3d/formats/fbx)

EnumerationsOpcions clau
FbxLoadOptionsN/A
FbxSaveOptionsembedTextures

Formats compatibles

EnumerationsEnumerationsEnumerationsEnumerations
Enumerations.objEnumerationsEnumerations
glTF 2.0.gltfEnumerationsEnumerations
Enumerations.glbEnumerationsEnumerations
STL.stlEnumerationsEnumerations
FBX.fbxNo*No*
COLLADA.daeEnumerationsEnumerations
3MF.3mfEnumerationsEnumerations

Exemple de referència ràpida

import { Scene } from '@aspose/3d';
import { ObjLoadOptions } from '@aspose/3d/formats/obj';
import { GltfSaveOptions } from '@aspose/3d/formats/gltf';

// Load OBJ with materials
const scene = new Scene();
const loadOpts = new ObjLoadOptions();
loadOpts.enableMaterials = true;
scene.open('input.obj', loadOpts);

// Inspect root nodes
for (const node of scene.rootNode.childNodes) {
    console.log(`Node: ${node.name}, entity: ${node.entity?.constructor.name}`);
}

// Export as GLB (binary glTF)
const saveOpts = new GltfSaveOptions();
saveOpts.binaryMode = true;
scene.save('output.glb', saveOpts);

Vegeu també

 Català