Package com.onshape.api.requests

Class PartStudiosExportGltfRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosExportGltfRequest.Builder

Enclosing class:

PartStudiosExportGltfRequest

public static final class PartStudiosExportGltfRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Number	angleTolerance()	Get Angle tolerance (in radians).
PartStudiosExportGltfRequest.Builder	angleTolerance(Number value)	Set Angle tolerance (in radians).
PartStudiosExportGltfResponse	call(OnshapeDocument document)	Calls exportGltf method, Export glTF representation of parts in a Part Studio.
PartStudiosExportGltfResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls exportGltf method, Export glTF representation of parts in a Part Studio.
Number	chordTolerance()	Get Chord tolerance (in meters).
PartStudiosExportGltfRequest.Builder	chordTolerance(Number value)	Set Chord tolerance (in meters).
String	configuration()	Get Configuration string
PartStudiosExportGltfRequest.Builder	configuration(String value)	Set Configuration string
String	faceId()	Get IDs of the faces to tessellate (repeat query param to add more than one, i.e.
PartStudiosExportGltfRequest.Builder	faceId(String value)	Set IDs of the faces 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.
PartStudiosExportGltfRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Number	maxFacetWidth()	Get Max facet width.
PartStudiosExportGltfRequest.Builder	maxFacetWidth(Number value)	Set Max facet width.
Boolean	outputFaceAppearances()	Get Determines if face appearance data will be included in the output
PartStudiosExportGltfRequest.Builder	outputFaceAppearances(Boolean value)	Set Determines if face appearance data will be included in the output
Boolean	outputSeparateFaceNodes()	Get Determines if separate nodes will be created for each face or per part.
PartStudiosExportGltfRequest.Builder	outputSeparateFaceNodes(Boolean value)	Set Determines if separate nodes will be created for each face or per part.
String	partId()	Get IDs of the parts to tessellate (repeat query param to add more than one, i.e.
PartStudiosExportGltfRequest.Builder	partId(String value)	Set IDs of the parts to tessellate (repeat query param to add more than one, i.e.
String	precomputedLevelOfDetail()	Get 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.
PartStudiosExportGltfRequest.Builder	precomputedLevelOfDetail(String value)	Set 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

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 faceId

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 faceId

partId

public final PartStudiosExportGltfRequest.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 faceId

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 faceId

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 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 PartStudiosExportGltfRequest.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 surface/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 surface/edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated.

chordTolerance

public final PartStudiosExportGltfRequest.Builder chordTolerance(Number value)

Set Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true surface/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 surface/edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated.

Returns:

the Builder object.

maxFacetWidth

public final Number maxFacetWidth()

Get Max facet width. This specifies the limit on the size of any side of a tessellation facet.

Returns:

Max facet width. This specifies the limit on the size of any side of a tessellation facet.

maxFacetWidth

public final PartStudiosExportGltfRequest.Builder maxFacetWidth(Number value)

Set Max facet width. This specifies the limit on the size of any side of a tessellation facet.

Parameters:

value - Max facet width. This specifies the limit on the size of any side of a tessellation facet.

Returns:

the Builder object.

faceId

public final String faceId()

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

Returns:

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

faceId

public final PartStudiosExportGltfRequest.Builder faceId(String value)

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

Parameters:

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

Returns:

the Builder object.

precomputedLevelOfDetail

public final String precomputedLevelOfDetail()

Get 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. The level-of-detail setting entails automatically-set chordal and angular tolerances. Hence any tolerances supplied to this API call will be ignored. Accepts the following values: coarse, medium, fine

Returns:

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. The level-of-detail setting entails automatically-set chordal and angular tolerances. Hence any tolerances supplied to this API call will be ignored. Accepts the following values: coarse, medium, fine

precomputedLevelOfDetail

public final PartStudiosExportGltfRequest.Builder precomputedLevelOfDetail(String value)

Set 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. The level-of-detail setting entails automatically-set chordal and angular tolerances. Hence any tolerances supplied to this API call will be ignored. Accepts the following values: coarse, medium, fine

Parameters:

value - 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. The level-of-detail setting entails automatically-set chordal and angular tolerances. Hence any tolerances supplied to this API call will be ignored. Accepts the following values: coarse, medium, fine

Returns:

the Builder object.

outputFaceAppearances

public final Boolean outputFaceAppearances()

Get Determines if face appearance data will be included in the output

Returns:

Determines if face appearance data will be included in the output

outputFaceAppearances

public final PartStudiosExportGltfRequest.Builder outputFaceAppearances(Boolean value)

Set Determines if face appearance data will be included in the output

Parameters:

value - Determines if face appearance data will be included in the output

Returns:

the Builder object.

outputSeparateFaceNodes

public final Boolean outputSeparateFaceNodes()

Get Determines if separate nodes will be created for each face or per part.

Returns:

Determines if separate nodes will be created for each face or per part.

outputSeparateFaceNodes

public final PartStudiosExportGltfRequest.Builder outputSeparateFaceNodes(Boolean value)

Set Determines if separate nodes will be created for each face or per part.

Parameters:

value - Determines if separate nodes will be created for each face or per part.

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

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls exportGltf method, Export glTF representation of parts in a Part Studio. The accuracy of the tessellation approximation to exact geometry is controlled by the angleTolerance, chordTolerance and maxFacetWidth parameters. The tessellation points are computed close enough so that none of these parameters are exceeded. All coordinates are in meters. The glTF output from this endpoint will differ from that exported from the UI. For output that matches that please use the PartStudios-createTranslation API.

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 PartStudiosExportGltfResponse call(OnshapeDocument document)
                                         throws OnshapeException

Calls exportGltf method, Export glTF representation of parts in a Part Studio. The accuracy of the tessellation approximation to exact geometry is controlled by the angleTolerance, chordTolerance and maxFacetWidth parameters. The tessellation points are computed close enough so that none of these parameters are exceeded. All coordinates are in meters. The glTF output from this endpoint will differ from that exported from the UI. For output that matches that please use the PartStudios-createTranslation API.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error