Search Results for

    Show / Hide Table of Contents

    Class EnvironmentProbe

    Environment Probe can capture space around the objects to provide reflections.

    Inheritance
    System.Object
    Object
    SceneObject
    Actor
    EnvironmentProbe
    Implements
    ISerializable
    Inherited Members
    Actor.SetLayerRecursive(Int32)
    Actor.SetLayerNameRecursive(String)
    Actor.HasTag()
    Actor.HasTag(Tag)
    Actor.HasTag(String)
    Actor.AddTag(Tag)
    Actor.AddTagRecursive(Tag)
    Actor.RemoveTag(Tag)
    Actor.SetParent(Actor, Boolean, Boolean)
    Actor.GetChild(Int32)
    Actor.GetChild(String)
    Actor.GetChild(Type)
    Actor.GetChildren(Type)
    Actor.DestroyChildren(Single)
    Actor.GetScript(Int32)
    Actor.GetScript(Type)
    Actor.GetScripts(Type)
    Actor.AddMovement(Vector3)
    Actor.AddMovement(Vector3, Quaternion)
    Actor.GetWorldToLocalMatrix(Matrix)
    Actor.GetLocalToWorldMatrix(Matrix)
    Actor.OnDebugDraw()
    Actor.OnDebugDrawSelected()
    Actor.GetPrefabRoot()
    Actor.FindActor(String)
    Actor.FindActor(Type, Boolean)
    Actor.FindActor(Type, String)
    Actor.FindActor(Type, Tag, Boolean)
    Actor.FindScript(Type)
    Actor.HasActorInHierarchy(Actor)
    Actor.HasActorInChildren(Actor)
    Actor.IntersectsItself(Ray, Single, Vector3)
    Actor.Intersects(Ray, Single, Vector3)
    Actor.LookAt(Vector3)
    Actor.LookAt(Vector3, Vector3)
    Actor.LookingAt(Vector3)
    Actor.LookingAt(Vector3, Vector3)
    Actor.ToBytes(Actor[])
    Actor.FromBytes(Byte[])
    Actor.FromBytes(Byte[], Dictionary<Guid, Guid>)
    Actor.TryGetSerializedObjectsIds(Byte[])
    Actor.ToJson()
    Actor.FromJson(String)
    Actor.Clone()
    Actor.OnEnable()
    Actor.OnDisable()
    Actor.OnParentChanged()
    Actor.OnTransformChanged()
    Actor.OnActiveChanged()
    Actor.OnActiveInTreeChanged()
    Actor.OnOrderInParentChanged()
    Actor.OnStaticFlagsChanged()
    Actor.OnLayerChanged()
    Actor.OnBeginPlay()
    Actor.OnEndPlay()
    Actor.AddStaticFlags(StaticFlags)
    Actor.RemoveStaticFlags(StaticFlags)
    Actor.SetStaticFlag(StaticFlags, Boolean)
    Actor.HasStaticFlag(StaticFlags)
    Actor.ResetLocalTransform()
    Actor.AddChild(Type)
    Actor.AddChild<T>()
    Actor.GetChild<T>()
    Actor.TryGetChild<T>(T)
    Actor.GetOrAddChild<T>()
    Actor.AddScript(Type)
    Actor.AddScript<T>()
    Actor.GetScript<T>()
    Actor.TryGetScript<T>(T)
    Actor.FindScript<T>()
    Actor.FindActor<T>(Boolean)
    Actor.FindActor<T>(String)
    Actor.FindActor<T>(Tag, Boolean)
    Actor.GetChildren<T>()
    Actor.GetScripts<T>()
    Actor.RotateAround(Vector3, Vector3, Single, Boolean)
    Actor.ToString()
    Actor.Children
    Actor.Tags
    Actor.Layer
    Actor.Name
    Actor.IsActive
    Actor.StaticFlags
    Actor.PerInstanceRandom
    Actor.LocalPosition
    Actor.LocalOrientation
    Actor.LocalScale
    Actor.Sphere
    Actor.Box
    Actor.BoxWithChildren
    Actor.EditorBox
    Actor.EditorBoxChildren
    Actor.HasContentLoaded
    Actor.IsPrefabRoot
    Actor.IsStatic
    Actor.IsTransformStatic
    Actor.WorldToLocalMatrix
    Actor.LocalToWorldMatrix
    SceneObject.SetParent(Actor, Boolean)
    SceneObject.LinkPrefab(Guid, Guid)
    SceneObject.BreakPrefabLink()
    SceneObject.GetNamePath(Char)
    SceneObject.IsDuringPlay
    SceneObject.HasParent
    SceneObject.HasPrefabLink
    SceneObject.PrefabID
    SceneObject.PrefabObjectID
    Object.__unmanagedPtr
    Object.__internalId
    Object.Finalize()
    Object.As<T>()
    Object.NewValue(Type)
    Object.New(String)
    Object.Find<T>(Guid, Boolean)
    Object.Find(Guid, Type, Boolean)
    Object.TryFind<T>(Guid)
    Object.TryFind(Guid, Type)
    Object.Destroy(Object, Single)
    Object.DestroyNow(Object)
    Object.Destroy<T>(T, Single)
    Object.Equals(Object)
    Object.GetUnmanagedPtr(Object)
    Object.GetUnmanagedInterface(Object, Type)
    Object.FromUnmanagedPtr(IntPtr)
    Object.MapObjectID(Guid)
    Object.RemapObjectID(Guid)
    Object.GetHashCode()
    Object.ID
    Object.TypeName
    Namespace: FlaxEngine
    Assembly: FlaxEngine.CSharp.dll
    Syntax
    [ActorContextMenu("New/Visuals/Lighting & PostFX/Environment Probe")]
    [ActorToolbox("Visuals")]
    [Unmanaged]
    public class EnvironmentProbe : Actor, ISerializable

    Constructors

    EnvironmentProbe()

    Initializes a new instance of the EnvironmentProbe.

    Declaration
    public EnvironmentProbe()

    Properties

    Brightness

    The reflections brightness.

    Declaration
    [EditorOrder(10)]
    [Limit(0F, 1000F, 0.01F)]
    [EditorDisplay("Probe", null)]
    [Unmanaged]
    public float Brightness { get; set; }
    Property Value
    System.Single

    CaptureNearPlane

    The probe capture camera near plane distance.

    Declaration
    [EditorOrder(30)]
    [Limit(0F, 3.40282347E+38F, 0.01F)]
    [EditorDisplay("Probe", null)]
    [Unmanaged]
    public float CaptureNearPlane { get; set; }
    Property Value
    System.Single

    CubemapResolution

    The reflections texture resolution.

    Declaration
    [EditorOrder(0)]
    [EditorDisplay("Probe", null)]
    [Unmanaged]
    public ProbeCubemapResolution CubemapResolution { get; set; }
    Property Value
    ProbeCubemapResolution

    CustomProbe

    Gets or sets the custom probe (null if using baked one or none).

    Declaration
    [EditorOrder(40)]
    [EditorDisplay("Probe", null)]
    [Unmanaged]
    public CubeTexture CustomProbe { get; set; }
    Property Value
    CubeTexture

    IsUsingCustomProbe

    True if probe is using custom cube texture (not baked).

    Declaration
    [Unmanaged]
    public bool IsUsingCustomProbe { get; }
    Property Value
    System.Boolean

    Probe

    Gets the probe texture used during rendering (baked or custom one).

    Declaration
    [Unmanaged]
    public GPUTexture Probe { get; }
    Property Value
    GPUTexture

    Radius

    Gets or sets the probe radius.

    Declaration
    [EditorOrder(20)]
    [Limit(0F, 3.40282347E+38F, 1F)]
    [EditorDisplay("Probe", null)]
    [Unmanaged]
    public float Radius { get; set; }
    Property Value
    System.Single

    ScaledRadius

    Gets probe scaled radius.

    Declaration
    [Unmanaged]
    public float ScaledRadius { get; }
    Property Value
    System.Single

    UpdateMode

    The probe update mode.

    Declaration
    [EditorOrder(30)]
    [EditorDisplay("Probe", null)]
    [Unmanaged]
    public EnvironmentProbe.ProbeUpdateMode UpdateMode { get; set; }
    Property Value
    EnvironmentProbe.ProbeUpdateMode

    Methods

    Bake(Single)

    Bakes that probe. It won't be performed now but on async graphics rendering task.

    Declaration
    [Unmanaged]
    public void Bake(float timeout = 0F)
    Parameters
    System.Single timeout

    The timeout in seconds left to bake it (aka startup time).

    Extension Methods

    Extensions.ReflectiveCompare<T>(T, T)
    Extensions.DeepClone<T>(T)
    Extensions.RawClone<T>(T)
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat