Sample Structure
Avatar creator sample structure
Last updated
Avatar creator sample structure
Last updated
The Avatar Creator sample uses the AvatarCreatorApi C++ class for communicating with the Ready Player Me Backend. The plugin Content can be completely rewritten to suit your project needs while using the AvatarCreatorApi for communication with the Backend.
The avatar creator is the topmost widget containing all the component sub-widgets: navigation panel, avatar editor, editor setup widgets, and loading screens and popups. It uses a simple state machine logic to change the visibility of the sub-widgets at runtime. It also creates an instance of the AvatarCreatorApi class and provides it to the child widgets. AvatarCreatorApi class handles all the server requests.
Login - Login by sending a one-time code to the user's email address.
User Avatars - Select/edit/delete the previously created avatar from the list of avatars.
Gender Selection - Select the gender of the avatar.
Avatar Templates - Select the avatar template from the list.
Selfie Suggestion - Landing page for taking a selfie and using it to generate the avatar.
Take Selfie - Opens webcam and allows one to take a photo.
Avatar Editor - The Avatar editor, allows customization of the avatar.
The navigation panel contains the following buttons for the navigation between the scenes: Back, Save, Profile, and optional Close. Their visibility is automatically toggled depending on the state of the avatar creator.
For the child widgets to be able to communicate with the avatar creator, they use the NavigationSwitcher interface. Avatar creator implements the NavigationSwitcher interface allowing the child widgets to send events.
The preview actor is spawned in the world when the avatar creator widget is opened. It contains avatar mesh, lights, and a camera for rendering the avatar at runtime and displaying it in the avatar editor afterward. There is also a possibility to override the preview avatar by injecting a custom one. To do so, call the Override Preview Avatar function of the avatar creator.
The popups widgets are located in the Popups folder, they are needed to give the user information about the current status of the avatar creator.
Loading Screen - Blocker screen that opens while the resources for the avatar editor are being downloaded.
Warning View - Opens when a server request fails.
Preview Loading View - Toggles a popup while the avatar is being updated, after the outfit change.
Save View - Opens while the avatar is being saved on the server.
Signup View - Ready Player Me signup suggestion popup that opens after the avatar gets saved.
The editor widget contains several sub-widgets and handles the logic and UI of the avatar editing process.
AvatarRenderer Widget is a helper widget that creates and manages the render actor.
The editor contains scroll boxes that contain buttons for avatar customization.
Outfit Category ScrollBox - Contains buttons for different asset types - face, hairstyle, outfit, glasses, face mask, face wear, and headwear. Clicking the buttons will open the respective asset-type panel.
Outfit Assets ScrollBox - Contains asset buttons for the selected outfit asset type.
Face Category ScrollBox - Contains asset type panels for face - face shape, eyes, eyebrows, nose, mouth, beard, etc.
Face Assets Scrollbox - Contains asset buttons for the selected face asset type.
Editor buttons are included in custom widgets. While the category buttons are hardcoded inside of the editor, the asset and color buttons are added at runtime.
Category Button - For selecting an asset type. The thumbnail image is present on the path Content/Icons.
Asset Button - For selecting an asset with a thumbnail and a selection circle. The thumbnail image is fetched from the server.
Color Button - For selecting a color with a thumbnail and a selection circle.
Color ScrollBox - Eye color, Skin color, Hair color, etc.
Powered By Badge shows the brands of the asset providers for the outfits. It gets changed when the assets are changed.