Руководство API скрипты

Camera

к Руководству

класс в UnityEngine / Наследует от: Behaviour / Реализовано в: UnityEngine.CoreModule

Описание

Камера — это устройство, через которое игрок смотрит на мир.

Точка пространства экрана определяется в пикселях. Нижний левый угол экрана (0,0); правый-верхний равно (pixelWidth,pixelHeight). Позиция z указывается в мировых единицах измерения камеры.

Точка пространства окна просмотра нормализована относительно камеры. Нижний левый угол камеры (0,0); вверху справа (1,1). Позиция z указывается в мировых единицах измерения камеры.

Точка мирового пространства определяется в глобальных координатах (например, Transform.position).

Обратите внимание, что класс не должен наследоваться от Camera напрямую. Если вам нужно наследовать от Camera, см. ScriptableCamera.

Смотрите так же: camera component.

Статические Свойства

allCameras Возвращает все включенные камеры в сцене.
allCamerasCount Количество камер в текущей сцене.
current Камера, с которой мы в данный момент рендерим, только для низкоуровневого управления рендерингом (только для чтения).
main Первый включенный компонент камеры с тегом "MainCamera" (только для чтения).
onPostRender Делегат, который можно использовать для выполнения пользовательского кода после того, как камера визуализирует сцену.
onPreCull Делегат, который можно использовать для выполнения пользовательского кода до того, как камера отберет сцену.
onPreRender Делегат, который можно использовать для выполнения пользовательского кода до того, как камера отобразит сцену.

Свойства

activeTexture Получает временную цель RenderTexture для этой камеры.
actualRenderingPath Путь рендеринга, который используется в данный момент (только для чтения).
allowDynamicResolution Динамическое масштабирование разрешения.
allowHDR Визуализация с высоким динамическим диапазоном.
allowMSAA Визуализация MSAA.
areVRStereoViewMatricesWithinSingleCullTolerance Определяет, подходят ли матрицы стереоскопического представления для однопроходной отбраковки.
aspect Соотношение сторон (ширина, деленная на высоту).
backgroundColor Цвет, которым будет очищаться экран.
cameraToWorldMatrix Матрица, преобразующая пространство камеры в мировое пространство (только для чтения).
cameraType Определяет тип камеры, используя перечисление CameraType.
clearFlags Как камера очищает фон.
clearStencilAfterLightingPass Должна ли камера очищать буфер трафарета после прохождения отложенного света?
commandBufferCount Количество буферов команд, установленных на этой камере (только для чтения).
cullingMask Используется для выборочной визуализации частей сцены.
cullingMatrix Устанавливает пользовательскую матрицу для использования камерой во всех запросах на отбраковку.
depth Глубина камеры в порядке рендеринга камеры.
depthTextureMode Каким образом камера создает текстуру глубины, и если это так?
eventMask Маска для выбора слоев, которые могут инициировать события на камере.
farClipPlane Расстояние от дальней плоскости отсечения до камеры, в мировых единицах.
fieldOfView Поле обзора камеры в градусах.
focalLength Фокусное расстояние камеры, выраженное в миллиметрах. Чтобы использовать это свойство, включите UsePhysicalProperties.
forceIntoRenderTexture Должен ли рендеринг камеры принудительно выполняться в RenderTexture.
gateFit Для камеры есть два вентиля: сенсорный вентиль и разрешающий вентиль. Строб сенсора физической камеры определяется свойством sensorSize, строб разрешения определяется целевой областью рендеринга.
layerCullDistances Расстояния отбраковки для каждого слоя.
layerCullSpherical Как выполнить послойную отбраковку для камеры.
lensShift Смещение объектива камеры. Сдвиг объектива зависит от размера сенсора. Например, смещение объектива на 0,5 смещает сенсор на половину его горизонтального размера.
nearClipPlane Расстояние ближайшей плоскости отсечения до камеры, в мировых единицах.
nonJitteredProjectionMatrix Получить или установить необработанную матрицу проекции без смещения камеры (без дрожания).
opaqueSortMode Режим сортировки непрозрачных объектов.
orthographic Является ли камера ортогональной (верно) или перспективной (ложной)?
orthographicSize Половина размера камеры в орфографическом режиме.
overrideSceneCullingMask Устанавливает параметры отбраковки, используемые для определения того, какие объекты из каких сцен нужно рисовать. См. EditorSceneManager.SetSceneCullingMask.
pixelHeight Высота камеры в пикселях (без учета динамического масштабирования разрешения) (только для чтения).
pixelRect Где на экране камера отображается в пиксельных координатах.
pixelWidth Ширина камеры в пикселях (без учета динамического масштабирования разрешения) (только для чтения).
previousViewProjectionMatrix Получить матрицу проекции вида, используемую в последнем кадре.
projectionMatrix Установите пользовательскую матрицу проекций.
rect Где на экране камера отображается в нормализованных координатах.
renderingPath Путь рендеринга, который следует использовать, если это возможно.
scaledPixelHeight Высота камеры в пикселях (с учетом динамического масштабирования разрешения) (только для чтения).
scaledPixelWidth Ширина камеры в пикселях (с учетом динамического масштабирования разрешения) (только чтение).
scene Если не ноль, камера будет отображать только содержимое указанной сцены.
sensorSize Размер сенсора камеры, выраженный в миллиметрах.
stereoActiveEye Возвращает отображаемый в данный момент глаз. При вызове, когда стерео не включено, он вернет Camera.MonoOrStereoscopicEye.Mono. При вызове во время обратного вызова рендеринга камеры, такого как OnRenderImage, он вернет текущий глаз рендеринга. Если он вызывается вне обратного вызова рендеринга и включено стерео, он возвращает глаз по умолчанию — Camera.MonoOrStereoscopicEye.Left.
stereoConvergence Расстояние до точки, в которой сходятся виртуальные глаза.
stereoEnabled Стереоскопический рендеринг.
stereoSeparation Расстояние между виртуальными глазами. Используйте это, чтобы запросить или установить текущее разделение глаз. Обратите внимание, что большинство устройств VR предоставляют это значение, и в этом случае установка значения не будет иметь никакого эффекта.
stereoTargetEye Определяет, в каком глазу VR-дисплея отображается камера.
targetDisplay Установите целевой экран для этой камеры.
targetTexture Целевая текстура рендеринга.
transparencySortAxis Ось, описывающая направление, вдоль которого измеряются расстояния до объектов с целью сортировки.
transparencySortMode Прозрачный режим сортировки объектов.
useJitteredProjectionMatrixForTransparentRendering Следует ли использовать дрожащую матрицу для визуализации прозрачности?
useOcclusionCulling Будет ли камера использовать отсечение окклюзии во время рендеринга.
usePhysicalProperties Включите [UsePhysicalProperties], чтобы использовать физические свойства камеры для вычисления поля зрения и усеченной пирамиды.
velocity Получить скорость камеры в мировом пространстве (только для чтения).
worldToCameraMatrix Матрица, трансформирующаяся из мира в пространство камеры.

Публичные Методы

AddCommandBuffer Добавить буфер команд для выполнения в указанном месте.
AddCommandBufferAsync Добавляет буфер команд в очереди асинхронных вычислений графического процессора и выполняет этот буфер команд, когда обработка графики достигает заданной точки.
CalculateFrustumCorners По заданным координатам окна просмотра вычисляет векторы пространства обзора, указывающие на четыре угла усеченного конуса на указанной глубине камеры.
CalculateObliqueMatrix Рассчитывает и возвращает матрицу наклонной почти плоской проекции.
CopyFrom Приводит настройки этой камеры в соответствие с настройками другой камеры.
CopyStereoDeviceProjectionMatrixToNonJittered Задает матрицу проекции без дрожания, полученную из VR SDK.
GetCommandBuffers Получить буферы команд для выполнения в указанном месте.
GetGateFittedFieldOfView Получает эффективное вертикальное поле зрения камеры, включая GateFit. Установка селектора сенсора и селектора разрешения влияет на окончательное поле зрения. Если соотношение сторон строба сенсора совпадает с соотношением сторон строба разрешения или если камера не находится в физическом режиме, то этот метод возвращает то же значение, что и свойство fieldofview.
GetGateFittedLensShift Получает эффективное смещение объектива камеры, включая GateFit. Установка селектора сенсора и селектора разрешения влияет на окончательную наклонность проекции. Если соотношение сторон строба датчика совпадает с соотношением сторон строба разрешения, то этот метод возвращает то же значение, что и свойство сдвига линзы. Если камера не в физическом режиме, то этот метод возвращает Vector2.zero.
GetStereoNonJitteredProjectionMatrix Получает матрицу проекции без флуктуации определенного левого или правого стереоскопического глаза.
GetStereoProjectionMatrix Получает матрицу проекции определенного левого или правого стереоскопического глаза.
GetStereoViewMatrix Получает матрицу левого или правого обзора определенного стереоскопического глаза.
RemoveAllCommandBuffers Удалить все буферы команд, установленные на этой камере.
RemoveCommandBuffer Удалить командный буфер из выполнения в указанном месте.
RemoveCommandBuffers Удалить буферы команд из выполнения в указанном месте.
Render Рендеринг камеры вручную.
RenderToCubemap Визуализация в статическую кубическую карту с этой камеры.
RenderWithShader Визуализация камеры с заменой шейдера.
Reset Восстановить все параметры камеры по умолчанию.
ResetAspect Восстановите соотношение сторон до соотношения сторон экрана.
ResetCullingMatrix Заставьте запросы на отбраковку отражать встроенные параметры камеры.
ResetProjectionMatrix Заставьте проекцию отражать нормальные параметры камеры.
ResetReplacementShader Удалить замену шейдера из камеры.
ResetStereoProjectionMatrices Переключите камеру на использование вычисленных матриц проекций Unity для всех стереоскопических глаз.
ResetStereoViewMatrices Переключите камеру на использование вычисляемых матриц просмотра Unity для всех стереоскопических глаз.
ResetTransparencySortSettings Сбрасывает настройки сортировки прозрачности этой камеры на значения по умолчанию. Настройки прозрачности по умолчанию берутся из GraphicsSettings, а не непосредственно из этой камеры.
ResetWorldToCameraMatrix Заставьте положение визуализации отражать положение камеры в сцене.
ScreenPointToRay Возвращает луч, идущий от камеры через точку экрана.
ScreenToViewportPoint Преобразует положение из пространства экрана в пространство окна просмотра.
ScreenToWorldPoint Преобразует точку из экранного пространства в мировое пространство, где мировое пространство определяется как система координат на самом верху иерархии вашей игры.
SetReplacementShader Сделайте визуализацию камеры с заменой шейдера.
SetStereoProjectionMatrix Задает пользовательскую матрицу проекции для определенного стереоскопического глаза.
SetStereoViewMatrix Устанавливает пользовательскую матрицу просмотра для определенного стереоскопического глаза.
SetTargetBuffers Настраивает камеру для рендеринга в выбранные буферы одной или нескольких RenderTexture.
SubmitRenderRequests Отправьте несколько запросов Camera.RenderRequests.
TryGetCullingParameters Получить параметры отбраковки для камеры.
ViewportPointToRay Возвращает луч, идущий от камеры через точку просмотра.
ViewportToScreenPoint Преобразует положение из пространства окна просмотра в пространство экрана.
ViewportToWorldPoint Преобразует положение из пространства окна просмотра в мировое пространство.
WorldToScreenPoint Преобразует позицию из мирового пространства в экранное пространство.
WorldToViewportPoint Преобразует положение из мирового пространства в пространство окна просмотра.

Статические Методы

CalculateProjectionMatrixFromPhysicalProperties Рассчитывает матрицу проекции на основе фокусного расстояния, размера сенсора, сдвига объектива, расстояния в ближней плоскости, расстояния в дальней плоскости и параметров строба. Чтобы рассчитать матрицу проекции без учета строба, используйте камеру. GateFitMode.None . Смотрите также: GateFitParameters
FieldOfViewToFocalLength Преобразует поле зрения в фокусное расстояние. Используйте либо высоту сенсора и вертикальное поле зрения, либо ширину сенсора и горизонтальное поле зрения.
FocalLengthToFieldOfView Преобразует фокусное расстояние в поле зрения.
GetAllCameras Заполняет массив Camera текущими камерами в сцене, не выделяя новый массив.
HorizontalToVerticalFieldOfView Преобразует горизонтальное поле зрения (FOV) в вертикальное FOV на основе значения параметра соотношения сторон.
VerticalToHorizontalFieldOfView Преобразует вертикальное поле зрения (FOV) в горизонтальное FOV на основе значения параметра соотношения сторон.

Сообщения

OnPostRender Функция события, которую Unity вызывает после того, как камера визуализирует сцену.
OnPreCull Функция события, которую Unity вызывает перед тем, как камера выберет сцену.
OnPreRender Функция события, которую Unity вызывает перед визуализацией сцены камерой.
OnRenderImage Функция события, которую Unity вызывает после завершения рендеринга камеры, что позволяет вам изменить финальное изображение с камеры.
OnRenderObject OnRenderObject вызывается после того, как камера визуализирует сцену.
OnWillRenderObject OnWillRenderObject вызывается для каждой камеры, если объект виден.

Делегаты

CameraCallback Тип делегата для обратных вызовов камеры.

Унаследованные члены

Свойства

enabled Включенные поведения обновляются, отключенные — нет.
isActiveAndEnabled Было ли поведение активным и включенным?
gameObject Игровой объект, к которому прикреплен компонент. Компонент всегда привязан к игровому объекту.
tag Тег игрового объекта.
transform Transform, прикрепленный игровому объекту.
hideFlags Должен ли объект быть скрыт, сохранен вместе со сценой или изменен пользователем?
name Имя объекта

Публичные Методы

BroadcastMessage Вызывает метод с именем methodName для каждого MonoBehaviour в игровом объекте или любом из его дочерних элементов.
CompareTag Помечен ли этот игровой объект тегом?
GetComponent Возвращает компонент, если он прикреплён к игровому объекту, и null, если нет. Также возвращает отключенные компоненты.
GetComponentInChildren Возвращает компонент дочернего элемента игрового объекта, используя поиск в глубину.
GetComponentInParent Возвращает компонент игрового объекта в любом из его родителей.
GetComponents Возвращает все компоненты игрового объекта
GetComponentsInChildren Возвращает все компоненты дочерних элементов игрового объекта. Работает рекурсивно.
GetComponentsInParent Возвращает все компоненты игрового объекта любого из родителя.
SendMessage Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте.
SendMessageUpwards Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте и для каждого behaviour.
TryGetComponent Получает компонент указанного типа, если он существует.
GetInstanceID Возвращает идентификатор экземпляра объекта.
ToString Возвращает имя объекта.

Статические Методы

Destroy Удаляет игровой объект, компонент или актив.
DestroyImmediate Уничтожает объект obj. Настоятельно рекомендуется использовать Destroy.
DontDestroyOnLoad Не уничтожает целевой объект при загрузке новой сцены.
FindObjectOfType Возвращает первый активный загруженный объект.
FindObjectsOfType Получает список всех загруженных объектов.
Instantiate Клонирует исходный объект и возвращает клон.

Операторы

bool Объект существует?
operator != Сравнивает, ссылаются ли два объекта на другой объект.
operator == Сравнивает две ссылки на объекты, чтобы определить, ссылаются ли они на один и тот же объект.
Вы можете отблагодарить автора, за перевод документации на русский язык. Донат
API скрипты 2021.3