TextStudio3DSpatialPlacement
[ExecuteAlways][DisallowMultipleComponent][RequireComponent(typeof(TextStudioText))][AddComponentMenu("Text Studio/3D/Spatial Placement")]public sealed class TextStudio3DSpatialPlacement : MonoBehaviourComponent-provided spatial placement for the shared Text Studio placement pipeline. It computes only position/orientation; ordinary Text Studio effects continue to compose on top through the same per-glyph frame state used by planar renderers.
Fields
Section titled “Fields”
StablePlacementId
Section titled “StablePlacementId”public const string StablePlacementId = "textstudio.3d.spatial"Returns
System.String
Methods
Section titled “Methods”
ApplyPreset(TextStudio3DPlacementPreset)
Section titled “ApplyPreset(TextStudio3DPlacementPreset)”public void ApplyPreset(TextStudio3DPlacementPreset preset)Applies a curated helix, cylinder, sphere-band, tunnel, staircase, or spatial-grid configuration.
Parameters
| Name | Type |
|---|---|
preset |
TextStudio.ThreeD.TextStudio3DPlacementPreset |
ComputePlacements(Vector3[], GlyphPlacement[], int)
Section titled “ComputePlacements(Vector3[], GlyphPlacement[], int)”public void ComputePlacements(Vector3[] layoutPositions, GlyphPlacement[] placements, int glyphCount)Computes renderer-local transforms from source layout positions using the current spatial pattern.
Parameters
| Name | Type |
|---|---|
layoutPositions |
UnityEngine.Vector3[] |
placements |
TextStudio.GlyphPlacement[] |
glyphCount |
System.Int32 |
Remarks
The destination array must have room for every supplied layout position.
ComputePlacements(in PlacementContext, GlyphPlacement[])
Section titled “ComputePlacements(in PlacementContext, GlyphPlacement[])”public void ComputePlacements(in PlacementContext context, GlyphPlacement[] placements)Computes spatial transforms through the base Text Studio placement-provider contract.
Parameters
| Name | Type |
|---|---|
context |
TextStudio.PlacementContext |
placements |
TextStudio.GlyphPlacement[] |
Constructors
Section titled “Constructors”
TextStudio3DSpatialPlacement()
Section titled “TextStudio3DSpatialPlacement()”public TextStudio3DSpatialPlacement()Properties
Section titled “Properties”
public PlacementMode Mode { get; }Returns
TextStudio.PlacementMode
PlacementId
Section titled “PlacementId”public string PlacementId { get; }Stable serialized identifier, namespaced by the owning package.
Returns
System.String
DisplayName
Section titled “DisplayName”public string DisplayName { get; }Customer-facing name shown in Text Studio’s placement chooser.
Returns
System.String
Description
Section titled “Description”public string Description { get; }Short explanation of the placement’s intended use.
Returns
System.String
Dimension
Section titled “Dimension”public TextStudioPlacementDimension Dimension { get; }Whether the placement uses depth in addition to the text plane.
Returns
TextStudio.TextStudioPlacementDimension
Pattern
Section titled “Pattern”public TextStudio3DPlacementPattern Pattern { get; set; }Returns
TextStudio.ThreeD.TextStudio3DPlacementPattern
Orientation
Section titled “Orientation”public TextStudioPlacementOrientation Orientation { get; set; }Returns
TextStudio.TextStudioPlacementOrientation
Radius
Section titled “Radius”public float Radius { get; set; }Returns
System.Single
GridFlow
Section titled “GridFlow”public TextStudio3DSpatialGridFlow GridFlow { get; set; }Returns
TextStudio.ThreeD.TextStudio3DSpatialGridFlow