.. module:: mocha.project
.. _XSplineContour:

XSplineContour
**************

.. inheritance-diagram:: XSplineContour
    :parts: 2

Synopsis
--------

Functions
^^^^^^^^^
.. container:: function_list

*    def :meth:`__eq__<XSplineContour.__eq__>` (rhs)
*    def :meth:`control_point<XSplineContour.control_point>` (index)
*    def :meth:`get_bounding_rect<XSplineContour.get_bounding_rect>` ([time=0.f[, view=View( 0 )]])
*    def :meth:`insert_point<XSplineContour.insert_point>` (time, xcpd, index[, view=View()])
*    def :meth:`parameter<XSplineContour.parameter>` (name_components)
*    def :meth:`parameter_set<XSplineContour.parameter_set>` ([name_components=list()])
*    def :meth:`remove<XSplineContour.remove>` ()


Properties
^^^^^^^^^^
.. container:: property_list

*    property :attr:`control_points<XSplineContour.control_points>` [read-only] of list of :class:`XControlPoint` instances


Detailed Description
--------------------


    
    X-Spline contour class. Provides access to X-Spline contours and their control points.
    


.. class:: XSplineContour(XSplineContour)


    :type XSplineContour: :class:`mocha.project.XSplineContour`







    :type XSplineContour: :class:`mocha.project.XSplineContour`



.. method:: XSplineContour.control_point(index)


    :type index: :class:`PySide.QtCore.uint`
    :rtype: :class:`mocha.project.XControlPoint`



    
    :param index: Control point index.
    :rtype: :class:`XControlPoint` or ``None`` if index is invalid.
    
    Returns x spline control point by index.
    



.. method:: XSplineContour.get_bounding_rect([time=0.f[, view=View( 0 )]])


    :type time: :class:`PySide.QtCore.float`
    :type view: :class:`mocha.project.View`
    :rtype: list of float






.. method:: XSplineContour.insert_point(time, xcpd, index[, view=View()])


    :type time: :class:`PySide.QtCore.float`
    :type xcpd: :class:`mocha.project.XControlPointData`
    :type index: :class:`PySide.QtCore.uint`
    :type view: :class:`mocha.project.View`
    :rtype: :class:`mocha.project.XControlPoint`



    
    :param time: Keyframe time.
    :param xcpd: Keyframe data.
    :param index: Inserting index.
    :param view: View.
    
    :rtype: :class:`XControlPoint`
    
    Inserts new control point into index position.
    



.. method:: XSplineContour.__eq__(rhs)


    :type rhs: :class:`mocha.project.XSplineContour`
    :rtype: :class:`PySide.QtCore.bool`






.. method:: XSplineContour.parameter(name_components)


    :type name_components: list of strings
    :rtype: :class:`mocha.project.Parameter`



    
    :param name_components: Relative name for a requested parameter.
    
    :rtype: :class:`Parameter`
    
    Returns :class:`Parameter` instance bound with given name path.
    



.. method:: XSplineContour.parameter_set([name_components=list()])


    :type name_components: list of strings
    :rtype: :class:`mocha.project.ParameterSet`



    
    :param name_components: Relative name for a requested parameter set.
    
    :rtype: :class:`ParameterSet`
    
    Returns :class:`ParameterSet` instance bound with given name path.
    Pass an empty list ``[]`` to get access to the X-Spline contour parameters set.
    



.. method:: XSplineContour.remove()





    
    Removes this contour.
    



.. attribute:: XSplineContour.control_points


    :type: list of :class:`XControlPoint` instances
    :access: read-only    
    Provides access to list of :class:`XControlPoint` instances.