Aspose.3D FOSS for TypeScript

תיעוד API עבור @aspose/3d גרסה 24.12.0. התקן באמצעות:

npm install @aspose/3d

זמן ריצה: Node.js 18, 20, 22+ · שפה: TypeScript 5.0+ / JavaScript (CommonJS) · רישיון: MIT

גרף סצנה ליבה

ImageRenderOptions

מכולת השורש עבור סצנה תלת‑ממדית. קרא scene.open() או scene.openFromBuffer() לטעון קובץ, ו scene.save() לכתוב פלט. חושף scene.rootNode כנקודת הכניסה למבנה הצמתים.

ImageRenderOptions

צומת בעל שם בעץ הסצנה. מחזיק ב Transform, אופציונלי entity (רשת, מצלמה, אור, או אחר SceneObject), ואפס או יותר צמתים צאצאים נגישים דרך childNodes.

ImageRenderOptions

מחלקה בסיסית לכל האובייקטים שניתן לצרף ל‑ Node כישות הראשית שלו. מחלקה נגזרת על ידי Mesh, Camera, Light, ואחרים.

SceneObject

מחלקה בסיסית מופשטת לאובייקטים בעלי שם השייכים לסצנה. מספקת את name המאפיין ומעקב החברות בסצנה המשותפים לצמתים, ישויות, ולאובייקטים ברמת נכסים.

A3DObject

מחלקת בסיס שורש לכל האובייקטים Aspose.3D. מספקת את מערכת המאפיינים (getProperty, setProperty) ו‑ה name שדה שיורש על‑ידי כל מחלקה ציבורית.

גאומטריה ורשת

ImageRenderOptions

מייצג רשת פוליגונים. מכיל controlPoints מערך של Vector4 קודקודים והגדרות פוליגון שנוצרו באמצעות createPolygon(). קרא triangulate() להמיר את כל הפוליגונים למשולשים לפני הייצוא.

ImageRenderOptions

מחלקה בסיסית לכל סוגי הגאומטריה. מחזיקה controlPoints ואת האוסף של רכיבי הקודקוד (normals, UVs, colors) המחוברים לגאומטריה.

VertexElement

מחלקה בסיסית לערוצי תכונות לכל קודקוד המחוברים ל- Geometry. תתי-מחלקות נושאות מערכי נתונים מסוג ו- mappingMode / referenceMode metadata.

VertexElementNormal

א VertexElement מחלקה משנה שמאחסנת נורמליות משטח. הנתונים מאוחסנים פנימית כ FVector4[] (ירש מ VertexElementFVector). נדרש על ידי רוב הרנדררים לתאורה נכונה.

VertexElementUV

א VertexElement מחלקה משנה שמאחסנת קואורדינטות מרקם דו‑ממדיות. רשת אחת יכולה להכיל מספר קבוצות UV לשכבות מרקם שונות.

VertexElementVertexColor

A VertexElement מחלקה משנה שמאחסנת ערכי צבע RGBA לכל קודקוד.

VertexElementType

מנייה של סוגי ערוצי המאפיין ש- VertexElement יכול לייצג (למשל,., NORMAL, UV, VERTEX_COLOR, TANGENT, BINORMAL).

MappingMode

מנייה השולטת באופן שבו נתוני אלמנט ממופים על גאומטריה: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, או ALL_SAME.

ReferenceMode

מִסְפָּר השולט באופן שבו אינדקסי האלמנטים מתייחסים לנתונים: DIRECT (one-to-one) או INDEX_TO_DIRECT (דרך מערך אינדקסים).

TextureMapping

מִסְפָּר של סמנטיקה של ערוצי מרקם: DIFFUSE, SPECULAR, NORMAL, EMISSIVE, BUMP, ועוד.

Transform ו-Spatial

ImageRenderOptions

מאחסן את המיקום המקומי (translation), סיבוב (rotation כ Quaternion), וקנה מידה (scaling) של Node. השינויים כאן משפיעים על הצומת ועל כל הילדים שלה.

GlobalTransform

תצוגה לקריאה בלבד של הטרנספורם במרחב-עולם של צומת, המחושבת על ידי צבירת כל האבות Transform ערכים. גישה דרך node.globalTransform.

