HPS::Image::ExportOptionsKit

class HPS.Image.ExportOptionsKit : public HPS.Kit

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportOptionsKit has any values set on it.

Return

true if no values are set on this ExportOptionsKit, false otherwise.

bool Equals (HPS.Image.ExportOptionsKit in_kit)

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Param in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportOptionsKit ()

The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit (HPS.Image.ExportOptionsKit in_kit)

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

Param in_kit

The source ExportOptionsKit to copy.

override int GetHashCode ()

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.ExportOptionsKit in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Param in_kit

The source ExportOptionsKit to copy.

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

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

See

Export format default value

Param in_format

The format of the image.

Return

A reference to this ExportOptionsKit.

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

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

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 ExportOptionsKit.

HPS.Image.ExportOptionsKit SetTransparentBackground (bool in_state)

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

Param in_state

Whether the image background will be transparent.

Return

A reference to this ExportOptionsKit.

void Show (out HPS.Image.ExportOptionsKit out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

Param out_kit

The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

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.

bool ShowTransparentBackground (out bool out_state)

Shows transparent background setting for this image

Param out_state

The transparent background setting for this image.

Return

true if a background preference was specified, false otherwise.

HPS.Image.ExportOptionsKit UnsetEverything ()

Removes all settings from this ExportOptionsKit.

Return

A reference to this ExportOptionsKit.

HPS.Image.ExportOptionsKit UnsetFormat ()

Removes the format of the image.

Return

A reference to this ExportOptionsKit.

HPS.Image.ExportOptionsKit UnsetSize ()

Removes the width and height of the image.

Return

A reference to this ExportOptionsKit.

HPS.Image.ExportOptionsKit UnsetTransparentBackground ()

Removes the transparent background setting of the image.

Return

A reference to this ExportOptionsKit.

Public Static Functions

HPS.Image.ExportOptionsKit GetDefault ()

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.

Return

A ExportOptionsKit with the default settings.

bool operator!= (HPS.Image.ExportOptionsKit a, HPS.Image.ExportOptionsKit b)

bool operator== (HPS.Image.ExportOptionsKit a, HPS.Image.ExportOptionsKit b)