PolylinePrimitive ================= .. py:class:: ansys.stk.core.graphics.PolylinePrimitive Bases: :py:class:`~ansys.stk.core.graphics.IPrimitive` Render a polyline in the 3D scene. Each line segment may have a different color. A polyline can be constructed with a position interpolator to render great arcs or rhumb lines. .. py:currentmodule:: PolylinePrimitive Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set` - Define the positions for a polyline primitive. The polyline is rendered in its reference frame. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_cartographic` - For convenience. Defines the positions of a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling Set. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_cartographic_with_colors` - For convenience. Defines the positions and colors of a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling Set. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_cartographic_with_colors_and_hint` - For convenience. Defines the positions and colors of a polyline using cartographic positions. renderPassHint is provided for efficiency. This is equivalent to converting each position in positions to cartesian and calling Set. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_cartographic_with_colors_and_optional_parameters` - For convenience. Defines the positions, colors, and/or optional point properties of a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling Set. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial` - Update a subset of positions in a polyline. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic` - For convenience. Updates a subset of positions in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic_with_colors` - For convenience. Updates a subset of positions and/or colors in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic_with_colors_indices_order_and_render_pass` - For convenience. Updates a subset of positions and/or colors in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic_with_indices_order` - For convenience. Updates a subset of positions in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic_with_optional_parameters` - For convenience. Updates a subset of positions, colors, and/or optional point properties in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_with_colors` - Update a subset of positions and/or colors in a polyline. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_with_colors_and_optional_parameters` - Update a subset of positions, colors, and/or optional point properties in a polyline. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_with_colors_indices_order_and_render_pass_hint` - Update a subset of positions and/or colors in a polyline. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_partial_with_indices_order` - Update a subset of positions in a polyline. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_subset` - Define the positions of a polyline using a subset of input positions. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_subset_cartographic` - For convenience. Defines the positions of a polyline using a subset of input cartographic positions. This is equivalent to converting the subset of positions to cartesian and calling SetSubset. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_with_colors` - Define the positions and colors of a polyline. The polyline is rendered in its reference frame. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_with_colors_and_hint` - Define the positions and colors of a polyline. The polyline is rendered in its reference frame. renderPassHint is provided for efficiency. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_with_colors_and_optional_parameters` - Define the positions, colors, and/or optional point properties of a polyline. The polyline is rendered in its reference frame. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_with_solid_triangulator_result` - Define the positions of a polyline using the outline positions of the specified solidTriangulatorResult. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_with_surface_shapes_result` - Define the positions of a polyline using the positions of the specified surfaceShapesResult. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_with_surface_triangulator_result` - Define the positions of a polyline using the boundary positions of the specified surfaceTriangulatorResult. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.central_body_clipped` - Get or set whether the polyline will be clipped by the central body. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.display_outline` - Get or set whether an outline is rendered around the polyline. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.maximum_width_supported` - Get the maximum width, in pixels, supported by the video card. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.minimum_width_supported` - Get the minimum width, in pixels, supported by the video card. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.outline_color` - Get or set the outline's color. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.outline_translucency` - Get or set the translucency of the outline. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.outline_width` - Get or set the width, in pixels, of the outline around the polyline. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.per_item_picking_enabled` - Get or set whether individual line indices will be included in the pick results returned from the scene's Pick method. Each line index that is picked will be returned as a batch primitive index. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.polyline_type` - Get how the polyline interprets the positions passed to Set methods. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.position_interpolator` - Get the position interpolator applied to positions passed to Set, SetCartographic, SetSubset, and SetSubsetCartographic methods. When this property is null, linear interpolation is used. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.set_hint` - Get the primitive's set hint. See the Set Hint Performance Overview for selecting an appropriate value to construct the primitive with. * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitive.width` - Get or set the line width, in pixels. Import detail ------------- .. code-block:: python from ansys.stk.core.graphics import PolylinePrimitive Property detail --------------- .. py:property:: central_body_clipped :canonical: ansys.stk.core.graphics.PolylinePrimitive.central_body_clipped :type: bool Get or set whether the polyline will be clipped by the central body. .. py:property:: display_outline :canonical: ansys.stk.core.graphics.PolylinePrimitive.display_outline :type: bool Get or set whether an outline is rendered around the polyline. .. py:property:: maximum_width_supported :canonical: ansys.stk.core.graphics.PolylinePrimitive.maximum_width_supported :type: float Get the maximum width, in pixels, supported by the video card. .. py:property:: minimum_width_supported :canonical: ansys.stk.core.graphics.PolylinePrimitive.minimum_width_supported :type: float Get the minimum width, in pixels, supported by the video card. .. py:property:: outline_color :canonical: ansys.stk.core.graphics.PolylinePrimitive.outline_color :type: Color Get or set the outline's color. .. py:property:: outline_translucency :canonical: ansys.stk.core.graphics.PolylinePrimitive.outline_translucency :type: float Get or set the translucency of the outline. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent. .. py:property:: outline_width :canonical: ansys.stk.core.graphics.PolylinePrimitive.outline_width :type: float Get or set the width, in pixels, of the outline around the polyline. .. py:property:: per_item_picking_enabled :canonical: ansys.stk.core.graphics.PolylinePrimitive.per_item_picking_enabled :type: bool Get or set whether individual line indices will be included in the pick results returned from the scene's Pick method. Each line index that is picked will be returned as a batch primitive index. .. py:property:: polyline_type :canonical: ansys.stk.core.graphics.PolylinePrimitive.polyline_type :type: PolylineType Get how the polyline interprets the positions passed to Set methods. .. py:property:: position_interpolator :canonical: ansys.stk.core.graphics.PolylinePrimitive.position_interpolator :type: IPositionInterpolator Get the position interpolator applied to positions passed to Set, SetCartographic, SetSubset, and SetSubsetCartographic methods. When this property is null, linear interpolation is used. .. py:property:: set_hint :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_hint :type: SetHint Get the primitive's set hint. See the Set Hint Performance Overview for selecting an appropriate value to construct the primitive with. .. py:property:: width :canonical: ansys.stk.core.graphics.PolylinePrimitive.width :type: float Get or set the line width, in pixels. Method detail ------------- .. py:method:: set(self, positions: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set Define the positions for a polyline primitive. The polyline is rendered in its reference frame. :Parameters: **positions** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_cartographic(self, central_body: str, positions: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_cartographic For convenience. Defines the positions of a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling Set. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_cartographic_with_colors(self, central_body: str, positions: list, colors: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_cartographic_with_colors For convenience. Defines the positions and colors of a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling Set. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **colors** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_cartographic_with_colors_and_hint(self, central_body: str, positions: list, colors: list, render_pass_hint: RenderPassHint) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_cartographic_with_colors_and_hint For convenience. Defines the positions and colors of a polyline using cartographic positions. renderPassHint is provided for efficiency. This is equivalent to converting each position in positions to cartesian and calling Set. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **colors** : :obj:`~list` **render_pass_hint** : :obj:`~RenderPassHint` :Returns: :obj:`~None` .. py:method:: set_cartographic_with_colors_and_optional_parameters(self, central_body: str, positions: list, colors: list, optional_parameters: PolylinePrimitiveOptionalParameters) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_cartographic_with_colors_and_optional_parameters For convenience. Defines the positions, colors, and/or optional point properties of a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling Set. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **colors** : :obj:`~list` **optional_parameters** : :obj:`~PolylinePrimitiveOptionalParameters` :Returns: :obj:`~None` .. py:method:: set_partial(self, positions: list, indices: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial Update a subset of positions in a polyline. :Parameters: **positions** : :obj:`~list` **indices** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_partial_cartographic(self, central_body: str, positions: list, indices: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic For convenience. Updates a subset of positions in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **indices** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_partial_cartographic_with_colors(self, central_body: str, positions: list, colors: list, indices: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic_with_colors For convenience. Updates a subset of positions and/or colors in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **colors** : :obj:`~list` **indices** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_partial_cartographic_with_colors_indices_order_and_render_pass(self, central_body: str, positions: list, colors: list, indices: list, indices_order_hint: PrimitiveIndicesOrderHint, render_pass_hint: RenderPassHint) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic_with_colors_indices_order_and_render_pass For convenience. Updates a subset of positions and/or colors in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **colors** : :obj:`~list` **indices** : :obj:`~list` **indices_order_hint** : :obj:`~PrimitiveIndicesOrderHint` **render_pass_hint** : :obj:`~RenderPassHint` :Returns: :obj:`~None` .. py:method:: set_partial_cartographic_with_indices_order(self, central_body: str, positions: list, indices: list, indices_order_hint: PrimitiveIndicesOrderHint) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic_with_indices_order For convenience. Updates a subset of positions in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **indices** : :obj:`~list` **indices_order_hint** : :obj:`~PrimitiveIndicesOrderHint` :Returns: :obj:`~None` .. py:method:: set_partial_cartographic_with_optional_parameters(self, central_body: str, positions: list, colors: list, optional_parameters: PolylinePrimitiveOptionalParameters, indices: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_cartographic_with_optional_parameters For convenience. Updates a subset of positions, colors, and/or optional point properties in a polyline using cartographic positions. This is equivalent to converting each position in positions to cartesian and calling SetPartial. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **colors** : :obj:`~list` **optional_parameters** : :obj:`~PolylinePrimitiveOptionalParameters` **indices** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_partial_with_colors(self, positions: list, colors: list, indices: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_with_colors Update a subset of positions and/or colors in a polyline. :Parameters: **positions** : :obj:`~list` **colors** : :obj:`~list` **indices** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_partial_with_colors_and_optional_parameters(self, positions: list, colors: list, optional_parameters: PolylinePrimitiveOptionalParameters, indices: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_with_colors_and_optional_parameters Update a subset of positions, colors, and/or optional point properties in a polyline. :Parameters: **positions** : :obj:`~list` **colors** : :obj:`~list` **optional_parameters** : :obj:`~PolylinePrimitiveOptionalParameters` **indices** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_partial_with_colors_indices_order_and_render_pass_hint(self, positions: list, colors: list, indices: list, indices_order_hint: PrimitiveIndicesOrderHint, render_pass_hint: RenderPassHint) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_with_colors_indices_order_and_render_pass_hint Update a subset of positions and/or colors in a polyline. :Parameters: **positions** : :obj:`~list` **colors** : :obj:`~list` **indices** : :obj:`~list` **indices_order_hint** : :obj:`~PrimitiveIndicesOrderHint` **render_pass_hint** : :obj:`~RenderPassHint` :Returns: :obj:`~None` .. py:method:: set_partial_with_indices_order(self, positions: list, indices: list, indices_order_hint: PrimitiveIndicesOrderHint) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_partial_with_indices_order Update a subset of positions in a polyline. :Parameters: **positions** : :obj:`~list` **indices** : :obj:`~list` **indices_order_hint** : :obj:`~PrimitiveIndicesOrderHint` :Returns: :obj:`~None` .. py:method:: set_subset(self, positions: list, index: int, count: int) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_subset Define the positions of a polyline using a subset of input positions. :Parameters: **positions** : :obj:`~list` **index** : :obj:`~int` **count** : :obj:`~int` :Returns: :obj:`~None` .. py:method:: set_subset_cartographic(self, central_body: str, positions: list, index: int, count: int) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_subset_cartographic For convenience. Defines the positions of a polyline using a subset of input cartographic positions. This is equivalent to converting the subset of positions to cartesian and calling SetSubset. :Parameters: **central_body** : :obj:`~str` **positions** : :obj:`~list` **index** : :obj:`~int` **count** : :obj:`~int` :Returns: :obj:`~None` .. py:method:: set_with_colors(self, positions: list, colors: list) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_with_colors Define the positions and colors of a polyline. The polyline is rendered in its reference frame. :Parameters: **positions** : :obj:`~list` **colors** : :obj:`~list` :Returns: :obj:`~None` .. py:method:: set_with_colors_and_hint(self, positions: list, colors: list, render_pass_hint: RenderPassHint) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_with_colors_and_hint Define the positions and colors of a polyline. The polyline is rendered in its reference frame. renderPassHint is provided for efficiency. :Parameters: **positions** : :obj:`~list` **colors** : :obj:`~list` **render_pass_hint** : :obj:`~RenderPassHint` :Returns: :obj:`~None` .. py:method:: set_with_colors_and_optional_parameters(self, positions: list, colors: list, optional_parameters: PolylinePrimitiveOptionalParameters) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_with_colors_and_optional_parameters Define the positions, colors, and/or optional point properties of a polyline. The polyline is rendered in its reference frame. :Parameters: **positions** : :obj:`~list` **colors** : :obj:`~list` **optional_parameters** : :obj:`~PolylinePrimitiveOptionalParameters` :Returns: :obj:`~None` .. py:method:: set_with_solid_triangulator_result(self, solid_triangulator_result: SolidTriangulatorResult) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_with_solid_triangulator_result Define the positions of a polyline using the outline positions of the specified solidTriangulatorResult. :Parameters: **solid_triangulator_result** : :obj:`~SolidTriangulatorResult` :Returns: :obj:`~None` .. py:method:: set_with_surface_shapes_result(self, surface_shapes_result: SurfaceShapesResult) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_with_surface_shapes_result Define the positions of a polyline using the positions of the specified surfaceShapesResult. :Parameters: **surface_shapes_result** : :obj:`~SurfaceShapesResult` :Returns: :obj:`~None` .. py:method:: set_with_surface_triangulator_result(self, surface_triangulator_result: SurfaceTriangulatorResult) -> None :canonical: ansys.stk.core.graphics.PolylinePrimitive.set_with_surface_triangulator_result Define the positions of a polyline using the boundary positions of the specified surfaceTriangulatorResult. :Parameters: **surface_triangulator_result** : :obj:`~SurfaceTriangulatorResult` :Returns: :obj:`~None`