BoundingBox

תיבה תוחמת מיושרת לציר (axis-aligned bounding box) המוגדרת על ידי minimum ו maximum Vector3 פינה. משמש לתיאור ההיקף המרחבי של רשת או סצנה.

ImageRenderOptions

Material, LambertMaterial, PhongMaterial, PbrMaterial

Material היא המחלקה הבסיסית המופשטת לכל סוגי החומרים. שלוש מימושים קונקרטיים זמינים:

  • LambertMaterial — פיזור בלבד עם ערוצי צבע אמביינט, פיזור ופולט. מתאים למשטחים ללא ברק.
  • PhongMaterial — מרחיב LambertMaterial עם צבע מראה ותכונות ברק עבור הצללה בפונג.
  • PbrMaterial — חומר רינדור מבוסס פיזיקה עם ערוצי מתכת, גסות, צבע‑בסיס, ומפת‑נורמל. ממופה ישירות למודל החומר glTF 2.0 PBR.

מצלמה ותאורה

ImageRenderOptions

ישות צומת נקודת מבט עם סוג פרויקט, שדה ראייה, מרחקי חיתוך קרוב/רחוק, ותכונות יחס גובה-רוחב.

ImageRenderOptions

ישות צומת מקור אור. הסוג נשלט על‑ידי ה‑ LightType המנייה.

LightType

מנייה של סוגי האור הנתמכים: POINT, DIRECTIONAL, SPOT, AREA, VOLUME.

ProjectionType

רשימת מצבי פרויקטור של מצלמה: PERSPECTIVE ו ORTHOGRAPHIC.

כלי מתמטיקה

ImageRenderOptions

וקטור צף בעל שלושה רכיבים עם x, y, z שדות ושיטות אריתמטיות נפוצות (dot, cross, normalize, minus, times). מיוצא מ @aspose/3d/utilities.

ImageRenderOptions

וקטור צף בעל ארבעה רכיבים עם x, y, z, w שדות. משמש כסוג של ערכים ב Mesh.controlPoints.

ImageRenderOptions

וקטור דו-רכיבי ברמת דיוק כפולה עם x ו y שדות. משמש לקואורדינטות מרקם UV.

FVector3

וקטור קומפקטי בת שלושה רכיבים מסוג float חד-דיוק המשמש במערכי נתוני רכיבי קודקוד עבור נורמליות וטנגנטים.

ImageRenderOptions

מטריצה של שינוי בגודל 4×4. תומכת ברצף, הפיכה, טרנספוזיציה, ופירוק לרכיבי תזוזה, סיבוב וקנה מידה. מיוצאת מ @aspose/3d/utilities.

ImageRenderOptions

קוואטורן יחיד לייצוג סיבובים ללא נעילת גימבל. מספק slerp() לשילוב חלק והמרה אל/מתוך זוויות אוילר ו Matrix4. מיוצא מ- @aspose/3d/utilities.

ImageRenderOptions

AnimationClip

אוסף בעל שם ומוגבל בזמן של AnimationNode רצועות. המכולה הראשית לנתוני אנימציית keyframe שנטענים מקבצי FBX או COLLADA.

AnimationNode

רצועת אנימציה בעלת שם שמכוונת לנתיב נכס ספציפי על אובייקט סצנה. מכילה אחת או יותר AnimationChannel אובייקטים.

AnimationChannel

ערוץ תכונה מונפשת יחיד בתוך AnimationNode. מחזיק ב KeyframeSequence של זוגות זמן/ערך.

KeyFrame

דגימה יחידה של זמן/ערך ב KeyframeSequence. נושא את חותמת הזמן (בשניות), את הערך, ואת מידע הטנגנט לאינטרפולציה.

KeyframeSequence

רשימה מסודרת של KeyFrame דגימות לערוץ תכונה אחד, יחד עם Interpolation ו Extrapolation הגדרות השולטות בניגון.

ImageRenderOptions

רשימה של מצבי אינטרפולציית מסגרות מפתח. חברים ידועים כוללים LINEAR ו CONSTANT. חברים נוספים כגון BEZIER ייתכן שיהיה זמין.

ImageRenderOptions

