PolylinePrimitiveFactory
========================

.. py:class:: ansys.stk.core.graphics.PolylinePrimitiveFactory

   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:: PolylinePrimitiveFactory

Overview
--------

.. tab-set::

    .. tab-item:: Methods

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize`
              - Initialize a default polyline primitive. This is equivalent to constructing a polyline with a set hint of Frequent and a polyline type of LineStrip.
            * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_interpolator_and_set_hint`
              - Initialize a polyline primitive with the specified interpolator and setHint.
            * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_type_and_hint`
              - Initialize a new instance of a polyline primitive with the specified polylineType and setHint.
            * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_interpolator`
              - Initialize a polyline primitive with the specified interpolator. This is equivalent to constructing a polyline with the specified interpolator and a set hint of Frequent.
            * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_hint`
              - Initialize a new instance of a polyline primitive with the specified set hint. This is equivalent to constructing a polyline with a polyline type of LineStrip and the specified set hint.
            * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_type`
              - Initialize a polyline primitive with the specified polylineType. This is equivalent to constructing a polyline with the specified polylineType and a set hint of Frequent.

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitiveFactory.minimum_width_supported`
              - Get the minimum width, in pixels, supported by the video card.
            * - :py:attr:`~ansys.stk.core.graphics.PolylinePrimitiveFactory.maximum_width_supported`
              - Get the maximum width, in pixels, supported by the video card.



Import detail
-------------

.. code-block:: python

    from ansys.stk.core.graphics import PolylinePrimitiveFactory


Property detail
---------------

.. py:property:: minimum_width_supported
    :canonical: ansys.stk.core.graphics.PolylinePrimitiveFactory.minimum_width_supported
    :type: float

    Get the minimum width, in pixels, supported by the video card.

.. py:property:: maximum_width_supported
    :canonical: ansys.stk.core.graphics.PolylinePrimitiveFactory.maximum_width_supported
    :type: float

    Get the maximum width, in pixels, supported by the video card.


Method detail
-------------

.. py:method:: initialize(self) -> PolylinePrimitive
    :canonical: ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize

    Initialize a default polyline primitive. This is equivalent to constructing a polyline with a set hint of Frequent and a polyline type of LineStrip.

    :Returns:

        :obj:`~PolylinePrimitive`

.. py:method:: initialize_with_interpolator_and_set_hint(self, interpolator: IPositionInterpolator, set_hint: SetHint) -> PolylinePrimitive
    :canonical: ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_interpolator_and_set_hint

    Initialize a polyline primitive with the specified interpolator and setHint.

    :Parameters:

        **interpolator** : :obj:`~IPositionInterpolator`

        **set_hint** : :obj:`~SetHint`


    :Returns:

        :obj:`~PolylinePrimitive`

.. py:method:: initialize_with_type_and_hint(self, polyline_type: PolylineType, set_hint: SetHint) -> PolylinePrimitive
    :canonical: ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_type_and_hint

    Initialize a new instance of a polyline primitive with the specified polylineType and setHint.

    :Parameters:

        **polyline_type** : :obj:`~PolylineType`

        **set_hint** : :obj:`~SetHint`


    :Returns:

        :obj:`~PolylinePrimitive`

.. py:method:: initialize_with_interpolator(self, interpolator: IPositionInterpolator) -> PolylinePrimitive
    :canonical: ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_interpolator

    Initialize a polyline primitive with the specified interpolator. This is equivalent to constructing a polyline with the specified interpolator and a set hint of Frequent.

    :Parameters:

        **interpolator** : :obj:`~IPositionInterpolator`


    :Returns:

        :obj:`~PolylinePrimitive`

.. py:method:: initialize_with_hint(self, set_hint: SetHint) -> PolylinePrimitive
    :canonical: ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_hint

    Initialize a new instance of a polyline primitive with the specified set hint. This is equivalent to constructing a polyline with a polyline type of LineStrip and the specified set hint.

    :Parameters:

        **set_hint** : :obj:`~SetHint`


    :Returns:

        :obj:`~PolylinePrimitive`

.. py:method:: initialize_with_type(self, polyline_type: PolylineType) -> PolylinePrimitive
    :canonical: ansys.stk.core.graphics.PolylinePrimitiveFactory.initialize_with_type

    Initialize a polyline primitive with the specified polylineType. This is equivalent to constructing a polyline with the specified polylineType and a set hint of Frequent.

    :Parameters:

        **polyline_type** : :obj:`~PolylineType`


    :Returns:

        :obj:`~PolylinePrimitive`