UxrPlanarReflectionBrp Class

Component that renders a planar reflection image of the scene on an object, using the built-in render pipeline:  

  • If the Mirror Transform is not set, it will use the transform on the component’s GameObject.
  • The component requires a Renderer on the same GameObject with a material compatible with the BRP planar reflection. They can be found in the UltimateXR/FX/ category.
  • The mirror normal is determined by the -forward axis of Mirror Transform.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Rendering.FX.UxrPlanarReflectionBrp
Namespace: UltimateXR.Rendering.FX
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

[ExecuteInEditMode]
public class UxrPlanarReflectionBrp : UxrComponent


The UxrPlanarReflectionBrp type exposes the following members.

Constructors

NameDescription
Public methodUxrPlanarReflectionBrp

Methods

NameDescription
Protected methodOnDisable Frees the allocated resources. (Overrides UxrComponent.OnDisable().)

Extension Methods

NameDescription
Public Extension MethodCheckSetEnabled Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
Public Extension MethodGetOrAddComponent<T> Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
Public Extension MethodGetPathUnderScene Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
Public Extension MethodGetSceneUid Gets an unique identifier string for the given component. (Defined by ComponentExt.)
Public Extension MethodGetUniqueScenePath Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.)
Public Extension MethodLoopCoroutine Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
Public Extension MethodSafeGetComponentInParent<T> Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.)
Public Extension MethodShowInInspector(Boolean)Overloaded.
Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
Public Extension MethodShowInInspector(Boolean, Boolean)Overloaded.
Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.Rendering.FX Namespace