ResizableComponent

fun create(
    session: Session,
    minimumSize: Dimensions = ResizableComponent.kMinimumSize,
    maximumSize: Dimensions = ResizableComponent.kMaximumSize
): ResizableComponent

Public factory function for creating a ResizableComponent. This component can be attached to a single instance of any non-Anchor Entity.

When attached, this Component will enable the user to resize the Entity by dragging along the boundaries of the interaction highlight.

fun addResizeListener(resizeListener: ResizeListener): Unit

Adds the listener to the set of listeners that are invoked through the resize operation, such as start, ongoing and end.

The listener is invoked on the main thread.

fun addResizeListener(executor: Executor, resizeListener: ResizeListener): Unit

Adds the listener to the set of listeners that are invoked through the resize operation, such as start, ongoing and end.

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

Attaches this component to the given entity.

open fun onDetach(entity: Entity): Unit

Detaches this component from the entity it is attached to.

fun removeResizeListener(resizeListener: ResizeListener): Unit

Removes a listener from the set listening to resize events.

var autoHideContent: Boolean

Whether the content of the entity (and all child entities) should be automatically hidden while it is being resized.

var autoUpdateSize: Boolean

Whether the size of the ResizableComponent should be automatically updated to match during an ongoing resize (to match the proposed size as resize events are received).

var fixedAspectRatio: Float

The aspect ratio of the entity during resizing. The aspect ratio is determined by taking the entity's width over its height. A value of 0.0f (or negative) means there are no preferences.

This method does not immediately resize the entity. The new aspect ratio will be applied the next time the user resizes the entity through the reform UI. During this resize operation, the entity's current area will be preserved.

If a different resizing behavior is desired, such as fixing the width and adjusting the height, the client can manually resize the entity to the preferred dimensions before calling this method. No automatic resizing will occur when using the reform UI then.

var forceShowResizeOverlay: Boolean

Whether the resize overlay should be shown even if the entity is not being resized.

This is useful for resizing multiple panels at once.

var maximumSize: Dimensions

An upper bound for the User's resize actions, in meters. This value constrains large the user can resize the bounding box of the entity. The size of the content inside that bounding box is fully controlled by the application.

var minimumSize: Dimensions

A lower bound for the User's resize actions, in meters. This value constrains how small the user can resize the bounding box of the entity. The size of the content inside that bounding box is fully controlled by the application.

var size: Dimensions

The current size of the entity, in meters. This property is automatically updated after resize events to match the resize affordance to the newly suggested size of the content. The apps can still override it. The default value is set to 1 meter, updated to the size of the entity when attached.