ClippingPlane Class

Definition

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

public ref class ClippingPlane : Microsoft::MixedReality::Toolkit::Utilities::ClippingPrimitive
[UnityEngine.AddComponentMenu("Scripts/MRTK/Core/ClippingPlane")]
[UnityEngine.ExecuteInEditMode]
public class ClippingPlane : Microsoft.MixedReality.Toolkit.Utilities.ClippingPrimitive
[<UnityEngine.AddComponentMenu("Scripts/MRTK/Core/ClippingPlane")>]
[<UnityEngine.ExecuteInEditMode>]
type ClippingPlane = class
    inherit ClippingPrimitive
Public Class ClippingPlane
Inherits ClippingPrimitive
Inheritance
UnityEngine.MonoBehaviour
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 (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

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

(Inherited from ClippingPrimitive)
ClippingSideProperty UnityEngine.MonoBehaviour.ClippingSideProperty
IsDirty

Keeping track of any field, property or transformation changes to optimize material property block setting.

(Inherited from ClippingPrimitive)
Keyword UnityEngine.MonoBehaviour.Keyword
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()
BeginUpdateShaderProperties() (Inherited from ClippingPrimitive)
ClearRenderers()

Removes all renderers in the list of objects this clipping primitive clips.

(Inherited from ClippingPrimitive)
ClearRenderers(Boolean)

Removes all renderers in the list of objects this clipping primitive clips.

(Inherited from ClippingPrimitive)
EditorUpdate() (Inherited from ClippingPrimitive)
EndUpdateShaderProperties() (Inherited from ClippingPrimitive)
GetRenderersCopy()

Returns a copy of the current list of renderers.

(Inherited from ClippingPrimitive)
Initialize() UnityEngine.MonoBehaviour.Initialize
LateUpdate() (Inherited from ClippingPrimitive)
OnCameraPreRender(CameraEventRouter) (Inherited from ClippingPrimitive)
OnDestroy() (Inherited from ClippingPrimitive)
OnDisable() (Inherited from ClippingPrimitive)
OnDrawGizmosSelected()

Renders a visual representation of the clipping primitive when selected.

OnEnable() (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) (Inherited from ClippingPrimitive)
ToggleClippingFeature(Material, Boolean) (Inherited from ClippingPrimitive)
ToggleClippingFeature(Material[], Boolean) (Inherited from ClippingPrimitive)
Update() (Inherited from ClippingPrimitive)
UpdateRenderers() (Inherited from ClippingPrimitive)
UpdateShaderProperties(MaterialPropertyBlock)

Applies to