r3f-xr-widgets / HorizonCursorMaterial

Class: HorizonCursorMaterial

Defined in: src/components/HorizonCursorMaterial.tsx:10

Custom cursor material for VR controllers in the HorizonWindow demo. Configured with optimal settings for VR sharpness (no mipmaps, linear filtering).

Extends

MeshBasicMaterial

Accessors

alphaTest

Get Signature

get alphaTest(): number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:389

Gets the alpha value to be used when running an alpha test. Default is 0.

Default

Returns

number

Set Signature

set alphaTest(value): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:395

Sets the alpha value to be used when running an alpha test. Default is 0.

Default

Parameters

value

number

Returns

void

Inherited from

MeshBasicMaterial.alphaTest

needsUpdate

Set Signature

set needsUpdate(value): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:455

Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

Default

false

Parameters

value

boolean

Returns

void

Inherited from

MeshBasicMaterial.needsUpdate

Constructors

Constructor

new HorizonCursorMaterial(): HorizonCursorMaterial

Defined in: src/components/HorizonCursorMaterial.tsx:11

Returns

HorizonCursorMaterial

Overrides

MeshBasicMaterial.constructor

Methods

addEventListener()

Call Signature

addEventListener<T>(type, listener): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:52

Adds a listener to an event type.

Type Parameters

T

T extends "dispose"

Parameters

type

T

The type of event to listen to.

listener

EventListener<object[T], T, HorizonCursorMaterial>

The function that gets called when the event is fired.

Returns

void

Inherited from

MeshBasicMaterial.addEventListener

Call Signature

addEventListener<T>(type, listener): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:56

Adds a listener to an event type.

Type Parameters

T

T extends string

Parameters

type

T

The type of event to listen to.

listener

EventListener<{ }, T, HorizonCursorMaterial>

The function that gets called when the event is fired.

Returns

void

Inherited from

MeshBasicMaterial.addEventListener

clone()

clone(): this

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:437

Return a new material with the same parameters as this material.

Returns

this

Inherited from

MeshBasicMaterial.clone

copy()

copy(material): this

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:443

Copy the parameters from the passed material into this material.

Parameters

material

Material

Returns

this

Inherited from

MeshBasicMaterial.copy

customProgramCacheKey()

customProgramCacheKey(): string

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:420

In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

Returns

string

Inherited from

MeshBasicMaterial.customProgramCacheKey

dispatchEvent()

dispatchEvent<T>(event): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:84

Fire an event type.

Type Parameters

T

T extends "dispose"

Parameters

event

BaseEvent<T> & object[T]

The event that gets fired.

Returns

void

Inherited from

MeshBasicMaterial.dispatchEvent

dispose()

dispose(): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:448

This disposes the material. Textures of a material don't get disposed. These needs to be disposed by Texture.

Returns

void

Inherited from

MeshBasicMaterial.dispose

hasEventListener()

Call Signature

hasEventListener<T>(type, listener): boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:63

Checks if listener is added to an event type.

Type Parameters

T

T extends "dispose"

Parameters

type

T

The type of event to listen to.

listener

EventListener<object[T], T, HorizonCursorMaterial>

The function that gets called when the event is fired.

Returns

boolean

Inherited from

MeshBasicMaterial.hasEventListener

Call Signature

hasEventListener<T>(type, listener): boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:67

Checks if listener is added to an event type.

Type Parameters

T

T extends string

Parameters

type

T

The type of event to listen to.

listener

EventListener<{ }, T, HorizonCursorMaterial>

The function that gets called when the event is fired.

Returns

boolean

Inherited from

MeshBasicMaterial.hasEventListener

onBeforeCompile()

onBeforeCompile(parameters, renderer): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:415

An optional callback that is executed immediately before the shader program is compiled. This function is called with the associated WebGL program parameters and renderer. Useful for the modification of built-in materials.

Parameters

parameters

WebGLProgramParametersWithUniforms

WebGL program parameters

renderer

WebGLRenderer

WebGLRenderer context that is initializing the material

Returns

void

Inherited from

MeshBasicMaterial.onBeforeCompile

onBeforeRender()

onBeforeRender(renderer, scene, camera, geometry, object, group): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:399

Parameters

renderer

WebGLRenderer

scene

Scene

camera

Camera

geometry

BufferGeometry

object

Object3D

group

Group

Returns

void

Inherited from

MeshBasicMaterial.onBeforeRender

onBuild()

onBuild(object, parameters, renderer): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:397

Parameters

object

Object3D

parameters

WebGLProgramParametersWithUniforms

renderer

WebGLRenderer

Returns

void

Inherited from

MeshBasicMaterial.onBuild

removeEventListener()

Call Signature

removeEventListener<T>(type, listener): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:74

Removes a listener from an event type.

