docs.unity3d.com
    Show / Hide Table of Contents

    Class GfCamera

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

    Constructors

    GfCamera()

    Declaration
    public GfCamera()

    GfCamera(GfMatrix4d)

    Declaration
    public GfCamera(GfMatrix4d transform)
    Parameters
    Type Name Description
    GfMatrix4d transform

    GfCamera(GfMatrix4d, GfCamera.Projection)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection

    GfCamera(GfMatrix4d, GfCamera.Projection, Single)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture

    GfCamera(GfMatrix4d, GfCamera.Projection, Single, Single)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture, float verticalAperture)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture
    Single verticalAperture

    GfCamera(GfMatrix4d, GfCamera.Projection, Single, Single, Single)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture, float verticalAperture, float horizontalApertureOffset)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture
    Single verticalAperture
    Single horizontalApertureOffset

    GfCamera(GfMatrix4d, GfCamera.Projection, Single, Single, Single, Single)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture, float verticalAperture, float horizontalApertureOffset, float verticalApertureOffset)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture
    Single verticalAperture
    Single horizontalApertureOffset
    Single verticalApertureOffset

    GfCamera(GfMatrix4d, GfCamera.Projection, Single, Single, Single, Single, Single)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture, float verticalAperture, float horizontalApertureOffset, float verticalApertureOffset, float focalLength)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture
    Single verticalAperture
    Single horizontalApertureOffset
    Single verticalApertureOffset
    Single focalLength

    GfCamera(GfMatrix4d, GfCamera.Projection, Single, Single, Single, Single, Single, GfRange1f)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture, float verticalAperture, float horizontalApertureOffset, float verticalApertureOffset, float focalLength, GfRange1f clippingRange)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture
    Single verticalAperture
    Single horizontalApertureOffset
    Single verticalApertureOffset
    Single focalLength
    GfRange1f clippingRange

    GfCamera(GfMatrix4d, GfCamera.Projection, Single, Single, Single, Single, Single, GfRange1f, GfVec4fVector)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture, float verticalAperture, float horizontalApertureOffset, float verticalApertureOffset, float focalLength, GfRange1f clippingRange, GfVec4fVector clippingPlanes)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture
    Single verticalAperture
    Single horizontalApertureOffset
    Single verticalApertureOffset
    Single focalLength
    GfRange1f clippingRange
    GfVec4fVector clippingPlanes

    GfCamera(GfMatrix4d, GfCamera.Projection, Single, Single, Single, Single, Single, GfRange1f, GfVec4fVector, Single)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture, float verticalAperture, float horizontalApertureOffset, float verticalApertureOffset, float focalLength, GfRange1f clippingRange, GfVec4fVector clippingPlanes, float fStop)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture
    Single verticalAperture
    Single horizontalApertureOffset
    Single verticalApertureOffset
    Single focalLength
    GfRange1f clippingRange
    GfVec4fVector clippingPlanes
    Single fStop

    GfCamera(GfMatrix4d, GfCamera.Projection, Single, Single, Single, Single, Single, GfRange1f, GfVec4fVector, Single, Single)

    Declaration
    public GfCamera(GfMatrix4d transform, GfCamera.Projection projection, float horizontalAperture, float verticalAperture, float horizontalApertureOffset, float verticalApertureOffset, float focalLength, GfRange1f clippingRange, GfVec4fVector clippingPlanes, float fStop, float focusDistance)
    Parameters
    Type Name Description
    GfMatrix4d transform
    GfCamera.Projection projection
    Single horizontalAperture
    Single verticalAperture
    Single horizontalApertureOffset
    Single verticalApertureOffset
    Single focalLength
    GfRange1f clippingRange
    GfVec4fVector clippingPlanes
    Single fStop
    Single focusDistance

    Fields

    swigCMemOwn

    Declaration
    protected bool swigCMemOwn
    Field Value
    Type Description
    Boolean

    Properties

    APERTURE_UNIT

    Declaration
    public static double APERTURE_UNIT { get; }
    Property Value
    Type Description
    Double

    DEFAULT_HORIZONTAL_APERTURE

    Declaration
    public static double DEFAULT_HORIZONTAL_APERTURE { get; }
    Property Value
    Type Description
    Double

    DEFAULT_VERTICAL_APERTURE

    Declaration
    public static double DEFAULT_VERTICAL_APERTURE { get; }
    Property Value
    Type Description
    Double

    FOCAL_LENGTH_UNIT

    Declaration
    public static double FOCAL_LENGTH_UNIT { get; }
    Property Value
    Type Description
    Double

    Methods

    Dispose()

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

    Equals(GfCamera, GfCamera)

    Declaration
    public static bool Equals(GfCamera lhs, GfCamera rhs)
    Parameters
    Type Name Description
    GfCamera lhs
    GfCamera 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()

    GetAspectRatio()

    Declaration
    public float GetAspectRatio()
    Returns
    Type Description
    Single

    GetClippingPlanes()

    Declaration
    public GfVec4fVector GetClippingPlanes()
    Returns
    Type Description
    GfVec4fVector

    GetClippingRange()

    Declaration
    public GfRange1f GetClippingRange()
    Returns
    Type Description
    GfRange1f

    GetFieldOfView(GfCamera.FOVDirection)

    Declaration
    public float GetFieldOfView(GfCamera.FOVDirection direction)
    Parameters
    Type Name Description
    GfCamera.FOVDirection direction
    Returns
    Type Description
    Single

    GetFocalLength()

    Declaration
    public float GetFocalLength()
    Returns
    Type Description
    Single

    GetFocusDistance()

    Declaration
    public float GetFocusDistance()
    Returns
    Type Description
    Single

    GetFrustum()

    Declaration
    public GfFrustum GetFrustum()
    Returns
    Type Description
    GfFrustum

    GetFStop()

    Declaration
    public float GetFStop()
    Returns
    Type Description
    Single

    GetHashCode()

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

    GetHorizontalAperture()

    Declaration
    public float GetHorizontalAperture()
    Returns
    Type Description
    Single

    GetHorizontalApertureOffset()

    Declaration
    public float GetHorizontalApertureOffset()
    Returns
    Type Description
    Single

    GetProjection()

    Declaration
    public GfCamera.Projection GetProjection()
    Returns
    Type Description
    GfCamera.Projection

    GetTransform()

    Declaration
    public GfMatrix4d GetTransform()
    Returns
    Type Description
    GfMatrix4d

    GetVerticalAperture()

    Declaration
    public float GetVerticalAperture()
    Returns
    Type Description
    Single

    GetVerticalApertureOffset()

    Declaration
    public float GetVerticalApertureOffset()
    Returns
    Type Description
    Single

    SetClippingPlanes(GfVec4fVector)

    Declaration
    public void SetClippingPlanes(GfVec4fVector val)
    Parameters
    Type Name Description
    GfVec4fVector val

    SetClippingRange(GfRange1f)

    Declaration
    public void SetClippingRange(GfRange1f val)
    Parameters
    Type Name Description
    GfRange1f val

    SetFocalLength(Single)

    Declaration
    public void SetFocalLength(float val)
    Parameters
    Type Name Description
    Single val

    SetFocusDistance(Single)

    Declaration
    public void SetFocusDistance(float val)
    Parameters
    Type Name Description
    Single val

    SetFStop(Single)

    Declaration
    public void SetFStop(float val)
    Parameters
    Type Name Description
    Single val

    SetHorizontalAperture(Single)

    Declaration
    public void SetHorizontalAperture(float val)
    Parameters
    Type Name Description
    Single val

    SetHorizontalApertureOffset(Single)

    Declaration
    public void SetHorizontalApertureOffset(float val)
    Parameters
    Type Name Description
    Single val

    SetOrthographicFromAspectRatioAndSize(Single, Single, GfCamera.FOVDirection)

    Declaration
    public void SetOrthographicFromAspectRatioAndSize(float aspectRatio, float orthographicSize, GfCamera.FOVDirection direction)
    Parameters
    Type Name Description
    Single aspectRatio
    Single orthographicSize
    GfCamera.FOVDirection direction

    SetPerspectiveFromAspectRatioAndFieldOfView(Single, Single, GfCamera.FOVDirection)

    Declaration
    public void SetPerspectiveFromAspectRatioAndFieldOfView(float aspectRatio, float fieldOfView, GfCamera.FOVDirection direction)
    Parameters
    Type Name Description
    Single aspectRatio
    Single fieldOfView
    GfCamera.FOVDirection direction

    SetPerspectiveFromAspectRatioAndFieldOfView(Single, Single, GfCamera.FOVDirection, Single)

    Declaration
    public void SetPerspectiveFromAspectRatioAndFieldOfView(float aspectRatio, float fieldOfView, GfCamera.FOVDirection direction, float horizontalAperture)
    Parameters
    Type Name Description
    Single aspectRatio
    Single fieldOfView
    GfCamera.FOVDirection direction
    Single horizontalAperture

    SetProjection(GfCamera.Projection)

    Declaration
    public void SetProjection(GfCamera.Projection val)
    Parameters
    Type Name Description
    GfCamera.Projection val

    SetTransform(GfMatrix4d)

    Declaration
    public void SetTransform(GfMatrix4d val)
    Parameters
    Type Name Description
    GfMatrix4d val

    SetVerticalAperture(Single)

    Declaration
    public void SetVerticalAperture(float val)
    Parameters
    Type Name Description
    Single val

    SetVerticalApertureOffset(Single)

    Declaration
    public void SetVerticalApertureOffset(float val)
    Parameters
    Type Name Description
    Single val

    Operators

    Equality(GfCamera, GfCamera)

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

    Inequality(GfCamera, GfCamera)

    Declaration
    public static bool operator !=(GfCamera lhs, GfCamera rhs)
    Parameters
    Type Name Description
    GfCamera lhs
    GfCamera 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