docs.unity3d.com
    Show / Hide Table of Contents

    Class GfFrustum

    Inheritance
    Object
    GfFrustum
    Inherited Members
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: pxr
    Syntax
    public class GfFrustum : IDisposable

    Constructors

    GfFrustum()

    Declaration
    public GfFrustum()

    GfFrustum(GfMatrix4d, GfRange2d, GfRange1d, GfFrustum.ProjectionType)

    Declaration
    public GfFrustum(GfMatrix4d camToWorldXf, GfRange2d window, GfRange1d nearFar, GfFrustum.ProjectionType projectionType)
    Parameters
    Type Name Description
    GfMatrix4d camToWorldXf
    GfRange2d window
    GfRange1d nearFar
    GfFrustum.ProjectionType projectionType

    GfFrustum(GfMatrix4d, GfRange2d, GfRange1d, GfFrustum.ProjectionType, Double)

    Declaration
    public GfFrustum(GfMatrix4d camToWorldXf, GfRange2d window, GfRange1d nearFar, GfFrustum.ProjectionType projectionType, double viewDistance)
    Parameters
    Type Name Description
    GfMatrix4d camToWorldXf
    GfRange2d window
    GfRange1d nearFar
    GfFrustum.ProjectionType projectionType
    Double viewDistance

    GfFrustum(GfVec3d, GfRotation, GfRange2d, GfRange1d, GfFrustum.ProjectionType)

    Declaration
    public GfFrustum(GfVec3d position, GfRotation rotation, GfRange2d window, GfRange1d nearFar, GfFrustum.ProjectionType projectionType)
    Parameters
    Type Name Description
    GfVec3d position
    GfRotation rotation
    GfRange2d window
    GfRange1d nearFar
    GfFrustum.ProjectionType projectionType

    GfFrustum(GfVec3d, GfRotation, GfRange2d, GfRange1d, GfFrustum.ProjectionType, Double)

    Declaration
    public GfFrustum(GfVec3d position, GfRotation rotation, GfRange2d window, GfRange1d nearFar, GfFrustum.ProjectionType projectionType, double viewDistance)
    Parameters
    Type Name Description
    GfVec3d position
    GfRotation rotation
    GfRange2d window
    GfRange1d nearFar
    GfFrustum.ProjectionType projectionType
    Double viewDistance

    Fields

    swigCMemOwn

    Declaration
    protected bool swigCMemOwn
    Field Value
    Type Description
    Boolean

    Methods

    ComputeAspectRatio()

    Declaration
    public double ComputeAspectRatio()
    Returns
    Type Description
    Double

    ComputeCorners()

    Declaration
    public GfVec3dVector ComputeCorners()
    Returns
    Type Description
    GfVec3dVector

    ComputeCornersAtDistance(Double)

    Declaration
    public GfVec3dVector ComputeCornersAtDistance(double d)
    Parameters
    Type Name Description
    Double d
    Returns
    Type Description
    GfVec3dVector

    ComputeLookAtPoint()

    Declaration
    public GfVec3d ComputeLookAtPoint()
    Returns
    Type Description
    GfVec3d

    ComputeNarrowedFrustum(GfVec2d, GfVec2d)

    Declaration
    public GfFrustum ComputeNarrowedFrustum(GfVec2d point, GfVec2d halfSize)
    Parameters
    Type Name Description
    GfVec2d point
    GfVec2d halfSize
    Returns
    Type Description
    GfFrustum

    ComputeNarrowedFrustum(GfVec3d, GfVec2d)

    Declaration
    public GfFrustum ComputeNarrowedFrustum(GfVec3d worldPoint, GfVec2d halfSize)
    Parameters
    Type Name Description
    GfVec3d worldPoint
    GfVec2d halfSize
    Returns
    Type Description
    GfFrustum

    ComputePickRay(GfVec2d)

    Declaration
    public GfRay ComputePickRay(GfVec2d windowPos)
    Parameters
    Type Name Description
    GfVec2d windowPos
    Returns
    Type Description
    GfRay

    ComputePickRay(GfVec3d)

    Declaration
    public GfRay ComputePickRay(GfVec3d worldSpacePos)
    Parameters
    Type Name Description
    GfVec3d worldSpacePos
    Returns
    Type Description
    GfRay

    ComputeProjectionMatrix()

    Declaration
    public GfMatrix4d ComputeProjectionMatrix()
    Returns
    Type Description
    GfMatrix4d

    ComputeRay(GfVec2d)

    Declaration
    public GfRay ComputeRay(GfVec2d windowPos)
    Parameters
    Type Name Description
    GfVec2d windowPos
    Returns
    Type Description
    GfRay

    ComputeRay(GfVec3d)

    Declaration
    public GfRay ComputeRay(GfVec3d worldSpacePos)
    Parameters
    Type Name Description
    GfVec3d worldSpacePos
    Returns
    Type Description
    GfRay

    ComputeUpVector()

    Declaration
    public GfVec3d ComputeUpVector()
    Returns
    Type Description
    GfVec3d

    ComputeViewDirection()

    Declaration
    public GfVec3d ComputeViewDirection()
    Returns
    Type Description
    GfVec3d

    ComputeViewFrame(GfVec3d, GfVec3d, GfVec3d)

    Declaration
    public void ComputeViewFrame(GfVec3d side, GfVec3d up, GfVec3d view)
    Parameters
    Type Name Description
    GfVec3d side
    GfVec3d up
    GfVec3d view

    ComputeViewInverse()

    Declaration
    public GfMatrix4d ComputeViewInverse()
    Returns
    Type Description
    GfMatrix4d

    ComputeViewMatrix()

    Declaration
    public GfMatrix4d ComputeViewMatrix()
    Returns
    Type Description
    GfMatrix4d

    Dispose()

    Declaration
    public virtual void Dispose()
    Implements
    IDisposable.Dispose()

    Equals(GfFrustum, GfFrustum)

    Declaration
    public static bool Equals(GfFrustum lhs, GfFrustum rhs)
    Parameters
    Type Name Description
    GfFrustum lhs
    GfFrustum rhs
    Returns
    Type Description
    Boolean

    Equals(Object)

    Declaration
    public override bool Equals(object rhs)
    Parameters
    Type Name Description
    Object rhs
    Returns
    Type Description
    Boolean
    Overrides
    Object.Equals(Object)

    Finalize()

    Declaration
    protected void Finalize()

    FitToSphere(GfVec3d, Double)

    Declaration
    public void FitToSphere(GfVec3d center, double radius)
    Parameters
    Type Name Description
    GfVec3d center
    Double radius

    FitToSphere(GfVec3d, Double, Double)

    Declaration
    public void FitToSphere(GfVec3d center, double radius, double slack)
    Parameters
    Type Name Description
    GfVec3d center
    Double radius
    Double slack

    GetFOV()

    Declaration
    public double GetFOV()
    Returns
    Type Description
    Double

    GetFOV(Boolean)

    Declaration
    public double GetFOV(bool isFovVertical)
    Parameters
    Type Name Description
    Boolean isFovVertical
    Returns
    Type Description
    Double

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    Object.GetHashCode()

    GetNearFar()

    Declaration
    public GfRange1d GetNearFar()
    Returns
    Type Description
    GfRange1d

    GetOrthographic(out Double, out Double, out Double, out Double, out Double, out Double)

    Declaration
    public bool GetOrthographic(out double left, out double right, out double bottom, out double top, out double nearPlane, out double farPlane)
    Parameters
    Type Name Description
    Double left
    Double right
    Double bottom
    Double top
    Double nearPlane
    Double farPlane
    Returns
    Type Description
    Boolean

    GetPerspective(Boolean, out Double, out Double, out Double, out Double)

    Declaration
    public bool GetPerspective(bool isFovVertical, out double fieldOfView, out double aspectRatio, out double nearDistance, out double farDistance)
    Parameters
    Type Name Description
    Boolean isFovVertical
    Double fieldOfView
    Double aspectRatio
    Double nearDistance
    Double farDistance
    Returns
    Type Description
    Boolean

    GetPerspective(out Double, out Double, out Double, out Double)

    Declaration
    public bool GetPerspective(out double fieldOfViewHeight, out double aspectRatio, out double nearDistance, out double farDistance)
    Parameters
    Type Name Description
    Double fieldOfViewHeight
    Double aspectRatio
    Double nearDistance
    Double farDistance
    Returns
    Type Description
    Boolean

    GetPosition()

    Declaration
    public GfVec3d GetPosition()
    Returns
    Type Description
    GfVec3d

    GetProjectionType()

    Declaration
    public GfFrustum.ProjectionType GetProjectionType()
    Returns
    Type Description
    GfFrustum.ProjectionType

    GetReferencePlaneDepth()

    Declaration
    public static double GetReferencePlaneDepth()
    Returns
    Type Description
    Double

    GetRotation()

    Declaration
    public GfRotation GetRotation()
    Returns
    Type Description
    GfRotation

    GetViewDistance()

    Declaration
    public double GetViewDistance()
    Returns
    Type Description
    Double

    GetWindow()

    Declaration
    public GfRange2d GetWindow()
    Returns
    Type Description
    GfRange2d

    Intersects(GfBBox3d)

    Declaration
    public bool Intersects(GfBBox3d bbox)
    Parameters
    Type Name Description
    GfBBox3d bbox
    Returns
    Type Description
    Boolean

    Intersects(GfVec3d)

    Declaration
    public bool Intersects(GfVec3d point)
    Parameters
    Type Name Description
    GfVec3d point
    Returns
    Type Description
    Boolean

    Intersects(GfVec3d, GfVec3d)

    Declaration
    public bool Intersects(GfVec3d p0, GfVec3d p1)
    Parameters
    Type Name Description
    GfVec3d p0
    GfVec3d p1
    Returns
    Type Description
    Boolean

    Intersects(GfVec3d, GfVec3d, GfVec3d)

    Declaration
    public bool Intersects(GfVec3d p0, GfVec3d p1, GfVec3d p2)
    Parameters
    Type Name Description
    GfVec3d p0
    GfVec3d p1
    GfVec3d p2
    Returns
    Type Description
    Boolean

    IntersectsViewVolume(GfBBox3d, GfMatrix4d)

    Declaration
    public static bool IntersectsViewVolume(GfBBox3d bbox, GfMatrix4d vpMat)
    Parameters
    Type Name Description
    GfBBox3d bbox
    GfMatrix4d vpMat
    Returns
    Type Description
    Boolean

    SetNearFar(GfRange1d)

    Declaration
    public void SetNearFar(GfRange1d nearFar)
    Parameters
    Type Name Description
    GfRange1d nearFar

    SetOrthographic(Double, Double, Double, Double, Double, Double)

    Declaration
    public void SetOrthographic(double left, double right, double bottom, double top, double nearPlane, double farPlane)
    Parameters
    Type Name Description
    Double left
    Double right
    Double bottom
    Double top
    Double nearPlane
    Double farPlane

    SetPerspective(Double, Boolean, Double, Double, Double)

    Declaration
    public void SetPerspective(double fieldOfView, bool isFovVertical, double aspectRatio, double nearDistance, double farDistance)
    Parameters
    Type Name Description
    Double fieldOfView
    Boolean isFovVertical
    Double aspectRatio
    Double nearDistance
    Double farDistance

    SetPerspective(Double, Double, Double, Double)

    Declaration
    public void SetPerspective(double fieldOfViewHeight, double aspectRatio, double nearDistance, double farDistance)
    Parameters
    Type Name Description
    Double fieldOfViewHeight
    Double aspectRatio
    Double nearDistance
    Double farDistance

    SetPosition(GfVec3d)

    Declaration
    public void SetPosition(GfVec3d position)
    Parameters
    Type Name Description
    GfVec3d position

    SetPositionAndRotationFromMatrix(GfMatrix4d)

    Declaration
    public void SetPositionAndRotationFromMatrix(GfMatrix4d camToWorldXf)
    Parameters
    Type Name Description
    GfMatrix4d camToWorldXf

    SetProjectionType(GfFrustum.ProjectionType)

    Declaration
    public void SetProjectionType(GfFrustum.ProjectionType projectionType)
    Parameters
    Type Name Description
    GfFrustum.ProjectionType projectionType

    SetRotation(GfRotation)

    Declaration
    public void SetRotation(GfRotation rotation)
    Parameters
    Type Name Description
    GfRotation rotation

    SetViewDistance(Double)

    Declaration
    public void SetViewDistance(double viewDistance)
    Parameters
    Type Name Description
    Double viewDistance

    SetWindow(GfRange2d)

    Declaration
    public void SetWindow(GfRange2d window)
    Parameters
    Type Name Description
    GfRange2d window

    Transform(GfMatrix4d)

    Declaration
    public GfFrustum Transform(GfMatrix4d matrix)
    Parameters
    Type Name Description
    GfMatrix4d matrix
    Returns
    Type Description
    GfFrustum

    Operators

    Equality(GfFrustum, GfFrustum)

    Declaration
    public static bool operator ==(GfFrustum lhs, GfFrustum rhs)
    Parameters
    Type Name Description
    GfFrustum lhs
    GfFrustum rhs
    Returns
    Type Description
    Boolean

    Inequality(GfFrustum, GfFrustum)

    Declaration
    public static bool operator !=(GfFrustum lhs, GfFrustum rhs)
    Parameters
    Type Name Description
    GfFrustum lhs
    GfFrustum rhs
    Returns
    Type Description
    Boolean
    Back to top
    Copyright © 2023 Unity Technologies
    • 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 on Thursday, October 19, 2023