ClippingPlane Class

Definition

Namespace:

Microsoft.MixedReality.GraphicsTools

Assembly:

Microsoft.MixedReality.GraphicsTools.dll

Component to animate and visualize a plane that can be used with per pixel based clipping.

[UnityEngine.AddComponentMenu("Scripts/GraphicsTools/ClippingPlane")]
[UnityEngine.ExecuteInEditMode]
public class ClippingPlane : Microsoft.MixedReality.GraphicsTools.ClippingPrimitive

[<UnityEngine.AddComponentMenu("Scripts/GraphicsTools/ClippingPlane")>]
[<UnityEngine.ExecuteInEditMode>]
type ClippingPlane = class
    inherit ClippingPrimitive

Public Class ClippingPlane
Inherits ClippingPrimitive

Inheritance

UnityEngine.MonoBehaviour

ClippingPrimitive

ClippingPlane

Attributes

UnityEngine.AddComponentMenuAttribute UnityEngine.ExecuteInEditModeAttribute

Constructors

ClippingPlane()

Fields

clippingSide	(Inherited from ClippingPrimitive)
clipPlaneID	The property name of the clip plane data within the shader.
materialPropertyBlock	The property block in use for material adjustments. (Inherited from ClippingPrimitive)
renderers	(Inherited from ClippingPrimitive)

Properties

ApplyToSharedMaterial	Toggles whether the clipping features will apply to shared materials or material instances (default). (Inherited from ClippingPrimitive)
ClippingSide	Which side of the primitive to clip pixels against. (Inherited from ClippingPrimitive)
ClippingSideProperty	Returns the shader property name used to control the clipping side.
IsDirty	Keeping track of any field, property or transformation changes to optimize material property block setting. (Inherited from ClippingPrimitive)
Keyword	Returns the shader keyword name used to toggle this clipping feature on/off.
UseOnPreRender	Toggles whether the primitive will use the Camera OnPreRender event. (Inherited from ClippingPrimitive)

Methods

AddRenderer(Renderer)	Adds a renderer to the list of objects this clipping primitive clips. (Inherited from ClippingPrimitive)
BeginUpdateShaderProperties()	Method called when before each renderer is updated.
ClearRenderers(Boolean)	Removes all renderers in the list of objects this clipping primitive clips. (Inherited from ClippingPrimitive)
EditorUpdate()	(Inherited from ClippingPrimitive)
EndUpdateShaderProperties()	Method called when after each renderer is updated. (Inherited from ClippingPrimitive)
GetRenderersCopy()	Returns a copy of the current list of renderers. (Inherited from ClippingPrimitive)
Initialize()	Caches commonly used state.
LateUpdate()	Updates all renderers with latest clipping state. (Inherited from ClippingPrimitive)
OnCameraPreRender(CameraEventRouter)	Updates all renderers with latest clipping state. (Inherited from ClippingPrimitive)
OnDestroy()	Removes all renderers from the clipping primitive. (Inherited from ClippingPrimitive)
OnDisable()	Turns clipping off. (Inherited from ClippingPrimitive)
OnDrawGizmosSelected()	Renders a visual representation of the clipping primitive when selected.
OnEnable()	Turns clipping on. (Inherited from ClippingPrimitive)
OnMaterialChanged(MaterialInstance)	Method which is invoked by a MaterialInstance when an external material change is detected. This normally occurs when materials are changed via Renderer.material, Renderer.materials, or via the editor. (Inherited from ClippingPrimitive)
RemoveRenderer(Renderer)	Removes a renderer to the list of objects this clipping primitive clips. (Inherited from ClippingPrimitive)
ToggleClippingFeature(Boolean)	Enables or disables clipping for all renderers. (Inherited from ClippingPrimitive)
ToggleClippingFeature(Material, Boolean)	Enables or disables clipping on a material. (Inherited from ClippingPrimitive)
ToggleClippingFeature(Material[], Boolean)	Enables or disables clipping for a list of materials. (Inherited from ClippingPrimitive)
UpdateRenderers()	Updates the render state of all renderers. (Inherited from ClippingPrimitive)
UpdateShaderProperties(MaterialPropertyBlock)	Method called for each renderer.