Struct RibbonEmitter 

pub struct RibbonEmitter { /* private fields */ }

RIB_ — Ribbon emitter (v4–v9, 744–760 bytes)

Ribbon strip effect with per-particle lifetime, velocity, color/size curves, physics, noise, spline segments, variation channels, and smoothing/collision settings. Shares many fields with ParticleEmitter.

Implementations

impl RibbonEmitter

pub fn new() -> Self

Panics

Panics if the native allocation fails.

pub fn bone_index(&self) -> u16

Primary bone index

pub fn set_bone_index(&mut self, value: u16)

pub fn bone_index_fallback(&self) -> u16

Fallback bone index

pub fn set_bone_index_fallback(&mut self, value: u16)

pub fn material_index(&self) -> u32

Index into MATM material map array

pub fn set_material_index(&mut self, value: u32)

pub fn additional_flags(&self) -> RibbonAdditionalFlag

Additional flags (v8+)

pub fn set_additional_flags(&mut self, value: RibbonAdditionalFlag)

pub fn initial_speed(&self) -> Ref<'_, AnimRefF32>

Initial ribbon segment speed Borrows the field in place — no copy, no allocation.

pub fn initial_speed_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn initial_speed_random(&self) -> Ref<'_, AnimRefF32>

Random speed variation Borrows the field in place — no copy, no allocation.

pub fn initial_speed_random_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn initial_yaw(&self) -> Ref<'_, AnimRefF32>

Initial yaw angle Borrows the field in place — no copy, no allocation.

pub fn initial_yaw_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn initial_pitch(&self) -> Ref<'_, AnimRefF32>

Initial pitch angle Borrows the field in place — no copy, no allocation.

pub fn initial_pitch_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn initial_horizontal(&self) -> Ref<'_, AnimRefF32>

Initial horizontal spread Borrows the field in place — no copy, no allocation.

pub fn initial_horizontal_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn initial_vertical(&self) -> Ref<'_, AnimRefF32>

Initial vertical spread Borrows the field in place — no copy, no allocation.

pub fn initial_vertical_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn lifetime(&self) -> Ref<'_, AnimRefF32>

Base segment lifetime Borrows the field in place — no copy, no allocation.

pub fn lifetime_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn lifetime_random(&self) -> Ref<'_, AnimRefF32>

Random lifetime variation Borrows the field in place — no copy, no allocation.

pub fn lifetime_random_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn kill_radius(&self) -> u32

Kill radius

pub fn set_kill_radius(&mut self, value: u32)

pub fn gravity_x(&self) -> f32

Gravity X component

pub fn set_gravity_x(&mut self, value: f32)

pub fn gravity_y(&self) -> f32

Gravity Y component

pub fn set_gravity_y(&mut self, value: f32)

pub fn gravity(&self) -> f32

Gravity Z component

pub fn set_gravity(&mut self, value: f32)

pub fn size_mid_time(&self) -> f32

Size midpoint time (0–1)

pub fn set_size_mid_time(&mut self, value: f32)

pub fn color_mid_time(&self) -> f32

Color midpoint time (0–1)

pub fn set_color_mid_time(&mut self, value: f32)

pub fn alpha_mid_time(&self) -> f32

Alpha midpoint time (0–1)

pub fn set_alpha_mid_time(&mut self, value: f32)

pub fn rotation_mid_time(&self) -> f32

Rotation midpoint time (0–1)

pub fn set_rotation_mid_time(&mut self, value: f32)

pub fn size_mid_hold_time(&self) -> f32

Size hold time at midpoint

pub fn set_size_mid_hold_time(&mut self, value: f32)

pub fn color_mid_hold_time(&self) -> f32

Color hold time at midpoint

pub fn set_color_mid_hold_time(&mut self, value: f32)

pub fn alpha_mid_hold_time(&self) -> f32

Alpha hold time at midpoint

pub fn set_alpha_mid_hold_time(&mut self, value: f32)

pub fn rotation_mid_hold_time(&self) -> f32

Rotation hold time at midpoint

pub fn set_rotation_mid_hold_time(&mut self, value: f32)

pub fn size_animation(&self) -> Ref<'_, AnimRefVector3f>

Size curve (start, mid, end) Borrows the field in place — no copy, no allocation.

