Enables moving the container frame.
ReadonlyapiGeneric object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.
Automatically scales child content when the frame is resized to maintain proportions.
When enabled, the frame automatically appears when hovered and hides when not being interacted with. Disable to manually control frame visibility.
Width of the border around the container.
Extra padding that maintains a fixed size in centimeters regardless of frame scaling, useful for toolbars and fixed-size UI elements
When enabled, creates a transparent center in the frame, allowing content behind the container to be visible.
If disabled, the Component will stop enacting its behavior.
event for callback on close button trigger
Size of the container's inner content area.
ReadonlyisReturns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.
Controls whether the container actively follows the user's view. Setting this defines the initial state.
event handler for frame scaling ended
public api for adding functions to the onScalingEnd event handler
event handler for frame scaling started
public api for adding functions to the onScalingStart event handler
public api for adding functions to the onScalingUpdate event handler
public api for adding functions to the onSnappingComplete event handler
public api for adding functions to the onTranslationEndEvent event handler
public api for adding functions to the onTranslationStartEvent event handler
reference to HoverBehavior on parent element
When enabled, Z-axis scaling of content will match X-axis scaling during frame resizing.
ReadonlysceneThe SceneObject this component is on.
reference to frame's default front follow behavior
Readonlyuniquereference to world camera
alpha of the dark backing effect of the frame
sets alpha of the dark backing effect of the frame
alpha of the glass border of the frame
sets alpha of the glass border of the frame
returns if center is cutout
ContainerFrame frame sceneObject
current opacity of frame elements
sets opacity for all frame elements
note this parameter is effected by calls to showVisual and hideVisual
current renderOrder for the renderMeshVisual of the frame itself
sets renderOrder for the renderMeshVisual of the frame itself
vec2 of the total size of the container, including constant padding
abort snapping behavior
Adds a new SceneEvent, triggered by eventType events, to the ScriptComponent.
Destroys the component.
set close button enabled or disabled
set follow button enabled or disabled
enable or disable interactable elements of the frame
returns the frame sceneobject
frame's Interactable
frame's InteractableManipulation
current local position of frame
current local rotation of frame
frame's parent's Interactable
parent transform of top container object
Returns the SceneObject the component is attached to.
inner object which contains original children
Returns the Transform this component is attached to.
StaticgetReturns the name of this object's type.
Gets current world position of frame
current world rotation of frame
tween to hide visuals of frame and elementss
Returns true if the object matches or derives from the passed in type.
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
whether the snapping behavior is checking for snappable elements
whether the snapping behavior is currently tweening
function for fully destroying the frame
Removes a previously added SceneEvent from the ScriptComponent.
enable or disable user scaling
setup billboarding component with the following parameters
set diameter of buttons in centimeters
sets opacity of frame when hovering interactable content in the frame
set if content is interactable
enable or disable the following button and defualt behavior ( if it is enabled )
turns on or off snappableBehavior
sets current local position of frame
set current local rotation of frame
set maximum scale of frame
set minimum scale of frame
whether or not to activate snapping
enable or disable the option to turn on the default follow behavior with the follow button
sets current world position of frame
sets current local position of frame
tween to show visuals of frame and elements
tween from current opacity to target opacity, will cancel existing opacity tweens
This class represents a container frame that can hold and manage UI elements. It provides settings for auto show/hide, inner size, border, constant padding, and scaling. The class uses prefabs for the frame and labeled buttons, and textures for icons.
Deprecated
in favor of using SpectaclesUIKit's Frame component. See https://developers.snap.com/spectacles/spectacles-frameworks/spectacles-ui-kit/get-started for more details.