CubicSegment
Constructors
Constructs a cubic segment from two anchors.
The handleOut of startAnchor and handleIn of endAnchor will be
used, but the other handles will be ignored.
Constructs a cubic segment from a line segment.
The control points of the cubic segment are calculated such that they lie
on the line segment between segment.s and segment.e, evenly spaced in
time at 1/3, 2/3, and 1 respectively. This keeps the segment linear with a
constant derivative.
Properties
The start position
The first cubic "handle" position
The second cubic "handle" position
The end position
Methods
Returns true if this segment is linear. A cubic segment is linear if its
control points lie on the line segment between its start and end points,
and they are evenly spaced.
tolerancenumberGEOMETRIC_TOLERANCEReturns true if this segment is straight. A cubic segment is straight if
its control points lie on the line segment between its start and end
points.
Returns true if this segment is exactly equal to segment.
Sets the positions of this segments so that it equals segment.
segmentLinearly interpolates this segment's control points to segment's control
points by the mixing factor t.
Sets the positions of this segment from two anchors.
Returns the approximate arc length of the segment.
distancenumberA positive distance
Returns the approximate time at distance along the segment.
If distance is greater than the length of the segment, this will return
- Negative distances will return 0.
timenumberA segment time between 0 and 1
Returns the approximate distance along the segment at time.
timenumberA segment time between 0 and 1
Returns the position on the segment at time.
timenumberA segment time between 0 and 1
Returns the first derivative of the segment at time.
The first derivative can also be thought of as the "velocity" of a point moving along the curve.
timenumberA segment time between 0 and 1
Returns the second derivative of the segment at time.
The second derivative can also be thought of as the "acceleration", or change in velocity of a point moving along the curve.
timenumberA segment time between 0 and 1
Returns the curvature of the segment at time.
Curvature describes how "bent" a segment is at a given point. It can be
thought of as the reciprocal of the radius of a circle with the same
curvature. To find the radius, one can use the formula 1 / curvature.
timenumberA segment time between 0 and 1
Returns a unit-length vector tangent to the segment at time.
timenumberA segment time between 0 and 1
Returns a unit-length vector perpendicular to the segment at time.
startTimenumberA segment time between 0 and 1
endTimenumberA segment time between 0 and 1 greater than startTime
Returns A new cubic segment that is the subset of the segment between
startTime and endTime.
Splits the segment at a specific time.
timenumberA segment time between 0 and 1
Returns two cubic segments.
Methods inherited from Geometry
Clone is useful when you need to make a change to geometry without changing the original.
const transformedPath = path.clone().transform({ rotation: 45 });
Returns A deep copy of this geometry
Returns true if this geometry is valid, or false otherwise.
Spatially transforms this geometry by an affine transformation matrix.
Affine matrices can represent any 2-dimensional transformation that keeps lines parallel.
affineMatrixSpatially transforms this geometry by an affine transformation matrix, excluding translation. Only rotation, scale, and skew transformations will be applied.
affineMatrixReverses this cubic segment.
Swaps the start and end points of the segment as well as their corresponding control points.
pointThe target point
areaOfInterestIf supplied, only results inside this bounding box
will be returned. This can save a lot of computation if you only need to
find closest points within a small area. Typically areaOfInterest is
centered on point, but this isn't required.
Returns The closest point to point that lies on this geometry, or
undefined if no point is found.
Returns the smallest axis-aligned bounding box that contains this geometry.
The loose bounding box may not be the smallest possible, but it's usually cheaper to compute. Use this when the exact bounding box isn't required.
Returns an axis-aligned bounding box that contains this geometry.
Geometry is contained by a bounding box if no part of it lies beyond it's minimum and maximum.
boxGeometry intersects a bounding box if part of the geometry crosses the boundary between the inside and outside of the box.
boxGeometry is overlapped by a bounding box if a point can be chosen that is indside both the geometry and the box.
Geometry is overlapped by a bounding box if it's contained inside, or intersected by it.
boxaunknownReturns true if geom is valid geometry
Transforms this geometry.
A transform can optionally specify any of position, rotation, scale,
skew and origin.
origin defines the center (in pre-transform coordinates) of the
transformation for rotation, scale and skew.
// Simple translation
geometry.translate({
position: Vec(1, 0),
});
// Rotation and scale
geometry.transform({
rotation: 45,
scale: 2,
});
// Complicated transform
geometry.transform({
position: Vec(1, 1),
rotation: 180,
scale: Vec(2, 1),
skew: 45,
origin: Vec(-0.5, 0.5),
};
transformgeometriesGeometry[]An array of geometries to intersect with.
areaOfInterestIf supplied, only intersection results inside this bounding box will be returned. This can save a lot of computation if you only need to find intersections within a small area.
Returns An array of intersections between this geometry and geometries
geometriesGeometry[]An array of geometries to find overlaps with.
areaOfInterestIf supplied, input geometry will be filtered so that only parts that intersect this bounding box will be tested. This can save a lot of time if only need to find overlaps within a small area.
tolerancenumberThe maximum distance apart two segments can be to be considered overlapping.
Returns An array of overlaps between this geometry and geometries
targetGeometryThe geometry to move toward.
directionThe direction to move in. This should point towards the target geometry, otherwise no intersection may be found.
optionsReturns approximately the smallest distance to move until this geometry intersects the target geometry.
If minOverlap is specified, the distance to move until the geometry
overlaps by some minimum width will be returned instead.
Returns undefined if no intersection is found.
A cubic bezier segment of a path.