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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Image.ExportOptionsKit in_kit)
 
 ExportOptionsKit ()
 
 ExportOptionsKit (HPS.Image.ExportOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Image.ExportOptionsKit in_kit)
 
HPS.Image.ExportOptionsKit SetFormat (HPS.Image.Format in_format)
 
HPS.Image.ExportOptionsKit SetSize (uint in_width, uint in_height)
 
HPS.Image.ExportOptionsKit SetTransparentBackground (bool in_state)
 
void Show (out HPS.Image.ExportOptionsKit out_kit)
 
bool ShowFormat (out HPS.Image.Format out_format)
 
bool ShowSize (out uint out_width, out uint out_height)
 
bool ShowTransparentBackground (out bool out_state)
 
HPS.Image.ExportOptionsKit UnsetEverything ()
 
HPS.Image.ExportOptionsKit UnsetFormat ()
 
HPS.Image.ExportOptionsKit UnsetSize ()
 
HPS.Image.ExportOptionsKit UnsetTransparentBackground ()
 
- 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 HPS.Image.ExportOptionsKit GetDefault ()
 
static bool operator!= (HPS.Image.ExportOptionsKit a, HPS.Image.ExportOptionsKit b)
 
static bool operator== (HPS.Image.ExportOptionsKit a, HPS.Image.ExportOptionsKit 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 HPS.Image.ExportOptionsKit class contains options that will be used to export image files. Calling HPS.Image.ExportOptionsKit.GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

◆ ExportOptionsKit() [1/2]

HPS.Image.ExportOptionsKit.ExportOptionsKit ( )
inline

The default constructor creates an empty ExportOptionsKit object.

◆ ExportOptionsKit() [2/2]

HPS.Image.ExportOptionsKit.ExportOptionsKit ( HPS.Image.ExportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportOptionsKit to copy.

Member Function Documentation

◆ Empty()

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

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

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

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

◆ GetDefault()

static HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.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()

override HPS.Type HPS.Image.ExportOptionsKit.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.ExportOptionsKit.Set ( HPS.Image.ExportOptionsKit  in_kit)
inline

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.

◆ SetFormat()

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

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

Parameters
in_formatThe format of the image.
Returns
A reference to this ExportOptionsKit.
See also
Export format default value

◆ SetSize()

HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.SetSize ( uint  in_width,
uint  in_height 
)
inline

Sets the width and height (in pixels) of the image. If this is not specified , an exception will be thrown on export.

Parameters
in_widthThe width (in pixels) of the image.
in_heightThe height (in pixels) of the image.
Returns
A reference to this ExportOptionsKit.

◆ SetTransparentBackground()

HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.SetTransparentBackground ( bool  in_state)
inline

Sets whether the image background will be transparent. This setting is only valid when exporting a PNG image.

Parameters
in_stateWhether the image background will be transparent.
Returns
A reference to this ExportOptionsKit.

◆ Show()

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

Copies this ExportOptionsKit into the given ExportOptionsKit.

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

◆ ShowFormat()

bool HPS.Image.ExportOptionsKit.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.ExportOptionsKit.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.

◆ ShowTransparentBackground()

bool HPS.Image.ExportOptionsKit.ShowTransparentBackground ( out bool  out_state)
inline

Shows transparent background setting for this image

Parameters
out_stateThe transparent background setting for this image.
Returns
true if a background preference was specified, false otherwise.

◆ UnsetEverything()

HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportOptionsKit.

Returns
A reference to this ExportOptionsKit.

◆ UnsetFormat()

HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.UnsetFormat ( )
inline

Removes the format of the image.

Returns
A reference to this ExportOptionsKit.

◆ UnsetSize()

HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.UnsetSize ( )
inline

Removes the width and height of the image.

Returns
A reference to this ExportOptionsKit.

◆ UnsetTransparentBackground()

HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.UnsetTransparentBackground ( )
inline

Removes the transparent background setting of the image.

Returns
A reference to this ExportOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.Image.cs