Aspose.3D FOSS for TypeScript

API-referens för @aspose/3d version 24.12.0. Installera via:

npm install @aspose/3d

Körmiljö: Node.js 18, 20, 22+ · Språk: TypeScript 5.0+ / JavaScript (CommonJS) · Licens: MIT

Kärnscengraf

ImageRenderOptions

Rotbehållaren för en 3D-scen. Anropa scene.open() eller scene.openFromBuffer() för att läsa in en fil, och scene.save() för att skriva utdata. Exponerar scene.rootNode som ingångspunkten till nodhierarkin.

ImageRenderOptions

En namngiven nod i scenträdet. Innehåller en Transform, ett valfritt entity (mesh, camera, light, or other SceneObject), och noll eller fler barnnoder som är åtkomliga via childNodes.

ImageRenderOptions

Basklass för alla objekt som kan fästas på en Node som dess primära enhet. Subklassad av Mesh, Camera, Light, och andra.

SceneObject

Abstrakt bas för namngivna objekt som tillhör en scen. Tillhandahåller name egenskaps- och scenmedlemskapsspårning som delas av noder, entiteter och objekt på tillgångsnivå.

A3DObject

Rotbas-klass för alla Aspose.3D-objekt. Tillhandahåller egenskapssystemet (getProperty, setProperty) och name fält som ärvs av varje publik klass.

Geometri och Mesh

ImageRenderOptions

Representerar ett polygonmesh. Innehåller en controlPoints array av Vector4 vertices och polygondefinitioner skapade via createPolygon(). Anropa triangulate() för att konvertera alla polygoner till trianglar innan export.

ImageRenderOptions

Basklass för alla geometrityper. Innehåller controlPoints och samlingen av vertexelement (normals, UVs, colors) som är knutna till geometrin.

VertexElement

Basklass för per-vertex-attributkanaler som är knutna till en Geometry. Subklasser bär typade dataarrayer och mappingMode / referenceMode metadata.

VertexElementNormal

En VertexElement subklass som lagrar surface normals. Data lagras internt som FVector4[] (ärvd från VertexElementFVector). Krävs av de flesta renderare för korrekt belysning.

VertexElementUV

En VertexElement subklass som lagrar 2D-texturkoordinater. Ett enskilt mesh kan ha flera UV-uppsättningar för olika texturlager.

VertexElementVertexColor

A VertexElement subklass som lagrar per-vertex RGBA-färgvärden.

VertexElementType

Uppräkning av attributkanaltyperna som en VertexElement kan representera (t.ex., NORMAL, UV, VERTEX_COLOR, TANGENT, BINORMAL).

MappingMode

Enumeration som styr hur elementdata mappas på geometri: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, eller ALL_SAME.

ReferenceMode

Enumeration som styr hur elementindex refererar till data: DIRECT (en-till-en) eller INDEX_TO_DIRECT (via en indexarray).

TextureMapping

Enumeration av texturkanalsemantiker: DIFFUSE, SPECULAR, NORMAL, EMISSIVE, BUMP, och mer.

Transform och Spatial

ImageRenderOptions

Innehåller den lokala positionen (translation), rotation (rotation som Quaternion), och skala (scaling) av en Node. Ändringar här påverkar noden och alla dess barn.

GlobalTransform

Skrivskyddad vy av en nods världsrumstransform, beräknad genom att ackumulera alla förfäders Transform värden. Åtkomst via node.globalTransform.

BoundingBox

En axelrät avgränsningsbox definierad av en minimum och maximum Vector3 hörn. Används för att beskriva det rumsliga omfånget av ett nät eller en scen.

ImageRenderOptions

Material, LambertMaterial, PhongMaterial, PbrMaterial

Material är den abstrakta basklassen för alla materialtyper. Tre konkreta implementationer finns tillgängliga:

  • LambertMaterial — diffus‑endast med omgivnings-, diffusions- och emissiva färgkanaler. Lämplig för icke‑speculära ytor.
  • PhongMaterial — utökar LambertMaterial med spekulär färg och glansighetsegenskaper för Phong‑skuggning.
  • PbrMaterial — fysiskt baserat renderingsmaterial med metallisk, grovhet, basfärg och normal‑kartkanaler. Mappas direkt till glTF 2.0 PBR‑materialmodellen.

Kamera och belysning

ImageRenderOptions

En vyknutnadsentitet med projektionstyp, synfält, när-/fjärrklippavstånd och egenskaper för bildförhållande.

ImageRenderOptions

En ljuskällnod‑entity. Typ styrs av LightType enumerationen.

LightType