Type Parameters

T

T extends "dispose"

Parameters

type

T

The type of the listener that gets removed.

listener

EventListener<object[T], T, HorizonCursorMaterial>

The listener function that gets removed.

Returns

void

Inherited from

MeshBasicMaterial.removeEventListener

Call Signature

removeEventListener<T>(type, listener): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:78

Removes a listener from an event type.

Type Parameters

T

T extends string

Parameters

type

T

The type of the listener that gets removed.

listener

EventListener<{ }, T, HorizonCursorMaterial>

The listener function that gets removed.

Returns

void

Inherited from

MeshBasicMaterial.removeEventListener

setValues()

setValues(parameters): void

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:138

Sets the properties based on the values.

Parameters

parameters

MeshBasicMaterialParameters

Returns

void

Inherited from

MeshBasicMaterial.setValues

toJSON()

toJSON(meta?): any

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:432

Convert the material to three.js JSON format.

Parameters

meta?

any

Object containing metadata such as textures or images for the material.

Returns

any

Inherited from

MeshBasicMaterial.toJSON

Properties

alphaHash

alphaHash: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:90

Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

Inherited from

MeshBasicMaterial.alphaHash

alphaMap

alphaMap: Texture | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:85

Default

null

Inherited from

MeshBasicMaterial.alphaMap

alphaToCoverage

alphaToCoverage: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:98

Enables alpha to coverage. Can only be used with MSAA-enabled rendering contexts (meaning when the renderer was created with antialias parameter set to true). Enabling this will smooth aliasing on clip plane edges and alphaTest-clipped edges.

Default

false

Inherited from

MeshBasicMaterial.alphaToCoverage

aoMap

aoMap: Texture | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:70

Default

null

Inherited from

MeshBasicMaterial.aoMap

aoMapIntensity

aoMapIntensity: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:75

Default

Inherited from

MeshBasicMaterial.aoMapIntensity

blendAlpha

blendAlpha: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:105

Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

Default

Inherited from

MeshBasicMaterial.blendAlpha

blendColor

blendColor: Color

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:112

Represent the RGB values of the constant blend color. This property has only an effect when using custom blending with ConstantColorFactor or OneMinusConstantColorFactor.

Default

0x000000

Inherited from

MeshBasicMaterial.blendColor

blendDst

blendDst: BlendingDstFactor

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:118

Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.

Default

THREE.OneMinusSrcAlphaFactor

Inherited from

MeshBasicMaterial.blendDst

blendDstAlpha

blendDstAlpha: number | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:124

The tranparency of the .blendDst. Default is null.

Default

null

Inherited from

MeshBasicMaterial.blendDstAlpha

blendEquation

blendEquation: BlendingEquation

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:130

Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.

Default

THREE.AddEquation

Inherited from

MeshBasicMaterial.blendEquation

blendEquationAlpha

blendEquationAlpha: number | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:136

The tranparency of the .blendEquation. Default is null.

Default

null

Inherited from

MeshBasicMaterial.blendEquationAlpha

blending

blending: Blending

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:142

Which blending to use when displaying objects with this material. Default is NormalBlending.

Default

THREE.NormalBlending

Inherited from

MeshBasicMaterial.blending

blendSrc

blendSrc: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:148

Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.

Default

THREE.SrcAlphaFactor

Inherited from

MeshBasicMaterial.blendSrc

blendSrcAlpha

blendSrcAlpha: number | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:154

The tranparency of the .blendSrc. Default is null.

Default

null

Inherited from

MeshBasicMaterial.blendSrcAlpha

clipIntersection

clipIntersection: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:160

Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.

Default

false

Inherited from

MeshBasicMaterial.clipIntersection

clippingPlanes

clippingPlanes: Plane[] | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:169

User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply to the objects this material is attached to. Points in space whose signed distance to the plane is negative are clipped (not rendered). See the WebGL / clipping /intersection example. Default is null.

Default

null

Inherited from

MeshBasicMaterial.clippingPlanes

clipShadows

clipShadows: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:175

Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.

Default

false

Inherited from

MeshBasicMaterial.clipShadows

color

color: Color

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:50

Default

new THREE.Color( 0xffffff )

Inherited from

MeshBasicMaterial.color

colorWrite

colorWrite: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:181

Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.

Default

true

Inherited from

MeshBasicMaterial.colorWrite

combine

combine: Combine

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:100

Default

THREE.MultiplyOperation

Inherited from

MeshBasicMaterial.combine

defines

defines: {[key: string]: any; } | undefined

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:188

Custom defines to be injected into the shader. These are passed in form of an object literal, with key/value pairs. { MY_CUSTOM_DEFINE: '' , PI2: Math.PI * 2 }. The pairs are defined in both vertex and fragment shaders. Default is undefined.

