Class VFXGizmo | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class VFXGizmo

    Inheritance
    System.Object
    VFXGizmo
    VFXGizmo<T>
    Namespace: UnityEditor.VFX
    Syntax
    public abstract class VFXGizmo

    Fields

    arcHandleSizeMultiplier

    Declaration
    protected const float arcHandleSizeMultiplier = 1.25F
    Field Value
    Type Description
    System.Single

    handleSize

    Declaration
    protected const float handleSize = 0.1F
    Field Value
    Type Description
    System.Single

    Properties

    component

    Declaration
    public VisualEffect component { get; set; }
    Property Value
    Type Description
    VisualEffect

    currentSpace

    Declaration
    public VFXCoordinateSpace currentSpace { get; set; }
    Property Value
    Type Description
    VFXCoordinateSpace

    needsComponent

    Declaration
    public virtual bool needsComponent { get; }
    Property Value
    Type Description
    System.Boolean

    spaceLocalByDefault

    Declaration
    public bool spaceLocalByDefault { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    ArcGizmo(Vector3, Single, Single, VFXGizmo.IProperty<Single>, Quaternion, Boolean)

    Declaration
    public bool ArcGizmo(Vector3 center, float radius, float degArc, VFXGizmo.IProperty<float> arcProperty, Quaternion rotation, bool always)
    Parameters
    Type Name Description
    Vector3 center
    System.Single radius
    System.Single degArc
    VFXGizmo.IProperty<System.Single> arcProperty
    Quaternion rotation
    System.Boolean always
    Returns
    Type Description
    System.Boolean

    CallDrawGizmo(Object)

    Declaration
    public abstract void CallDrawGizmo(object value)
    Parameters
    Type Name Description
    System.Object value

    CallGetGizmoBounds(Object)

    Declaration
    public abstract Bounds CallGetGizmoBounds(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    Bounds

    DefaultAngleHandleDrawFunction(Int32, Vector3, Quaternion, Single, EventType)

    Declaration
    public static void DefaultAngleHandleDrawFunction(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
    Parameters
    Type Name Description
    System.Int32 controlID
    Vector3 position
    Quaternion rotation
    System.Single size
    EventType eventType

    NormalGizmo(Vector3, ref Vector3, Boolean)

    Declaration
    public bool NormalGizmo(Vector3 position, ref Vector3 normal, bool always)
    Parameters
    Type Name Description
    Vector3 position
    Vector3 normal
    System.Boolean always
    Returns
    Type Description
    System.Boolean

    PositionGizmo(Vector3, VFXGizmo.IProperty<Vector3>, Boolean)

    Declaration
    public bool PositionGizmo(Vector3 position, VFXGizmo.IProperty<Vector3> positionProperty, bool always)
    Parameters
    Type Name Description
    Vector3 position
    VFXGizmo.IProperty<Vector3> positionProperty
    System.Boolean always
    Returns
    Type Description
    System.Boolean

    PositionGizmo(ref Vector3, Boolean)

    Declaration
    public bool PositionGizmo(ref Vector3 position, bool always)
    Parameters
    Type Name Description
    Vector3 position
    System.Boolean always
    Returns
    Type Description
    System.Boolean

    RegisterEditableMembers(VFXGizmo.IContext)

    Declaration
    public abstract void RegisterEditableMembers(VFXGizmo.IContext context)
    Parameters
    Type Name Description
    VFXGizmo.IContext context

    RotationGizmo(Vector3, ref Quaternion, Boolean)

    Declaration
    public bool RotationGizmo(Vector3 position, ref Quaternion rotation, bool always)
    Parameters
    Type Name Description
    Vector3 position
    Quaternion rotation
    System.Boolean always
    Returns
    Type Description
    System.Boolean

    RotationGizmo(Vector3, Vector3, VFXGizmo.IProperty<Vector3>, Boolean)

    Declaration
    public bool RotationGizmo(Vector3 position, Vector3 rotation, VFXGizmo.IProperty<Vector3> anglesProperty, bool always)
    Parameters
    Type Name Description
    Vector3 position
    Vector3 rotation
    VFXGizmo.IProperty<Vector3> anglesProperty
    System.Boolean always
    Returns
    Type Description
    System.Boolean

    RotationGizmo(Vector3, ref Vector3, Boolean)

    Declaration
    public bool RotationGizmo(Vector3 position, ref Vector3 rotation, bool always)
    Parameters
    Type Name Description
    Vector3 position
    Vector3 rotation
    System.Boolean always
    Returns
    Type Description
    System.Boolean

    ScaleGizmo(Vector3, Vector3, Quaternion, VFXGizmo.IProperty<Vector3>, Boolean)

    Declaration
    public bool ScaleGizmo(Vector3 position, Vector3 scale, Quaternion rotation, VFXGizmo.IProperty<Vector3> scaleProperty, bool always)
    Parameters
    Type Name Description
    Vector3 position
    Vector3 scale
    Quaternion rotation
    VFXGizmo.IProperty<Vector3> scaleProperty
    System.Boolean always
    Returns
    Type Description
    System.Boolean

    ScaleGizmo(Vector3, ref Vector3, Quaternion, Boolean)

    Declaration
    public bool ScaleGizmo(Vector3 position, ref Vector3 scale, Quaternion rotation, bool always)
    Parameters
    Type Name Description
    Vector3 position
    Vector3 scale
    Quaternion rotation
    System.Boolean always
    Returns
    Type Description
    System.Boolean
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023