Enumeration av stödjade ljustyper: POINT, DIRECTIONAL, SPOT, AREA, VOLUME.

ProjectionType

Enumeration av kameraprojektionstyper: PERSPECTIVE och ORTHOGRAPHIC.

Matematikverktyg

ImageRenderOptions

En trekomponents flyttalsvektor med x, y, z fält och vanliga aritmetiska metoder (dot, cross, normalize, minus, times). Exporterad från @aspose/3d/utilities.

ImageRenderOptions

En fyrakomponents flyttalsvektor med x, y, z, w fält. Används som typ för poster i Mesh.controlPoints.

ImageRenderOptions

En tvåkomponents dubbelprecisionvektor med x och y fält. Används för UV‑texturkoordinater.

FVector3

En kompakt trekomponents enkelprecision flyttalsvektor som används i vertex‑elementdatamatriser för normaler och tangenter.

ImageRenderOptions

En 4×4 transformationsmatris. Stöder sammanslagning, inversion, transponering och dekomposition till translations-, rotations- och skalningskomponenter. Exporterad från @aspose/3d/utilities.

ImageRenderOptions

En enhetskvaternion för att representera rotationer utan gimbal-lås. Tillhandahåller slerp() för smidig interpolering och konvertering till/från Euler-vinklar och Matrix4. Exporterad från @aspose/3d/utilities.

ImageRenderOptions

AnimationClip

En namngiven, tidsbegränsad samling av tracks. AnimationNode Den primära behållaren för keyframe‑animationsdata som läses in från FBX‑ eller COLLADA‑filer.

AnimationNode

Ett namngivet animationsspår som riktar sig mot en specifik property‑path på ett scene‑object. Innehåller en eller flera objects. AnimationChannel objects.

AnimationChannel

En enda animerad property‑channel inom en AnimationNode. Holds a KeyframeSequence av time/value‑par.

KeyFrame

Ett enskilt time/value‑sample i en KeyframeSequence. Carries the time stamp (in seconds), the value, and tangent information for interpolation.

KeyframeSequence

En ordnad lista av KeyFrame samples för en property‑channel, tillsammans med den Interpolation och Extrapolation settings som styr playback.

ImageRenderOptions

Uppräkning av keyframe‑interpolationslägen. Kända medlemmar inkluderar LINEAR och CONSTANT. Ytterligare medlemmar såsom BEZIER kan vara tillgänglig.

ImageRenderOptions

Definierar beteende utanför nyckelbildsintervallet (före den första nyckeln och efter den sista nyckeln). Styrs av ExtrapolationType.

StepMode

Enumeration som styr hur stegvis (konstant) interpolering tillämpas vid gränser.

WeightedMode

Uppräkning för hantering av Bezier‑tangentvikt: NONE, OUT_WEIGHT, NEXT_IN_WEIGHT, eller BOTH.

ExtrapolationType

Uppräkning av beteenden utanför intervallet: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, och OSCILLATE.

Format I/O

FileFormat

Basbeskrivning för ett 3D-filformat. Varje stödd format tillhandahåller en konkret singleton via getInstance().

ImageRenderOptions

Basklass för format‑specifika importimplementationer. Instansieras inte direkt; anropas internt av scene.open().

ImageRenderOptions

Basklass för format‑specifika exportimplementationer. Instansieras inte direkt; anropas internt av scene.save().

LoadOptions

Basklass för format‑specifika laddningsalternativobjekt. Skicka en underklassinstans till scene.open() eller scene.openFromBuffer().

SaveOptions

Basklass för format‑specifika sparalternativobjekt. Skicka en underklassinstans till scene.save().

IOService

Intern tjänstegränssnitt som abstraherar filsystem‑ och buffer‑I/O för importörer och exportörer.

OBJ-format

OBJ stödjer både import och export. Vid sparande som OBJ skrivs materialbiblioteket (.mtl) skrivet automatiskt tillsammans med .obj filen.

ObjImporter

Intern importör som läser Wavefront OBJ‑filer, löser .mtl materialbibliotek och fyller i en Scene. Anropas automatiskt när ObjLoadOptions skickas till scene.open().

ObjExporter

Intern exportör som skriver Wavefront OBJ‑filer. En följeslagare .mtl materialbiblioteket skrivs automatiskt. Anropas när scene.save() riktar in sig på en .obj sökväg.

ObjLoadOptions

Läs in alternativ för OBJ-filer. Nyckelegenskaper: enableMaterials (boolesk, standard true), flipCoordinateSystem (boolesk), normalizeNormal (boolesk, standard true), scale (nummer). Se Alternativ för inläsning och sparning av format för fullständig information.

ObjSaveOptions

Spara alternativ för OBJ-export. Skicka till scene.save() för att styra OBJ-utdata beteende. Se Alternativ för inläsning och sparning av format för fullständig information.

ObjFormat

Formatbeskrivnings‑singleton för OBJ. Båda canImport och canExport är true.

glTF-format

GltfImporter

Läser glTF 2.0 JSON (.gltf).glb) filer. Hanterar inbäddade och externa buffertreferenser, PBR-material, skins och animationsklipp.

GltfExporter

Skriver glTF 2.0-utdata. När GltfSaveOptions.binaryMode är true, producerar en självständig GLB; annars skriver den en JSON .gltf med en medföljande .bin buffert.

GltfLoadOptions

Läsalternativ för glTF/GLB‑filer. Styr buffertupplösning och hur texturer laddas.

GltfSaveOptions

Spara alternativ för glTF/GLB-export. Anmärkningsvärda egenskaper: binaryMode (boolean, true → GLB, standard false), flipTexCoordV (boolean, vänder UV:s vertikala axel, standard true). Se Alternativ för inläsning och sparning av format för fullständig information.

GltfFormat

Formatbeskrivnings‑singleton. Hämta via GltfFormat.getInstance() och skicka till scene.save() som det andra argumentet.

STL-format

StlImporter

Läser både ASCII- och binära STL-filer till en Scene som innehåller en enda Mesh entitet.

StlExporter

Skriver binär STL. Utdata innehåller det triangulerade meshet från scenen; icke-triangulära polygoner trianguleras automatiskt.

StlLoadOptions

Laddningsalternativ för STL. Styr om importören vänder normaler under import.

StlSaveOptions

Spara alternativ för STL-export. Nyckel­egenskap: binaryMode (boolean, standard false). Styr om utdata är ASCII eller binär STL. Se Alternativ för inläsning och sparning av format för fullständig information.

StlFormat

Formatbeskrivnings‑singleton. Hämta via StlFormat.getInstance().

3MF Format

ThreeMfImporter

Läser Open Packaging Convention 3MF-arkiv och fyller i en Scene med mesh-objekt, färger och materialegenskaper.

ThreeMfExporter

Skriver ett giltigt 3MF-arkiv från den aktuella scenen. Lämplig för 3D‑utskriftsarbetsflöden.

ThreeMfLoadOptions

Läsalternativ för 3MF-filer.

ThreeMfSaveOptions

Sparaalternativ för 3MF-export.

ThreeMfFormat

Formatbeskrivnings‑singleton. Hämta via ThreeMfFormat.getInstance().

FBX-format

FbxImporter

Läser FBX-binär- och ASCII-filer inklusive geometri, material, skelett, blend shapes och animationsklipp.

FbxExporter

Skriver FBX-filer från den aktuella scenen. Både binär och ASCII FBX-utdata stöds beroende på alternativ.

FbxLoadOptions

Läsalternativ för FBX. Styr om animation, skins och blend shapes importeras.

FbxSaveOptions

Spara alternativ för FBX-export. Nyckel‑egenskap: embedTextures (boolean, standard false). Se Alternativ för inläsning och sparning av format för fullständig information.

FbxFormat

Formatbeskrivningssingleton. Hämta via FbxFormat.getInstance().

COLLADA-format

COLLADA-import och -export kräver xmldom peer‑beroende, som installeras automatiskt med @aspose/3d.

ColladaImporter

Läser COLLADA (.dae) XML-filer med xmldom. Hanterar geometri, material, kameror, ljus och animation.

ColladaExporter

Skriver COLLADA XML‑utdata från den aktuella scenen. Lämplig för utbyte med DCC‑verktyg (Blender, Maya osv.).

ColladaFormat

Formatbeskrivningssingleton. Hämta via ColladaFormat.getInstance().

Egenskapssystem

ImageRenderOptions

Ett typat namn/värde‑par som kan bifogas till någon A3DObject. Stöder skalära och vektoriella värdetyper.

PropertyCollection

En ordnad behållare av Property objekt. Tillgänglig på alla A3DObject via properties åtkomstmetod.

CustomObject

En fri-form egenskapsbehållare som utökar A3DObject. Används för att lagra godtycklig metadata som inte mappar till en standardklass.

Tillgångsinformation

AssetInfo

Bär scen‑nivåmetadata som laddas från källfilen: författare, programnamn, skapelsedatum, enhetsskala och koordinataxelinformation.

ImageRenderOptions

Alternativ som styr hur texturer och bilder löses upp och kodas när de sparas till format som bäddar in bilddata (t.ex. GLB med binaryMode: true).

Se även

 Svenska