CIP JAVA documentation for class "com.ptc.pfc.pfcModel.PlotInstructions"

Interface PlotInstructions

package com.ptc.pfc.pfcModel; public interface PlotInstructions extends com.ptc.pfc.pfcModel.ExportInstructions

Description

Instructions object used to plot drawings.

This export-instructions class has been superseeded by PrinterInstructions objects.

See Also:: pfcModel.PlotInstructions_Create(String), Model.Export(String, ExportInstructions)

Method Summary
`/optional/ Integer`	`GetFirstPage ()` Get method for attribute "FirstPage" When PageRangeChoice is `PlotPageRange.PLOT_RANGE_OF_PAGES`, this specifies the first page to print. Otherwise, the value is `null`
`boolean`	`GetLabelPlot ()` Get method for attribute "LabelPlot" If set to `true` , generates the plot with a label. Default is `false`; no label is created.
`/optional/ Integer`	`GetLastPage ()` Get method for attribute "LastPage" When PageRangeChoice is `PlotPageRange.PLOT_RANGE_OF_PAGES`, this specifies the last page to print. Otherwise, the value is `null`
`int`	`GetOutputQuality ()` Get method for attribute "OutputQuality" A value of 0, 1, 2, or 3. Default is 1. Defines the amount of checking for overlapping lines in a plot or 2-D export file, such as IGES, before making a file. The values are interpreted as follows: 0-Does not check for overlapping lines or collect lines of the same pen color. 1-Does not check for overlapping lines, but collects lines of the same pen color for plotting. 2-Partially checks edges with two vertices, and collects lines of the same pen color for plotting. 3-Does a complete check of all edges against each other, regardless of the number of vertices, font, or color. Collects lines of the same pen color for plotting.
`PlotPageRange`	`GetPageRangeChoice ()` Get method for attribute "PageRangeChoice" One of the `PlotPageRange` enumeration objects. Default is PlotPageRange.PLOT_RANGE_ALL.
`PlotPaperSize`	`GetPaperSize ()` Get method for attribute "PaperSize" One of the `PlotPaperSize` enumeration objects. Default is PlotPaperSize.ASIZEPLOT.
`/optional/ Double`	`GetPaperSizeX ()` Get method for attribute "PaperSizeX" When PaperSize is `PlotPaperSize.VARIABLEPLOTSIZE`, this specifies the size of the plotter paper in the X dimension. Otherwise, the value is `null`
`/optional/ Double`	`GetPaperSizeY ()` Get method for attribute "PaperSizeY" When PaperSize is `PlotPaperSize.VARIABLEPLOTSIZE`, this specifies the size of the plotter paper in the Y dimension. Otherwise, the value is `null`.
`boolean`	`GetPenSlew ()` Get method for attribute "PenSlew" Set to `true` if you want to adjust pen velocity. Default is `false`.
`double`	`GetPenVelocityX ()` Get method for attribute "PenVelocityX" When PenSlew is `true`, this value is a multiple of the default pen speed in the X dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is `false`.
`double`	`GetPenVelocityY ()` Get method for attribute "PenVelocityY" When PenSlew is `true`, this value is a multiple of the default pen speed in the y dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is `false`.
`String`	`GetPlotterName ()` Get method for attribute "PlotterName" c.f. The print dialog for support names eg: POSTSCRIPT, COLORPOSTSC
`boolean`	`GetSegmentedOutput ()` Get method for attribute "SegmentedOutput" Set to `true` to generate a segmented plot. Default is `false`.This may be `true` only if you are plotting a single page.
`boolean`	`GetSeparatePlotFiles ()` Get method for attribute "SeparatePlotFiles" Defines the default in the Print to File dialog box. `true`-Sets the default to Create Separate Files. `false` -A single file is created by default.
`double`	`GetUserScale ()` Get method for attribute "UserScale" Specifies a scale factor between 0.01 and 100 for scaling a model or drawing for plotting. Default is 0.01.
`void`	`SetFirstPage ( /optional/ Integer value)` Set method for attribute "FirstPage" When PageRangeChoice is `PlotPageRange.PLOT_RANGE_OF_PAGES`, this specifies the first page to print. Otherwise, the value is `null`
`void`	`SetLabelPlot (boolean value)` Set method for attribute "LabelPlot" If set to `true` , generates the plot with a label. Default is `false`; no label is created.
`void`	`SetLastPage ( /optional/ Integer value)` Set method for attribute "LastPage" When PageRangeChoice is `PlotPageRange.PLOT_RANGE_OF_PAGES`, this specifies the last page to print. Otherwise, the value is `null`
`void`	`SetOutputQuality (int value)` Set method for attribute "OutputQuality" A value of 0, 1, 2, or 3. Default is 1. Defines the amount of checking for overlapping lines in a plot or 2-D export file, such as IGES, before making a file. The values are interpreted as follows: 0-Does not check for overlapping lines or collect lines of the same pen color. 1-Does not check for overlapping lines, but collects lines of the same pen color for plotting. 2-Partially checks edges with two vertices, and collects lines of the same pen color for plotting. 3-Does a complete check of all edges against each other, regardless of the number of vertices, font, or color. Collects lines of the same pen color for plotting.
`void`	`SetPageRangeChoice (PlotPageRange value)` Set method for attribute "PageRangeChoice" One of the `PlotPageRange` enumeration objects. Default is PlotPageRange.PLOT_RANGE_ALL.
`void`	`SetPaperSize (PlotPaperSize value)` Set method for attribute "PaperSize" One of the `PlotPaperSize` enumeration objects. Default is PlotPaperSize.ASIZEPLOT.
`void`	`SetPaperSizeX ( /optional/ Double value)` Set method for attribute "PaperSizeX" When PaperSize is `PlotPaperSize.VARIABLEPLOTSIZE`, this specifies the size of the plotter paper in the X dimension. Otherwise, the value is `null`
`void`	`SetPaperSizeY ( /optional/ Double value)` Set method for attribute "PaperSizeY" When PaperSize is `PlotPaperSize.VARIABLEPLOTSIZE`, this specifies the size of the plotter paper in the Y dimension. Otherwise, the value is `null`.
`void`	`SetPenSlew (boolean value)` Set method for attribute "PenSlew" Set to `true` if you want to adjust pen velocity. Default is `false`.
`void`	`SetPenVelocityX (double value)` Set method for attribute "PenVelocityX" When PenSlew is `true`, this value is a multiple of the default pen speed in the X dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is `false`.
`void`	`SetPenVelocityY (double value)` Set method for attribute "PenVelocityY" When PenSlew is `true`, this value is a multiple of the default pen speed in the y dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is `false`.
`void`	`SetPlotterName (String value)` Set method for attribute "PlotterName" c.f. The print dialog for support names eg: POSTSCRIPT, COLORPOSTSC
`void`	`SetSegmentedOutput (boolean value)` Set method for attribute "SegmentedOutput" Set to `true` to generate a segmented plot. Default is `false`.This may be `true` only if you are plotting a single page.
`void`	`SetSeparatePlotFiles (boolean value)` Set method for attribute "SeparatePlotFiles" Defines the default in the Print to File dialog box. `true`-Sets the default to Create Separate Files. `false` -A single file is created by default.
`void`	`SetUserScale (double value)` Set method for attribute "UserScale" Specifies a scale factor between 0.01 and 100 for scaling a model or drawing for plotting. Default is 0.01.

