docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class GltfEntityAsset

    Loads a glTF from a MonoBehaviour but instantiates Entities. Intermediate solution and drop-in replacement for GltfAsset TODO: To be replaced with a pure ECS concept

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    GltfAssetBase
    GltfEntityAsset
    Inherited Members
    GltfAssetBase.ImportSettings
    GltfAssetBase.Importer
    GltfAssetBase.IsDone
    GltfAssetBase.CurrentSceneId
    GltfAssetBase.Instantiate(ICodeLogger)
    GltfAssetBase.InstantiateScene(int, ICodeLogger)
    GltfAssetBase.InstantiateScene(int, GameObjectInstantiator)
    GltfAssetBase.GetMaterial(int)
    GltfAssetBase.SceneCount
    GltfAssetBase.SceneNames
    GltfAssetBase.Dispose()
    GltfAssetBase.OnDestroy()
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    object.MemberwiseClone()
    Namespace: GLTFast
    Assembly: solution.dll
    Syntax
    [BurstCompile]
    public class GltfEntityAsset : GltfAssetBase

    Properties

    FullUrl

    Declaration
    public string FullUrl { get; }
    Property Value
    Type Description
    string

    InstantiationSettings

    Instantiation settings

    Declaration
    public InstantiationSettings InstantiationSettings { get; set; }
    Property Value
    Type Description
    InstantiationSettings

    LoadOnStartup

    Automatically load at start

    Declaration
    public bool LoadOnStartup { get; set; }
    Property Value
    Type Description
    bool

    SceneId

    Scene to load (-1 loads glTFs default scene)

    Declaration
    protected int SceneId { get; }
    Property Value
    Type Description
    int

    StreamingAsset

    If true, url is treated as relative StreamingAssets path

    Declaration
    public bool StreamingAsset { get; }
    Property Value
    Type Description
    bool

    Url

    Declaration
    public string Url { get; }
    Property Value
    Type Description
    string

    Methods

    ClearScenes()

    Removes previously instantiated scene(s)

    Declaration
    public override void ClearScenes()
    Overrides
    GltfAssetBase.ClearScenes()

    GetDefaultInstantiator(ICodeLogger)

    Returns an instance of the default instantiator

    Declaration
    protected override IInstantiator GetDefaultInstantiator(ICodeLogger logger)
    Parameters
    Type Name Description
    ICodeLogger logger

    Custom logger to use with the instantiator

    Returns
    Type Description
    IInstantiator

    Default instantiator instance

    Overrides
    GltfAssetBase.GetDefaultInstantiator(ICodeLogger)

    Load(string, IDownloadProvider, IDeferAgent, IMaterialGenerator, ICodeLogger)

    Method for manual loading with custom IDownloadProvider and IDeferAgent.

    Declaration
    public override Task<bool> Load(string gltfUrl, IDownloadProvider downloadProvider = null, IDeferAgent deferAgent = null, IMaterialGenerator materialGenerator = null, ICodeLogger logger = null)
    Parameters
    Type Name Description
    string gltfUrl

    URL of the glTF file.

    IDownloadProvider downloadProvider

    Download Provider for custom loading (e.g. caching or HTTP authorization)

    IDeferAgent deferAgent

    Defer Agent takes care of interrupting the loading procedure in order to keep the frame rate responsive.

    IMaterialGenerator materialGenerator

    Used to convert glTF materials to Material instances

    ICodeLogger logger

    Used for message reporting

    Returns
    Type Description
    Task<bool>

    Async Task that loads the glTF's contents

    Overrides
    GltfAssetBase.Load(string, IDownloadProvider, IDeferAgent, IMaterialGenerator, ICodeLogger)

    PostInstantiation(IInstantiator, bool)

    Callback that is called after instantiation

    Declaration
    protected override void PostInstantiation(IInstantiator instantiator, bool success)
    Parameters
    Type Name Description
    IInstantiator instantiator

    instantiator that was used

    bool success

    True if instantiation was successful, false otherwise

    Overrides
    GltfAssetBase.PostInstantiation(IInstantiator, bool)

    Start()

    Declaration
    protected virtual void Start()
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)