Class ClippingPrimitive

An abstract primitive component to animate and visualize a clipping primitive that can be used to drive per pixel based clipping.

Inheritance

Object

ClippingPrimitive

ClippingBox

ClippingPlane

ClippingSphere

Namespace: Microsoft.MixedReality.Toolkit.Utilities

Assembly: cs.temp.dll.dll

Syntax

public abstract class ClippingPrimitive : MonoBehaviour

Fields

allocatedMaterials

Declaration

protected List<Material> allocatedMaterials

Field Value

Type	Description
List<Material>

clippingSide

Declaration

protected ClippingPrimitive.Side clippingSide

Field Value

Type	Description
ClippingPrimitive.Side

materialPropertyBlock

Declaration

protected MaterialPropertyBlock materialPropertyBlock

Field Value

Type	Description
MaterialPropertyBlock

modifiedMaterials

Declaration

protected Dictionary<Material, bool> modifiedMaterials

Field Value

Type	Description
Dictionary<Material, Boolean>

renderers

Declaration

protected List<Renderer> renderers

Field Value

Type	Description
List<Renderer>

Properties

ClippingSide

The renderer(s) that should be affected by the primitive.

Declaration

public ClippingPrimitive.Side ClippingSide { get; set; }

Property Value

Type	Description
ClippingPrimitive.Side

ClippingSideProperty

Declaration

protected abstract string ClippingSideProperty { get; }

Property Value

Type	Description
String

Keyword

Declaration

protected abstract string Keyword { get; }

Property Value

Type	Description
String

UseOnPreRender

Declaration

public bool UseOnPreRender { get; set; }

Property Value

Type	Description
Boolean

Methods

AddRenderer(Renderer)

Declaration

public void AddRenderer(Renderer _renderer)

Parameters

Type	Name	Description
Renderer	_renderer

GetMaterial(Renderer, Boolean)

Declaration

protected Material GetMaterial(Renderer _renderer, bool trackAllocations = true)

Parameters

Type	Name	Description
Renderer	_renderer
Boolean	trackAllocations

Returns

Type	Description
Material

Initialize()

Declaration

protected virtual void Initialize()

LateUpdate()

Declaration

protected void LateUpdate()

OnCameraPreRender(CameraEventRouter)

Declaration

protected void OnCameraPreRender(CameraEventRouter router)

Parameters

Type	Name	Description
CameraEventRouter	router

OnDestroy()

Declaration

protected void OnDestroy()

OnDisable()

Declaration

protected void OnDisable()

OnEnable()

Declaration

protected void OnEnable()

OnValidate()

Declaration

protected void OnValidate()

RemoveRenderer(Renderer)

Declaration

public void RemoveRenderer(Renderer _renderer)

Parameters

Type	Name	Description
Renderer	_renderer

RestoreUnassignedMaterials()

Declaration

protected void RestoreUnassignedMaterials()

Start()

Declaration

protected void Start()

ToggleClippingFeature(Material, Boolean)

Declaration

protected void ToggleClippingFeature(Material material, bool keywordOn)

Parameters

Type	Name	Description
Material	material
Boolean	keywordOn

ToggleClippingFeature(Boolean)

Declaration

protected void ToggleClippingFeature(bool keywordOn)

Parameters

Type	Name	Description
Boolean	keywordOn

UpdateRenderers()

Declaration

protected virtual void UpdateRenderers()

UpdateShaderProperties(MaterialPropertyBlock)

Declaration

protected abstract void UpdateShaderProperties(MaterialPropertyBlock materialPropertyBlock)

Parameters

Type	Name	Description
MaterialPropertyBlock	materialPropertyBlock