ChainGraphics2DAnimation

class ansys.stk.core.stkobjects.ChainGraphics2DAnimation

2D Animation graphics for a chain.

Overview

Properties

color	Get or set the color in which valid strand lines are to be displayed during animation.
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.
line_width	Get or set the width of the valid strand lines used in animation graphics.
network_throughput_end_nodes_color	The color for the end nodes for network throughput graphics.
network_throughput_link_combine_strands	Combine strand link data when multiple strands overlap for Network Throughput graphics.
network_throughput_link_data_mode	The data mode for displaying link labels and lines for network throughput graphics.
network_throughput_link_labels_include_num_strands	Include the number of strands in the link labels for Network Throughput graphics.
network_throughput_link_line_width	Line width of links when network throughput graphics are displayed.
network_throughput_node_data_mode	The data mode for displaying nodes labels and points for network throughput graphics.
network_throughput_node_point_size	Pixel size of nodes when network throughput graphics are displayed.
network_throughput_one_hundred_pct_contour_color	The color for the 100 percentage network throughput contours graphics.
network_throughput_zero_pct_contour_color	The color for the 0 percentage network throughput contours graphics.
number_of_optimal_strands_to_display	The number of animation optimal strands lines to show.
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.
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_line_width	Get or set the width of the optimal strands lines used in animation graphics.
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.
show_network_throughput_graphics_2d	Show or hide all network throughput graphics if computed.
show_network_throughput_link_graphics_2d	Show or hide all network throughput link graphics.
show_network_throughput_link_labels_graphics_2d	Show or hide all network throughput link labels.
show_network_throughput_node_graphics_2d	Show or hide all network throughput node graphics.
show_network_throughput_node_labels_graphics_2d	Show or hide all network throughput node labels.
show_optimal_path_line	Opt whether to display lines for the optimal strands in the chain during animation.
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.

Import detail

from ansys.stk.core.stkobjects import ChainGraphics2DAnimation

Property detail

property ChainGraphics2DAnimation.color: Color

Get or set the color in which valid strand lines are to be displayed during animation.

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.line_width: LineWidth

Get or set the width of the valid strand lines used in animation graphics.

property ChainGraphics2DAnimation.network_throughput_end_nodes_color: Color

The color for the end nodes for network throughput graphics.

property ChainGraphics2DAnimation.network_throughput_link_combine_strands: bool

Combine strand link data when multiple strands overlap for Network Throughput graphics.

property ChainGraphics2DAnimation.network_throughput_link_data_mode: ChainGraphics2DNetworkDataMode

The data mode for displaying link labels and lines for network throughput graphics.

property ChainGraphics2DAnimation.network_throughput_link_labels_include_num_strands: bool

Include the number of strands in the link labels for Network Throughput graphics.

property ChainGraphics2DAnimation.network_throughput_link_line_width: LineWidth

Line width of links when network throughput graphics are displayed.

property ChainGraphics2DAnimation.network_throughput_node_data_mode: ChainGraphics2DNetworkDataMode

The data mode for displaying nodes labels and points for network throughput graphics.

property ChainGraphics2DAnimation.network_throughput_node_point_size: float

Pixel size of nodes when network throughput graphics are displayed.

property ChainGraphics2DAnimation.network_throughput_one_hundred_pct_contour_color: Color

The color for the 100 percentage network throughput contours graphics.

property ChainGraphics2DAnimation.network_throughput_zero_pct_contour_color: Color

The color for the 0 percentage network throughput contours graphics.

property ChainGraphics2DAnimation.number_of_optimal_strands_to_display: int

The number of animation optimal strands lines to show.

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.

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_line_width: LineWidth

Get or set the width of the optimal strands lines used in animation graphics.

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.show_network_throughput_graphics_2d: bool

Show or hide all network throughput graphics if computed.

property ChainGraphics2DAnimation.show_network_throughput_link_graphics_2d: bool

Show or hide all network throughput link graphics.

property ChainGraphics2DAnimation.show_network_throughput_link_labels_graphics_2d: bool

Show or hide all network throughput link labels.

property ChainGraphics2DAnimation.show_network_throughput_node_graphics_2d: bool

Show or hide all network throughput node graphics.

property ChainGraphics2DAnimation.show_network_throughput_node_labels_graphics_2d: bool

Show or hide all network throughput node labels.

property ChainGraphics2DAnimation.show_optimal_path_line: bool

Opt whether to display lines for the optimal strands in the chain during animation.

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.