ChainGraphics2DAnimation#

class ansys.stk.core.stkobjects.ChainGraphics2DAnimation#: 2D Animation graphics for a chain.

Overview#

Properties

`show_highlight`	Opt whether to display access in bold print during animation. A box appears around each object during access.
`show_line`	Opt whether to display lines between the valid strands in the chain during animation.
`show_link_numbers_in_strands`	Opt whether to have each link line in the valid strand lines is numbered to show the sequence of the links between the objects in the chain.
`color`	Get or set the color in which valid strand lines are to be displayed during animation.
`line_width`	Get or set the width of the valid strand lines used in animation graphics.
`show_optimal_path_line`	Opt whether to display lines for the optimal strands in the chain during animation.
`optimal_path_color`	Do not use this property, as it is deprecated. Use OptimalPathColorRampStartColor. Gets or sets the color in which the optimal strands lines are to be displayed during animation.
`optimal_path_line_width`	Get or set the width of the optimal strands lines used in animation graphics.
`use_hide_animation_graphics_2d_if_more_than_n_strands`	Use the maximum number of animation strand lines to show. If there are more than the specified number of valid strands, the animation lines are not displayed.
`hide_animation_graphics_2d_if_more_than_n_strands_number`	Get or set the maximum number of animation strand lines to show. If there are more than the specified number of valid strands, the animation lines are not displayed.
`number_of_optimal_strands_to_display`	The number of animation optimal strands lines to show.
`optimal_path_color_ramp_start_color`	The start color for the color ramp in which the optimal strands lines are to be displayed during animation.
`optimal_path_color_ramp_end_color`	The end color for the color ramp in which the optimal strands lines are to be displayed during animation.

Import detail#

from ansys.stk.core.stkobjects import ChainGraphics2DAnimation

Property detail#

property ChainGraphics2DAnimation.show_highlight: bool#: Opt whether to display access in bold print during animation. A box appears around each object during access.

property ChainGraphics2DAnimation.show_line: bool#: Opt whether to display lines between the valid strands in the chain during animation.

property ChainGraphics2DAnimation.show_link_numbers_in_strands: bool#: Opt whether to have each link line in the valid strand lines is numbered to show the sequence of the links between the objects in the chain.

property ChainGraphics2DAnimation.color: Color#: Get or set the color in which valid strand lines are to be displayed during animation.

property ChainGraphics2DAnimation.line_width: LineWidth#: Get or set the width of the valid strand lines used in animation graphics.

property ChainGraphics2DAnimation.show_optimal_path_line: bool#: Opt whether to display lines for the optimal strands in the chain during animation.

property ChainGraphics2DAnimation.optimal_path_color: Color#: Do not use this property, as it is deprecated. Use OptimalPathColorRampStartColor. Gets or sets the color in which the optimal strands lines are to be displayed during animation.

property ChainGraphics2DAnimation.optimal_path_line_width: LineWidth#: Get or set the width of the optimal strands lines used in animation graphics.

property ChainGraphics2DAnimation.use_hide_animation_graphics_2d_if_more_than_n_strands: bool#: Use the maximum number of animation strand lines to show. If there are more than the specified number of valid strands, the animation lines are not displayed.

property ChainGraphics2DAnimation.hide_animation_graphics_2d_if_more_than_n_strands_number: int#: Get or set the maximum number of animation strand lines to show. If there are more than the specified number of valid strands, the animation lines are not displayed.

property ChainGraphics2DAnimation.number_of_optimal_strands_to_display: int#: The number of animation optimal strands lines to show.

property ChainGraphics2DAnimation.optimal_path_color_ramp_start_color: Color#: The start color for the color ramp in which the optimal strands lines are to be displayed during animation.

property ChainGraphics2DAnimation.optimal_path_color_ramp_end_color: Color#: The end color for the color ramp in which the optimal strands lines are to be displayed during animation.