Environment
Set the current environment of the avatar.
BwApiEnvironmentSet
Set the current environment of the avatar.
Python
BwApi.EnvironmentSet(name)
C++
BwApiEnvironmentSet(name);
C#
BwApi.EnvironmentSet(name);
Parameters
Param | Variable | Description |
In | name | Name of the environment. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: If the name doesn't exist nothing will happen.
---
BwApiEnvironmentGet
Get the current environment of the avatar.
Python
BwApi.EnvironmentGet()
C++
BwApiEnvironmentGet(name);
C#
BwApi.EnvironmentGet();
Parameters
Param | Variable | Description |
Out | name | Name of the current environment. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironments
Get all the environments in the system.
Python
BwApi.Environments()
C++
BwApiEnvironments(environments);
C#
BwApi.Environments();
Parameters
Param | Variable | Description |
Out | environments | List of environments. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentLightCurrentSet
Set the light of the avatar.
Python
BwApi.EnvironmentLightCurrentSet(name)
C++
BwApiEnvironmentLightCurrentSet(name);
C#
BwApi.EnvironmentLightCurrentSet(name);
Parameters
Param | Variable | Description |
In | name | Name of the light. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: If the name doesn't exist nothing will happen.
---
BwApiEnvironmentLightCurrentGet
Get the light of the avatar.
Python
BwApi.EnvironmentLightCurrentGet()
C++
BwApiEnvironmentLightCurrentGet(name);
C#
BwApi.EnvironmentLightCurrentGet();
Parameters
Param | Variable | Description |
Out | name | Name of the current light. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentLights
Get all the lights in the system.
Python
BwApi.EnvironmentLights()
C++
BwApiEnvironmentLights(lights);
C#
BwApi.EnvironmentLights();
Parameters
Param | Variable | Description |
Out | lights | List of lights. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentLightInfoSet
Set the light info.
Python
BwApi.EnvironmentLightInfoSet(name, jsonLightInfo)
C++
BwApiEnvironmentLightInfoSet(name, jsonLightInfo);
C#
BwApi.EnvironmentLightInfoSet(name, jsonLightInfo);
Parameters
Param | Variable | Description |
In | name | Name of the light. |
In | jsonLightInfo | JSON object as a string that represents a light info object (see light.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: If the name doesn't exist nothing will happen.
---
BwApiEnvironmentLightInfoGet
Get the light info
Python
BwApi.EnvironmentLightInfoGet(name, jsonLightInfo)
C++
BwApiEnvironmentLightInfoGet(name, jsonLightInfo);
C#
BwApi.EnvironmentLightInfoGet(name, jsonLightInfo);
Parameters
Param | Variable | Description |
In | name | Name of the light. |
In | jsonLightInfo | JSON object as a string that represents a light info object (see light.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: If the name doesn't exist nothing will happen.
---
BwApiEnvironmentLightSetDefault
Set current HDRI Light as Default HDRI Light.
Python
BwApi.EnvironmentLightSetDefault()
C++
BwApiEnvironmentLightSetDefault();
C#
BwApi.EnvironmentLightSetDefault();
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentLightLoadDefault
Load Default HDRI Light.
Python
BwApi.EnvironmentLightLoadDefault()
C++
BwApiEnvironmentLightLoadDefault();
C#
BwApi.EnvironmentLightLoadDefault();
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentLightImport
Import HDRI Light from file.
Python
BwApi.EnvironmentLightImport(fileName)
C++
BwApiEnvironmentLightImport(fileName);
C#
BwApi.EnvironmentLightImport(fileName);
Parameters
Param | Variable | Description |
In | fileName | Filename of the light to import. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentLightDelete
Delete imported HDRI Light.
Python
BwApi.EnvironmentLightDelete(name)
C++
BwApiEnvironmentLightDelete(name);
C#
BwApi.EnvironmentLightDelete(name);
Parameters
Param | Variable | Description |
In | name | Name of the light. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentCameraGet
Get the current camera of the environment.
Python
BwApi.EnvironmentCameraGet()
C++
BwApiEnvironmentCameraGet(cameraJson);
C#
BwApi.EnvironmentCameraGet();
Parameters
Param | Variable | Description |
Out | cameraJson | Camera JSON object as a string containing all the camera information (see camera.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentCameraSet
Set the current camera of the environment.
Python
BwApi.EnvironmentCameraSet(cameraJson)
C++
BwApiEnvironmentCameraSet(cameraJson);
C#
BwApi.EnvironmentCameraSet(cameraJson);
Parameters
Param | Variable | Description |
In | cameraJson | Camera JSON object as a string containing all the camera information (see camera.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentTurntableCameraPositionsGet
Get all the the turntable position from a given number of angles and a camera.
Python
BwApi.EnvironmentTurntableCameraPositionsGet(cameraJson, angles)
C++
BwApiEnvironmentTurntableCameraPositionsGet(cameraJson, angles, cameraPositions);
C#
BwApi.EnvironmentTurntableCameraPositionsGet(cameraJson, angles);
Parameters
Param | Variable | Description |
In | cameraJson | Camera JSON object as a string containing all the camera information (see camera.json schema). |
In | angles | Number of angles. |
Out | cameraPositions | Array of camera positions (as a string) that represents the turntable positions. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentCameraViews
Get all camera views.
Python
BwApi.EnvironmentCameraViews()
C++
BwApiEnvironmentCameraViews(cameraViews);
C#
BwApi.EnvironmentCameraViews();
Parameters
Param | Variable | Description |
Out | cameraViews | Array of camera view names. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: There are two special camera views named GarmentFront and AvatarFront which get the camera to focus on the garment or the avatar.
---
BwApiEnvironmentCameraViewGet
Get the camera by camera view name.
Python
BwApi.EnvironmentCameraViewGet(garmentId, cameraViewName)
C++
BwApiEnvironmentCameraViewGet(garmentId, cameraViewName, cameraJson);
C#
BwApi.EnvironmentCameraViewGet(garmentId, cameraViewName);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | cameraViewName | Camera view name. |
Out | cameraJson | Camera JSON object as string containing all the camera's information (see camera.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: There are two special camera views named GarmentFront and AvatarFront which get the camera to focus on the garment or the avatar.
---
BwApiEnvironmentBBoxToCamera
Get camera which is looking at the given 3D bounding box.
Python
BwApi.EnvironmentBBoxToCamera(boundingBox)
C++
BwApiEnvironmentBBoxToCamera(boundingBox, cameraJson);
C#
BwApi.EnvironmentBBoxToCamera(boundingBox);
Parameters
Param | Variable | Description |
In | boundingBox | List of BwApiCoordinatesXYZ that construct bounding box camera should look at. |
Out | cameraJson | Camera JSON object as string containing all the camera's information (see camera.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: The camera will look at the middle point of the given bounding box.
---
BwApiEnvironmentCameraViewImport
Import a camera view.
Python
BwApi.EnvironmentCameraViewImport(cameraViewPath)
C++
BwApiEnvironmentCameraViewImport(cameraViewPath);
C#
BwApi.EnvironmentCameraViewImport(cameraViewPath);
Parameters
Param | Variable | Description |
In | cameraViewPath | Camera view full path. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentCameraViewExport
Export a camera view.
Python
BwApi.EnvironmentCameraViewExport(cameraViewName, cameraViewPath)
C++
BwApiEnvironmentCameraViewExport(cameraViewName, cameraViewPath);
C#
BwApi.EnvironmentCameraViewExport(cameraViewName, cameraViewPath);
Parameters
Param | Variable | Description |
In | cameraViewName | Camera view name. |
In | cameraViewPath | Camera view full path. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: There are two special camera views named GarmentFront and AvatarFront which get the camera to focus on the garment or the avatar.
---
BwApiEnvironmentAvatarVisibilitySet
Set the visibility of the current avatar.
Python
BwApi.EnvironmentAvatarVisibilitySet(visible)
C++
BwApiEnvironmentAvatarVisibilitySet(visible);
C#
BwApi.EnvironmentAvatarVisibilitySet(visible);
Parameters
Param | Variable | Description |
In | visible | The avatar visibility. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiEnvironmentAvatarVisibilityGet
Get the visibility of the current avatar.
Python
BwApi.EnvironmentAvatarVisibilityGet()
C++
BwApiEnvironmentAvatarVisibilityGet(visible);
C#
BwApi.EnvironmentAvatarVisibilityGet();
Parameters
Param | Variable | Description |
Out | visible | The avatar visibility. |
Returns: Error/success code (see BwApiErrorCodes enum).
---