MovableComponent

fun createAnchorable(
    session: Session,
    anchorPlacement: Set<AnchorPlacement> = setOf(AnchorPlacement.createForPlanes()),
    disposeParentOnReAnchor: Boolean = true
): MovableComponent

Public factory function for creating a MovableComponent.

This Component can be attached to a single instance of an Entity. When attached, this Component will enable the user to translate the Entity by pointing and dragging on it.

When created with this function the MovableComponent will move and potentially Anchor the Entity. When anchored a new AnchorEntity will be created and set as the parent of the Entity. If the entity is moved off of a created AnchorEntity it will be reparented to the ActivitySpace. An EntityMoveListener can be attached to receive callbacks when the Entity is being moved and to see if it was reparented to an AnchorEntity.

This component cannot be attached to an AnchorEntity or to the ActivitySpace. Calling Entity.addComponent to an Entity with these types will return false.

fun createCustomMovable(
    session: Session,
    scaleInZ: Boolean,
    executor: Executor?,
    entityMoveListener: EntityMoveListener
): MovableComponent

Public factory function for creating a MovableComponent.

This Component can be attached to a single instance of an Entity. When attached, this Component will enable the user to translate the Entity by pointing and dragging on it.

When created with this function the MovableComponent will not move or rescale the Entity but it could be done using the EntityMoveListener.onMoveUpdate callback.

This component cannot be attached to an AnchorEntity or to the ActivitySpace. Calling Entity.addComponent to an Entity with these types will return false.

fun createSystemMovable(session: Session, scaleInZ: Boolean = true): MovableComponent

Public factory function for creating a MovableComponent.

This Component can be attached to a single instance of an Entity. When attached, this Component will enable the user to translate the Entity by pointing and dragging on it.

When created with this function the MovableComponent will move and rescale the Entity. EntityMoveListener can be attached to received callbacks when the Entity is being moved.

This component cannot be attached to an AnchorEntity or to the ActivitySpace. Calling Entity.addComponent to an Entity with these types will return false.

fun addMoveListener(entityMoveListener: EntityMoveListener): Unit

Adds a listener to the set of active listeners for the move events. The listener will be invoked regardless of whether the Entity is being moved by the system or the user.

The listener is invoked on the main thread.

fun addMoveListener(
    executor: Executor,
    entityMoveListener: EntityMoveListener
): Unit

Adds a listener to the set of active listeners for the move events. The listener will be invoked regardless of whether the Entity is being moved by the system or the user.

The listener is invoked on the provided Executor. If the app intends to modify the UI elements/views during the callback, the app should provide the thread executor that is appropriate for the UI operations. For example, if the app is using the main thread to render the UI, the app should provide the main thread (Looper.getMainLooper()) executor. If the app is using a separate thread to render the UI, the app should provide the executor for that thread.

open fun onAttach(entity: Entity): Boolean

Called by an Entity when it attempts to add this Component to itself.

This method is restricted because it is only called from Entity.addComponent.

open fun onDetach(entity: Entity): Unit

Called by an Entity when it attempts to detach this Component from itself.

This method is restricted because it is only called from Entity.removeComponent.

fun removeMoveListener(entityMoveListener: EntityMoveListener): Unit

Removes a listener from the set of active listeners for the move events.

var size: FloatSize3d

The size of the move affordance in meters. This property determines the size of the bounding box that is used to draw the draggable move affordances around the Entity. This property can be modified if the move affordance needs to be larger or smaller than the Entity itself.