
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 () |
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. 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. More... | |
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. More... | |
HPS.Image.ImportOptionsKit | SetFormat (HPS.Image.Format in_format) |
Sets the format of the image. This must be specified when importing any image. More... | |
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. 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... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
override HPS.Type | ObjectType () |
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 an identifier that can be used to identify which instance of a class an object is. 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 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 () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ImportOptionsKit class contains options that will be used to import image files and will be set on the ImageKit returned by File.Import.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ImportOptionsKit object.
|
inline |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ImportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ImportOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
|
inline |
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.
- Parameters
-
in_quality The compression quality for the image.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
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.
- Parameters
-
in_state Whether to down-sample the image.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Sets the format of the image. This must be specified when importing any image.
- Parameters
-
in_format The format of the image.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
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.
- Parameters
-
in_width The width (in pixels) of the image. in_height The height (in pixels) of the image.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
|
inline |
Shows the compression quality for the image.
- Parameters
-
out_quality The compression quality for the image.
- Returns
- true if the compression quality is valid, false otherwise.
|
inline |
Shows whether to down-sample the image.
- Parameters
-
out_state whether to down-sample the image.
- Returns
- true if the flag is valid, false otherwise.
|
inline |
Shows the format of the image.
- Parameters
-
out_format The format of the image.
- Returns
- true if the format is valid, false otherwise.
|
inline |
Shows the width and height (in pixels) of the image.
- Parameters
-
out_width The width (in pixels) of the image. out_height The height (in pixels) of the image.
- Returns
- true if the width and height are valid, false otherwise.
|
inline |
Removes the compression quality for the image.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes whether to down-sample the image.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the format of the image.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the width and height of the image.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Image.cs