API Overview — @aspose/3d for TypeScript

パッケージ: @aspose/3d (v24.12.0) 言語: TypeScript / Node.js 18+ ライセンス: MIT

@aspose/3d は、Node.js で 3D シーンを読み取り、構築、エクスポートするための MIT ライセンスのライブラリです。完全な TypeScript 型定義が同梱され、単一のランタイム依存関係 (xmldom)、そして 7 つの主要な 3D ファイル形式をサポートします。すべての I/O は同期的です。ネイティブアドオンは不要です。.


Methods

npm install @aspose/3d

Methods tsconfig.json 正しいサブパス解決のための設定:

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

プレースホルダーへのアクセス

Methods

3D シーンのルートコンテナ。すべてのコンテンツ(ノード、ジオメトリ、マテリアル、アニメーション)は、次の場所をルートとしたツリーに格納されます scene.rootNode.使用します open() / openFromBuffer() ファイルをロードし、 save() / saveToBuffer() エクスポート用。.

MethodsMethodsMethods
rootNodeNodeシーン グラフのルート
assetInfoAssetInfoファイルメタデータ(作成者、単位、座標系)
animationClipsAnimationClip[]シーン内のすべてのアニメーションクリップ
open(path, opts?)(string, LoadOptions?) → voidディスクからファイルを読み込む
openFromBuffer(buf, opts?)(Buffer, LoadOptions?) → voidメモリ内バッファから読み込む
save(path, opts?)(string, SaveOptions?) → voidディスクに保存(拡張子から形式を推測)
saveToBuffer(ext, opts?)(string, SaveOptions?) → Bufferメモリ内バッファに保存
createAnimationClip(name)(string) → AnimationClip新しいアニメーションクリップを作成して登録する

Methods

シーン グラフ内の名前付きツリーノード。ノードはオプションで Entity (mesh, camera, light)と a Transform ノードを親に対して相対的に配置する。.

MethodsMethodsMethods
namestringノード名
childNodesNode[]直接の子ノード
entity`Entitynull`
transformTransformローカルの平行移動、回転、スケール
materialsMaterial[]このノードに割り当てられたマテリアル
createChildNode(name)(string) → Node子ノードを追加
getChildNode(name)`(string) → Nodenull`

Methods

ポリゴンメッシュ;主要なジオメトリタイプ。拡張 Geometry.

MethodsMethodsMethods
controlPointsVector4[]頂点位置 (w=1 は位置を表す)
polygonCountnumberポリゴン数
createPolygon(indices)(number[]) → voidポリゴンを追加(三角形または四角形)
getElement(type)`(VertexElementType) → VertexElementnull`
createElement(type)(VertexElementType) → VertexElement頂点要素を作成

Methods

ノードに適用されるローカルトランスフォーム。.

MethodsMethodsMethods
translationVector3ローカル位置
eulerAnglesVector3度単位のオイラー回転(XYZ順)
rotationQuaternionクォータニオンとしての回転
scalingVector3ローカルスケール

マテリアルクラス

MethodsMethods主要プロパティ
LambertMaterialDiffuse + アンビエントシェーディングdiffuseColor, ambientColor, transparency
PhongMaterialLambert に specular + emissive を追加specularColor, shininess, emissiveColor
PbrMaterialglTF 2.0 向けの物理ベースalbedo, metallicFactor, roughnessFactor, emissiveColor

数学クラス

MethodsMethods
Vector33-component double-precision vector (x, y, z)
Vector44-component vector for homogeneous math (x, y, z, w)
FVector3頂点データで使用される単精度バリアント
Matrix44×4 transformation matrix; multiply, invert, decompose
Quaternion回転クォータニオン; fromEulerAngle, toEulerAngles, slerp
BoundingBox軸整列バウンディングボックス; minimum, maximum, center, size, merge

アニメーションクラス

MethodsMethods
AnimationClip名前付きクリップ; 含む AnimationNode リスト; からアクセス scene.animationClips
AnimationNodeクリップを名前付きシーンノードにバインドする; 含む AnimationChannel リスト
AnimationChannel単一プロパティ(例: translation X)を対象とする; 保持する KeyframeSequence
KeyframeSequence順序付けられたリスト KeyFrame オブジェクト with interpolation および extrapolation
KeyFrame単一の時間/値ペア

Methods

MethodsMethodsMethods
VertexElementTypeNORMAL, UV, VERTEX_COLOR, BINORMAL, TANGENT頂点要素のセマンティクス
MappingModeCONTROL_POINT, POLYGON_VERTEX, POLYGON, ALL_SAMEデータがジオメトリにマッピングされる方法
ReferenceModeDIRECT, INDEX, INDEX_TO_DIRECT頂点要素データのインデックス戦略
InterpolationCONSTANT, LINEAR, BEZIERキーフレーム補間
ExtrapolationCONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATEキーフレーム範囲外の動作

フォーマットモジュール

フォーマット固有のオプションクラスはサブパスモジュールからエクスポートされます。個別にインポートしてください:

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 モジュール (@aspose/3d/formats/obj)

Methodsキーオプション
ObjLoadOptionsenableMaterials, flipCoordinateSystem, scale, normalizeNormal

glTF/GLB モジュール (@aspose/3d/formats/gltf)

Methodsキーオプション
GltfSaveOptionsbinaryMode (true → .glb), flipTexCoordV
GltfFormatGltfFormat.getInstance(): フォーマットインスタンス 用 scene.save()

STL モジュール (@aspose/3d/formats/stl)

Methods主要オプション
StlLoadOptionsN/A
StlSaveOptionsbinaryMode (false → ASCII、true → binary)

FBX モジュール (@aspose/3d/formats/fbx)

Methods主要オプション
FbxLoadOptionsN/A
FbxSaveOptionsembedTextures

サポートされているフォーマット

MethodsMethodsMethodsMethods
Methods.objMethodsMethods
glTF 2.0.gltfMethodsMethods
Methods.glbMethodsMethods
STL.stlMethodsMethods
FBX.fbxいいえ*いいえ*
COLLADA.daeMethodsMethods
3MF.3mfMethodsMethods

クイックリファレンス例

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

参照

 日本語