Simulant  21.12-574
A portable game engine for Windows, OSX, Linux, Dreamcast, and PSP
Classes | Public Member Functions | List of all members
smlt::ParticleSystem Class Reference
Inheritance diagram for smlt::ParticleSystem:
smlt::TypedDestroyableObject< ParticleSystem, Stage > smlt::StageNode smlt::generic::Identifiable< ParticleSystemID > smlt::AudioSource smlt::Loadable smlt::HasMutableRenderPriority smlt::ChainNameable< ParticleSystem > smlt::Nameable smlt::TwoPhaseConstructed smlt::HasAutoID< StageNode > smlt::Organism smlt::BoundableEntity smlt::Updateable smlt::Transformable smlt::Printable smlt::Nameable smlt::TreeNode smlt::DestroyableObject smlt::DestroyableObject

Public Member Functions

 ParticleSystem (Stage *stage, SoundDriver *sound_driver, ParticleScriptPtr script)
 
const AABB & aabb () const override
 
const AABB transformed_aabb () const override
 
bool emitters_active () const
 
void set_emitters_active (bool value=true)
 
void set_destroy_on_completion (bool value=true)
 
bool destroy_on_completion () const
 
bool has_active_emitters () const
 
bool update_when_hidden () const
 If update_when_hidden is true, then particles will continue to be simulated even if the particle system is hidden via set_visible. The default is false. More...
 
void set_update_when_hidden (bool value=true)
 
VertexData * vertex_data () const
 
void clean_up () override
 
void _get_renderables (batcher::RenderQueue *render_queue, const CameraPtr camera, const DetailLevel detail_level) override
 
ParticleScript * script () const
 
void update (float dt) override
 
std::size_t particle_count () const
 
const Particle & particle (const std::size_t i) const
 
- Public Member Functions inherited from smlt::TypedDestroyableObject< ParticleSystem, Stage >
 TypedDestroyableObject (Stage *owner)
 
bool destroy () override
 
bool destroy_immediately () override
 
- Public Member Functions inherited from smlt::DestroyableObject
 DEFINE_SIGNAL (DestroyedSignal, signal_destroyed)
 
bool is_destroyed () const
 
- Public Member Functions inherited from smlt::StageNode
AncestorIteratorPair each_ancestor ()
 
DescendentIteratorPair each_descendent ()
 
SiblingIteratorPair each_sibling ()
 
ChildIteratorPair each_child ()
 
std::string repr () const override
 
 StageNode (Stage *stage, StageNodeType node_type)
 
StageNodeType node_type () const
 
void link_position (StageNode *other)
 
void move_to_absolute (const Vec3 &position)
 
void move_to_absolute (float x, float y, float z)
 
void rotate_to_absolute (const Quaternion &rotation)
 
void rotate_to_absolute (const Degrees &degrees, float x, float y, float z)
 
Vec3 absolute_position () const
 
Quaternion absolute_rotation () const
 
Vec3 absolute_scaling () const
 
Mat4 absolute_transformation () const
 
bool is_visible () const
 
bool is_intended_visible () const
 
void set_visible (bool visible)
 
template<typename T >
void set_parent (const UniqueID< T > &id)
 
void set_parent (TreeNode *node)
 
smlt::Promise< void > destroy_after (const Seconds &seconds)
 
void update (float dt) override
 
void late_update (float dt) override
 
void fixed_update (float step) override
 
bool parent_is_stage () const
 
void clean_up () override
 
const AABB transformed_aabb () const override
 
ShadowCast shadow_cast () const
 
void set_shadow_cast (ShadowCast cast)
 
ShadowReceive shadow_receive () const
 
void set_shadow_receive (ShadowReceive receive)
 
StageNode * find_descendent_with_name (const std::string &name)
 
void set_cullable (bool v)
 
bool is_cullable () const
 
UniqueIDKey key () const
 
- Public Member Functions inherited from smlt::TreeNode
void set_parent (TreeNode *node)
 
void add_child (TreeNode *node)
 
void remove_from_parent ()
 
bool is_root () const
 
bool is_leaf () const
 
TreeNode * parent () const
 
uint32_t child_count () const
 
TreeNode * first_child () const
 
TreeNode * next_node () const
 
TreeNode * previous_node () const
 
TreeNode * child_at (std::size_t i) const
 
- Public Member Functions inherited from smlt::Nameable
void set_name (const std::string &name)
 
const std::string & name () const
 
bool has_name () const
 
- Public Member Functions inherited from smlt::Transformable
smlt::Vec3 position () const
 
smlt::Vec2 position_2d () const
 
smlt::Quaternion rotation () const
 
smlt::Vec3 scale () const
 
virtual void move_to (const smlt::Vec3 &pos)
 
virtual void move_to (const smlt::Vec2 &pos)
 
virtual void move_to (float x, float y, float z)
 
virtual void move_to (float x, float y)
 
virtual void move_by (const smlt::Vec3 &pos)
 
virtual void move_by (const smlt::Vec2 &pos)
 
virtual void move_by (float x, float y, float z)
 
virtual void move_by (float x, float y)
 
virtual void move_forward_by (float amount)
 
virtual void move_right_by (float amount)
 
virtual void move_up_by (float amount)
 
virtual void rotate_to (const smlt::Degrees &angle, float axis_x, float axis_y, float axis_z)
 
virtual void rotate_to (const smlt::Degrees &angle, const smlt::Vec3 &axis)
 
virtual void rotate_to (const smlt::Quaternion &rotation)
 
virtual void rotate_x_by (const smlt::Degrees &angle)
 
virtual void rotate_y_by (const smlt::Degrees &angle)
 
virtual void rotate_z_by (const smlt::Degrees &angle)
 
virtual void rotate_by (const smlt::Degrees &angle_x, const smlt::Degrees &angle_y, const smlt::Degrees &angle_z)
 
virtual void rotate_by (const smlt::Vec3 &angles)
 
virtual void scale_x_by (const float scale)
 
virtual void scale_y_by (const float scale)
 
virtual void scale_z_by (const float scale)
 
virtual void scale_by (float x)
 
virtual void scale_by (const Vec3 &x)
 
virtual void scale_to (const float x, const float y, const float z)
 
virtual void rotate_around (const smlt::Vec3 &axis, const smlt::Degrees &degrees)
 
void rotate_global_x_by (const smlt::Degrees &degrees)
 
void rotate_global_y_by (const smlt::Degrees &degrees)
 
void rotate_global_z_by (const smlt::Degrees &degrees)
 
virtual void look_at (const smlt::Vec3 &target, const Vec3 &up=Vec3::POSITIVE_Y)
 
virtual void look_at (float x, float y, float z, const Vec3 &up=Vec3::POSITIVE_Y)
 
Vec3 right () const
 
Vec3 up () const
 
Vec3 forward () const
 
void constrain_to_aabb (const AABB &region)
 
bool is_constrained () const
 
void remove_constraint ()
 
- Public Member Functions inherited from smlt::Updateable
virtual void _update_thunk (float dt)
 
virtual void _late_update_thunk (float dt)
 
virtual void _fixed_update_thunk (float step)
 
- Public Member Functions inherited from smlt::BoundableEntity
virtual const Vec3 centre () const
 
- Public Member Functions inherited from smlt::Boundable
virtual float width () const
 
virtual float height () const
 
virtual float depth () const
 
virtual float half_width () const
 
virtual float half_height () const
 
virtual float half_depth () const
 
virtual float diameter () const
 
virtual float radius () const
 
- Public Member Functions inherited from smlt::Organism
template<typename T >
bool has_behaviour () const
 
template<typename T >
T * behaviour () const
 
template<typename T >
T * new_behaviour ()
 
template<typename T , typename ... Params>
T * new_behaviour (Params &&... params)
 
void fixed_update_behaviours (float step)
 
void update_behaviours (float dt)
 
void late_update_behaviours (float dt)
 
- Public Member Functions inherited from smlt::HasAutoID< StageNode >
uint64_t auto_id () const
 
- Public Member Functions inherited from smlt::TwoPhaseConstructed
virtual bool init ()
 
- Public Member Functions inherited from smlt::generic::Identifiable< ParticleSystemID >
 Identifiable (ParticleSystemID id)
 
