Namespace: GuiMarkerFactory

SKARF. GuiMarkerFactory

Factory that creates GuiMarkers
Source:

Methods

<static> create(type, options)

Function to create a SKARF.GuiMarker instance
Parameters:
Name Type Description
type string Type of GuiMarker to create: 'generic', 'button', 'checkbox', 'slider', 'combobox', 'timer'
options object Options
Properties
Name Type Description
key string Unique string ID that identifies this GUI marker. This name is used to search for callback functions related to this GUI marker.
name string Name for this GUI marker
markerId number ID of the AR marker
markerTransform THREE.Object3D A transform to hold this GUI marker
markerSize number Scale of the GUI marker
params object Additional parameters to customize this GUI marker
Source:

<static> register(mappingName, mappingClass)

Registers a type string to a class
Parameters:
Name Type Description
mappingName string Name of the mapping which is used to identify the type when creating instances e.g. 'threejs'
mappingClass SKARF.GuiMarker GuiMarker class that will be created when the associated type is used
Source: