Overview

Introduction

Installation

Getting Started

Core Features

Influence Modes

Deformation

Refinement & Smoothing

Material Layer System

Modular Character Support

API Reference

Blueprint API

Editor Guide

Asset Editor Overview

Debug Visualization

Resources & Support

Troubleshooting & FAQ

Changelog

Influence Modes

Overview

The FleshRing plugin provides 3 Influence Modes that control how a Ring determines its area of effect on surrounding mesh vertices. Each mode defines two things: which vertices are selected for deformation (Selection) and how much influence each vertex receives (Influence Weight, 0.0 ~ 1.0).

Select a mode from the Effect Range Mode dropdown in the Details panel. The UI automatically shows only the parameters relevant to the selected mode.

[IMAGE: Effect Range Mode dropdown screenshot — showing all 3 mode options]


Mode Comparison

Mesh Based Virtual Ring Virtual Band
Range Source SDF (Signed Distance Field) of the Ring mesh Manually defined cylinder Variable-radius cylinder (Catmull-Rom interpolation)
Precision Highest — conforms to actual mesh shape Medium — simplified geometric model High — supports asymmetric profiles
Performance Medium (SDF texture sampling) Fast (math-only) Fast (math-only)
Best For When a Ring mesh asset exists Simple cylindrical deformations (bracelets, armbands) Stockings / thigh-highs (asymmetric top and bottom)
Key Parameters SDF Bounds Expand X/Y Radius, Thickness, Height 4 Radii, 3 Heights

Mesh Based

Automatically calculates the influence range using the 3D SDF (Signed Distance Field) texture generated from the Ring mesh.

How It Works

  1. Vertex Selection (CPU): Selects all vertices within the SDF bounding box. The selection area can be expanded using SDFBoundsExpandX/Y.
  2. Influence Calculation (GPU): Samples the SDF texture at each vertex's 3D position to compute the distance from the Ring surface, then applies a falloff function.

[GIF: Mesh Based mode — influence range conforming to Ring mesh shape as it is moved/rotated]

Parameters

Parameter Type Default Description
SDF Bounds Expand X float 1.0 Expands the SDF bounding box along the X axis (0.0 ~ 10.0)
SDF Bounds Expand Y float 1.0 Expands the SDF bounding box along the Y axis (0.0 ~ 10.0)

[IMAGE: Mesh Based mode — Details panel showing SDF Bounds Expand parameters]

When to Use


Virtual Ring

Defines the influence range using manually specified cylinder parameters (radius, thickness, height). No Ring mesh asset is required.

How It Works

  1. Vertex Selection (CPU): Selects all vertices inside the defined cylindrical geometry.
  2. Influence Calculation (GPU): Computes distance from the Ring surface along two independent axes — Radial and Axial — then multiplies them to produce the final influence weight.
MaxDistance = RingRadius + RingThickness
RadialInfluence = Falloff(|RadialDist - RingRadius|, RingThickness)
AxialInfluence  = Falloff(|AxisDist|, RingHeight * 0.5)
FinalInfluence  = RadialInfluence * AxialInfluence

[GIF: Virtual Ring mode — adjusting Radius/Thickness/Height with debug visualization showing the cylindrical range]

Parameters

Parameter Type Default Description
Ring Radius float 5.0 cm Inner radius of the Ring. The point where tightness peaks
Ring Thickness float 1.0 cm Radial falloff distance from the Ring surface
Ring Height float 2.0 cm Axial influence range. Extends Height/2 above and below
Ring Offset FVector (0,0,0) Position offset relative to the attached bone
Ring Rotation FRotator (-90,0,0) Rotation of the Ring (controls axis direction)

[IMAGE: Virtual Ring mode — Details panel showing all Ring parameters]

Diagram

        <-- RingThickness -->
        +-------------------+ --+-- RingHeight / 2
        |   +-------------+ |   |
        |   |  Ring        | |   |  <-- RingRadius
        |   |  Surface     | |   |
        |   +-------------+ |   |
        +-------------------+ --+-- RingHeight / 2

[IMAGE: Virtual Ring parameter diagram — visual illustration of Radius, Thickness, and Height relationship]

When to Use


Virtual Band

Defines the influence range using an asymmetric variable-radius cylinder. Optimized for stockings, thigh-highs, and similar garments where the top and bottom profiles differ.

How It Works

  1. Vertex Selection (CPU): Selects only the vertices within the Band Section (tightening region).
  2. Influence Calculation (GPU): Uses a Catmull-Rom spline to interpolate a variable radius based on height. Four control points form a smooth curve, preventing abrupt transitions at section boundaries.

[GIF: Virtual Band mode — adjusting upper/lower radii and heights with debug visualization showing the band shape]

Band Structure

A Virtual Band is composed of 3 sections:

         Upper Bulge Zone
    +--- UpperRadius -------+  --+-- UpperHeight
    |                       |    |
    +--- MidUpperRadius ----+  --+--
    |                       |    |
    |     Band Section      |    +-- BandHeight (Tightening Region)
    |    (Tightness Zone)   |    |
    |                       |    |
    +--- MidLowerRadius ----+  --+--
    |                       |    |
    +--- LowerRadius -------+  --+-- LowerHeight
         Lower Zone

[IMAGE: Virtual Band structure diagram — visual illustration of the 3 sections and 4 radii]

Parameters

Band Transform

Parameter Type Default Description
Band Offset FVector (0,0,0) Position offset relative to the attached bone
Band Rotation FRotator — Rotation of the Band

Band Body (Tightening Region)

Parameter Type Description
Mid Upper Radius float Radius at the top of the tightening zone
Mid Lower Radius float Radius at the bottom of the tightening zone
Band Height float Vertical length of the tightening zone

Upper Bulge Zone

| --- | --- | --- |

Lower Zone

| --- | --- | --- |

[IMAGE: Virtual Band mode — Details panel showing all Band parameters]

Catmull-Rom Interpolation

The four control points (Upper → MidUpper → MidLower → Lower) are connected by a Catmull-Rom spline, producing a smooth curve with no sharp transitions at section boundaries.

[IMAGE: Catmull-Rom interpolation graph — smooth curve connecting the 4 control points]

When to Use


Falloff Types

A shared setting across all Influence Modes. Determines how influence decreases as distance from the Ring surface increases.

| --- | --- | --- |

[IMAGE: Falloff curve comparison graph — Linear / Quadratic / Hermite side by side]


Deformation Pipeline

The Influence Mode only determines the first stage of the pipeline (Selection + Influence). All subsequent deformation stages are identical regardless of which mode is selected.