CubbyFlow::VolumeParticleEmitter3::Builder Class Referencefinal

Front-end to create VolumeParticleEmitter3 objects step by step. More...

#include <Core/Emitter/VolumeParticleEmitter3.hpp>

Public Member Functions

BuilderWithImplicitSurface (const ImplicitSurface3Ptr &implicitSurface)
 Returns builder with implicit surface defining volume shape. More...
 
BuilderWithSurface (const Surface3Ptr &surface)
 Returns builder with surface defining volume shape. More...
 
BuilderWithMaxRegion (const BoundingBox3D &maxRegion)
 Returns builder with max region. More...
 
BuilderWithSpacing (double spacing)
 Returns builder with spacing. More...
 
BuilderWithInitialVelocity (const Vector3D &initialVel)
 Returns builder with initial velocity. More...
 
BuilderWithLinearVelocity (const Vector3D &linearVel)
 Returns builder with linear velocity. More...
 
BuilderWithAngularVelocity (const Vector3D &angularVel)
 Returns builder with angular velocity. More...
 
BuilderWithMaxNumberOfParticles (size_t maxNumberOfParticles)
 Returns builder with max number of particles. More...
 
BuilderWithJitter (double jitter)
 Returns builder with jitter amount. More...
 
BuilderWithIsOneShot (bool isOneShot)
 Returns builder with one-shot flag. More...
 
BuilderWithAllowOverlapping (bool allowOverlapping)
 Returns builder with overlapping flag. More...
 
BuilderWithRandomSeed (uint32_t seed)
 Returns builder with random seed. More...
 
VolumeParticleEmitter3 Build () const
 Builds VolumeParticleEmitter3. More...
 
VolumeParticleEmitter3Ptr MakeShared () const
 Builds shared pointer of VolumeParticleEmitter3 instance. More...
 

Detailed Description

Front-end to create VolumeParticleEmitter3 objects step by step.

Member Function Documentation

◆ Build()

VolumeParticleEmitter3 CubbyFlow::VolumeParticleEmitter3::Builder::Build ( ) const

◆ MakeShared()

VolumeParticleEmitter3Ptr CubbyFlow::VolumeParticleEmitter3::Builder::MakeShared ( ) const

Builds shared pointer of VolumeParticleEmitter3 instance.

◆ WithAllowOverlapping()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithAllowOverlapping ( bool  allowOverlapping)

Returns builder with overlapping flag.

◆ WithAngularVelocity()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithAngularVelocity ( const Vector3D angularVel)

Returns builder with angular velocity.

◆ WithImplicitSurface()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithImplicitSurface ( const ImplicitSurface3Ptr implicitSurface)

Returns builder with implicit surface defining volume shape.

◆ WithInitialVelocity()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithInitialVelocity ( const Vector3D initialVel)

Returns builder with initial velocity.

◆ WithIsOneShot()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithIsOneShot ( bool  isOneShot)

Returns builder with one-shot flag.

◆ WithJitter()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithJitter ( double  jitter)

Returns builder with jitter amount.

◆ WithLinearVelocity()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithLinearVelocity ( const Vector3D linearVel)

Returns builder with linear velocity.

◆ WithMaxNumberOfParticles()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithMaxNumberOfParticles ( size_t  maxNumberOfParticles)

Returns builder with max number of particles.

◆ WithMaxRegion()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithMaxRegion ( const BoundingBox3D maxRegion)

Returns builder with max region.

◆ WithRandomSeed()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithRandomSeed ( uint32_t  seed)

Returns builder with random seed.

◆ WithSpacing()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithSpacing ( double  spacing)

Returns builder with spacing.

◆ WithSurface()

Builder& CubbyFlow::VolumeParticleEmitter3::Builder::WithSurface ( const Surface3Ptr surface)

Returns builder with surface defining volume shape.


The documentation for this class was generated from the following file: