API Overview — @aspose/3d for TypeScript

Paketti: @aspose/3d (v24.12.0) Kieli: TypeScript / Node.js 18+ Lisenssi: MIT

@aspose/3d on MIT-lisenssillä varustettu kirjasto 3D‑kohtauksien lukemiseen, rakentamiseen ja viemiseen Node.js:ssä. Se toimitetaan täydellisten TypeScript‑tyyppimääritelmien sekä yhden ajonaikaisen riippuvuuden (xmldom), ja tukee seitsemää tärkeintä 3D‑tiedostomuotoa. Kaikki I/O on synkronista. Natiivisia lisäosia ei vaadita.


Methods

npm install @aspose/3d

Methods tsconfig.json asetukset oikean alipolun ratkaisemiseksi:

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

Ydinluokat

Methods

Juuri­konttiaineri 3D‑kohtaukselle. Kaikki sisältö; solmut, geometria, materiaalit ja animaatiot; tallennetaan puuhun, jonka juuri on scene.rootNode.Käytä open() / openFromBuffer() tiedoston lataamiseen ja save() / saveToBuffer() vientiä varten.

MethodsMethodsMethods
rootNodeNodeKohtauksen graafin juuri
assetInfoAssetInfoTiedoston metatiedot (luoja, yksiköt, koordinaattijärjestelmä)
animationClipsAnimationClip[]Kaikki animaatioklipit kohtauksessa
open(path, opts?)(string, LoadOptions?) → voidLataa tiedosto levystä
openFromBuffer(buf, opts?)(Buffer, LoadOptions?) → voidLataa muistipuskurista
save(path, opts?)(string, SaveOptions?) → voidTallenna levylle (muoto päätellään tiedostopäätteestä)
saveToBuffer(ext, opts?)(string, SaveOptions?) → BufferTallenna muistipuskurille
createAnimationClip(name)(string) → AnimationClipLuo ja rekisteröi uusi animaatioleike

Methods

Nimetty puun solmu kohtausgraafissa. Solmut kantavat valinnaisen Entity (mesh, camera, light) ja Transform joka asettaa solmun suhteessa sen vanhempaan.

MethodsMethodsMethods
namestringSolmun nimi
childNodesNode[]Suorat lapsisolmut
entity`Entitynull`
transformTransformPaikallinen siirto, kierto, skaalaus
materialsMaterial[]Tälle solmulle määritetyt materiaalit
createChildNode(name)(string) → NodeLisää lapsisolmu
getChildNode(name)`(string) → Nodenull`

Methods

Polygoniverkko; ensisijainen geometria-tyyppi. Laajentaa Geometry.

MethodsMethodsMethods
controlPointsVector4[]Kärkipisteiden sijainnit (w=1 sijainneille)
polygonCountnumberPolygonien määrä
createPolygon(indices)(number[]) → voidLisää polygoni (kolmio tai nelikulmio)
getElement(type)`(VertexElementType) → VertexElementnull`
createElement(type)(VertexElementType) → VertexElementLuo kärki-elementti

Methods

Paikallinen muunnos, joka on sovellettu solmuun.

MethodsMethodsMethods
translationVector3Paikallinen sijainti
eulerAnglesVector3Eulerin kierto asteina (XYZ-järjestys)
rotationQuaternionKierto kvaternionina
scalingVector3Paikallinen skaala

Materiaaliluokat

MethodsMethodsKeskeiset ominaisuudet
LambertMaterialDiffuus + ambientti varjostusdiffuseColor, ambientColor, transparency
PhongMaterialLisää spekulaarisen + emissiivisen LambertiinspecularColor, shininess, emissiveColor
PbrMaterialFysiikaperusteinen glTF 2.0:llealbedo, metallicFactor, roughnessFactor, emissiveColor

Matematiikkaluokat

MethodsMethods
Vector33-component double-precision vector (x, y, z)
Vector44-component vector for homogeneous math (x, y, z, w)
FVector3Yhden tarkkuuden variantti, jota käytetään vertex-datassa
Matrix44×4 transformation matrix; multiply, invert, decompose
QuaternionKierroskvaternion; fromEulerAngle, toEulerAngles, slerp
BoundingBoxAkselikohtainen rajauslaatikko; minimum, maximum, center, size, merge

Animaatioluokat

MethodsMethods
AnimationClipNimetty leike; sisältää AnimationNode lista; käytetään kautta scene.animationClips
AnimationNodeSidot leikkeen nimettyyn kohtaus solmuun; sisältää AnimationChannel lista
AnimationChannelKohdistaa yhteen ominaisuuteen (esim. translation X); sisältää KeyframeSequence
KeyframeSequenceJärjestetty lista KeyFrame objekteja, joilla interpolation ja extrapolation
KeyFrameYksi aika/arvopari

Methods

MethodsMethodsMethods
VertexElementTypeNORMAL, UV, VERTEX_COLOR, BINORMAL, TANGENTVertex-elementin semantiikka
MappingModeCONTROL_POINT, POLYGON_VERTEX, POLYGON, ALL_SAMEKuinka data kartoitetaan geometriaan
ReferenceModeDIRECT, INDEX, INDEX_TO_DIRECTIndeksointistrategia vertex element -datalle
InterpolationCONSTANT, LINEAR, BEZIERKeyframe-interpolaatio
ExtrapolationCONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATEKäyttäytyminen avainruutujen alueen ulkopuolella

Formaattimoduulit

Formaattiin spesifiset asetuskoulut viedään alipolku‑moduuleista. Tuo ne erikseen:

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';

OBJ-moduuli (@aspose/3d/formats/obj)

MethodsKeskeiset asetukset
ObjLoadOptionsenableMaterials, flipCoordinateSystem, scale, normalizeNormal

glTF/GLB-moduuli (@aspose/3d/formats/gltf)

MethodsKeskeiset asetukset
GltfSaveOptionsbinaryMode (true → .glb), flipTexCoordV
GltfFormatGltfFormat.getInstance(): formaatti‑instanssi kohteelle scene.save()

STL-moduuli (@aspose/3d/formats/stl)

MethodsKeskeiset asetukset
StlLoadOptionsN/A
StlSaveOptionsbinaryMode (false → ASCII, true → binaari)

FBX-moduuli (@aspose/3d/formats/fbx)

MethodsKeskeiset asetukset
FbxLoadOptionsN/A
FbxSaveOptionsembedTextures

Tuetut formaatit

MethodsMethodsMethodsMethods
Methods.objMethodsMethods
glTF 2.0.gltfMethodsMethods
Methods.glbMethodsMethods
STL.stlMethodsMethods
FBX.fbxEi*Ei*
COLLADA.daeMethodsMethods
3MF.3mfMethodsMethods

Pikaviite-esimerkki

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);

Katso myös

 Suomi