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
| Name | Description | |
|---|---|---|
 | UxrPlanarReflectionBrp |
Methods
| Name | Description | |
|---|---|---|
 | OnDisable | Frees the allocated resources. (Overrides UxrComponent.OnDisable().) |
Extension Methods
| Name | Description | |
|---|---|---|
 | CheckSetEnabled | Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.) |
| GetOrAddComponent<T> | Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.) |
| GetPathUnderScene | Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.) |
| GetSceneUid | Gets an unique identifier string for the given component. (Defined by ComponentExt.) |
| GetUniqueScenePath | 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.) |
| LoopCoroutine | Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.) |
| SafeGetComponentInParent<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.) |
| ShowInInspector(Boolean) | Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.) |
| ShowInInspector(Boolean, Boolean) | Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.) |
| ThrowIfNull | Throws an exception if the object is null. (Defined by ObjectExt.) |