Api session event editor customgeometry add: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:


{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]])
| (Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]])
|3D Data array
| 3D Data array
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(TColor or multiple values in array [a, b, c])
| (TColor or multiple values in array [a, b, c])
|Color
| Color
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|[[Texture]] Names
| [[Texture]] Names
|
|  
|-
|-
|3
| 3
|REQUIRED
| REQUIRED
|(boolean or multiple values in array [a, b, c])
| (boolean or multiple values in array [a, b, c])
|Use absolute height from 3D Data array
| Use absolute height from 3D Data array
|
|  
|-
|-
|4
| 4
|REQUIRED
| REQUIRED
|(boolean or multiple values in array [a, b, c])
| (boolean or multiple values in array [a, b, c])
|Render both the front and back face
| Render both the front and back face
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 45: Line 45:
!Description
!Description
|-
|-
|200
| 200
|Integer[] (Integer array)
| Integer[] (Integer array)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Curl example POST:
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorcustomgeometry/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1.0, 2.0 ], -65536, "Texture Name 1", true, true ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorcustomgeometry/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1.0, 2.0 ], -65536, "Texture Name 1", true, true ]'
</syntaxhighlight>
</syntaxhighlight>
Curl example multi item POST:
Curl example multi item POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorcustomgeometry/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], [ -65536, -16744448, -16776961 ], [ "Texture Name 1", "Texture Name 2", "Texture Name 3" ], [ true, false, true ], [ true, false, true ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorcustomgeometry/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], [ -65536, -16744448, -16776961 ], [ "Texture Name 1", "Texture Name 2", "Texture Name 3" ], [ true, false, true ], [ true, false, true ] ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST
 
<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 method: "POST",

Latest revision as of 12:02, 15 June 2026

API Endpoint: api/session/event/editorcustomgeometry/add/

Description: Add a Custom Geometry to render.

Index Importance Type Description Values
0 REQUIRED (Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]) 3D Data array
1 REQUIRED (TColor or multiple values in array [a, b, c]) Color
2 REQUIRED (String or multiple values in array ["a", "b", "c"]) Texture Names
3 REQUIRED (boolean or multiple values in array [a, b, c]) Use absolute height from 3D Data array
4 REQUIRED (boolean or multiple values in array [a, b, c]) Render both the front and back face

Response Codes

Response Code: Description
200 Integer[] (Integer array)
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editorcustomgeometry/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1.0, 2.0 ], -65536, "Texture Name 1", true, true ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editorcustomgeometry/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], [ -65536, -16744448, -16776961 ], [ "Texture Name 1", "Texture Name 2", "Texture Name 3" ], [ true, false, true ], [ true, false, true ] ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ [ 1.0, 2.0 ], -65536, "Texture Name 1", true, true ]'
};
fetch("https://engine.tygron.com/api/session/event/editorcustomgeometry/add/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));