Class: Col
Defined in: src/ui/layouts/Col.ts:12
A fundamental UI component for creating interactive user interfaces. It serves as a base class for other UI elements like Panels, Rows, and Columns, providing core layout logic, visibility control, and interaction hooks.
Each View is a THREE.Object3D and inherits lifecycle methods from
Script.
Extends
Constructors
Constructor
new Col(
options):Col
Defined in: src/ui/layouts/Col.ts:13
Parameters
options
ColOptions = {}
Returns
Col
Overrides
Properties
aspectRatio
aspectRatio:
number=1.0
Defined in: src/ui/core/View.ts:72
The calculated aspect ratio (width / height) of this view.
Inherited from
cols
cols:
number=0
Defined in: src/ui/layouts/Grid.ts:54
Inherited from
colWeight
colWeight:
number=0
Defined in: src/ui/layouts/Grid.ts:42
The weight of the current columns in the grid.
Inherited from
height
height:
number=1
Defined in: src/ui/core/View.ts:42
The height of the view, as a 0-1 ratio of its parent's available space.
Inherited from
isQuad
isQuad:
boolean=true
Defined in: src/ui/core/View.ts:27
Flag indicating View behaves as a 2D quad in layout calculations.
Inherited from
isRoot
isRoot:
boolean=false
Defined in: src/ui/core/View.ts:29
Flag indicating if this is the root view of a layout.
Inherited from
isView
isView:
boolean=true
Defined in: src/ui/core/View.ts:31
Type identifier for easy checking with instanceof.
Inherited from
isXRScript
isXRScript:
boolean=true
Defined in: src/core/Script.ts:53
Inherited from
leftWeight
leftWeight:
number=0
Defined in: src/ui/layouts/Grid.ts:47
The summed weight to the left of the grid.
Inherited from
mesh?
optionalmesh:Mesh<BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>,Material|Material[],Object3DEventMap>
Defined in: src/ui/core/View.ts:70
The underlying THREE.Mesh if the view has a visible geometry.
Inherited from
name
name:
string='View'
Defined in: src/ui/core/View.ts:25
Text description of the view
Inherited from
opacity
opacity:
number=1.0
Defined in: src/ui/core/View.ts:68
The overall opacity of the view and its children.
Inherited from
paddingX
paddingX:
number=0
Defined in: src/ui/core/View.ts:59
Horizontal padding, as a 0-1 ratio of the parent's width.
Inherited from
paddingY
paddingY:
number=0
Defined in: src/ui/core/View.ts:61
Vertical padding, as a 0-1 ratio of the parent's height.
Inherited from
paddingZ
paddingZ:
number=0
Defined in: src/ui/core/View.ts:63
Depth padding, for z-axis adjustment to prevent z-fighting.
Inherited from
rows
rows:
number=0
Defined in: src/ui/layouts/Grid.ts:55
Inherited from
rowWeight
rowWeight:
number=0
Defined in: src/ui/layouts/Grid.ts:37
The weight of the current rows in the grid.
Inherited from
selectable
selectable:
boolean=true
Defined in: src/ui/core/View.ts:33
Determines if this view can be targeted by user input.
Inherited from
topWeight
topWeight:
number=0
Defined in: src/ui/layouts/Grid.ts:52
The summed weight to the top of the grid.
Inherited from
ux
ux:
UX
Defined in: src/core/Script.ts:52
Inherited from
weight
weight:
number=0.5
Defined in: src/ui/core/View.ts:38
Proportional size used in layouts like Row or Col.
Inherited from
width
width:
number=1
Defined in: src/ui/core/View.ts:40
The width of the view, as a 0-1 ratio of its parent's available space.
Inherited from
x
x:
number=0
Defined in: src/ui/core/View.ts:47
The local x-coordinate within the parent's layout, from -0.5 to 0.5. For root view (Panel), this will be addition to the global positioning.
Inherited from
y
y:
number=0
Defined in: src/ui/core/View.ts:52
The local y-coordinate within the parent's layout, from -0.5 to 0.5. For root view (Panel), this will be addition to the global positioning.
Inherited from
z
z:
number=0
Defined in: src/ui/core/View.ts:57
The local z-coordinate within the parent's layout. For root view (Panel), this will be addition to the global positioning.
Inherited from
ColClass
staticColClass: typeofCol
Defined in: src/ui/layouts/Grid.ts:30
Inherited from
OrbiterClass
staticOrbiterClass: typeofOrbiter
Defined in: src/ui/layouts/Grid.ts:32
Inherited from
PanelClass
staticPanelClass: typeofPanel
Defined in: src/ui/layouts/Grid.ts:31
Inherited from
RowClass
staticRowClass: typeofRow
Defined in: src/ui/layouts/Grid.ts:29
Inherited from
Accessors
rangeX
Get Signature
get rangeX():
number
Defined in: src/ui/core/View.ts:79
Gets the effective horizontal range for child elements, normalized to 1.0 for the smaller dimension.
Returns
number
The horizontal layout range.
Inherited from
rangeY
Get Signature
get rangeY():
number
Defined in: src/ui/core/View.ts:88
Gets the effective vertical range for child elements, normalized to 1.0 for the smaller dimension.
Returns
number
The vertical layout range.
Inherited from
Methods
add()
add(...
children):Col
Defined in: src/ui/core/View.ts:215
Overrides THREE.Object3D.add to automatically trigger a layout update
when a new View is added as a child.
Parameters
children
...Object3D<Object3DEventMap>[]
Returns
Col
Inherited from
addCol()
addCol(
options):Col
Defined in: src/ui/layouts/Grid.ts:166
Adds a column to the grid.
Parameters
options
ColOptions = {}
The options for the column.
Returns
Col
The added column.
Inherited from
addExitButton()
addExitButton(
options):ExitButton
Defined in: src/ui/layouts/Grid.ts:127
Parameters
options
IconButtonOptions = {}
Returns
Inherited from
addIcon()
addIcon(
options):IconView
Defined in: src/ui/layouts/Grid.ts:103
Parameters
options
IconButtonOptions = {}
Returns
Inherited from
addIconButton()
addIconButton(
options):IconButton
Defined in: src/ui/layouts/Grid.ts:91
Parameters
options
IconButtonOptions = {}
Returns
Inherited from
addImage()
addImage(
options):ImageView
Defined in: src/ui/layouts/Grid.ts:79
Adds an image to the grid.
Parameters
options
The options for the image.
Returns
The added image view.
Inherited from
addLabel()
addLabel(
options):LabelView
Defined in: src/ui/layouts/Grid.ts:115
Parameters
options
object
Returns
Inherited from
addOrbiter()
addOrbiter(
options):Orbiter
Defined in: src/ui/layouts/Grid.ts:121
Parameters
options
GridOptions = {}
Returns
Orbiter
Inherited from
addPanel()
addPanel(
options):Panel
Defined in: src/ui/layouts/Grid.ts:138
Adds a panel to the grid.
Parameters
options
PanelOptions = {}
The options for the panel.
Returns
The added panel.
Inherited from
addRow()
addRow(
options):Row
Defined in: src/ui/layouts/Grid.ts:150
Adds a row to the grid.
Parameters
options
RowOptions = {}
The options for the row.
Returns
The added row.
Inherited from
addText()
addText(
options):TextView
Defined in: src/ui/layouts/Grid.ts:109
Parameters
options
TextViewOptions = {}
Returns
Inherited from
addTextButton()
addTextButton(
options):TextButton
Defined in: src/ui/layouts/Grid.ts:97
Parameters
options
TextButtonOptions = {}
Returns
Inherited from
addVideo()
addVideo(
options):VideoView
Defined in: src/ui/layouts/Grid.ts:85
Parameters
options
Returns
Inherited from
dispose()
dispose():
void
Defined in: src/core/Script.ts:196
Called when the script is removed from the scene. Opposite of init.
Returns
void
Inherited from
dpToLocalUnits()
dpToLocalUnits(
dp):number
Defined in: src/ui/core/View.ts:123
Converts a value from Density-Independent Pixels (DP) to local units.
Parameters
dp
number
The value in density-independent pixels.
Returns
number
The equivalent value in local units.
Inherited from
hide()
hide():
void
Defined in: src/ui/core/View.ts:137
Makes the view and all its descendants invisible.
Returns
void
Inherited from
init()
init(
_?):void|Promise<void>
Defined in: src/core/Script.ts:62
Initializes an instance with XR controllers, grips, hands, raycaster, and default options. We allow all scripts to quickly access its user (e.g., user.isSelecting(), user.hands), world (e.g., physical depth mesh, lighting estimation, and recognized objects), and scene (the root of three.js's scene graph). If this returns a promise, we will wait for it.
Parameters
_?
object
Returns
void | Promise<void>
Inherited from
initPhysics()
initPhysics(
_physics):void|Promise<void>
Defined in: src/core/Script.ts:72
Enables depth-aware interactions with physics. See /demos/ballpit
Parameters
_physics
Returns
void | Promise<void>
Inherited from
onHoverEnter()
onHoverEnter(
_controller):void
Defined in: src/core/Script.ts:157
Called when the controller starts hovering over this object with reticle.
Parameters
_controller
An XR controller.
Returns
void
Inherited from
onHoverExit()
onHoverExit(
_controller):void
Defined in: src/core/Script.ts:162
Called when the controller hovers over this object with reticle.
Parameters
_controller
An XR controller.
Returns
void
Inherited from
onHovering()
onHovering(
_controller):void
Defined in: src/core/Script.ts:167
Called when the controller hovers over this object with reticle.
Parameters
_controller
An XR controller.
Returns
void
Inherited from
onKeyDown()
onKeyDown(
_event):void
Defined in: src/core/Script.ts:109
Called on keyboard keypress.
Parameters
_event
Event containing .code to read the keyboard key.
Returns
void
Inherited from
onKeyUp()
onKeyUp(
_event):void
Defined in: src/core/Script.ts:110
Parameters
_event
Returns
void
Inherited from
onObjectGrabbing()
onObjectGrabbing(
_event):void
Defined in: src/core/Script.ts:187
Called every frame a hand is grabbing this object.
Parameters
_event
Returns
void
Inherited from
onObjectGrabEnd()
onObjectGrabEnd(
_event):void
Defined in: src/core/Script.ts:191
Called when a hand stops grabbing this object.
Parameters
_event
Returns
void
Inherited from
onObjectGrabStart()
onObjectGrabStart(
_event):void
Defined in: src/core/Script.ts:183
Called when a hand starts grabbing this object (touching + pinching).
Parameters
_event
Returns
void
Inherited from
onObjectSelectEnd()
onObjectSelectEnd(
_event):boolean
Defined in: src/core/Script.ts:150
Called when the controller stops selecting this object the script represents, e.g. View, ModelView.
Parameters
_event
event.target holds its controller.
Returns
boolean
Whether the event was handled
Inherited from
onObjectSelectStart()
onObjectSelectStart(
_event):boolean
Defined in: src/core/Script.ts:141
Called when the controller starts selecting this object the script represents, e.g. View, ModelView.
Parameters
_event
event.target holds its controller.
Returns
boolean
Whether the event was handled
Inherited from
onObjectTouchEnd()
onObjectTouchEnd(
_event):void
Defined in: src/core/Script.ts:179
Called when a hand's index finger stops touching this object.
Parameters
_event
Returns
void
Inherited from
onObjectTouching()
onObjectTouching(
_event):void
Defined in: src/core/Script.ts:175
Called every frame that a hand's index finger is touching this object.
Parameters
_event
Returns
void
Inherited from
onObjectTouchStart()
onObjectTouchStart(
_event):void
Defined in: src/core/Script.ts:171
Called when a hand's index finger starts touching this object.
Parameters
_event
Returns
void
Inherited from
onSelect()
onSelect(
_event):void
Defined in: src/core/Script.ts:98
Called whenever pinch / mouse click successfully completes, globally.
Parameters
_event
event.target holds its controller.
Returns
void
Inherited from
onSelectEnd()
onSelectEnd(
_event):void
Defined in: src/core/Script.ts:92
Called whenever pinch / mouse click discontinues, globally.
Parameters
_event
event.target holds its controller
Returns
void
Inherited from
onSelecting()
onSelecting(
_event):void
Defined in: src/core/Script.ts:103
Called whenever pinch / mouse click is happening, globally.
Parameters
_event
Returns
void
Inherited from
onSelectStart()
onSelectStart(
_event):void
Defined in: src/core/Script.ts:86
Called whenever pinch / mouse click starts, globally.
Parameters
_event
event.target holds its controller
Returns
void
Inherited from
onSimulatorStarted()
onSimulatorStarted():
void
Defined in: src/core/Script.ts:78
Returns
void
Inherited from
onSqueeze()
onSqueeze(
_event):void
Defined in: src/core/Script.ts:132
Called whenever gamepad trigger successfully completes, globally.
Parameters
_event
event.target holds its controller.
Returns
void
Inherited from
onSqueezeEnd()
onSqueezeEnd(
_event):void
Defined in: src/core/Script.ts:121
Called whenever gamepad trigger stops, globally.
Parameters
_event
event.target holds its controller.
Returns
void
Inherited from
onSqueezeStart()
onSqueezeStart(
_event):void
Defined in: src/core/Script.ts:116
Called whenever gamepad trigger starts, globally.
Parameters
_event
event.target holds its controller.
Returns
void
Inherited from
onSqueezing()
onSqueezing(
_event):void
Defined in: src/core/Script.ts:126
Called whenever gamepad is being triggered, globally.
Parameters
_event
Returns
void
Inherited from
onTriggered()
onTriggered(
_id):void
Defined in: src/ui/core/View.ts:230
Hook called on a complete select action (e.g., a click) when this view is the target. Intended for override by subclasses.
Parameters
_id
number
The ID of the controller that triggered the action.
Returns
void
Inherited from
onXRSessionEnded()
onXRSessionEnded():
void
Defined in: src/core/Script.ts:76
Returns
void
Inherited from
onXRSessionStarted()
onXRSessionStarted(
_session?):void
Defined in: src/core/Script.ts:75
Parameters
_session?
Returns
void
Inherited from
physicsStep()
physicsStep():
void
Defined in: src/core/Script.ts:73
Returns
void
Inherited from
resetLayout()
resetLayout():
void
Defined in: src/ui/layouts/Grid.ts:189
Initializes the layout of the grid with compose().
Returns
void
Inherited from
resetLayouts()
resetLayouts():
void
Defined in: src/ui/core/View.ts:198
Resets the layout state for this view and all its descendants.
Returns
void
Inherited from
show()
show():
void
Defined in: src/ui/core/View.ts:129
Makes the view and all its descendants visible.
Returns
void
Inherited from
update()
update(
_time?,_frame?):void
Defined in: src/core/Script.ts:67
Runs per frame.
Parameters
_time?
number
_frame?
Returns
void
Inherited from
updateLayout()
updateLayout():
void
Defined in: src/ui/layouts/Grid.ts:180
Updates the layout of the grid.
Returns
void
Inherited from
updateLayouts()
updateLayouts():
void
Defined in: src/ui/core/View.ts:171
Triggers a layout update for this view and all its descendants.
Returns
void
Inherited from
updateLayoutsBFS()
updateLayoutsBFS():
void
Defined in: src/ui/core/View.ts:179
Performs a Breadth-First Search (BFS) traversal to update the layout tree, ensuring parent layouts are calculated before their children.
Returns
void
Inherited from
dpToMeters()
staticdpToMeters(dp):number
Defined in: src/ui/core/View.ts:114
Converts a value from Density-Independent Pixels (DP) to meters.
Parameters
dp
number
The value in density-independent pixels.
Returns
number
The equivalent value in meters.
Inherited from
init()
staticinit(RowClass,ColClass,PanelClass,OrbiterClass):void
Defined in: src/ui/layouts/Grid.ts:65
Initializes the Grid class with the provided Row, Col, and Panel classes.
Parameters
RowClass
typeof Row
The class for rows.
ColClass
typeof Col
The class for columns.
PanelClass
typeof Panel
The class for panels.
OrbiterClass
typeof Orbiter
The class for panels.
Returns
void