CadOptions (groupdocs-viewer (25.12) API Reference)

java.lang.Object
- com.groupdocs.viewer.options.CadOptions

public class CadOptions
extends Object

Provides options for rendering CAD drawings.

The CadOptions class encapsulates various settings and parameters that can be used to control the rendering of CAD drawings in the GroupDocs.Viewer component.

For more information and code examples, see the Render CAD drawings and models as HTML, PDF, and image files and Specify rendering options for CAD files.

Example usage:


 CadOptions options = CadOptions.forRenderingByWidth(256);
 options.setRenderLayouts(true);
 options.setBackgroundColor(Color.YELLOW);
 options.setLayers(Arrays.asList(
         CacheableFactory.getInstance().newLayer("Layer1"),
         CacheableFactory.getInstance().newLayer("Layer2")
 ));

 try (Viewer viewer = new Viewer("document.dwg")) {
     PdfViewOptions pdfViewOptions = new PdfViewOptions();
     pdfViewOptions.setCadOptions(options);
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }

See Also:: CacheableFactory, PdfViewOptions, Viewer

Field Summary

Fields
Modifier and Type Field and Description

static String HEIGHT

static String WIDTH

Fields
Modifier and Type	Field and Description
`static String`	`HEIGHT`
`static String`	`WIDTH`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Checks if this CadOptions object is equal to another object.
`static CadOptions`	`forRenderingByHeight(int height)` Initializes a new instance of the `CadOptions` class for rendering by height.
`static CadOptions`	`forRenderingByScaleFactor(double scaleFactor)` Initializes a new instance of the `CadOptions` class for rendering by scale factor.
`static CadOptions`	`forRenderingByWidth(int width)` Initializes a new instance of the `CadOptions` class for rendering by width.
`static CadOptions`	`forRenderingByWidthAndHeight(int width, int height)` Initializes a new instance of the `CadOptions` class for rendering by width and height.
`Color`	`getBackgroundColor()` Gets the background color of the image.
`String`	`getBackgroundColorAsHex()` Gets the background color of the image.
`int`	`getHeight()` Gets the height of the output result in pixels.
`List<Layer>`	`getLayers()` Gets the CAD drawing layers to render.
`String`	`getLayoutName()` Gets the name of the specific layout to render.
`String`	`getPc3File()` Retrieves the PC3 (Plotter Configuration) file associated with the plotter.
`double`	`getScaleFactor()` Gets the scale factor for rendering.
`List<Tile>`	`getTiles()` Gets the drawing regions to render.
`int`	`getWidth()` Gets the width of the output result in pixels.
`int`	`hashCode()`
`boolean`	`isEnablePerformanceConversionMode()` Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family.
`boolean`	`isRenderLayouts()` Indicates whether layouts from the CAD document should be rendered.
`void`	`setBackgroundColor(Color backgroundColor)` Sets the background color of the image.
`void`	`setBackgroundColor(String colorName)` Sets the background color of the image.
`void`	`setEnablePerformanceConversionMode(boolean enablePerformanceConversionMode)` Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family.
`void`	`setLayers(List<Layer> value)` Gets the CAD drawing layers to render.
`void`	`setLayoutName(String value)` Sets the name of the specific layout to render.
`void`	`setPc3File(String pc3File)` Sets the PC3 (Plotter Configuration) file associated with the plotter.
`void`	`setRenderLayouts(boolean value)` Sets whether layouts from the CAD document should be rendered.
`void`	`setTiles(List<Tile> value)` Sets the drawing regions to render.
`String`	`toString()`
`String`	`toString(org.apache.commons.lang3.builder.ToStringStyle style)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - HEIGHT
```
public static final String HEIGHT
```
    See Also:
    
    Constant Field Values
  - WIDTH
```
public static final String WIDTH
```
    See Also:
    
    Constant Field Values
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Checks if this CadOptions object is equal to another object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - The object to compare with.
    
    Returns:
    
    true if the objects are equal, false otherwise.
  - forRenderingByHeight
```
public static CadOptions forRenderingByHeight(int height)
```
    Initializes a new instance of the CadOptions class for rendering by height.
    
    For code example, see the documentation.
    
    Parameters:
    
    height - The height of the output result in pixels.
    
    Returns:
    
    a new instance of the CadOptions class for rendering by height.
    
    Throws:
    
    IllegalArgumentException - If height is less than or equal to zero.
  - forRenderingByScaleFactor
```
public static CadOptions forRenderingByScaleFactor(double scaleFactor)
```
    Initializes a new instance of the CadOptions class for rendering by scale factor.
    
    For code example, see the documentation.
    
    Parameters:
    
    scaleFactor - The scale factor for rendering. Values greater than 1 will enlarge the output result, while values between 0 and 1 will make the output result smaller.
    
    Returns:
    
    a new instance of the CadOptions class for rendering by scale factor.
  - forRenderingByWidth
```
public static CadOptions forRenderingByWidth(int width)
```
    Initializes a new instance of the CadOptions class for rendering by width.
    
    For code example, see the documentation.
    
    Parameters:
    
    width - The width of the output result in pixels.
    
    Returns:
    
    a new instance of the CadOptions class for rendering by width.
    
    Throws:
    
    IllegalArgumentException - If width is less than or equal to zero.
  - forRenderingByWidthAndHeight
```
public static CadOptions forRenderingByWidthAndHeight(int width,
                                                      int height)
