docs.unity3d.com
Version: 

    Class GeomInterface

    Inheritance
    object
    Interface
    GeomInterface
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Pixyz.Geom
    Syntax
    public class GeomInterface : Interface

    Fields

    IdentityMatrix4

    Declaration
    public static readonly Matrix4 IdentityMatrix4
    Field Value
    Type Description
    Matrix4

    XupToYupMatrix4

    Declaration
    public static readonly Matrix4 XupToYupMatrix4
    Field Value
    Type Description
    Matrix4

    YupToZupMatrix4

    Declaration
    public static readonly Matrix4 YupToZupMatrix4
    Field Value
    Type Description
    Matrix4

    ZupToYupMatrix4

    Declaration
    public static readonly Matrix4 ZupToYupMatrix4
    Field Value
    Type Description
    Matrix4

    Methods

    ApplyTransform(uint, Matrix4)

    Apply a transformation matrix to a geometrical entity

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public void ApplyTransform(uint entity, Matrix4 matrix)
    Parameters
    Type Name Description
    uint entity

    The geometric entity

    Matrix4 matrix

    The transformation matrix

    ChangeOfBasisMatrix(Point3, Point3, Point3, Point3)

    Construct a Change of Basis Matrix (e.g multiplying the point [0,0,0] will result to the point origin)

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 ChangeOfBasisMatrix(Point3 origin, Point3 x, Point3 y, Point3 z)
    Parameters
    Type Name Description
    Point3 origin

    Origin of the new basis

    Point3 x

    X axis of the new basis

    Point3 y

    Y axis of the new basis

    Point3 z

    Z axis of the new basis

    Returns
    Type Description
    Matrix4

    ConfigureFunctionLogger(string, bool, bool, bool)

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public void ConfigureFunctionLogger(string functionName, bool enableFunction, bool enableParameters, bool enableExecutionTime)
    Parameters
    Type Name Description
    string functionName
    bool enableFunction
    bool enableParameters
    bool enableExecutionTime

    FromAffine(Affine)

    Create a Matrix from an Affine

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 FromAffine(Affine affine)
    Parameters
    Type Name Description
    Affine affine

    The affine

    Returns
    Type Description
    Matrix4

    FromLookAtMatrix(Matrix4, double)

    Get camera position, up and target vectors

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public FromLookAtMatrixReturn FromLookAtMatrix(Matrix4 matrix, double distanceFromTarget = 1)
    Parameters
    Type Name Description
    Matrix4 matrix

    The created Matrix

    double distanceFromTarget
    Returns
    Type Description
    FromLookAtMatrixReturn

    FromOriginNormal(Point3, Point3)

    Create a Matrix from an origin and a normal vector

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 FromOriginNormal(Point3 origin, Point3 normal)
    Parameters
    Type Name Description
    Point3 origin

    The origin point

    Point3 normal

    The normal vector

    Returns
    Type Description
    Matrix4

    FromTRS(Point3, Point3, Point3)

    Create a Matrix from translation, rotation and scaling vectors

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 FromTRS(Point3 T, Point3 R, Point3 S)
    Parameters
    Type Name Description
    Point3 T

    The translation vector

    Point3 R

    The rotations vector

    Point3 S

    The scaling vector

    Returns
    Type Description
    Matrix4

    GetEntityAABB(uint)

    Retrieve the Axis-Aligned Bounded Box of a geometric entity

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public AABB GetEntityAABB(uint entity)
    Parameters
    Type Name Description
    uint entity

    The geometric entity

    Returns
    Type Description
    AABB

    GetLastError()

    Declaration
    public static string GetLastError()
    Returns
    Type Description
    string

    GetMaxScale(Matrix4)

    Get maximum matrix scale

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public double GetMaxScale(Matrix4 matrix)
    Parameters
    Type Name Description
    Matrix4 matrix
    Returns
    Type Description
    double

    InvertMatrix(Matrix4)

    Invert a matrix

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 InvertMatrix(Matrix4 matrix)
    Parameters
    Type Name Description
    Matrix4 matrix

    The matrix to invert

    Returns
    Type Description
    Matrix4

    LookAtMatrix(Point3, Point3, Point3)

    Create a matrix from a camera position, up and target

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 LookAtMatrix(Point3 position, Point3 up, Point3 target)
    Parameters
    Type Name Description
    Point3 position

    The camera position

    Point3 up

    The up vector

    Point3 target

    The target position

    Returns
    Type Description
    Matrix4

    MultiplyMatrices(Matrix4, Matrix4)

    Multiply two matrices, returns left*right

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 MultiplyMatrices(Matrix4 left, Matrix4 right)
    Parameters
    Type Name Description
    Matrix4 left

    Left side matrix

    Matrix4 right

    Right side matrix

    Returns
    Type Description
    Matrix4

    MultiplyMatrixPoint(Matrix4, Point3)

    Multiply a point by a matrix (i.e apply the matrix to a point)

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Point3 MultiplyMatrixPoint(Matrix4 matrix, Point3 point)
    Parameters
    Type Name Description
    Matrix4 matrix

    The matrix to apply

    Point3 point

    The point to multiply

    Returns
    Type Description
    Point3

    MultiplyMatrixVector(Matrix4, Point3)

    Multiply a vector by a matrix (i.e apply the matrix to a vector)

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Point3 MultiplyMatrixVector(Matrix4 matrix, Point3 vector)
    Parameters
    Type Name Description
    Matrix4 matrix

    The matrix to apply

    Point3 vector

    The vector to multiply

    Returns
    Type Description
    Point3

    OrthographicMatrix(double, double, double, double)

    Create an orthographic matrix from a 3D width, a 3D height, a near, and a far clipping distance

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 OrthographicMatrix(double width3D, double height3D, double nearClipDistance, double farClipDistance)
    Parameters
    Type Name Description
    double width3D

    The 3D width to consider

    double height3D

    The 3D height to consider

    double nearClipDistance

    The near clipping distance

    double farClipDistance

    The far clipping distance

    Returns
    Type Description
    Matrix4

    PerspectiveMatrix(double, double, double, double)

    Create a perspective matrix from a fovX, an aspect ratio, a near, and a far clipping distance

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Matrix4 PerspectiveMatrix(double fovX, double aspectRatio, double nearClipDistance, double farClipDistance)
    Parameters
    Type Name Description
    double fovX

    The field of view on the x axis

    double aspectRatio

    The aspect ratio foxX/fovY

    double nearClipDistance

    The near clipping distance

    double farClipDistance

    The far clipping distance

    Returns
    Type Description
    Matrix4

    ToTRS(Matrix4)

    Decompose a Matrix into translation, rotation and scaling vectors

    Declaration
    [HandleProcessCorruptedStateExceptions]
    public Vector3List ToTRS(Matrix4 matrix)
    Parameters
    Type Name Description
    Matrix4 matrix

    The Matrix to be decomposed

    Returns
    Type Description
    Vector3List
    Version 2024.2.2.3
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX.