 |
ezEngine
Release 25.03
|
|
ezEngine
Release 25.03
|
A cylindrical volume in which wind shall be applied. More...
#include <WindVolumeComponent.h>
Public Member Functions | |
| virtual void | SerializeComponent (ezWorldWriter &inout_stream) const override |
| Override this to save the current state of the component to the given stream. | |
| virtual void | DeserializeComponent (ezWorldReader &inout_stream) override |
| Override this to load the current state of the component from the given stream. More... | |
| virtual ezSimdVec4f | ComputeForceAtLocalPosition (const ezSimdVec4f &vLocalPos) const override |
| float | GetRadius () const |
| void | SetRadius (float fVal) |
| float | GetRadiusFalloff () const |
| void | SetRadiusFalloff (float fVal) |
| float | GetLength () const |
| void | SetLength (float fVal) |
| float | GetPositiveFalloff () const |
| void | SetPositiveFalloff (float fVal) |
| float | GetNegativeFalloff () const |
| void | SetNegativeFalloff (float fVal) |
 Public Member Functions inherited from ezWindVolumeComponent | |
| ezSimdVec4f | ComputeForceAtGlobalPosition (const ezSimdVec4f &vGlobalPos) const |
| Computes the wind force at a global position. More... | |
| Public Member Functions inherited from ezComponent | |
| void | SetActiveFlag (bool bEnabled) |
| Sets the active flag of the component, which affects its active state. More... | |
| bool | GetActiveFlag () const |
| Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'. More... | |
| bool | IsActive () const |
| Checks whether this component is in an active state. More... | |
| bool | IsActiveAndInitialized () const |
| Returns whether this component is active and initialized. More... | |
| bool | IsActiveAndSimulating () const |
| Whether the component is currently active and simulation has been started as well. More... | |
| ezComponentManagerBase * | GetOwningManager () |
| Returns the corresponding manager for this component. | |
| const ezComponentManagerBase * | GetOwningManager () const |
| Returns the corresponding manager for this component. | |
| ezGameObject * | GetOwner () |
| Returns the owner game object if the component is attached to one or nullptr. | |
| const ezGameObject * | GetOwner () const |
| Returns the owner game object if the component is attached to one or nullptr. | |
| ezWorld * | GetWorld () |
| Returns the corresponding world for this component. | |
| const ezWorld * | GetWorld () 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. | |
| EZ_ALWAYS_INLINE bool | SendMessage (ezMessage &ref_msg) |
| Sends a message to this component. | |
| EZ_ALWAYS_INLINE bool | SendMessage (ezMessage &ref_msg) const |
| void | PostMessage (const ezMessage &msg, ezTime delay=ezTime::MakeZero(), ezObjectMsgQueueType::Enum queueType=ezObjectMsgQueueType::NextFrame) const |
| Queues the message for the given phase. The message is processed after the given delay in the corresponding phase. | |
| virtual bool | HandlesMessage (const ezMessage &msg) const |
| Returns whether the given Message is handled by this component. | |
| void | SetUserFlag (ezUInt8 uiFlagIndex, bool bSet) |
| Be careful to check which flags may already be in use by base classes. | |
| bool | GetUserFlag (ezUInt8 uiFlagIndex) const |
| Retrieves a custom flag. Index must be between 0 and 7. | |
| void | SetCreatedByPrefab () |
| Adds ezObjectFlags::CreatedByPrefab to the component. See the flag for details. | |
| bool | WasCreatedByPrefab () const |
| Checks whether the ezObjectFlags::CreatedByPrefab flag is set on this component. | |
| Public Member Functions inherited from ezReflectedClass | |
| virtual const ezRTTI * | GetDynamicRTTI () const |
| 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 | |
| ezEnum< ezWindVolumeCylinderMode > | m_Mode |
| Public Attributes inherited from ezWindVolumeComponent | |
| ezTime | m_BurstDuration |
| If non-zero, the wind will only last for a limited amount of time. | |
| ezEnum< ezWindStrength > | m_Strength |
| How strong the wind shall blow at the strongest point of the volume. | |
| float | m_fStrengthFactor = 1.0f |
| Factor to scale the wind strength. Negative values can be used to reverse the wind direction. | |
| ezEnum< ezOnComponentFinishedAction > | m_OnFinishedAction |
| What happens after the wind burst is over. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ezNoBase | |
| static const ezRTTI * | GetStaticRTTI () |
| Static Public Attributes inherited from ezWindVolumeComponent | |
| static ezSpatialData::Category | SpatialDataCategory = ezSpatialData::RegisterCategory("WindVolumes", ezSpatialData::Flags::None) |
| The spatial category to use to find all wind volume components through the spatial system. | |
| Protected Member Functions inherited from ezWindVolumeComponent | |
| virtual void | OnActivated () override |
| This method is called when the component gets activated. More... | |
| virtual void | OnDeactivated () override |
| This method is called when the component gets deactivated. More... | |
| virtual void | OnSimulationStarted () override |
| 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 | OnTriggered (ezMsgComponentInternalTrigger &msg) |
| void | OnMsgDeleteGameObject (ezMsgDeleteGameObject &msg) |
| float | GetWindInMetersPerSecond () const |
| 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 ezWorldModuleTypeId | 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 | Deinitialize () |
| This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work. More... | |
| void | EnableUnhandledMessageHandler (bool enable) |
| By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message. | |
| virtual bool | OnUnhandledMessage (ezMessage &msg, bool bWasPostedMsg) |
| When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. More... | |
| virtual bool | OnUnhandledMessage (ezMessage &msg, bool bWasPostedMsg) const |
| When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. More... | |
| bool | IsInitialized () const |
| bool | IsInitializing () const |
| bool | IsSimulationStarted () const |
| Protected Attributes inherited from ezComponent | |
| const ezRTTI * | m_pMessageDispatchType = nullptr |
| Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary. | |
A cylindrical volume in which wind shall be applied.
The wind direction may be either outwards from the cylinder center, or tangential (a vortex).
|
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 ezWindVolumeComponent.
1.8.17