StreamLines R6 Class

Visualizes a vector field using stream lines (particle traces). Particles are seeded at random or grid positions and traced through the velocity field using Euler integration.

Super classes

manimR::MObject -> manimR::VMobject -> StreamLines

Public fields

func

Vector field function f(x, y) -> c(vx, vy)

x_range

x range for seeding

y_range

y range for seeding

n_lines

Number of stream lines

dt

Integration time step

max_steps

Maximum integration steps per line

stroke_width

Line stroke width

lines

List of stream line VMobjects

Active bindings

stroke_width

Line stroke width

Methods

Public methods

• StreamLines$new()

• StreamLines$start_animation()

• StreamLines$clone()

Inherited methods

• manimR::MObject$add_updater()
• manimR::MObject$align_to()
• manimR::MObject$clear_updaters()
• manimR::MObject$copy()
• manimR::MObject$generate_target()
• manimR::MObject$get_bottom()
• manimR::MObject$get_corner()
• manimR::MObject$get_height()
• manimR::MObject$get_left()
• manimR::MObject$get_right()
• manimR::MObject$get_top()
• manimR::MObject$get_width()
• manimR::MObject$match_color()
• manimR::MObject$next_to()
• manimR::MObject$set_opacity()
• manimR::MObject$to_corner()
• manimR::MObject$to_edge()
• manimR::VMobject$add()
• manimR::VMobject$add_cubic_bezier()
• manimR::VMobject$add_line()
• manimR::VMobject$add_submobject()
• manimR::VMobject$append_points()
• manimR::VMobject$clear_points()
• manimR::VMobject$get_all_points()
• manimR::VMobject$get_arc_length()
• manimR::VMobject$get_bounding_box()
• manimR::VMobject$get_center()
• manimR::VMobject$get_draw_points()
• manimR::VMobject$get_end()
• manimR::VMobject$get_num_curves()
• manimR::VMobject$get_points()
• manimR::VMobject$get_start()
• manimR::VMobject$get_submobject()
• manimR::VMobject$has_points()
• manimR::VMobject$move_to()
• manimR::VMobject$point_from_proportion()
• manimR::VMobject$print()
• manimR::VMobject$remove()
• manimR::VMobject$rotate()
• manimR::VMobject$scale()
• manimR::VMobject$set_color()
• manimR::VMobject$set_fill()
• manimR::VMobject$set_points()
• manimR::VMobject$set_stroke()
• manimR::VMobject$set_style()
• manimR::VMobject$shift()

---

Method new()

Create StreamLines

Usage

StreamLines$new(
  func,
  x_range = c(-5, 5),
  y_range = c(-3, 3),
  n_lines = 50,
  dt = 0.05,
  max_steps = 100,
  color = BLUE,
  stroke_width = 2,
  ...
)

Arguments

func

Function(x, y) -> c(vx, vy)

x_range

c(min, max)

y_range

c(min, max)

n_lines

Number of lines

dt

Integration step

max_steps

Max steps per line

color

Line color or color gradient

stroke_width

Stroke width

...

Additional args

---

Method start_animation()

Start the streaming animation

Usage

StreamLines$start_animation(scene = NULL, run_time = 3)

Arguments

scene

The scene to animate in

run_time

Animation duration

---

Method clone()

The objects of this class are cloneable with this method.

Usage

StreamLines$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.