Three.js

Константы

Анимационные константы

Цикличные режимы (loop modes)

однократное воспроизведение клипа');" onmouseout="hide()">THREE.LoopOnce

клип проигрывается выбранное количество
раз (указанное в параметре repetitions),
всякий раз переходя с конца клипа
непосредственно на его начало');" onmouseout="hide()">THREE.LoopRepeat

воспроизводится выбранное количество раз
(указанное в параметре repetitions),
проигрывая его поочередно вперед и назад');" onmouseout="hide()">THREE.LoopPingPong

Режимы интерполяции (interpolation modes)

THREE.InterpolateDiscrete
THREE.InterpolateLinear
THREE.InterpolateSmooth

Режимы окончания (ending modes)

THREE.ZeroCurvatureEnding
THREE.ZeroSlopeEnding
THREE.WrapAroundEnding

Исходники

Константы ядра

Номер версии (revision number)

THREE.REV

Номер текущей версии three.js.

Кнопки мышки (mouse buttons)

THREE.MOUSE.LEFT
THREE.MOUSE.MIDDLE
THREE.MOUSE.RIGHT

Исходники

Константы настраиваемых уравнений смешивания

Пример

materials / blending / custom

Применение

Константы работают со всеми типами материалов. Вначале устанавливается режим смешивания материалов (THREE.CustomBlending), затем устанавливается желаемые уравнение смешивания (Blending Equation), исходный фактор (Source Factor) и целевой фактор (Destination Factor).

var material = new THREE.MeshBasicMaterial( {color: 0x00ff00} );
material.blending = THREE.CustomBlending;
material.blendEquation = THREE.AddEquation; // по умолчанию
material.blendSrc = THREE.SrcAlphaFactor; // по умолчанию
material.blendDst = THREE.OneMinusDstAlphaFactor; // по умолчанию

Уравнения смешивания (blending equations)

THREE.AddEquation
THREE.SubtractEquation
THREE.ReverseSubtractEquation
THREE.MinEquation
THREE.MaxEquation

Исходные факторы (source factors)

THREE.ZeroFactor
THREE.OneFactor
THREE.SrcColorFactor
THREE.OneMinusSrcColorFactor
THREE.SrcAlphaFactor
THREE.OneMinusSrcAlphaFactor
THREE.DstAlphaFactor
THREE.OneMinusDstAlphaFactor
THREE.DstColorFactor
THREE.OneMinusDstColorFactor
THREE.SrcAlphaSaturateFactor

Целевые факторы (destination factors)

Все исходные факторы работают и как целевые, за исключением THREE.SrcAlphaSaturateFactor.

Исходники

Константы режима рисования

Это действующие значения для свойства Mesh.drawMode, и управляют тем, как список вершин будет интерпретирован после отправки в графический процессор (GPU).
Обратите внимание, что это все работает только когда Mesh.geometry является BufferGeometry. Изменение констант, когда Mesh.geometry является Geometry, не окажет никакого влияния.

Режимы рисования (draw modes)

THREE.TrianglesDrawMode

THREE.TriangleStripDrawMode

THREE.TriangleFanDrawMode

Применение

var geometry = new THREE.Geometry();

geometry.vertices.push(
	new THREE.Vector3( -10,  10, 0 ),
	new THREE.Vector3( -10, -10, 0 ),
	new THREE.Vector3(  10, -10, 0 ),
	...
);
geometry.faces.push( new THREE.Face3( 0, 1, 2 ), ... );

var material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );

var mesh = new THREE.Mesh( geometry, material );
mesh.drawMode = THREE.TrianglesDrawMode; // default (по умолчанию)

scene.add( mesh );

Исходники

Константы материалов

Эти константы определяют свойства, общие для всех типов материала, за исключением операций комбинирования текстур (Texture Combine Operations), которые применяются только к MeshBasicMaterial, MeshLambertMaterial и MeshPhongMaterial.

Сторона (side)

THREE.FrontSide
THREE.BackSide
THREE.DoubleSide

