Module Ipo :: Class BezTriple

Class BezTriple

The BezTriple object

This object gives access to generic data from all beztriple objects in Blender. If an attribute is listed as being 'read-only' that means you cannot write to it. Use the set*() methods instead.

Method Summary
BezTriple	`__init__(coords)` Create a new BezTriple object.
list of floats	`getPoints()` Returns the xy coordinates of the Bezier knot point.
list consisting of 3 lists of 3 floats	`getTriple()` Returns the x,y,z coordinates for each of the three points that make up a BezierTriple.
None	`setPoints(newval)` Sets the point xy coordinates of the Bezier knot point.

Instance Variable Summary
int	`hide`: the visibility status of the control point.
list of floats	`pt`: the [x,y] coordinates for knot point of this BezTriple.
list of points	`vec`: a list of the 3 points [ handle, knot, handle ] that comprise a BezTriple.

Method Details

init(coords)
(Constructor)

Create a new BezTriple object.

Parameters:: coords - the coordinate values for the new control point. If three floats are given, then the handle values are automatically generated.
(type=sequence of three or nine floats)

Returns:: a new BezTriple object
(type=BezTriple)

getPoints()

Returns the xy coordinates of the Bezier knot point.

Returns:: list of the x and y coordinates of the Bezier point.
(type=list of floats)

getTriple()

Returns the x,y,z coordinates for each of the three points that make up a BezierTriple.

The return list looks like this [ [H1x, H1y, H1z], [Px, Py, Pz], [H2x, H2y, H2z] ] .

Example:

 # where bt is of type BezierTriple
 #  and h1, p, and h2 are lists of 3 floats
 h1, p, h2 = bt.getTriple()

Returns:: handle1, knot, handle2
(type=list consisting of 3 lists of 3 floats)

setPoints(newval)

Sets the point xy coordinates of the Bezier knot point. After changing coordinates, it is advisable to call IpoCurve.recalc() to update the Ipo curves.

Parameters:: newval - the x and y coordinates of the new Bezier point.
(type=tuple of 2 floats)

Returns:: None
(type=None)

Instance Variable Details

hide

the visibility status of the control point.

Type:: int

pt

the [x,y] coordinates for knot point of this BezTriple. Read-only.

Type:: list of floats

vec

a list of the 3 points [ handle, knot, handle ] that comprise a BezTriple. See the getTriple() method for an example of the format. Read-only.

Type:: list of points

Generated by Epydoc 2.1 on Thu Jan 26 09:17:44 2006

http://epydoc.sf.net