Class BaseShapeEmitter
Base class that represents the base particle emitter.
Namespace: Evergine.Framework.Particles.Shape
Assembly: Evergine.Framework.dll
Syntax
public abstract class BaseShapeEmitterProperties
NeedsEntitySource
Gets a value indicating whether the emitter shape needs an entity source.
Declaration
public virtual bool NeedsEntitySource { get; }Property Value
| Type | Description |
|---|---|
| bool |
ShapeType
Gets the shape type.
Declaration
public abstract EmitterShapes ShapeType { get; }Property Value
| Type | Description |
|---|---|
| EmitterShapes |
VelocityOffset
Gets or sets the directional random on the particle's emission velocity.
Declaration
public abstract Vector3 VelocityOffset { get; set; }Property Value
| Type | Description |
|---|---|
| Vector3 |
Methods
BindShape(ComputeEmitterSimulator)
Sets the shape properties to the particle compute.
Declaration
public virtual void BindShape(ComputeEmitterSimulator computeEmitter)Parameters
| Type | Name | Description |
|---|---|---|
| ComputeEmitterSimulator | computeEmitter | The compute shader emitter simulator. |
CreateFromDescription(ShapeDescription)
Gets a shape emitter from its description.
Declaration
public static BaseShapeEmitter CreateFromDescription(ShapeDescription description)Parameters
| Type | Name | Description |
|---|---|---|
| ShapeDescription | description | The shape description. |
Returns
| Type | Description |
|---|---|
| BaseShapeEmitter | The shape emitter. |
RaisePropertyChanged(string)
Raise the PropertyChanged event of the given property.
Declaration
protected virtual void RaisePropertyChanged(string propertyName = "")Parameters
| Type | Name | Description |
|---|---|---|
| string | propertyName | The porperty name. |
RefreshShapeParameters(CommandBuffer, EmitterSimulator)
Refreshes the shape parameters.
Declaration
public virtual void RefreshShapeParameters(CommandBuffer commandBuffer, EmitterSimulator emitter)Parameters
| Type | Name | Description |
|---|---|---|
| CommandBuffer | commandBuffer | The comand buffer. |
| EmitterSimulator | emitter | The particles emitter. |
UnbindShape(ComputeEmitterSimulator)
Unsets the shape properties to the particle compute.
Declaration
public virtual void UnbindShape(ComputeEmitterSimulator computeEmitter)Parameters
| Type | Name | Description |
|---|---|---|
| ComputeEmitterSimulator | computeEmitter | The compute shader emitter simulator. |
Events
PropertyChanged
Event launched when the property has been changed.
Declaration
public event EventHandler<string> PropertyChangedEvent Type
| Type | Description |
|---|---|
| EventHandler<string> |