ResizableComponent

fun create(
    session: Session,
    minimumSize: FloatSize3d = kMinimumSize,
    maximumSize: FloatSize3d = kMaximumSize,
    executor: Executor = HandlerExecutor.mainThreadExecutor,
    resizeEventListener: Consumer<ResizeEvent>
): ResizableComponent

Public factory function for creating a ResizableComponent.

This Component can be attached to a single instance of an Entity. When attached, this Component will enable the user to resize the Entity by dragging along the boundaries of a user-resize affordance.

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

fun addResizeEventListener(
    executor: Executor = HandlerExecutor.mainThreadExecutor,
    resizeEventListener: Consumer<ResizeEvent>
): 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 provided.

fun removeResizeEventListener(resizeEventListener: Consumer<ResizeEvent>): Unit

Removes a listener from the set listening to resize events.

protected open fun onAttach(entity: Entity): Boolean

Called by the framework when this component is being added to an Entity.

This method is triggered when Entity.addComponent is invoked. Implementations should override this method to perform setup logic or to validate if the component is compatible with the provided entity.

protected open fun onDetach(entity: Entity): Unit

Called by the framework when this component is being removed from an Entity.

This method is triggered when Entity.removeComponent is invoked. Implementations should override this method to release resources or undo any changes made during onAttach.

var affordanceSize: FloatSize3d

The current size of the affordance for 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. If attached to a PanelEntity, this is updated to the size of the Entity when attached.

var isAlwaysShowOverlayEnabled: Boolean

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

This is useful for resizing multiple panels at once.

var isAutoHideContentWhileResizingEnabled: Boolean

Whether the content of the Entity, and all child Entities, will be automatically hidden while it is being resized.

var isFixedAspectRatioEnabled: Boolean

Whether the aspect ratio is maintained during resizing.

If true the affordance will maintain its current aspect ratio being resized and all suggested sizes will maintain the current aspect ratio. This defaults to false.

var maximumEntitySize: FloatSize3d

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 minimumEntitySize: FloatSize3d

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.