Class SceneItemModel

Base entity model class.

Inheritance
object
SceneItemModel
EntityItemModel
PrefabInstanceModel
Namespace: Evergine.Framework.Assets.AssetSources.Entities
Assembly: Evergine.Framework.dll
Syntax
public abstract class SceneItemModel

Constructors

SceneItemModel()

Initializes a new instance of the SceneItemModel class.

Declaration
public SceneItemModel()

Fields

PropertySeparator

The property path separator.

Declaration
protected const char PropertySeparator = '#'
Field Value
Type Description
char

entity

The entity.

Declaration
protected Entity entity
Field Value
Type Description
Entity

id

The entity ID.

Declaration
protected Guid id
Field Value
Type Description
Guid

Properties

Entity

Gets or sets the entity.

Declaration
public Entity Entity { get; protected set; }
Property Value
Type Description
Entity

EntityPath

Gets the entity path.

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

Id

Gets or sets the entity ID.

Declaration
public Guid Id { get; set; }
Property Value
Type Description
Guid

IsEntityRecreated

Gets a value indicating whether the scene item entity has been re-created.

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

State

Gets the entity state.

Declaration
public AttachableObjectState State { get; }
Property Value
Type Description
AttachableObjectState

Methods

Clean()

Cleans this entity model.

Declaration
public abstract void Clean()

DefaultValues()

Sets the default values.

Declaration
protected virtual void DefaultValues()

GetSceneItem(Entity)

Gets a scene item model from an entity.

Declaration
public static SceneItemModel GetSceneItem(Entity entity)
Parameters
Type Name Description
Entity entity

The source entity.
Returns
Type Description
SceneItemModel

A PrefabInstance model or an EntityItem model depending on the source.

RandomizeId()

Changes the IDs to random ones.

Declaration
public abstract void RandomizeId()

RecreateEntity()

Constructs the underlying entity.

Declaration
public virtual void RecreateEntity()

Events

Recreated

Event that is called when the entity has been recreated.

Declaration
public event EventHandler<SceneItemModel> Recreated
Event Type
Type Description
EventHandler<SceneItemModel>

Extension Methods