OutgoingGlyphModule
public sealed class OutgoingGlyphModule : Module3DBase, ITextStudio3DOutgoingMotionDriver, ITextStudio3DOutgoingHandoffModuleRetains the rendered 3D glyphs when the hub replaces text in Overlap Handoff mode. The module is a stateless asset. Every host owns its own bounded runtime pools.
Fields
Section titled “Fields”
MaximumConcurrentChanges
Section titled “MaximumConcurrentChanges”public const int MaximumConcurrentChanges = 8Returns
System.Int32
MaximumGlyphCount
Section titled “MaximumGlyphCount”public const int MaximumGlyphCount = 512Returns
System.Int32
Methods
Section titled “Methods”
OnInactive(TextStudio3DText)
Section titled “OnInactive(TextStudio3DText)”public override void OnInactive(TextStudio3DText host)Called after assembly when an attached post-assembly module is disabled. Lifecycle modules can use this to hide or return previously created output without destroying pools.
Parameters
| Name | Type |
|---|---|
host |
TextStudio.ThreeD.TextStudio3DText |
CanHandleOutgoingHandoff(TextStudio3DText)
Section titled “CanHandleOutgoingHandoff(TextStudio3DText)”public bool CanHandleOutgoingHandoff(TextStudio3DText host)Returns whether this module can retain outgoing glyphs for the supplied host.
Parameters
| Name | Type |
|---|---|
host |
TextStudio.ThreeD.TextStudio3DText |
Returns
System.Boolean
TryHandleOutgoingHandoff(in TextStudio3DOutgoingHandoffContext)
Section titled “TryHandleOutgoingHandoff(in TextStudio3DOutgoingHandoffContext)”public bool TryHandleOutgoingHandoff(in TextStudio3DOutgoingHandoffContext context)Captures outgoing glyph geometry and starts its configured retained-glyph simulation.
Parameters
| Name | Type |
|---|---|
context |
TextStudio.ThreeD.TextStudio3DOutgoingHandoffContext |
Returns
System.Boolean
Constructors
Section titled “Constructors”
OutgoingGlyphModule()
Section titled “OutgoingGlyphModule()”public OutgoingGlyphModule()Properties
Section titled “Properties”
SimulationMode
Section titled “SimulationMode”public TextStudio3DOutgoingSimulationMode SimulationMode { get; }Returns
TextStudio.ThreeD.TextStudio3DOutgoingSimulationMode
Gravity
Section titled “Gravity”public Vector3 Gravity { get; }Returns
UnityEngine.Vector3
InitialVelocity
Section titled “InitialVelocity”public Vector3 InitialVelocity { get; }Returns
UnityEngine.Vector3
Scatter
Section titled “Scatter”public float Scatter { get; }Returns
System.Single
public float Spin { get; }Returns
System.Single
public float Drag { get; }Returns
System.Single
Lifetime
Section titled “Lifetime”public float Lifetime { get; }Returns
System.Single
ShrinkStart
Section titled “ShrinkStart”public float ShrinkStart { get; }Returns
System.Single
MaxConcurrentChanges
Section titled “MaxConcurrentChanges”public int MaxConcurrentChanges { get; }Returns
System.Int32
MaxGlyphs
Section titled “MaxGlyphs”public int MaxGlyphs { get; }Returns
System.Int32
public float Mass { get; }Returns
System.Single
PhysicsMaterial
Section titled “PhysicsMaterial”public PhysicsMaterial PhysicsMaterial { get; }Returns
UnityEngine.PhysicsMaterial
ExecutionStages
Section titled “ExecutionStages”public override ModuleExecutionStage ExecutionStages { get; }Pipeline callbacks used by this module. Typed capability interfaces infer their exact stages; modules using raw callbacks must override this property explicitly.
Returns
TextStudio.ThreeD.ModuleExecutionStage
RequiresUncachedGeometry
Section titled “RequiresUncachedGeometry”public override bool RequiresUncachedGeometry { get; }Whether this module needs isolated glyph geometry instead of shared cached buffers. Contour and post-geometry modules normally do; lifecycle-only modules normally do not.
Returns
System.Boolean
public override TextStudio3DModuleRole Roles { get; }Returns
TextStudio.ThreeD.TextStudio3DModuleRole
RequiredMeshChannels
Section titled “RequiredMeshChannels”public override TextStudio3DMeshChannels RequiredMeshChannels { get; }Returns
TextStudio.ThreeD.TextStudio3DMeshChannels
BoundsBehavior
Section titled “BoundsBehavior”public override TextStudio3DBoundsBehavior BoundsBehavior { get; }Returns
TextStudio.ThreeD.TextStudio3DBoundsBehavior
GeometryImpact
Section titled “GeometryImpact”public override TextStudio3DGeometryImpact GeometryImpact { get; }Returns
TextStudio.ThreeD.TextStudio3DGeometryImpact