Class CameraMetadata

Defines properties and message types for Camera.

Inherits properties and message types from Node3DMetadata.

Property Types

See also PropertyType
CameraMetadata.AspectRatioProperty

Sets the aspect ratio of the camera.

CameraMetadata.DisableAspectRatioProperty

Whether to use the aspect ratio setting from the viewport in render pass. When disabled, you can set the aspect ratio in the camera.

CameraMetadata.ZNearProperty

Sets the distance to the near clipping plane of the camera. The camera shows only the objects that are farther away than the value set in this property.

CameraMetadata.ZFarProperty

Sets the distance to the far clipping plane of the camera. The camera shows only the objects that are closer than the value set in this property.

CameraMetadata.ProjectionTypeProperty

Sets the projection type of the camera:

  • Perspective projection shows objects closer to the camera larger than those that are further away. This is the default.
  • Asymmetric perspective projection lets you use the Asymmetric FOV property to control the field of view of each angle of a perspective projection.
  • Orthographic projection shows a 2D view of a 3D scene without providing a sense of depth.
CameraMetadata.FovTypeProperty

Sets the direction of the field of view:

  • Y FOV sets the field of view along the y axis. This is the default.
  • X FOV sets the field of view along the x axis.
CameraMetadata.FovProperty

Sets the field of view of the camera in degrees.

CameraMetadata.AsymmetricFovProperty

Sets the field of view of the camera in degrees toward the left, right, up, and down. Angles to the right of the center and upwards of the center are positive.

To use this property, set the Projection Type to Asymmetric perspective.

CameraMetadata.OrthogonalCoordinateSystemTypeProperty

Sets the type of the orthogonal coordinate system:

  • Relative sets the camera to display an area whose width is scaled with the value of the Orthogonal Plane Size property. This is the default.
  • Absolute sets the camera to use pixel coordinates.
CameraMetadata.OrthogonalPlaneHeightProperty

Sets the half width or half height of the view plane of a camera that uses the relative orthogonal coordinate system:

  • When FOV Type is Y FOV (default value), the height.
  • When FOV Type is X FOV, the width.

The default value is 1.0.

Message Types

See also MessageType

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.