ParticleSystemID id () const
 
virtual bool operator== (const Identifiable< ParticleSystemID > &rhs) const
 
virtual bool operator< (const Identifiable< ParticleSystemID > &rhs) const
 
void _bind_id_pointer (ResourceTypePtr ptr)
 
void _overwrite_id (ParticleSystemID new_id)
 
- Public Member Functions inherited from smlt::AudioSource
 AudioSource (Window *window)
 
 AudioSource (Stage *stage, StageNode *this_as_node, SoundDriver *driver)
 
PlayingSoundPtr play_sound (SoundPtr sound_id, AudioRepeat repeat=AUDIO_REPEAT_NONE, DistanceModel model=DISTANCE_MODEL_DEFAULT)
 
bool stop_sound (PlayingSoundID sound_id)
 
uint8_t playing_sound_count () const
 
uint8_t played_sound_count () const
 
bool is_sound_playing () const
 
sig::signal< void()> & signal_stream_finished ()
 
void update_source (float dt)
 
- Public Member Functions inherited from smlt::HasMutableRenderPriority
void set_render_priority (RenderPriority priority)
 
virtual RenderPriority render_priority () const
 
- Public Member Functions inherited from smlt::ChainNameable< ParticleSystem >
ParticleSystem * set_name_and_get (const std::string &name)
 

Additional Inherited Members

- Public Types inherited from smlt::generic::Identifiable< ParticleSystemID >
typedef ParticleSystemID id_type
 
- Static Public Member Functions inherited from smlt::AudioSource
static void source_update_thread ()
 
- Public Attributes inherited from smlt::TypedDestroyableObject< ParticleSystem, Stage >
friend Owner
 
- Public Attributes inherited from smlt::StageNode
Property< generic::DataCarrier StageNode::* > data = { this, &StageNode::data_ }
 
Property< Stage *StageNode::* > stage = { this, &StageNode::stage_ }
 
- Public Attributes inherited from smlt::AudioSource
Stage * stage_ = nullptr
 
Window * window_ = nullptr
 
SoundDriver * driver_ = nullptr
 
StageNode * node_ = nullptr
 
std::list< PlayingSound::ptr > instances_
 
sig::signal< void()> signal_stream_finished_
 
thread::Mutex mutex_
 
- Protected Member Functions inherited from smlt::StageNode
Stage * get_stage () const
 
void on_transformation_changed () override
 
void on_parent_set (TreeNode *oldp, TreeNode *newp) override
 
virtual void update_transformation_from_parent ()
 
void recalc_bounds_if_necessary () const
 
void mark_transformed_aabb_dirty ()
 
void mark_absolute_transformation_dirty ()
 
- Protected Member Functions inherited from smlt::TreeNode
TreeNode * detach ()
 
TreeNode * last_child () const
 
- Protected Member Functions inherited from smlt::Transformable
void set_position (const Vec3 &p)
 
void set_rotation (const Quaternion &q)
 
void set_scaling (const Vec3 &s)
 
virtual void on_transformation_change_attempted ()
 
- Protected Member Functions inherited from smlt::AudioSource
SoundDriver * _sound_driver () const
 
- Protected Attributes inherited from smlt::DestroyableObject
bool destroyed_ = false
 
- Protected Attributes inherited from smlt::TreeNode
TreeNode * root_ = nullptr
 
TreeNode * parent_ = nullptr
 
TreeNode * first_child_ = nullptr
 
TreeNode * prev_ = this
 
TreeNode * next_ = this
 
- Protected Attributes inherited from smlt::Transformable
Vec3 position_
 
Quaternion rotation_
 
Vec3 scaling_ = Vec3(1, 1, 1)
 
std::unique_ptr< AABB > constraint_
 

Member Function Documentation

◆ update_when_hidden()

bool smlt::ParticleSystem::update_when_hidden ( ) const

If update_when_hidden is true, then particles will continue to be simulated even if the particle system is hidden via set_visible. The default is false.

Returns
True if update_when_hidden is set.
The documentation for this class was generated from the following files:
Generated by doxygen 1.8.20