|
override void | Dispose () |
|
override bool | Empty () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Hardcopy.File.ExportOptionsKit in_kit) |
|
| ExportOptionsKit () |
|
| ExportOptionsKit (HPS.Hardcopy.File.ExportOptionsKit in_kit) |
|
override int | GetHashCode () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.Hardcopy.File.ExportOptionsKit in_kit) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetBackgroundPreference (HPS.Hardcopy.BackgroundPreference in_background_preference) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetHiddenLineSorting (bool in_on, float in_activation_weight, HPS.Line.SizeUnits in_units) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetHiddenLineSorting (bool in_on, float in_activation_weight) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetHiddenLineSorting (bool in_on) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetPDFFontPreference (HPS.Hardcopy.PDFFontPreference in_pdf_font_preference) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetRenderingAlgorithm (HPS.Hardcopy.RenderingAlgorithm in_rendering_algorithm) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetResolution (float in_resolution, HPS.Hardcopy.ResolutionUnits in_units) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetResolution (float in_resolution) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetScale (float in_scale, HPS.Hardcopy.SizeUnits in_units) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetScale (float in_scale) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetSize (float in_width, float in_height, HPS.Hardcopy.SizeUnits in_units) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetSize (float in_width, float in_height) |
|
HPS.Hardcopy.File.ExportOptionsKit | SetWYSIWYG (bool in_onoff) |
|
void | Show (out HPS.Hardcopy.File.ExportOptionsKit out_kit) |
|
bool | ShowBackgroundPreference (out HPS.Hardcopy.BackgroundPreference out_background_preference) |
|
bool | ShowHiddenLineSorting (out bool out_state, out float out_threshold, out HPS.Line.SizeUnits out_units) |
|
bool | ShowPDFFontPreference (out HPS.Hardcopy.PDFFontPreference out_pdf_font_preference) |
|
bool | ShowRenderingAlgorithm (out HPS.Hardcopy.RenderingAlgorithm out_rendering_algorithm) |
|
bool | ShowResolution (out float out_resolution, out HPS.Hardcopy.ResolutionUnits out_units) |
|
bool | ShowScale (out float out_scale, out HPS.Hardcopy.SizeUnits out_units) |
|
bool | ShowSize (out float out_width, out float out_height, out HPS.Hardcopy.SizeUnits out_units) |
|
bool | ShowWYSIWYG (out bool out_onoff) |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetBackgroundPreference () |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetEverything () |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetHiddenLineSorting () |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetPDFFontPreference () |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetRenderingAlgorithm () |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetResolution () |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetScale () |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetSize () |
|
HPS.Hardcopy.File.ExportOptionsKit | UnsetWYSIWYG () |
|
override void | Dispose () |
|
| Kit (HPS.Kit in_that) |
|
override HPS.Type | ObjectType () |
|
override HPS.Type | Type () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.Hardcopy.File.ExportOptionsKit class contains settings controlling hardcopy export. Calling HPS.Hardcopy.File.ExportOptionsKit.GetDefault() will return an options kit with values found in here.
◆ ExportOptionsKit() [1/2]
HPS.Hardcopy.File.ExportOptionsKit.ExportOptionsKit |
( |
| ) |
|
|
inline |
◆ ExportOptionsKit() [2/2]
◆ Empty()
override bool HPS.Hardcopy.File.ExportOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ GetDefault()
Creates a ExportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A ExportOptionsKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Hardcopy.File.ExportOptionsKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ Set()
◆ SetBackgroundPreference()
The background preference setting is used to decide how the background of this Hardcopy operation will be handled. If no preference is specified, the background will be forced to be white.
- Parameters
-
in_background_preference | how the background for this Hardcopy export will be handled. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetHiddenLineSorting() [1/3]
Species whether hidden lines are sorted, and if so, what the threshold for sorting is. If Hidden Line Sorting is activated, lines will be printed in proper z-order. If this option is not activated, the order in which lines are printed is non-deterministic. Enabling this option will result in slower performance.
- Parameters
-
in_on | Whether to sort hidden lines or not. |
in_activation_weight | What is the minimum size of hidden lines that are sorted. Lines thinner than this will not be sorted. |
in_units | Units applied to in_activation_weight. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetHiddenLineSorting() [2/3]
Species whether hidden lines are sorted, and if so, what the threshold for sorting is. If Hidden Line Sorting is activated, lines will be printed in proper z-order. If this option is not activated, the order in which lines are printed is non-deterministic. Enabling this option will result in slower performance.
- Parameters
-
in_on | Whether to sort hidden lines or not. |
in_activation_weight | What is the minimum size of hidden lines that are sorted. Lines thinner than this will not be sorted. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetHiddenLineSorting() [3/3]
Species whether hidden lines are sorted, and if so, what the threshold for sorting is. If Hidden Line Sorting is activated, lines will be printed in proper z-order. If this option is not activated, the order in which lines are printed is non-deterministic. Enabling this option will result in slower performance.
- Parameters
-
in_on | Whether to sort hidden lines or not. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetPDFFontPreference()
The PDF font preference setting is used to decide whether fonts will be embedded in an expored PDF file. If no preference is specified, fonts will not be embedded in the exported PDF file. Embedding fonts makes sure that text included in exported PDF files will render the same way on any platform, but has the side effect of increasing the size of exported PDF. The 14 default PDF fonts are never embedded, regardless of this setting, since they are guaranteed to be available to conforming PDF readers.
- Parameters
-
in_pdf_font_preference | the PDF font preference for this Hardcopy export |
- Returns
- A reference to this ExportOptionsKit.
◆ SetRenderingAlgorithm()
The rendering algorithm setting is used to decide how the Hardcopy export will be performed. If no preference is specified, two passes will be used for the Hardcopy export.
- Parameters
-
in_rendering_algorithm | how the Hardcopy export will be handled. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetResolution() [1/2]
Sets the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
in_resolution | Resolution (dots per inch or dots per centimeter). |
in_units | Units of preceding arguments. Defaults to Inches. |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
◆ SetResolution() [2/2]
Sets the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
in_resolution | Resolution (dots per inch or dots per centimeter). |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
◆ SetScale() [1/2]
Scales Visualize units to correspond to real world units. For example, SetScale(1.0f, Hardcopy.SizeUnits.Inches), will make it so that every Visualize unit corresponds to 1 inch for this export, SetScale(2.0f, Hardcopy.SizeUnits.Centimeters), will make it so that every Visualize unit corresponds to 2 centimeters for this export. SetScale(0.2, Hardcopy.SizeUnits.Centimeters), will make it so that every Visualize unit corresponds to 2 millimeters for this export. Setting a scale is not defined for perspective cameras.
- Parameters
-
in_scale | the unit scale. in_scale is required to be a positive number. |
in_units | the unit in_scale is expressed in. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetScale() [2/2]
Scales Visualize units to correspond to real world units. For example, SetScale(1.0f, Hardcopy.SizeUnits.Inches), will make it so that every Visualize unit corresponds to 1 inch for this export, SetScale(2.0f, Hardcopy.SizeUnits.Centimeters), will make it so that every Visualize unit corresponds to 2 centimeters for this export. SetScale(0.2, Hardcopy.SizeUnits.Centimeters), will make it so that every Visualize unit corresponds to 2 millimeters for this export. Setting a scale is not defined for perspective cameras.
- Parameters
-
in_scale | the unit scale. in_scale is required to be a positive number. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetSize() [1/2]
Sets the size of the image to be inserted into the Hardcopy.
- Parameters
-
in_width | Width in inches. |
in_height | Height in inches. |
in_units | Units of preceding arguments. Defaults to Inches |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
◆ SetSize() [2/2]
Sets the size of the image to be inserted into the Hardcopy.
- Parameters
-
in_width | Width in inches. |
in_height | Height in inches. |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
◆ SetWYSIWYG()
Enables or disables WYSIWYG hardcopy output. The WYSIWYG setting (which stands for What You See Is What You Get) works as follows:
-
If true, what you see on the screen is what will be printed. This is the default.
-
If false, everything which will fit on the page size you have specified will be printed, even if some of that is not on screen when you issue the command.
- Parameters
-
in_onoff | true is on, false is off. |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
◆ Show()
◆ ShowBackgroundPreference()
Shows the background preference for this Hardcopy export.
- Parameters
-
out_background_preference | the preference for the background of this Hardcopy export. |
- Returns
- true if a background preference setting was specified, false otherwise.
◆ ShowHiddenLineSorting()
bool HPS.Hardcopy.File.ExportOptionsKit.ShowHiddenLineSorting |
( |
out bool |
out_state, |
|
|
out float |
out_threshold, |
|
|
out HPS.Line.SizeUnits |
out_units |
|
) |
| |
|
inline |
Shows the hidden line sorting options of Hardcopy.
- Parameters
-
out_state | Whether hidden line sorting is on or off. |
out_threshold | The minimum width at which hidden lines are sorted. |
out_units | The units that out_threshold is measured in. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowPDFFontPreference()
Shows the PDF font preference for this Hardcopy export.
- Parameters
-
out_pdf_font_preference | the PDF font preference of this Hardcopy export. |
- Returns
- true if a PDF font preference was specified, false otherwise.
◆ ShowRenderingAlgorithm()
Shows the rendering algorithm for this Hardcopy export.
- Parameters
-
out_rendering_algorithm | the rendering algorithm setting of this Hardcopy export. |
- Returns
- true if a rendering algorithm setting was specified, false otherwise.
◆ ShowResolution()
Shows the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
out_resolution | Resolution (dots per inch or dots per centimeter). |
out_units | Units of preceding arguments. |
- Returns
- true if a size setting was specified, false otherwise.
◆ ShowScale()
bool HPS.Hardcopy.File.ExportOptionsKit.ShowScale |
( |
out float |
out_scale, |
|
|
out HPS.Hardcopy.SizeUnits |
out_units |
|
) |
| |
|
inline |
Shows true if a scale has been set
- Parameters
-
out_scale | the scale specified. |
out_units | the units out_scale is specified in. |
- Returns
- true if a scale setting was specified, false otherwise.
◆ ShowSize()
bool HPS.Hardcopy.File.ExportOptionsKit.ShowSize |
( |
out float |
out_width, |
|
|
out float |
out_height, |
|
|
out HPS.Hardcopy.SizeUnits |
out_units |
|
) |
| |
|
inline |
Shows the size of the image to be inserted into the Hardcopy.
- Parameters
-
out_width | Width. |
out_height | Height. |
out_units | Units of preceding arguments. |
- Returns
- true if a size setting was specified, false otherwise.
◆ ShowWYSIWYG()
bool HPS.Hardcopy.File.ExportOptionsKit.ShowWYSIWYG |
( |
out bool |
out_onoff | ) |
|
|
inline |
Shows true if wysiwyg has been enabled
- Parameters
-
out_onoff | whether 'what you see is what you get' is turned on or off |
- Returns
- true if a wysiwyg setting was specified, false otherwise.
◆ UnsetBackgroundPreference()
◆ UnsetEverything()
◆ UnsetHiddenLineSorting()
Removes the line sorting settings for hidden lines from Hardcopy
- Returns
- A reference to this object.
◆ UnsetPDFFontPreference()
◆ UnsetRenderingAlgorithm()
◆ UnsetResolution()
◆ UnsetScale()
◆ UnsetSize()
◆ UnsetWYSIWYG()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Hardcopy.cs