מגדיר התנהגות מחוץ לטווח מסגרות המפתח (לפני המפתח הראשון ואחרי האחרון). נשלט על ידי ExtrapolationType.

StepMode

מִמְסְפָּר השולט באופן שבו אינטרפולציית שלב (קבועה) מיושמת בגבולות.

WeightedMode

רשימת ערכים לטיפול במשקול המשיק של בזייה: NONE, OUT_WEIGHT, NEXT_IN_WEIGHT, או BOTH.

ExtrapolationType

רשימת ערכים של התנהגויות מחוץ לטווח: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, ו OSCILLATE.

קלט/פלט של פורמט

FileFormat

מתאר בסיס לפורמט קובץ תלת‑ממדי. כל פורמט נתמך מספק singleton קונקרטי באמצעות getInstance().

ImageRenderOptions

מחלקה בסיסית למימושי ייבוא ספציפיים לפורמט. לא נוצרה ישירות; מופעלת פנימית על‑ידי scene.open().

ImageRenderOptions

מחלקה בסיסית למימושי יצוא ספציפיים לפורמט. לא נוצרה ישירות; מופעלת פנימית על‑ידי scene.save().

LoadOptions

מחלקה בסיסית לאובייקטי אפשרויות טעינה ספציפיים לפורמט. העבר מופע של תת‑מחלקה ל‑ scene.open() או scene.openFromBuffer().

SaveOptions

מחלקה בסיסית לאובייקטי אפשרויות שמירה ספציפיים לפורמט. העבר מופע של תת‑מחלקה ל‑ scene.save().

IOService

ממשק שירות פנימי המפשט קלט/פלט של מערכת קבצים ובאפרים למייבאים ולמייצאים.

פורמט OBJ

OBJ תומך גם בייבוא וגם ביצוא. בעת שמירה כ‑OBJ, ספריית החומרים (.mtl) נכתב אוטומטית לצד ה .obj קובץ.

ObjImporter

מייבא פנימי הקורא קבצי Wavefront OBJ, פותר .mtl ספריות חומרים, וממלא Scene. מופעל אוטומטית כאשר ObjLoadOptions נשלח ל scene.open().

ObjExporter

מייצא פנימי שכותב קבצי Wavefront OBJ. מלווה .mtl ספריית החומרים נכתבת אוטומטית. מופעל כאשר scene.save() מכוון ל .obj נתיב.

ObjLoadOptions

אפשרויות טעינה לקבצי OBJ. תכונות מפתח: enableMaterials (בוליאני, ברירת מחדל true), flipCoordinateSystem (בוליאני), normalizeNormal (בוליאני, ברירת מחדל true), scale (מספר). ראה אפשרויות טעינה ושמירה של פורמט לפרטים מלאים.

ObjSaveOptions

שמור אפשרויות לייצוא OBJ. העבר ל scene.save() לְשׁלוֹט בִּהְתַּנָּעוּת הַפִּלט של OBJ. ראה אפשרויות טעינה ושמירה של פורמט לפרטים מלאים.

ObjFormat

תיאור פורמט יחיד עבור OBJ. גם canImport ו canExport הם true.

פורמט glTF

GltfImporter

קורא glTF 2.0 JSON (.gltf) ו‑GLB בינארי (.glb) קבצים. מטפל בהתייחסויות למאגר משולב וחיצוני, חומרים PBR, סקינים וקטעי אנימציה.

GltfExporter

כותב פלט glTF 2.0. כאשר GltfSaveOptions.binaryMode הוא true, מייצר GLB עצמאי; אחרת כותב JSON .gltf עם קובץ נלווה .bin מאגר.

GltfLoadOptions

אפשרויות טעינה לקבצי glTF/GLB. שולטות ברזולוציית המאגר ובתנהגות טעינת המרקמים.

GltfSaveOptions

אפשרויות שמירה לייצוא glTF/GLB. תכונות בולטות: binaryMode (בוליאני, true → GLB, ברירת מחדל false), flipTexCoordV (בוליאני, הופך את ציר ה‑UV האנכי, ברירת מחדל true). ראה אפשרויות טעינה ושמירה של פורמט לפרטים מלאים.

