Class SerpentineStructure
Generates and owns the anatomical structure of a Serpentine creature.
Inheritance
object
SerpentineStructure
Namespace: CreatureKit.Serpentine
Assembly: CreatureKit.Serpentine.Runtime.dll
Syntax
public sealed class SerpentineStructure : MonoBehaviourConstructors
SerpentineStructure()
Declaration
public SerpentineStructure()Properties
BodyFrames
Current Body frames after all runtime pose contributions.
Declaration
public IReadOnlyList<SerpentineAxialFrame> BodyFrames { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<SerpentineAxialFrame> |
BodyLength
Configured Body length in local units.
Declaration
public float BodyLength { get; }Property Value
| Type | Description |
|---|---|
| float |
BodyRenderer
The generated Body renderer, when available.
Declaration
public SkinnedMeshRenderer BodyRenderer { get; }Property Value
| Type | Description |
|---|---|
| SkinnedMeshRenderer |
GeneratedBodyJointCount
Number of generated Body joints; N joints define N - 1 segments.
Declaration
public int GeneratedBodyJointCount { get; }Property Value
| Type | Description |
|---|---|
| int |
GeneratedHeadCount
Number of generated logical Head parts.
Declaration
public int GeneratedHeadCount { get; }Property Value
| Type | Description |
|---|---|
| int |
GeneratedNeckCount
Number of generated Neck bridges; normally one per Head.
Declaration
public int GeneratedNeckCount { get; }Property Value
| Type | Description |
|---|---|
| int |
GeneratedNeckVertexCount
Total vertices generated by all Neck renderers.
Declaration
public int GeneratedNeckVertexCount { get; }Property Value
| Type | Description |
|---|---|
| int |
HasGeneratedParts
True when the V1 Body part is available.
Declaration
public bool HasGeneratedParts { get; }Property Value
| Type | Description |
|---|---|
| bool |
Parts
The currently generated anatomical parts.
Declaration
public SerpentineParts Parts { get; }Property Value
| Type | Description |
|---|---|
| SerpentineParts |
Methods
ClearGeneratedStructure()
Removes generated parts while preserving this authoring component.
Declaration
public void ClearGeneratedStructure()Rebuild()
Recreates generated parts from the serialized structure settings.
Declaration
public void Rebuild()Events
StructureCleared
Raised after the generated structure has been cleared.
Declaration
public event Action<SerpentineStructure> StructureClearedEvent Type
| Type | Description |
|---|---|
| Action<SerpentineStructure> |
StructureRebuilt
Raised after all generated parts have been rebuilt.
Declaration
public event Action<SerpentineStructure, SerpentineParts> StructureRebuiltEvent Type
| Type | Description |
|---|---|
| Action<SerpentineStructure, SerpentineParts> |