Package com.onshape.api.responses

Class PartStudiosGetSketchInfoResponseSketchesGeomEntities

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.PartStudiosGetSketchInfoResponseSketchesGeomEntities

public final class PartStudiosGetSketchInfoResponseSketchesGeomEntities
extends AbstractResponseObject

Object used in calls to getSketchInfo API endpoint. © 2018-Present Onshape Inc.

Field Summary

Fields

Modifier and Type	Field	Description
Number[]	center	(circle, arc, ellipse, ellipticArc) The center point
Boolean	clockwise	(arc, ellipticArc) If true, the segment is oriented clockwise from the startPoint to the endPoint around the center.
Map[]	controlPoints	(spline[Segment]) The spline control points
Number	curveLength	(curvePoints=true) The length of the curve
Number	degree	(spline[Segment]) The degree of the spline
Number[]	direction	(line, ellipse, ellipticArc) For line, this is the line direction.
Number[]	endDerivative	(interpolatedSpline[Segment]) For a non-periodic spline the derivative at the end of the spline
Number[]	endHandle	(interpolatedSpline[Segment]) For a non-periodic spline, the end handle point use to determine the end derivative.
Number	endParam	(splineSegment, interpolatedSplineSegment) The end parameter of the spline segment
Number[]	endPoint	(lineSegment, arc, ellipticArc, curvePoints=true) The end point of the segment
String[]	endPointIds	A 2-dimensional array of endpoint ids, if the curve is a bounded curve.
Number[]	endVector	(curvePoints=true) The tangent vector at the end of the curve
String	entityType	The type of the entity.
Number[]	interpolationPoints	(interpolatedSpline[Segment]) The interpolation points for the spline
Boolean	isConstruction	Set to true if this is a construction entity
Number[]	knots	(spline[Segment]) The spline knot vector
Number	majorRadius	(ellipse, ellipticArc) The major radius of the elliptic entity
Number[]	midPoint	(curvePoints=true) The point that is half way between the start and end of the curve
Number	minorRadius	(ellipse, ellipticArc) The minor radius of the elliptic entity
Number	numberControlPoints	(spline[Segment]) The number of control points in the spline
Boolean	periodic	(spline[Segment], interpolatedSpline[Segment]) If true, the spline entity is periodic
Number[]	point	(line) An arbitrary point on the line
Number[]	quarterPoint	(curvePoints=true) The point that is one quarter way between the start and end of the curve
Number	radius	(circle, arc).
Boolean	rational	(spline[Segment]) If true, the spline is in rational form
Number[]	startDerivative	(interpolatedSpline[Segment]) For a non-periodic spline the derivative at the start of the spline
Number[]	startHandle	(interpolatedSpline[Segment]) For a non-periodic spline, the start handle point use to determine the start derivative.
Number	startParam	(splineSegment, interpolatedSplineSegment) The start parameter of the spline segment
Number[]	startPoint	(lineSegment, arc, ellipticArc, curvePoints=true) The start point of the segment
Number[]	startVector	(curvePoints=true) The tangent vector at the start of the curve

Constructor Summary

Constructors

Constructor	Description
PartStudiosGetSketchInfoResponseSketchesGeomEntities()

Method Summary

Modifier and Type	Method	Description
Number[]	getCenter()	Get (circle, arc, ellipse, ellipticArc) The center point
Boolean	getClockwise()	Get (arc, ellipticArc) If true, the segment is oriented clockwise from the startPoint to the endPoint around the center.
Map[]	getControlPoints()	Get (spline[Segment]) The spline control points
Number	getCurveLength()	Get (curvePoints=true) The length of the curve
Number	getDegree()	Get (spline[Segment]) The degree of the spline
Number[]	getDirection()	Get (line, ellipse, ellipticArc) For line, this is the line direction.
Number[]	getEndDerivative()	Get (interpolatedSpline[Segment]) For a non-periodic spline the derivative at the end of the spline
Number[]	getEndHandle()	Get (interpolatedSpline[Segment]) For a non-periodic spline, the end handle point use to determine the end derivative.
Number	getEndParam()	Get (splineSegment, interpolatedSplineSegment) The end parameter of the spline segment
Number[]	getEndPoint()	Get (lineSegment, arc, ellipticArc, curvePoints=true) The end point of the segment
String[]	getEndPointIds()	Get A 2-dimensional array of endpoint ids, if the curve is a bounded curve.
Number[]	getEndVector()	Get (curvePoints=true) The tangent vector at the end of the curve
String	getEntityType()	Get The type of the entity.
Number[]	getInterpolationPoints()	Get (interpolatedSpline[Segment]) The interpolation points for the spline
Boolean	getIsConstruction()	Get Set to true if this is a construction entity
Number[]	getKnots()	Get (spline[Segment]) The spline knot vector
Number	getMajorRadius()	Get (ellipse, ellipticArc) The major radius of the elliptic entity
Number[]	getMidPoint()	Get (curvePoints=true) The point that is half way between the start and end of the curve
Number	getMinorRadius()	Get (ellipse, ellipticArc) The minor radius of the elliptic entity
Number	getNumberControlPoints()	Get (spline[Segment]) The number of control points in the spline
Boolean	getPeriodic()	Get (spline[Segment], interpolatedSpline[Segment]) If true, the spline entity is periodic
Number[]	getPoint()	Get (line) An arbitrary point on the line
Number[]	getQuarterPoint()	Get (curvePoints=true) The point that is one quarter way between the start and end of the curve
Number	getRadius()	Get (circle, arc).
Boolean	getRational()	Get (spline[Segment]) If true, the spline is in rational form
Number[]	getStartDerivative()	Get (interpolatedSpline[Segment]) For a non-periodic spline the derivative at the start of the spline
Number[]	getStartHandle()	Get (interpolatedSpline[Segment]) For a non-periodic spline, the start handle point use to determine the start derivative.
Number	getStartParam()	Get (splineSegment, interpolatedSplineSegment) The start parameter of the spline segment
Number[]	getStartPoint()	Get (lineSegment, arc, ellipticArc, curvePoints=true) The start point of the segment
Number[]	getStartVector()	Get (curvePoints=true) The tangent vector at the start of the curve
String	toString()

Methods inherited from class com.onshape.api.types.AbstractResponseObject

getOtherProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

entityType

public String entityType

The type of the entity. Can be one of: "point", "line", "lineSegment", "circle", "arc", "ellipse", "ellipticArc", "spline", "splineSegment", "interpolatedSpline", "interpolatedSplineSegment", "unknownGeometry".

endPointIds

public String[] endPointIds

A 2-dimensional array of endpoint ids, if the curve is a bounded curve.

point

public Number[] point

(line) An arbitrary point on the line

direction

public Number[] direction

(line, ellipse, ellipticArc) For line, this is the line direction. For elliptic entities, this is the direction of the major axis.

startPoint

public Number[] startPoint

(lineSegment, arc, ellipticArc, curvePoints=true) The start point of the segment

endPoint

public Number[] endPoint

(lineSegment, arc, ellipticArc, curvePoints=true) The end point of the segment

center

public Number[] center

(circle, arc, ellipse, ellipticArc) The center point

radius

public Number radius

(circle, arc). The circular radius

majorRadius

public Number majorRadius

(ellipse, ellipticArc) The major radius of the elliptic entity

minorRadius

public Number minorRadius

(ellipse, ellipticArc) The minor radius of the elliptic entity

clockwise

public Boolean clockwise

(arc, ellipticArc) If true, the segment is oriented clockwise from the startPoint to the endPoint around the center.

periodic

public Boolean periodic

(spline[Segment], interpolatedSpline[Segment]) If true, the spline entity is periodic

rational

public Boolean rational

(spline[Segment]) If true, the spline is in rational form

degree

public Number degree

(spline[Segment]) The degree of the spline

numberControlPoints

public Number numberControlPoints

(spline[Segment]) The number of control points in the spline

controlPoints

public Map[] controlPoints

(spline[Segment]) The spline control points

knots

public Number[] knots

