anim_flipbook#

class ansys.api.pyensight.ensight_api.anim_flipbook(session: Session)#

Class wrapper for EnSight anim_flipbook module

This class acts as a proxy for the EnSight Python module ensight.anim_flipbook

Methods

`anim_flipbook.begin_simtime`(p0)	Specify a beginning simulation time value to start the flipbook animation.
`anim_flipbook.begin_time_step`(p0)	Specify a beginning time step value to start the flipbook animation.
`anim_flipbook.cycle`(p0)	Specify the automatic playback sequence of the flipbook.
`anim_flipbook.delete_all_pages`()	Specify to delete the currently loaded flipbook.
`anim_flipbook.delete_gpucache`()	Anim_flipbook: delete_gpucache
`anim_flipbook.display_speed`(p0)	Specifies the playback-speed factor, or the display speed at which the flipbook animates.
`anim_flipbook.dynamic_line`(p0, p1, p2, p3, ...)	Specify dynamic flipbook animation of the selected 1d-clip line part.
`anim_flipbook.dynamic_plane`(p0, p1, p2, p3, ...)	Specify dynamic flipbook animation of the selected 2d-clip plane part.
`anim_flipbook.dynamic_value`(p0, p1, p2)	Specify dynamic flipbook animation of the selected isosurface, xyz-clip, or ijk-clip part, within the appropriate specified dynamic ranges.
`anim_flipbook.end_simtime`(p0)	Specify an ending simulation time value to start the flipbook animation.
`anim_flipbook.end_time_step`(p0)	Specify an ending time step value to start the flipbook animation.
`anim_flipbook.interactive_part`(p0)	Specify the start and stop of the recording of interactive movement of any specified isosurface or clip parts during a flipbook load.
`anim_flipbook.load`()	Specify the loading of the flipbook pages, according to the selected part(s) and specified flipbook options.
`anim_flipbook.load_as`(p0)	Specify whether to load the flipbook as graphic objects or images.
`anim_flipbook.load_type`(p0)	Specifies the type of flipbook animation to load.
`anim_flipbook.move_dynamic_plane`(p0, p1, p2, ...)	Specify the vector in which the 2d-clip plane part is to be transformed.
`anim_flipbook.number_to_create`(p0)	Specify the number of pages to create in the flipbook animation.
`anim_flipbook.page`(p0)	Specify which page of the flipbook animation to display.
`anim_flipbook.play_backward`()	Specify that the flipbook is to be played backward/forward.
`anim_flipbook.play_forward`()	Specify that the flipbook is to be played backward/forward.
`anim_flipbook.play_style`()	Anim_flipbook: play_style
`anim_flipbook.query_attributes`(args)	Anim_flipbook: query_attributes
`anim_flipbook.query_loaded`(args)	Anim_flipbook: query_loaded
`anim_flipbook.query_running`(args)	Anim_flipbook: query_running
`anim_flipbook.regen_all_pages`(p0)	Toggle indicating whether to regenerate existing flipbook pages when loading a flipbook.
`anim_flipbook.restore_images`(p0)	Anim_flipbook: restore_images
`anim_flipbook.run`(p0)	Anim_flipbook: run
`anim_flipbook.run_type`(p0)	Specify how to play the flipbook animation.
`anim_flipbook.save_images`(p0)	Specify the file name prefix into which each flipbook animation page (or each image) will be recorded.
`anim_flipbook.save_multiple_images`(p0)	When recording an animation flipbook with a detached display this option will save a file for each display if on.
`anim_flipbook.save_win_size`(p0, p1)	Specify the x and y window dimensions of the flipbook animation images.
`anim_flipbook.save_win_type`(p0)	Specify the size of the window/image into which to play/record the flipbook animation.
`anim_flipbook.select_all_timesteps`()	When loading a flipbook load all timesteps that exist.
`anim_flipbook.show_from_page`(p0)	Specify the starting page from which to run the flipbook animation.
`anim_flipbook.show_to_page`(p0)	Specify the ending page to which to run the flipbook animation.
`anim_flipbook.specify_time_as`(p0)	Specify the paging units for the flipbook animation.
`anim_flipbook.step_backward`()	Step back/forward one frame of a flipbook.
`anim_flipbook.step_by`(p0)	Specify the time step increment by which to run the transient_data flipbook animation.
`anim_flipbook.step_forward`()	Step back/forward one frame of a flipbook.
`anim_flipbook.step_increment`()	Anim_flipbook: step_increment
`anim_flipbook.step_simtime`(p0)	Specify the simulation-time increment by which to run the transient_data flipbook animation.
`anim_flipbook.stop`()	Stop playing a flipbook.
`anim_flipbook.time`(p0)	Specify which page of the flipbook animation to display.
`anim_flipbook.use_gpucache`(p0)	Anim_flipbook: use_gpucache