LogoLogo
  • 📘Knowledge Center
  • Before Getting Started
    • 🔷3D User
    • 🔷AI User
    • 🔷Merchandiser
    • 🔷Web Developer
  • CREATOR INTERFACE
    • 🔷Creator Home Page
    • 🔷Canvas / Workspace
    • 🔷Export
  • Creator
    • 🔷Getting Started
      • 🔹Sign Up
        • 🔹How to Sign up Using Gmail?
        • 🔹How to Sign up Using Apple Id?
        • 🔹How to Sign up Using Email?
    • 🔷Creator Navigation
    • 🔷Projects
      • 🔷How to use the Quick Access Tools?
      • 🔷View Port Settings
      • 🔷Generate AI 3D Models
      • 🔷Object
        • 🔷Upload Object
        • 🔹Transform
        • 🔷Node Hierarchy
        • 🔷Material Change
      • 🔷Scene
      • 🔷Image
      • 🔷Video
      • 🔷Audio
      • 🔷HDRI
      • 🔹Light
      • 🔷Text
      • 🔷Camera
      • 🔷Animation Timeline
      • 🔷Export
      • 🔷3D/AR
    • 🔷Assets
    • 🔷Community Showcase
    • 🔷Upload Your Catalog
      • 🔷Download Template
      • 🔷Upload File
      • 🔷Upload 3D Model
        • 🔷Product Information
        • 🔷Additional Details
          • 🔹Color Variant
          • 🔹Interaction
          • 🔹Dimensions
        • 🔷Proceed to Preview
        • 🔷Supported Files Formats
    • 🔷User Management
    • 🔷My Profile
      • 🔹How to Seek Help?
      • 🔹About
      • 🔹How to Logout from Creator?
    • 🔷Guidelines For 3D Model Creation
  • IDE - Low Code
    • 🔷Getting Started
    • 🔷IDE Functions
      • 🔹Add Object to The Scene
      • 🔹Add Light to the Scene
      • 🔹Add Environment to the Scene
      • 🔹Add Background to the Scene
      • 🔹Add Room to the Scene
      • 🔹Add Text to the Scene
      • 🔹Add Image to the Scene
      • 🔹Show/Hide Object
      • 🔹Show/Hide Image
      • 🔹Add Scroll Break Points
      • 🔹Add Animation to the Scene
      • 🔹Add Model Transformation to the Scene
      • 🔹Add Animation Block to the Scene
      • 🔹Play GLB Animation (pre built in GLB file)
    • 🔷Examples and Tutorials:
  • Developer Documentation
    • 🛠️How to Integrate Avataar Experiences?
      • 🛠️Integration with Web Renderer (React Package)
      • 🛠️Integration with Web Renderer (Javascript Package)
      • 🛠️Integration with Android Renderer
      • 🛠️Integration with iOS Renderer
      • 🛠️Integration of Experiences via Creator (React Package)
      • 🛠️Integration of Experiences via Creator (Javascript Package)
  • Incarnate
    • 🔷Getting Started
      • 🔷Device Eligibility & Settings
      • 🔷How to Download 'Incarnate by Avataar'?
      • 🔷Sign Up
        • 🔹How to Sign Up Using Google?
        • 🔹How to Sign Up Using Apple ID?
        • 🔹How to Sign Up Using Email?
      • 🔷How to Setup The Ideal Environment for Capture?
    • 🔷A Guided Tour Through the App
      • 🔷How to Choose an Object to Scan?
      • 🔷How to Use the Hamburger Menu Button?
      • 🔷How to Use the Floor Detection Feature?
      • 🔷Bounding Box
        • 🔹How to Resize the Bounding Box?
        • 🔹How to Adjust the Bounding Box?
      • 🔷How to Capture the Object?
      • 🔷How to Upload the Captured Object?
      • 🔷How to Ensure a Good Capture?
  • Release Notes
    • Version 2.4
    • Version 2.3
    • Version 2.2
    • Version 2.1
    • Version 2.0
    • December 1, 2023
Powered by GitBook
On this page
  • Pre-requisites:
  • Installation :
  • Implementation :
  • Sample :
  1. Developer Documentation
  2. How to Integrate Avataar Experiences?

Integration with iOS Renderer

PreviousIntegration with Android RendererNextIntegration of Experiences via Creator (React Package)

Pre-requisites:

To integrate Avataar's renderer with your ios application, you will need the following equipment as a basic requirement:

  • Xcode - Apple's integrated development environment (IDE)

  • Ios version : 16 & above

  • Camera permission needs to be enabled

Installation :

Please follow the below steps to install the package in your ios application :

  • Add the following permission entry to your app's `Info.plist` file:

Key: `Privacy - Camera Usage Description`

Value: `$(PRODUCT_NAME) camera use`

  • Next , you need to go to “File” and click on “Add Package…”

  • Once the package is added, please search for the following URL and add the package by clicking on the ‘Add Package’ button at the bottom right corner.

  • The package will be added to your application.

  • As a next step, please import the `GeminiCastorFramework` module into your Swift file by adding the below code snippet.

import GeminiCastorFramework

  • You now have to access GeminiView which is exported from the GeminiCastorFramework. Create an instance of the Gemini Renderer by calling `GeminiView()`. The `GeminiView` initializer takes two parameters:

Your token (generated on Avataar Apollo/shared by Avataar)

Config URL (generated when publishing an asset in Avataar Apollo Configurator)

Implementation :

Please follow the below steps to integrate Avataar's renderer with your iOS application:

1. Create a “NavigationView” and wrap the ‘’NavigationLink’’ package inside it.

2. Set the navigation style to stack:

.navigationViewStyle(.stack) <Important>

3. Add the below parameters to the ‘’NavigationLink’’ in order to navigate to the GeminiView,

NavigationLink(

"",

destination: GeminiView(token: yourToken, configURL : yourConfigURL),

isActive: $isActive

)

4. To enable or disable the view, toggle the `isActive` variable. By default, please set the “isActive” variable to false to avoid triggering the view on onload of the application.

Sample :

Here’s a sample of implementing the Renderer integration post installing the package.

import SwiftUI

import GeminiCastorFramework

struct ContentView: View {

let dummyToken = "your_token"

let configName = "your_config_name"

@State private var isActive = false

var body: some View {

NavigationView {

NavigationLink("",destination: GeminiView(token: dummyToken, configURL: configName),

isActive: $isActive

)

}

.navigationViewStyle(.stack)

}

}

🛠️
🛠️
https://github.com/SoulVisionCreations/avataar-gemini-castor-package