Package com.onshape.api.requests

Class AssembliesGetShadedViewsRequest.Builder

java.lang.Object

com.onshape.api.requests.AssembliesGetShadedViewsRequest.Builder

Enclosing class:

AssembliesGetShadedViewsRequest

public static final class AssembliesGetShadedViewsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AssembliesGetShadedViewsResponse	call(OnshapeDocument document)	Calls getShadedViews method, Get a shaded image rendering of an Assembly
AssembliesGetShadedViewsResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getShadedViews method, Get a shaded image rendering of an Assembly
String	edges()	Get The treatment to be applied to edges in the display.
AssembliesGetShadedViewsRequest.Builder	edges(String value)	Set The treatment to be applied to edges in the display.
Boolean	includeSurfaces()	Get Whether or not surfaces should be shown in the element.
AssembliesGetShadedViewsRequest.Builder	includeSurfaces(Boolean value)	Set Whether or not surfaces should be shown in the element.
Boolean	includeWires()	Get Whether or not curves should be shown in the element.
AssembliesGetShadedViewsRequest.Builder	includeWires(Boolean value)	Set Whether or not curves should be shown in the element.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
AssembliesGetShadedViewsRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Number	outputHeight()	Get Output image height (in pixels)
AssembliesGetShadedViewsRequest.Builder	outputHeight(Number value)	Set Output image height (in pixels)
Number	outputWidth()	Get Output image width (in pixels)
AssembliesGetShadedViewsRequest.Builder	outputWidth(Number value)	Set Output image width (in pixels)
Number	pixelSize()	Get Height and width represented by each pixel (in meters).
AssembliesGetShadedViewsRequest.Builder	pixelSize(Number value)	Set Height and width represented by each pixel (in meters).
Boolean	showAllParts()	Get Whether or not all parts should be shown in the element, regardless of user setting.
AssembliesGetShadedViewsRequest.Builder	showAllParts(Boolean value)	Set Whether or not all parts should be shown in the element, regardless of user setting.
Boolean	useAntiAliasing()	Get If true, an anti-aliasing factor will be used to smooth model boundaries in the final image result.
AssembliesGetShadedViewsRequest.Builder	useAntiAliasing(Boolean value)	Set If true, an anti-aliasing factor will be used to smooth model boundaries in the final image result.
String	viewMatrix()	Get 12-number view matrix (comma-separated), or one of the following named views: top, bottom, front, back, left, right The 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself.
AssembliesGetShadedViewsRequest.Builder	viewMatrix(String value)	Set 12-number view matrix (comma-separated), or one of the following named views: top, bottom, front, back, left, right The 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself.

Methods inherited from class java.lang.Object

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

Method Detail

outputHeight

public final Number outputHeight()

Get Output image height (in pixels)

Returns:

Output image height (in pixels)

outputHeight

public final AssembliesGetShadedViewsRequest.Builder outputHeight(Number value)

Set Output image height (in pixels)

Parameters:

value - Output image height (in pixels)

Returns:

the Builder object.

outputWidth

public final Number outputWidth()

Get Output image width (in pixels)

Returns:

Output image width (in pixels)

outputWidth

public final AssembliesGetShadedViewsRequest.Builder outputWidth(Number value)

Set Output image width (in pixels)

Parameters:

value - Output image width (in pixels)

Returns:

the Builder object.

pixelSize

public final Number pixelSize()

Get Height and width represented by each pixel (in meters). If the value is 0, the display will be sized to fit the output image dimensions.

Returns:

Height and width represented by each pixel (in meters). If the value is 0, the display will be sized to fit the output image dimensions.

pixelSize

public final AssembliesGetShadedViewsRequest.Builder pixelSize(Number value)

Set Height and width represented by each pixel (in meters). If the value is 0, the display will be sized to fit the output image dimensions.

Parameters:

value - Height and width represented by each pixel (in meters). If the value is 0, the display will be sized to fit the output image dimensions.

Returns:

the Builder object.

edges

public final String edges()

Get The treatment to be applied to edges in the display. Options are show: show visible edges, hide: hide visible edges

Returns:

The treatment to be applied to edges in the display. Options are show: show visible edges, hide: hide visible edges

edges

public final AssembliesGetShadedViewsRequest.Builder edges(String value)

Set The treatment to be applied to edges in the display. Options are show: show visible edges, hide: hide visible edges

Parameters:

value - The treatment to be applied to edges in the display. Options are show: show visible edges, hide: hide visible edges

Returns:

the Builder object.

showAllParts

public final Boolean showAllParts()

Get Whether or not all parts should be shown in the element, regardless of user setting. If false, the visibility setting made by the user will be reflected in the image. If true, all parts will be shown.

Returns:

Whether or not all parts should be shown in the element, regardless of user setting. If false, the visibility setting made by the user will be reflected in the image. If true, all parts will be shown.

showAllParts

public final AssembliesGetShadedViewsRequest.Builder showAllParts(Boolean value)

Set Whether or not all parts should be shown in the element, regardless of user setting. If false, the visibility setting made by the user will be reflected in the image. If true, all parts will be shown.

Parameters:

value - Whether or not all parts should be shown in the element, regardless of user setting. If false, the visibility setting made by the user will be reflected in the image. If true, all parts will be shown.

Returns:

the Builder object.

includeSurfaces

public final Boolean includeSurfaces()

Get Whether or not surfaces should be shown in the element. If false, surfaces will be excluded. If true, all surfaces will be shown.

Returns:

Whether or not surfaces should be shown in the element. If false, surfaces will be excluded. If true, all surfaces will be shown.

includeSurfaces

public final AssembliesGetShadedViewsRequest.Builder includeSurfaces(Boolean value)

