head_size_by

anim_traces.head_size_by(p0: str) → int

Specify which variable type to use to size the head of each animated trace segment of the selected particle trace part(s).

Not applicable when head type is none. The head size is determined by multiplying the scale factor (anim_traces: head_scale) by the specified variable (anim_traces: head_variable) value.

Args:

p0:

‘option’ constant

p1:

‘option’ scalar

p2:

‘option’ vector_mag

p3:

‘option’ vector_xcomp

p4:

‘option’ vector_ycomp

p5:

‘option’ vector_zcomp

Examples:

# 
# Select the particle trace part(s) to animate 
# 
ensight.part.select_begin(2)
# 
# Toggle off the visibility of the selected particle trace part(s), and 
# animate them. 
# 
ensight.part.modify_begin()
ensight.part.visible("OFF")
ensight.ptrace.animate("ON")
ensight.part.modify_end()
# 
# Toggle animated trace segment head type to spheres 
# and size by velocity magnitude 
# 
ensight.anim_traces.head_type("sphere")
ensight.anim_traces.head_size_by("vector_mag")
ensight.anim_traces.head_variable("Velocity")

Returns:

zero on success, non-zero on error