@galacean/engine-core 1.1.0-beta.20 → 1.1.0-beta.21

package/types/mesh/SubModelMesh.d.ts

@@ -1,260 +0,0 @@
-import { Color, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
-import { Engine } from "../Engine";
-import { Buffer } from "../graphic/Buffer";
-import { Mesh } from "../graphic/Mesh";
-import { VertexBufferBinding } from "../graphic/VertexBufferBinding";
-import { VertexElement } from "../graphic/VertexElement";
-import { BlendShape } from "./BlendShape";
-import { VertexAttribute } from "./enums/VertexAttribute";
-import { MeshTopology } from "../graphic/enums/MeshTopology";
-/**
- * Sub-model mesh.
- */
-export declare class SubModelMesh extends Mesh {
-    private static _tempVec0;
-    private static _tempVec1;
-    private static _tempVec2;
-    private static _tempVec3;
-    private static _tempVec4;
-    private _vertexCount;
-    private _vertexCountDirty;
-    private _dataVersionCounter;
-    private _positions;
-    private _normals;
-    private _colors;
-    private _tangents;
-    private _uv;
-    private _uv1;
-    private _uv2;
-    private _uv3;
-    private _uv4;
-    private _uv5;
-    private _uv6;
-    private _uv7;
-    private _boneWeights;
-    private _boneIndices;
-    private _advancedElementUpdateFlag;
-    private _advancedDataUpdateFlag;
-    private _advancedVertexDataVersions;
-    private _advancedDataSyncToBuffer;
-    private _internalVertexBufferStride;
-    private _internalVertexBufferCreatedInfo;
-    private _internalVertexElementsOffset;
-    private _internalVertexElementsFlags;
-    private _vertexBufferInfos;
-    private _indices;
-    private _indicesFormat;
-    private _indicesChangeFlag;
-    /** Start drawing offset. */
-    start: number;
-    /** Drawing count. */
-    count: number;
-    /** Drawing topology. */
-    topology: MeshTopology;
-    /**
-     * Vertex count of mesh.
-     */
-    get vertexCount(): number;
-    /**
-     * Vertex element collection.
-     */
-    get vertexElements(): Readonly<VertexElement[]>;
-    /**
-     * Vertex buffer binding collection.
-     */
-    get vertexBufferBindings(): ReadonlyArray<VertexBufferBinding>;
-    /**
-     * BlendShapes of this ModelMesh.
-     */
-    get blendShapes(): Readonly<BlendShape[]>;
-    /**
-     * BlendShape count of this ModelMesh.
-     */
-    get blendShapeCount(): number;
-    /**
-     * Create a model mesh.
-     * @param engine - Engine to which the mesh belongs
-     */
-    constructor(engine: Engine);
-    /**
-     * Set positions for the mesh.
-     * @param positions - The positions for the mesh
-     */
-    setPositions(positions: Vector3[] | null): void;
-    /**
-     * Get positions for the mesh.
-     * @remarks Please call the setPositions() method after modification to ensure that the modification takes effect.
-     */
-    getPositions(): Vector3[] | null;
-    /**
-     * Set per-vertex normals for the mesh.
-     * @param normals - The normals for the mesh
-     */
-    setNormals(normals: Vector3[] | null): void;
-    /**
-     * Get normals for the mesh.
-     * @remarks Please call the setNormals() method after modification to ensure that the modification takes effect.
-     */
-    getNormals(): Vector3[] | null;
-    /**
-     * Set per-vertex colors for the mesh.
-     * @param colors - The colors for the mesh
-     */
-    setColors(colors: Color[] | null): void;
-    /**
-     * Get colors for the mesh.
-     * @remarks Please call the setColors() method after modification to ensure that the modification takes effect.
-     */
-    getColors(): Color[] | null;
-    /**
-     * Set per-vertex bone weights for the mesh.
-     * @param boneWeights - The bone weights for the mesh
-     */
-    setBoneWeights(boneWeights: Vector4[] | null): void;
-    /**
-     * Get bone weights for the mesh.
-     * @remarks Please call the setWeights() method after modification to ensure that the modification takes effect.
-     */
-    getBoneWeights(): Vector4[] | null;
-    /**
-     * Set per-vertex bone indices for the mesh.
-     * @param boneIndices - The bone indices for the mesh
-     */
-    setBoneIndices(boneIndices: Vector4[] | null): void;
-    /**
-     * Get bone indices for the mesh.
-     * @remarks Please call the setBoneIndices() method after modification to ensure that the modification takes effect.
-     */
-    getBoneIndices(): Vector4[] | null;
-    /**
-     * Set per-vertex tangents for the mesh.
-     * @param tangents - The tangents for the mesh
-     */
-    setTangents(tangents: Vector4[] | null): void;
-    /**
-     * Get tangents for the mesh.
-     * @remarks Please call the setTangents() method after modification to ensure that the modification takes effect.
-     */
-    getTangents(): Vector4[] | null;
-    /**
-     * Set per-vertex uv for the mesh.
-     * @param uv - The uv for the mesh
-     */
-    setUVs(uv: Vector2[] | null): void;
-    /**
-     * Set per-vertex uv for the mesh by channelIndex.
-     * @param uv - The uv for the mesh
-     * @param channelIndex - The index of uv channels, in [0 ~ 7] range
-     */
-    setUVs(uv: Vector2[] | null, channelIndex: number): void;
-    /**
-     * Get uv for the mesh.
-     * @remarks Please call the setUV() method after modification to ensure that the modification takes effect.
-     */
-    getUVs(): Vector2[] | null;
-    /**
-     * Get uv for the mesh by channelIndex.
-     * @param channelIndex - The index of uv channels, in [0 ~ 7] range.
-     * @remarks Please call the setUV() method after modification to ensure that the modification takes effect.
-     */
-    getUVs(channelIndex: number): Vector2[] | null;
-    /**
-     * Set indices for the mesh.
-     * @param indices - The indices for the mesh
-     */
-    setIndices(indices: Uint8Array | Uint16Array | Uint32Array): void;
-    /**
-     * Get indices for the mesh.
-     */
-    getIndices(): Uint8Array | Uint16Array | Uint32Array;
-    /**
-     * Set vertex elements.
-     * @param elements - Vertex element collection
-     *
-     * @remarks
-     * Call this method will clear the vertex data set by the setPositions(), setNormals(), setColors(), setBoneWeights(), setBoneIndices(), setTangents(), setUVs() methods.
-     */
-    setVertexElements(elements: VertexElement[]): void;
-    /**
-     * Set vertex buffer binding.
-     * @param vertexBufferBinding - Vertex buffer binding
-     * @param index - Vertex buffer index, the default value is 0
-     */
-    setVertexBufferBinding(vertexBufferBinding: VertexBufferBinding, index?: number): void;
-    /**
-     * Set vertex buffer binding.
-     * @param vertexBuffer - Vertex buffer
-     * @param stride - Vertex buffer data stride
-     * @param index - Vertex buffer index, the default value is 0
-     */
-    setVertexBufferBinding(vertexBuffer: Buffer, stride: number, index?: number): void;
-    /**
-     * Set vertex buffer binding.
-     * @param vertexBufferBindings - Vertex buffer binding
-     * @param firstIndex - First vertex buffer index, the default value is 0
-     */
-    setVertexBufferBindings(vertexBufferBindings: VertexBufferBinding[], firstIndex?: number): void;
-    /**
-     * Get `VertexElement` by attribute.
-     * @param attribute - Vertex attribute
-     * @returns Vertex element
-     */
-    getVertexElement(attribute: VertexAttribute): VertexElement | null;
-    /**
-     * Add a BlendShape for this ModelMesh.
-     * @param blendShape - The BlendShape
-     */
-    addBlendShape(blendShape: BlendShape): void;
-    /**
-     * Clear all BlendShapes.
-     */
-    clearBlendShapes(): void;
-    /**
-     * Get name of BlendShape by given index.
-     * @param index - The index of BlendShape
-     * @returns The name of BlendShape
-     */
-    getBlendShapeName(index: number): string;
-    /**
-     * Upload data to GPU set by `setPositions()`, `setNormals()`, `setColors()`, `setBoneWeights()`, `setBoneIndices()`, `setTangents()`, `setUVs()`, `setIndices()` methods.
-     * This method will be auto generate vertex element and vertex buffer binding if needed.
-     *
-     * @param releaseData - Whether to release the data cache, release data can reduce memory usage.
-     */
-    uploadData(releaseData: boolean): void;
-    /**
-     * Calculate mesh tangent.
-     * @remark need to set positions(with or not with indices), normals, uv before calculation.
-     * @remark based on http://foundationsofgameenginedev.com/FGED2-sample.pdf
-     */
-    calculateTangents(): void;
-    private _getVertexElementData;
-    private _beforeSetAdvancedVertexData;
-    private _updateAdvancedVertexDataMarks;
-    private _updateInternalVertexBuffer;
-    private _readVector2VertexData;
-    private _readVector3VertexData;
-    private _readVector4VertexData;
-    private _readColorVertexData;
-    private _readVertexData;
-    private _updateAdvancedVertexElement;
-    private _updateAdvancedVertexElements;
-    private _updateVertexElements;
-    private _writeVector2AdvancedVertexData;
-    private _writeVector3AdvancedVertexData;
-    private _writeVector4AdvancedVertexData;
-    private _writeColorAdvancedVertexData;
-    private _writeAdvancedVertexData;
-    private _updateAdvancedVertices;
-    private _getInternalVertexBufferIndex;
-    private _getAttributeFormat;
-    private _getAttributeByteLength;
-    private _releaseCache;
-    /** @deprecated */
-    private _accessible;
-    /**
-     * @deprecated
-     * Whether to access data of the mesh.
-     */
-    get accessible(): boolean;
-}

package/types/particle/ParticleShaderMacro.d.ts

@@ -1 +0,0 @@
-export {};

package/types/particle/ParticleShaderProperty.d.ts

@@ -1 +0,0 @@
-export {};

package/types/particle/ParticleSystem.d.ts

@@ -1,41 +0,0 @@
-import { ParticleRenderer } from "./ParticleRenderer";
-import { EmissionModule } from "./modules/EmissionModule";
-import { MainModule } from "./modules/MainModule";
-import { ShapeModule } from "./modules/ShapeModule";
-/**
- * Particle System.
- */
-export declare class ParticleGenerator {
-    /** Use auto random seed. */
-    useAutoRandomSeed: boolean;
-    /** Main module. */
-    readonly main: MainModule;
-    /** Emission module. */
-    readonly emission: EmissionModule;
-    /** Shape module. */
-    readonly shape: ShapeModule;
-    private _waitProcessRetiredElementCount;
-    private _instanceVertexBufferBinding;
-    private _instanceVertices;
-    private readonly _engine;
-    private readonly _renderer;
-    private readonly _particleIncreaseCount;
-    /**
-     * Random seed.
-     * @remarks If `useAutoRandomSeed` is true, this value will be random changed when play.
-     */
-    get randomSeed(): number;
-    set randomSeed(value: number);
-    constructor(renderer: ParticleRenderer);
-    /**
-     * Emit a certain number of particles.
-     * @param count - Number of particles to emit
-     */
-    emit(count: number): void;
-    private _addNewParticle;
-    private _retireActiveParticles;
-    private _freeRetiredParticles;
-    private _addNewParticlesToVertexBuffer;
-    private _createParticleData;
-    private _addVertexBufferBindingsFilterDuplicate;
-}

package/types/particle/ParticleVertexElements.d.ts

@@ -1 +0,0 @@
-export {};

package/types/particle/ParticleVertexUtils.d.ts

@@ -1 +0,0 @@
-export {};

package/types/particle/modules/ShapeModule.d.ts

@@ -1,9 +0,0 @@
-import { ParticleGeneratorModule } from "./ParticleGeneratorModule";
-import { BaseShape } from "./shape/BaseShape";
-/**
- * Shape module of `ParticleGenerator`.
- */
-export declare class ShapeModule extends ParticleGeneratorModule {
-    /** The shape of the emitter. */
-    shape: BaseShape;
-}

package/types/particle/modules/shape/enums/ParticleShapeMultiModeValue.d.ts

@@ -1,9 +0,0 @@
-/**
- * The mode used to generate new points in a shape.
- */
-export declare enum ParticleShapeMultiModeValue {
-    /** Generate points randomly. (Default) */
-    Random = 0,
-    /** Animate the emission point around the shape. */
-    Loop = 1
-}

package/types/particle/moudules/EmissionModule.d.ts

@@ -1,49 +0,0 @@
-import { ParticleSystem } from "../ParticleSystem";
-import { Burst } from "./Burst";
-import { ParticleCurve } from "./ParticleCurve";
-/**
- * The EmissionModule of a Particle System.
- */
-export declare class EmissionModule {
-    /** Specifies whether the EmissionModule is enabled or disabled. */
-    enabled: boolean;
-    /**  The rate of particle emission. */
-    rateOverTime: ParticleCurve;
-    /**  The rate at which the emitter spawns new particles over distance. */
-    rateOverDistance: ParticleCurve;
-    private _bursts;
-    private _frameRateTime;
-    private _currentBurstIndex;
-    private _particleSystem;
-    /**
-     * Gets the burst array.
-     */
-    get bursts(): ReadonlyArray<Burst>;
-    constructor(particleSystem: ParticleSystem);
-    /**
-     * Add a single burst.
-     * @param burst - The burst
-     */
-    addBurst(burst: Burst): void;
-    /**
-     * Remove a single burst from the array of bursts.
-     * @param burst - The burst data
-     */
-    removeBurst(burst: Burst): void;
-    /**
-     * Remove a single burst from the array of bursts.
-     * @param index - The burst data index
-     */
-    removeBurstByIndex(index: number): void;
-    /**
-     * Clear burst data.
-     */
-    clearBurst(): void;
-    /**
-     * @override
-     */
-    cloneTo(destEmission: EmissionModule): void;
-    private _emitByRateOverTime;
-    private _emitByBurst;
-    private _emitBySubBurst;
-}

package/types/particle/moudules/MainModule.d.ts

@@ -1,59 +0,0 @@
-import { ParticleSystem } from "../ParticleSystem";
-import { ParticleScaleMode } from "../enums/ParticleScaleMode";
-import { ParticleSimulationSpace } from "../enums/ParticleSimulationSpace";
-import { ParticleCurve } from "./ParticleCurve";
-import { ParticleGradient } from "./ParticleGradient";
-export declare class MainModule {
-    /** The duration of the Particle System in seconds. */
-    duration: number;
-    /** Specifies whether the Particle System is looping. */
-    loop: boolean;
-    /** Start delay in seconds. */
-    startDelay: ParticleCurve;
-    /** The initial lifetime of particles when emitted. */
-    startLifetime: ParticleCurve;
-    /** The initial speed of particles when the Particle System first spawns them. */
-    startSpeed: ParticleCurve;
-    /** A flag to enable specifying particle size individually for each axis. */
-    startSize3D: boolean;
-    /** The initial size of particles when the Particle System first spawns them. */
-    startSize: ParticleCurve;
-    /** The initial size of particles along the x-axis when the Particle System first spawns them. */
-    startSizeX: ParticleCurve;
-    /** The initial size of particles along the y-axis when the Particle System first spawns them. */
-    startSizeY: ParticleCurve;
-    /** The initial size of particles along the z-axis when the Particle System first spawns them. */
-    startSizeZ: ParticleCurve;
-    /** A flag to enable 3D particle rotation. */
-    startRotation3D: boolean;
-    /** The initial rotation of particles when the Particle System first spawns them. */
-    startRotation: ParticleCurve;
-    /** The initial rotation of particles around the x-axis when emitted.*/
-    startRotationX: ParticleCurve;
-    /** The initial rotation of particles around the y-axis when emitted. */
-    startRotationY: ParticleCurve;
-    /** The initial rotation of particles around the z-axis when emitted. */
-    startRotationZ: ParticleCurve;
-    /** Makes some particles spin in the opposite direction. */
-    flipRotation: number;
-    /** The mode of start color */
-    startColor: ParticleGradient;
-    /** A scale that this Particle System applies to gravity, defined by Physics.gravity. */
-    gravityModifier: ParticleCurve;
-    /** This selects the space in which to simulate particles. It can be either world or local space. */
-    simulationSpace: ParticleSimulationSpace;
-    /** Override the default playback speed of the Particle System. */
-    simulationSpeed: number;
-    /** Control how the Particle System applies its Transform component to the particles it emits. */
-    scalingMode: ParticleScaleMode;
-    /** If set to true, the Particle System automatically begins to play on startup. */
-    playOnAwake: boolean;
-    private _bufferMaxParticles;
-    private _particleSystem;
-    /**
-     * Max particles count.
-     */
-    get maxParticles(): number;
-    set maxParticles(value: number);
-    constructor(particleSystem: ParticleSystem);
-}

package/types/particle/moudules/ParticleGradient.d.ts

@@ -1,28 +0,0 @@
-import { IClone } from "@galacean/engine-design";
-import { Color } from "@galacean/engine-math";
-import { ParticleGradientMode } from "../enums/ParticleGradientMode";
-/**
- * Particle curve.
- */
-export declare class ParticleGradient implements IClone {
-    /** The curve mode. */
-    mode: ParticleGradientMode;
-    color: Color;
-    colorMin: Color;
-    colorMax: Color;
-    /**
-     * Query the color at the specified time.
-     * @param time - Normalized time at which to evaluate the gradient, Valid when `mode` is set to `Gradient` or `TwoGradients`
-     * @param lerpFactor - Lerp factor between two colors or gradients, Valid when `mode` is set to `TwoColors` or `TwoGradients`
-     * @param out - The result color
-     */
-    evaluate(time: number, lerpFactor: number, out: Color): void;
-    /**
-     * @inheritDoc
-     */
-    cloneTo(destEmission: ParticleGradient): void;
-    /**
-     * @inheritDoc
-     */
-    clone(): ParticleGradient;
-}

package/types/particle/moudules/ShapeModule.d.ts

@@ -1,7 +0,0 @@
-/**
- * Shape module of `ParticleSystem`.
- */
-export declare class ShapeModule {
-    /** Specifies whether the Shape Module is enabled or disabled. */
-    enabled: boolean;
-}

package/types/particle/moudules/shape/BaseShape.d.ts

@@ -1,28 +0,0 @@
-import { IClone } from "@galacean/engine-design";
-import { BoundingBox, Rand } from "@galacean/engine-math";
-import { ParticleShapeType } from "./enums/ParticleShapeType";
-/**
- * Configures the initial positions and directions of particles.
- */
-export declare class BaseShape implements IClone {
-    /** The type of shape to emit particles from. */
-    shapeType: ParticleShapeType;
-    /** Specifies whether the ShapeModule is enabled or disabled. */
-    enable: boolean;
-    /** Randomizes the starting direction of particles. */
-    randomDirectionAmount: number;
-    protected _rand: Rand;
-    constructor(randSeed?: number);
-    /**
-     * @override
-     * @inheritDoc
-     */
-    cloneTo(destShape: BaseShape): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    clone(): BaseShape;
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
-}

package/types/particle/moudules/shape/BoxShape.d.ts

@@ -1,20 +0,0 @@
-import { BoundingBox, Vector3 } from "@galacean/engine-math";
-import { BaseShape } from "./BaseShape";
-/**
- * Box emitter shape
- */
-export declare class BoxShape extends BaseShape {
-    /** Thickness of the box to emit particles from. */
-    boxThickness: Vector3;
-    constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
-    cloneTo(destShape: BoxShape): void;
-    clone(): BoxShape;
-}

package/types/particle/moudules/shape/CircleShape.d.ts

@@ -1,27 +0,0 @@
-import { BoundingBox, Vector2, Vector3 } from "@galacean/engine-math";
-import { BaseShape } from "./BaseShape";
-import { ParticleShapeMultiModeValue } from "./enums/ParticleShapeMultiModeValue";
-/**
- * Circle Particle Emitter
- */
-export declare class CircleShape extends BaseShape {
-    protected static _tempPositionPoint: Vector2;
-    /** Radius of the shape to emit particles from. */
-    radius: number;
-    /** Angle of the circle arc to emit particles from. */
-    arc: number;
-    /** The mode to generate particles around the arc. */
-    arcMode: ParticleShapeMultiModeValue;
-    constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
-    _generatePositionAndDirection(position: Vector3, direction: Vector3): void;
-    cloneTo(destShape: CircleShape): void;
-    clone(): CircleShape;
-}

package/types/particle/moudules/shape/ConeShape.d.ts

@@ -1,35 +0,0 @@
-import { BoundingBox, Vector2, Vector3 } from "@galacean/engine-math";
-import { BaseShape } from "./BaseShape";
-export declare enum ConeEmitType {
-    Base = 0,
-    BaseShell = 1,
-    Volume = 2,
-    VolumeShell = 3
-}
-/**
- * Cone particle emitter
- */
-export declare class ConeShape extends BaseShape {
-    protected static _tempPositionPoint: Vector2;
-    protected static _tempDirectionPoint: Vector2;
-    /** Angle of the cone to emit particles from. */
-    angle: number;
-    /** Radius of the shape to emit particles from. */
-    radius: number;
-    /** Length of the cone to emit particles from. */
-    length: number;
-    /** Cone emitter subtype */
-    emitType: ConeEmitType;
-    constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
-    _generatePositionAndDirection(position: Vector3, direction: Vector3): void;
-    cloneTo(destShape: ConeShape): void;
-    clone(): ConeShape;
-}

package/types/particle/moudules/shape/HemisphereShape.d.ts

@@ -1,23 +0,0 @@
-import { BoundingBox, Vector3 } from "@galacean/engine-math";
-import { BaseShape } from "./BaseShape";
-/**
- * Hemisphere emitter
- */
-export declare class HemisphereShape extends BaseShape {
-    /** Radius of the shape to emit particles from. */
-    radius: number;
-    /** Whether emit from shell */
-    emitFromShell: boolean;
-    constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
-    _generatePositionAndDirection(position: Vector3, direction: Vector3): void;
-    cloneTo(destShape: HemisphereShape): void;
-    clone(): HemisphereShape;
-}

package/types/particle/moudules/shape/ShapeUtils.d.ts

@@ -1 +0,0 @@
-export {};

package/types/particle/moudules/shape/SphereShape.d.ts

@@ -1,23 +0,0 @@
-import { BoundingBox, Rand, Vector3 } from "@galacean/engine-math";
-import { BaseShape } from "./BaseShape";
-/**
- * Sphere emitter
- */
-export declare class SphereShape extends BaseShape {
-    /** Radius of the shape to emit particles from. */
-    radius: number;
-    /** Whether emit from shell */
-    emitFromShell: boolean;
-    constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
-    _generatePositionAndDirection(position: Vector3, direction: Vector3, rand?: Rand, randomSeeds?: Uint32Array): void;
-    cloneTo(destShape: SphereShape): void;
-    clone(): SphereShape;
-}

package/types/particle/moudules/shape/enums/ParticleShapeMultiModeValue.d.ts

@@ -1,9 +0,0 @@
-/**
- * The mode used to generate new points in a shape.
- */
-export declare enum ParticleShapeMultiModeValue {
-    /** Generate points randomly. (Default) */
-    Random = 0,
-    /** Animate the emission point around the shape. */
-    Loop = 1
-}

package/types/particle/moudules/shape/enums/ParticleShapeType.d.ts

@@ -1,15 +0,0 @@
-/**
- * The emission shape.
- */
-export declare enum ParticleShapeType {
-    /** Emit from the volume of a box. */
-    Box = 0,
-    /** Emit from a circle. */
-    Circle = 1,
-    /** Emit from the base of a cone. */
-    Cone = 2,
-    /** Emit from a half-sphere. */
-    Hemisphere = 3,
-    /** Emit from a sphere. */
-    Sphere = 4
-}