.. oe:namespace:: OEShape

.. meta::
   :keywords: OEQuatStarts, QuatStarts


.. _OEShape_OEQuatStarts:

.. oe:class:: OEQuatStarts

   .. oe:api::


      class OEQuatStarts : public OEInertialStarts

   The :ref:`OEQuatStarts <OEShape_OEQuatStarts>` represents the user defined
   quaternion starts for overlay optimization.  The :ref:`OEQuatStarts <OEShape_OEQuatStarts>`
   takes the user defined quaternions as the starts, with reference to the inertial 
   frame of the reference system.

   The following methods are publicly inherited from :ref:`OEStarts <OEShape_OEStarts>`:
    * :oe:meth:`CreateCopy<OEShape::OEStarts::CreateCopy>`  
    * :oe:meth:`GetNumOfStarts<OEShape::OEStarts::GetNumOfStarts>` 
    * :oe:meth:`GetStarts<OEShape::OEStarts::GetStarts>`
    * :oe:meth:`Setup<OEShape::OEStarts::Setup>`
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupFrame>` 
    * :oe:meth:`SetupRef<OEShape::OEStarts::SetupRef>`

   The following methods are publicly inherited from :ref:`OEInertialStarts <OEShape_OEInertialStarts>`:
    * :oe:meth:`GetSymmetryThreshold<OEShape::OEInertialStarts::GetSymmetryThreshold>`  
    * :oe:meth:`SetSymmetryThreshold<OEShape::OEInertialStarts::SetSymmetryThreshold>`

   The :ref:`OEQuatStarts <OEShape_OEQuatStarts>` class defines the following public methods:
    * :oe:meth:`ClearStarts<OEShape::OEQuatStarts::ClearStarts>`  
    * :oe:meth:`SetStarts<OEShape::OEQuatStarts::SetStarts>`  

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEQuatStarts()
            OEQuatStarts(const OEQuatStarts&)

      .. oe:language:: python

         .. oe:api:: python

            OEQuatStarts() -> OEQuatStarts
            OEQuatStarts(arg2: OEQuatStarts) -> OEQuatStarts

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEQuatStarts &operator=(const OEQuatStarts &)

      The assignment operator.

      Assignment operator.


   .. oe:method:: ClearStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void ClearStarts()

      .. oe:language:: python

         .. oe:api:: python

            ClearStarts() -> None

      Clears the currently specified starts.

   .. oe:method:: SetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStarts(const double* Quats, unsigned int NumQuats)

      .. oe:language:: python

         .. oe:api:: python

            SetStarts(argQuats: OEDoubleArray, argNumStarts: int) -> None

      Sets the starting quaternions. Method expects an array of size
      7*NumQuats for the first argument.