Methods Inherited from Interface `com.ptc.pfc.pfcModel.ExportInstructions`
`GetFileType`

Method Detail

GetPlotterName/SetPlotterName

`String`	`GetPlotterName`	`()`
`void`	`SetPlotterName`	`(String value)`

c.f. The print dialog for support names eg: POSTSCRIPT, COLORPOSTSC

Note: MS_PRINT_MGR is not supported

GetOutputQuality/SetOutputQuality

`int`	`GetOutputQuality`	`()`
`void`	`SetOutputQuality`	`(int value)`

A value of 0, 1, 2, or 3. Default is 1. Defines the amount of checking for overlapping lines in a plot or 2-D export file, such as IGES, before making a file.

The values are interpreted as follows:

0-Does not check for overlapping lines or collect lines of the same pen color.
1-Does not check for overlapping lines, but collects lines of the same pen color for plotting.
2-Partially checks edges with two vertices, and collects lines of the same pen color for plotting.
3-Does a complete check of all edges against each other, regardless of the number of vertices, font, or color. Collects lines of the same pen color for plotting.

GetUserScale/SetUserScale

`double`	`GetUserScale`	`()`
`void`	`SetUserScale`	`(double value)`

Specifies a scale factor between 0.01 and 100 for scaling a model or drawing for plotting. Default is 0.01.

