Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    AudioListenerProcessor Class

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

    Processor in charge of creating and updating the AudioListener data associated to the scene AudioListenerComponents.

    System.Object → EntityProcessor → EntityProcessor<AudioListenerComponent, AudioListenerComponent> → EntityProcessor<AudioListenerComponent> → AudioListenerProcessor
    Derived from AudioListenerProcessor:

    public class AudioListenerProcessor : EntityProcessor<AudioListenerComponent>
    Remarks

    The processor updates only AudioListener associated to AudioListenerComponents The processor is subscribing to the Stride.Audio.AudioListenerProcessor.audioSystem AudioListenerComponent collection events to be informed of required AudioEmitter updates. When a AudioListenerComponent is added to the Stride.Audio.AudioListenerProcessor.audioSystem, the processor set the associated AudioEmitter. When a AudioListenerComponent is removed from the entity system, the processor set the AudioEmitter reference of the AudioSystem to null but do not remove the AudioListenerComponent from its collection.

    Name Description
    Constructors
    AudioListenerProcessor()

    Create a new instance of AudioListenerProcessor.

    Methods
    Draw(RenderContext)
    OnEntityComponentAdding(Entity, AudioListenerComponent, AudioListenerComponent)
    OnEntityComponentRemoved(Entity, AudioListenerComponent, AudioListenerComponent)
    OnSystemAdd()
    OnSystemRemove()
    | Improve this Doc View Source

    Constructors


    AudioListenerProcessor()

    Create a new instance of AudioListenerProcessor.

    public AudioListenerProcessor()
    | Improve this Doc View Source

    Methods


    Draw(RenderContext)

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

    OnEntityComponentAdding(Entity, AudioListenerComponent, AudioListenerComponent)

    protected override void OnEntityComponentAdding(Entity entity, AudioListenerComponent component, AudioListenerComponent data)
    Parameters
    Type Name Description
    Entity entity
    AudioListenerComponent component
    AudioListenerComponent data
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioListenerComponent, Stride.Engine.AudioListenerComponent>.OnEntityComponentAdding(Stride.Engine.Entity, Stride.Engine.AudioListenerComponent, Stride.Engine.AudioListenerComponent)

    OnEntityComponentRemoved(Entity, AudioListenerComponent, AudioListenerComponent)

    protected override void OnEntityComponentRemoved(Entity entity, AudioListenerComponent component, AudioListenerComponent data)
    Parameters
    Type Name Description
    Entity entity
    AudioListenerComponent component
    AudioListenerComponent data
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioListenerComponent, Stride.Engine.AudioListenerComponent>.OnEntityComponentRemoved(Stride.Engine.Entity, Stride.Engine.AudioListenerComponent, Stride.Engine.AudioListenerComponent)

    OnSystemAdd()

    protected override void OnSystemAdd()
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioListenerComponent, Stride.Engine.AudioListenerComponent>.OnSystemAdd()

    OnSystemRemove()

    protected override void OnSystemRemove()
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.AudioListenerComponent, Stride.Engine.AudioListenerComponent>.OnSystemRemove()

    Inherited Members

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