```
    Initializes a new instance of the CadOptions class for rendering by width and height.
    
    For code example, see the documentation.
    
    Parameters:
    
    width - The width of the output result in pixels.
    
    height - The height of the output result in pixels.
    
    Returns:
    
    a new instance of the CadOptions class for rendering by width and height.
    
    Throws:
    
    IllegalArgumentException - If width is less than or equal to zero or if height is less than or equal to zero.
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Gets the background color of the image.
    
    Returns:
    
    the background color of the image.
  - getBackgroundColorAsHex
```
public String getBackgroundColorAsHex()
```
    Gets the background color of the image.
    
    Returns:
    
    the background color of the image in 0xFFFFFF format.
  - getHeight
```
public final int getHeight()
```
    Gets the height of the output result in pixels.
    
    Returns:
    
    the height of the output result.
  - getLayers
```
public final List<Layer> getLayers()
```
    Gets the CAD drawing layers to render.
    
    Note: By default, all layers are rendered. Layer names are case-sensitive.
    
    Returns:
    
    the CAD drawing layers.
  - getLayoutName
```
public final String getLayoutName()
```
    Gets the name of the specific layout to render. The layout name is case-sensitive.
    Note: This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.
    
    Returns:
    
    the name of the specific layout to render.
  - getPc3File
```
public String getPc3File()
```
    Retrieves the PC3 (Plotter Configuration) file associated with the plotter.
    
    Returns:
    
    the PC3 file path.
  - getScaleFactor
```
public final double getScaleFactor()
```
    Gets the scale factor for rendering. Values higher than 1 will enlarge the output result, while values between 0 and 1 will make the output result smaller.
    
    Returns:
    
    the scale factor for rendering.
  - getTiles
```
public final List<Tile> getTiles()
```
    Gets the drawing regions to render.
    Note: This option is supported only for FileType.DWG and FileType.DWT file types. The RenderLayouts (isRenderLayouts()/setRenderLayouts(boolean)) and LayoutName (getLayoutName()/setLayoutName(String)) options are ignored when rendering by tiles.
    
    Returns:
    
    the list of drawing regions to render.
  - getWidth
```
public final int getWidth()
```
    Gets the width of the output result in pixels.
    
    Returns:
    
    the width of the output result.
  - hashCode
```
public int hashCode()
```
    Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.
    Note: This method overrides the default implementation of the hashCode() method defined in the Object class.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code value for this object.
  - isEnablePerformanceConversionMode
```
public boolean isEnablePerformanceConversionMode()
```
    Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. In this mode, the conversion speed is much faster, but the quality of the resultant documents is significantly worse. By default, it is disabled (false). The quality of the resultant documents is the best possible at the expense of performance.
    
    Returns:
    
    true if performance-oriented conversion mode is enabled, false otherwise.
  - isRenderLayouts
```
public final boolean isRenderLayouts()
```
    Indicates whether layouts from the CAD document should be rendered.
    Note: This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.
    
    Returns:
    
    true if layouts should be rendered, false otherwise.
  - setBackgroundColor
```
public void setBackgroundColor(Color backgroundColor)
```
    Sets the background color of the image.
    
    Parameters:
    
    backgroundColor - The background color of the image.
  - setBackgroundColor
```
public void setBackgroundColor(String colorName)
```
    Sets the background color of the image.
    
    Parameters:
    
    colorName - The background color name of the image.
  - setEnablePerformanceConversionMode
```
public void setEnablePerformanceConversionMode(boolean enablePerformanceConversionMode)
```
    Setting this flag to true enables a special performance-oriented conversion mode for all formats within the CAD family. In this mode, the conversion speed is much faster, but the quality of the resultant documents is significantly worse. By default, it is disabled (false). The quality of the resultant documents is the best possible at the expense of performance.
    
    Parameters:
    
    enablePerformanceConversionMode - true to enable the performance-oriented conversion mode, false to disable it.
  - setLayers
```
public final void setLayers(List<Layer> value)
```
    Gets the CAD drawing layers to render.
    Note: By default, all layers are rendered. Layer names are case-sensitive.
    
    Parameters:
    
    value - The CAD drawing layers.
  - setLayoutName
```
public final void setLayoutName(String value)
```
    Sets the name of the specific layout to render. The layout name is case-sensitive.
    Note: This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.
    
    Parameters:
    
    value - The name of the specific layout to render.
  - setPc3File
```
public void setPc3File(String pc3File)
```
    Sets the PC3 (Plotter Configuration) file associated with the plotter.
    
    Parameters:
    
    pc3File - The PC3 file path.
  - setRenderLayouts
```
public final void setRenderLayouts(boolean value)
```
    Sets whether layouts from the CAD document should be rendered.
    Note: This option applies only to CAD drawings that support layouts, such as FileType.DXF, FileType.DWG, FileType.DWT, FileType.DWF, and FileType.DWFX. By default, only the Model is rendered.
    
    Parameters:
    
    value - true to render layouts, false otherwise.
  - setTiles
```
public final void setTiles(List<Tile> value)
```
    Sets the drawing regions to render.
    Note: This option is supported only for FileType.DWG and FileType.DWT file types. The RenderLayouts (isRenderLayouts()/setRenderLayouts(boolean)) and LayoutName (getLayoutName()/setLayoutName(String)) options are ignored when rendering by tiles.
    
    Parameters:
    
    value - The list of drawing regions to render.
  - toString
```
public String toString()
```
    Returns a string representation of this object.
    Note: This method overrides the default implementation of the toString() method defined in the Object class.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this object.
  - toString
```
public String toString(org.apache.commons.lang3.builder.ToStringStyle style)
```
    Returns a string representation of this object.
    Note: This method overrides the default implementation of the toString() method defined in the Object class.
    
    Parameters:
    
    style - The ToStringStyle to use for generating the string representation.
    
    Returns:
    
    a string representation of this object using the specified ToStringStyle.

Class CadOptions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEIGHT

WIDTH

Method Detail

equals

forRenderingByHeight

forRenderingByScaleFactor

forRenderingByWidth

forRenderingByWidthAndHeight

getBackgroundColor

getBackgroundColorAsHex

getHeight

getLayers

getLayoutName

getPc3File

getScaleFactor

getTiles

getWidth

hashCode

isEnablePerformanceConversionMode

isRenderLayouts

setBackgroundColor

setBackgroundColor

setEnablePerformanceConversionMode

setLayers

setLayoutName

setPc3File

setRenderLayouts

setTiles

toString

toString