ezEngine  Milestone 9
ezParticleComponent Class Reference
Inheritance diagram for ezParticleComponent:

Public Member Functions

void Update ()
 
virtual void SerializeComponent (ezWorldWriter &stream) const override
 Override this to save the current state of the component to the given stream. More...
 
virtual void DeserializeComponent (ezWorldReader &stream) override
 Override this to load the current state of the component from the given stream. More...
 
bool StartEffect ()
 Starts a new particle effect. If one is already running, it will be stopped (but not interrupted) and a new one is started as well. More...
 
void StopEffect ()
 Stops emitting further particles, making any existing particle system stop in a finite amount of time.
 
void InterruptEffect ()
 Cancels the entire effect immediately, it will pop out of existence.
 
bool IsEffectActive () const
 Returns true, if an effect is currently in a state where it might emit new particles.
 
void OnSetPlaying (ezMsgSetPlaying &msg)
 
void SetParticleEffect (const ezParticleEffectResourceHandle &hEffect)
 
EZ_ALWAYS_INLINE const ezParticleEffectResourceHandleGetParticleEffect () const
 
void SetParticleEffectFile (const char *szFile)
 
const char * GetParticleEffectFile () const
 
virtual ezResult GetLocalBounds (ezBoundingBoxSphere &bounds, bool &bAlwaysVisible) override
 Called by ezRenderComponent::OnUpdateLocalBounds(). If EZ_SUCCESS is returned, bounds and bAlwaysVisible will be integrated into the ezMsgUpdateLocalBounds result, otherwise the out values are simply ignored.
 
void OnExtractRenderData (ezMsgExtractRenderData &msg) const
 
const ezRangeView< const char *, ezUInt32 > GetParameters () const
 
void SetParameter (const char *szKey, const ezVariant &value)
 
void RemoveParameter (const char *szKey)
 
bool GetParameter (const char *szKey, ezVariant &out_value) const
 
- Public Member Functions inherited from ezRenderComponent
virtual void Deinitialize () override
 This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work. More...
 
virtual void OnActivated () override
 This method is called when the component gets activated. More...
 
void OnUpdateLocalBounds (ezMsgUpdateLocalBounds &msg)
 
void TriggerLocalBoundsUpdate ()
 
EZ_ALWAYS_INLINE ezUInt32 GetUniqueIdForRendering (ezUInt32 uiInnerIndex=0, ezUInt32 uiInnerIndexShift=24) const
 
- Public Member Functions inherited from ezComponent
void SetActive (bool bActive)
 Sets the active state of the component. Note that it is up to the manager if he differentiates between active and inactive components.
 
void Activate ()
 Activates the component. Note that it is up to the manager if he differentiates between active and inactive components.
 
void Deactivate ()
 Deactivates the component.
 
bool IsActive () const
 Returns whether this component is active.
 
bool IsActiveAndInitialized () const
 Returns whether this component is active and initialized.
 
bool IsActiveAndSimulating () const
 Whether the component is currently active and simulation has been started as well.
 
ezComponentManagerBaseGetOwningManager ()
 Returns the corresponding manager for this component.
 
const ezComponentManagerBaseGetOwningManager () const
 Returns the corresponding manager for this component.
 
ezGameObjectGetOwner ()
 Returns the owner game object if the component is attached to one or nullptr.
 
const ezGameObjectGetOwner () const
 Returns the owner game object if the component is attached to one or nullptr.
 
ezWorldGetWorld ()
 Returns the corresponding world for this component.
 
const ezWorldGetWorld () const
 Returns the corresponding world for this component.
 
ezComponentHandle GetHandle () const
 Returns a handle to this component.
 
ezUInt32 GetUniqueID () const
 Returns the unique id for this component.
 
void SetUniqueID (ezUInt32 uiUniqueID)
 Sets the unique id for this component.
 
void EnsureInitialized ()
 Ensures that the component is initialized. Must only be called from another component's Initialize callback.
 
void EnsureSimulationStarted ()
 Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback.
 
bool SendMessage (ezMessage &msg)
 Sends a message to this component.
 
bool SendMessage (ezMessage &msg) const
 
