accessories
#
The accessories
object has a different structure depending on which accessory you are defining.
None#
To generate an actor with no accessories, use this structure for the accessories
object:
"accessories": null,
Glasses#
To define a pair of glasses for the actor to wear, use this structure for the accessories
object:
"accessories": { "glasses": { "id": //The UUID of a specific pair of glasses "frame_color": //The base color of the glasses frame "frame_metalness": //The reflectivity of the glasses frame "lens_color": //The base color of the glasses lenses "lens_reflectivity": //The amount of light reflected by the lenses "lens_transparency": //The amount of light that passes through the lenses "position": //Where the glasses are being worn } },
id
#
string
The id
field defines the specific pair of glasses that the actor should wear, chosen from Datagen’s asset library. This field defines the shape of the glasses - not its color, reflectivity, or other attributes.
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
Tip
To download a CSV with a complete list of UUIDs that identify individual glasses shapes, click here
Sample usage
A sample id field and its location in the data request
In the JSON hierarchy of the data request, the
id
field is found here:{ "datapoints": [ { "accessories": { "glasses": { "id": "518467ba-b067-4aae-ad73-107acd0c3583", } } } ] }This value will generate a pair of cat-eye glasses.
frame_color
#
string
The frame_color
field defines the base color of the frame of the actor’s glasses. This color will be further affected by the value of the frame_metalness field.
Valid values are as follows:
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
Sample usage
A sample frame_color field and its location in the data request
In the JSON hierarchy of the data request, the
frame_color
field is found here:{ "datapoints": [ { "accessories": { "glasses": { "frame_color": "white", } } } ] }This value will generate a pair of glasses with white frames.
frame_metalness
#
64-bit float
The frame_metalness
field defines the reflectivity of the frames of the actor’s glasses, which can grant the frames a more plastic or more metallic character. This field accepts floating-point values from 0 to 1.
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
Sample usage
lens_color
#
string
The lens_color
field determines the base color of the lenses of the actor’s glasses. This base color will be further affected by the values of the lens_reflectivity and lens_transparency fields.
Valid values are:
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
Sample usage
A sample lens_color field and its location in the data request
In the JSON hierarchy of the data request, the
lens_color
field is found here:{ "datapoints": [ { "accessories": { "glasses": { "lens_color": "red", } } } ] }This value will generate a pair of glasses whose lenses are tinted red, in addition to any transparency and reflectivity that may be applied:
![]()
lens_reflectivity
and lens_transparency
#
64-bit floats
The lens_reflectivity
and lens_transparency
fields define how light behaves as it hits the glasses lens.
lens_reflectivity
defines how much light is reflected off of the lens. The higher the reflectivity, the more you will see the actor’s surroundings in the glasses lens. lens_reflectivity
accepts floating-point values from 0 to 1.
lens_transparency
defines how much light is able to pass directly through the lens. The higher the transparency, the more you can see of the actor’s eyes. lens_transparency
accepts floating-point values from 0 to 1.
Sample usage
Sample lens_reflectivity and lens_transparency fields, and their location in the data request
In the JSON hierarchy of the data request, the
lens_reflectivity
andlens_transparency
fields are found here:{ "datapoints": [ { "accessories": { "glasses": { "lens_reflectivity": 1.0, "lens_transparency": 0, } } } ] }These values will generate a pair of mirrored lenses.
position
#
string
The position
field defines where the actor is wearing his or her glasses. Currently we support glasses being worn only in the default position, on the nose.
Sample usage
A sample position field and its location in the data request
In the JSON hierarchy of the data request, the
position
field is found here:{ "datapoints": [ { "accessories": { "glasses": { "position": "on_nose" } }, } ] }This value will generate a pair of glasses worn on the nose:
![]()
Masks#
To define a facemask for the actor to wear, use this structure for the accessories
object:
"accessories": { "mask": { "id": //The UUID that identifies the physical shape of the mask "color": //The base color of the mask "roughness": //How much light the mask absorbs before reflecting it "position": //Where the mask is being worn "texture": //The physical pattern of the mask } },
id
#
string
The id
field defines the specific mask that the actor will wear. This field defines the shape and style of the mask - not its color, reflectivity, or other attributes.
Currently, Datagen offers only one type of mask, with the UUID 7e701bf2-91ef-4729-91f7-cb039e49b085
.
Sample usage
A sample id field and its location in the data request
In the JSON hierarchy of the data request, the
id
field is found here:{ "datapoints": [ { "accessories": { "mask": { "id": "7e701bf2-91ef-4729-91f7-cb039e49b085", } }, } ] }This value will generate a user wearing a mask of the standard shape offered by Datagen.
color
#
string
The color
field defines the base color of the mask. This color will be further influenced by the roughness and texture fields.
![]()
|
![]()
|
![]()
|
![]()
|
![]()
|
Sample usage
A sample color field and its location in the data request
In the JSON hierarchy of the data request, the
color
field is found here:{ "datapoints": [ { "accessories": { "mask": { "color": "green", } }, } ] }This value will generate a mask of the following color:
roughness
#
64-bit float
The roughness
field defines the reflectivity of the mask: whether or not light is reflected before it is absorbed by the mask. The higher the reflectivity, the more shiny the mask surface; at lower levels of reflectivity, the mask has a duller surface more appropriate to cloth-like materials.
Sample usage
A sample roughness field and its location in the data request
In the JSON hierarchy of the data request, the
roughness
field is found here:{ "datapoints": [ { "accessories": { "mask": { "roughness": 0.8, } }, } ] }This value will generate a mask that has a shinier surface than most.
position
#
string
The position
field defines where the actor will wear his or her mask. Valid values are on_nose
, on_mouth
, and on_chin
.
Sample usage
A sample position field and its location in the data request
In the JSON hierarchy of the data request, the
position
field is found here:{ "datapoints": [ { "accessories": { "mask": { "position": "on_nose", } }, } ] }This value will generate a datapoint depicting an actor wearing a mask over the nose and mouth:
![]()
texture
#
string
The texture
field defines the pattern of the fabric in the mask that the actor is wearing. Valid values are cloth
, diamond_pattern
, and woven
.
Sample usage
A sample texture field and its location in the data request
In the JSON hierarchy of the data request, the
texture
field is found here:{ "datapoints": [ { "accessories": { "mask": { "texture": "woven" } }, } ] }This value will generate a mask with a woven texture.