Avatar
Get all the avatar templates in the system.
BwApiAvatarTemplates
Get all the avatar templates in the system.
Python
BwApi.AvatarTemplates()
C++
BwApiAvatarTemplates(templates);
C#
BwApi.AvatarTemplates();
Parameters
Param | Variable | Description |
Out | templates | Avatar templates in the system. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarTemplatesEx
Get all the avatar templates in the system.
Python
BwApi.AvatarTemplatesEx()
C++
BwApiAvatarTemplatesEx(templates);
C#
BwApi.AvatarTemplatesEx();
Parameters
Param | Variable | Description |
Out | templates | JSON object as a string that represents an array of avatar template information (see avatar_template.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarCreate
Create an avatar from a given template ID and select it.
Python
BwApi.AvatarCreate(avatarTemplate, name)
C++
BwApiAvatarCreate(avatarTemplate, name, avatarId);
C#
BwApi.AvatarCreate(avatarTemplate, name);
Parameters
Param | Variable | Description |
In | avatarTemplate | Avatar template ID. |
In | name | Name of the avatar. |
Out | avatarId | ID of the avatar. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarDelete
Remove an avatar.
Python
BwApi.AvatarDelete(avatarId)
C++
BwApiAvatarDelete(avatarId);
C#
BwApi.AvatarDelete(avatarId);
Parameters
Param | Variable | Description |
In | avatarId | ID of an avatar. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarIds
Get the avatar IDs in the system.
Python
BwApi.AvatarIds(avatarParametric)
C++
BwApiAvatarIds(avatarParametric, avatarIds);
C#
BwApi.AvatarIds(avatarParametric);
Parameters
Param | Variable | Description |
In | avatarParametric | Boolean (1/0) if the given avatar type is parametric or not. |
Out | avatarIds | IDs of the avatars. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarCurrentGet
Get the current avatar ID.
Python
BwApi.AvatarCurrentGet()
C++
BwApiAvatarCurrentGet(avatarId);
C#
BwApi.AvatarCurrentGet();
Parameters
Param | Variable | Description |
Out | avatarId | ID of the avatar. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarCurrentSet
Set the current avatar.
Python
BwApi.AvatarCurrentSet(avatarId)
C++
BwApiAvatarCurrentSet(avatarId);
C#
BwApi.AvatarCurrentSet(avatarId);
Parameters
Param | Variable | Description |
In | avatarId | ID of the avatar. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarImport
Import an avatar from FBX or OBJ.
Python
BwApi.AvatarImport(path)
C++
BwApiAvatarImport(path, avatarId);
C#
BwApi.AvatarImport(path);
Parameters
Param | Variable | Description |
In | path | Path to FBX or OBJ. |
Out | avatarId | ID of the avatar. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarImportEx
Import an avatar from FBX or OBJ.
Python
BwApi.AvatarImportEx(jsonAvatarImport)
C++
BwApiAvatarImportEx(jsonAvatarImport, avatarId);
C#
BwApi.AvatarImportEx(jsonAvatarImport);
Parameters
Param | Variable | Description |
In | jsonAvatarImport | JSON object as a string that represents an import properties object (see avatar_import_info.json schema). |
Out | avatarId | ID of the avatar. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarImportVSA
Import avatars VSA.
Python
BwApi.AvatarImportVSA(path)
C++
BwApiAvatarImportVSA(path, avatarIds);
C#
BwApi.AvatarImportVSA(path);
Parameters
Param | Variable | Description |
In | path | Path to a VSA file. |
Out | avatarIds | Imported avatar's ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarExportVSA
Export avatars VSA.
Python
BwApi.AvatarExportVSA(path, avatarIds)
C++
BwApiAvatarExportVSA(path, avatarIds);
C#
BwApi.AvatarExportVSA(path, avatarIds);
Parameters
Param | Variable | Description |
In | path | Path to a VSA file. |
In | avatarIds | Exported avatar's ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarEVSAExport
Export avatars VSA.
Python
BwApi.AvatarEVSAExport(vsaPath, avatarId, avatarVersion, evsaPath)
C++
BwApiAvatarEVSAExport(vsaPath, avatarId, avatarVersion, evsaPath);
C#
BwApi.AvatarEVSAExport(vsaPath, avatarId, avatarVersion, evsaPath);
Parameters
Param | Variable | Description |
In | vsaPath | Path to a VSA file. |
In | avatarId | Exported avatar ID. |
In | avatarVersion | Exported avatar version. |
In | evsaPath | Path to a EVSA file. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarCurrentPoseIds
Get the current avatar's pose IDs.
Python
BwApi.AvatarCurrentPoseIds()
C++
BwApiAvatarCurrentPoseIds(poseIds);
C#
BwApi.AvatarCurrentPoseIds();
Parameters
Param | Variable | Description |
Out | poseIds | List of poses for the currently active avatar. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarPoseCurrentGet
Get the current avatar's current pose ID.
Python
BwApi.AvatarPoseCurrentGet()
C++
BwApiAvatarPoseCurrentGet(poseId);
C#
BwApi.AvatarPoseCurrentGet();
Parameters
Param | Variable | Description |
Out | poseId | Pose ID of the pose. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarPoseCurrentSet
Set the current avatar's current pose.
Python
BwApi.AvatarPoseCurrentSet(poseId, redress, resimulate)
C++
BwApiAvatarPoseCurrentSet(poseId, redress, resimulate);
C#
BwApi.AvatarPoseCurrentSet(poseId, redress, resimulate);
Parameters
Param | Variable | Description |
In | poseId | Pose ID of the pose. |
In | redress | Boolean 0 - change pose only, 1 - after changing pose redress all garments. |
In | resimulate | Boolean 0 - use existing snapshot if exist, 1 - create a new snapshot. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarPosePropertiesGet
Get the current avatar's pose properties.
Python
BwApi.AvatarPosePropertiesGet(poseId)
C++
BwApiAvatarPosePropertiesGet(poseId, jsonAvatarPoseProperties);
C#
BwApi.AvatarPosePropertiesGet(poseId);
Parameters
Param | Variable | Description |
In | poseId | Pose ID of the pose. |
Out | jsonAvatarPoseProperties | JSON object as a string that represents an avatar pose properties object (see avatar_pose_properties.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarPosePropertiesUpdate
Update the current avatar's pose properties.
Python
BwApi.AvatarPosePropertiesUpdate(poseId, jsonAvatarPoseProperties)
C++
BwApiAvatarPosePropertiesUpdate(poseId, jsonAvatarPoseProperties);
C#
BwApi.AvatarPosePropertiesUpdate(poseId, jsonAvatarPoseProperties);
Parameters
Param | Variable | Description |
In | poseId | Pose ID of the pose. |
In | jsonAvatarPoseProperties | JSON object as a string that represents an avatar pose properties object (see avatar_pose_properties.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarJointIds
Get the list of joint IDs of the current avatar pose.
Python
BwApi.AvatarJointIds()
C++
BwApiAvatarJointIds(joints);
C#
BwApi.AvatarJointIds();
Parameters
Param | Variable | Description |
Out | joints | The list of avatar joint IDs. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarJointPropertiesGet
Get the properties of a joint of the current avatar pose.
Python
BwApi.AvatarJointPropertiesGet(jointId)
C++
BwApiAvatarJointPropertiesGet(jointId, jsonAvatarJointProperties);
C#
BwApi.AvatarJointPropertiesGet(jointId);
Parameters
Param | Variable | Description |
In | jointId | The joint ID whose properties are to be retrieved. |
Out | jsonAvatarJointProperties | JSON object as a string that represents the properties of the given joint object (see joint.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarJointPropertiesUpdate
Set the properties of a joint of the current avatar pose.
Python
BwApi.AvatarJointPropertiesUpdate(jointId, jsonAvatarJointProperties)
C++
BwApiAvatarJointPropertiesUpdate(jointId, jsonAvatarJointProperties);
C#
BwApi.AvatarJointPropertiesUpdate(jointId, jsonAvatarJointProperties);
Parameters
Param | Variable | Description |
In | jointId | The joint ID whose rotation is to be set. |
In | jsonAvatarJointProperties | JSON object as a string that represents the properties of the given joint object (see joint.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarPropertiesGet
Get the current avatar's properties. The hanging points of the avatar are according to the original avatar's axies direction except y (which is opposite)
Python
BwApi.AvatarPropertiesGet()
C++
BwApiAvatarPropertiesGet(jsonAvatarProperties);
C#
BwApi.AvatarPropertiesGet();
Parameters
Param | Variable | Description |
Out | jsonAvatarProperties | JSON object as a string that represents an avatar properties object (see avatar_properties.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: Vertical: Direction of the object - can be one of 6: for each one of the surrounding "Cube" faces. For an avatar, could stand straight, on its head, laying parallel to us with its head to the left, head to the right, laying perpendicular to us head or feet in our direction.
---
BwApiAvatarPropertiesUpdate
Update the current avatar's properties. The hanging points of the avatar are according to the original avatar's axies direction.
Python
BwApi.AvatarPropertiesUpdate(jsonAvatarProperties)
C++
BwApiAvatarPropertiesUpdate(jsonAvatarProperties);
C#
BwApi.AvatarPropertiesUpdate(jsonAvatarProperties);
Parameters
Param | Variable | Description |
In | jsonAvatarProperties | JSON object as a string that represents an avatar properties object (see avatar_properties.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: The available skin tones are in <VStitcher or Lotta instalation folder>\<version>\Materials.
---
BwApiAvatarHangingPointsGet
Get the avatar's hanging points.
Python
BwApi.AvatarHangingPointsGet(jsonAvatarHangingPointsInfo)
C++
BwApiAvatarHangingPointsGet(jsonAvatarHangingPointsInfo, jsonAvatarHangingPoints);
C#
BwApi.AvatarHangingPointsGet(jsonAvatarHangingPointsInfo);
Parameters
Param | Variable | Description |
In | jsonAvatarHangingPointsInfo | JSON object as a string that represents an avatar's hanging points information. (see hanging_points_info.json schema). |
Out | jsonAvatarHangingPoints | JSON object as a string that represents an avatar's hanging points (see hanging_points.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: This function will underss the current avatar.
---
BwApiAvatarHangingPointsUpdate
Update the currently imported avatar's hanging points. The hanging points of the avatar are according to the original avatar's axies direction.
Python
BwApi.AvatarHangingPointsUpdate(jsonAvatarHangingPoints)
C++
BwApiAvatarHangingPointsUpdate(jsonAvatarHangingPoints);
C#
BwApi.AvatarHangingPointsUpdate(jsonAvatarHangingPoints);
Parameters
Param | Variable | Description |
In | jsonAvatarHangingPoints | JSON object as a string that represents avatar hanging points in Browzwears axies direction (see hanging_points.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: Update is applicable only on imported avatars.
---
BwApiAvatarMeasurementsSchema
Get the current avatar's measurements schema.
Python
BwApi.AvatarMeasurementsSchema()
C++
BwApiAvatarMeasurementsSchema(measurementsSchema);
C#
BwApi.AvatarMeasurementsSchema();
Parameters
Param | Variable | Description |
Out | measurementsSchema | Schema that represents avatar measurements schema. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarMeasurementsGet
Get the current avatar's measurements.
Python
BwApi.AvatarMeasurementsGet()
C++
BwApiAvatarMeasurementsGet(jsonAvatarMeasurements);
C#
BwApi.AvatarMeasurementsGet();
Parameters
Param | Variable | Description |
Out | jsonAvatarMeasurements | JSON object as a string that represents an avatar measurements object. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiAvatarMeasurementsUpdate
Update the current avatar's measurements.
Python
BwApi.AvatarMeasurementsUpdate(jsonAvatarMeasurements)
C++
BwApiAvatarMeasurementsUpdate(jsonAvatarMeasurements);
C#
BwApi.AvatarMeasurementsUpdate(jsonAvatarMeasurements);
Parameters
Param | Variable | Description |
In | jsonAvatarMeasurements | JSON object as a string that represents an avatar measurements object. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: The JSON jsonAvatarMeasurements will be validated with the avatar measurements schema.
---
BwApiAvatarMeasurementsUpdate_v2
Update the current avatar's measurements V2.
Python
BwApi.AvatarMeasurementsUpdate_v2(jsonAvatarMeasurements)
C++
BwApiAvatarMeasurementsUpdate_v2(jsonAvatarMeasurements, jsonMeasurementsError);
C#
BwApi.AvatarMeasurementsUpdate_v2(jsonAvatarMeasurements);
Parameters
Param | Variable | Description |
In | jsonAvatarMeasurements | JSON object as a string that represents an avatar measurements object. |
Out | jsonMeasurementsError | JSON object as a string that represents an measurements error object (see avatar_measurements_error.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: The JSON jsonAvatarMeasurements will be validated with the avatar measurements schema.
---