pub fn size_animation_mut(&mut self) -> RefMut<'_, AnimRefVector3f>

pub fn rotation_animation(&self) -> Ref<'_, AnimRefVector3f>

Rotation curve (start, mid, end) Borrows the field in place — no copy, no allocation.

pub fn rotation_animation_mut(&mut self) -> RefMut<'_, AnimRefVector3f>

pub fn color_start(&self) -> Ref<'_, AnimRefM3ColorBGRA>

Color at birth Borrows the field in place — no copy, no allocation.

pub fn color_start_mut(&mut self) -> RefMut<'_, AnimRefM3ColorBGRA>

pub fn color_mid(&self) -> Ref<'_, AnimRefM3ColorBGRA>

Color at midpoint Borrows the field in place — no copy, no allocation.

pub fn color_mid_mut(&mut self) -> RefMut<'_, AnimRefM3ColorBGRA>

pub fn color_end(&self) -> Ref<'_, AnimRefM3ColorBGRA>

Color at death Borrows the field in place — no copy, no allocation.

pub fn color_end_mut(&mut self) -> RefMut<'_, AnimRefM3ColorBGRA>

pub fn drag(&self) -> f32

Air drag coefficient

pub fn set_drag(&mut self, value: f32)

pub fn mass(&self) -> f32

Segment mass

pub fn set_mass(&mut self, value: f32)

pub fn mass_random(&self) -> f32

Random mass variation

pub fn set_mass_random(&mut self, value: f32)

pub fn mass_size_multiplier(&self) -> f32

Mass–size coupling

pub fn set_mass_size_multiplier(&mut self, value: f32)

pub fn local_forces(&self) -> u16

Local force channel bitmask

pub fn set_local_forces(&mut self, value: u16)

pub fn world_forces(&self) -> u16

World force channel bitmask

pub fn set_world_forces(&mut self, value: u16)

pub fn local_forces_fallback(&self) -> u16

Fallback local force channels

pub fn set_local_forces_fallback(&mut self, value: u16)

pub fn world_forces_fallback(&self) -> u16

Fallback world force channels

pub fn set_world_forces_fallback(&mut self, value: u16)

pub fn world_forces_mass_multiplier(&self) -> f32

World force mass multiplier

pub fn set_world_forces_mass_multiplier(&mut self, value: f32)

pub fn noise_amplitude(&self) -> f32

Noise displacement amplitude

pub fn set_noise_amplitude(&mut self, value: f32)

pub fn noise_frequency(&self) -> f32

Noise spatial frequency

pub fn set_noise_frequency(&mut self, value: f32)

pub fn noise_coherence(&self) -> f32

Noise temporal coherence

pub fn set_noise_coherence(&mut self, value: f32)

pub fn noise_edge(&self) -> f32

Noise edge sharpness

pub fn set_noise_edge(&mut self, value: f32)

pub fn index_plus_length(&self) -> u32

Index + length

pub fn set_index_plus_length(&mut self, value: u32)

pub fn emitter_shape(&self) -> u32

Emitter shape type

pub fn set_emitter_shape(&mut self, value: u32)

pub fn ribbon_type(&self) -> RibbonType

Ribbon cross-section type

pub fn set_ribbon_type(&mut self, value: RibbonType)

pub fn divisions(&self) -> f32

Number of ribbon divisions

pub fn set_divisions(&mut self, value: f32)

pub fn edges(&self) -> u32

Number of cross-section edges

pub fn set_edges(&mut self, value: u32)

pub fn inner_radius(&self) -> f32

Inner radius

pub fn set_inner_radius(&mut self, value: f32)

pub fn max_length(&self) -> Ref<'_, AnimRefF32>

Animated maximum ribbon length Borrows the field in place — no copy, no allocation.

pub fn max_length_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn spline_ribbons_len(&self) -> usize

Spline ribbon segments (SRIB)

pub fn spline_ribbons(&self, index: usize) -> Option<Ref<'_, SplineRibbon>>

Borrows element index in place. None when out of range.

pub fn spline_ribbons_mut( &mut self, index: usize, ) -> Option<RefMut<'_, SplineRibbon>>

pub fn spline_ribbons_iter( &self, ) -> impl ExactSizeIterator<Item = Ref<'_, SplineRibbon>>

Iterate the elements, borrowing each in turn.

