Search Results for

    Show / Hide Table of Contents

    Class EntityItemModel

    Entity Model class.

    Inheritance
    object
    SceneItemModel
    EntityItemModel
    Inherited Members
    SceneItemModel.PropertySeparator
    SceneItemModel.id
    SceneItemModel.entity
    SceneItemModel.Recreated
    SceneItemModel.Id
    SceneItemModel.Entity
    SceneItemModel.EntityPath
    SceneItemModel.State
    SceneItemModel.IsEntityRecreated
    SceneItemModel.DefaultValues()
    SceneItemModel.GetSceneItem(Entity)
    Namespace: Evergine.Framework.Assets.AssetSources.Entities
    Assembly: Evergine.Framework.dll
    Syntax
    public class EntityItemModel : SceneItemModel

    Constructors

    EntityItemModel()

    Initializes a new instance of the EntityItemModel class.

    Declaration
    public EntityItemModel()

    EntityItemModel(Entity, bool)

    Initializes a new instance of the EntityItemModel class.

    Declaration
    public EntityItemModel(Entity entity, bool maintainPrefabs = true)
    Parameters
    Type Name Description
    Entity entity

    the entity.

    bool maintainPrefabs

    If the prefab instances should be preserved or flattened to entities.

    Fields

    isEnabled

    If the entity is enabled.

    Declaration
    protected bool isEnabled
    Field Value
    Type Description
    bool

    isSerializable

    If the entity is serializable.

    Declaration
    protected bool isSerializable
    Field Value
    Type Description
    bool

    isStatic

    If the entity is static.

    Declaration
    protected bool isStatic
    Field Value
    Type Description
    bool

    name

    The entity name.

    Declaration
    protected string name
    Field Value
    Type Description
    string

    tag

    The entity tag.

    Declaration
    protected string tag
    Field Value
    Type Description
    string

    Properties

    Children

    Gets or sets gets th children list.

    Declaration
    [EvergineMember(8)]
    public List<SceneItemModel> Children { get; set; }
    Property Value
    Type Description
    List<SceneItemModel>

    Components

    Gets or sets gets the components list.

    Declaration
    [EvergineMember(7)]
    public List<Component> Components { get; set; }
    Property Value
    Type Description
    List<Component>

    IsEnabled

    Gets or sets a value indicating whether this instance is active.

    Declaration
    [EvergineMember(2)]
    public bool IsEnabled { get; set; }
    Property Value
    Type Description
    bool

    IsStatic

    Gets or sets a value indicating whether this instance is static. Once an entity is initialized, this cannot be displaced, rotated or scalated.

    Declaration
    [EvergineMember(4)]
    public bool IsStatic { get; set; }
    Property Value
    Type Description
    bool

    Name

    Gets or sets entity Name.

    Declaration
    [EvergineMember(0)]
    public string Name { get; set; }
    Property Value
    Type Description
    string

    Tag

    Gets or sets the tag.

    Declaration
    [EvergineMember(1)]
    public string Tag { get; set; }
    Property Value
    Type Description
    string

    Methods

    AddChild(SceneItemModel, int)

    Add child.

    Declaration
    public virtual void AddChild(SceneItemModel newChild, int order = 0)
    Parameters
    Type Name Description
    SceneItemModel newChild

    child base entity model.

    int order

    the order.

    AddComponent(Component)

    Add components.

    Declaration
    public void AddComponent(Component c)
    Parameters
    Type Name Description
    Component c

    the component instance.

    Clean()

    Clean this entity model.

    Declaration
    public override void Clean()
    Overrides
    SceneItemModel.Clean()

    DetachChild(Guid)

    Detach child.

    Declaration
    public virtual void DetachChild(Guid childId)
    Parameters
    Type Name Description
    Guid childId

    The Id of the child.

    RandomizeId()

    Changes the ids for a random one.

    Declaration
    public override void RandomizeId()
    Overrides
    SceneItemModel.RandomizeId()

    RecreateEntity()

    Recreates the underlying entity.

    Declaration
    public override void RecreateEntity()
    Overrides
    SceneItemModel.RecreateEntity()

    RemoveComponent(Component)

    Remove Component.

    Declaration
    public void RemoveComponent(Component component)
    Parameters
    Type Name Description
    Component component

    The component.

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In this article
    Back to top
    Generated by DocFX