Installation

Tento průvodce pokrývá vše, co potřebujete k instalaci Aspose.3D FOSS pro TypeScript a k potvrzení, že funguje správně, než napíšete svůj první 3D zpracovatelský skript.

Požadavky

Ujistěte se, že jsou následující nainstalovány a ve vašem PATH před pokračováním:

Jak zkontrolovat své verze:

node --version   # v18.x.x or later
npm --version    # 7.x or later
npx tsc --version  # Version 5.x.x

Krok 1: Vytvořte projekt (pokud je potřeba)

Pokud přidáváte Aspose.3D do existujícího TypeScript projektu, tento krok přeskočte a přejděte přímo ke Kroku 2.

Pro nový projekt:

mkdir my-3d-project && cd my-3d-project
npm init -y
npm install -D typescript ts-node @types/node

Krok 2: Nainstalujte @aspose/3d

npm install @aspose/3d

Tím se nainstaluje balíček a jeho jediná tranzitivní závislost, xmldom, automaticky. Žádné další systémové balíčky, nativní doplňky ani kompilátory nejsou vyžadovány. Instalace je dokončena, když @aspose/3d se objeví ve vašem package.json v sekci dependencies.

Ověřte instalaci:

ls node_modules/@aspose/3d

Měli byste vidět adresář balíčku s package.json, soubory s definicemi typů (.d.ts), a zkompilovaným JavaScriptem.

Krok 3: Nakonfigurujte TypeScript

Přidejte nebo aktualizujte tsconfig.json ve vašem kořenovém adresáři projektu s následujícím nastavením. Toto je vyžadováno pro plnou kompatibilitu s definicemi typů knihovny a výstupem CommonJS:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "moduleResolution": "node",
    "esModuleInterop": true,
    "strict": true,
    "outDir": "dist",
    "rootDir": "src"
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules", "dist"]
}

Klíčová nastavení a proč jsou důležitá:

Krok 4: Ověřte instalaci

Vytvořte src/verify.ts s následujícím minimálním testem importu:

import { Scene } from '@aspose/3d';

const scene = new Scene();
console.log('Aspose.3D FOSS for TypeScript is installed correctly.');
console.log('rootNode name:', scene.rootNode.name);

Zkompilujte a spusťte:

npx tsc
node dist/verify.js

Expected output:

Aspose.3D FOSS for TypeScript is installed correctly.
rootNode name:

Název kořenového uzlu je ve výchozím nastavení prázdný řetězec — scene.rootNode je vytvořen bez argumentu názvu.

Pokud dáváte přednost přeskočit krok kompilace během vývoje, spusťte přímo s ts-node:

npx ts-node src/verify.ts

Krok 5: Rychlý start: Načíst scénu a vypsat informace o uzlech

Následující skript načte 3D soubor a vypíše název a typ entity každého uzlu ve scéně. Funguje s libovolným podporovaným formátem: OBJ, glTF, GLB, STL, 3MF, FBX nebo COLLADA.

import { Scene, Node } from '@aspose/3d';

function printNode(node: Node, depth: number = 0): void {
  const indent = '  '.repeat(depth);
  const entityType = node.entity ? node.entity.constructor.name : '(no entity)';
  console.log(`${indent}${node.name} [${entityType}]`);
  for (const child of node.childNodes) {
    printNode(child, depth + 1);
  }
}

const scene = new Scene();

// Replace 'model.obj' with any supported 3D file path.
// Format is detected automatically from binary magic numbers.
scene.open('model.obj');

console.log('Scene loaded. Node hierarchy:');
printNode(scene.rootNode);

Uložte to jako src/quickstart.ts a spusťte to:

npx ts-node src/quickstart.ts

Pro soubor OBJ s jednou sítí pojmenovanou Cube, výstup bude vypadat takto:

Scene loaded. Node hierarchy:
 [(no entity)]
  Cube [Mesh]

Kořenový uzel má prázdný název (vytištěn jako prázdná předpona). Podřízené uzly dědí své názvy ze načteného souboru.

Poznámky k závislostem

Aspose.3D FOSS pro TypeScript má přesně jednu runtime závislost:

Nemusíte instalovat xmldom ručně. Objeví se ve vašem node_modules po hlavním příkazu instalace. Neexistují žádné nativní doplňky (.node soubory) a nejsou vyžadovány žádné systémové knihovny.

Další kroky

Nyní, když je knihovna nainstalována a ověřena:

• Přečtěte si Průvodce vývojáře pro kompletní průvodce všemi oblastmi funkcí.
• Viz Funkce a vlastnosti pro podrobnosti o podpoře formátů, vzory scénových grafů, API materiálů a animací a kompletní příklady kódu v TypeScriptu.