RenderExport3DObject
Export 3D object in one of the flowing formats: FBX, OBJ, glTF, Glb, BWO.
Python C++ C#
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 Schema/export_3d_object.json schema) |
Error/success code (see BwApiErrorCodes enum).
RenderImage
DEPRECATED - Use BwApiRenderImageEx
Python C++ C#
Python
BwApi.RenderImage()
C++
BwApiRenderImage();
C#
BwApi.RenderImage();
RenderImageEx
Render image(s) of the current garment in normal, ray_trace or schematic mode.
Python C++ C#
Python
BwApi.RenderImageEx(garmentId, renderJson)
C++
BwApiRenderImageEx(garmentId, renderJson);
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 Schema/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 |
Error/success code (see BwApiErrorCodes enum).
Avatar must be dressed prior calling to this function.
For ray_trace mode this function will use the current render application settings.
RenderJobStatusGet
Get raytrace render status (local or remote).
Python C++ C#
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 Schema/render.json schema) |
In | status | JSON object as a string that represents a render job status (see Schema/raytrace_render_job_status.json schema) |
Error/success code (see BwApiErrorCodes enum).
RenderRayTraceCMD
Create ray trace command.
Python C++ C#
Python
BwApi.RenderRayTraceCMD(garmentId, renderJson)
C++
BwApiRenderRayTraceCMD(garmentId, renderJson);
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 Schema/render.json schema) |
Out | cmd | The command to run on the third party rendering |
Error/success code (see BwApiErrorCodes enum).
The command depends on the Ray-Trace renderer path which can be modified in Preperrences->Rendering.
RenderAnimationMode
Set the animation mode state in the system.
Python C++ C#
Python
BwApi.RenderAnimationMode(state)
C++
BwApiRenderAnimationMode(state);
C#
BwApi.RenderAnimationMode(state);
Parameters
Param | Variable | Description |
In | state | Boolean 1 = animation mode, 0 = normal mode |
Error/success code (see BwApiErrorCodes enum).
RenderAnimationModeGet
Get the animation mode state in the system.
Python C++ C#
Python
BwApi.RenderAnimationModeGet()
C++
BwApiRenderAnimationModeGet();
C#
BwApi.RenderAnimationModeGet();
Parameters
Param | Variable | Description |
Out | state | Boolean 1 = animation mode, 0 = normal mode |
Error/success code (see BwApiErrorCodes enum).
RenderExportByPreset
Render/export using a standard render/export preset.
Python C++ C#
Python
BwApi.RenderExportByPreset(garmentId, presetObj, outputPath)
C++
BwApiRenderExportByPreset(garmentId, presetObj, outputPath);
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 |
Error/success code (see BwApiErrorCodes enum).
Avatar must be dressed prior calling to this function.
For ray trace rendering this function will use the current render application settings.