Эти константы определяют какая сторона грани будет отображаться - передняя (front), задняя (back) или обе. По умолчанию используется FrontSide.

Цвета (colors)

THREE.NoColors
THREE.FaceColors
THREE.VertexColors

NoColors используется по умолчанию и применяет ко всем граням (поверхностям) цвет материала.
FaceColors окрашивает грани (т.е. ячейки каркаса) в соответствии со значением цвета color каждой треугольной грани Face3.
VertexColors окрашивает грани в соответствии со значением vertexColors каждой из вершин грани Face3. Это массив из трех значений color, по одному для каждой вершины грани.
Смотрите пример geometry / colors.

Режим смешивания (blending mode)

THREE.NoBlending
THREE.NormalBlending
THREE.AdditiveBlending
THREE.SubtractiveBlending
THREE.MultiplyBlending
THREE.CustomBlending

Эти константы управляют исходным и целевым уравнениями смешивания для каналов цвета (RGB) и канала прозрачности (Alpha) материала, отправляемых WebGLRenderer'у для использования в WebGL.
NormalBlending используется по умолчанию.
Обратите внимание, что CustomBlending должен быть установлен для использования Custom Blending Equations.
Смотрите пример materials / blending.

Режим глубины (depth mode)

THREE.NeverDepth
THREE.AlwaysDepth
THREE.LessDepth
THREE.LessEqualDepth
THREE.GreaterEqualDepth
THREE.GreaterDepth
THREE.NotEqualDepth

Эти константы определяют функцию, используемую материалом для сравнения значения входящего пиксела глубины (т.е. значения по оси Z) с текущим значением буфера глубины. Если результатом этого сравнения будет значение true, пиксель будет прорисован.

Операции комбинирования (совмещения) текстур

THREE.MultiplyOperation
THREE.MixOperation
THREE.AddOperation

Эти операции определяют каков будет результат при совмещении цвета поверхности с картой цвета среды (если существует), для таких материалов как MeshBasicMaterial, MeshLambertMaterial и MeshPhongMaterial.

Исходники

Константы WebGLRenderer

Режимы выбраковки граней (cull face modes)

THREE.CullFaceNone
THREE.CullFaceBack
THREE.CullFaceFront
THREE.CullFaceFrontBack

Эти константы используются методом setFaceCulling WebGLRenderer'а.

Направление передней грани (front face direction)

THREE.FrontFaceDirectionCW
THREE.FrontFaceDirectionCCW

Эти константы используются методом setFaceCulling WebGLRenderer'а.

Типы тени (shadow types)

THREE.BasicShadowMap
THREE.PCFShadowMap
THREE.PCFSoftShadowMap

Эти константы определяют свойство shadowMap.type WebGLRenderer'а.

Отображение тона цвета (tone mapping)

Отображение тонов цвета (tone mapping) - это процесс преобразования диапазона яркостей HDR к LDR диапазону, отображаемому устройством вывода, например, монитором или принтером, так как вывод HDR изображений на них потребует преобразования динамического диапазона и цветового охвата модели HDR в соответствующий динамический диапазон LDR, чаще всего модель RGB. Ведь диапазон яркости, представленный в HDR, очень широк, это несколько порядков абсолютного динамического диапазона единовременно, в одной сцене. А диапазон, который можно воспроизвести на привычных устройствах вывода (мониторах, телевизорах), составляет лишь около двух порядков динамического диапазона.
Преобразование из HDR в LDR и называется
закон преобразования яркости пикселей может быть разным
для различных частей изображения (имитация градиентного
фильтра). Существуют разные алгоритмы с разными
дополнительными эффектами и возможностями по управлению
пользователем этим процессом. В результате применения
алгоритмов могут образовываться ореолы в районе границ
между светлыми и тёмными областями, тёмные по природе
объекты могут стать неестественно светлыми.')" onmouseout="hide()">отображением тонов (tone mapping), оно выполняется с потерями и имитирует свойства человеческого зрения.

