 |
XII Release 0.1.0
|
|
XII Release 0.1.0
|
Scene component that exposes a GPU particle system to extraction and tooling. More...
#include <ParticleSystem.h>
Public Member Functions | |
| virtual void | SerializeComponent (xiiWorldWriter &inout_stream) const override |
| Override this to save the current state of the component to the given stream. | |
| virtual void | DeserializeComponent (xiiWorldReader &inout_stream) override |
| virtual xiiResult | GetLocalBounds (xiiBoundingBoxSphere &ref_bounds, bool &ref_bAlwaysVisible, xiiMsgUpdateLocalBounds &ref_msg) override |
| void | SetDescriptor (const xiiParticleSystemDescriptor &descriptor) |
| Sets the descriptor for the particle system, which defines the behavior of the simulation and rendering. This can be called at any time to update the configuration of the particle system, but changes will only take effect after PrepareRuntimeResources() is called to ensure that the runtime has sufficient resources for the new descriptor. The exact semantics of changing the descriptor (e.g., whether it resets the simulation state or requires re-initialization) are defined by the implementation of the component and runtime. | |
| const xiiParticleSystemDescriptor & | GetDescriptor () const |
| Returns the current descriptor for the particle system, which contains the configuration for the simulation and rendering. This can be used for reference or for making decisions about how to configure emitters or other aspects of the particle graph based on the current settings. The exact semantics of the descriptor (e.g., whether it reflects pending changes that have not yet been applied to the runtime) are defined by the implementation of the component and runtime. | |
| void | SetParticleGraph (const xiiParticleGraphResourceHandle &hGraph) |
| Sets the particle graph resource handle, which defines the logic of the simulation and rendering. This can be called at any time to update the behavior of the particle system, but changes will only take effect after PrepareRuntimeResources() is called to ensure that the runtime has sufficient resources for the new graph. The exact semantics of changing the graph (e.g., whether it resets the simulation state or requires re-initialization) are defined by the implementation of the component and runtime. | |
| const xiiParticleGraphResourceHandle & | GetParticleGraph () const |
| Returns the current particle graph resource handle, which defines the logic of the simulation and rendering. This can be used for reference or for making decisions about how to configure emitters or other aspects of the particle graph based on the current graph. The exact semantics of the graph (e.g., whether it reflects pending changes that have not yet been applied to the runtime) are defined by the implementation of the component and runtime. | |
| xiiResult | PrepareRuntimeResources (xiiSharedPtr< xiiGALDevice > pDevice) const |
| Prepares the runtime resources for the particle system based on the current descriptor and graph settings. This should be called after setting the descriptor and graph to ensure that the runtime has sufficient resources for simulation and rendering. Returns failure if resource preparation fails (e.g., due to insufficient GPU resources or invalid descriptor/graph parameters), in which case the runtime may be left in an uninitialized or partially initialized state. | |
| xiiParticleSystemRuntime & | GetRuntime () const |
| Returns a reference to the particle system runtime, which manages the GPU resources and simulation for this particle system. This can be used for accessing buffers, adding simulation passes, or other operations related to the runtime. The exact semantics of the runtime (e.g., whether it reflects pending changes that have not yet been applied to GPU resources) are defined by the implementation of the component and runtime. | |
| xiiParticleSystemRuntimeHandle | GetRuntimeHandle () const |
| Public Member Functions inherited from xiiRenderComponent | |
| virtual xiiBitflags< xiiRenderExtractionCategory > | GetRenderExtractionCategories () const |
| virtual bool | IsRenderDataViewIndependent () const |
| void | TriggerLocalBoundsUpdate () |
| Call this when some value was modified that affects the size of the local bounding box and it should be recomputed. | |
| XII_ALWAYS_INLINE xiiUInt32 | GetUniqueIdForRendering (xiiUInt32 uiInnerIndex=0, xiiUInt32 uiInnerIndexShift=24) const |
| Computes a unique ID for the given component, that is usually given to the renderer to distinguish objects. | |
| Public Member Functions inherited from xiiComponent | |
| void | SetActiveFlag (bool bEnabled) |
| bool | GetActiveFlag () const |
| bool | IsActive () const |
| bool | IsActiveAndInitialized () const |
| bool | IsActiveAndSimulating () const |
| xiiComponentManagerBase * | GetOwningManager () |
| Returns the corresponding manager for this component. | |
| const xiiComponentManagerBase * | GetOwningManager () const |
| Returns the corresponding manager for this component. | |
| xiiGameObject * | GetOwner () |
| Returns the owner game object if the component is attached to one or nullptr. | |
| const xiiGameObject * | GetOwner () const |
| Returns the owner game object if the component is attached to one or nullptr. | |
| xiiWorld * | GetWorld () |
| Returns the corresponding world for this component. | |
| const xiiWorld * | GetWorld () const |
| Returns the corresponding world for this component. | |
| xiiComponentHandle | GetHandle () const |
| Returns a handle to this component. | |
| xiiUInt32 | GetUniqueID () const |
| Returns the unique id for this component. | |
| void | SetUniqueID (xiiUInt32 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 () |
| XII_ALWAYS_INLINE bool | SendMessage (xiiMessage &ref_msg) |
| Sends a message to this component. | |
| XII_ALWAYS_INLINE bool | SendMessage (xiiMessage &ref_msg) const |
| void | PostMessage (const xiiMessage &msg, xiiTime delay=xiiTime::MakeZero(), xiiObjectMsgQueueType::Enum queueType=xiiObjectMsgQueueType::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 xiiMessage &msg) const |
| Returns whether the given Message is handled by this component. | |
| void | SetUserFlag (xiiUInt8 uiFlagIndex, bool bSet) |
| Be careful to check which flags may already be in use by base classes. | |
| bool | GetUserFlag (xiiUInt8 uiFlagIndex) const |
| Retrieves a custom flag. Index must be between 0 and 7. | |
| void | SetCreatedByPrefab () |
| Adds xiiObjectFlags::CreatedByPrefab to the component. See the flag for details. | |
| bool | WasCreatedByPrefab () const |
| Checks whether the xiiObjectFlags::CreatedByPrefab flag is set on this component. | |
| void | DeleteComponent () |
| Deletes this component. Note that the component will be invalidated first and the actual deletion is postponed. | |
| Public Member Functions inherited from xiiReflectedClass | |
| virtual const xiiRTTI * | GetDynamicRTTI () const |
| bool | IsInstanceOf (const xiiRTTI *pType) const |
| Returns whether the type of this instance is of the given type or derived from it. | |
| template<typename T> | |
| XII_ALWAYS_INLINE bool | IsInstanceOf () const |
| Returns whether the type of this instance is of the given type or derived from it. | |
Protected Member Functions | |
| void | OnMsgExtractRenderData (xiiMsgExtractRenderData &ref_msg) const |
| Protected Member Functions inherited from xiiRenderComponent | |
| virtual void | Deinitialize () override |
| virtual void | OnActivated () override |
| virtual void | OnDeactivated () override |
| void | OnUpdateLocalBounds (xiiMsgUpdateLocalBounds &msg) |
| void | InvalidateCachedRenderData () |
| void | OnTransformChanged (xiiMsgTransformChanged &msg) |
| Protected Member Functions inherited from xiiComponent | |
| xiiComponent () | |
| 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 xiiWorldModuleTypeId | GetTypeId () const =0 |
| virtual xiiComponentMode::Enum | GetMode () const =0 |
| virtual void | Initialize () |
| virtual void | OnSimulationStarted () |
| void | EnableUnhandledMessageHandler (bool enable) |
| By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message. | |
| virtual bool | OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg) |
| virtual bool | OnUnhandledMessage (xiiMessage &msg, bool bWasPostedMsg) const |
| bool | IsInitialized () const |
| bool | IsInitializing () const |
| bool | IsSimulationStarted () const |
Additional Inherited Members | |
| Static Public Member Functions inherited from xiiRenderComponent | |
| static xiiUInt32 | GetUniqueIdForRendering (const xiiComponent &component, xiiUInt32 uiInnerIndex=0, xiiUInt32 uiInnerIndexShift=24) |
| Computes a unique ID for the given component, that is usually given to the renderer to distinguish objects. | |
| Static Public Member Functions inherited from xiiNoBase | |
| static const xiiRTTI * | GetStaticRTTI () |
| Protected Attributes inherited from xiiComponent | |
| const xiiRTTI * | m_pMessageDispatchType = nullptr |
| Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary. | |
Scene component that exposes a GPU particle system to extraction and tooling.
|
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 xiiComponent.
|
overridevirtual |
Called by xiiRenderComponent::OnUpdateLocalBounds().
If XII_SUCCESS is returned, out_bounds and out_bAlwaysVisible will be integrated into the xiiMsgUpdateLocalBounds ref_msg, otherwise the out values are simply ignored.
Implements xiiRenderComponent.
|
overridevirtual |
Override this to save the current state of the component to the given stream.
Reimplemented from xiiComponent.
1.15.0