ARgoPositionable

ARgoPositionable

Allows the display of 3D models snapped to the center of a device's screen. This special object requires the use of the argo-plugins module (libargoplugins.so). By default, an ARgoPositionable is disabled when first created.

Constructor

new ARgoPositionable(name, options, …models)

Creates an instance of ARgoPositionable that allows the display of 3D models snapped to the center of a device's screen.

Parameters:
Name Type Attributes Description
name string

A unique name for thie Positionable.
options ARgoPositionableOptions

Setup options for this positionable.
models <repeatable>
Source:

Properties

backgroundDrawableUniqueName

Gets the unique name used for the Background Drawable.

Source:

models :Map.<String, ARgoDrawableOptions>

The models to be positioned by this positionable.

Type:
Source:

showBackground :boolean

Adds a default background to the device's screen.

Type:
  • boolean
Source:

Methods

addModel(modelName, options)

Adds a model to be controlled by this positionable. Models can be loaded and unloaded at runtime.

Parameters:
Name Type Description
modelName string

Unique name for the model.
options ARgoDrawableOptions

Source and setup-Parameters for the model.
Source:
See:

closeAll()

Hides and unloads all models maintained and currently loaded by this Positionable.

Source:

closeModel(modelName)

Hides and unloads a model maintained and already loaded by this Positionable.

Parameters:
Name Type Description
modelName string

Unique name of loaded the model.
Source:

getLoadedModel(modelName) → {ARgoModel}

Parameters:
Name Type Description
modelName string
Source:
Returns:
Type
ARgoModel

hasLoadedModel(modelName)

Gets if a model with the specified unique name, is currently loaded by this Positionable.

Parameters:
Name Type Description
modelName string
Source:

hideModel(modelName, animateopt)

Hides a model maintained and already loaded by this Positionable.

Parameters:
Name Type Attributes Default Description
modelName string

Unique name of loaded the model.
animate boolean <optional>
 false
Source:

showModel(modelName, animateopt) → {boolean}

Shows a model maintained by this Positionable.

Parameters:
Name Type Attributes Default Description
modelName string

Unique name of the model.
animate boolean <optional>
 false
Source:
Returns:

Returns if the model is successfully loaded and shown.

Type
boolean