Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    ModelRenderProcessor Class

    Namespace: Stride.Rendering
    Assembly: Stride.Engine.dll
    System.Object → EntityProcessor → EntityProcessor<ModelComponent, RenderModel> → ModelRenderProcessor
    Derived from ModelRenderProcessor:

    public class ModelRenderProcessor : EntityProcessor<ModelComponent, RenderModel>, IEntityComponentRenderProcessor
    Name Description
    Constructors
    ModelRenderProcessor()
    Properties
    RenderModels
    VisibilityGroup
    Methods
    Draw(RenderContext)

    Performs work related to this processor.

    GenerateComponentData(Entity, ModelComponent)

    Generates associated data to the given entity.

    IsAssociatedDataValid(Entity, ModelComponent, RenderModel)

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

    OnEntityComponentRemoved(Entity, ModelComponent, RenderModel)

    Run when a matching entity is removed from this entity processor.

    OnSystemAdd()

    Run when this EntityProcessor is added to an EntityManager.

    | Improve this Doc View Source

    Constructors


    ModelRenderProcessor()

    public ModelRenderProcessor()
    | Improve this Doc View Source

    Properties


    RenderModels

    public Dictionary<ModelComponent, RenderModel> RenderModels { get; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<ModelComponent, RenderModel>

    VisibilityGroup

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

    Methods


    Draw(RenderContext)

    Performs work related to this processor.

    public override void Draw(RenderContext context)
    Parameters
    Type Name Description
    RenderContext context
    Overrides
    EntityProcessor.Draw(RenderContext)

    GenerateComponentData(Entity, ModelComponent)

    Generates associated data to the given entity.

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

    The entity.

    ModelComponent component
    Returns
    Type Description
    RenderModel

    The associated data.

    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.ModelComponent, Stride.Rendering.RenderModel>.GenerateComponentData(Stride.Engine.Entity, Stride.Engine.ModelComponent)

    IsAssociatedDataValid(Entity, ModelComponent, RenderModel)

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

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

    The entity.

    ModelComponent component
    RenderModel 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<Stride.Engine.ModelComponent, Stride.Rendering.RenderModel>.IsAssociatedDataValid(Stride.Engine.Entity, Stride.Engine.ModelComponent, Stride.Rendering.RenderModel)

    OnEntityComponentRemoved(Entity, ModelComponent, RenderModel)

    Run when a matching entity is removed from this entity processor.

    protected override void OnEntityComponentRemoved(Entity entity, ModelComponent component, RenderModel renderModel)
    Parameters
    Type Name Description
    Entity entity

    The entity.

    ModelComponent component
    RenderModel renderModel
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.ModelComponent, Stride.Rendering.RenderModel>.OnEntityComponentRemoved(Stride.Engine.Entity, Stride.Engine.ModelComponent, Stride.Rendering.RenderModel)

    OnSystemAdd()

    Run when this EntityProcessor is added to an EntityManager.

    protected override void OnSystemAdd()
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.ModelComponent, Stride.Rendering.RenderModel>.OnSystemAdd()

    Inherited Members

    EntityProcessor<ModelComponent, RenderModel>.ComponentDatas
    EntityProcessor<ModelComponent, RenderModel>.OnSystemAdd()
    EntityProcessor<ModelComponent, RenderModel>.OnSystemRemove()
    EntityProcessor<ModelComponent, RenderModel>.RemoveAllEntities()
    EntityProcessor<ModelComponent, RenderModel>.ProcessEntityComponent(Entity, EntityComponent, Boolean)
    EntityProcessor<ModelComponent, RenderModel>.GenerateComponentData(Entity, ModelComponent)
    EntityProcessor<ModelComponent, RenderModel>.IsAssociatedDataValid(Entity, ModelComponent, RenderModel)
    EntityProcessor<ModelComponent, RenderModel>.OnEntityComponentAdding(Entity, ModelComponent, RenderModel)
    EntityProcessor<ModelComponent, RenderModel>.OnEntityComponentRemoved(Entity, ModelComponent, RenderModel)
    EntityProcessor.Tags
    EntityProcessor.UpdateProfilingState
    EntityProcessor.DrawProfilingState
    EntityProcessor.Enabled
    EntityProcessor.MainComponentType
    EntityProcessor.RequiredTypes
    EntityProcessor.HasRequiredComponents
    EntityProcessor.Order
    EntityProcessor.EntityManager
    EntityProcessor.Services
    EntityProcessor.Update(GameTime)
    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