ResizableComponent

public final void addResizeEventListener(
    @NonNull Executor executor,
    @NonNull Consumer<@NonNull ResizeEvent> resizeEventListener
)

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.

public static final @NonNull ResizableComponent create(
    @NonNull Session session,
    @NonNull FloatSize3d minimumSize,
    @NonNull FloatSize3d maximumSize,
    @NonNull Executor executor,
    @NonNull Consumer<@NonNull ResizeEvent> resizeEventListener
)

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 AnchorEntity or to the ActivitySpace. Calling Entity.addComponent to an Entity with these types will return false.

public final @NonNull FloatSize3d getAffordanceSize()

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.

public final float getFixedAspectRatio()

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 provided in the Consumer the next time the user resizes the Entity through the reform UI.

public final @NonNull FloatSize3d getMaximumEntitySize()

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.

public final @NonNull FloatSize3d getMinimumEntitySize()

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.

public boolean onAttach(@NonNull Entity entity)

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.

public void onDetach(@NonNull Entity entity)

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.

public final void removeResizeEventListener(
    @NonNull Consumer<@NonNull ResizeEvent> resizeEventListener
)

Removes a listener from the set listening to resize events.

public final void setAffordanceSize(@NonNull FloatSize3d affordanceSize)

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.

public final void setFixedAspectRatio(float fixedAspectRatio)

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 provided in the Consumer the next time the user resizes the Entity through the reform UI.

public final void setMaximumEntitySize(@NonNull FloatSize3d maximumEntitySize)

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.

public final void setMinimumEntitySize(@NonNull FloatSize3d minimumEntitySize)

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.

public final void setShouldAlwaysShowOverlay(boolean shouldAlwaysShowOverlay)

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

This is useful for resizing multiple panels at once.

public final void setShouldAutoHideContent(boolean shouldAutoHideContent)

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

public final void setShouldAutoUpdateOverlay(boolean shouldAutoUpdateOverlay)

Whether the size of the resize overlay should be automatically updated to match the proposed size as resize events are received.

public final boolean shouldAlwaysShowOverlay()

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

This is useful for resizing multiple panels at once.

public final boolean shouldAutoHideContent()

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

public final boolean shouldAutoUpdateOverlay()

Whether the size of the resize overlay should be automatically updated to match the proposed size as resize events are received.