head_variable

anim_traces.head_variable(args: Any) → int

Specify the variable to use in scaling the head of the animated trace segments of the selected particle trace part(s).

Not applicable for “anim_traces: head_sized_by constant”. The scale factor (anim_traces: head_scale) will be applied to the value of the specified variable at the location of the head of the animated trace. Variable must be active.

Args:

p0:

‘variable_name’ variable name to use in scaling the heads of the animated trace segments

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