THREE.NoToneMapping
THREE.LinearToneMapping
THREE.ReinhardToneMapping
THREE.Uncharted2ToneMapping
THREE.CineonToneMapping

Эти константы определяют свойство toneMapping WebGLRenderer'а. Они используются для приведения внешнего вида изображения в расширенном динамическом диапазоне (high dynamic range - HDR) к возможному отображению их в низком динамическом диапазоне (low dynamic range - LDR) стандартного компьютерного монитора или экрана мобильного устройства.
NoToneMapping отключает отображение тонов.
Значением по умолчанию является LinearToneMapping.
Смотрите пример отображения тонов.

Исходники

Константы текстур

Режимы картирования (mapping modes)

THREE.UVMapping
THREE.CubeReflectionMapping
THREE.CubeRefractionMapping
THREE.EquirectangularReflectionMapping
THREE.EquirectangularRefractionMapping
THREE.SphericalReflectionMapping
THREE.CubeUVReflectionMapping
THREE.CubeUVRefractionMapping

Эти константы определяют режим наложения текстуры на поверхность объекта.
Значением по умолчанию является THREE.UVMapping, при которой текстура накладывается на поверхность объекта в соответствии с координатами UV сетки (mesh).
Остальные константы определяют типы картирования окружающей обстановки.
CubeReflectionMapping и CubeRefractionMapping предназначены для использования с CubeTexture, состоящей из шести текстур, по одной на каждую грань куба. Для CubeTexture значением по умолчанию является CubeReflectionMapping.
EquirectangularReflectionMapping и EquirectangularRefractionMapping предназначены для использования с картой равнопромежуточной проекции. Также она называется картой (lat-long map) с долготой (longitude) и широтой (latitude), равнопромежуточная текстура представляет вид на 360 градусов по горизонтальной оси и на 180 градусов по вертикальной оси, с верхним и нижним краями изображения соответствующими северному и южному полюсам отображаемой сферы.
Вот статьи Википедии Равнопромежуточная проекция и Equirectangular projection.
SphericalReflectionMapping предназначена для использования с картой сферического отражения, такой, какая может быть получена путем обрезки фотографии зеркального шара. Сферические карты будут отображаться лицевой стороной к камере, независимо от её положения относительно объекта с кубическим картированием или поверхности.
Смотрите пример materials / envmaps.

Режимы укладки текстур (wrapping modes)

THREE.RepeatWrapping
THREE.ClampToEdgeWrapping
THREE.MirroredRepeatWrapping

Эти константы определяют свойства текстур wrapS и wrapT, которые устанавливают стыковку текстур по горизонтали и вертикали.

Фильтры увеличения (magnification filters)

nearest filter - ближайший фильтр')" onmouseout="hide()">THREE.NearestFilter


linear filter - линейный фильтр')" onmouseout="hide()">THREE.LinearFilter

Эти константы предназначены для свойства текстуры magFilter, они определяют функцию увеличения текстуры, используемую когда пиксель существующей текстуры отображает область меньше или равную одному элементу текстуры (текселю).

Фильтры минимизации (minification filters)

nearest filter - ближайший фильтр')" onmouseout="hide()">THREE.NearestFilter


nearest mipmap nearest filter - ближайшая mip-карта, ближайший фильтр')" onmouseout="hide()">THREE.NearestMipMapNearestFilter


nearest mipmap linear filter - ближайшая mip-карта, линейный фильтр')" onmouseout="hide()">THREE.NearestMipMapLinearFilter


linear filter - линейный фильтр')" onmouseout="hide()">THREE.LinearFilter


linear mipmap nearest filter - линейная mip-карта, ближайший фильтр')" onmouseout="hide()">THREE.LinearMipMapNearestFilter


linear mipmap linear filter - линейная mip-карта, линейный фильтр')" onmouseout="hide()">THREE.LinearMipMapLinearFilter

Эти константы предназначены для использования со свойством текстуры minFilter, они определяют функцию минимизации текстуры, которая используется всякий раз, когда пиксел существующей текстуры отображает область больше, чем один элемент текстуры (тексель).
В дополнение к NearestFilter и LinearFilter для минимизации можно использовать следующие четыре функции: Смотрите пример materials / texture / filters.

