2.23. XControlPoint

2.23.1. Synopsis

2.23.1.1. Functions

2.23.1.2. Properties

2.23.2. Detailed Description

X-Spline control point class. Provides access to X-Spline contour control points.
class mocha.project.XControlPoint(XControlPoint)
XControlPoint.get_point_data(time[, view=View()])
Return type:

mocha.project.XControlPointData

Parameters:
  • time (PySide2.QtCore.float) – Keyframe time.
  • view (mocha.project.View) – Keyframe view.

Returns control point data by time and view.

XControlPoint.__eq__(rhs)
Return type:PySide2.QtCore.bool
XControlPoint.parameter(name_components)
Return type:mocha.project.Parameter
Parameters:name_components (list of strings) – Relative name for a requested parameter.
Return type:Parameter

Returns Parameter instance bound with given name path.

XControlPoint.parameter_set([name_components=list()])
Return type:mocha.project.ParameterSet
Parameters:name_components (list of strings) – Relative name for a requested parameter set.
Return type:ParameterSet

Returns ParameterSet instance bound with given name path. Pass an empty list [] to get access to the X-Spline control point parameters set.

XControlPoint.remove()

Removes the this control point.

XControlPoint.set_master_point(arg__1[, time=0.f[, view=View(0)]])
Parameters:
  • time (PySide2.QtCore.float) – Keyframe time.
  • view (mocha.project.View) – Keyframe view.

Set the given point as constraining one for the point. Set None value to break the constraint.

XControlPoint.set_point_data(time, xcpd[, view=View()])
Parameters:

Sets keyframe data for given time and view erasing all old keyframe data.

XControlPoint.update_point_data(time, xcpd[, view=View()])
Parameters:

Updates keyframe data for given time and view.

XControlPoint.master_point
Type:BezierControlPoint or XControlPoint
Access:read-only

Provides access to constraining point.