# API Reference

    # IOS

    # ARViewer

    Load the 3D model into the Activity’s ARFragment.
    Supports configuration of the ARFragment.

    # Constructor

    # new ARViewer( Context context )

    Create Instance for ARViewer.

    • Parameters
      • context Context
    • Return
      ARViewer instance
    • Example



    # Method

    # createScene( @IdRes int registryId )

    Create Scene.

    • Parameters
      • registryId @IdRes int
    • Return
      ARSceneView instance
    • Example

    # loadRenderable( String url )

    Load the product.

    • Parameters
      • url String
        The address is where the sfb file is located.
    • Return
      ModelRenderable instance
      Returns ‘null’ if the load fails.
    • Example

    # getFigures()

    Gets imported models.

    • Return
      ArrayList<Figure>
    • Example

    # changeLight( LightDirection lightDirection, int color )

    Set light direction and lighting color.
    Can use LightDirection and Color to set the lighting,
    and can set the desired orientation in the form of an enum for those who are not familiar with the vector.

    • Parameters
      • lightDirection LightDirection
        The direction of light. Set to ARViewer.LightDirection.
      • color int
        The color of light. Can be set to android.Graphics.Color.
    • Example

    # changeLight( Vector3 vector3, int color )

    Set light direction and lighting color.
    Can set the lighting using Vector3 and Color.
    Can set the detail direction of fine light using the Vector3 value

    • Parameters
      • vector3 Vector3
        The direction of light. Can be set by using Vector3.
      • color int
        The color of light. Can be set by using android.Graphics.Color.
    • Example

    # takeScreenshot()

    Take Screenshot.

    • Return
      Bitmap instance
    • Example

    # changeGuideImage( Drawable drawable )

    Change the guide image.

    • Parameters
      • drawable Drawable
        Image to change. Can be set to Drawable type.
    • Example

    # changeVertexColor( int color )

    Change the color of the bottom point.

    • Parameters
      • color int
        The color of the scanned floor point. Can be set by using android.Graphics.Color.
    • Example

    # changeVertexColor( float r, float g, float b )

    Change the color of the bottom point.

    • Parameters
      • r float
        Color of the scanned floor point. ‘red’ value of ‘RGB’.
      • g float
        Color of the scanned floor point. ‘green’ value of RGB.
      • b float
        Color of the scanned floor point. ‘blue’ value of RGB.
    • Example










    # Figure

    3D model Class. Can manipulate the instantiated model.

    # Method

    # detach()

    Delete the imported model.

    • Example

    # changeMetallic( float metallicFactor )

    Change the Metallic factor of the model.

    • Parameters
      • metallicFactor float
        The metallic factor value. ( 0 ~ 1 )
    • Example

    # changeRoughness( float roughnessFactor )

    Change the model’s Roughness factor.

    • Parameters
      • roughnessFactor float
        The Roughness factor value. ( 0 ~ 1 )
    • Example

    # setZoomable( boolean zoomable )

    Expansion of the model using pinch gestures / Set whether to downsize or not.

    • Parameters
      • zoomable boolean
        Specify whether the zoom function is enabled.
    • Example

    # Android

    # ARViewer

    Load the 3D model into the Activity’s ARFragment.
    Supports configuration of the ARFragment.

    # Constructor

    # new ARViewer( Context context )

    Create Instance for ARViewer.

    • Parameters
      • context Context
    • Return
      ARViewer instance
    • Example



    # Method

    # createScene( @IdRes int registryId )

    Create Scene.

    • Parameters
      • registryId @IdRes int
    • Return
      ARSceneView instance
    • Example

    # loadRenderable( String url )

    Load the product.

    • Parameters
      • url String
        The address is where the sfb file is located.
    • Return
      ModelRenderable instance
      Returns ‘null’ if the load fails.
    • Example

    # getFigures()

    Gets imported models.

    • Return
      ArrayList<Figure>
    • Example

    # changeLight( LightDirection lightDirection, int color )

    Set light direction and lighting color.
    Can use LightDirection and Color to set the lighting,
    and can set the desired orientation in the form of an enum for those who are not familiar with the vector.

    • Parameters
      • lightDirection LightDirection
        The direction of light. Set to ARViewer.LightDirection.
      • color int
        The color of light. Can be set to android.Graphics.Color.
    • Example

    # changeLight( Vector3 vector3, int color )

    Set light direction and lighting color.
    Can set the lighting using Vector3 and Color.
    Can set the detail direction of fine light using the Vector3 value

    • Parameters
      • vector3 Vector3
        The direction of light. Can be set by using Vector3.
      • color int
        The color of light. Can be set by using android.Graphics.Color.
    • Example

    # takeScreenshot()

    Take Screenshot.

    • Return
      Bitmap instance
    • Example

    # changeGuideImage( Drawable drawable )

    Change the guide image.

    • Parameters
      • drawable Drawable
        Image to change. Can be set to Drawable type.
    • Example

    # changeVertexColor( int color )

    Change the color of the bottom point.

    • Parameters
      • color int
        The color of the scanned floor point. Can be set by using android.Graphics.Color.
    • Example

    # changeVertexColor( float r, float g, float b )

    Change the color of the bottom point.

    • Parameters
      • r float
        Color of the scanned floor point. ‘red’ value of ‘RGB’.
      • g float
        Color of the scanned floor point. ‘green’ value of RGB.
      • b float
        Color of the scanned floor point. ‘blue’ value of RGB.
    • Example










    # Figure

    3D model Class. Can manipulate the instantiated model.

    # Method

    # detach()

    Delete the imported model.

    • Example

    # changeMetallic( float metallicFactor )

    Change the Metallic factor of the model.

    • Parameters
      • metallicFactor float
        The metallic factor value. ( 0 ~ 1 )
    • Example

    # changeRoughness( float roughnessFactor )

    Change the model’s Roughness factor.

    • Parameters
      • roughnessFactor float
        The Roughness factor value. ( 0 ~ 1 )
    • Example

    # setZoomable( boolean zoomable )

    Expansion of the model using pinch gestures / Set whether to downsize or not.

    • Parameters
      • zoomable boolean
        Specify whether the zoom function is enabled.
    • Example
    top button