Package com.onshape.api.requests

Class PartStudiosGetEdgesRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosGetEdgesRequest.Builder

Enclosing class:

PartStudiosGetEdgesRequest

public static final class PartStudiosGetEdgesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Number	angleTolerance()	Get Angle tolerance (in radians).
PartStudiosGetEdgesRequest.Builder	angleTolerance(Number value)	Set Angle tolerance (in radians).
PartStudiosGetEdgesResponse	call(OnshapeDocument document)	Calls getEdges method, Get the tessellated edges of the parts in a Part Studio.
PartStudiosGetEdgesResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getEdges method, Get the tessellated edges of the parts in a Part Studio.
Number	chordTolerance()	Get Chord tolerance (in meters).
PartStudiosGetEdgesRequest.Builder	chordTolerance(Number value)	Set Chord tolerance (in meters).
String	configuration()	Get Configuration string
PartStudiosGetEdgesRequest.Builder	configuration(String value)	Set Configuration string
String	edgeId()	Get IDs of edges to tessellate (repeat query param to add more than one, i.e.
PartStudiosGetEdgesRequest.Builder	edgeId(String value)	Set IDs of edges to tessellate (repeat query param to add more than one, i.e.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosGetEdgesRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
String	partId()	Get IDs of the parts to tessellate (repeat query param to add more than one, i.e.
PartStudiosGetEdgesRequest.Builder	partId(String value)	Set IDs of the parts to tessellate (repeat query param to add more than one, i.e.
String	precomputedLevelOfDetail()	Get medium, fine] If this parameter is specified, the provided level of detail will be retrieved from cache (if available) and used to return the tessellation in a more timely manner.
PartStudiosGetEdgesRequest.Builder	precomputedLevelOfDetail(String value)	Set medium, fine] If this parameter is specified, the provided level of detail will be retrieved from cache (if available) and used to return the tessellation in a more timely manner.

Methods inherited from class java.lang.Object

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

Method Detail

angleTolerance

public final Number angleTolerance()

Get Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated.

Returns:

Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated.

angleTolerance

public final PartStudiosGetEdgesRequest.Builder angleTolerance(Number value)

Set Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated.

Parameters:

value - Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated.

Returns:

the Builder object.

chordTolerance

public final Number chordTolerance()

Get Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated.

Returns:

Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated.

chordTolerance

public final PartStudiosGetEdgesRequest.Builder chordTolerance(Number value)

Set Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated.

Parameters:

value - Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated.

Returns:

the Builder object.

edgeId

public final String edgeId()

Get IDs of edges to tessellate (repeat query param to add more than one, i.e. edgeId=JHK&edgeId=JHD)

Returns:

IDs of edges to tessellate (repeat query param to add more than one, i.e. edgeId=JHK&edgeId=JHD)

edgeId

public final PartStudiosGetEdgesRequest.Builder edgeId(String value)

Set IDs of edges to tessellate (repeat query param to add more than one, i.e. edgeId=JHK&edgeId=JHD)

Parameters:

value - IDs of edges to tessellate (repeat query param to add more than one, i.e. edgeId=JHK&edgeId=JHD)

Returns:

the Builder object.

partId

public final String partId()

Get IDs of the parts to tessellate (repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with edgeId

Returns:

IDs of the parts to tessellate (repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with edgeId

partId

public final PartStudiosGetEdgesRequest.Builder partId(String value)

Set IDs of the parts to tessellate (repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with edgeId

Parameters:

value - IDs of the parts to tessellate (repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with edgeId

Returns:

the Builder object.

precomputedLevelOfDetail

public final String precomputedLevelOfDetail()

Get medium, fine] If this parameter is specified, the provided level of detail will be retrieved from cache (if available) and used to return the tessellation in a more timely manner.

Returns:

medium, fine] If this parameter is specified, the provided level of detail will be retrieved from cache (if available) and used to return the tessellation in a more timely manner.

precomputedLevelOfDetail

public final PartStudiosGetEdgesRequest.Builder precomputedLevelOfDetail(String value)

Set medium, fine] If this parameter is specified, the provided level of detail will be retrieved from cache (if available) and used to return the tessellation in a more timely manner.

Parameters:

value - medium, fine] If this parameter is specified, the provided level of detail will be retrieved from cache (if available) and used to return the tessellation in a more timely manner.

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final PartStudiosGetEdgesRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final PartStudiosGetEdgesRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

public final PartStudiosGetEdgesResponse call(String did,
                                              WVM wvmType,
                                              String wvm,
                                              String eid)
                                       throws OnshapeException

Calls getEdges method, Get the tessellated edges of the parts in a Part Studio. The accuracy of the tessellation approximation to exact geometry is controlled by the angleTolerance and chordTolerance parameters. The tessellation points are computed close enough so that neither the angle tolerance nor the chord tolerance are exceeded. All coordinates are in meters.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartStudiosGetEdgesResponse call(OnshapeDocument document)
                                       throws OnshapeException

Calls getEdges method, Get the tessellated edges of the parts in a Part Studio. The accuracy of the tessellation approximation to exact geometry is controlled by the angleTolerance and chordTolerance parameters. The tessellation points are computed close enough so that neither the angle tolerance nor the chord tolerance are exceeded. All coordinates are in meters.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error