import Clickable from '@mobilizing/library/js/Mobilizing/renderer/3D/three/ui/Clickable.js'

public class |source

Clickable

Extends:

Component → Clickable

Constructor Summary

Public Constructor
public	constructor(params: Object) Makes a Mesh clickable

Member Summary

Public Members
public	camera: *
public	canvas: *
public	continuous: *
public	hovered: boolean
public	mesh: *
public	onEnter: *
public	onLeave: *
public	onPress: *
public	onRelease: *
public	picked: boolean
public	pointer: *

Method Summary

Public Methods
public	setup() Setup for this clickable instance

Inherited Summary

From class Component
public	active: boolean
public	context: *
public	events: *
public	id: *
public	name: *
private	_nexts: *[]
private	_setupDone: boolean
public	byPass()
public	chain(component: Component) Adds a component to this chained component array
public	getChainedComponents(): Array Returns the array of attached children components
public	off() Deactivate the component
public	on() Activate the component A call to this method calls the setup method if it has not been run yet
public	postUpdate() Run code after the update of all components is run This empty method is usually overriden to perform post-update actions for the component It is called periodically by an internal Mobilizing mechanism
public	preLoad() preLoad the component This empty method is usually overriden to perform preLoad actions for the component.
public	preUpdate() Run code before the update of all components is run This empty method is usually overriden to perform pre-update actions for the component It is called once per component by an internal Mobilizing mechanism
public	prepare() prepare the component This empty method is usually overriden to perform preparation actions for the component, from external process as a server.
public	setup() Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly
public	update() Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism

Public Constructors

public constructor(params: Object) source

Makes a Mesh clickable

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
params	Object		Parameters object, given by the constructor.
params.pointer	Pointer		a Pointer input object to use for the interaction. If none provided, a Pointer is created internally by this class, but it needs a canvas reference (i.e the canvas uses by the renderer)
params.camera	Camera		the camera used in the scene to compute the pick on the mesh
params.mesh	Mesh		the target mesh to make clickable
params.canvas	Canvas		the canvas to use for the Pointer input to work (i.e the canvas uses by the renderer)
params.continuous	Boolean		set the hover (enter) behavious continuous (i.e not only once on the mesh entering, but at each pointer's move)
params.onPress	onPress		onPress Handler
params.onRelease	onRelease		onRelease Handler
params.continuous	continuous		defines if the events triggered by this clickable should be conituous (every frame) or not (on event only)
params.onEnter	onEnter		Handler
params.onLeave	onLeave		Handler

Clickable

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(params: Object) source

Override:

Params:

Public Members

public camera: * source

public canvas: * source

public continuous: * source

public hovered: boolean source

public mesh: * source

public onEnter: * source

public onLeave: * source

public onPress: * source

public onRelease: * source

public picked: boolean source

public pointer: * source

Public Methods

public setup() source

Override: