LineRenderer
Описание
Линейный рендерер используется для рисования свободно плавающих линий в 3D пространстве.
Этот класс — программный интерфейс для линейный рендерер компонент.
// Programatically add a LineRenderer component and draw a 3D line. using UnityEngine;
public class LineRendererExample : MonoBehaviour { void Start() { // Add a LineRenderer component LineRenderer lineRenderer = gameObject.AddComponent<LineRenderer>();
// Set the material lineRenderer.material = new Material(Shader.Find("Sprites/Default"));
// Set the color lineRenderer.startColor = Color.red; lineRenderer.endColor = Color.green;
// Set the width lineRenderer.startWidth = 0.2f; lineRenderer.endWidth = 0.2f;
// Set the number of vertices lineRenderer.positionCount = 3;
// Set the positions of the vertices lineRenderer.SetPosition(0, new Vector3(0, 0, 0)); lineRenderer.SetPosition(1, new Vector3(1, 1, 0)); lineRenderer.SetPosition(2, new Vector3(2, 0, 0)); } }
Свойства
| Свойство | Описание |
|---|---|
| alignment | Выберите, будет ли линия обращена к камере, или ориентацию компонента Transform. |
| applyActiveColorSpace | Устанавливает, будут ли цвета преобразовываться надлежащим образом перед передачей в GPU при использовании линейного отображения. |
| colorGradient | Установите цветовой градиент, описывающий цвет линии в различных точках на протяжении ее длины. |
| endColor | Устанавливает цвет в конце строки. |
| endWidth | Устанавливает ширину в конце строки. |
| generateLightingData | Настраивает линию для генерации Нормальных и Тангенсных. С этими данными, Scene освещение может влиять на линию через Нормальные Картины и Unity Standard Shader, или ваши собственные пользовательские Шейдер. |
| loop | Соедините начальную и конечную позиции линии вместе, чтобы сформировать непрерывную петлю. |
| maskInteraction | Указывает, как LineRenderer взаимодействует с SpriteMask. |
| numCapVertices | Установите значение больше 0, чтобы получить округленные углы на каждом конце линии. По умолчанию это 0. |
| numCornerVertices | Установите значение больше 0, чтобы получить закругленные углы между каждым сегментом линии. |
| positionCount | Установить/получить число вершин. |
| shadowBias | Применяет отклонение тени для предотвращения артефактов самотени. Указанное значение представляет собой долю ширины линии на каждом сегменте. |
| startColor | Устанавливает цвет в начале строки. |
| startWidth | Устанавливает ширину в начале строки. |
| textureMode | Выберите, будет ли U-координата текстуры линии плиткой или растянута. |
| textureScale | Множитель для координат UV текстуры линии. |
| useWorldSpace | Если включено, то линии определяются в мировом пространстве. |
| widthCurve | Установить кривую, описывающую ширину линии в различных точках по всей ее длине. |
| widthMultiplier | Устанавливает общий множитель, который применяется к LineRenderer.widthCurve для получения окончательной ширины линии. |
Конструкторы
| Конструктор | Описание |
|---|---|
| LineRenderer | Вместо использования этого конструктора используйте либо GameObject.AddComponent<LineRenderer>(), либо, если у вас есть существующий компонент LineRenderer на GameObject, используйте GameObject.GetComponent<LineRenderer>(). |
Открытые методы
| Метод | Описание |
|---|---|
| BakeMesh | Создает моментальный снимок LineRenderer и хранит его в сетке. |
| GetPosition | Получить положение вершины в прямой. |
| GetPositions | Получить позиции всех вершин в прямой. |
| SetPosition | Установить положение вершины на линии. |
| SetPositions | Установить позиции всех вершин в линии. |
| Simplify | Создает упрощенную версию первоначальной линии путем удаления точек, которые находятся в пределах указанного допуска. |
Унаследованные члены 5
Свойства
| Свойство | Описание |
|---|---|
| gameObject | GameObject, к которому прикреплен данный компонент. Компонент всегда прикрепляется к игровому объекту. |
| tag | Тег этого игрового объекта. |
| transform | Transform прикреплен к этому GameObject. |
| transformHandle | TransformHandle этого GameObject. |
| hideFlags | Должен ли объект быть скрытым, сохраняться с Scene или изменяться пользователем? |
| name | Имя объекта. |
| allowOcclusionWhenDynamic | Управляет тем, должен ли выполняться динамический отбор по окклюзии для данного рендерера. |
| bounds | Ограничительная рамка рендерера в мировом пространстве. |
| enabled | Делает отображаемый объект 3D видимым, если включено. |
| forceMeshLod | Принудительная установка определенного уровня Mesh LOD для этого рендерера, если сетка имеет Mesh LODs. Если значение -1, Unity использует метод выбора Mesh LOD по умолчанию. |
| forceRenderingOff | Позволяет отключить отображение для определенного компонента. |
| isLOD0 | Является ли рендерер первым LOD уровнем в своей группе. |
| isPartOfStaticBatch | Указывает, входит ли этот рендерер в статический пакет вместе с другими рендерерами. |
| isVisible | Видимо ли это изображение на любой камере? (только для чтения) |
| lightmapIndex | Индекс выпеченной lightmap применяется к этому рендерингу. |
| lightmapScaleOffset | Масштаб UV и смещение, используемые для lightmap. |
| lightProbeProxyVolumeOverride | Если установлено, то Рендерер будет использовать компонент Light Probe Proxy Volume, прикрепленный к источнику GameObject. |
| lightProbeUsage | Тип интерполяции светового зонда. |
| localBounds | Ограничительная рамка рендерера в локальном пространстве. |
| localToWorldMatrix | Матрица, преобразующая точку из локального пространства в мировое пространство (только для чтения). |
| LODGroup | LODGroup для этого рендера. |
| material | Возвращает первый экземпляр Материала, назначенный рендеру. |
| materials | Возвращает все экземпляры материалов этого объекта. |
| meshLodSelectionBias | Отклонение, которое добавляется к вычисляемому значению при выборе уровня сетки LOD. |
| motionVectorGenerationMode | Указывает режим отображения вектора движения. |
| probeAnchor | Если установлено, то Рендерер будет использовать положение Transform для поиска зонда света или отражения. |
| rayTracingAccelerationStructureBuildFlags | Флаги, используемые Unity при построении структур ускорения, связанных с геометрией, используемой рендерами. |
| rayTracingAccelerationStructureBuildFlagsOverride | Следует ли переопределить флаги сборки по умолчанию, заданные при создании RayTracingAccelerationStructure. |
| rayTracingMode | Описывает, как этот рендерер обновляется для отслеживания лучей. |
| realtimeLightmapIndex | Индекс карты освещения реального времени, применённой к этому рендерингу. |
| realtimeLightmapScaleOffset | Масштаб UV и смещение, используемые для карты освещения реального времени. |
| receiveShadows | Получает ли этот объект тени? |
| reflectionProbeUsage | Должны ли использоваться отражательные зонды для этого Renderer? |
| rendererPriority | Это значение сортирует рендереры по приоритету. Низкие значения отображаются первыми, а высокие значения — последними. |
| renderingLayerMask | Определяет, на каком уровне отображения находится этот рендерер, если используется конвейер отображения со сценариями. |
| shadowCastingMode | Отбрасывает ли этот объект тени? |
| sharedMaterial | Общий материал этого объекта. |
| sharedMaterials | Все общие материалы этого объекта. |
| sortingLayerID | Уникальный ID слоя сортировки рендерера. |
| sortingLayerName | Имя слоя сортировки рендерера. |
| sortingOrder | Порядок отображения в слое сортировки. |
| staticShadowCaster | Является ли этот рендерер статическим источником теней? |
| worldToLocalMatrix | Матрица, преобразующая точку из мирового пространства в локальное пространство (только для чтения). |
Открытые методы
| Метод | Описание |
|---|---|
| BroadcastMessage | Вызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте или любом из его дочерей. |
| CompareTag | Проверяет тег GameObject на соответствие определенному тегу. |
| GetComponent | Получает ссылку на компонент типа T на том же GameObject, что и указанный компонент. |
| GetComponentInChildren | Получает ссылку на компонент типа T на том же GameObject, что и указанный компонент, или на любого ребенка GameObject. |
| GetComponentIndex | Получает индекс компонента на его родительском GameObject. |
| GetComponentInParent | Получает ссылку на компонент типа T на том же GameObject, что и указанный компонент, или на любой родитель GameObject. |
| GetComponents | Получает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент. |
| GetComponentsInChildren | Получает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент, и на любого ребенка GameObject. |
| GetComponentsInParent | Получает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент, и любой родитель GameObject. |
| SendMessage | Вызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте. |
| SendMessageUpwards | Вызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте и на каждом предшественнике поведения. |
| TryGetComponent | Получает компонент указанного типа, если он существует. |
| GetInstanceID | Получает экземпляр ID объекта. |
| ToString | Возвращает имя объекта. |
| GetClosestReflectionProbes | Возвращает массив ближайших зондов отражения с весами, вес показывает, какое влияние зонд оказывает на рендер, это значение также используется при смешивании между зондами отражения. |
| GetMaterials | Возвращает все экземпляры материалов этого объекта. |
| GetPropertyBlock | Получить блок свойств для каждого рендерера или материала. |
| GetSharedMaterials | Возвращает все общие материалы этого объекта. |
| HasPropertyBlock | Возвращает true, если в Renderer блок свойств материала прикреплен через SetPropertyBlock. |
| ResetBounds | Сброс пользовательских границ пространства мира. |
| ResetLocalBounds | Сброс пользовательских границ локального пространства. |
| SetMaterials | Назначает общие материалы этого рендерера, используя предоставленный список материалов. |
| SetPropertyBlock | Позволяет установить или очистить переопределения параметров для каждого рендерера или материала. |
| SetSharedMaterials | Назначает общие материалы этого рендерера, используя предоставленный список материалов. |
Статические методы
| Метод | Описание |
|---|---|
| Destroy | Удаляет GameObject, компонент или ресурс. |
| DestroyImmediate | Немедленно уничтожает указанный объект. Используйте с осторожностью и только в режиме редактирования. |
| DontDestroyOnLoad | Не уничтожать целевой Объект при загрузке нового Scene. |
| FindAnyObjectByType | Получает любой активный загруженный объект типа Type. |
| FindFirstObjectByType | Получает первый активный загруженный объект типа Type. |
| FindObjectsByType | Получает список всех загруженных объектов типа Type. |
| Instantiate | Клонирует исходный объект и возвращает клон. |
| InstantiateAsync | Захватывает моментальный снимок первоначального объекта (который должен быть связан с каким-либо GameObject) и возвращает AsyncInstantiateOperation. |
Операторы
| Оператор | Описание |
|---|---|
| bool | Существует ли объект? |
| оператор!= | Сравнивает, если два объекта ссылаются на разные объекты. |
| оператор == | Сравнение двух ссылок на объекты для определения того, относятся ли они к одному и тому же объекту. |
Сообщения
| Сообщение | Описание |
|---|---|
| OnBecameInvisible | OnBecameInvisible вызывается, когда объект больше не видно ни одной камерой. |
| OnBecameVisible | OnBecameVisible вызывается, когда объект становится видимым для любой камеры. |