2.28. XControlPoint

2.28.1. Synopsis

2.28.1.1. Functions

• def __eq__ (rhs)

• def get_master_point ()

• def get_point_data (time[, view=View()])

• def parameter (name_components)

• def parameter_set ([name_components=list()])

• def remove ()

• def set_master_point (arg__1[, time=0.f[, view=View(0)]])

• def set_point_data (time, xcpd[, view=View()])

• def update_point_data (time, xcpd[, view=View()])

2.28.1.2. Properties

• property master_point [read-only] of BezierControlPoint or XControlPoint

• property psets [read-only] of ParameterSet

• property selected [read-write] of bool

2.28.2. Detailed Description

X-Spline control point class. Provides access to X-Spline contour control points.

class mocha.project.XControlPoint

XControlPoint.get_master_point()

Return type

object

XControlPoint.get_point_data(time[, view=View()])

Return type

XControlPointData

Parameters

• time (float) – Keyframe time.

• view (View) – Keyframe view.

Returns control point data by time and view.

XControlPoint.__eq__(rhs)

Return type

bool

XControlPoint.parameter(name_components)

Return type

Parameter

Parameters

name_components (list of strings) – Relative name for a requested parameter.

Returns Parameter instance bound with given name path.

XControlPoint.parameter_set([name_components=list()])

Return type

ParameterSet

Parameters

name_components (list of strings) – Relative name for a requested parameter set.

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 (float) – Keyframe time.

• view (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

• time (float) – Keyframe time.

• xcpd (XControlPointData) – keyframe data reflected in XControlPointData instance

• view (View) – Keyframe view.

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

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

Parameters

• time (float) – Keyframe time.

• xcpd (XControlPointData) – Keyframe data reflected in XControlPointData instance

• view (View) – Keyframe view.

Updates keyframe data for given time and view.

XControlPoint.master_point

Type

BezierControlPoint or XControlPoint

Access

read-only Provides access to constraining point.

XControlPoint.psets

Type

ParameterSet

Access

read-only Provides access to the root parameter set.

Mimics parameter_set() call.

XControlPoint.selected

Type

bool

Access

read-write Provides access to selected state of the point.