Skip to content

TextStudio3DEffectSpatialField

StructTextStudio.ThreeDTextStudio.3D
public struct TextStudio3DEffectSpatialField

A spherical effect field measured in world units, independent of text scale.

TextStudio3DEffectSpatialField(bool, Vector3, float, float, float)

Section titled “TextStudio3DEffectSpatialField(bool, Vector3, float, float, float)”
public TextStudio3DEffectSpatialField(bool enabled, Vector3 origin, float radius, float edgeWidth, float strength)

Creates a radial field with finite, clamped bounds and strength.

Parameters

Name Type
enabled System.Boolean
origin UnityEngine.Vector3
radius System.Single
edgeWidth System.Single
strength System.Single

public float Evaluate(Vector3 worldPosition, float disabledValue)

Returns the radial weight at a world position, or the supplied value when the field is disabled.

Parameters

Name Type
worldPosition UnityEngine.Vector3
disabledValue System.Single

Returns

System.Single

public TextStudio3DEffectSpatialField WithOffset(Vector3 offset)

Creates a field whose origin is translated by the supplied world-space offset.

Parameters

Name Type
offset UnityEngine.Vector3

Returns

TextStudio.ThreeD.TextStudio3DEffectSpatialField

public bool Equals(TextStudio3DEffectSpatialField other)

Parameters

Name Type
other TextStudio.ThreeD.TextStudio3DEffectSpatialField

Returns

System.Boolean

public override bool Equals(object other)

Parameters

Name Type
other System.Object

Returns

System.Boolean

public override int GetHashCode()

Returns

System.Int32

public bool Enabled { get; }

Returns

System.Boolean

public Vector3 Origin { get; }

Returns

UnityEngine.Vector3

public float Radius { get; }

Returns

System.Single

public float EdgeWidth { get; }

Returns

System.Single

public float Strength { get; }

Returns

System.Single