animation

class ansys.cfx.core.generated.post_processing.settings_261.animation.animation(name: str | None = None, parent=None)

Bases: Group

Defines a Keyframe animation sequence. A list of KEYFRAME objects indicate the states between which to interpolate.

Attributes

Attribute	Summary
animate_camera	Indicates whether to animate the camera (flythrough) along with the other objects, or leave the camera at the current position.
animation_bit_rate	The number of Bits per Second maximum rate.
animation_filename	The name of the file to save this animation to.
animation_frame_pattern	The MPEG frame type pattern. This must be a list of B, P and I characters. If any of the characters are not B, P or I, then the default value will be used. I (“intra-frame”) encoded frames are complete frames (i.e. contain all the data to completely render themselves). P (“predicted”) encoded frames use data from previous frames to render themselves. B (“bi-directional”) frames use data from previous and following frames to render themselves.
animation_frame_rate	The Frame Rate at which to generate the Animation MPEG.
animation_hardcopy_filename	The path of the file to save a hardcopy to.
animation_name	The name of this animation.
animation_quality	Modifies the Frame Pattern to one of three predefined values providing a variety of quality settings. If ‘Custom’ is selected, then users may enter their own pattern via the ‘Animation Frame Pattern’ parameter.
animation_speed_factor	Specifies the amount of scaling that should apply to the speed of the animation. Whether the speed is reduced or increased depends on the Speed Adjustment Selection parameter.
antialiasing	Enables the antialiasing of the graphics (smooth edges).
drop_last_mpeg_frame	When creating looping animations, it may be desirable to drop the last frame in the animation from the generated MPEG since it may be the same as the first frame, and that would not create a smooth looping animation.
frame_increment	DEPRECATED The number of frames to increment the frame counter by when incrementing to go to the next frame.
hardcopy_tolerance	‘hardcopy_tolerance’ child.
intermediate_file_format	The format in which to save intermediate files when generating animation MPEGs.
keep_intermediate_files	Boolean indicating whether or not CFD-Post should delete the intermediate files after the MPEG generation is complete.
keyframe_list	An ordered list of keyframe names to be used for this animation.
local_output_directory	Animation frame images will be saved to this directory if ‘Output to User Directory’ parameter is set. This is the local (GUI) directory in remote server mode. ‘Output Directory’ contains the remote (engine) directory.
looping	Indicates the type of looping to perform for the animation.
looping_cycles	Indicates the number of cycles that the Animation loop should complete before stopping automatically. A value of -1 will repeat the cycles forever.
mpeg_height	The image height (used when MPEG Size is set to Use Screen Size).
mpeg_scale	The amount to scale the viewer image for the Animation MPEG output.
mpeg_size	Selects which size to create the MPEG.
mpeg_width	The image width (used when MPEG Size is set to Use Screen Size).
output_directory	Animation frame images will be saved to this directory if ‘Output to User Directory’ parameter is set.
output_to_user_directory	If set, the frame image files will be output to the directory specified in ‘Output Directory’ parameter. Otherwise, they will saved to TEMP directory.
qanim_frames	The number of frames per Quick Animation loop.
qanim_looping	Indicates the type of looping to perform for the quick animation.
qanim_looping_cycles	Indicates the number of cycles that the quick animation loop should complete before stopping automatically. A value of -1 will repeat the cycles forever.
qanim_mpeg_filename	The filename of the Quick Animation MPEG to create.
qanim_object_list	The list of named objects to Quick Animate.
qanim_override_symbol	Indicates whether to override the object Symbol settings when animating Streamlines or Particle Tracks.
qanim_save_mpeg	Indicates whether to create an MPEG file out of the Quick Animation.
qanim_symbol_size	A scaling factor for the Streamline or Particle Track Symbol size.
qanim_symbol_spacing	The proportional spacing to provide.
qanim_symbol_type	Name of streamline symbol to be used for plot.
save_hardcopy	Boolean indicating whether to save the current animation to a file, as it progresses. A filename needs to be specified.
speed_adjustment_selection	Indicates how to interpret the Animation Speed Factor.
speed_scaling_method	The ‘Pad or Clip MPEG Frames’ option only applies the scaling to the generated MPEG frames, reducing the number of frames or reusing some of the frames to generate the MPEG animation. For this option, no visible changes will occur in Post as you run through the animation. The ‘Distribute Frames Smoothly’ option will scale the number of frames that exist between keyframes by the given factor. As the animation plays, you will see more or fewer frames in the animation. The scaling will occur whether or not an MPEG will be generated.
timeanim_control_case	Case used to control the timestep animation available timesteps.
timeanim_control_variable	Variable used to control timestep selection for animation.
timeanim_crank_angle_interval	‘timeanim_crank_angle_interval’ child.
timeanim_end_crank_angle	‘timeanim_end_crank_angle’ child.
timeanim_end_time	‘timeanim_end_time’ child.
timeanim_end_timestep	‘timeanim_end_timestep’ child.
timeanim_frame_interval	‘timeanim_frame_interval’ child.
timeanim_frame_rate	The desired Frame Rate at which to play animation.
timeanim_frame_spacing	‘timeanim_frame_spacing’ child.
timeanim_looping_cycles	Indicates the number of cycles that the Timestep Animation loop should complete before stopping automatically. A value of -1 will repeat the cycles forever.
timeanim_mpeg_filename	The filename of the Timestep Animation MPEG to create.
timeanim_number_of_frames	‘timeanim_number_of_frames’ child.
timeanim_object_list	The list of named objects to Timestep Animate.
timeanim_save_mpeg	Indicates whether to create an MPEG file out of the Timestep Animation.
timeanim_specify_range	‘timeanim_specify_range’ child.
timeanim_speed_control	Option to enable control of the timestep animation play speed.
timeanim_speed_control_method	Method used to control time animation play speed.
timeanim_start_crank_angle	‘timeanim_start_crank_angle’ child.
timeanim_start_phase_position	‘timeanim_start_phase_position’ child.
timeanim_start_time	‘timeanim_start_time’ child.
timeanim_start_timestep	‘timeanim_start_timestep’ child.
timeanim_time_interval	‘timeanim_time_interval’ child.
timeanim_timestep_interval	‘timeanim_timestep_interval’ child.
timeanim_total_play_time	The desired total time for playing an animation cycle.
timeanim_viewer_animation	If true, execute timestep animation in the viewer.
timeanim_viewer_animation_type	Control object selection for viewer animation.
timestep_interpolation_method	Indicates what timestep information to interpolate if timesteps are to be animated.
transparent_background	Toggles if hardcopy output is produced on a transparent or CFX viewer background.
use_screen_mpeg_size	DEPRECATED When set to On, the current screen size is used as the MPEG size.
variable_bit_rate	Boolean indicating whether to apply the specified Bit Rate. If this parameter is ‘false’, then a specified Bit Rate will not be sent to the encoder which will then use a variable bit rate.
video_format	The video format to encode the animation in.
white_background	Toggles if hardcopy output is produced on a white or CFX viewer background.

Methods

Method	Summary
suspend	Suspend immediate update for the object.
unsuspend	Restore immediate update for the object.

Included in:

Parent	Summary
results	Encapsulates a CFX post-processing setup.