CurvedUI
  • 👋Getting Started
    • Compatibility
    • CurvedUI in a new Project
    • Setup for Steam VR SDK
    • Setup for Meta XR SDK
    • Setup for Unity XR SDK
    • Setup for other Platforms
  • 🔰Scripting API
    • CurvedUIInputModule
    • CurvedUISettings
    • CurvedUIRaycaster
  • ❓FAQ & Common Problems
  • 🐞Known Issues
  • 🗒️Changelog
  • 🙋Contact & Support
Powered by GitBook
On this page
  1. Scripting API

CurvedUISettings

Member Name
Summary

AddEffectToChildren

Adds the CurvedUIVertexEffect component to every child GameObject that requires it, creating the curving effect.

BlocksRaycasts

Gets or sets whether the canvas will block raycasts. Setting this to false will destroy the canvas' collider.

CanvasToCurvedCanvas

Converts a point in canvas space to a point on the curved surface in world space units.

CanvasToCurvedCanvasNormal

Returns a normal direction on the curved canvas for a given point on the flat canvas, working in canvas's local space.

Click

Sends OnClick event to every button under the pointer. Shortcut to CurvedUIRaycaster's Click method.

ControlMethod

Gets or sets the current controller mode, deciding how the user interacts with the canvas. Shortcut to CurvedUIInputModule's property.

GetObjectsHitByRay

Returns all canvas objects intersected by the given ray. Shortcut to CurvedUIInputModule's method.

GetObjectsUnderPointer

Returns all objects currently under the pointer. Shortcut to CurvedUIInputModule's method.

GetObjectsUnderScreenPos

Returns all canvas objects visible under the given screen position of EventCamera. Shortcut to CurvedUIInputModule's method.

Interactable

Gets or sets whether the canvas can be interacted with.

PointingAtCanvas

Returns true if the user's pointer is currently pointing inside this canvas. Shortcut to CurvedUIRaycaster's PointingAtCanvas bool.

PreserveAspect

Gets or sets whether CurvedUI should try to preserve the aspect ratio of the original canvas.

RaycastToCanvasSpace

Raycasts along the given ray and returns the intersection with the flat canvas. Converts from world space to flat canvas space.

RingExternalDiameter

Gets or sets the external diameter of the ring.

RingFlipVertical

Gets or sets whether the center of the ring should be at the bottom or top of the canvas.

SetAllChildrenDirty

Forces all child CurvedUI objects to recalculate. If recalculateCurveOnly is true, only recalculates the curve.

UseMeshCollider

Gets or sets whether the collider for this canvas should be created using more expensive box colliders. Default is false.

VertexPositionToCurvedCanvas

Maps a world space vector to a curved canvas, operating in the canvas's local space.

PreviousCurvedUIInputModuleNextCurvedUIRaycaster

Last updated 3 months ago

🔰