void PostMessage (const ezMessage &msg, ezObjectMsgQueueType::Enum queueType) const
 Queues the message for the given phase and processes it later in that phase.
 
void PostMessage (const ezMessage &msg, ezObjectMsgQueueType::Enum queueType, ezTime delay) const
 Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.
 
void SetUserFlag (ezUInt8 flagIndex, bool set)
 Stores a custom flag. Index must be between 0 and 7. More...
 
bool GetUserFlag (ezUInt8 flagIndex) const
 Retrieves a custom flag. Index must be between 0 and 7.
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTIGetDynamicRTTI () const
 
EZ_ALWAYS_INLINE bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Public Attributes

ezUInt64 m_uiRandomSeed
 
ezString m_sSharedInstanceName
 
bool m_bSpawnAtStart = true
 
bool m_bIfContinuousStopRightAway = false
 
ezEnum< ezOnComponentFinishedAction2m_OnFinishedAction
 
ezTime m_MinRestartDelay
 
ezTime m_RestartDelayRange
 
ezParticleEffectController m_EffectController
 

Protected Member Functions

void OnDeleteObject (ezMsgDeleteGameObject &msg)
 
virtual void OnDeactivated () override
 This method is called when the component gets deactivated. More...
 
void HandOffToFinisher ()
 
void CheckBVolumeUpdate ()
 
- Protected Member Functions inherited from ezComponent
 ezComponent ()
 Keep the constructor private or protected in derived classes, so it cannot be called manually.
 
bool IsDynamic () const
 Returns whether this component is dynamic and thus can only be attached to dynamic game objects.
 
virtual ezUInt16 GetTypeId () const =0
 
virtual ezComponentMode::Enum GetMode () const =0
 
virtual void Initialize ()
 Can be overridden for basic initialization that depends on a valid hierarchy and position. More...
 
virtual void OnSimulationStarted ()
 This method is called once for active components, at the start of the next world update, but only when the world is simulated. More...
 
void EnableUnhandledMessageHandler (bool enable)
 By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.
 
virtual bool OnUnhandledMessage (ezMessage &msg)
 When EnableUnhandledMessageHandler() was activated, called for messages all unhandled messages.
 
virtual bool OnUnhandledMessage (ezMessage &msg) const
 When EnableUnhandledMessageHandler() was activated, called for messages all unhandled messages.
 

Protected Attributes

ezParticleEffectResourceHandle m_hEffectResource
 
ezTime m_RestartTime
 
ezTime m_LastBVolumeUpdate
 
- Protected Attributes inherited from ezComponent
const ezRTTIm_pMessageDispatchType = nullptr
 Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.
 

Friends

class ezParticleEventReaction_Effect
 

Additional Inherited Members

- Static Public Member Functions inherited from ezRenderComponent
static ezUInt32 GetUniqueIdForRendering (const ezComponent *pComponent, ezUInt32 uiInnerIndex=0, ezUInt32 uiInnerIndexShift=24)
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 

Member Function Documentation

◆ DeserializeComponent()

void ezParticleComponent::DeserializeComponent ( ezWorldReader stream)
overridevirtual

Override this to load the current state of the component from the given stream.

The active state will be automatically serialized. The 'initialized' state is not serialized, all components will be initialized after creation, even if they were already in an initialized state when they were serialized.

Reimplemented from ezComponent.

◆ OnDeactivated()

void ezParticleComponent::OnDeactivated ( )
overrideprotectedvirtual

This method is called when the component gets deactivated.

Upon destruction, a component that is active first gets deactivated. Therefore OnDeactivated() should be used for typical game code cleanup.

See also
OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from ezRenderComponent.

◆ SerializeComponent()

void ezParticleComponent::SerializeComponent ( ezWorldWriter stream) const
overridevirtual

Override this to save the current state of the component to the given stream.

Todo:
store effect state

Reimplemented from ezComponent.

◆ StartEffect()

bool ezParticleComponent::StartEffect ( )

Starts a new particle effect. If one is already running, it will be stopped (but not interrupted) and a new one is started as well.

Returns false, if no valid particle resource is specified.


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