RibbonTrailMesh
Represents a straight ribbon-shaped PrimitiveMesh with variable width.
Represents a straight ribbon-shaped PrimitiveMesh with variable width.
RibbonTrailMesh represents a straight ribbon-shaped mesh with variable width. The ribbon is composed of a number of flat or cross-shaped sections, each with the same RibbonTrailMesh.SectionLength and number of RibbonTrailMesh.SectionSegments. A RibbonTrailMesh.Curve is sampled along the total length of the ribbon, meaning that the curve determines the size of the ribbon 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
RibbonTrailMeshConstructor
public RibbonTrailMesh();Properties6
CurveProperty
public Curve Curve { get; set; }Width profile along the generated ribbon. Changes geometry, not particle trajectory or history duration. A detailed profile requires adequate section/segment geometry.
SectionLengthProperty
public float SectionLength { get; set; }Rest-mesh section length. Together with Sections defines rest geometry; visible deformed length also depends on history/motion, not only that product.
SectionSegmentsProperty
public int SectionSegments { get; set; }Subdivisions within each section, 1 to 1024. Increases profile/geometry vertex count without adding simulation steps or motion history.
SectionsProperty
public int Sections { get; set; }Rest-geometry sections and built-in pose layout, 2 to 128. More sections increase complexity. Sections times SectionLength does not guarantee final motion-history length.
ShapeProperty
public RibbonTrailMesh.ShapeEnum Shape { get; set; }Flat creates a flat ribbon, Cross crossed geometry. Visibility also depends on culling, billboard mode and camera; choosing the shape does not enable trail history by itself.
SizeProperty
public float Size { get; set; }Generated ribbon width. Distinct from TrailLifetime history duration and emission-region dimensions. Curve profile, transforms and deformation affect the result.
Methods12
GetCurveCurve
public Curve GetCurve();Returns Curve. Width profile along the generated ribbon. Changes geometry, not particle trajectory or history duration. A detailed profile requires adequate section/segment geometry.
CurveCurrent Curve value; account for units and the setting/effective-result distinction.
GetSectionLengthfloat
public float GetSectionLength();Returns SectionLength. Rest-mesh section length. Together with Sections defines rest geometry; visible deformed length also depends on history/motion, not only that product.
floatCurrent SectionLength value; account for units and the setting/effective-result distinction.
GetSectionSegmentsint
public int GetSectionSegments();Returns SectionSegments. Subdivisions within each section, 1 to 1024. Increases profile/geometry vertex count without adding simulation steps or motion history.
intCurrent SectionSegments value; account for units and the setting/effective-result distinction.
GetSectionsint
public int GetSections();Returns Sections. Rest-geometry sections and built-in pose layout, 2 to 128. More sections increase complexity. Sections times SectionLength does not guarantee final motion-history length.
intCurrent Sections value; account for units and the setting/effective-result distinction.
GetShapeRibbonTrailMesh.ShapeEnum
public RibbonTrailMesh.ShapeEnum GetShape();Returns Shape. Flat creates a flat ribbon, Cross crossed geometry. Visibility also depends on culling, billboard mode and camera; choosing the shape does not enable trail history by itself.
RibbonTrailMesh.ShapeEnumCurrent Shape value; account for units and the setting/effective-result distinction.
GetSizefloat
public float GetSize();Returns Size. Generated ribbon width. Distinct from TrailLifetime history duration and emission-region dimensions. Curve profile, transforms and deformation affect the result.
floatCurrent Size value; account for units and the setting/effective-result distinction.
SetCurvevoid
public void SetCurve(Curve curve);Sets Curve. Width profile along the generated ribbon. Changes geometry, not particle trajectory or history duration. A detailed profile requires adequate section/segment geometry.
| Name | Type | Default |
|---|---|---|
curve | Curve | — |
curveWidth profile along the generated ribbon. Changes geometry, not particle trajectory or history duration. A detailed profile requires adequate section/segment geometry.
SetSectionLengthvoid
public void SetSectionLength(float sectionLength);Sets SectionLength. Rest-mesh section length. Together with Sections defines rest geometry; visible deformed length also depends on history/motion, not only that product.
| Name | Type | Default |
|---|---|---|
sectionLength | float | — |
sectionLengthRest-mesh section length. Together with Sections defines rest geometry; visible deformed length also depends on history/motion, not only that product.
SetSectionSegmentsvoid
public void SetSectionSegments(int sectionSegments);Sets SectionSegments. Subdivisions within each section, 1 to 1024. Increases profile/geometry vertex count without adding simulation steps or motion history.
| Name | Type | Default |
|---|---|---|
sectionSegments | int | — |
sectionSegmentsSubdivisions within each section, 1 to 1024. Increases profile/geometry vertex count without adding simulation steps or motion history.
SetSectionsvoid
public void SetSections(int sections);Sets Sections. Rest-geometry sections and built-in pose layout, 2 to 128. More sections increase complexity. Sections times SectionLength does not guarantee final motion-history length.
| Name | Type | Default |
|---|---|---|
sections | int | — |
sectionsRest-geometry sections and built-in pose layout, 2 to 128. More sections increase complexity. Sections times SectionLength does not guarantee final motion-history length.
SetShapevoid
public void SetShape(RibbonTrailMesh.ShapeEnum shape);Sets Shape. Flat creates a flat ribbon, Cross crossed geometry. Visibility also depends on culling, billboard mode and camera; choosing the shape does not enable trail history by itself.
| Name | Type | Default |
|---|---|---|
shape | RibbonTrailMesh.ShapeEnum | — |
shapeFlat creates a flat ribbon, Cross crossed geometry. Visibility also depends on culling, billboard mode and camera; choosing the shape does not enable trail history by itself.
SetSizevoid
public void SetSize(float size);Sets Size. Generated ribbon width. Distinct from TrailLifetime history duration and emission-region dimensions. Curve profile, transforms and deformation affect the result.
| Name | Type | Default |
|---|---|---|
size | float | — |
sizeGenerated ribbon width. Distinct from TrailLifetime history duration and emission-region dimensions. Curve profile, transforms and deformation affect the result.