Search Results for

    Show / Hide Table of Contents

    Class EntityShapeEmitter

    The entity shape emitter class.

    Inheritance
    object
    BaseShapeEmitter
    BaseShapeEmitter<ShapeEntityDescription>
    EntityShapeEmitter
    Inherited Members
    BaseShapeEmitter<ShapeEntityDescription>.Description
    BaseShapeEmitter<ShapeEntityDescription>.ShapeType
    BaseShapeEmitter<ShapeEntityDescription>.randomizeDirectionMode
    BaseShapeEmitter<ShapeEntityDescription>.RandomizeDirection
    BaseShapeEmitter<ShapeEntityDescription>.VelocityOffset
    BaseShapeEmitter<ShapeEntityDescription>.BindShape(ComputeEmitterSimulator)
    BaseShapeEmitter<ShapeEntityDescription>.UnbindShape(ComputeEmitterSimulator)
    BaseShapeEmitter.PropertyChanged
    BaseShapeEmitter.CreateFromDescription(ShapeDescription)
    BaseShapeEmitter.RaisePropertyChanged(string)
    Namespace: Evergine.Framework.Particles.Shape
    Assembly: Evergine.Framework.dll
    Syntax
    public class EntityShapeEmitter : BaseShapeEmitter<ShapeEntityDescription>

    Constructors

    EntityShapeEmitter(ShapeEntityDescription)

    Initializes a new instance of the EntityShapeEmitter class.

    Declaration
    public EntityShapeEmitter(ShapeEntityDescription description)
    Parameters
    Type Name Description
    ShapeEntityDescription description

    The description of the emitter.

    Properties

    EmissionSource

    Gets or sets the emission type of the entity.

    Declaration
    [RenderProperty(CustomPropertyName = "Emission Source", Tooltip = "What part of the entity are considered for emission (vertex, triangles...)")]
    public EntityEmitterType EmissionSource { get; set; }
    Property Value
    Type Description
    EntityEmitterType

    NeedsEntitySource

    Gets a value indicating whether the emitter shape needs a source entity.

    Declaration
    public override bool NeedsEntitySource { get; }
    Property Value
    Type Description
    bool
    Overrides
    BaseShapeEmitter.NeedsEntitySource

    Methods

    EmitParticleCPU(CPUEmitterSimulator, ref uint, ref Vector3, out Vector3)

    CPU particle emission.

    Declaration
    protected override void EmitParticleCPU(CPUEmitterSimulator cpuEmitter, ref uint seed, ref Vector3 position, out Vector3 initDirection)
    Parameters
    Type Name Description
    CPUEmitterSimulator cpuEmitter

    The CPU emitter simulator.

    uint seed

    The seed.

    Vector3 position

    The initial position.

    Vector3 initDirection

    The initial direction.

    Overrides
    BaseShapeEmitter<ShapeEntityDescription>.EmitParticleCPU(CPUEmitterSimulator, ref uint, ref Vector3, out Vector3)

    RefreshShapeParameters(CommandBuffer, EmitterSimulator)

    Refreshes the shape parameters.

    Declaration
    public override void RefreshShapeParameters(CommandBuffer commandBuffer, EmitterSimulator emitter)
    Parameters
    Type Name Description
    CommandBuffer commandBuffer

    The command buffer.

    EmitterSimulator emitter

    The particle emitter.

    Overrides
    BaseShapeEmitter<ShapeEntityDescription>.RefreshShapeParameters(CommandBuffer, EmitterSimulator)

    Extension Methods

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