Render
Export 3D object in one of the flowing formats: FBX, OBJ, glTF, Glb, BWO.
BwApiRenderExport3DObject
Export 3D object in one of the flowing formats: FBX, OBJ, glTF, Glb, BWO.
Python
BwApi.RenderExport3DObject(garmentId, export3dObjectJson)
C++
BwApiRenderExport3DObject(garmentId, export3dObjectJson);
C#
BwApi.RenderExport3DObject(garmentId, export3dObjectJson);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | export3dObjectJson | JSON object as a string that represents the object (see export_3d_object.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiRenderImage
DEPRECATED - Use BwApiRenderImageEx
Python
BwApi.RenderImage()
C++
BwApiRenderImage();
C#
BwApi.RenderImage();
---
BwApiRenderImageEx
Render image(s) of the current garment in normal, ray_trace or schematic mode.
Python
BwApi.RenderImageEx(garmentId, renderJson)
C++
BwApiRenderImageEx(garmentId, renderJson, renderJobId);
C#
BwApi.RenderImageEx(garmentId, renderJson);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | renderJson | JSON object as a string that represents a render object (see render.json schema). |
Out | renderJobId | Render job ID for raytrace rendering (local or remote) to be used with BwApiRenderJobStatusGet. For 'normal' render this will return an empty string. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: Avatar must be dressed prior calling to this function.
---
BwApiRenderJobStatusGet
Get raytrace render status (local or remote).
Python
BwApi.RenderJobStatusGet(garmentId, renderJobId, status)
C++
BwApiRenderJobStatusGet(garmentId, renderJobId, status);
C#
BwApi.RenderJobStatusGet(garmentId, renderJobId, status);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | renderJobId | Render_job_id returned when calling BwApiRenderImage (see render.json schema). |
In | status | JSON object as a string that represents a render job status (see raytrace_render_job_status.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiRenderRayTraceCMD
Create ray trace command.
Python
BwApi.RenderRayTraceCMD(garmentId, renderJson)
C++
BwApiRenderRayTraceCMD(garmentId, renderJson, cmd);
C#
BwApi.RenderRayTraceCMD(garmentId, renderJson);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | renderJson | JSON object as a string that represents a render object (see render.json schema). |
Out | cmd | The command to run on the third party rendering. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: The command depends on the Ray-Trace renderer path which can be modified in Preperrences->Rendering.
---
BwApiRenderAnimationMode
Set the animation mode state in the system.
Python
BwApi.RenderAnimationMode(state)
C++
BwApiRenderAnimationMode(state);
C#
BwApi.RenderAnimationMode(state);
Parameters
Param | Variable | Description |
In | state | Boolean 1 = animation mode, 0 = normal mode. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiRenderAnimationModeGet
Get the animation mode state in the system.
Python
BwApi.RenderAnimationModeGet()
C++
BwApiRenderAnimationModeGet(state);
C#
BwApi.RenderAnimationModeGet();
Parameters
Param | Variable | Description |
Out | state | Boolean 1 = animation mode, 0 = normal mode. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiRenderExportByPreset
Render/export using a standard render/export preset.
Python
BwApi.RenderExportByPreset(garmentId, presetObj, outputPath)
C++
BwApiRenderExportByPreset(garmentId, presetObj, outputPath, renderJobId);
C#
BwApi.RenderExportByPreset(garmentId, presetObj, outputPath);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | presetObj | JSON object represent the content of render dialog preset file (i.e: the content of .exp file). |
In | outputPath | Output folder path. |
Out | renderJobId | Render job ID for raytrace rendering (local or remote) to be used with BwApiRenderJobStatusGet. For 'normal' render this will return an empty string. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: Avatar must be dressed prior calling to this function.
---