Jet  v1.3.3
Public Member Functions | List of all members
jet::VolumeParticleEmitter3::Builder Class Referencefinal

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

#include <jet/volume_particle_emitter3.h>

Public Member Functions

Builder & withImplicitSurface (const ImplicitSurface3Ptr &implicitSurface)
 Returns builder with implicit surface defining volume shape. More...
 
Builder & withSurface (const Surface3Ptr &surface)
 Returns builder with surface defining volume shape. More...
 
Builder & withMaxRegion (const BoundingBox3D &bounds)
 Returns builder with max region. More...
 
Builder & withSpacing (double spacing)
 Returns builder with spacing. More...
 
Builder & withInitialVelocity (const Vector3D &initialVel)
 Returns builder with initial velocity. More...
 
Builder & withLinearVelocity (const Vector3D &linearVel)
 Returns builder with linear velocity. More...
 
Builder & withAngularVelocity (const Vector3D &angularVel)
 Returns builder with angular 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...
 
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 jet::VolumeParticleEmitter3::Builder::build ( ) const

◆ makeShared()

VolumeParticleEmitter3Ptr jet::VolumeParticleEmitter3::Builder::makeShared ( ) const

Builds shared pointer of VolumeParticleEmitter3 instance.

◆ withAllowOverlapping()

Builder& jet::VolumeParticleEmitter3::Builder::withAllowOverlapping ( bool  allowOverlapping)

Returns builder with overlapping flag.

◆ withAngularVelocity()

Builder& jet::VolumeParticleEmitter3::Builder::withAngularVelocity ( const Vector3D &  angularVel)

Returns builder with angular velocity.

◆ withImplicitSurface()

Builder& jet::VolumeParticleEmitter3::Builder::withImplicitSurface ( const ImplicitSurface3Ptr &  implicitSurface)

Returns builder with implicit surface defining volume shape.

◆ withInitialVelocity()

Builder& jet::VolumeParticleEmitter3::Builder::withInitialVelocity ( const Vector3D &  initialVel)

Returns builder with initial velocity.

◆ withIsOneShot()

Builder& jet::VolumeParticleEmitter3::Builder::withIsOneShot ( bool  isOneShot)

Returns builder with one-shot flag.

◆ withJitter()

Builder& jet::VolumeParticleEmitter3::Builder::withJitter ( double  jitter)

Returns builder with jitter amount.

◆ withLinearVelocity()

Builder& jet::VolumeParticleEmitter3::Builder::withLinearVelocity ( const Vector3D &  linearVel)

Returns builder with linear velocity.

◆ withMaxNumberOfParticles()

Builder& jet::VolumeParticleEmitter3::Builder::withMaxNumberOfParticles ( size_t  maxNumberOfParticles)

Returns builder with max number of particles.

◆ withMaxRegion()

Builder& jet::VolumeParticleEmitter3::Builder::withMaxRegion ( const BoundingBox3D &  bounds)

Returns builder with max region.

◆ withRandomSeed()

Builder& jet::VolumeParticleEmitter3::Builder::withRandomSeed ( uint32_t  seed)

Returns builder with random seed.

◆ withSpacing()

Builder& jet::VolumeParticleEmitter3::Builder::withSpacing ( double  spacing)

Returns builder with spacing.

◆ withSurface()

Builder& jet::VolumeParticleEmitter3::Builder::withSurface ( const Surface3Ptr &  surface)

Returns builder with surface defining volume shape.


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