mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class ClippingSphere

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

    Inheritance
    Object
    ClippingPrimitive
    ClippingSphere
    Implements
    IMaterialInstanceOwner
    MonoBehaviour
    Inherited Members
    ClippingPrimitive.renderers
    ClippingPrimitive.clippingSide
    ClippingPrimitive.ClippingSide
    ClippingPrimitive.UseOnPreRender
    ClippingPrimitive.materialPropertyBlock
    ClippingPrimitive.AddRenderer(Renderer)
    ClippingPrimitive.RemoveRenderer(Renderer)
    ClippingPrimitive.ClearRenderers()
    ClippingPrimitive.GetRenderersCopy()
    ClippingPrimitive.OnEnable()
    ClippingPrimitive.OnDisable()
    ClippingPrimitive.LateUpdate()
    ClippingPrimitive.OnCameraPreRender(CameraEventRouter)
    ClippingPrimitive.OnDestroy()
    ClippingPrimitive.OnMaterialChanged(MaterialInstance)
    ClippingPrimitive.UpdateRenderers()
    ClippingPrimitive.ToggleClippingFeature(Boolean)
    ClippingPrimitive.ToggleClippingFeature(Material[], Boolean)
    ClippingPrimitive.ToggleClippingFeature(Material, Boolean)
    Namespace: Microsoft.MixedReality.Toolkit.Utilities
    Assembly: cs.temp.dll.dll
    Syntax
    public class ClippingSphere : ClippingPrimitive, IMaterialInstanceOwner, MonoBehaviour

    Fields

    clipSphereID

    The property name of the clip sphere data within the shader.

    Declaration
    protected int clipSphereID
    Field Value
    Type Description
    Int32

    Properties

    ClippingSideProperty

    Declaration
    protected override string ClippingSideProperty { get; }
    Property Value
    Type Description
    String
    Overrides
    ClippingPrimitive.ClippingSideProperty

    ClippingSideProperty

    Declaration
    protected override string ClippingSideProperty { get; }
    Property Value
    Type Description
    String
    Overrides
    ClippingPrimitive.ClippingSideProperty

    Keyword

    Declaration
    protected override string Keyword { get; }
    Property Value
    Type Description
    String
    Overrides
    ClippingPrimitive.Keyword

    Keyword

    Declaration
    protected override string Keyword { get; }
    Property Value
    Type Description
    String
    Overrides
    ClippingPrimitive.Keyword

    Radius

    The radius of the clipping sphere, which is determined by the largest axis of the transform's scale.

    Declaration
    public float Radius { get; }
    Property Value
    Type Description
    Single

    Radius

    The radius of the clipping sphere, which is determined by the largest axis of the transform's scale.

    Declaration
    public float Radius { get; }
    Property Value
    Type Description
    Single

    Methods

    Initialize()

    Declaration
    protected override void Initialize()
    Overrides
    ClippingPrimitive.Initialize()

    Initialize()

    Declaration
    protected override void Initialize()
    Overrides
    ClippingPrimitive.Initialize()

    OnDrawGizmosSelected()

    Renders a visual representation of the clipping primitive when selected.

    Declaration
    protected void OnDrawGizmosSelected()

    UpdateShaderProperties(MaterialPropertyBlock)

    Declaration
    protected override void UpdateShaderProperties(MaterialPropertyBlock materialPropertyBlock)
    Parameters
    Type Name Description
    MaterialPropertyBlock materialPropertyBlock
    Overrides
    ClippingPrimitive.UpdateShaderProperties(MaterialPropertyBlock)

    UpdateShaderProperties(MaterialPropertyBlock)

    Declaration
    protected override void UpdateShaderProperties(MaterialPropertyBlock materialPropertyBlock)
    Parameters
    Type Name Description
    MaterialPropertyBlock materialPropertyBlock
    Overrides
    ClippingPrimitive.UpdateShaderProperties(MaterialPropertyBlock)

    Implements

    IMaterialInstanceOwner
    MonoBehaviour
    In This Article
    • Fields
      • clipSphereID
    • Properties
      • ClippingSideProperty
      • ClippingSideProperty
      • Keyword
      • Keyword
      • Radius
      • Radius
    • Methods
      • Initialize()
      • Initialize()
      • OnDrawGizmosSelected()
      • UpdateShaderProperties(MaterialPropertyBlock)
      • UpdateShaderProperties(MaterialPropertyBlock)
    • Implements
    Back to top Generated by DocFX