The quilt splitter mode type
This mode is used to split quilts along simple lines defined by a few points and parameters.
| pw:: | The quilt splitter mode type |
| Instance Attributes | |
| SplitMode | This attribute is the split mode. |
| SplitType | This attribute is the split type to carry out with the mode’s points. |
| SplitMethod | This attribute is the method which the splitting curves are generated. |
| ExtendMode | This attribute is the extend mode. |
| MergeTolerance | This attribute is the merge tolerance of the mode. |
| ExtendMaximumBendAngle | This attribute is the maximum bending angle allowed when extending splits into adjacent quilts, with 0 meaning no maximum. |
| Instance Actions | |
| getBisect | This action checks whether the given quilt will be bisected when the SplitMode is set to Bisect. |
| setBisect | This action sets whether the given quilt will be bisected when the SplitMode is set to Bisect. |
| getBisectQuilts | This action returns the quilts that will be bisected when the SplitMode is set to Bisect. |
| setBisectQuilts | This action sets the quilts that will be bisected when the SplitMode is set to Bisect. |
| getExtendSplits | This action checks whether the given quilt will extend the splits of any neighboring quilts into itself. |
| setExtendSplits | This action sets whether the given quilt will extend the splits of any neighboring quilts into itself. |
| getExtendSplitsQuilts | This action returns the quilts that will extending splits. |
| setExtendSplitsQuilts | This action sets the quilts that will extend splits. |
| getPointCount | This action gets the number of explicit points to split at. |
| getPoint | This action gets the split point at the given index. |
| getPoints | This action gets all the split points. |
| isValidPoint | This action checks if the given point is valid for this mode. |
| setPoint | This action sets the split point at the given index. |
| addPoint | This action adds an explicit point to split the quilts at. |
| insertPoint | This action inserts a split point before the given index. |
| removePoint | This action removes the split point at the given index. |
| removeAllPoints | This action removes all of the split points and clears any manually set center points. |
| getCenterPoint | This action gets the center point of the given quilt, which can be used to aid in setting the split points. |
| setCenterPoint | This action sets a center point. |
| clearCenterPoint | This action clears a manually set center point of the given quilt. |
| getSplitsCount | This action gets the count of split locations. |
| getXYZsForSplits | This action gets a list of points along the split locations. |
| splitQuilts | This action splits the quilts of this mode. |
| isIncompatibleQuilt | This action checks if the given pw::Quilt object is incompatible with the current settings of this mode. |
| getIncompatibleQuilts | This action returns the list of pw::Quilt objects that are incompatible with the current settings of this mode. |
| isInvalidSplitQuilt | This action checks if the given pw::Quilt object has any invalid split specifications or failed creation of split locations. |
| getInvalidSplitQuilts | This action returns the list of pw::Quilt objects that have an invalid split specification or failed creation of split locations. |
| isInvalidSplitPoint | This action checks if the point at the given index is an invalid split specification or the split location failed to be created. |
| getInvalidSplitPoints | This action returns the list of integer point indices that are an invalid split specification or the split location failed to be created. |
| getFailedSplitQuilts | This action returns the list of pw::Quilt objects that were attempted to be split during the last call to <splitCurves>, but failed to be split. |
$splitter get/setSplitMode split_mode
This attribute is the split mode.
This attribute is a string with valid options < Bisect | OnePoint | TwoPoint | Star >.
The default for this attribute is Bisect.
Some quilts in the mode may only be compatible with certain combinations of SplitMode, SplitType, and SplitMethod. Use getIncompatibleQuilts to check if any of the quilts are incompatible with the current settings. If splitQuilts is called when one of these quilts is selected to be split, any other quilts will be successfully split, but the incompatible quilts will be ignored and can be retrieved using getInvalidSplitQuilts.
$splitter get/setSplitType split_type
This attribute is the split type to carry out with the mode’s points.
This attribute is a string with valid options < Curvature | Lengthwise | Widthwise | Orthogonal >.
The default for this attribute is Curvature.
This attribute is ignored when the SplitMode is TwoPoint or Star.
$splitter get/setSplitMethod split_method
This attribute is the method which the splitting curves are generated.
This attribute is a string with valid options < Parametric | Projected >.
The default for this attribute is Parametric.
This attribute is ignored when the SplitMode is Bisect or OnePoint.
$splitter get/setExtendMode extend_mode
This attribute is the extend mode.
This attribute is a string with valid options < None | Adjacent | AllAdjacent >.
The default for this attribute is None.
$splitter get/setMergeTolerance tol
This attribute is the merge tolerance of the mode. This tolerance is used in determining when to merge splits with existing quilt corners and with other splits. This tolerance is also used to determine if a split is too close to an existing boundary which prevents the split and will be considered an invalid split specification.
This attribute is of type float.
The default for this attribute is the pw::Database.getFitTolerance when the mode was created.
$splitter get/setExtendMaximumBendAngle angle
This attribute is the maximum bending angle allowed when extending splits into adjacent quilts, with 0 meaning no maximum.
A float in the range [0.0, 180.0).
30.0
$splitter getBisect quilt
This action checks whether the given quilt will be bisected when the SplitMode is set to Bisect. By default no quilts will be bisected.
| quilt | This required parameter is the pw::Quilt object to get whether to bisect in Bisect mode. It must be a quilt that is part of this mode, otherwise an error will occur. |
This action returns a boolean if the quilt is to be bisected.
$splitter setBisect quilt bisect
This action sets whether the given quilt will be bisected when the SplitMode is set to Bisect. By default no quilts will be bisected.
| quilt | This required parameter is the pw::Quilt object to set whether to bisect in Bisect mode. It must be a quilt that is part of this mode, otherwise an error will occur. |
| bisect | This required parameter is a boolean for whether to bisect. |
This action does not return anything.
$splitter setBisectQuilts quilts
This action sets the quilts that will be bisected when the SplitMode is set to Bisect.
| quilts | This required parameter is the list of pw::Quilt objects to bisect when SplitMode is Bisect. Any quilts previously set to bisect but not in the given list will no longer be bisected. Any quilts in the list that are not part of this mode will be ignored. |
This action does not return anything.
$splitter getExtendSplits quilt
This action checks whether the given quilt will extend the splits of any neighboring quilts into itself. By default all quilts will have splits extended.
| quilt | This required parameter is the pw::Quilt object to get whether to extend splits. It must be a quilt that is part of this mode, otherwise an error will occur. |
This action returns a boolean if splits are extended
$splitter setExtendSplits quilt extend
This action sets whether the given quilt will extend the splits of any neighboring quilts into itself. By default all quilts will have splits extended.
| quilt | This required parameter is the pw::Quilt object to set whether to extend splits. It must be a quilt that is part of this mode, otherwise an error will occur. |
| extend | This required parameter is a boolean for whether to extend. |
This action does not return anything.
$splitter getExtendSplitsQuilts
This action returns the quilts that will extending splits.
This action has no parameters.
This action returns a list of pw::Quilt objects that are extending splits.
<pw::QuiltSplitter.getExtendSplit>
$splitter setExtendSplitsQuilts quilts
This action sets the quilts that will extend splits.
| quilts | This required parameter is the list of pw::Quilt objects to extend splits. Any quilts previously set to extend splits but not in the given list will no longer extend splits. Any quilts in the list that are not part of this mode will be ignored. |
This action does not return anything.
$splitter getPointCount
This action gets the number of explicit points to split at.
This action has no parameters.
This action returns the integer number of split points.
$splitter getPoints
This action gets all the split points.
This action has no parameters.
This action returns a list of points.
$splitter addPoint point
This action adds an explicit point to split the quilts at.
| point | This required parameter is the point to add. |
This action does not return anything.
$splitter insertPoint index point
This action inserts a split point before the given index.
| index | This required parameter is the integer index to insert the given point in the range [1, number of points + 1] |
| point | This required parameter is the point to be inserted. |
This action does not return anything.
$splitter getCenterPoint quilt
This action gets the center point of the given quilt, which can be used to aid in setting the split points.
| quilt | This required parameter is the pw::Quilt object to get the center point of. It must be a quilt that is part of this mode, otherwise an error will occur. |
This action returns the point at the center of the quilt.
$splitter setCenterPoint point
This action sets a center point. The given point will override the computed center point returned by getCenterPoint for the quilt that the given point is defined on.
| point | This required parameter is the point to set as a center point. It must be defined on a quilt that is part of this mode, otherwise an error will occur. |
This action returns nothing.
$splitter clearCenterPoint point
This action clears a manually set center point of the given quilt.
| quilt | This required parameter is the pw::Quilt object to clear the center point of. It must be a quilt that is part of this mode, otherwise an error will occur. |
This action returns nothing.
$splitter getSplitsCount ?-type location_type? ?-quilts quilt_list? ?-points index_list?
This action gets the count of split locations.
| -type location_type | This optional parameter is the string type of split locations to return with options < All | Explicit | Extension >. |
| -quilts quilt_list | This optional parameter gives a list of quilts to count the split locations of. If not given, the split locations of all quilts will be counted. |
| -points index_list | This optional parameter gives a list of point indices to count the split locations of. If not given, the split locations of all points will be counted. |
This action returns the integer number of split locations.
This command supports progress updates.
$splitter getXYZsForSplits ?-type location_type? ?-quilts quilt_list? ?-points index_list?
This action gets a list of points along the split locations.
| -type location_type | This optional parameter is the string type of split locations to return with options < All | Explicit | Extension >. |
| -quilts quilt_list | This optional parameter gives a list of quilts to retrieve the split locations of. If not given, the split locations of all quilts will be returned. |
| -points index_list | This optional parameter gives a list of point indices to retrieve the split locations of. If not given, the split locations of all points will be returned. |
This action returns xyz points representing the split location. The result will be a list of lines, with each line specified as a list of XYZ vector values.
This command supports progress updates.
$quilter splitQuilts
This action splits the quilts of this mode. The current settings of the mode will control how the splitting is carried out. After splitting, all points will be removed and all quilts will be set to not bisect, but other settings of the mode will be the same.
This action has no parameters.
This action returns a list of pw::Quilt objects that are newly created from the split.
This command supports progress updates.
$splitter isIncompatibleQuilt ?-type location_type? quilt
This action checks if the given pw::Quilt object is incompatible with the current settings of this mode.
| -type location_type | This optional parameter is the string type of split locations to check for incompatibility with options < All | Explicit | Extension >. |
| quilt | This required parameter is the pw::Quilt object to check. It must be a quilt that is part of this mode, otherwise an error will occur. |
This action returns a boolean, true if the quilt is incompatible.
An example of an incompatible quilt is if the SplitMode is Bisect and the quilt has more than one loop.
$splitter getIncompatibleQuilts ?-type location_type?
This action returns the list of pw::Quilt objects that are incompatible with the current settings of this mode.
| -type location_type | This optional parameter is the string type of split locations to check for incompatibility with options < All | Explicit | Extension >. |
This action returns a list of pw::Quilt objects that are incompatible.
An example of an incompatible quilt is if the SplitMode is Bisect and the quilt has more than one loop.
$splitter isInvalidSplitQuilt ?-type location_type? quilt
This action checks if the given pw::Quilt object has any invalid split specifications or failed creation of split locations.
| -type location_type | This optional parameter is the string type of split locations to check for incompatibility with options < All | Explicit | Extension >. |
| quilt | This required parameter is the pw::Quilt object to check. It must be a quilt that is part of this mode, otherwise an error will occur. |
This action returns a boolean, true if the quilt has invalid splits.
A quilt will be considered invalid if it has at least one invalid split specification, even if other specifications are valid and would split the quilt. An example of an invalid split specification is if the SplitMode is TwoPoint but only one point is specified on the quilt. Another example is if the SplitMode is Bisect and a quilt with more than one loop is set to be bisected.
$splitter getInvalidSplitQuilts ?-type location_type?
This action returns the list of pw::Quilt objects that have an invalid split specification or failed creation of split locations.
| -type location_type | This optional parameter is the string type of split locations to check for incompatibility with options < All | Explicit | Extension >. |
This action returns a list of pw::Quilt objects that have an invalid split specification.
A quilt will be considered invalid if it has at least one invalid split specification, even if other specifications are valid and would split the quilt. An example of an invalid split specification is if the SplitMode is TwoPoint but only one point is specified on the quilt. Another example is if the SplitMode is Bisect and a quilt with more than one loop is set to be bisected.
$splitter isInvalidSplitPoint ?-type location_type? index
This action checks if the point at the given index is an invalid split specification or the split location failed to be created.
| -type location_type | This optional parameter is the string type of split locations to check for incompatibility with options < All | Explicit | Extension >. |
| index | This required parameter is the integer index of the point to check in the range [1, number of points]. |
This action returns a boolean, true if the point is an invalid split.
An example of an invalid split specification is if the SplitMode is TwoPoint but only one point is specified on the quilt.
$splitter getInvalidSplitPoints ?-type location_type?
This action returns the list of integer point indices that are an invalid split specification or the split location failed to be created.
| -type location_type | This optional parameter is the string type of split locations to check for incompatibility with options < All | Explicit | Extension >. |
This action returns a list of integer point indices.
An example of an invalid split specification is if the SplitMode is TwoPoint but only one point is specified on the quilt.
This attribute is the split mode.
$splitter get/setSplitMode split_mode
This attribute is the split type to carry out with the mode’s points.
$splitter get/setSplitType split_type
This attribute is the method which the splitting curves are generated.
$splitter get/setSplitMethod split_method
This attribute is the extend mode.
$splitter get/setExtendMode extend_mode
This attribute is the merge tolerance of the mode.
$splitter get/setMergeTolerance tol
This attribute is the maximum bending angle allowed when extending splits into adjacent quilts, with 0 meaning no maximum.
$splitter get/setExtendMaximumBendAngle angle
This action checks whether the given quilt will be bisected when the SplitMode is set to Bisect.
$splitter getBisect quilt
This action sets whether the given quilt will be bisected when the SplitMode is set to Bisect.
$splitter setBisect quilt bisect
This action returns the quilts that will be bisected when the SplitMode is set to Bisect.
$splitter getBisectQuilts
This action sets the quilts that will be bisected when the SplitMode is set to Bisect.
$splitter setBisectQuilts quilts
This action checks whether the given quilt will extend the splits of any neighboring quilts into itself.
$splitter getExtendSplits quilt
This action sets whether the given quilt will extend the splits of any neighboring quilts into itself.
$splitter setExtendSplits quilt extend
This action returns the quilts that will extending splits.
$splitter getExtendSplitsQuilts
This action sets the quilts that will extend splits.
$splitter setExtendSplitsQuilts quilts
This action gets the number of explicit points to split at.
$splitter getPointCount
This action gets the split point at the given index.
$splitter getPoint index
This action gets all the split points.
$splitter getPoints
This action checks if the given point is valid for this mode.
$splitter isValidPoint point
This action sets the split point at the given index.
$splitter setPoint index point
This action adds an explicit point to split the quilts at.
$splitter addPoint point
This action inserts a split point before the given index.
$splitter insertPoint index point
This action removes the split point at the given index.
$splitter removePoint index
This action removes all of the split points and clears any manually set center points.
$splitter removeAllPoints
This action gets the center point of the given quilt, which can be used to aid in setting the split points.
$splitter getCenterPoint quilt
This action sets a center point.
$splitter setCenterPoint point
This action clears a manually set center point of the given quilt.
$splitter clearCenterPoint point
This action gets the count of split locations.
$splitter getSplitsCount ?-type location_type? ?-quilts quilt_list? ?-points index_list?
This action gets a list of points along the split locations.
$splitter getXYZsForSplits ?-type location_type? ?-quilts quilt_list? ?-points index_list?
This action splits the quilts of this mode.
$quilter splitQuilts
This action checks if the given pw::Quilt object is incompatible with the current settings of this mode.
$splitter isIncompatibleQuilt ?-type location_type? quilt
This action returns the list of pw::Quilt objects that are incompatible with the current settings of this mode.
$splitter getIncompatibleQuilts ?-type location_type?
This action checks if the given pw::Quilt object has any invalid split specifications or failed creation of split locations.
$splitter isInvalidSplitQuilt ?-type location_type? quilt
This action returns the list of pw::Quilt objects that have an invalid split specification or failed creation of split locations.
$splitter getInvalidSplitQuilts ?-type location_type?
This action checks if the point at the given index is an invalid split specification or the split location failed to be created.
$splitter isInvalidSplitPoint ?-type location_type? index
This action returns the list of integer point indices that are an invalid split specification or the split location failed to be created.
$splitter getInvalidSplitPoints ?-type location_type?
This action returns the list of pw::Quilt objects that were attempted to be split during the last call to splitCurves, but failed to be split.
$splitter getFailedSplitQuilts
This action gets the fit tolerance for database operations.
pw::Database getFitTolerance