Типы

THREE.UnsignedByteType
THREE.ByteType
THREE.ShortType
THREE.UnsignedShortType
THREE.IntType
THREE.UnsignedIntType
THREE.FloatType
THREE.HalfFloatType

в шестнадцатиразрядное двоичное число
по четыре разряда на каждое из значений')" onmouseout="hide()">THREE.UnsignedShort4444Type

в шестнадцатиразрядное двоичное число
по пять разрядов на каждое из значений цвета
и один разряд для значения прозрачности')" onmouseout="hide()">THREE.UnsignedShort5551Type

двоичное число по пять разрядов на красный и синий
цвета и шесть разрядов на зеленый цвет')" onmouseout="hide()">THREE.UnsignedShort565Type

в 32-битное число, 24 бита на значение
глубины и 8 бит на значение трафарета')" onmouseout="hide()">THREE.UnsignedInt248Type

Для использования со свойством текстуры type, которое должно соответствовать правильному формату.
Значением по умолчанию является UnsignedByteType.
Для типов упакованных данных THREE.UnsignedShort4444Type, THREE.UnsignedShort5551Type или THREE.UnsignedShort565Type, все компоненты цвета одного текселя можно рассматривать как битовые поля внутри целочисленного элемента в формате Uint16Array.
Это метод хранения цвета текселя (пикселя текстуры). Описываемые битовые поля связаны с числами, определяющими количество бит каждого канала цвета.
Цифры 4444 в названии типа означают число бит для каждого из каналов цвета и канала прозрачности в формате RGBA - по четыре бита на каждый канал.

 16-разрядное беззнаковое число
|R|R|R|R|G|G|G|G|B|B|B|B|A|A|A|A|
 красный|зеленый| синий | альфа

В типе 5551 по пять бит отведено на каждый из каналов цвета и один бит на канал прозрачности (т.е. альфа-канал может быть либо 100%, либо 0% или 1 или 0).

 16-разрядное беззнаковое число
|R|R|R|R|R|G|G|G|G|G|B|B|B|B|B|A|
| красный | зеленый |  синий  |альфа

У типа 565 нет альфа-канала, но имеется дополнительный бит в канале зеленого цвета.

 16-разрядное беззнаковое число
|R|R|R|R|R|G|G|G|G|G|G|B|B|B|B|B|
  красный |  зеленый  |  синий

Тип THREE.UnsignedInt248Type это упаковка значений глубины и трафарета в 32-битное целое число без знака. Цифры 248 означают, что на значение глубины (depth) отводится 24 бита, а на значение трафарета (stencil) - 8 бит.

Форматы

alpha format - формат канала
прозрачности (альфа-канала)')" onmouseout="hide()">THREE.AlphaFormat


RGB format - формат компонентов
цвета RGB')" onmouseout="hide()">THREE.RGBFormat


RGBA format - формат компонентов
цвета RGB и канала прозрачности
(альфа-канала)')" onmouseout="hide()">THREE.RGBAFormat


luminance format - формат яркости')" onmouseout="hide()">THREE.LuminanceFormat


luminance alpha format - формат
яркости и прозрачности (альфа-канал)')" onmouseout="hide()">THREE.LuminanceAlphaFormat


RGBE format - формат компонентов
цвета RGB (на каждый цвет отводится
по одному байту) и канала показателя
степени (exponent) - также один байт')" onmouseout="hide()">THREE.RGBEFormat


depth format - формат глубины')" onmouseout="hide()">THREE.DepthFormat


depth stencil format - формат
глубины и трафарета')" onmouseout="hide()">THREE.DepthStencilFormat

Предназначены для использования со свойством format, они определяют как элементы двумерной текстуры (тексели), считываются шейдерами. Обратите внимание, что текстура должна иметь правильный тип, как указано выше. Подробности смотрите на этой странице.

Форматы сжатия текстур DDS / ST3C Compressed Texture Formats

сжатие компонентов цвета RGB
в формате S3TC (вариант DXT1)')" onmouseout="hide()">THREE.RGB_S3TC_DXT1_Format


сжатие компонентов цвета RGB и
канала прозрачности (альфа-канала)
в формате S3TC (вариант DXT1)')" onmouseout="hide()">THREE.RGBA_S3TC_DXT1_Format


сжатие компонентов цвета RGB и
канала прозрачности (альфа-канала)
в формате S3TC (вариант DXT3)')" onmouseout="hide()">THREE.RGBA_S3TC_DXT3_Format


сжатие компонентов цвета RGB и
канала прозрачности (альфа-канала)
в формате S3TC (вариант DXT5)')" onmouseout="hide()">THREE.RGBA_S3TC_DXT5_Format

Предназначены для использования со свойством format CompressedTexture, при этом требуется поддержка расширения WEBGL_compressed_texture_s3tc.
С поддержкой этого расширения имеется четыре S3TC формата.

Форматы сжатия текстур PVRTC (PowerVR Texture Compression)

сжатие компонентов цвета RGB в формате PVRTC,
в 4-битном режиме')" onmouseout="hide()">THREE.RGB_PVRTC_4BPPV1_Format


сжатие компонентов цвета RGB в формате PVRTC,
в 2-битном режиме')" onmouseout="hide()">THREE.RGB_PVRTC_2BPPV1_Format


сжатие компонентов цвета RGB и
канала прозрачности (альфа-канала)
в формате PVRTC, в 4-битном режиме')" onmouseout="hide()">THREE.RGBA_PVRTC_4BPPV1_Format


сжатие компонентов цвета RGB и
канала прозрачности (альфа-канала)
в формате PVRTC, в 2-битном режиме')" onmouseout="hide()">THREE.RGBA_PVRTC_2BPPV1_Format

Предназначены для использования со свойством format CompressedTexture, при этом требуется поддержка расширения WEBGL_compressed_texture_pvrtc.
Формат сжатия PVRTC обычно доступен только на мобильных устройствах с наборами микросхем PowerVR, в основном это устройства Apple.
С поддержкой этого расширения имеется четыре PVRTC формата.

Формат сжатия текстур ETC

RGB_ETC1_Format - формат ETC1 (сжатия компонентов цвета) RGB')" onmouseout="hide()">THREE.RGB_ETC1_Format

Предназначена для использования со свойством format CompressedTexture, при этом требуется поддержка расширения WEBGL_compressed_texture_etc1.

Кодирование

linear encoding - линейное кодирование')" onmouseout="hide()">LinearEncoding


sRGB encoding - кодирование sRGB')" onmouseout="hide()">THREE.sRGBEncoding


gamma encoding - гамма-кодирование')" onmouseout="hide()">THREE.GammaEncoding


RGBE encoding - кодирование RGBE')" onmouseout="hide()">THREE.RGBEEncoding


RGBM7 encoding - кодировка RGBM7')" onmouseout="hide()">THREE.LogLuvEncoding


')" onmouseout="hide()">THREE.RGBM7Encoding


RGBM16 encoding - кодировка RGBM16')" onmouseout="hide()">THREE.RGBM16Encoding


RGBD encoding - кодировка RGBD')" onmouseout="hide()">THREE.RGBDEncoding


basic depth packing -
базовая упаковка глубины')" onmouseout="hide()">THREE.BasicDepthPacking


RGBA depth packing -
упаковка глубины компонентов
цвета RGB и прозрачности A')" onmouseout="hide()">THREE.RGBADepthPacking

Для использования со свойством текстуры encoding.
Если тип кодирования изменяется после того, как текстура уже была использована материалом, нужно установить свойство Material.needsUpdate как true, чтобы пересобрать (перекомпилировать) материал.
Значением по умолчанию является

linear encoding - линейное кодирование')" onmouseout="hide()">LinearEncoding. Значения, отличные от данных, действительны только для свойств материала map, envMap и emissiveMap.

Исходники