Skip to main content

OrthogonalUtils

Utilities involving orthogonal Vector3s

Functions​

decomposeCFrameToVectors​

</>
OrthogonalUtils.decomposeCFrameToVectors(cframe: CFrame) → {Vector3}

Decompose the CFrame return { Vector3 }

getClosestVector​

</>
OrthogonalUtils.getClosestVector(
options: {Vector3},--

normals

unitVector: Vector3
) → Vector3?

Gets the closest vectors to another vector.

return Vector3?

snapCFrameTo​

</>
OrthogonalUtils.snapCFrameTo(
cframe: CFrame,
snapToCFrame: CFrame
) → CFrame

Snaps a CFrame to another one

return CFrame

Show raw api
{
    "functions": [
        {
            "name": "decomposeCFrameToVectors",
            "desc": "Decompose the CFrame\nreturn { Vector3 }",
            "params": [
                {
                    "name": "cframe",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ Vector3 }\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 14,
                "path": "src/geometryutils/src/Shared/OrthogonalUtils.lua"
            }
        },
        {
            "name": "getClosestVector",
            "desc": "Gets the closest vectors to another vector.\n\nreturn Vector3?",
            "params": [
                {
                    "name": "options",
                    "desc": "normals",
                    "lua_type": "{ Vector3 }"
                },
                {
                    "name": "unitVector",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 32,
                "path": "src/geometryutils/src/Shared/OrthogonalUtils.lua"
            }
        },
        {
            "name": "snapCFrameTo",
            "desc": "Snaps a CFrame to another one\n\nreturn CFrame",
            "params": [
                {
                    "name": "cframe",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "snapToCFrame",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 53,
                "path": "src/geometryutils/src/Shared/OrthogonalUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "OrthogonalUtils",
    "desc": "Utilities involving orthogonal Vector3s",
    "source": {
        "line": 6,
        "path": "src/geometryutils/src/Shared/OrthogonalUtils.lua"
    }
}