docs.unity3d.com
    Show / Hide Table of Contents

    Class Artifact

    Inheritance
    Object
    Artifact
    Artifact<T>
    Inherited Members
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Muse.Common
    Syntax
    [Serializable]
    public abstract class Artifact : IEquatable<Artifact>

    Constructors

    Artifact(String, UInt32)

    Declaration
    protected Artifact(string guid, uint seed)
    Parameters
    Type Name Description
    String guid
    UInt32 seed

    Fields

    Guid

    Declaration
    [SerializeField]
    public string Guid
    Field Value
    Type Description
    String

    history

    Declaration
    [SerializeReference]
    public List<Artifact> history
    Field Value
    Type Description
    List<Artifact>

    k_InvalidGUID

    Declaration
    public static readonly string k_InvalidGUID
    Field Value
    Type Description
    String

    m_Operators

    Declaration
    [SerializeReference]
    protected List<IOperator> m_Operators
    Field Value
    Type Description
    List<IOperator>

    OnGenerationDone

    Declaration
    public Artifact.ArtifactGenerationDelegate OnGenerationDone
    Field Value
    Type Description
    Artifact.ArtifactGenerationDelegate

    Seed

    Declaration
    [SerializeField]
    public uint Seed
    Field Value
    Type Description
    UInt32

    Methods

    Clone(String)

    Declaration
    public virtual Artifact Clone(string mode)
    Parameters
    Type Name Description
    String mode
    Returns
    Type Description
    Artifact

    CloneOperators(IEnumerable<IOperator>)

    Clone the given operators, or if null, this artifact's operators.

    Declaration
    public List<IOperator> CloneOperators(IEnumerable<IOperator> operators = null)
    Parameters
    Type Name Description
    IEnumerable<IOperator> operators

    The operators to clone.

    Returns
    Type Description
    List<IOperator>

    The cloned operators.

    CreateCanvasView()

    Declaration
    public virtual ArtifactView CreateCanvasView()
    Returns
    Type Description
    ArtifactView

    CreateView()

    Declaration
    public abstract ArtifactView CreateView()
    Returns
    Type Description
    ArtifactView

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    Object.Equals(Object)

    Equals(Artifact)

    Declaration
    public bool Equals(Artifact other)
    Parameters
    Type Name Description
    Artifact other
    Returns
    Type Description
    Boolean
    Implements
    IEquatable<T>.Equals(T)

    Generate(Model)

    Declaration
    public abstract void Generate(Model model)
    Parameters
    Type Name Description
    Model model

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    Object.GetHashCode()

    GetOperators()

    Declaration
    public List<IOperator> GetOperators()
    Returns
    Type Description
    List<IOperator>

    GetPreview(Artifact.ArtifactPreviewDelegate, Boolean)

    Declaration
    public abstract void GetPreview(Artifact.ArtifactPreviewDelegate onDoneCallback, bool useCache)
    Parameters
    Type Name Description
    Artifact.ArtifactPreviewDelegate onDoneCallback
    Boolean useCache

    RegisterToEvents(Model)

    Declaration
    public void RegisterToEvents(Model model)
    Parameters
    Type Name Description
    Model model

    RetryGenerate(Model)

    Declaration
    public abstract void RetryGenerate(Model model)
    Parameters
    Type Name Description
    Model model

    SetOperators(IEnumerable<IOperator>)

    Declaration
    public void SetOperators(IEnumerable<IOperator> operators)
    Parameters
    Type Name Description
    IEnumerable<IOperator> operators

    StartGenerate(Model)

    Only called once for a generation group

    Declaration
    public virtual void StartGenerate(Model model)
    Parameters
    Type Name Description
    Model model

    Model used.

    UnregisterFromEvents(Model)

    Declaration
    public void UnregisterFromEvents(Model model)
    Parameters
    Type Name Description
    Model model

    Variate(List<IOperator>)

    Declaration
    public virtual void Variate(List<IOperator> ops)
    Parameters
    Type Name Description
    List<IOperator> ops

    Operators

    Equality(Artifact, Artifact)

    Declaration
    public static bool operator ==(Artifact lhs, Artifact rhs)
    Parameters
    Type Name Description
    Artifact lhs
    Artifact rhs
    Returns
    Type Description
    Boolean

    Inequality(Artifact, Artifact)

    Declaration
    public static bool operator !=(Artifact lhs, Artifact rhs)
    Parameters
    Type Name Description
    Artifact lhs
    Artifact rhs
    Returns
    Type Description
    Boolean

    Extension Methods

    ArtifactExtensions.IsValid(Artifact)
    ArtifactExtension.GetOperator<T>(Artifact)
    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