< Home

< Table of Contents

REFERENCE MANUAL

HPS.Image.ExportOptionsKit Class Reference

The Image::ExportOptionsKit class contains options that will be used to export image files. More...

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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ExportOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Image.ExportOptionsKit in_kit)
 Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...
 
 ExportOptionsKit ()
 The default constructor creates an empty ExportOptionsKit object. More...
 
 ExportOptionsKit (HPS.Image.ExportOptionsKit in_kit)
 The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Image.ExportOptionsKit in_kit)
 Copies the source ExportOptionsKit into this ExportOptionsKit. More...
 
HPS.Image.ExportOptionsKit SetFormat (HPS.Image.Format in_format)
 Sets the format of the image. More...
 
HPS.Image.ExportOptionsKit SetSize (uint in_width, uint in_height)
 Sets the width and height (in pixels) of the image. More...
 
void Show (out HPS.Image.ExportOptionsKit out_kit)
 Copies this ExportOptionsKit into the given ExportOptionsKit. 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.ExportOptionsKit UnsetEverything ()
 Removes all settings from this ExportOptionsKit. More...
 
HPS.Image.ExportOptionsKit UnsetFormat ()
 Removes the format of the image. More...
 
HPS.Image.ExportOptionsKit UnsetSize ()
 Removes the width and height of the image. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static HPS.Image.ExportOptionsKit GetDefault ()
 Creates a ExportOptionsKit which contains the default settings. More...
 
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.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The Image::ExportOptionsKit class contains options that will be used to export image files.

Calling Image::ExportOptionsKit::GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

HPS.Image.ExportOptionsKit.ExportOptionsKit ( )

The default constructor creates an empty ExportOptionsKit object.

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_image_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.Image.ExportOptionsKit.Empty ( )
virtual

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.

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

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_image_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_image_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.GetDefault ( )
static

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.
override HPS.Type HPS.Image.ExportOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.Image.ExportOptionsKit.Set ( HPS.Image.ExportOptionsKit  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_image_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy.
HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.SetFormat ( HPS.Image.Format  in_format)

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.

Export format default value

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

Parameters
in_widthThe width (in pixels) of the image.
in_heightThe height (in pixels) of the image.
Returns
A reference to this ExportOptionsKit.
void HPS.Image.ExportOptionsKit.Show ( out HPS.Image.ExportOptionsKit  out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_image_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_image_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref>.
bool HPS.Image.ExportOptionsKit.ShowFormat ( out HPS.Image.Format  out_format)

Shows the format of the image.

Parameters
out_formatThe format of the image.
Returns
true if the format is valid, false otherwise.
bool HPS.Image.ExportOptionsKit.ShowSize ( out uint  out_width,
out uint  out_height 
)

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

Removes all settings from this ExportOptionsKit.

Returns
A reference to this ExportOptionsKit.
HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.UnsetFormat ( )

Removes the format of the image.

Returns
A reference to this ExportOptionsKit.
HPS.Image.ExportOptionsKit HPS.Image.ExportOptionsKit.UnsetSize ( )

Removes the width and height of the image.

Returns
A reference to this ExportOptionsKit.

The documentation for this class was generated from the following file: