ShapeModule Class
The shape module of 3d particle.
Index
Properties
enableBooleanThe enable of shapeModule.shapeTypeShapeTypeParticle emitter type.emitFromEmitLocationThe emission site of the particle.radiusNumberParticle emitter radius.radiusThicknessNumberParticle emitter emission position (not valid for Box type emitters):... angleNumberThe angle between the axis of the cone and the generatrix... arcNumberParticle emitters emit in a fan-shaped range.arcModeArcModeHow particles are emitted in the sector range.arcSpreadNumberControls the discrete intervals around the arcs where particles might be generated.arcSpeedCurveRangeThe speed at which particles are emitted around the circumference.lengthNumberAxis length from top of cone to bottom of cone. boxThicknessVec3Particle emitter emission location (for box-type particle emitters).positionVec3Particle Emitter PositionrotationVec3Particle emitter rotation angle.scaleVec3Particle emitter scalingalignToDirectionBooleanThe direction of particle movement is determined based on the initial direction of the particles.randomDirectionAmountNumberSet particle generation direction randomly.sphericalDirectionAmountNumberInterpolation between the current emission direction and the direction from the current position to the center of the node.
Details
Properties
enable
The enable of shapeModule.
| meta | description |
|---|---|
| Type | Boolean |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:23 |
shapeType
Particle emitter type.
| meta | description |
|---|---|
| Type | ShapeType |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:34 |
emitFrom
The emission site of the particle.
| meta | description |
|---|---|
| Type | EmitLocation |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:68 |
radius
Particle emitter radius.
| meta | description |
|---|---|
| Type | Number |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:78 |
radiusThickness
Particle emitter emission position (not valid for Box type emitters):
- 0 means emitted from the surface;
- 1 means launch from the center;
- 0 ~ 1 indicates emission from the center to the surface.
| meta | description |
|---|---|
| Type | Number |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:86 |
angle
The angle between the axis of the cone and the generatrix
Determines the opening and closing of the cone launcher
| meta | description |
|---|---|
| Type | Number |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:103 |
arc
Particle emitters emit in a fan-shaped range.
| meta | description |
|---|---|
| Type | Number |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:122 |
arcMode
How particles are emitted in the sector range.
| meta | description |
|---|---|
| Type | ArcMode |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:136 |
arcSpread
Controls the discrete intervals around the arcs where particles might be generated.
| meta | description |
|---|---|
| Type | Number |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:146 |
arcSpeed
The speed at which particles are emitted around the circumference.
| meta | description |
|---|---|
| Type | CurveRange |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:154 |
length
Axis length from top of cone to bottom of cone
. Determines the height of the cone emitter.
| meta | description |
|---|---|
| Type | Number |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:164 |
boxThickness
Particle emitter emission location (for box-type particle emitters).
| meta | description |
|---|---|
| Type | Vec3 |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:174 |
position
Particle Emitter Position
| meta | description |
|---|---|
| Type | Vec3 |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:185 |
rotation
Particle emitter rotation angle.
| meta | description |
|---|---|
| Type | Vec3 |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:202 |
scale
Particle emitter scaling
| meta | description |
|---|---|
| Type | Vec3 |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:219 |
alignToDirection
The direction of particle movement is determined based on the initial direction of the particles.
| meta | description |
|---|---|
| Type | Boolean |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:233 |
randomDirectionAmount
Set particle generation direction randomly.
| meta | description |
|---|---|
| Type | Number |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:241 |
sphericalDirectionAmount
Interpolation between the current emission direction and the direction from the current position to the center of the node.
| meta | description |
|---|---|
| Type | Number |
| Defined in | cocos2d/core/3d/particle/emitter/shape-module.ts:249 |