VfxShapeVolume

Inheritance 1 ancestor · 2 siblings · 3 descendants

• IVfxShape
  • VfxShapeLegacy
  • VfxShapePointDoNotUse
  • VfxShapeVolumecurrent
    • VfxShapeBox
    • VfxShapeCylinder
    • VfxShapeSphere

Class Documentation

Edit documentation

A spawn shape that samples either the boundary or the interior of a volume. flags selects which.

Properties

flags

U8

Documentation Edit documentation

Bit mask that selects where the shape samples.

Bit	Name	Effect
0x1	Interior	Samples the interior instead of the boundary.

What the bit does on each shape:

Shape	Bit 0x1 clear	Bit 0x1 set
VfxShapeBox	A point on one face, with a random quarter turn.	Uniform in the solid box, with no turn.
VfxShapeCylinder	On the side surface, radius from the axis.	The radial coordinate is uniform in -radius..radius.
VfxShapeSphere	On the sphere, radius from the centre.	The distance from the centre is uniform in 0..radius.

Notes

• The client reads only bit 0x1. The other bits have no effect.
• The cylinder and sphere interior modes are not corrected for volume, so their samples cluster toward the axis or the centre.

flags