
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Hardcopy.File.ExportOptionsKit in_kit) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More... | |
ExportOptionsKit () | |
The default constructor creates an empty ExportOptionsKit object. More... | |
ExportOptionsKit (HPS.Hardcopy.File.ExportOptionsKit in_kit) | |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
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). More... | |
void | Set (HPS.Hardcopy.File.ExportOptionsKit in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetBackgroundPreference (HPS.Hardcopy.BackgroundPreference in_background_preference) |
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. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetHiddenLineSorting (bool in_on, float in_activation_weight, HPS.Line.SizeUnits in_units) |
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. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetHiddenLineSorting (bool in_on, float in_activation_weight) |
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. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetHiddenLineSorting (bool in_on) |
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. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetRenderingAlgorithm (HPS.Hardcopy.RenderingAlgorithm in_rendering_algorithm) |
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. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetResolution (float in_resolution, HPS.Hardcopy.ResolutionUnits in_units) |
Sets the resolution of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetResolution (float in_resolution) |
Sets the resolution of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetScale (float in_scale, HPS.Hardcopy.SizeUnits in_units) |
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. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetScale (float in_scale) |
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. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetSize (float in_width, float in_height, HPS.Hardcopy.SizeUnits in_units) |
Sets the size of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetSize (float in_width, float in_height) |
Sets the size of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | SetWYSIWYG (bool in_onoff) |
Enables or disables WYSIWYG hardcopy output. The WYSIWYG setting (which stands for What You See Is What You Get) works as follows: More... | |
void | Show (out HPS.Hardcopy.File.ExportOptionsKit out_kit) |
Copies this ExportOptionsKit into the given ExportOptionsKit. More... | |
bool | ShowBackgroundPreference (out HPS.Hardcopy.BackgroundPreference out_background_preference) |
Shows the background preference for this Hardcopy export. More... | |
bool | ShowHiddenLineSorting (out bool out_state, out float out_threshold, out HPS.Line.SizeUnits out_units) |
Shows the hidden line sorting options of Hardcopy. More... | |
bool | ShowRenderingAlgorithm (out HPS.Hardcopy.RenderingAlgorithm out_rendering_algorithm) |
Shows the rendering algorithm for this Hardcopy export. More... | |
bool | ShowResolution (out float out_resolution, out HPS.Hardcopy.ResolutionUnits out_units) |
Shows the resolution of the image to be inserted into the Hardcopy. More... | |
bool | ShowScale (out float out_scale, out HPS.Hardcopy.SizeUnits out_units) |
Shows true if a scale has been set More... | |
bool | ShowSize (out float out_width, out float out_height, out HPS.Hardcopy.SizeUnits out_units) |
Shows the size of the image to be inserted into the Hardcopy. More... | |
bool | ShowWYSIWYG (out bool out_onoff) |
Shows true if wysiwyg has been enabled More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetBackgroundPreference () |
Removes the background preference setting from this Hardcopy export. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetEverything () |
Removes all settings from this ExportOptionsKit. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetHiddenLineSorting () |
Removes the line sorting settings for hidden lines from Hardcopy More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetRenderingAlgorithm () |
Removes the rendering algorithm setting from this Hardcopy export. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetResolution () |
Removes the resolution of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetScale () |
Removes the scale setting from Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetSize () |
Removes the size of the image to be inserted into the Hardcopy. More... | |
HPS.Hardcopy.File.ExportOptionsKit | UnsetWYSIWYG () |
Removes the wysiwyg setting from Hardcopy. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
override HPS.Type | ObjectType () |
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). More... | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.Hardcopy.File.ExportOptionsKit | 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. More... | |
static bool | operator!= (HPS.Hardcopy.File.ExportOptionsKit a, HPS.Hardcopy.File.ExportOptionsKit b) |
static bool | operator== (HPS.Hardcopy.File.ExportOptionsKit a, HPS.Hardcopy.File.ExportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
◆ ExportOptionsKit() [1/2]
|
inline |
The default constructor creates an empty ExportOptionsKit object.
◆ ExportOptionsKit() [2/2]
|
inline |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
Member Function Documentation
◆ Empty()
|
inlinevirtual |
Indicates whether this ExportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportOptionsKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
inlinestatic |
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()
|
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()
|
inline |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
◆ SetBackgroundPreference()
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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.
◆ SetRenderingAlgorithm()
|
inline |
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]
|
inline |
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.
Default value
◆ SetResolution() [2/2]
|
inline |
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.
Default value
◆ SetScale() [1/2]
|
inline |
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]
|
inline |
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]
|
inline |
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.
Default value
◆ SetSize() [2/2]
|
inline |
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.
Default value
◆ SetWYSIWYG()
|
inline |
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.
Default value
◆ Show()
|
inline |
Copies this ExportOptionsKit into the given ExportOptionsKit.
- Parameters
-
out_kit The ExportOptionsKit to populate with the contents of this ExportOptionsKit.
◆ ShowBackgroundPreference()
|
inline |
◆ ShowHiddenLineSorting()
|
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.
◆ ShowRenderingAlgorithm()
|
inline |
◆ ShowResolution()
|
inline |
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()
|
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()
|
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()
|
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()
|
inline |
Removes the background preference setting from this Hardcopy export.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetEverything()
|
inline |
Removes all settings from this ExportOptionsKit.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetHiddenLineSorting()
|
inline |
Removes the line sorting settings for hidden lines from Hardcopy
- Returns
- A reference to this object.
◆ UnsetRenderingAlgorithm()
|
inline |
Removes the rendering algorithm setting from this Hardcopy export.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetResolution()
|
inline |
Removes the resolution of the image to be inserted into the Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetScale()
|
inline |
Removes the scale setting from Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetSize()
|
inline |
Removes the size of the image to be inserted into the Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetWYSIWYG()
|
inline |
Removes the wysiwyg setting from Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Hardcopy.cs