GltfFormat

מתאר פורמט יחיד. קבל דרך GltfFormat.getInstance() ועבר ל scene.save() כארגומנט השני.

פורמט STL

StlImporter

קורא קבצי STL בפורמט ASCII ובינארי לתוך Scene שמכיל יחיד Mesh ישות.

StlExporter

כותב STL בינארי. הפלט מכיל את הרשת המשולשת מה‑scene; פוליגונים שאינם משולשים משולשים אוטומטית.

StlLoadOptions

אפשרויות טעינה עבור STL. שולטות האם המייבא הופך נורמליות במהלך הייבוא.

StlSaveOptions

אפשרויות שמירה לייצוא STL. מאפיין מפתח: binaryMode (בוליאני, ברירת מחדל false). שולט האם הפלט הוא STL בפורמט ASCII או בינארי. ראה אפשרויות טעינה ושמירה של פורמט לפרטים מלאים.

StlFormat

תיאור פורמט יחיד. קבל דרך StlFormat.getInstance().

3MF Format

ThreeMfImporter

קורא ארכיוני Open Packaging Convention 3MF וממלא א Scene עם אובייקטי רשת, צבעים ותכונות חומר.

ThreeMfExporter

כותב ארכיון 3MF תקין מה‑scene הנוכחי. מתאים לתהליכי הדפסת תלת‑ממד.

ThreeMfLoadOptions

אפשרויות טעינה עבור קבצי 3MF.

ThreeMfSaveOptions

אפשרויות שמירה לייצוא 3MF.

ThreeMfFormat

תיאור פורמט יחיד. קבל דרך ThreeMfFormat.getInstance().

פורמט FBX

FbxImporter

קורא קבצי FBX בינאריים ו-ASCII כולל גאומטריה, חומרים, שלדים, צורות מיזוג וקטעי אנימציה.

FbxExporter

כותב קבצי FBX מהסצנה הנוכחית. תמיכה ביצוא FBX בינארי ו-ASCII בהתאם לאפשרויות.

FbxLoadOptions

אפשרויות טעינה ל‑FBX. שולט אם אנימציה, סקינים וצורות מיזוג מיובאים.

FbxSaveOptions

אפשרויות שמירה לייצוא FBX. תכונה מרכזית: embedTextures (בוליאני, ברירת מחדל false). ראה אפשרויות טעינה ושמירה של פורמט לפרטים מלאים.

FbxFormat

אובייקט יחיד של מתאר הפורמט. קבל דרך FbxFormat.getInstance().

פורמט COLLADA

ייבוא וייצוא COLLADA דורשים את xmldom תלות שותפה, שמותקנת אוטומטית עם @aspose/3d.

ColladaImporter

קורא COLLADA (.dae) קבצי XML באמצעות xmldom. מטפל בגאומטריה, חומרים, מצלמות, תאורה והאנימציה.

ColladaExporter

כותב פלט XML של COLLADA מהסצנה הנוכחית. מתאים להחלפה עם כלי DCC (Blender, Maya וכו’).

ColladaFormat

תיאור פורמט יחיד. קבל דרך ColladaFormat.getInstance().

מערכת מאפיינים

ImageRenderOptions

זוג שם/ערך בעל טיפוס שניתן לצרף לכל A3DObject. תומך בסוגי ערכים סקלריים ווקטוריים.

PropertyCollection

מכולה מסודרת של Property אובייקטים. נגיש על כל A3DObject באמצעות properties מאפשר גישה.

CustomObject

חבילה חופשית של מאפיינים שמרחיבה A3DObject. משמש לאחסון מטא-נתונים שרירותיים שאינם ממופים למחלקה סטנדרטית.

מידע נכס

AssetInfo

נושא מטא‑נתונים ברמת הסצנה שנקראו מקובץ המקור: מחבר, שם היישום, תאריך יצירה, קנה מידה של היחידות, ומידע על צירי הקואורדינטות.

ImageRenderOptions

אפשרויות השולטות באופן שבו מרקמים ותמונות נפתרים ומקודדים בעת שמירה לפורמטים שמשלבים נתוני תמונה (למשל, GLB עם binaryMode: true).

ראה גם

 עברית