Set Whether or not surfaces should be shown in the element. If false, surfaces will be excluded. If true, all surfaces will be shown.

Parameters:

value - Whether or not surfaces should be shown in the element. If false, surfaces will be excluded. If true, all surfaces will be shown.

Returns:

the Builder object.

includeWires

public final Boolean includeWires()

Get Whether or not curves should be shown in the element. If false, curves will be excluded. If true, all curves will be shown.

Returns:

Whether or not curves should be shown in the element. If false, curves will be excluded. If true, all curves will be shown.

includeWires

public final AssembliesGetShadedViewsRequest.Builder includeWires(Boolean value)

Set Whether or not curves should be shown in the element. If false, curves will be excluded. If true, all curves will be shown.

Parameters:

value - Whether or not curves should be shown in the element. If false, curves will be excluded. If true, all curves will be shown.

Returns:

the Builder object.

useAntiAliasing

public final Boolean useAntiAliasing()

Get If true, an anti-aliasing factor will be used to smooth model boundaries in the final image result. If false, the image will be rasterized at the given resolution. Setting to true can have negative performance implications with respect to rendering time and memory usage. If a high-resolution image is requested and anti-aliasing is turned on, the server may not be able to fulfill the request.

Returns:

If true, an anti-aliasing factor will be used to smooth model boundaries in the final image result. If false, the image will be rasterized at the given resolution. Setting to true can have negative performance implications with respect to rendering time and memory usage. If a high-resolution image is requested and anti-aliasing is turned on, the server may not be able to fulfill the request.

useAntiAliasing

public final AssembliesGetShadedViewsRequest.Builder useAntiAliasing(Boolean value)

Set If true, an anti-aliasing factor will be used to smooth model boundaries in the final image result. If false, the image will be rasterized at the given resolution. Setting to true can have negative performance implications with respect to rendering time and memory usage. If a high-resolution image is requested and anti-aliasing is turned on, the server may not be able to fulfill the request.

Parameters:

value - If true, an anti-aliasing factor will be used to smooth model boundaries in the final image result. If false, the image will be rasterized at the given resolution. Setting to true can have negative performance implications with respect to rendering time and memory usage. If a high-resolution image is requested and anti-aliasing is turned on, the server may not be able to fulfill the request.

Returns:

the Builder object.

viewMatrix

public final String viewMatrix()

Get 12-number view matrix (comma-separated), or one of the following named views: top, bottom, front, back, left, right The 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself. The matrix's first three columns maps the coordinate axes of the model to the coordinate axes of the view, and the fourth column translates the origin (in meters). The view coordinates have x pointing right, y pointing up, and z pointing towards the viewer, while a front view of the model has x pointing right, y pointing away from the viewer, and z pointing up. For example, the identity matrix viewMatrix=1,0,0,0,0,1,0,0,0,0,1,0 corresponds to the top view, and viewMatrix=0.612,0.612,0,0,-0.354,0.354,0.707,0,0.707,-0.707,0.707,0 corresponds (approximately) to the isometric view. The first three columns of the view matrix should be orthonormal and have a positive determinant. If this is not the case, view behavior may be undefined.

Returns:

12-number view matrix (comma-separated), or one of the following named views: top, bottom, front, back, left, right The 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself. The matrix's first three columns maps the coordinate axes of the model to the coordinate axes of the view, and the fourth column translates the origin (in meters). The view coordinates have x pointing right, y pointing up, and z pointing towards the viewer, while a front view of the model has x pointing right, y pointing away from the viewer, and z pointing up. For example, the identity matrix viewMatrix=1,0,0,0,0,1,0,0,0,0,1,0 corresponds to the top view, and viewMatrix=0.612,0.612,0,0,-0.354,0.354,0.707,0,0.707,-0.707,0.707,0 corresponds (approximately) to the isometric view. The first three columns of the view matrix should be orthonormal and have a positive determinant. If this is not the case, view behavior may be undefined.

viewMatrix

public final AssembliesGetShadedViewsRequest.Builder viewMatrix(String value)

Set 12-number view matrix (comma-separated), or one of the following named views: top, bottom, front, back, left, right The 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself. The matrix's first three columns maps the coordinate axes of the model to the coordinate axes of the view, and the fourth column translates the origin (in meters). The view coordinates have x pointing right, y pointing up, and z pointing towards the viewer, while a front view of the model has x pointing right, y pointing away from the viewer, and z pointing up. For example, the identity matrix viewMatrix=1,0,0,0,0,1,0,0,0,0,1,0 corresponds to the top view, and viewMatrix=0.612,0.612,0,0,-0.354,0.354,0.707,0,0.707,-0.707,0.707,0 corresponds (approximately) to the isometric view. The first three columns of the view matrix should be orthonormal and have a positive determinant. If this is not the case, view behavior may be undefined.

Parameters:

value - 12-number view matrix (comma-separated), or one of the following named views: top, bottom, front, back, left, right The 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself. The matrix's first three columns maps the coordinate axes of the model to the coordinate axes of the view, and the fourth column translates the origin (in meters). The view coordinates have x pointing right, y pointing up, and z pointing towards the viewer, while a front view of the model has x pointing right, y pointing away from the viewer, and z pointing up. For example, the identity matrix viewMatrix=1,0,0,0,0,1,0,0,0,0,1,0 corresponds to the top view, and viewMatrix=0.612,0.612,0,0,-0.354,0.354,0.707,0,0.707,-0.707,0.707,0 corresponds (approximately) to the isometric view. The first three columns of the view matrix should be orthonormal and have a positive determinant. If this is not the case, view behavior may be undefined.

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

call

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

Calls getShadedViews method, Get a shaded image rendering of an Assembly

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

Calls getShadedViews method, Get a shaded image rendering of an Assembly

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error