ARgoModel

ARgoModel

A Model drawable represents an ARObject as a 3D Model. This subclass adds basic animation layouts' handling.

Constructor

new ARgoModel(optionsopt)

Creates an instance of an ARgoModel drawable that represents an ARObject as a 3D Model.

Parameters:
Name Type Attributes Description
options ARgoDrawableOptions <optional>

Source and setup parameters to customize additional object properties.
Source:

Extends

  • AR.Model

Properties

allowManipulation :boolean

Allows user manipulation when snapped on screen.

Type:
  • boolean
Source:

appearanceAnimation :ARgoAnimationGroup

An animation that initially shows or later hides the model.

Type:
Source:

canRotate

A callback that indicates if rotation is allowed during manipulation.

Source:

defaultLayout :ModelLayout

The default layout of the object in the AR environment. If the model is animated and you set this, you do not need to set the regular layout options.

Type:
Source:

isOnPresentation :boolean

Gets or sets if the model is currently in Presentation Mode.

Type:
  • boolean
Source:

manipulationData :ARgoObjectManipulationData

Initial manipulation data.

Type:
Source:

onAppearingComplete

Called when the model is shown and after any appearing animations have completed.

Source:

onCreateAppearingAnimation

Called when the model is about to be shown.

Source:

onCreateHidingAnimation

Called when the model is about to be hidden.

Source:

onCreatePresentationAnimation

Called when the model is about to go to presentation mode.

Source:

onCreateResetAnimation

Called when the model is about to resume from presentation mode.

Source:

onHidingComplete

Called when the model is shown and after any hiding animations have completed.

Source:

onPresentationComplete

Called when the model has entered Presentation Mode and after any animations have completed.

Source:

onResetComplete

Called when the model has exited Presentation Mode and after any animations have completed.

Source:

presentationAnimation :ARgoAnimationGroup

The animation that brings this model to and back from Presentation Mode.

Type:
Source:

presentationLayout :ModelLayout

The layout of the object when on presentation mode.

Type:
Source:

presentedModel :string

The name of the model presented in association to this model.

Type:
  • string
Source:

rootLayout :ModelLayout

The layout of the object at the beginning of a snapping animation (if any).

Type:
Source:

Methods

(static) createDefaultAnimation(model, layout)

Creates a default animation for animating from the current layout to another.

Parameters:
Name Type Description
model ARgoModel
layout ModelLayout
Source:

(static) getSafeLayout(layout) → {ModelLayout}

Gets a layout that has all members initialized.

Parameters:
Name Type Description
layout ModelLayout
Source:
Returns:

A ModelLayout instance that has all members initialized.

Type
ModelLayout

applyDefaultLayout()

Applies the defaultLayout to the model.

Source:

applyLayout(layout)

Applies a specified layout to the model.

Parameters:
Name Type Description
layout ModelLayout
Source:

applyPresentationLayout()

Applies the presentationLayout to the model.

Source:

applyRootLayout()

Applies the applyRootLayout to the model.

Source: