TheCloud/panda3d
1
0
Fork 0
mirror of https://github.com/panda3d/panda3d.git synced 2025-10-04 19:08:55 -04:00
Code Issues Packages Projects Releases Wiki Activity

use docstrings instead of hash comments

Browse Source
This commit is contained in:
David Rose 2006-05-12 23:04:52 +00:00
parent ae9d5a6f77
commit 2c049a474d
1 changed files with 32 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
direct/src/showutil/Rope.py
View File

@ -3,7 +3,7 @@ import types
class Rope(NodePath):
"""
This class defines a Nurbs curve whose control vertices are
This class defines a NURBS curve whose control vertices are
defined based on points relative to one or more nodes in space, so
that the "rope" will animate as the nodes move around. It uses
the C++ RopeNode class to achieve fancy rendering effects like
@ -20,33 +20,34 @@ class Rope(NodePath):
self.name = name
def setup(self, order, verts, knots = None):
# This must be called to define the shape of the curve
# initially, and may be called again as needed to adjust the
# curve's properties.
"""This must be called to define the shape of the curve
initially, and may be called again as needed to adjust the
curve's properties.
# order must be either 1, 2, 3, or 4, and is one more than the
# degree of the curve; most NURBS curves are order 4.
order must be either 1, 2, 3, or 4, and is one more than the
degree of the curve; most NURBS curves are order 4.
# verts is a list of (NodePath, point) tuples, defining the
# control vertices of the curve. For each control vertex, the
# NodePath may refer to an arbitrary node in the scene graph,
# indicating the point should be interpreted in the coordinate
# space of that node (and it will automatically move when the
# node is moved), or it may be the empty NodePath or None to
# indicate the point should be interpreted in the coordinate
# space of the Rope itself. Each point value may be either a
# 3-tuple or a 4-tuple (or a VBase3 or VBase4). If it is a
# 3-component vector, it represents a 3-d point in space; a
# 4-component vector represents a point in 4-d homogeneous
# space; that is to say, a 3-d point and an additional weight
# factor (which should have been multiplied into the x y z
# components).
verts is a list of (NodePath, point) tuples, defining the
control vertices of the curve. For each control vertex, the
NodePath may refer to an arbitrary node in the scene graph,
indicating the point should be interpreted in the coordinate
space of that node (and it will automatically move when the
node is moved), or it may be the empty NodePath or None to
indicate the point should be interpreted in the coordinate
space of the Rope itself. Each point value may be either a
3-tuple or a 4-tuple (or a VBase3 or VBase4). If it is a
3-component vector, it represents a 3-d point in space; a
4-component vector represents a point in 4-d homogeneous
space; that is to say, a 3-d point and an additional weight
factor (which should have been multiplied into the x y z
components).
# knots is optional. If specified, it should be a list of
# floats, and should be of length len(verts) + order. If it
# is omitted, a default knot string is generated that consists
# of the first (order - 1) and last (order - 1) values the
# same, and the intermediate values incrementing by 1.
knots is optional. If specified, it should be a list of
floats, and should be of length len(verts) + order. If it
is omitted, a default knot string is generated that consists
of the first (order - 1) and last (order - 1) values the
same, and the intermediate values incrementing by 1.
"""
self.order = order
self.verts = verts
@ -55,9 +56,9 @@ class Rope(NodePath):
self.recompute()
def recompute(self):
# Recomputes the curve after its properties have changed.
# Normally it is not necessary for the user to call this
# directly.
"""Recomputes the curve after its properties have changed.
Normally it is not necessary for the user to call this
directly."""
if not self.showRope:
return
@ -83,9 +84,9 @@ class Rope(NodePath):
self.ropeNode.resetBound(self)
def getPoints(self, len):
# Returns a list of len points, evenly distributed in
# parametric space on the rope, in the coordinate space of the
# Rope itself.
"""Returns a list of len points, evenly distributed in
parametric space on the rope, in the coordinate space of the
Rope itself."""
result = self.curve.evaluate(self)
numPts = len