reckfellENGINE

RibbonTrailMesh

Represents a straight ribbon-shaped PrimitiveMesh with variable width.

On this page
class RibbonTrailMeshReckfellSharpInherits PrimitiveMesh

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
# RibbonTrailMesh
C#
public RibbonTrailMesh();

Properties6

CurveProperty
# Curve
C#
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
# SectionLength
C#
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
# SectionSegments
C#
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
# Sections
C#
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
# Shape
C#
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
# Size
C#
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
# GetCurve
C#
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.

Returns Curve

Current Curve value; account for units and the setting/effective-result distinction.

GetSectionLengthfloat
# GetSectionLength
C#
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.

Returns float

Current SectionLength value; account for units and the setting/effective-result distinction.

GetSectionSegmentsint
# GetSectionSegments
C#
public int GetSectionSegments();

Returns SectionSegments. Subdivisions within each section, 1 to 1024. Increases profile/geometry vertex count without adding simulation steps or motion history.

Returns int

Current SectionSegments value; account for units and the setting/effective-result distinction.

GetSectionsint
# GetSections
C#
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.

Returns int

Current Sections value; account for units and the setting/effective-result distinction.

GetShapeRibbonTrailMesh.ShapeEnum
# GetShape
C#
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.

Returns RibbonTrailMesh.ShapeEnum

Current Shape value; account for units and the setting/effective-result distinction.

GetSizefloat
# GetSize
C#
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.

Returns float

Current Size value; account for units and the setting/effective-result distinction.

SetCurvevoid
# SetCurve
C#
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.

Parameters
NameTypeDefault
curveCurve—
curve

Width profile along the generated ribbon. Changes geometry, not particle trajectory or history duration. A detailed profile requires adequate section/segment geometry.

SetSectionLengthvoid
# SetSectionLength
C#
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.

Parameters
NameTypeDefault
sectionLengthfloat—
sectionLength

Rest-mesh section length. Together with Sections defines rest geometry; visible deformed length also depends on history/motion, not only that product.

SetSectionSegmentsvoid
# SetSectionSegments
C#
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.

Parameters
NameTypeDefault
sectionSegmentsint—
sectionSegments

Subdivisions within each section, 1 to 1024. Increases profile/geometry vertex count without adding simulation steps or motion history.

SetSectionsvoid
# SetSections
C#
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.

Parameters
NameTypeDefault
sectionsint—
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.

SetShapevoid
# SetShape
C#
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.

Parameters
NameTypeDefault
shapeRibbonTrailMesh.ShapeEnum—
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.

SetSizevoid
# SetSize
C#
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.

Parameters
NameTypeDefault
sizefloat—
size

Generated ribbon width. Distinct from TrailLifetime history duration and emission-region dimensions. Curve profile, transforms and deformation affect the result.

RibbonTrailMesh.ShapeEnum

ValueDescription
Cross = 1

Gives the mesh two perpendicular flat faces, making a cross shape.

Flat = 0

Gives the mesh a single flat face.

Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.