Scene (advantage 2.6.1.0 API)

java.lang.Object
- com.digitalsunray.advantage.models.Scene

All Implemented Interfaces:

java.io.Serializable
```
public class Scene
extends java.lang.Object
implements java.io.Serializable
```
This class represents the AR SceneForm values. It can be used to show the 3D models on the AR view.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`auto` true', insert the pre-defined 3D model automatically on the plane (surface) otherwise 'false'.
`static java.lang.String`	`EXTRA_KEY`
`float`	`initialScale` Initial scale level of the given 3D model.
`java.lang.String`	`landingPageLink` A valid URL which will be used to show more information about the product.
`java.lang.String`	`logoUrl` Image URL which represents the company logo.
`float`	`maxScale` Maximum scale level of the given 3D model.
`float`	`minScale` Minimum scale level of the given 3D model.
`java.lang.String`	`modelUrl` A valid 3D model URL.
`java.lang.String`	`onboardingImageUrl` Image URL which represents the on-boarding and intro in the AR view.
`java.lang.String`	`onInsertFirstNodeTracking` A tracking URL which will be triggered as soon as we insert the first 3D model into the scene.
`java.lang.String`	`onLandingPageOpenTracking` A tracking URL which will be triggered when user taps on the landing page (more info) button.
`java.lang.String`	`onPermissionDeniedTracking` A tracking URL which will be triggered when required permission(s) is/are granted.
`java.lang.String`	`onPermissionGrantedTracking` A tracking URL which will be triggered when required permission(s) is/are granted.
`java.lang.String`	`onShareClickTracking` A tracking URL which will be triggered when user taps on the share (camera) button.
`java.lang.String`	`onStartTracking` A tracking URL which will be triggered when user opens the AR view.
`boolean`	`shareEnabled` 'true', show the camera (share) button, otherwise 'false'.
`boolean`	`singleEntry` 'true', only ONE node (3D model) is visible on the scene, otherwise 'false'.
`java.lang.String`	`sourceType` Represents the format of the given 3d Model.

Constructor Summary

Constructors
Constructor and Description

Scene(java.lang.String json)
Constructs a new instance of scene object with the given parameters.

Constructors
Constructor and Description
`Scene(java.lang.String json)` Constructs a new instance of scene object with the given parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.ar.sceneform.math.Vector3`	`getInitialScale()`
`java.lang.String`	`getLandingPageLink()`
`java.lang.String`	`getLogoUrl()`
`float`	`getMaxScale()`
`float`	`getMinScale()`
`android.net.Uri`	`getModelUrl()`
`java.lang.String`	`getOnboardingImageUrl()`
`java.lang.String`	`getOnInsertFirstNodeTracking()`
`java.lang.String`	`getOnLandingPageOpenTracking()`
`java.lang.String`	`getOnPermissionDeniedTracking()`
`java.lang.String`	`getOnPermissionGrantedTracking()`
`java.lang.String`	`getOnShareClickTracking()`
`java.lang.String`	`getOnStartTracking()`
`com.google.ar.sceneform.assets.RenderableSource.SourceType`	`getSourceType()`
`boolean`	`isAuto()`
`boolean`	`isShareEnabled()`
`boolean`	`isSingleEntry()`
`boolean`	`isValid()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTRA_KEY
```
public static java.lang.String EXTRA_KEY
```
  - modelUrl
```
public java.lang.String modelUrl
```
    A valid 3D model URL. at the moment we support the following 3D model formats: - GLTF V2 - GLB Note: the value of this attribute cannot be empty otherwise we should not launch the AR view!
  - sourceType
```
public java.lang.String sourceType
```
    Represents the format of the given 3d Model. We currently support the following 3D model formats: - GLTF2 - GLB Note: the value of this attribute cannot be empty otherwise we should not launch the AR view!
  - logoUrl
```
public java.lang.String logoUrl
```
    Image URL which represents the company logo. Note: we do not show the logo (top|left) on the AR view if the value of this attribute is empty!
  - onboardingImageUrl
```
public java.lang.String onboardingImageUrl
```
    Image URL which represents the on-boarding and intro in the AR view. Note: we do not show the on-boarding dialog on the AR view if the value of this attribute is empty!
  - landingPageLink
```
public java.lang.String landingPageLink
```
    A valid URL which will be used to show more information about the product. Note: we MUST hide the info button if the value of this attribute is empty!
  - minScale
```
public float minScale
```
    Minimum scale level of the given 3D model. Note: we do not use this attribute when the value is smaller or equals to 0!
  - maxScale
```
public float maxScale
```
    Maximum scale level of the given 3D model. Note: we do not use this attribute when the value is 0 or is smaller or equals to min_scale!
  - initialScale
```
public float initialScale
```
    Initial scale level of the given 3D model. Note: we do not use this attribute when the value is smaller or equals to 0!
  - auto
```
public boolean auto
```
    true', insert the pre-defined 3D model automatically on the plane (surface) otherwise 'false'. the default value is 'false'.
  - singleEntry
```
public boolean singleEntry
```
    'true', only ONE node (3D model) is visible on the scene, otherwise 'false'. the default value is 'false'. Note: in single entry mode users can still insert a new node to the surface, and we detach the latest node, if any!
  - shareEnabled
```
public boolean shareEnabled
```
    'true', show the camera (share) button, otherwise 'false'. the default value is 'false'.
  - onStartTracking
```
public java.lang.String onStartTracking
```
    A tracking URL which will be triggered when user opens the AR view.
  - onLandingPageOpenTracking
```
public java.lang.String onLandingPageOpenTracking
```
    A tracking URL which will be triggered when user taps on the landing page (more info) button.
  - onShareClickTracking
```
public java.lang.String onShareClickTracking
```
    A tracking URL which will be triggered when user taps on the share (camera) button.
  - onInsertFirstNodeTracking
```
public java.lang.String onInsertFirstNodeTracking
```
    A tracking URL which will be triggered as soon as we insert the first 3D model into the scene.
  - onPermissionGrantedTracking
```
public java.lang.String onPermissionGrantedTracking
```
    A tracking URL which will be triggered when required permission(s) is/are granted.
  - onPermissionDeniedTracking
```
public java.lang.String onPermissionDeniedTracking
```
    A tracking URL which will be triggered when required permission(s) is/are granted.
- Constructor Detail
  - Scene
```
public Scene(java.lang.String json)
```
    Constructs a new instance of scene object with the given parameters.
    
    Parameters:
    
    json - JSON string contains Scene values!
- Method Detail
  - isValid
```
public boolean isValid()
```
    Returns:
    
    true if the current model is valid to process. false otherwise.
  - getInitialScale
```
public com.google.ar.sceneform.math.Vector3 getInitialScale()
```
  - getMinScale
```
public float getMinScale()
```
  - getMaxScale
```
public float getMaxScale()
```
  - getLandingPageLink
```
@Nullable
public java.lang.String getLandingPageLink()
```
  - getLogoUrl
```
@Nullable
public java.lang.String getLogoUrl()
```
  - getOnboardingImageUrl
```
@Nullable
public java.lang.String getOnboardingImageUrl()
```
  - getModelUrl
```
public android.net.Uri getModelUrl()
```
  - getSourceType
```
@Nullable
public com.google.ar.sceneform.assets.RenderableSource.SourceType getSourceType()
```
  - isAuto
```
public boolean isAuto()
```
  - isSingleEntry
```
public boolean isSingleEntry()
```
  - isShareEnabled
```
public boolean isShareEnabled()
```
  - getOnStartTracking
```
@Nullable
public java.lang.String getOnStartTracking()
```
  - getOnInsertFirstNodeTracking
```
@Nullable
public java.lang.String getOnInsertFirstNodeTracking()
```
  - getOnLandingPageOpenTracking
```
@Nullable
public java.lang.String getOnLandingPageOpenTracking()
```
  - getOnShareClickTracking
```
@Nullable
public java.lang.String getOnShareClickTracking()
```
  - getOnPermissionDeniedTracking
```
@Nullable
public java.lang.String getOnPermissionDeniedTracking()
```
  - getOnPermissionGrantedTracking
```
@Nullable
public java.lang.String getOnPermissionGrantedTracking()
```

Class Scene

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTRA_KEY

modelUrl

sourceType

logoUrl

onboardingImageUrl

landingPageLink

minScale

maxScale

initialScale

auto

singleEntry

shareEnabled

onStartTracking

onLandingPageOpenTracking

onShareClickTracking

onInsertFirstNodeTracking

onPermissionGrantedTracking

onPermissionDeniedTracking

Constructor Detail

Scene

Method Detail

isValid

getInitialScale

getMinScale

getMaxScale

getLandingPageLink

getLogoUrl

getOnboardingImageUrl

getModelUrl

getSourceType

isAuto

isSingleEntry

isShareEnabled

getOnStartTracking

getOnInsertFirstNodeTracking

getOnLandingPageOpenTracking

getOnShareClickTracking

getOnPermissionDeniedTracking

getOnPermissionGrantedTracking