XII Release 0.1.0
Loading...
Searching...
No Matches
xiiParticleGraphPinDesc Struct Reference

One input or output pin visible in the particle graph editor. More...

#include <ParticleGraph.h>

Public Attributes

xiiHashedString m_sName
 Unique identifier for this pin within its node. For attribute pins, this is the name of the particle attribute. For parameter pins, this is the name of the parameter.
xiiHashedString m_sAttributeName
 For attribute pins, this is the name of the particle attribute this pin reads from or writes to. For parameter pins, this is typically empty and the parameter name is defined in xiiParticleGraphParameterDesc.
xiiEnum< xiiParticleAttributeSemantic > m_Semantic
 Built-in semantic for this pin, which can be used for special handling in the editor or runtime. Custom semantics should use 'Custom' and rely on m_sAttributeName for identification.
xiiEnum< xiiParticleAttributeFormat > m_Format
 Data format of this pin, which determines how data is read from or written to particle attributes or parameters. This should be compatible with the expected format of the attribute or parameter this pin is connected to.
xiiVariant m_DefaultValue
 Default value for this pin, used when no connection is made. For input pins, this value will be used if the pin is not connected to an output. For output pins, this value may be ignored or used as an initial value depending on the node's implementation.
bool m_bRequired = false
 Whether this pin must be connected for the node to function properly. This is a hint for the editor to indicate that the node may not execute or produce valid results if this pin is left unconnected.
bool m_bMultiConnect = false
 Whether this pin can be connected to multiple other pins. For input pins, this allows multiple outputs to feed into the same input, which may require special handling in the node's implementation (e.g., summing forces from multiple sources). For output pins, this allows the output to be used by multiple downstream nodes without needing to add explicit splitter nodes.
bool m_bHidden = false
 Whether this pin should be hidden in the editor. Hidden pins are not visible or connectable in the editor, but can still be used for internal connections or by custom node implementations. This is useful for simplifying the editor UI by hiding pins that are not relevant for most use cases or that are only used for specific configurations.

Detailed Description

One input or output pin visible in the particle graph editor.


The documentation for this struct was generated from the following file:
  • /home/runner/work/XII/XII/Source/Engine/GraphicsCore/Particles/ParticleGraph.h