Class CameraSample

Inheritance
Object
SampleBase
ImageableSample
XformableSample
XformSample
CameraSample
SanitizedCameraSample
Inherited Members
XformableSample.FromTransform(Transform)
XformableSample.transform
XformableSample.xformOpOrder
XformableSample.ConvertTransform()
SampleBase.Free()
Namespace: USD.NET.Unity
Syntax
[Serializable]
[UsdSchema("Camera")]
public class CameraSample : XformSample

Constructors

CameraSample()

Declaration
public CameraSample()

CameraSample(Camera)

Declaration
public CameraSample(Camera fromCamera)
Parameters
Type Name Description
Camera fromCamera

Fields

clippingPlanes

Declaration
public Vector4[] clippingPlanes
Field Value
Type Description
Vector4[]

clippingRange

Declaration
public Vector2 clippingRange
Field Value
Type Description
Vector2

focalLength

Declaration
public float focalLength
Field Value
Type Description
Single

focusDistance

Declaration
public float focusDistance
Field Value
Type Description
Single

fStop

Declaration
public float fStop
Field Value
Type Description
Single

horizontalAperture

Declaration
public float horizontalAperture
Field Value
Type Description
Single

horizontalApertureOffset

Declaration
public float horizontalApertureOffset
Field Value
Type Description
Single

projection

Declaration
public CameraSample.ProjectionType projection
Field Value
Type Description
CameraSample.ProjectionType

shutter

Declaration
[UsdNamespace("shutter")]
public CameraSample.Shutter shutter
Field Value
Type Description
CameraSample.Shutter

stereoRole

Declaration
[UsdVariability(Variability.Uniform)]
public CameraSample.StereoRole stereoRole
Field Value
Type Description
CameraSample.StereoRole

verticalAperture

Declaration
public float verticalAperture
Field Value
Type Description
Single

verticalApertureOffset

Declaration
public float verticalApertureOffset
Field Value
Type Description
Single

Methods

CopyFromCamera(Camera, Boolean)

Copys all relevant values of the given camera to the current camera sample.

Declaration
public void CopyFromCamera(Camera camera, bool convertTransformToUsd = true)
Parameters
Type Name Description
Camera camera

The camera to copy.
Boolean convertTransformToUsd

If true, converts the transform matrix from left handed(Unity) to right handed(USD). If you're unsure about this parameter, it should be left to the default value of true.

CopyToCamera(Camera, Boolean)

Copies the current sample values to the given camera.

Declaration
public void CopyToCamera(Camera camera, bool setTransform)
Parameters
Type Name Description
Camera camera
Boolean setTransform

Did you find this page useful? Please give it a rating: