Circle segment type
pw:: | Circle segment type |
Static Actions | |
create | This action creates a new circle segment object. |
Instance Actions | |
getAlternatePointType | This action gets the type of the alternate point. |
removeAlternatePoint | This action removes the alternate point of the circle. |
getShoulderPoint | This action gets the shoulder point of the circle. |
setShoulderPoint | This action sets the shoulder point of the circle. |
getCenterPoint | This action gets the center point of the circle. |
setCenterPoint | This action sets the center point of the circle. |
getAngle | This action gets the angle of this circular arc. |
setAngle | This action sets the angle of this circular arc. |
setEndAngle | This action sets the angle of the end point of this circular arc. |
flipArc | This action flips the arc by moving the shoulder and center points in angle mode. |
getNormal | This action gets the current circle normal. |
pw::SegmentCircle create
This action creates a new circle segment object.
none
This action returns a new pw::SegmentCircle object.
$segment getAlternatePointType
This action gets the type of the alternate point.
none
This action returns a string with options < None | Shoulder | Center | Angle | EndAngle >.
$segment removeAlternatePoint
This action removes the alternate point of the circle.
none
This action returns nothing.
After this action, getAlternatePointType will return None, and the circle will be represented as a line between the control points
$segment getShoulderPoint
This action gets the shoulder point of the circle.
none
This action returns the shoulder point.
If getAlternatePointType returns Shoulder, this will return the point passed in to setShoulderPoint. Otherwise it will return the midpoint on the circle.
$segment setShoulderPoint point ?normal?
This action sets the shoulder point of the circle.
point | This required parameter is the point to set. |
normal | This optional parameter is the circle normal vector to use if the points don’t have a conclusive normal |
This action returns nothing.
After this action, getAlternatePointType will return Shoulder, and the circle will be represented as an arc between the control points, which passes through the given shoulder point.
$segment getCenterPoint
This action gets the center point of the circle.
none
This action returns the center point.
If getAlternatePointType returns Center, this will return the point passed in to setCenterPoint. Otherwise it will return the center of the circle.
$segment setCenterPoint point ?normal?
This action sets the center point of the circle.
point | This required parameter is the point to set. |
normal | This optional paramter is the circle normal vector to use if the points don’t have a conclusive normal. |
This action returns nothing.
After this action, getAlternatePointType will return Center, and the circle will be represented as the shortest arc between the control points, with the center being the given center point. If the given center point is not at an equal distance between the control points, it will be modified so that it is.
$segment getAngle
This action gets the angle of this circular arc.
none
This action returns the float angle in degrees in the range [0.0, 360.0].
If getAlternatePointType returns Angle or EndAngle, this will return the angle passed in to setAngle or setEndAngle. Otherwise it will return the angle of the circle.
$segment setAngle angle ?normal?
This action sets the angle of this circular arc.
angle | This required parameter is the float angle of the circular arc in the range [0.0, 360.0]. |
normal | This optional parameter is the circle normal vector to use if the points don’t have a conclusive normal. The default value is the positive Z axis. |
This action returns nothing.
After this action, getAlternatePointType will return Angle, and the circle will be represented as the arc between the control points, with the angle being the given angle. Except if the angle is 360 degrees, then the arc will be a full 360 degrees beginning and ending at the first control point, with the midpoint of the arc at the second control point.
$segment setEndAngle angle ?normal?
This action sets the angle of the end point of this circular arc.
angle | This required parameter is the float end angle of the circular arc in the range [0.0, 360.0]. |
normal | This optional parameter is the circle normal vector to use if the points don’t have a conclusive normal. The default value is the positive Z axis. |
This action returns nothing.
After this action, getAlternatePointType will return EndAngle, and the circle will be represented as the arc from the first control point, with the second control as the center, and the angle being the given angle.
$segment getNormal
This action gets the current circle normal.
none
This action returns the circle normal vector.
If the circle is not fully defined, this will return a zero vector.
This action creates a new circle segment object.
pw::SegmentCircle create
This action gets the type of the alternate point.
$segment getAlternatePointType
This action removes the alternate point of the circle.
$segment removeAlternatePoint
This action gets the shoulder point of the circle.
$segment getShoulderPoint
This action sets the shoulder point of the circle.
$segment setShoulderPoint point ?normal?
This action gets the center point of the circle.
$segment getCenterPoint
This action sets the center point of the circle.
$segment setCenterPoint point ?normal?
This action gets the angle of this circular arc.
$segment getAngle
This action sets the angle of this circular arc.
$segment setAngle angle ?normal?
This action sets the angle of the end point of this circular arc.
$segment setEndAngle angle ?normal?
This action flips the arc by moving the shoulder and center points in angle mode.
$segment flipArc
This action gets the current circle normal.
$segment getNormal