This site has been permanently archived. The content on this site was last updated in 2019.
Stay organized with collections
Save and categorize content based on your preferences.
GvrUIHelpers
Helper class for dealing with canvas UI.
Summary
Public static functions
|
GetMetersToCanvasScale(Transform canvasObject)
|
float
Finds the meters scale for the local coordinate system of the root canvas that contains the canvasObject passed in.
|
Public static functions
GetMetersToCanvasScale
float GetMetersToCanvasScale(
Transform canvasObject
)
Finds the meters scale for the local coordinate system of the root canvas that contains the canvasObject passed in.
| Details |
| Parameters |
canvasObject
|
The UI canvas object for which to find the scale.
|
|
|
Returns
|
The meters scale for the local coordinate system of the root UI canvas.
|
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003e\u003ccode\u003eGvrUIHelpers\u003c/code\u003e is a helper class designed to simplify interactions with canvas UI elements.\u003c/p\u003e\n"],["\u003cp\u003eIt offers a public static function, \u003ccode\u003eGetMetersToCanvasScale\u003c/code\u003e, which calculates the scale factor between meters and canvas units for a given UI object.\u003c/p\u003e\n"],["\u003cp\u003eThis function helps in translating real-world measurements to the canvas coordinate system.\u003c/p\u003e\n"]]],["The `GvrUIHelpers` class provides a utility function, `GetMetersToCanvasScale`, which calculates the meters scale for a given UI canvas object. It takes a `Transform` representing the canvas object as input and returns a `float` value. This value represents the meters scale for the root UI canvas's local coordinate system. This function is useful for determining the scale in meters for elements within the canvas.\n"],null,["# GvrUIHelpers Class Reference\n\nGvrUIHelpers\n============\n\nHelper class for dealing with canvas UI.\n\nSummary\n-------\n\n| ### Public static functions ||\n|-----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|\n| [GetMetersToCanvasScale](#classGvrUIHelpers_1af0ce491041b76178a1654335c7d0f618)`(Transform canvasObject)` | `float` Finds the meters scale for the local coordinate system of the root canvas that contains the canvasObject passed in. |\n\nPublic static functions\n-----------------------\n\n### GetMetersToCanvasScale\n\n```c#\nfloat GetMetersToCanvasScale(\n Transform canvasObject\n)\n``` \nFinds the meters scale for the local coordinate system of the root canvas that contains the canvasObject passed in.\n\n\u003cbr /\u003e\n\n| Details ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| Parameters | |----------------|---------------------------------------------------| | `canvasObject` | The UI canvas object for which to find the scale. | |\n| **Returns** | The meters scale for the local coordinate system of the root UI canvas. |"]]