Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    Scene Class

    Namespace: Stride.Engine
    Assembly: Stride.Engine.dll

    A scene.

    System.Object → DisposeBase → ComponentBase → Scene
    Derived from Scene:

    [DataContract("Scene")]
    [ContentSerializer(typeof(DataContentSerializerWithReuse<Scene>))]
    [DataSerializerGlobal(typeof(ReferenceSerializer<Scene>), null, DataSerializerGenericMode.None, false, false, Profile = "Content")]
    public sealed class Scene : ComponentBase, IDisposable, IComponent, IReferencable, ICollectorHolder, IIdentifiable
    Name Description
    Constructors
    Scene()

    Initializes a new instance of the Scene class.

    Fields
    Offset

    An offset applied to all entities of the scene relative to it's parent scene.

    WorldMatrix

    The absolute transform applied to all entities of the scene.

    Properties
    Children

    The child scenes.

    Entities

    The entities.

    Id
    Parent

    The parent scene.

    Methods
    ToString()
    UpdateWorldMatrix()

    Updates the world transform of the scene.

    | Improve this Doc View Source

    Constructors


    Scene()

    Initializes a new instance of the Scene class.

    public Scene()
    | Improve this Doc View Source

    Fields


    Offset

    An offset applied to all entities of the scene relative to it's parent scene.

    public Vector3 Offset
    Field Value
    Type Description
    Vector3

    WorldMatrix

    The absolute transform applied to all entities of the scene.

    public Matrix WorldMatrix
    Field Value
    Type Description
    Matrix
    Remarks

    This field is overwritten by the transform processor each frame.

    | Improve this Doc View Source

    Properties


    Children

    The child scenes.

    public TrackingCollection<Scene> Children { get; }
    Property Value
    Type Description
    TrackingCollection<Scene>

    Entities

    The entities.

    public TrackingCollection<Entity> Entities { get; }
    Property Value
    Type Description
    TrackingCollection<Entity>

    Id

    [DataMember(-10)]
    [Display(null, null, Browsable = false)]
    public Guid Id { get; set; }
    Property Value
    Type Description
    System.Guid

    Parent

    The parent scene.

    public Scene Parent { get; set; }
    Property Value
    Type Description
    Scene
    | Improve this Doc View Source

    Methods


    ToString()

    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    ComponentBase.ToString()

    UpdateWorldMatrix()

    Updates the world transform of the scene.

    public void UpdateWorldMatrix()

    Inherited Members

    ComponentBase.Tags
    ComponentBase.Name
    ComponentBase.Destroy()
    ComponentBase.ICollectorHolder.Collector
    ComponentBase.OnNameChanged()
    DisposeBase.Dispose()
    DisposeBase.IsDisposed
    DisposeBase.IReferencable.ReferenceCount
    DisposeBase.IReferencable.AddReference()
    DisposeBase.IReferencable.Release()
    DisposeBase.OnAddReference()
    DisposeBase.OnReleaseReference()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation