CubbyFlow::VolumeParticleEmitter2::Builder Class Referencefinal
Front-end to create VolumeParticleEmitter2 objects step by step. More...
#include <Core/Emitter/VolumeParticleEmitter2.h>
Public Member Functions | |
Builder & | WithImplicitSurface (const ImplicitSurface2Ptr &implicitSurface) |
Returns builder with implicit surface defining volume shape. More... | |
Builder & | WithSurface (const Surface2Ptr &surface) |
Returns builder with surface defining volume shape. More... | |
Builder & | WithMaxRegion (const BoundingBox2D &bounds) |
Returns builder with max region. More... | |
Builder & | WithSpacing (double spacing) |
Returns builder with spacing. More... | |
Builder & | WithInitialVelocity (const Vector2D &initialVel) |
Returns builder with initial velocity. More... | |
Builder & | WithMaxNumberOfParticles (size_t maxNumberOfParticles) |
Returns builder with max number of particles. More... | |
Builder & | WithJitter (double jitter) |
Returns builder with jitter amount. More... | |
Builder & | WithIsOneShot (bool isOneShot) |
Returns builder with one-shot flag. More... | |
Builder & | WithAllowOverlapping (bool allowOverlapping) |
Returns builder with overlapping flag. More... | |
Builder & | WithRandomSeed (uint32_t seed) |
Returns builder with random seed. More... | |
VolumeParticleEmitter2 | Build () const |
Builds VolumeParticleEmitter2. More... | |
VolumeParticleEmitter2Ptr | MakeShared () const |
Builds shared pointer of VolumeParticleEmitter2 instance. More... | |
Detailed Description
Front-end to create VolumeParticleEmitter2 objects step by step.
Member Function Documentation
◆ Build()
VolumeParticleEmitter2 CubbyFlow::VolumeParticleEmitter2::Builder::Build | ( | ) | const |
Builds VolumeParticleEmitter2.
◆ MakeShared()
VolumeParticleEmitter2Ptr CubbyFlow::VolumeParticleEmitter2::Builder::MakeShared | ( | ) | const |
Builds shared pointer of VolumeParticleEmitter2 instance.
◆ WithAllowOverlapping()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithAllowOverlapping | ( | bool | allowOverlapping | ) |
Returns builder with overlapping flag.
◆ WithImplicitSurface()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithImplicitSurface | ( | const ImplicitSurface2Ptr & | implicitSurface | ) |
Returns builder with implicit surface defining volume shape.
◆ WithInitialVelocity()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithInitialVelocity | ( | const Vector2D & | initialVel | ) |
Returns builder with initial velocity.
◆ WithIsOneShot()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithIsOneShot | ( | bool | isOneShot | ) |
Returns builder with one-shot flag.
◆ WithJitter()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithJitter | ( | double | jitter | ) |
Returns builder with jitter amount.
◆ WithMaxNumberOfParticles()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithMaxNumberOfParticles | ( | size_t | maxNumberOfParticles | ) |
Returns builder with max number of particles.
◆ WithMaxRegion()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithMaxRegion | ( | const BoundingBox2D & | bounds | ) |
Returns builder with max region.
◆ WithRandomSeed()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithRandomSeed | ( | uint32_t | seed | ) |
Returns builder with random seed.
◆ WithSpacing()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithSpacing | ( | double | spacing | ) |
Returns builder with spacing.
◆ WithSurface()
Builder& CubbyFlow::VolumeParticleEmitter2::Builder::WithSurface | ( | const Surface2Ptr & | surface | ) |
Returns builder with surface defining volume shape.
The documentation for this class was generated from the following file:
- Core/Emitter/VolumeParticleEmitter2.h