Package com.onshape.api.requests

Class PartStudiosGetTessellatedEntitiesRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosGetTessellatedEntitiesRequest.Builder

Enclosing class:

PartStudiosGetTessellatedEntitiesRequest

public static final class PartStudiosGetTessellatedEntitiesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Number	angleTolerance()	Get Angle tolerance (in radians).
PartStudiosGetTessellatedEntitiesRequest.Builder	angleTolerance(Number value)	Set Angle tolerance (in radians).
PartStudiosGetTessellatedEntitiesResponse	call(OnshapeDocument document, String sid)	Calls getTessellatedEntities method, Get the tessellations of the sketch entities of a sketch in a part studio.
PartStudiosGetTessellatedEntitiesResponse	call(String did, WVM wvmType, String wvm, String eid, String sid)	Calls getTessellatedEntities method, Get the tessellations of the sketch entities of a sketch in a part studio.
Number	chordTolerance()	Get Chord tolerance (in meters).
PartStudiosGetTessellatedEntitiesRequest.Builder	chordTolerance(Number value)	Set Chord tolerance (in meters).
String	configuration()	Get Configuration string
PartStudiosGetTessellatedEntitiesRequest.Builder	configuration(String value)	Set Configuration string
String	entityId()	Get Sketch entity id to be tessellated.
PartStudiosGetTessellatedEntitiesRequest.Builder	entityId(String value)	Set Sketch entity id to be tessellated.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosGetTessellatedEntitiesRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

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

Method Detail

entityId

public final String entityId()

Get Sketch entity id to be tessellated. All entities in the sketch are tessellated if none are provided.

Returns:

Sketch entity id to be tessellated. All entities in the sketch are tessellated if none are provided.

entityId

public final PartStudiosGetTessellatedEntitiesRequest.Builder entityId(String value)

Set Sketch entity id to be tessellated. All entities in the sketch are tessellated if none are provided.

Parameters:

value - Sketch entity id to be tessellated. All entities in the sketch are tessellated if none are provided.

Returns:

the Builder object.

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 of 0.087267 radians, but is subject to change.

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 of 0.087267 radians, but is subject to change.

angleTolerance

public final PartStudiosGetTessellatedEntitiesRequest.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 of 0.087267 radians, but is subject to change.

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 of 0.087267 radians, but is subject to change.

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 curve. This parameter currently has a default value of 0.02 meters, but is subject to change.

Returns:

Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true curve. This parameter currently has a default value of 0.02 meters, but is subject to change.

chordTolerance

public final PartStudiosGetTessellatedEntitiesRequest.Builder chordTolerance(Number value)

Set Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true curve. This parameter currently has a default value of 0.02 meters, but is subject to change.

Parameters:

value - Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true curve. This parameter currently has a default value of 0.02 meters, but is subject to change.

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 PartStudiosGetTessellatedEntitiesRequest.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 PartStudiosGetTessellatedEntitiesRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls getTessellatedEntities method, Get the tessellations of the sketch entities of a sketch in a part studio. The accuracy of the tessellation 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. For most parts, the angular tolerance is the most restrictive of the two default tolerances.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

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

eid - Element ID

sid - Sketch feature ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartStudiosGetTessellatedEntitiesResponse call(OnshapeDocument document,
                                                            String sid)
                                                     throws OnshapeException

Calls getTessellatedEntities method, Get the tessellations of the sketch entities of a sketch in a part studio. The accuracy of the tessellation 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. For most parts, the angular tolerance is the most restrictive of the two default tolerances.

Parameters:

document - Document object from Onshape URL.

sid - Sketch feature ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error