Search Results for

    Show / Hide Table of Contents

    Class PointAttractorForce

    Forces that attract particles to a point.

    Inheritance
    object
    IdentifiableObject
    DependencyObject
    AttachableObject
    PrefabInstanceObject
    Component
    BaseForce
    PointAttractorForce
    Implements
    IDependencyObject
    Inherited Members
    BaseForce.Transform
    BaseForce.assets
    BaseForce.particlesManager
    BaseForce.Strength
    BaseForce.ForceCategory
    BaseForce.RangeEnabled
    BaseForce.Range
    BaseForce.RangeSqr
    BaseForce.DecayEnabled
    BaseForce.OnAttached()
    BaseForce.OnActivated()
    BaseForce.OnDeactivated()
    BaseForce.UpdateParticles(CPUEmitterSimulator, float)
    Component.Owner
    Component.Managers
    Component.ShouldBeActivated
    Component.Clone()
    Component.Attach(Entity)
    Component.OnLoaded()
    Component.Start()
    Component.OnDetach()
    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 PointAttractorForce : 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 strength of the cutout.

    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

    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)

    RefreshComputeMatrices(ComputeTaskDecorator, CommandBuffer, ComputeEmitterSimulator, TimeSpan)

    Refreshes a compute task matrices for a particle system.

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

    The compute task to refresh.

    CommandBuffer commandBuffer

    The command buffer.

    ComputeEmitterSimulator emitterSimulator
    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 emitterSimulator)
    Parameters
    Type Name Description
    ComputeTaskDecorator computeTask

    The compute task to refresh.

    ComputeEmitterSimulator emitterSimulator
    Overrides
    BaseForce.RefreshComputeParams(ComputeTaskDecorator, ComputeEmitterSimulator)

    Implements

    IDependencyObject

    Extension Methods

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