API reference
API reference
Select your platform
No SDKs available
No versions available

CylinderShapeOptions Class

Modifiers: final
Shape options for a cylindrical panel.

Signature

data class CylinderShapeOptions(val radius: Float = 5.0f, val width: Float = 1.0f, val height: Float = 0.75f) : PanelConfigOptionsModifier, UIPanelShapeOptions, MediaPanelShapeOptions

Constructors

CylinderShapeOptions ( radius , width , height )
Signature
constructor(radius: Float = 5.0f, width: Float = 1.0f, height: Float = 0.75f)
Parameters
radius: Float
  Controls the curvature of the panel in meters. A smaller radius produces a more curved panel; a larger radius produces a flatter one.
width: Float
  The arc-length width of the panel in meters.
height: Float
  The height of the panel in meters. The angular extent of the cylinder is <code>width / radius</code> radians. The maximum supported angular extent is 360° (<code>2 * PI</code> radians). If <code>width / radius</code> exceeds <code>2 * PI</code>, the radius will be increased to <code>width / (2 * PI)</code> so the full panel width is preserved without exceeding 360°. Panels wider than 180° (i.e. where <code>radius < width / PI</code>) should not be used with horizontally scrollable content.

Properties

height : Float
[Get]
The height of the panel in meters.
The angular extent of the cylinder is <code>width / radius</code> radians. The maximum supported angular extent is 360° (<code>2 * PI</code> radians). If <code>width / radius</code> exceeds <code>2 * PI</code>, the radius will be increased to <code>width / (2 * PI)</code> so the full panel width is preserved without exceeding 360°. Panels wider than 180° (i.e. where <code>radius < width / PI</code>) should not be used with horizontally scrollable content.
Signature
val height: Float = 0.75f
radius : Float
[Get]
Controls the curvature of the panel in meters. A smaller radius produces a more curved panel; a larger radius produces a flatter one.
Signature
val radius: Float = 5.0f
width : Float
[Get]
The arc-length width of the panel in meters.
Signature
val width: Float = 1.0f

Functions

applyTo ( options )
Signature
open override fun applyTo(options: PanelConfigOptions)
Parameters
Did you find this page helpful?