Search Results for

    Show / Hide Table of Contents

    Class EntityAttractorForce

    Forces that attract particles to an entity.

    Inheritance
    object
    IdentifiableObject
    DependencyObject
    AttachableObject
    PrefabInstanceObject
    Component
    BaseForce
    EntityAttractorForce
    Implements
    IDependencyObject
    Inherited Members
    BaseForce.Transform
    BaseForce.assets
    BaseForce.particlesManager
    BaseForce.Strength
    BaseForce.ForceCategory
    BaseForce.RangeEnabled
    BaseForce.Range
    BaseForce.RangeSqr
    BaseForce.DecayEnabled
    BaseForce.OnActivated()
    BaseForce.OnDeactivated()
    BaseForce.UpdateParticles(CPUEmitterSimulator, float)
    Component.Owner
    Component.Managers
    Component.ShouldBeActivated
    Component.Clone()
    Component.Attach(Entity)
    Component.OnLoaded()
    Component.OnDestroy()
    PrefabInstanceObject.PrefabSource
    PrefabInstanceObject.RefreshPrefab(Prefab)
    PrefabInstanceObject.PrefabElementId
    PrefabInstanceObject.IsPrefabInstance
    PrefabInstanceObject.IsMissingPrefabSource
    AttachableObject.AttachableStateChanged
    AttachableObject.IsEnabled
    AttachableObject.State
    AttachableObject.IsLoaded
    AttachableObject.IsAttached
    AttachableObject.IsActivated
    AttachableObject.IsStarted
    AttachableObject.IsDestroyed
    AttachableObject.Destroy()
    AttachableObject.DependencyBroken()
    DependencyObject.Dependencies
    DependencyObject.OnDependencyRemoved
    IdentifiableObject.Id
    IdentifiableObject.IdHasChanged(Guid)
    Namespace: Evergine.Framework.Particles.Forces
    Assembly: Evergine.Framework.dll
    Syntax
    public class EntityAttractorForce : BaseForce, IDependencyObject

    Properties

    CutoutEnabled

    Gets or sets a value indicating whether the attractor has a cutout.

    Declaration
    [RenderProperty(Tag = 2)]
    public bool CutoutEnabled { get; set; }
    Property Value
    Type Description
    bool

    CutoutRange

    Gets or sets the cutout range.

    Declaration
    [RenderProperty(AttachToTag = 2, AttachToValue = true)]
    public float CutoutRange { get; set; }
    Property Value
    Type Description
    float

    CutoutStrength

    Gets or sets the cutout strength.

    Declaration
    [RenderProperty(AttachToTag = 2, AttachToValue = true)]
    public float CutoutStrength { get; set; }
    Property Value
    Type Description
    float

    ForceType

    Gets the force type.

    Declaration
    public override ForceTypes ForceType { get; }
    Property Value
    Type Description
    ForceTypes
    Overrides
    BaseForce.ForceType

    RandomPrecission

    Gets or sets the random precision level of the particle system.

    Declaration
    public RandomPrecissionEnum RandomPrecission { get; set; }
    Property Value
    Type Description
    RandomPrecissionEnum

    SourceEntity

    Gets or sets the target entity.

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

    SourceEntityPath

    Gets or sets the path of the target entity.

    Declaration
    public string SourceEntityPath { get; set; }
    Property Value
    Type Description
    string

    SourceTopology

    Gets or sets the emission type of the entity.

    Declaration
    public EntityEmitterType SourceTopology { get; set; }
    Property Value
    Type Description
    EntityEmitterType

    UseComputeParticles

    Gets or sets a value indicating whether the particles try to be generated by a compute shader.

    Declaration
    public bool UseComputeParticles { get; set; }
    Property Value
    Type Description
    bool

    Methods

    ApplyForce(int, ref ParticleVertex, ref ParticleStateB, float)

    Apply force to a single particle.

    Declaration
    protected override void ApplyForce(int id, ref ParticleVertex p, ref ParticleStateB pB, float ellapsedTime)
    Parameters
    Type Name Description
    int id

    The ID of the particle.

    ParticleVertex p

    The particle pointer.

    ParticleStateB pB

    The particle struct B pointer.

    float ellapsedTime
    Overrides
    BaseForce.ApplyForce(int, ref ParticleVertex, ref ParticleStateB, float)

    CreateComputeTask(ComputeEmitterSimulator)

    Creates a compute task for a particle system.

    Declaration
    public override ComputeTaskDecorator CreateComputeTask(ComputeEmitterSimulator particleSystem)
    Parameters
    Type Name Description
    ComputeEmitterSimulator particleSystem

    The particle system.

    Returns
    Type Description
    ComputeTaskDecorator

    The compute task.

    Overrides
    BaseForce.CreateComputeTask(ComputeEmitterSimulator)

    OnAttached()

    Invoked when the object is attached to the system.

    Declaration
    protected override bool OnAttached()
    Returns
    Type Description
    bool

    True if everything is OK.

    Overrides
    BaseForce.OnAttached()

    OnDetach()

    Invoked when the object is detached.

    Declaration
    protected override void OnDetach()
    Overrides
    Component.OnDetach()

    RefreshComputeMatrices(ComputeTaskDecorator, CommandBuffer, ComputeEmitterSimulator, TimeSpan)

    Refreshes a compute task matrices for a particle system.

    Declaration
    public override void RefreshComputeMatrices(ComputeTaskDecorator computeTask, CommandBuffer commandBuffer, ComputeEmitterSimulator particleSystem, TimeSpan ellapsedTime)
    Parameters
    Type Name Description
    ComputeTaskDecorator computeTask

    The compute task to refresh.

    CommandBuffer commandBuffer

    The command buffer.

    ComputeEmitterSimulator particleSystem

    The particle system.

    TimeSpan ellapsedTime
    Overrides
    BaseForce.RefreshComputeMatrices(ComputeTaskDecorator, CommandBuffer, ComputeEmitterSimulator, TimeSpan)

    RefreshComputeParams(ComputeTaskDecorator, ComputeEmitterSimulator)

    Refreshes a compute task for a particle system.

    Declaration
    public override void RefreshComputeParams(ComputeTaskDecorator computeTask, ComputeEmitterSimulator particleSystem)
    Parameters
    Type Name Description
    ComputeTaskDecorator computeTask

    The compute task to refresh.

    ComputeEmitterSimulator particleSystem

    The particle system.

    Overrides
    BaseForce.RefreshComputeParams(ComputeTaskDecorator, ComputeEmitterSimulator)

    Start()

    Invoked to start the object.

    Declaration
    protected override void Start()
    Overrides
    Component.Start()

    Implements

    IDependencyObject

    Extension Methods

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