Inheritance diagram for HPS.Image.ImportOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Image.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.Image.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Image.ImportOptionsKit in_kit)
 
HPS.Image.ImportOptionsKit SetCompressionQuality (float in_quality)
 
HPS.Image.ImportOptionsKit SetDownSampling (bool in_state)
 
HPS.Image.ImportOptionsKit SetFormat (HPS.Image.Format in_format)
 
HPS.Image.ImportOptionsKit SetSize (uint in_width, uint in_height)
 
void Show (out HPS.Image.ImportOptionsKit out_kit)
 
bool ShowCompressionQuality (out float out_quality)
 
bool ShowDownSampling (out bool out_state)
 
bool ShowFormat (out HPS.Image.Format out_format)
 
bool ShowSize (out uint out_width, out uint out_height)
 
HPS.Image.ImportOptionsKit UnsetCompressionQuality ()
 
HPS.Image.ImportOptionsKit UnsetDownSampling ()
 
HPS.Image.ImportOptionsKit UnsetEverything ()
 
HPS.Image.ImportOptionsKit UnsetFormat ()
 
HPS.Image.ImportOptionsKit UnsetSize ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ ImportOptionsKit() [1/2]

HPS.Image.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.Image.ImportOptionsKit.ImportOptionsKit ( HPS.Image.ImportOptionsKit  in_kit)
inline

The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Image.ImportOptionsKit.Empty ( )
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.

◆ Equals()

bool HPS.Image.ImportOptionsKit.Equals ( HPS.Image.ImportOptionsKit  in_kit)
inline

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.Image.ImportOptionsKit.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()

void HPS.Image.ImportOptionsKit.Set ( HPS.Image.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetCompressionQuality()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.SetCompressionQuality ( float  in_quality)
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_qualityThe compression quality for the image.
Returns
A reference to this ImportOptionsKit.

◆ SetDownSampling()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.SetDownSampling ( bool  in_state)
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_stateWhether to down-sample the image.
Returns
A reference to this ImportOptionsKit.

◆ SetFormat()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.SetFormat ( HPS.Image.Format  in_format)
inline

Sets the format of the image. This must be specified when importing any image.

Parameters
in_formatThe format of the image.
Returns
A reference to this ImportOptionsKit.

◆ SetSize()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.SetSize ( uint  in_width,
uint  in_height 
)
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_widthThe width (in pixels) of the image.
in_heightThe height (in pixels) of the image.
Returns
A reference to this ImportOptionsKit.

◆ Show()

void HPS.Image.ImportOptionsKit.Show ( out HPS.Image.ImportOptionsKit  out_kit)
inline

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.

◆ ShowCompressionQuality()

bool HPS.Image.ImportOptionsKit.ShowCompressionQuality ( out float  out_quality)
inline

Shows the compression quality for the image.

Parameters
out_qualityThe compression quality for the image.
Returns
true if the compression quality is valid, false otherwise.

◆ ShowDownSampling()

bool HPS.Image.ImportOptionsKit.ShowDownSampling ( out bool  out_state)
inline

Shows whether to down-sample the image.

Parameters
out_statewhether to down-sample the image.
Returns
true if the flag is valid, false otherwise.

◆ ShowFormat()

bool HPS.Image.ImportOptionsKit.ShowFormat ( out HPS.Image.Format  out_format)
inline

Shows the format of the image.

Parameters
out_formatThe format of the image.
Returns
true if the format is valid, false otherwise.

◆ ShowSize()

bool HPS.Image.ImportOptionsKit.ShowSize ( out uint  out_width,
out uint  out_height 
)
inline

Shows the width and height (in pixels) of the image.

Parameters
out_widthThe width (in pixels) of the image.
out_heightThe height (in pixels) of the image.
Returns
true if the width and height are valid, false otherwise.

◆ UnsetCompressionQuality()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetCompressionQuality ( )
inline

Removes the compression quality for the image.

Returns
A reference to this ImportOptionsKit.

◆ UnsetDownSampling()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetDownSampling ( )
inline

Removes whether to down-sample the image.

Returns
A reference to this ImportOptionsKit.

◆ UnsetEverything()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetFormat()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetFormat ( )
inline

Removes the format of the image.

Returns
A reference to this ImportOptionsKit.

◆ UnsetSize()

HPS.Image.ImportOptionsKit HPS.Image.ImportOptionsKit.UnsetSize ( )
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