ClippingBox Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Utilities

Assembly:: Microsoft.MixedReality.Toolkit.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class ClippingBox : Microsoft::MixedReality::Toolkit::Utilities::ClippingPrimitive

[UnityEngine.AddComponentMenu("Scripts/MRTK/Core/ClippingBox")]
[UnityEngine.ExecuteInEditMode]
public class ClippingBox : Microsoft.MixedReality.Toolkit.Utilities.ClippingPrimitive

[<UnityEngine.AddComponentMenu("Scripts/MRTK/Core/ClippingBox")>]
[<UnityEngine.ExecuteInEditMode>]
type ClippingBox = class
    inherit ClippingPrimitive

Public Class ClippingBox
Inherits ClippingPrimitive

Inheritance: UnityEngine.MonoBehaviour

ClippingPrimitive
ClippingBox

Attributes: UnityEngine.AddComponentMenuAttribute UnityEngine.ExecuteInEditModeAttribute

Constructors

ClippingBox()

Fields

clipBoxInverseTransformID	The property name of the clip box inverse transformation matrix within the shader.
clipBoxSizeID	The property name of the clip box data within the shader.
clippingSide	(Inherited from ClippingPrimitive)
materialPropertyBlock	(Inherited from ClippingPrimitive)
rendererDict	The renderer(s) that should be affected by the primitive. (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)
CacheSharedMaterialsFromRenderer	Whether to let managed MaterialInstances use a cached copy of cachedRenderer.sharedMaterials or call sharedMaterials on the Renderer directly. Enabling the option will lead to better performance but you must turn it off before modifying sharedMaterials of the Renderer. (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)
Awake()	(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, Boolean)	Removes a renderer from the list of objects this clipping primitive clips. (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

Share via