Package com.onshape.api.requests

Class PartsGetFacesRequest.Builder

java.lang.Object

com.onshape.api.requests.PartsGetFacesRequest.Builder

Enclosing class:

PartsGetFacesRequest

public static final class PartsGetFacesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Number	angleTolerance()	Get Angle tolerance (in radians).
PartsGetFacesRequest.Builder	angleTolerance(Number value)	Set Angle tolerance (in radians).
PartsGetFacesResponse	call(OnshapeDocument document, String partid)	Calls getFaces method, Get the tessellated faces of a part.
PartsGetFacesResponse	call(String did, WVM wvmType, String wvm, String eid, String partid)	Calls getFaces method, Get the tessellated faces of a part.
Number	chordTolerance()	Get Chord tolerance (in meters).
PartsGetFacesRequest.Builder	chordTolerance(Number value)	Set Chord tolerance (in meters).
String	combineCompositePartConstituents()	Get If true, the geometry belonging to the constituents of composite parts will be combined within the parent composite part, rather than each constituent having its own node in the result.
PartsGetFacesRequest.Builder	combineCompositePartConstituents(String value)	Set If true, the geometry belonging to the constituents of composite parts will be combined within the parent composite part, rather than each constituent having its own node in the result.
String	configuration()	Get Configuration string
PartsGetFacesRequest.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.
PartsGetFacesRequest.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.
PartsGetFacesRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Number	maxFacetWidth()	Get Max facet width.
PartsGetFacesRequest.Builder	maxFacetWidth(Number value)	Set Max facet width.
Boolean	outputErrorFaces()	Get Whether or not to output faces that cause an error
PartsGetFacesRequest.Builder	outputErrorFaces(Boolean value)	Set Whether or not to output faces that cause an error
Boolean	outputFacetNormals()	Get Output facet normals
PartsGetFacesRequest.Builder	outputFacetNormals(Boolean value)	Set Output facet normals
Boolean	outputIndexTable()	Get Output index table
PartsGetFacesRequest.Builder	outputIndexTable(Boolean value)	Set Output index table
Boolean	outputTextureCoordinates()	Get Output texture coordinates
PartsGetFacesRequest.Builder	outputTextureCoordinates(Boolean value)	Set Output texture coordinates
Boolean	outputVertexNormals()	Get Output vertex normals
PartsGetFacesRequest.Builder	outputVertexNormals(Boolean value)	Set Output vertex normals
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.
PartsGetFacesRequest.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 part 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 part being tessellated.

angleTolerance

public final PartsGetFacesRequest.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 part 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 part 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 PartsGetFacesRequest.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 PartsGetFacesRequest.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.

outputVertexNormals

public final Boolean outputVertexNormals()

Get Output vertex normals

Returns:

Output vertex normals

outputVertexNormals

public final PartsGetFacesRequest.Builder outputVertexNormals(Boolean value)

Set Output vertex normals

Parameters:

value - Output vertex normals

Returns:

the Builder object.

outputFacetNormals

public final Boolean outputFacetNormals()

Get Output facet normals

Returns:

Output facet normals

outputFacetNormals

public final PartsGetFacesRequest.Builder outputFacetNormals(Boolean value)

Set Output facet normals

Parameters:

value - Output facet normals

Returns:

the Builder object.

outputTextureCoordinates

public final Boolean outputTextureCoordinates()

Get Output texture coordinates

Returns:

Output texture coordinates

outputTextureCoordinates

public final PartsGetFacesRequest.Builder outputTextureCoordinates(Boolean value)

Set Output texture coordinates

Parameters:

value - Output texture coordinates

Returns:

the Builder object.

outputIndexTable

public final Boolean outputIndexTable()

Get Output index table

Returns:

Output index table

outputIndexTable

public final PartsGetFacesRequest.Builder outputIndexTable(Boolean value)

Set Output index table

Parameters:

value - Output index table

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 PartsGetFacesRequest.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.

outputErrorFaces

public final Boolean outputErrorFaces()

Get Whether or not to output faces that cause an error

Returns:

Whether or not to output faces that cause an error

outputErrorFaces

public final PartsGetFacesRequest.Builder outputErrorFaces(Boolean value)

Set Whether or not to output faces that cause an error

Parameters:

value - Whether or not to output faces that cause an error

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 PartsGetFacesRequest.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.

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 PartsGetFacesRequest.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.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final PartsGetFacesRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

combineCompositePartConstituents

public final String combineCompositePartConstituents()

Get If true, the geometry belonging to the constituents of composite parts will be combined within the parent composite part, rather than each constituent having its own node in the result.

Returns:

If true, the geometry belonging to the constituents of composite parts will be combined within the parent composite part, rather than each constituent having its own node in the result.

combineCompositePartConstituents

public final PartsGetFacesRequest.Builder combineCompositePartConstituents(String value)

Set If true, the geometry belonging to the constituents of composite parts will be combined within the parent composite part, rather than each constituent having its own node in the result.

Parameters:

value - If true, the geometry belonging to the constituents of composite parts will be combined within the parent composite part, rather than each constituent having its own node in the result.

Returns:

the Builder object.

call

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

Calls getFaces method, Get the tessellated faces of a part. 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.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

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

eid - Element ID

partid - Part ID (must be URL encoded)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartsGetFacesResponse call(OnshapeDocument document,
                                        String partid)
                                 throws OnshapeException

Calls getFaces method, Get the tessellated faces of a part. 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.

Parameters:

document - Document object from Onshape URL.

partid - Part ID (must be URL encoded)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error