Default

undefined

Inherited from

MeshBasicMaterial.defines

depthFunc

depthFunc: DepthModes

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:194

Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.

Default

THREE.LessEqualDepth

Inherited from

MeshBasicMaterial.depthFunc

depthTest

depthTest: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:201

Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write will also be implicitly disabled.

Default

true

Inherited from

MeshBasicMaterial.depthTest

depthWrite

depthWrite: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:208

Whether rendering this material has any effect on the depth buffer. Default is true. When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

Default

true

Inherited from

MeshBasicMaterial.depthWrite

dithering

dithering: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:318

Whether to apply dithering to the color to remove the appearance of banding. Default is false.

Default

false

Inherited from

MeshBasicMaterial.dithering

envMap

envMap: Texture | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:90

Default

null

Inherited from

MeshBasicMaterial.envMap

envMapRotation

envMapRotation: Euler

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:95

The rotation of the environment map in radians. Default is (0,0,0).

Inherited from

MeshBasicMaterial.envMapRotation

fog

fog: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:136

Whether the material is affected by fog. Default is true.

Default

fog

Inherited from

MeshBasicMaterial.fog

forceSinglePass

forceSinglePass: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:312

Default

false

Inherited from

MeshBasicMaterial.forceSinglePass

id

id: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:213

Unique number of this material instance.

Inherited from

MeshBasicMaterial.id

isMaterial

readonly isMaterial: true

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:82

Read-only flag to check if a given object is of type Material.

Remarks

This is a constant value

Default Value

true

Inherited from

MeshBasicMaterial.isMaterial

isMeshBasicMaterial

readonly isMeshBasicMaterial: true

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:40

Read-only flag to check if a given object is of type MeshBasicMaterial.

Remarks

This is a constant value

Default Value

true

Inherited from

MeshBasicMaterial.isMeshBasicMaterial

lightMap

lightMap: Texture | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:60

Default

null

Inherited from

MeshBasicMaterial.lightMap

lightMapIntensity

lightMapIntensity: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:65

Default

Inherited from

MeshBasicMaterial.lightMapIntensity

map

map: Texture | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:55

Default

null

Inherited from

MeshBasicMaterial.map

name

name: string

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:271

Material name. Default is an empty string.

Default

''

Inherited from

MeshBasicMaterial.name

opacity

opacity: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:277

Opacity. Default is 1.

Default

Inherited from

MeshBasicMaterial.opacity

polygonOffset

polygonOffset: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:283

Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.

Default

false

Inherited from

MeshBasicMaterial.polygonOffset

polygonOffsetFactor

polygonOffsetFactor: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:289

Sets the polygon offset factor. Default is 0.

Default

Inherited from

MeshBasicMaterial.polygonOffsetFactor

polygonOffsetUnits

polygonOffsetUnits: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:295

Sets the polygon offset units. Default is 0.

Default

Inherited from

MeshBasicMaterial.polygonOffsetUnits

precision

precision: "highp" | "mediump" | "lowp" | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:301

Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.

Default

null

Inherited from

MeshBasicMaterial.precision

premultipliedAlpha

premultipliedAlpha: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:307

Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.

Default

false

Inherited from

MeshBasicMaterial.premultipliedAlpha

reflectivity

reflectivity: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:105

Default

Inherited from

MeshBasicMaterial.reflectivity

refractionRatio

refractionRatio: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:110

Default

0.98

Inherited from

MeshBasicMaterial.refractionRatio

shadowSide

shadowSide: Side | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:333

Defines which of the face sides will cast shadows. Default is null. If null, the value is opposite that of side, above.

Default

null

Inherited from

MeshBasicMaterial.shadowSide

side

side: Side

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:326

Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

Default

THREE.FrontSide

Inherited from

MeshBasicMaterial.side

specularMap

specularMap: Texture | null

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:80

Default

null

Inherited from

MeshBasicMaterial.specularMap

stencilFail

stencilFail: StencilOp

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:249

Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

Inherited from

MeshBasicMaterial.stencilFail

stencilFunc

stencilFunc: StencilFunc

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:225

The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.

Default

THREE.AlwaysStencilFunc

Inherited from

MeshBasicMaterial.stencilFunc

stencilFuncMask

stencilFuncMask: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:243

The bit mask to use when comparing against the stencil buffer. Default is 0xFF.

Default

0xff

Inherited from

MeshBasicMaterial.stencilFuncMask

stencilRef

stencilRef: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:231

The value to use when performing stencil comparisons or stencil operations. Default is 0.

Default

Inherited from

MeshBasicMaterial.stencilRef

stencilWrite

stencilWrite: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:219

Whether rendering this material has any effect on the stencil buffer. Default is false.

Default

false

Inherited from

MeshBasicMaterial.stencilWrite

stencilWriteMask

stencilWriteMask: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:237

The bit mask to use when writing to the stencil buffer. Default is 0xFF.

Default

0xff

Inherited from

MeshBasicMaterial.stencilWriteMask

stencilZFail

stencilZFail: StencilOp

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:257

Which stencil operation to perform when the comparison function returns true but the depth test fails. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

Inherited from

MeshBasicMaterial.stencilZFail

stencilZPass

stencilZPass: StencilOp

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:265

Which stencil operation to perform when the comparison function returns true and the depth test passes. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

Inherited from

MeshBasicMaterial.stencilZPass

toneMapped

toneMapped: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:341

Defines whether this material is tone mapped according to the renderer's WebGLRenderer.toneMapping toneMapping setting. It is ignored when rendering to a render target or using post processing.

Default

true

Inherited from

MeshBasicMaterial.toneMapped

transparent

transparent: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:348

Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects. When set to true, the extent to which the material is transparent is controlled by setting it's .opacity property.

Default

false

Inherited from

MeshBasicMaterial.transparent

type

type: string

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:45

Default

'MeshBasicMaterial'

Inherited from

MeshBasicMaterial.type

userData

userData: Record<string, any>

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:377

An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

Default

{}

Inherited from

MeshBasicMaterial.userData

uuid

uuid: string

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:359

UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.

Inherited from

MeshBasicMaterial.uuid

version

version: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:383

This starts at 0 and counts how many times .needsUpdate is set to true.

Default

Inherited from

MeshBasicMaterial.version

vertexColors

vertexColors: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:365

Defines whether vertex coloring is used. Default is false.

Default

false

Inherited from

MeshBasicMaterial.vertexColors

visible

visible: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:371

Defines whether this material is visible. Default is true.

Default

true

Inherited from

MeshBasicMaterial.visible

wireframe

wireframe: boolean

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:115

Default

false

Inherited from

MeshBasicMaterial.wireframe

wireframeLinecap

wireframeLinecap: string

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:125

Default

'round'

Inherited from

MeshBasicMaterial.wireframeLinecap

wireframeLinejoin

wireframeLinejoin: string

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:130

Default

'round'

Inherited from

MeshBasicMaterial.wireframeLinejoin

wireframeLinewidth

wireframeLinewidth: number

Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/MeshBasicMaterial.d.ts:120

Default

Inherited from

MeshBasicMaterial.wireframeLinewidth

Class: HorizonCursorMaterial ​

Extends ​

Accessors ​

alphaTest ​

Get Signature ​

Default ​

Returns ​

Set Signature ​

Default ​

Parameters ​

value ​

Returns ​

Inherited from ​

needsUpdate ​

Set Signature ​

Default ​

Parameters ​

value ​

Returns ​

Inherited from ​

Constructors ​

Constructor ​

Returns ​

Overrides ​

Methods ​

addEventListener() ​

Call Signature ​

Type Parameters ​

T ​

Parameters ​

type ​

listener ​

Returns ​

Inherited from ​

Call Signature ​

Type Parameters ​

T ​

Parameters ​

type ​

listener ​

Returns ​

Inherited from ​

clone() ​

Returns ​

Inherited from ​

copy() ​

Parameters ​

material ​

Returns ​

Inherited from ​

customProgramCacheKey() ​

Returns ​

Inherited from ​

dispatchEvent() ​

Type Parameters ​

T ​

Parameters ​

event ​

Returns ​

Inherited from ​

dispose() ​

Returns ​

Inherited from ​

hasEventListener() ​

Call Signature ​

Type Parameters ​

T ​

Parameters ​

type ​

listener ​

Returns ​

Inherited from ​

Call Signature ​

Type Parameters ​

T ​

Parameters ​

type ​

listener ​

Returns ​

Inherited from ​

Class: HorizonCursorMaterial

Extends

Accessors

alphaTest

Get Signature

Default

Returns

Set Signature

Default

Parameters

value

Returns

Inherited from

needsUpdate

Set Signature

Default

Parameters

value

Returns

Inherited from

Constructors

Constructor

Returns

Overrides

Methods

addEventListener()

Call Signature

Type Parameters

T

Parameters

type

listener

Returns

Inherited from

Call Signature

Type Parameters

T

Parameters

type

listener

Returns

Inherited from

clone()

Returns

Inherited from

copy()

Parameters

material

Returns

Inherited from

customProgramCacheKey()

Returns

Inherited from

dispatchEvent()

Type Parameters

T

Parameters

event

Returns

Inherited from

dispose()

Returns

Inherited from

hasEventListener()

Call Signature

Type Parameters

T

Parameters

type

listener

Returns

Inherited from

Call Signature

Type Parameters

T

Parameters

type

listener

Returns

Inherited from