GetPenSlew/SetPenSlew

`boolean`	`GetPenSlew`	`()`
`void`	`SetPenSlew`	`(boolean value)`

Set to true if you want to adjust pen velocity. Default is false.

GetPenVelocityX/SetPenVelocityX

`double`	`GetPenVelocityX`	`()`
`void`	`SetPenVelocityX`	`(double value)`

When PenSlew is true, this value is a multiple of the default pen speed in the X dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is false.

GetPenVelocityY/SetPenVelocityY

`double`	`GetPenVelocityY`	`()`
`void`	`SetPenVelocityY`	`(double value)`

When PenSlew is true, this value is a multiple of the default pen speed in the y dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is false.

GetSegmentedOutput/SetSegmentedOutput

`boolean`	`GetSegmentedOutput`	`()`
`void`	`SetSegmentedOutput`	`(boolean value)`

Set to true to generate a segmented plot. Default is false.This may be true only if you are plotting a single page.

GetLabelPlot/SetLabelPlot

`boolean`	`GetLabelPlot`	`()`
`void`	`SetLabelPlot`	`(boolean value)`

If set to true , generates the plot with a label. Default is false; no label is created.

GetSeparatePlotFiles/SetSeparatePlotFiles

`boolean`	`GetSeparatePlotFiles`	`()`
`void`	`SetSeparatePlotFiles`	`(boolean value)`

Defines the default in the Print to File dialog box.

true-Sets the default to Create Separate Files.
false -A single file is created by default.

GetPaperSize/SetPaperSize

`PlotPaperSize`	`GetPaperSize`	`()`
`void`	`SetPaperSize`	`(PlotPaperSize value)`

One of the PlotPaperSize enumeration objects. Default is PlotPaperSize.ASIZEPLOT.

GetPageRangeChoice/SetPageRangeChoice

`PlotPageRange`	`GetPageRangeChoice`	`()`
`void`	`SetPageRangeChoice`	`(PlotPageRange value)`

One of the PlotPageRange enumeration objects. Default is PlotPageRange.PLOT_RANGE_ALL.

GetPaperSizeX/SetPaperSizeX

`/optional/ Double`	`GetPaperSizeX`	`()`
`void`	`SetPaperSizeX`	`( /optional/ Double value)`

When PaperSize is PlotPaperSize.VARIABLEPLOTSIZE, this specifies the size of the plotter paper in the X dimension. Otherwise, the value is null

GetPaperSizeY/SetPaperSizeY

`/optional/ Double`	`GetPaperSizeY`	`()`
`void`	`SetPaperSizeY`	`( /optional/ Double value)`

When PaperSize is PlotPaperSize.VARIABLEPLOTSIZE, this specifies the size of the plotter paper in the Y dimension. Otherwise, the value is null.

GetFirstPage/SetFirstPage

`/optional/ Integer`	`GetFirstPage`	`()`
`void`	`SetFirstPage`	`( /optional/ Integer value)`

When PageRangeChoice is PlotPageRange.PLOT_RANGE_OF_PAGES, this specifies the first page to print. Otherwise, the value is null

GetLastPage/SetLastPage

`/optional/ Integer`	`GetLastPage`	`()`
`void`	`SetLastPage`	`( /optional/ Integer value)`

When PageRangeChoice is PlotPageRange.PLOT_RANGE_OF_PAGES, this specifies the last page to print. Otherwise, the value is null