Class: OccluderMaterial
@geenee/bodyrenderers-babylon.OccluderMaterial
Occluder material
Occluders are elements of a scene that are not rendered by themselves but still participate in occlusion queries. Usually, occluder is a base mesh (average approximation) of a body representing its real counterpart in a scene. Occluders are used to mask visible virtual objects behind them (like geometries of a 3D scene behind user's body). Applying OccluderMaterial to a mesh makes it an occluder.
Hierarchy
-
ShaderMaterial
↳
OccluderMaterial
Constructors
constructor
• new OccluderMaterial(name
, scene
)
Constructor
Parameters
Name | Type | Description |
---|---|---|
name | string | Name of the material in the scene |
scene | Scene | Scene the material belongs to |
Overrides
ShaderMaterial.constructor
Properties
_activeEffect
• Protected
Optional
_activeEffect: Effect
Inherited from
ShaderMaterial._activeEffect
_alpha
• Protected
_alpha: number
The alpha value of the material
Inherited from
ShaderMaterial._alpha
_backFaceCulling
• Protected
_backFaceCulling: boolean
Specifies if back face culling is enabled
Inherited from
ShaderMaterial._backFaceCulling
_callbackPluginEventBindForSubMesh
• _callbackPluginEventBindForSubMesh: (eventData
: MaterialPluginBindForSubMesh
) => void
Type declaration
▸ (eventData
): void
Parameters
Name | Type |
---|---|
eventData | MaterialPluginBindForSubMesh |
Returns
void
Inherited from
ShaderMaterial._callbackPluginEventBindForSubMesh
_callbackPluginEventFillRenderTargetTextures
• _callbackPluginEventFillRenderTargetTextures: (eventData
: MaterialPluginFillRenderTargetTextures
) => void
Type declaration
▸ (eventData
): void
Parameters
Name | Type |
---|---|
eventData | MaterialPluginFillRenderTargetTextures |
Returns
void
Inherited from
ShaderMaterial._callbackPluginEventFillRenderTargetTextures
_callbackPluginEventGeneric
• _callbackPluginEventGeneric: (id
: number
, info
: MaterialPluginDisposed
| MaterialPluginHasTexture
| MaterialPluginGetDefineNames
| MaterialPluginPrepareEffect
| MaterialPluginPrepareUniformBuffer
| MaterialPluginGetAnimatables
| MaterialPluginGetActiveTextures
) => void
Type declaration
▸ (id
, info
): void
Parameters
Name | Type |
---|---|
id | number |
info | MaterialPluginDisposed | MaterialPluginHasTexture | MaterialPluginGetDefineNames | MaterialPluginPrepareEffect | MaterialPluginPrepareUniformBuffer | MaterialPluginGetAnimatables | MaterialPluginGetActiveTextures |
Returns
void
Inherited from
ShaderMaterial._callbackPluginEventGeneric
_callbackPluginEventHardBindForSubMesh
• _callbackPluginEventHardBindForSubMesh: (eventData
: MaterialPluginHardBindForSubMesh
) => void
Type declaration
▸ (eventData
): void
Parameters
Name | Type |
---|---|
eventData | MaterialPluginHardBindForSubMesh |
Returns
void
Inherited from
ShaderMaterial._callbackPluginEventHardBindForSubMesh
_callbackPluginEventHasRenderTargetTextures
• _callbackPluginEventHasRenderTargetTextures: (eventData
: MaterialPluginHasRenderTargetTextures
) => void
Type declaration
▸ (eventData
): void
Parameters
Name | Type |
---|---|
eventData | MaterialPluginHasRenderTargetTextures |
Returns
void
Inherited from
ShaderMaterial._callbackPluginEventHasRenderTargetTextures
_callbackPluginEventIsReadyForSubMesh
• _callbackPluginEventIsReadyForSubMesh: (eventData
: MaterialPluginIsReadyForSubMesh
) => void
Type declaration
▸ (eventData
): void
Parameters
Name | Type |
---|---|
eventData | MaterialPluginIsReadyForSubMesh |
Returns
void
Inherited from
ShaderMaterial._callbackPluginEventIsReadyForSubMesh
_callbackPluginEventPrepareDefines
• _callbackPluginEventPrepareDefines: (eventData
: MaterialPluginPrepareDefines
) => void
Type declaration
▸ (eventData
): void
Parameters
Name | Type |
---|---|
eventData | MaterialPluginPrepareDefines |
Returns
void
Inherited from
ShaderMaterial._callbackPluginEventPrepareDefines
_callbackPluginEventPrepareDefinesBeforeAttributes
• _callbackPluginEventPrepareDefinesBeforeAttributes: (eventData
: MaterialPluginPrepareDefines
) => void
Type declaration
▸ (eventData
): void
Parameters
Name | Type |
---|---|
eventData | MaterialPluginPrepareDefines |
Returns
void
Inherited from
ShaderMaterial._callbackPluginEventPrepareDefinesBeforeAttributes
_cullBackFaces
• Protected
_cullBackFaces: boolean
Specifies if back or front faces should be culled (when culling is enabled)
Inherited from
ShaderMaterial._cullBackFaces
_dirtyCallbacks
• _dirtyCallbacks: Object
Index signature
▪ [code: number
]: () => void
Inherited from
ShaderMaterial._dirtyCallbacks
_drawWrapper
• Protected
_drawWrapper: DrawWrapper
Inherited from
ShaderMaterial._drawWrapper
_eventInfo
• Protected
_eventInfo: MaterialPluginDisposed
& MaterialPluginHasTexture
& MaterialPluginIsReadyForSubMesh
& MaterialPluginGetDefineNames
& MaterialPluginPrepareEffect
& MaterialPluginPrepareDefines
& MaterialPluginPrepareUniformBuffer
& MaterialPluginBindForSubMesh
& MaterialPluginGetAnimatables
& MaterialPluginGetActiveTextures
& MaterialPluginFillRenderTargetTextures
& MaterialPluginHasRenderTargetTextures
& MaterialPluginHardBindForSubMesh
Inherited from
ShaderMaterial._eventInfo
_forceAlphaTest
• Protected
_forceAlphaTest: boolean
Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
Inherited from
ShaderMaterial._forceAlphaTest
_indexInSceneMaterialArray
• _indexInSceneMaterialArray: number
Inherited from
ShaderMaterial._indexInSceneMaterialArray
_internalMetadata
• _internalMetadata: any
Inherited from
ShaderMaterial._internalMetadata
_loadedUniqueId
• _loadedUniqueId: string
Inherited from
ShaderMaterial._loadedUniqueId
_materialContext
• _materialContext: undefined
| IMaterialContext
Stores the effects for the material
Inherited from
ShaderMaterial._materialContext
_materialHelperNeedsPreviousMatrices
• _materialHelperNeedsPreviousMatrices: boolean
Inherited from
ShaderMaterial._materialHelperNeedsPreviousMatrices
_needToBindSceneUbo
• Protected
_needToBindSceneUbo: boolean
Inherited from
ShaderMaterial._needToBindSceneUbo
_normalMatrix
• Protected
_normalMatrix: Matrix
Inherited from
ShaderMaterial._normalMatrix
_onEffectCreatedObservable
• Protected
_onEffectCreatedObservable: Nullable
<Observable
<{ effect
: Effect
; subMesh
: Nullable
<SubMesh
> }>>
Inherited from
ShaderMaterial._onEffectCreatedObservable
_parentContainer
• _parentContainer: Nullable
<AbstractScene
>
Inherited from
ShaderMaterial._parentContainer
_storeEffectOnSubMeshes
• _storeEffectOnSubMeshes: boolean
Inherited from
ShaderMaterial._storeEffectOnSubMeshes
_transparencyMode
• Protected
_transparencyMode: Nullable
<number
>
The transparency mode of the material.
Inherited from
ShaderMaterial._transparencyMode
_uniformBuffer
• _uniformBuffer: UniformBuffer
Stores the uniform buffer
Inherited from
ShaderMaterial._uniformBuffer
_uniformBufferLayoutBuilt
• _uniformBufferLayoutBuilt: boolean
Inherited from
ShaderMaterial._uniformBufferLayoutBuilt
_useLogarithmicDepth
• Protected
_useLogarithmicDepth: boolean
Inherited from
ShaderMaterial._useLogarithmicDepth
allowShaderHotSwapping
• allowShaderHotSwapping: boolean
Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping. This means that the material can keep using a previous shader while a new one is being compiled. This is mostly used when shader parallel compilation is supported (true by default)
Inherited from
ShaderMaterial.allowShaderHotSwapping
animations
• animations: Nullable
<Animation
[]>
Stores the animations for the material
Inherited from
ShaderMaterial.animations
checkReadyOnEveryCall
• checkReadyOnEveryCall: boolean
Specifies if the ready state should be checked on each call
Inherited from
ShaderMaterial.checkReadyOnEveryCall
checkReadyOnlyOnce
• checkReadyOnlyOnce: boolean
Specifies if the ready state should be checked once
Inherited from
ShaderMaterial.checkReadyOnlyOnce
clipPlane
• clipPlane: Nullable
<Plane
>
Gets or sets the active clipplane 1
Inherited from
ShaderMaterial.clipPlane
clipPlane2
• clipPlane2: Nullable
<Plane
>
Gets or sets the active clipplane 2
Inherited from
ShaderMaterial.clipPlane2
clipPlane3
• clipPlane3: Nullable
<Plane
>
Gets or sets the active clipplane 3
Inherited from
ShaderMaterial.clipPlane3
clipPlane4
• clipPlane4: Nullable
<Plane
>
Gets or sets the active clipplane 4
Inherited from
ShaderMaterial.clipPlane4
clipPlane5
• clipPlane5: Nullable
<Plane
>
Gets or sets the active clipplane 5
Inherited from
ShaderMaterial.clipPlane5
clipPlane6
• clipPlane6: Nullable
<Plane
>
Gets or sets the active clipplane 6
Inherited from
ShaderMaterial.clipPlane6