HPS::Image::ImportOptionsKit
- class HPS.Image.ImportOptionsKit : public HPS.Kit
The ImportOptionsKit class contains options that will be used to import image files and will be set on the ImageKit returned by File.Import.
Public Functions
- override void Dispose ()
- override bool Empty ()
Indicates whether this ImportOptionsKit has any values set on it.
- Return
true if no values are set on this ImportOptionsKit, false otherwise.
- bool Equals (HPS.Image.ImportOptionsKit in_kit)
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Param in_kit
The source ImportOptionsKit to compare to this ImportOptionsKit.
- Return
true if the objects are equivalent, false otherwise.
- override bool Equals (Object obj)
- override int GetHashCode ()
- ImportOptionsKit ()
The default constructor creates an empty ImportOptionsKit object.
- ImportOptionsKit (HPS.Image.ImportOptionsKit in_kit)
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Param in_kit
The source ImportOptionsKit to copy.
- 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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void Set (HPS.Image.ImportOptionsKit in_kit)
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Param in_kit
The source ImportOptionsKit to copy.
- 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.
- Param in_quality
The compression quality for the image.
- Return
A reference to this 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.
- Param in_state
Whether to down-sample the image.
- Return
A reference to this ImportOptionsKit.
- HPS.Image.ImportOptionsKit SetFormat (HPS.Image.Format in_format)
Sets the format of the image. This must be specified when importing any image.
- Param in_format
The format of the image.
- Return
A reference to this 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.
- Param in_width
The width (in pixels) of the image.
- Param in_height
The height (in pixels) of the image.
- Return
A reference to this ImportOptionsKit.
- void Show (out HPS.Image.ImportOptionsKit out_kit)
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Param out_kit
The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
- bool ShowCompressionQuality (out float out_quality)
Shows the compression quality for the image.
- Param out_quality
The compression quality for the image.
- Return
true if the compression quality is valid, false otherwise.
- bool ShowDownSampling (out bool out_state)
Shows whether to down-sample the image.
- Param out_state
whether to down-sample the image.
- Return
true if the flag is valid, false otherwise.
- bool ShowFormat (out HPS.Image.Format out_format)
Shows the format of the image.
- Param out_format
The format of the image.
- Return
true if the format is valid, false otherwise.
- bool ShowSize (out uint out_width, out uint out_height)
Shows the width and height (in pixels) of the image.
- Param out_width
The width (in pixels) of the image.
- Param out_height
The height (in pixels) of the image.
- Return
true if the width and height are valid, false otherwise.
- HPS.Image.ImportOptionsKit UnsetCompressionQuality ()
Removes the compression quality for the image.
- Return
A reference to this ImportOptionsKit.
- HPS.Image.ImportOptionsKit UnsetDownSampling ()
Removes whether to down-sample the image.
- Return
A reference to this ImportOptionsKit.
- HPS.Image.ImportOptionsKit UnsetEverything ()
Removes all settings from this ImportOptionsKit.
- Return
A reference to this ImportOptionsKit.
- HPS.Image.ImportOptionsKit UnsetFormat ()
Removes the format of the image.
- Return
A reference to this ImportOptionsKit.
- HPS.Image.ImportOptionsKit UnsetSize ()
Removes the width and height of the image.
- Return
A reference to this ImportOptionsKit.
Public Static Functions
- bool operator!= (HPS.Image.ImportOptionsKit a, HPS.Image.ImportOptionsKit b)
- bool operator== (HPS.Image.ImportOptionsKit a, HPS.Image.ImportOptionsKit b)