(spline[Segment]) The spline knot vector

startParam

public Number startParam

(splineSegment, interpolatedSplineSegment) The start parameter of the spline segment

endParam

public Number endParam

(splineSegment, interpolatedSplineSegment) The end parameter of the spline segment

startHandle

public Number[] startHandle

(interpolatedSpline[Segment]) For a non-periodic spline, the start handle point use to determine the start derivative.

endHandle

public Number[] endHandle

(interpolatedSpline[Segment]) For a non-periodic spline, the end handle point use to determine the end derivative.

startDerivative

public Number[] startDerivative

(interpolatedSpline[Segment]) For a non-periodic spline the derivative at the start of the spline

endDerivative

public Number[] endDerivative

(interpolatedSpline[Segment]) For a non-periodic spline the derivative at the end of the spline

interpolationPoints

public Number[] interpolationPoints

(interpolatedSpline[Segment]) The interpolation points for the spline

isConstruction

public Boolean isConstruction

Set to true if this is a construction entity

curveLength

public Number curveLength

(curvePoints=true) The length of the curve

midPoint

public Number[] midPoint

(curvePoints=true) The point that is half way between the start and end of the curve

quarterPoint

public Number[] quarterPoint

(curvePoints=true) The point that is one quarter way between the start and end of the curve

startVector

public Number[] startVector

(curvePoints=true) The tangent vector at the start of the curve

endVector

public Number[] endVector

(curvePoints=true) The tangent vector at the end of the curve

Constructor Detail

PartStudiosGetSketchInfoResponseSketchesGeomEntities

public PartStudiosGetSketchInfoResponseSketchesGeomEntities()

Method Detail

getEntityType

public final String getEntityType()

Get The type of the entity. Can be one of: "point", "line", "lineSegment", "circle", "arc", "ellipse", "ellipticArc", "spline", "splineSegment", "interpolatedSpline", "interpolatedSplineSegment", "unknownGeometry".

Returns:

The type of the entity. Can be one of: "point", "line", "lineSegment", "circle", "arc", "ellipse", "ellipticArc", "spline", "splineSegment", "interpolatedSpline", "interpolatedSplineSegment", "unknownGeometry".

getEndPointIds

public final String[] getEndPointIds()

Get A 2-dimensional array of endpoint ids, if the curve is a bounded curve.

Returns:

A 2-dimensional array of endpoint ids, if the curve is a bounded curve.

getPoint

public final Number[] getPoint()

Get (line) An arbitrary point on the line

Returns:

(line) An arbitrary point on the line

getDirection

public final Number[] getDirection()

Get (line, ellipse, ellipticArc) For line, this is the line direction. For elliptic entities, this is the direction of the major axis.

Returns:

(line, ellipse, ellipticArc) For line, this is the line direction. For elliptic entities, this is the direction of the major axis.

getStartPoint

public final Number[] getStartPoint()

Get (lineSegment, arc, ellipticArc, curvePoints=true) The start point of the segment

Returns:

(lineSegment, arc, ellipticArc, curvePoints=true) The start point of the segment

getEndPoint

public final Number[] getEndPoint()

Get (lineSegment, arc, ellipticArc, curvePoints=true) The end point of the segment

Returns:

(lineSegment, arc, ellipticArc, curvePoints=true) The end point of the segment

getCenter

public final Number[] getCenter()

Get (circle, arc, ellipse, ellipticArc) The center point

Returns:

(circle, arc, ellipse, ellipticArc) The center point

getRadius

public final Number getRadius()

Get (circle, arc). The circular radius

Returns:

(circle, arc). The circular radius

getMajorRadius

public final Number getMajorRadius()

Get (ellipse, ellipticArc) The major radius of the elliptic entity

Returns:

(ellipse, ellipticArc) The major radius of the elliptic entity

getMinorRadius

public final Number getMinorRadius()

Get (ellipse, ellipticArc) The minor radius of the elliptic entity

Returns:

(ellipse, ellipticArc) The minor radius of the elliptic entity

getClockwise

public final Boolean getClockwise()

