TubeTrailMesh
Represents a straight tube-shaped PrimitiveMesh with variable width.
Represents a straight tube-shaped PrimitiveMesh with variable width.
TubeTrailMesh represents a straight tube-shaped mesh with variable width. The tube is composed of a number of cylindrical sections, each with the same TubeTrailMesh.SectionLength and number of TubeTrailMesh.SectionRings. A TubeTrailMesh.Curve is sampled along the total length of the tube, meaning that the curve determines the radius of the tube along its length.
This primitive mesh is usually used for particle trails.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
TubeTrailMeshConstructor
public TubeTrailMesh();Properties8
CapBottomProperty
public bool CapBottom { get; set; }Adds tube bottom-cap geometry. Affects mesh geometry, not particle completion or history duration.
CapTopProperty
public bool CapTop { get; set; }Adds tube top-cap geometry. Does not enable history, set alpha mode or automatically repair incompatible poses.
CurveProperty
public Curve Curve { get; set; }Radius profile along the generated tube. Not a motion curve; final deformation also requires compatible poses and a trail material.
RadialStepsProperty
public int RadialSteps { get; set; }Tube circumference subdivisions, 3 to 128. Increase vertex count, not the number of temporal history samples.
RadiusProperty
public float Radius { get; set; }Tube cross-section radius, additionally modulated by Curve. Not TrailLifetime duration or particle collision radius.
SectionLengthProperty
public float SectionLength { get; set; }Rest-geometry section length. Sections times SectionLength describes the rest mesh, not guaranteed final deformed-history length.
SectionRingsProperty
public int SectionRings { get; set; }Subdivision rings within each section, 1 to 1024. Add shape/profile geometry, not simulation or collision steps.
SectionsProperty
public int Sections { get; set; }Rest-tube sections and built-in pose layout, 2 to 128. Not a universal control of final world-space trail length.
Methods16
GetCurveCurve
public Curve GetCurve();Returns Curve. Radius profile along the generated tube. Not a motion curve; final deformation also requires compatible poses and a trail material.
CurveCurrent Curve value; account for units and the setting/effective-result distinction.
GetRadialStepsint
public int GetRadialSteps();Returns RadialSteps. Tube circumference subdivisions, 3 to 128. Increase vertex count, not the number of temporal history samples.
intCurrent RadialSteps value; account for units and the setting/effective-result distinction.
GetRadiusfloat
public float GetRadius();Returns Radius. Tube cross-section radius, additionally modulated by Curve. Not TrailLifetime duration or particle collision radius.
floatCurrent Radius value; account for units and the setting/effective-result distinction.
GetSectionLengthfloat
public float GetSectionLength();Returns SectionLength. Rest-geometry section length. Sections times SectionLength describes the rest mesh, not guaranteed final deformed-history length.
floatCurrent SectionLength value; account for units and the setting/effective-result distinction.
GetSectionRingsint
public int GetSectionRings();Returns SectionRings. Subdivision rings within each section, 1 to 1024. Add shape/profile geometry, not simulation or collision steps.
intCurrent SectionRings value; account for units and the setting/effective-result distinction.
GetSectionsint
public int GetSections();Returns Sections. Rest-tube sections and built-in pose layout, 2 to 128. Not a universal control of final world-space trail length.
intCurrent Sections value; account for units and the setting/effective-result distinction.
IsCapBottombool
public bool IsCapBottom();boolIsCapTopbool
public bool IsCapTop();boolSetCapBottomvoid
public void SetCapBottom(bool capBottom);| Name | Type | Default |
|---|---|---|
capBottom | bool | — |
SetCapTopvoid
public void SetCapTop(bool capTop);| Name | Type | Default |
|---|---|---|
capTop | bool | — |
SetCurvevoid
public void SetCurve(Curve curve);Sets Curve. Radius profile along the generated tube. Not a motion curve; final deformation also requires compatible poses and a trail material.
| Name | Type | Default |
|---|---|---|
curve | Curve | — |
curveRadius profile along the generated tube. Not a motion curve; final deformation also requires compatible poses and a trail material.
SetRadialStepsvoid
public void SetRadialSteps(int radialSteps);Sets RadialSteps. Tube circumference subdivisions, 3 to 128. Increase vertex count, not the number of temporal history samples.
| Name | Type | Default |
|---|---|---|
radialSteps | int | — |
radialStepsTube circumference subdivisions, 3 to 128. Increase vertex count, not the number of temporal history samples.
SetRadiusvoid
public void SetRadius(float radius);Sets Radius. Tube cross-section radius, additionally modulated by Curve. Not TrailLifetime duration or particle collision radius.
| Name | Type | Default |
|---|---|---|
radius | float | — |
radiusTube cross-section radius, additionally modulated by Curve. Not TrailLifetime duration or particle collision radius.
SetSectionLengthvoid
public void SetSectionLength(float sectionLength);Sets SectionLength. Rest-geometry section length. Sections times SectionLength describes the rest mesh, not guaranteed final deformed-history length.
| Name | Type | Default |
|---|---|---|
sectionLength | float | — |
sectionLengthRest-geometry section length. Sections times SectionLength describes the rest mesh, not guaranteed final deformed-history length.
SetSectionRingsvoid
public void SetSectionRings(int sectionRings);Sets SectionRings. Subdivision rings within each section, 1 to 1024. Add shape/profile geometry, not simulation or collision steps.
| Name | Type | Default |
|---|---|---|
sectionRings | int | — |
sectionRingsSubdivision rings within each section, 1 to 1024. Add shape/profile geometry, not simulation or collision steps.
SetSectionsvoid
public void SetSections(int sections);Sets Sections. Rest-tube sections and built-in pose layout, 2 to 128. Not a universal control of final world-space trail length.
| Name | Type | Default |
|---|---|---|
sections | int | — |
sectionsRest-tube sections and built-in pose layout, 2 to 128. Not a universal control of final world-space trail length.