REFERENCE MANUAL
The ImportOptionsKit class contains options that will be used to import image files and will be set on the ImageKit returned by File::Import. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ImportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Image.ImportOptionsKit in_kit) |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More... | |
override int | GetHashCode () |
ImportOptionsKit () | |
The default constructor creates an empty ImportOptionsKit object. More... | |
ImportOptionsKit (HPS.Image.ImportOptionsKit in_kit) | |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Image.ImportOptionsKit in_kit) |
Copies the source ImportOptionsKit into this ImportOptionsKit. More... | |
HPS.Image.ImportOptionsKit | SetCompressionQuality (float in_quality) |
Sets the compression quality for the image. More... | |
HPS.Image.ImportOptionsKit | SetDownSampling (bool in_state) |
Sets whether to down-sample the image. More... | |
HPS.Image.ImportOptionsKit | SetFormat (HPS.Image.Format in_format) |
Sets the format of the image. More... | |
HPS.Image.ImportOptionsKit | SetSize (uint in_width, uint in_height) |
Sets the width and height (in pixels) of the image. More... | |
void | Show (out HPS.Image.ImportOptionsKit out_kit) |
Copies this ImportOptionsKit into the given ImportOptionsKit. More... | |
bool | ShowCompressionQuality (out float out_quality) |
Shows the compression quality for the image. More... | |
bool | ShowDownSampling (out bool out_state) |
Shows whether to down-sample the image. More... | |
bool | ShowFormat (out HPS.Image.Format out_format) |
Shows the format of the image. More... | |
bool | ShowSize (out uint out_width, out uint out_height) |
Shows the width and height (in pixels) of the image. More... | |
HPS.Image.ImportOptionsKit | UnsetCompressionQuality () |
Removes the compression quality for the image. More... | |
HPS.Image.ImportOptionsKit | UnsetDownSampling () |
Removes whether to down-sample the image. More... | |
HPS.Image.ImportOptionsKit | UnsetEverything () |
Removes all settings from this ImportOptionsKit. More... | |
HPS.Image.ImportOptionsKit | UnsetFormat () |
Removes the format of the image. More... | |
HPS.Image.ImportOptionsKit | UnsetSize () |
Removes the width and height of the image. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Image.ImportOptionsKit a, HPS.Image.ImportOptionsKit b) |
static bool | operator== (HPS.Image.ImportOptionsKit a, HPS.Image.ImportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ImportOptionsKit class contains options that will be used to import image files and will be set on the ImageKit returned by File::Import.
HPS.Image.ImportOptionsKit.ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
HPS.Image.ImportOptionsKit.ImportOptionsKit | ( | HPS.Image.ImportOptionsKit | in_kit | ) |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_image_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this ImportOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Image.ImportOptionsKit.Equals | ( | HPS.Image.ImportOptionsKit | in_kit | ) |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_image_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_image_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref>. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.Image.ImportOptionsKit.Set | ( | HPS.Image.ImportOptionsKit | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_image_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to copy. |
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.SetCompressionQuality | ( | float | in_quality | ) |
Sets the compression quality for the image.
This setting will be copied over to the ImageKit returned from File::Import. It doesn't need to be set for the import to succeed.
in_quality | The compression quality for the image. |
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.SetDownSampling | ( | bool | in_state | ) |
Sets whether to down-sample the image.
This setting will be copied over to the ImageKit returned from File::Import. It doesn't need to be set for the import to succeed.
in_state | Whether to down-sample the image. |
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.SetFormat | ( | HPS.Image.Format | in_format | ) |
Sets the format of the image.
This must be specified when importing any image.
in_format | The format of the image. |
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.SetSize | ( | uint | in_width, |
uint | in_height | ||
) |
Sets the width and height (in pixels) of the image.
This does not need to be set when importing image files which contain this information (i.e., Image::Jpeg, Image::Png or Image::Targa). If this is not specified for images files which do not contain this information, an exception will be thrown on import.
in_width | The width (in pixels) of the image. |
in_height | The height (in pixels) of the image. |
void HPS.Image.ImportOptionsKit.Show | ( | out HPS.Image.ImportOptionsKit | out_kit | ) |
Copies this ImportOptionsKit into the given ImportOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_image_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_image_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref>. |
bool HPS.Image.ImportOptionsKit.ShowCompressionQuality | ( | out float | out_quality | ) |
Shows the compression quality for the image.
out_quality | The compression quality for the image. |
bool HPS.Image.ImportOptionsKit.ShowDownSampling | ( | out bool | out_state | ) |
Shows whether to down-sample the image.
out_state | whether to down-sample the image. |
bool HPS.Image.ImportOptionsKit.ShowFormat | ( | out HPS.Image.Format | out_format | ) |
Shows the format of the image.
out_format | The format of the image. |
bool HPS.Image.ImportOptionsKit.ShowSize | ( | out uint | out_width, |
out uint | out_height | ||
) |
Shows the width and height (in pixels) of the image.
out_width | The width (in pixels) of the image. |
out_height | The height (in pixels) of the image. |
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetCompressionQuality | ( | ) |
Removes the compression quality for the image.
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetDownSampling | ( | ) |
Removes whether to down-sample the image.
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetFormat | ( | ) |
Removes the format of the image.
HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetSize | ( | ) |
Removes the width and height of the image.