Get (arc, ellipticArc) If true, the segment is oriented clockwise from the startPoint to the endPoint around the center.

Returns:

(arc, ellipticArc) If true, the segment is oriented clockwise from the startPoint to the endPoint around the center.

getPeriodic

public final Boolean getPeriodic()

Get (spline[Segment], interpolatedSpline[Segment]) If true, the spline entity is periodic

Returns:

(spline[Segment], interpolatedSpline[Segment]) If true, the spline entity is periodic

getRational

public final Boolean getRational()

Get (spline[Segment]) If true, the spline is in rational form

Returns:

(spline[Segment]) If true, the spline is in rational form

getDegree

public final Number getDegree()

Get (spline[Segment]) The degree of the spline

Returns:

(spline[Segment]) The degree of the spline

getNumberControlPoints

public final Number getNumberControlPoints()

Get (spline[Segment]) The number of control points in the spline

Returns:

(spline[Segment]) The number of control points in the spline

getControlPoints

public final Map[] getControlPoints()

Get (spline[Segment]) The spline control points

Returns:

(spline[Segment]) The spline control points

getKnots

public final Number[] getKnots()

Get (spline[Segment]) The spline knot vector

Returns:

(spline[Segment]) The spline knot vector

getStartParam

public final Number getStartParam()

Get (splineSegment, interpolatedSplineSegment) The start parameter of the spline segment

Returns:

(splineSegment, interpolatedSplineSegment) The start parameter of the spline segment

getEndParam

public final Number getEndParam()

Get (splineSegment, interpolatedSplineSegment) The end parameter of the spline segment

Returns:

(splineSegment, interpolatedSplineSegment) The end parameter of the spline segment

getStartHandle

public final Number[] getStartHandle()

Get (interpolatedSpline[Segment]) For a non-periodic spline, the start handle point use to determine the start derivative.

Returns:

(interpolatedSpline[Segment]) For a non-periodic spline, the start handle point use to determine the start derivative.

getEndHandle

public final Number[] getEndHandle()

Get (interpolatedSpline[Segment]) For a non-periodic spline, the end handle point use to determine the end derivative.

Returns:

(interpolatedSpline[Segment]) For a non-periodic spline, the end handle point use to determine the end derivative.

getStartDerivative

public final Number[] getStartDerivative()

Get (interpolatedSpline[Segment]) For a non-periodic spline the derivative at the start of the spline

Returns:

(interpolatedSpline[Segment]) For a non-periodic spline the derivative at the start of the spline

getEndDerivative

public final Number[] getEndDerivative()

Get (interpolatedSpline[Segment]) For a non-periodic spline the derivative at the end of the spline

Returns:

(interpolatedSpline[Segment]) For a non-periodic spline the derivative at the end of the spline

getInterpolationPoints

public final Number[] getInterpolationPoints()

Get (interpolatedSpline[Segment]) The interpolation points for the spline

Returns:

(interpolatedSpline[Segment]) The interpolation points for the spline

getIsConstruction

public final Boolean getIsConstruction()

Get Set to true if this is a construction entity

Returns:

Set to true if this is a construction entity

getCurveLength

public final Number getCurveLength()

Get (curvePoints=true) The length of the curve

Returns:

(curvePoints=true) The length of the curve

getMidPoint

public final Number[] getMidPoint()

Get (curvePoints=true) The point that is half way between the start and end of the curve

Returns:

(curvePoints=true) The point that is half way between the start and end of the curve

getQuarterPoint

public final Number[] getQuarterPoint()

Get (curvePoints=true) The point that is one quarter way between the start and end of the curve

Returns:

(curvePoints=true) The point that is one quarter way between the start and end of the curve

getStartVector

public final Number[] getStartVector()

Get (curvePoints=true) The tangent vector at the start of the curve

Returns:

(curvePoints=true) The tangent vector at the start of the curve

getEndVector

public final Number[] getEndVector()

Get (curvePoints=true) The tangent vector at the end of the curve

Returns:

(curvePoints=true) The tangent vector at the end of the curve

toString

public String toString()

Overrides:

toString in class Object