pub fn resize_spline_ribbons(&mut self, count: usize)

pub fn active(&self) -> Ref<'_, AnimRefU32>

Animated active state Borrows the field in place — no copy, no allocation.

pub fn active_mut(&mut self) -> RefMut<'_, AnimRefU32>

pub fn flags(&self) -> RibbonFlag

Ribbon emitter flags

pub fn set_flags(&mut self, value: RibbonFlag)

pub fn size_smoothing(&self) -> InterpolationMode

Size interpolation mode

pub fn set_size_smoothing(&mut self, value: InterpolationMode)

pub fn color_smoothing(&self) -> InterpolationMode

Color interpolation mode

pub fn set_color_smoothing(&mut self, value: InterpolationMode)

pub fn friction(&self) -> f32

Friction coefficient

pub fn set_friction(&mut self, value: f32)

pub fn bounce(&self) -> f32

Bounce coefficient

pub fn set_bounce(&mut self, value: f32)

pub fn lod_reduce(&self) -> u32

LOD reduction level

pub fn set_lod_reduce(&mut self, value: u32)

pub fn lod_cut(&self) -> u32

LOD cut-off level

pub fn set_lod_cut(&mut self, value: u32)

pub fn yaw_type(&self) -> u32

Yaw variation type

pub fn set_yaw_type(&mut self, value: u32)

pub fn yaw_amplitude(&self) -> Ref<'_, AnimRefF32>

Yaw variation amplitude Borrows the field in place — no copy, no allocation.

pub fn yaw_amplitude_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn yaw_frequency(&self) -> Ref<'_, AnimRefF32>

Yaw variation frequency Borrows the field in place — no copy, no allocation.

pub fn yaw_frequency_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn pitch_type(&self) -> u32

Pitch variation type

pub fn set_pitch_type(&mut self, value: u32)

pub fn pitch_amplitude(&self) -> Ref<'_, AnimRefF32>

Pitch variation amplitude Borrows the field in place — no copy, no allocation.

pub fn pitch_amplitude_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn pitch_frequency(&self) -> Ref<'_, AnimRefF32>

Pitch variation frequency Borrows the field in place — no copy, no allocation.

pub fn pitch_frequency_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn speed_type(&self) -> u32

Speed variation type

pub fn set_speed_type(&mut self, value: u32)

pub fn speed_amplitude(&self) -> Ref<'_, AnimRefF32>

Speed variation amplitude Borrows the field in place — no copy, no allocation.

pub fn speed_amplitude_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn speed_frequency(&self) -> Ref<'_, AnimRefF32>

Speed variation frequency Borrows the field in place — no copy, no allocation.

pub fn speed_frequency_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn size_type(&self) -> u32

Size variation type

pub fn set_size_type(&mut self, value: u32)

pub fn size_amplitude(&self) -> Ref<'_, AnimRefF32>

Size variation amplitude Borrows the field in place — no copy, no allocation.

pub fn size_amplitude_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn size_frequency(&self) -> Ref<'_, AnimRefF32>

Size variation frequency Borrows the field in place — no copy, no allocation.

pub fn size_frequency_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn alpha_type(&self) -> u32

Alpha variation type

pub fn set_alpha_type(&mut self, value: u32)

pub fn alpha_amplitude(&self) -> Ref<'_, AnimRefF32>

Alpha variation amplitude Borrows the field in place — no copy, no allocation.

pub fn alpha_amplitude_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn alpha_frequency(&self) -> Ref<'_, AnimRefF32>

Alpha variation frequency Borrows the field in place — no copy, no allocation.

pub fn alpha_frequency_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn particle_velocity(&self) -> Ref<'_, AnimRefF32>

Animated parent velocity influence Borrows the field in place — no copy, no allocation.

pub fn particle_velocity_mut(&mut self) -> RefMut<'_, AnimRefF32>

pub fn overlay(&self) -> Ref<'_, AnimRefF32>

Animated overlay effect Borrows the field in place — no copy, no allocation.

pub fn overlay_mut(&mut self) -> RefMut<'_, AnimRefF32>

Trait Implementations

impl Debug for RibbonEmitter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RibbonEmitter

fn default() -> Self

Returns the “default value” for a type.

impl Drop for RibbonEmitter

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for RibbonEmitter