Flex | Boris FX

< Previous | Contents | Manuals Home | Boris FX | Next >

‌Flex

.Clone() Returns a new clone of the flex. The cloned flex does not have any curves; clone them separately if desired.

.color Color in display, 24b little-endian RGB value.

Is 0x818283 (8487555) if the color is the default determined by the preferences. See also .netcolor

.curve List of curves attached to this flex (read only)

.ending 3-D position of the end point constraining the ending end of the flex.

.endingMode If 0, the flex ends perpendicular to the point, if 1, ends exactly at the point.

.EquiLength() Reasonably exact value for the length of the curving flex way or seed path. The way path is used if it exists. This length is notably larger than the distance between step points!

.EquiSpace(npnt) Interpolate the flex’s way or seed path into npnt evenly-spaced points along that path, forming a new waypoint path.

.EquiStep(step) Interpolate the flex’s way or seed path every step units, forming a new waypoint path. For example, EquiLength() may report 55.1223 (units, interpreted as meters), EquiStep can be called with 0.25 to interpolate the path at a

0.25 meter spacing. A final point is always generated at the end of the spline. If the final step would be less than 1% of the step size, the next-to-would-be-last step is made larger, rather than creating a tiny final step.

.err RMS pixel error (read only)

.Interpolate(val) Interpolates along the waypoint path (if there are waypoints), or the seedpoint path (if not) an amount val, which ranges 0..1. Note that uniform steps in val do NOT produce equally- spaced values in 3-D; spacing will vary depending on control point placements, angles, etc. See EquiSpace().

.isExported Whether or not it should be exported. (Most exporters do not export flexes.)

.isVisible Flex is visible in the viewports

.lock Locks the flex’s seed path.

.netcolor The flex’s .color, or if it indicates the default, the flex color preference. (Read-only)

.nm Flex name

.obj Moving object it is attached to, if any

.seed List of seed control points (vectors) in the unsolved flex. The list cannot be written as a unit, but individual elements can. You can add new elements by writing the next one past the last, or with new flex.seed, which returns the new index number to write. Call seed.Clear() to clear the entire list.

.start Position of “start” point constraining the starting end of the flex.

.startMode If 0, the flex starts perpendicular to the point, if 1, it starts exactly at the point.

.uniqueID A unique ID string (representing a 64-bit integer)

.way List of waypoints (vectors) in the solved flex. The list cannot be written as a unit, but the individual elements can. You can add new elements by writing the next one past the last, or with new flex.way, which returns the new index number to write. Call way.Clear() to clear the entire list.

< Previous | Contents | Manuals Home | Boris FX | Next >