pw:: SegmentCircle

Circle segment type

Derives From

pw::Object pw::Segment

Summary
Circle segment type
This action creates a new circle segment object.
This action gets the type of the alternate point.
This action removes the alternate point of the circle.
This action gets the shoulder point of the circle.
This action sets the shoulder point of the circle.
This action gets the center point of the circle.
This action sets the center point of the circle.
This action gets the angle of this circular arc.
This action sets the angle of this circular arc.
This action sets the angle of the end point of this circular arc.
This action flips the arc by moving the shoulder and center points in angle mode.
This action gets the current circle normal.

Static Actions

create

pw::SegmentCircle create

This action creates a new circle segment object.

Parameters

none

Returns

This action returns a new pw::SegmentCircle object.

Instance Actions

getAlternatePointType

$segment getAlternatePointType

This action gets the type of the alternate point.

Parameters

none

Returns

This action returns one of None | Shoulder | Center | Angle | EndAngle.

removeAlternatePoint

$segment removeAlternatePoint

This action removes the alternate point of the circle.

Parameters

none

Returns

This action returns nothing.

Information

After this action, getAlternatePointType will return None, and the circle will be represented as a line between the control points

getShoulderPoint

$segment getShoulderPoint

This action gets the shoulder point of the circle.

Parameters

none

Returns

This action returns the shoulder point.

Information

If getAlternatePointType returns Shoulder, this will return the point passed in to setShoulderPoint.  Otherwise it will return the midpoint on the circle.

setShoulderPoint

$segment setShoulderPoint point ?normal?

This action sets the shoulder point of the circle.

Parameters

pointThis parameter is the point to set.
normalThis optional parameter is the circle normal vector to use if the points don’t have a conclusive normal

Returns

This action returns nothing.

Information

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.

getCenterPoint

$segment getCenterPoint

This action gets the center point of the circle.

Parameters

none

Returns

This action returns the center point.

Information

If getAlternatePointType returns Center, this will return the point passed in to setCenterPoint.  Otherwise it will return the center of the circle.

setCenterPoint

$segment setCenterPoint point ?normal?

This action sets the center point of the circle.

Parameters

pointThis parameter is the point to set.
normalThis optional paramter is the circle normal vector to use if the points don’t have a conclusive normal.

Returns

This action returns nothing.

Information

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.

getAngle

$segment getAngle

This action gets the angle of this circular arc.

Parameters

none

Returns

This action returns the angle in degrees as float [0.0, 360.0].

Information

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.

setAngle

$segment setAngle angle ?normal?

This action sets the angle of this circular arc.

Parameters

angleThis parameter is the angle of the circular arc as float [0, 360].
normalThis 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.

Returns

This action returns nothing.

Information

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.

setEndAngle

$segment setEndAngle angle ?normal?

This action sets the angle of the end point of this circular arc.

Parameters

angleThis parameter is the end angle of the circular arc float [0, 360].
normalThis 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.

Returns

This action returns nothing.

Information

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.

flipArc

$segment flipArc

This action flips the arc by moving the shoulder and center points in angle mode.

Parameters

none

Returns

This action returns nothing.

getNormal

$segment getNormal

This action gets the current circle normal.

Parameters

none

Returns

This action returns the circle normal vector.

Information

If the circle is not fully defined, this will return a zero vector.

pw::SegmentCircle create
This action creates a new circle segment object.
$segment getAlternatePointType
This action gets the type of the alternate point.
$segment removeAlternatePoint
This action removes the alternate point of the circle.
$segment getShoulderPoint
This action gets the shoulder point of the circle.
$segment setShoulderPoint point ?normal?
This action sets the shoulder point of the circle.
$segment getCenterPoint
This action gets the center point of the circle.
$segment setCenterPoint point ?normal?
This action sets the center point of the circle.
$segment getAngle
This action gets the angle of this circular arc.
$segment setAngle angle ?normal?
This action sets the angle of this circular arc.
$segment setEndAngle angle ?normal?
This action sets the angle of the end point of this circular arc.
$segment flipArc
This action flips the arc by moving the shoulder and center points in angle mode.
$segment getNormal
This action gets the current circle normal.
Base type for all glyph types
Connector and Curve segment type
Circle segment type
A point is a position either in model space or database parameter space.
A vector is a list of float values.
A float is a fractional number.