Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    EntityProcessor<TComponent> Class

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

    Base implementation of EntityProcessor<TComponent, TData> when the TComponent and TData are the same

    System.Object → EntityProcessor → EntityProcessor<TComponent, TComponent> → EntityProcessor<TComponent>
    Derived from EntityProcessor<TComponent>: AudioListenerProcessor CameraProcessor InstanceProcessor LightShaftBoundingVolumeProcessor ModelNodeLinkProcessor ScriptProcessor TransformProcessor UIElementLinkProcessor LightProbeProcessor

    public abstract class EntityProcessor<TComponent> : EntityProcessor<TComponent, TComponent> where TComponent : EntityComponent
    Type Parameters
    Name Description
    TComponent

    The main type of the component this processor is looking for.

    Name Description
    Constructors
    EntityProcessor(Type[])
    Methods
    GenerateComponentData(Entity, TComponent)

    Generates associated data to the given entity.

    IsAssociatedDataValid(Entity, TComponent, TComponent)

    Checks if the current associated data is valid, or if readding the entity is required.

    | Improve this Doc View Source

    Constructors


    EntityProcessor(Type[])

    protected EntityProcessor(params Type[] requiredAdditionalTypes)
    Parameters
    Type Name Description
    System.Type[] requiredAdditionalTypes
    | Improve this Doc View Source

    Methods


    GenerateComponentData(Entity, TComponent)

    Generates associated data to the given entity.

    protected override TComponent GenerateComponentData(Entity entity, TComponent component)
    Parameters
    Type Name Description
    Entity entity

    The entity.

    TComponent component
    Returns
    Type Description
    TComponent

    The associated data.

    Overrides
    Stride.Engine.EntityProcessor<TComponent, TComponent>.GenerateComponentData(Stride.Engine.Entity, TComponent)

    IsAssociatedDataValid(Entity, TComponent, TComponent)

    Checks if the current associated data is valid, or if readding the entity is required.

    protected override bool IsAssociatedDataValid(Entity entity, TComponent component, TComponent associatedData)
    Parameters
    Type Name Description
    Entity entity

    The entity.

    TComponent component
    TComponent associatedData
    Returns
    Type Description
    System.Boolean

    True if the change in associated data requires the entity to be readded, false otherwise.

    Overrides
    Stride.Engine.EntityProcessor<TComponent, TComponent>.IsAssociatedDataValid(Stride.Engine.Entity, TComponent, TComponent)

    Inherited Members

    EntityProcessor<TComponent, TComponent>.ComponentDatas
    EntityProcessor<TComponent, TComponent>.OnSystemAdd()
    EntityProcessor<TComponent, TComponent>.OnSystemRemove()
    EntityProcessor<TComponent, TComponent>.RemoveAllEntities()
    EntityProcessor<TComponent, TComponent>.ProcessEntityComponent(Entity, EntityComponent, Boolean)
    EntityProcessor<TComponent, TComponent>.GenerateComponentData(Entity, TComponent)
    EntityProcessor<TComponent, TComponent>.IsAssociatedDataValid(Entity, TComponent, TComponent)
    EntityProcessor<TComponent, TComponent>.OnEntityComponentAdding(Entity, TComponent, TComponent)
    EntityProcessor<TComponent, TComponent>.OnEntityComponentRemoved(Entity, TComponent, TComponent)
    EntityProcessor.Tags
    EntityProcessor.UpdateProfilingState
    EntityProcessor.DrawProfilingState
    EntityProcessor.Enabled
    EntityProcessor.MainComponentType
    EntityProcessor.RequiredTypes
    EntityProcessor.HasRequiredComponents
    EntityProcessor.Order
    EntityProcessor.EntityManager
    EntityProcessor.Services
    EntityProcessor.Update(GameTime)
    EntityProcessor.Draw(RenderContext)
    EntityProcessor.OnSystemAdd()
    EntityProcessor.OnSystemRemove()
    EntityProcessor.RemoveAllEntities()
    EntityProcessor.ProcessEntityComponent(Entity, EntityComponent, Boolean)
    EntityProcessor.InternalAddEntity(Entity)
    EntityProcessor.InternalRemoveEntity(Entity, Boolean)

    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